| <!DOCTYPE HTML> |
| <html lang="fr"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> |
| <span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> *</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> */</a> |
| <span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.web.filter.authc;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authc.AuthenticationToken;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.codec.Base64;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.web.util.WebUtils;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">026</span><a id="line.26"></a> |
| <span class="sourceLineNo">027</span><a id="line.27">import javax.servlet.ServletRequest;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import javax.servlet.ServletResponse;</a> |
| <span class="sourceLineNo">029</span><a id="line.29">import javax.servlet.http.HttpServletRequest;</a> |
| <span class="sourceLineNo">030</span><a id="line.30">import javax.servlet.http.HttpServletResponse;</a> |
| <span class="sourceLineNo">031</span><a id="line.31">import java.util.HashSet;</a> |
| <span class="sourceLineNo">032</span><a id="line.32">import java.util.Locale;</a> |
| <span class="sourceLineNo">033</span><a id="line.33">import java.util.Set;</a> |
| <span class="sourceLineNo">034</span><a id="line.34"></a> |
| <span class="sourceLineNo">035</span><a id="line.35"></a> |
| <span class="sourceLineNo">036</span><a id="line.36">/**</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> * Requires the requesting user to be {@link org.apache.shiro.subject.Subject#isAuthenticated() authenticated} for the</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> * request to continue, and if they're not, requires the user to login via the HTTP Basic protocol-specific challenge.</a> |
| <span class="sourceLineNo">039</span><a id="line.39"> * Upon successful login, they're allowed to continue on to the requested resource/url.</a> |
| <span class="sourceLineNo">040</span><a id="line.40"> * <p/></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * This implementation is a 'clean room' Java implementation of Basic HTTP Authentication specification per</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * <a href="ftp://ftp.isi.edu/in-notes/rfc2617.txt">RFC 2617</a>.</a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * <p/></a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * Basic authentication functions as follows:</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * <ol></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * <li>A request comes in for a resource that requires authentication.</li></a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * <li>The server replies with a 401 response status, sets the <code>WWW-Authenticate</code> header, and the contents of a</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * page informing the user that the incoming resource requires authentication.</li></a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * <li>Upon receiving this <code>WWW-Authenticate</code> challenge from the server, the client then takes a</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * username and a password and puts them in the following format:</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * <p><code>username:password</code></p></li></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * <li>This token is then base 64 encoded.</li></a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * <li>The client then sends another request for the same resource with the following header:<br/></a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * <p><code>Authorization: Basic <em>Base64_encoded_username_and_password</em></code></p></li></a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * </ol></a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * The {@link #onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} method will</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * only be called if the subject making the request is not</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * {@link org.apache.shiro.subject.Subject#isAuthenticated() authenticated}</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> *</a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * @see <a href="https://tools.ietf.org/html/rfc2617">RFC 2617</a></a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * @see <a href="http://en.wikipedia.org/wiki/Basic_access_authentication">Basic Access Authentication</a></a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * @since 0.9</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> */</a> |
| <span class="sourceLineNo">064</span><a id="line.64">public class BasicHttpAuthenticationFilter extends HttpAuthenticationFilter {</a> |
| <span class="sourceLineNo">065</span><a id="line.65"></a> |
| <span class="sourceLineNo">066</span><a id="line.66"> /**</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * This class's private logger.</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> */</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> private static final Logger log = LoggerFactory.getLogger(BasicHttpAuthenticationFilter.class);</a> |
| <span class="sourceLineNo">070</span><a id="line.70"></a> |
| <span class="sourceLineNo">071</span><a id="line.71"></a> |
| <span class="sourceLineNo">072</span><a id="line.72"> public BasicHttpAuthenticationFilter() {</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> setAuthcScheme(HttpServletRequest.BASIC_AUTH);</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> setAuthzScheme(HttpServletRequest.BASIC_AUTH);</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> }</a> |
| <span class="sourceLineNo">076</span><a id="line.76"></a> |
| <span class="sourceLineNo">077</span><a id="line.77"> /**</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * Creates an AuthenticationToken for use during login attempt with the provided credentials in the http header.</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * <p/></a> |
| <span class="sourceLineNo">080</span><a id="line.80"> * This implementation:</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * <ol><li>acquires the username and password based on the request's</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * {@link #getAuthzHeader(javax.servlet.ServletRequest) authorization header} via the</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> * {@link #getPrincipalsAndCredentials(String, javax.servlet.ServletRequest) getPrincipalsAndCredentials} method</li></a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * <li>The return value of that method is converted to an <code>AuthenticationToken</code> via the</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> * {@link #createToken(String, String, javax.servlet.ServletRequest, javax.servlet.ServletResponse) createToken} method</li></a> |
| <span class="sourceLineNo">086</span><a id="line.86"> * <li>The created <code>AuthenticationToken</code> is returned.</li></a> |
| <span class="sourceLineNo">087</span><a id="line.87"> * </ol></a> |
| <span class="sourceLineNo">088</span><a id="line.88"> *</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> * @param request incoming ServletRequest</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> * @param response outgoing ServletResponse</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> * @return the AuthenticationToken used to execute the login attempt</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> */</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> protected AuthenticationToken createToken(ServletRequest request, ServletResponse response) {</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> String authorizationHeader = getAuthzHeader(request);</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> if (authorizationHeader == null || authorizationHeader.length() == 0) {</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> // Create an empty authentication token since there is no</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> // Authorization header.</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> return createToken("", "", request, response);</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> }</a> |
| <span class="sourceLineNo">100</span><a id="line.100"></a> |
| <span class="sourceLineNo">101</span><a id="line.101"> log.debug("Attempting to execute login with auth header");</a> |
| <span class="sourceLineNo">102</span><a id="line.102"></a> |
| <span class="sourceLineNo">103</span><a id="line.103"> String[] prinCred = getPrincipalsAndCredentials(authorizationHeader, request);</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> if (prinCred == null || prinCred.length < 2) {</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> // Create an authentication token with an empty password,</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> // since one hasn't been provided in the request.</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> String username = prinCred == null || prinCred.length == 0 ? "" : prinCred[0];</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> return createToken(username, "", request, response);</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> }</a> |
| <span class="sourceLineNo">110</span><a id="line.110"></a> |
| <span class="sourceLineNo">111</span><a id="line.111"> String username = prinCred[0];</a> |
| <span class="sourceLineNo">112</span><a id="line.112"> String password = prinCred[1];</a> |
| <span class="sourceLineNo">113</span><a id="line.113"></a> |
| <span class="sourceLineNo">114</span><a id="line.114"> return createToken(username, password, request, response);</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> }</a> |
| <span class="sourceLineNo">116</span><a id="line.116"></a> |
| <span class="sourceLineNo">117</span><a id="line.117"> /**</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> * Returns the username and password pair based on the specified <code>encoded</code> String obtained from</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> * the request's authorization header.</a> |
| <span class="sourceLineNo">120</span><a id="line.120"> * <p/></a> |
| <span class="sourceLineNo">121</span><a id="line.121"> * Per RFC 2617, the default implementation first Base64 decodes the string and then splits the resulting decoded</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * string into two based on the ":" character. That is:</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> * <p/></a> |
| <span class="sourceLineNo">124</span><a id="line.124"> * <code>String decoded = Base64.decodeToString(encoded);<br/></a> |
| <span class="sourceLineNo">125</span><a id="line.125"> * return decoded.split(":");</code></a> |
| <span class="sourceLineNo">126</span><a id="line.126"> *</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> * @param scheme the {@link #getAuthcScheme() authcScheme} found in the request</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> * {@link #getAuthzHeader(javax.servlet.ServletRequest) authzHeader}. It is ignored by this implementation,</a> |
| <span class="sourceLineNo">129</span><a id="line.129"> * but available to overriding implementations should they find it useful.</a> |
| <span class="sourceLineNo">130</span><a id="line.130"> * @param encoded the Base64-encoded username:password value found after the scheme in the header</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> * @return the username (index 0)/password (index 1) pair obtained from the encoded header data.</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> */</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> protected String[] getPrincipalsAndCredentials(String scheme, String encoded) {</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> String decoded = Base64.decodeToString(encoded);</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> return decoded.split(":", 2);</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> }</a> |
| <span class="sourceLineNo">137</span><a id="line.137">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
