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