| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <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.Locale;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>/**<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Requires the requesting user to be {@link org.apache.shiro.subject.Subject#isAuthenticated() authenticated} for the<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * request to continue, and if they're not, requires the user to login via the HTTP Basic protocol-specific challenge.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Upon successful login, they're allowed to continue on to the requested resource/url.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <p/><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * This implementation is a 'clean room' Java implementation of Basic HTTP Authentication specification per<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <a href="ftp://ftp.isi.edu/in-notes/rfc2617.txt">RFC 2617</a>.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <p/><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * Basic authentication functions as follows:<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <ol><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <li>A request comes in for a resource that requires authentication.</li><a name="line.44"></a> |
| <span class="sourceLineNo">045</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.45"></a> |
| <span class="sourceLineNo">046</span> * page informing the user that the incoming resource requires authentication.</li><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <li>Upon receiving this <code>WWW-Authenticate</code> challenge from the server, the client then takes a<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * username and a password and puts them in the following format:<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <p><code>username:password</code></p></li><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <li>This token is then base 64 encoded.</li><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <li>The client then sends another request for the same resource with the following header:<br/><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <p><code>Authorization: Basic <em>Base64_encoded_username_and_password</em></code></p></li><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * </ol><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * The {@link #onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} method will<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * only be called if the subject making the request is not<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * {@link org.apache.shiro.subject.Subject#isAuthenticated() authenticated}<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> *<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @see <a href="ftp://ftp.isi.edu/in-notes/rfc2617.txt">RFC 2617</a><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @see <a href="http://en.wikipedia.org/wiki/Basic_access_authentication">Basic Access Authentication</a><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @since 0.9<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span>public class BasicHttpAuthenticationFilter extends AuthenticatingFilter {<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> /**<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * This class's private logger.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> */<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private static final Logger log = LoggerFactory.getLogger(BasicHttpAuthenticationFilter.class);<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> /**<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * HTTP Authorization header, equal to <code>Authorization</code><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> protected static final String AUTHORIZATION_HEADER = "Authorization";<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> /**<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * HTTP Authentication header, equal to <code>WWW-Authenticate</code><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> */<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> protected static final String AUTHENTICATE_HEADER = "WWW-Authenticate";<a name="line.77"></a> |
| <span class="sourceLineNo">078</span><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> /**<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * The name that is displayed during the challenge process of authentication, defauls to <code>application</code><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * and can be overridden by the {@link #setApplicationName(String) setApplicationName} method.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> */<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> private String applicationName = "application";<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * The authcScheme to look for in the <code>Authorization</code> header, defaults to <code>BASIC</code><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> */<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> private String authcScheme = HttpServletRequest.BASIC_AUTH;<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> /**<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * The authzScheme value to look for in the <code>Authorization</code> header, defaults to <code>BASIC</code><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> private String authzScheme = HttpServletRequest.BASIC_AUTH;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> /**<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * Returns the name to use in the ServletResponse's <b><code>WWW-Authenticate</code></b> header.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * <p/><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * Per RFC 2617, this name name is displayed to the end user when they are asked to authenticate. Unless overridden<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * by the {@link #setApplicationName(String) setApplicationName(String)} method, the default value is 'application'.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * <p/><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * Please see {@link #setApplicationName(String) setApplicationName(String)} for an example of how this functions.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> *<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @return the name to use in the ServletResponse's 'WWW-Authenticate' header.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public String getApplicationName() {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> return applicationName;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> /**<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * Sets the name to use in the ServletResponse's <b><code>WWW-Authenticate</code></b> header.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * <p/><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * Per RFC 2617, this name name is displayed to the end user when they are asked to authenticate. Unless overridden<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * by this method, the default value is &quot;application&quot;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * <p/><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * For example, setting this property to the value <b><code>Awesome Webapp</code></b> will result in the<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * following header:<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * <p/><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * <code>WWW-Authenticate: Basic realm=&quot;<b>Awesome Webapp</b>&quot;</code><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * <p/><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * Side note: As you can see from the header text, the HTTP Basic specification calls<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * this the authentication 'realm', but we call this the 'applicationName' instead to avoid confusion with<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * Shiro's Realm constructs.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> *<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * @param applicationName the name to use in the ServletResponse's 'WWW-Authenticate' header.<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> */<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> public void setApplicationName(String applicationName) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> this.applicationName = applicationName;<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> }<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> /**<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * Returns the HTTP <b><code>Authorization</code></b> header value that this filter will respond to as indicating<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * a login request.<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * <p/><a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * Unless overridden by the {@link #setAuthzScheme(String) setAuthzScheme(String)} method, the<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * default value is <code>BASIC</code>.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> *<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @return the Http 'Authorization' header value that this filter will respond to as indicating a login request<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> */<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> public String getAuthzScheme() {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> return authzScheme;<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> }<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /**<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * Sets the HTTP <b><code>Authorization</code></b> header value that this filter will respond to as indicating a<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * login request.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * <p/><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * Unless overridden by this method, the default value is <code>BASIC</code><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> *<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * @param authzScheme the HTTP <code>Authorization</code> header value that this filter will respond to as<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * indicating a login request.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> */<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> public void setAuthzScheme(String authzScheme) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> this.authzScheme = authzScheme;<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> /**<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * Returns the HTTP <b><code>WWW-Authenticate</code></b> header scheme that this filter will use when sending<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * the HTTP Basic challenge response. The default value is <code>BASIC</code>.<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> *<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * @return the HTTP <code>WWW-Authenticate</code> header scheme that this filter will use when sending the HTTP<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * Basic challenge response.<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @see #sendChallenge<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> */<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> public String getAuthcScheme() {<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> return authcScheme;<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span><a name="line.167"></a> |
| <span class="sourceLineNo">168</span> /**<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * Sets the HTTP <b><code>WWW-Authenticate</code></b> header scheme that this filter will use when sending the<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * HTTP Basic challenge response. The default value is <code>BASIC</code>.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> *<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * @param authcScheme the HTTP <code>WWW-Authenticate</code> header scheme that this filter will use when<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * sending the Http Basic challenge response.<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * @see #sendChallenge<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> */<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> public void setAuthcScheme(String authcScheme) {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> this.authcScheme = authcScheme;<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> <a name="line.179"></a> |
| <span class="sourceLineNo">180</span> /**<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * The Basic authentication filter can be configured with a list of HTTP methods to which it should apply. This<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * method ensures that authentication is <em>only</em> required for those HTTP methods specified. For example,<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * if you had the configuration:<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * <pre><a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * [urls]<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * /basic/** = authcBasic[POST,PUT,DELETE]<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * </pre><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * then a GET request would not required authentication but a POST would.<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * @param request The current HTTP servlet request.<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * @param response The current HTTP servlet response.<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * @param mappedValue The array of configured HTTP methods as strings. This is empty if no methods are configured.<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> */<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> HttpServletRequest httpRequest = WebUtils.toHttp(request);<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> String httpMethod = httpRequest.getMethod();<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> <a name="line.196"></a> |
| <span class="sourceLineNo">197</span> // Check whether the current request's method requires authentication.<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> // If no methods have been configured, then all of them require auth,<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> // otherwise only the declared ones need authentication.<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> String[] methods = (String[]) (mappedValue == null ? new String[0] : mappedValue);<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> boolean authcRequired = methods.length == 0;<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> for (String m : methods) {<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> if (httpMethod.equalsIgnoreCase(m)) {<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> authcRequired = true;<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> break;<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> }<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> <a name="line.208"></a> |
| <span class="sourceLineNo">209</span> if (authcRequired) {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> return super.isAccessAllowed(request, response, mappedValue);<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> }<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> else {<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> return true;<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> }<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> }<a name="line.215"></a> |
| <span class="sourceLineNo">216</span><a name="line.216"></a> |
| <span class="sourceLineNo">217</span> /**<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * Processes unauthenticated requests. It handles the two-stage request/challenge authentication protocol.<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> *<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * @param request incoming ServletRequest<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * @param response outgoing ServletResponse<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * @return true if the request should be processed; false if the request should not continue to be processed<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> */<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> protected boolean onAccessDenied(ServletRequest request, ServletResponse response) throws Exception {<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> boolean loggedIn = false; //false by default or we wouldn't be in this method<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> if (isLoginAttempt(request, response)) {<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> loggedIn = executeLogin(request, response);<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> }<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> if (!loggedIn) {<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> sendChallenge(request, response);<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> }<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> return loggedIn;<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> }<a name="line.233"></a> |
| <span class="sourceLineNo">234</span><a name="line.234"></a> |
| <span class="sourceLineNo">235</span> /**<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * Determines whether the incoming request is an attempt to log in.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * <p/><a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * The default implementation obtains the value of the request's<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * {@link #AUTHORIZATION_HEADER AUTHORIZATION_HEADER}, and if it is not <code>null</code>, delegates<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * to {@link #isLoginAttempt(String) isLoginAttempt(authzHeaderValue)}. If the header is <code>null</code>,<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * <code>false</code> is returned.<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> *<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * @param request incoming ServletRequest<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * @param response outgoing ServletResponse<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * @return true if the incoming request is an attempt to log in based, false otherwise<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> */<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> protected boolean isLoginAttempt(ServletRequest request, ServletResponse response) {<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> String authzHeader = getAuthzHeader(request);<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> return authzHeader != null && isLoginAttempt(authzHeader);<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> }<a name="line.250"></a> |
| <span class="sourceLineNo">251</span><a name="line.251"></a> |
| <span class="sourceLineNo">252</span> /**<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> * Delegates to {@link #isLoginAttempt(javax.servlet.ServletRequest, javax.servlet.ServletResponse) isLoginAttempt}.<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> */<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> @Override<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> protected final boolean isLoginRequest(ServletRequest request, ServletResponse response) {<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> return this.isLoginAttempt(request, response);<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> }<a name="line.258"></a> |
| <span class="sourceLineNo">259</span><a name="line.259"></a> |
| <span class="sourceLineNo">260</span> /**<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * Returns the {@link #AUTHORIZATION_HEADER AUTHORIZATION_HEADER} from the specified ServletRequest.<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * <p/><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * This implementation merely casts the request to an <code>HttpServletRequest</code> and returns the header:<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * <p/><a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * <code>HttpServletRequest httpRequest = {@link WebUtils#toHttp(javax.servlet.ServletRequest) toHttp(reaquest)};<br/><a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * return httpRequest.getHeader({@link #AUTHORIZATION_HEADER AUTHORIZATION_HEADER});</code><a name="line.266"></a> |
| <span class="sourceLineNo">267</span> *<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * @param request the incoming <code>ServletRequest</code><a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * @return the <code>Authorization</code> header's value.<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> */<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> protected String getAuthzHeader(ServletRequest request) {<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> HttpServletRequest httpRequest = WebUtils.toHttp(request);<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> return httpRequest.getHeader(AUTHORIZATION_HEADER);<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> }<a name="line.274"></a> |
| <span class="sourceLineNo">275</span><a name="line.275"></a> |
| <span class="sourceLineNo">276</span> /**<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * Default implementation that returns <code>true</code> if the specified <code>authzHeader</code><a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * starts with the same (case-insensitive) characters specified by the<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * {@link #getAuthzScheme() authzScheme}, <code>false</code> otherwise.<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * <p/><a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * That is:<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * <p/><a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * <code>String authzScheme = getAuthzScheme().toLowerCase();<br/><a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * return authzHeader.toLowerCase().startsWith(authzScheme);</code><a name="line.284"></a> |
| <span class="sourceLineNo">285</span> *<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * @param authzHeader the 'Authorization' header value (guaranteed to be non-null if the<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * {@link #isLoginAttempt(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} method is not overriden).<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * @return <code>true</code> if the authzHeader value matches that configured as defined by<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * the {@link #getAuthzScheme() authzScheme}.<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> */<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> protected boolean isLoginAttempt(String authzHeader) {<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> //SHIRO-415: use English Locale:<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> String authzScheme = getAuthzScheme().toLowerCase(Locale.ENGLISH);<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> return authzHeader.toLowerCase(Locale.ENGLISH).startsWith(authzScheme);<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> }<a name="line.295"></a> |
| <span class="sourceLineNo">296</span><a name="line.296"></a> |
| <span class="sourceLineNo">297</span> /**<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * Builds the challenge for authorization by setting a HTTP <code>401</code> (Unauthorized) status as well as the<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * response's {@link #AUTHENTICATE_HEADER AUTHENTICATE_HEADER}.<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * <p/><a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * The header value constructed is equal to:<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * <p/><a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * <code>{@link #getAuthcScheme() getAuthcScheme()} + " realm=\"" + {@link #getApplicationName() getApplicationName()} + "\"";</code><a name="line.303"></a> |
| <span class="sourceLineNo">304</span> *<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> * @param request incoming ServletRequest, ignored by this implementation<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * @param response outgoing ServletResponse<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * @return false - this sends the challenge to be sent back<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> */<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> protected boolean sendChallenge(ServletRequest request, ServletResponse response) {<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> if (log.isDebugEnabled()) {<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> log.debug("Authentication required: sending 401 Authentication challenge response.");<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> }<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> HttpServletResponse httpResponse = WebUtils.toHttp(response);<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> httpResponse.setStatus(HttpServletResponse.SC_UNAUTHORIZED);<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> String authcHeader = getAuthcScheme() + " realm=\"" + getApplicationName() + "\"";<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> httpResponse.setHeader(AUTHENTICATE_HEADER, authcHeader);<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> return false;<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> }<a name="line.318"></a> |
| <span class="sourceLineNo">319</span><a name="line.319"></a> |
| <span class="sourceLineNo">320</span> /**<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * Creates an AuthenticationToken for use during login attempt with the provided credentials in the http header.<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * <p/><a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * This implementation:<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * <ol><li>acquires the username and password based on the request's<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * {@link #getAuthzHeader(javax.servlet.ServletRequest) authorization header} via the<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * {@link #getPrincipalsAndCredentials(String, javax.servlet.ServletRequest) getPrincipalsAndCredentials} method</li><a name="line.326"></a> |
| <span class="sourceLineNo">327</span> * <li>The return value of that method is converted to an <code>AuthenticationToken</code> via the<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * {@link #createToken(String, String, javax.servlet.ServletRequest, javax.servlet.ServletResponse) createToken} method</li><a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * <li>The created <code>AuthenticationToken</code> is returned.</li><a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * </ol><a name="line.330"></a> |
| <span class="sourceLineNo">331</span> *<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * @param request incoming ServletRequest<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * @param response outgoing ServletResponse<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * @return the AuthenticationToken used to execute the login attempt<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> */<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> protected AuthenticationToken createToken(ServletRequest request, ServletResponse response) {<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> String authorizationHeader = getAuthzHeader(request);<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> if (authorizationHeader == null || authorizationHeader.length() == 0) {<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> // Create an empty authentication token since there is no<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> // Authorization header.<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> return createToken("", "", request, response);<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> }<a name="line.342"></a> |
| <span class="sourceLineNo">343</span><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> if (log.isDebugEnabled()) {<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> log.debug("Attempting to execute login with headers [" + authorizationHeader + "]");<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> }<a name="line.346"></a> |
| <span class="sourceLineNo">347</span><a name="line.347"></a> |
| <span class="sourceLineNo">348</span> String[] prinCred = getPrincipalsAndCredentials(authorizationHeader, request);<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> if (prinCred == null || prinCred.length < 2) {<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> // Create an authentication token with an empty password,<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> // since one hasn't been provided in the request.<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> String username = prinCred == null || prinCred.length == 0 ? "" : prinCred[0];<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> return createToken(username, "", request, response);<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> }<a name="line.354"></a> |
| <span class="sourceLineNo">355</span><a name="line.355"></a> |
| <span class="sourceLineNo">356</span> String username = prinCred[0];<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> String password = prinCred[1];<a name="line.357"></a> |
| <span class="sourceLineNo">358</span><a name="line.358"></a> |
| <span class="sourceLineNo">359</span> return createToken(username, password, request, response);<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> }<a name="line.360"></a> |
| <span class="sourceLineNo">361</span><a name="line.361"></a> |
| <span class="sourceLineNo">362</span> /**<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * Returns the username obtained from the<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * {@link #getAuthzHeader(javax.servlet.ServletRequest) authorizationHeader}.<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> * <p/><a name="line.365"></a> |
| <span class="sourceLineNo">366</span> * Once the {@code authzHeader} is split per the RFC (based on the space character ' '), the resulting split tokens<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * are translated into the username/password pair by the<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * {@link #getPrincipalsAndCredentials(String, String) getPrincipalsAndCredentials(scheme,encoded)} method.<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> *<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * @param authorizationHeader the authorization header obtained from the request.<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * @param request the incoming ServletRequest<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> * @return the username (index 0)/password pair (index 1) submitted by the user for the given header value and request.<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> * @see #getAuthzHeader(javax.servlet.ServletRequest)<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> */<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> protected String[] getPrincipalsAndCredentials(String authorizationHeader, ServletRequest request) {<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> if (authorizationHeader == null) {<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> return null;<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> }<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> String[] authTokens = authorizationHeader.split(" ");<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> if (authTokens == null || authTokens.length < 2) {<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> return null;<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> }<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> return getPrincipalsAndCredentials(authTokens[0], authTokens[1]);<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> }<a name="line.384"></a> |
| <span class="sourceLineNo">385</span><a name="line.385"></a> |
| <span class="sourceLineNo">386</span> /**<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> * Returns the username and password pair based on the specified <code>encoded</code> String obtained from<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> * the request's authorization header.<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> * <p/><a name="line.389"></a> |
| <span class="sourceLineNo">390</span> * Per RFC 2617, the default implementation first Base64 decodes the string and then splits the resulting decoded<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> * string into two based on the ":" character. That is:<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * <p/><a name="line.392"></a> |
| <span class="sourceLineNo">393</span> * <code>String decoded = Base64.decodeToString(encoded);<br/><a name="line.393"></a> |
| <span class="sourceLineNo">394</span> * return decoded.split(":");</code><a name="line.394"></a> |
| <span class="sourceLineNo">395</span> *<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> * @param scheme the {@link #getAuthcScheme() authcScheme} found in the request<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> * {@link #getAuthzHeader(javax.servlet.ServletRequest) authzHeader}. It is ignored by this implementation,<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> * but available to overriding implementations should they find it useful.<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * @param encoded the Base64-encoded username:password value found after the scheme in the header<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> * @return the username (index 0)/password (index 1) pair obtained from the encoded header data.<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> */<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> protected String[] getPrincipalsAndCredentials(String scheme, String encoded) {<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> String decoded = Base64.decodeToString(encoded);<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> return decoded.split(":", 2);<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> }<a name="line.405"></a> |
| <span class="sourceLineNo">406</span>}<a name="line.406"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
