| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.web.filter.authc;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.authc.AuthenticationException;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.authc.AuthenticationToken;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.authc.UsernamePasswordToken;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.subject.Subject;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.shiro.web.util.WebUtils;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.slf4j.Logger;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.slf4j.LoggerFactory;<a name="line.27"></a> |
| <FONT color="green">028</FONT> <a name="line.28"></a> |
| <FONT color="green">029</FONT> import javax.servlet.ServletRequest;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import javax.servlet.ServletResponse;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import javax.servlet.http.HttpServletRequest;<a name="line.31"></a> |
| <FONT color="green">032</FONT> <a name="line.32"></a> |
| <FONT color="green">033</FONT> <a name="line.33"></a> |
| <FONT color="green">034</FONT> /**<a name="line.34"></a> |
| <FONT color="green">035</FONT> * Requires the requesting user to be authenticated for the request to continue, and if they are not, forces the user<a name="line.35"></a> |
| <FONT color="green">036</FONT> * to login via by redirecting them to the {@link #setLoginUrl(String) loginUrl} you configure.<a name="line.36"></a> |
| <FONT color="green">037</FONT> * <p/><a name="line.37"></a> |
| <FONT color="green">038</FONT> * <p>This filter constructs a {@link UsernamePasswordToken UsernamePasswordToken} with the values found in<a name="line.38"></a> |
| <FONT color="green">039</FONT> * {@link #setUsernameParam(String) username}, {@link #setPasswordParam(String) password},<a name="line.39"></a> |
| <FONT color="green">040</FONT> * and {@link #setRememberMeParam(String) rememberMe} request parameters. It then calls<a name="line.40"></a> |
| <FONT color="green">041</FONT> * {@link org.apache.shiro.subject.Subject#login(org.apache.shiro.authc.AuthenticationToken) Subject.login(usernamePasswordToken)},<a name="line.41"></a> |
| <FONT color="green">042</FONT> * effectively automatically performing a login attempt. Note that the login attempt will only occur when the<a name="line.42"></a> |
| <FONT color="green">043</FONT> * {@link #isLoginSubmission(javax.servlet.ServletRequest, javax.servlet.ServletResponse) isLoginSubmission(request,response)}<a name="line.43"></a> |
| <FONT color="green">044</FONT> * is <code>true</code>, which by default occurs when the request is for the {@link #setLoginUrl(String) loginUrl} and<a name="line.44"></a> |
| <FONT color="green">045</FONT> * is a POST request.<a name="line.45"></a> |
| <FONT color="green">046</FONT> * <p/><a name="line.46"></a> |
| <FONT color="green">047</FONT> * <p>If the login attempt fails, the resulting <code>AuthenticationException</code> fully qualified class name will<a name="line.47"></a> |
| <FONT color="green">048</FONT> * be set as a request attribute under the {@link #setFailureKeyAttribute(String) failureKeyAttribute} key. This<a name="line.48"></a> |
| <FONT color="green">049</FONT> * FQCN can be used as an i18n key or lookup mechanism to explain to the user why their login attempt failed<a name="line.49"></a> |
| <FONT color="green">050</FONT> * (e.g. no account, incorrect password, etc).<a name="line.50"></a> |
| <FONT color="green">051</FONT> * <p/><a name="line.51"></a> |
| <FONT color="green">052</FONT> * <p>If you would prefer to handle the authentication validation and login in your own code, consider using the<a name="line.52"></a> |
| <FONT color="green">053</FONT> * {@link PassThruAuthenticationFilter} instead, which allows requests to the<a name="line.53"></a> |
| <FONT color="green">054</FONT> * {@link #loginUrl} to pass through to your application's code directly.<a name="line.54"></a> |
| <FONT color="green">055</FONT> *<a name="line.55"></a> |
| <FONT color="green">056</FONT> * @see PassThruAuthenticationFilter<a name="line.56"></a> |
| <FONT color="green">057</FONT> * @since 0.9<a name="line.57"></a> |
| <FONT color="green">058</FONT> */<a name="line.58"></a> |
| <FONT color="green">059</FONT> public class FormAuthenticationFilter extends AuthenticatingFilter {<a name="line.59"></a> |
| <FONT color="green">060</FONT> <a name="line.60"></a> |
| <FONT color="green">061</FONT> //TODO - complete JavaDoc<a name="line.61"></a> |
| <FONT color="green">062</FONT> <a name="line.62"></a> |
| <FONT color="green">063</FONT> public static final String DEFAULT_ERROR_KEY_ATTRIBUTE_NAME = "shiroLoginFailure";<a name="line.63"></a> |
| <FONT color="green">064</FONT> <a name="line.64"></a> |
| <FONT color="green">065</FONT> public static final String DEFAULT_USERNAME_PARAM = "username";<a name="line.65"></a> |
| <FONT color="green">066</FONT> public static final String DEFAULT_PASSWORD_PARAM = "password";<a name="line.66"></a> |
| <FONT color="green">067</FONT> public static final String DEFAULT_REMEMBER_ME_PARAM = "rememberMe";<a name="line.67"></a> |
| <FONT color="green">068</FONT> <a name="line.68"></a> |
| <FONT color="green">069</FONT> private static final Logger log = LoggerFactory.getLogger(FormAuthenticationFilter.class);<a name="line.69"></a> |
| <FONT color="green">070</FONT> <a name="line.70"></a> |
| <FONT color="green">071</FONT> private String usernameParam = DEFAULT_USERNAME_PARAM;<a name="line.71"></a> |
| <FONT color="green">072</FONT> private String passwordParam = DEFAULT_PASSWORD_PARAM;<a name="line.72"></a> |
| <FONT color="green">073</FONT> private String rememberMeParam = DEFAULT_REMEMBER_ME_PARAM;<a name="line.73"></a> |
| <FONT color="green">074</FONT> <a name="line.74"></a> |
| <FONT color="green">075</FONT> private String failureKeyAttribute = DEFAULT_ERROR_KEY_ATTRIBUTE_NAME;<a name="line.75"></a> |
| <FONT color="green">076</FONT> <a name="line.76"></a> |
| <FONT color="green">077</FONT> public FormAuthenticationFilter() {<a name="line.77"></a> |
| <FONT color="green">078</FONT> setLoginUrl(DEFAULT_LOGIN_URL);<a name="line.78"></a> |
| <FONT color="green">079</FONT> }<a name="line.79"></a> |
| <FONT color="green">080</FONT> <a name="line.80"></a> |
| <FONT color="green">081</FONT> @Override<a name="line.81"></a> |
| <FONT color="green">082</FONT> public void setLoginUrl(String loginUrl) {<a name="line.82"></a> |
| <FONT color="green">083</FONT> String previous = getLoginUrl();<a name="line.83"></a> |
| <FONT color="green">084</FONT> if (previous != null) {<a name="line.84"></a> |
| <FONT color="green">085</FONT> this.appliedPaths.remove(previous);<a name="line.85"></a> |
| <FONT color="green">086</FONT> }<a name="line.86"></a> |
| <FONT color="green">087</FONT> super.setLoginUrl(loginUrl);<a name="line.87"></a> |
| <FONT color="green">088</FONT> if (log.isTraceEnabled()) {<a name="line.88"></a> |
| <FONT color="green">089</FONT> log.trace("Adding login url to applied paths.");<a name="line.89"></a> |
| <FONT color="green">090</FONT> }<a name="line.90"></a> |
| <FONT color="green">091</FONT> this.appliedPaths.put(getLoginUrl(), null);<a name="line.91"></a> |
| <FONT color="green">092</FONT> }<a name="line.92"></a> |
| <FONT color="green">093</FONT> <a name="line.93"></a> |
| <FONT color="green">094</FONT> public String getUsernameParam() {<a name="line.94"></a> |
| <FONT color="green">095</FONT> return usernameParam;<a name="line.95"></a> |
| <FONT color="green">096</FONT> }<a name="line.96"></a> |
| <FONT color="green">097</FONT> <a name="line.97"></a> |
| <FONT color="green">098</FONT> /**<a name="line.98"></a> |
| <FONT color="green">099</FONT> * Sets the request parameter name to look for when acquiring the username. Unless overridden by calling this<a name="line.99"></a> |
| <FONT color="green">100</FONT> * method, the default is <code>username</code>.<a name="line.100"></a> |
| <FONT color="green">101</FONT> *<a name="line.101"></a> |
| <FONT color="green">102</FONT> * @param usernameParam the name of the request param to check for acquiring the username.<a name="line.102"></a> |
| <FONT color="green">103</FONT> */<a name="line.103"></a> |
| <FONT color="green">104</FONT> public void setUsernameParam(String usernameParam) {<a name="line.104"></a> |
| <FONT color="green">105</FONT> this.usernameParam = usernameParam;<a name="line.105"></a> |
| <FONT color="green">106</FONT> }<a name="line.106"></a> |
| <FONT color="green">107</FONT> <a name="line.107"></a> |
| <FONT color="green">108</FONT> public String getPasswordParam() {<a name="line.108"></a> |
| <FONT color="green">109</FONT> return passwordParam;<a name="line.109"></a> |
| <FONT color="green">110</FONT> }<a name="line.110"></a> |
| <FONT color="green">111</FONT> <a name="line.111"></a> |
| <FONT color="green">112</FONT> /**<a name="line.112"></a> |
| <FONT color="green">113</FONT> * Sets the request parameter name to look for when acquiring the password. Unless overridden by calling this<a name="line.113"></a> |
| <FONT color="green">114</FONT> * method, the default is <code>password</code>.<a name="line.114"></a> |
| <FONT color="green">115</FONT> *<a name="line.115"></a> |
| <FONT color="green">116</FONT> * @param passwordParam the name of the request param to check for acquiring the password.<a name="line.116"></a> |
| <FONT color="green">117</FONT> */<a name="line.117"></a> |
| <FONT color="green">118</FONT> public void setPasswordParam(String passwordParam) {<a name="line.118"></a> |
| <FONT color="green">119</FONT> this.passwordParam = passwordParam;<a name="line.119"></a> |
| <FONT color="green">120</FONT> }<a name="line.120"></a> |
| <FONT color="green">121</FONT> <a name="line.121"></a> |
| <FONT color="green">122</FONT> public String getRememberMeParam() {<a name="line.122"></a> |
| <FONT color="green">123</FONT> return rememberMeParam;<a name="line.123"></a> |
| <FONT color="green">124</FONT> }<a name="line.124"></a> |
| <FONT color="green">125</FONT> <a name="line.125"></a> |
| <FONT color="green">126</FONT> /**<a name="line.126"></a> |
| <FONT color="green">127</FONT> * Sets the request parameter name to look for when acquiring the rememberMe boolean value. Unless overridden<a name="line.127"></a> |
| <FONT color="green">128</FONT> * by calling this method, the default is <code>rememberMe</code>.<a name="line.128"></a> |
| <FONT color="green">129</FONT> * <p/><a name="line.129"></a> |
| <FONT color="green">130</FONT> * RememberMe will be <code>true</code> if the parameter value equals any of those supported by<a name="line.130"></a> |
| <FONT color="green">131</FONT> * {@link org.apache.shiro.web.util.WebUtils#isTrue(javax.servlet.ServletRequest, String) WebUtils.isTrue(request,value)}, <code>false</code><a name="line.131"></a> |
| <FONT color="green">132</FONT> * otherwise.<a name="line.132"></a> |
| <FONT color="green">133</FONT> *<a name="line.133"></a> |
| <FONT color="green">134</FONT> * @param rememberMeParam the name of the request param to check for acquiring the rememberMe boolean value.<a name="line.134"></a> |
| <FONT color="green">135</FONT> */<a name="line.135"></a> |
| <FONT color="green">136</FONT> public void setRememberMeParam(String rememberMeParam) {<a name="line.136"></a> |
| <FONT color="green">137</FONT> this.rememberMeParam = rememberMeParam;<a name="line.137"></a> |
| <FONT color="green">138</FONT> }<a name="line.138"></a> |
| <FONT color="green">139</FONT> <a name="line.139"></a> |
| <FONT color="green">140</FONT> public String getFailureKeyAttribute() {<a name="line.140"></a> |
| <FONT color="green">141</FONT> return failureKeyAttribute;<a name="line.141"></a> |
| <FONT color="green">142</FONT> }<a name="line.142"></a> |
| <FONT color="green">143</FONT> <a name="line.143"></a> |
| <FONT color="green">144</FONT> public void setFailureKeyAttribute(String failureKeyAttribute) {<a name="line.144"></a> |
| <FONT color="green">145</FONT> this.failureKeyAttribute = failureKeyAttribute;<a name="line.145"></a> |
| <FONT color="green">146</FONT> }<a name="line.146"></a> |
| <FONT color="green">147</FONT> <a name="line.147"></a> |
| <FONT color="green">148</FONT> protected boolean onAccessDenied(ServletRequest request, ServletResponse response) throws Exception {<a name="line.148"></a> |
| <FONT color="green">149</FONT> if (isLoginRequest(request, response)) {<a name="line.149"></a> |
| <FONT color="green">150</FONT> if (isLoginSubmission(request, response)) {<a name="line.150"></a> |
| <FONT color="green">151</FONT> if (log.isTraceEnabled()) {<a name="line.151"></a> |
| <FONT color="green">152</FONT> log.trace("Login submission detected. Attempting to execute login.");<a name="line.152"></a> |
| <FONT color="green">153</FONT> }<a name="line.153"></a> |
| <FONT color="green">154</FONT> return executeLogin(request, response);<a name="line.154"></a> |
| <FONT color="green">155</FONT> } else {<a name="line.155"></a> |
| <FONT color="green">156</FONT> if (log.isTraceEnabled()) {<a name="line.156"></a> |
| <FONT color="green">157</FONT> log.trace("Login page view.");<a name="line.157"></a> |
| <FONT color="green">158</FONT> }<a name="line.158"></a> |
| <FONT color="green">159</FONT> //allow them to see the login page ;)<a name="line.159"></a> |
| <FONT color="green">160</FONT> return true;<a name="line.160"></a> |
| <FONT color="green">161</FONT> }<a name="line.161"></a> |
| <FONT color="green">162</FONT> } else {<a name="line.162"></a> |
| <FONT color="green">163</FONT> if (log.isTraceEnabled()) {<a name="line.163"></a> |
| <FONT color="green">164</FONT> log.trace("Attempting to access a path which requires authentication. Forwarding to the " +<a name="line.164"></a> |
| <FONT color="green">165</FONT> "Authentication url [" + getLoginUrl() + "]");<a name="line.165"></a> |
| <FONT color="green">166</FONT> }<a name="line.166"></a> |
| <FONT color="green">167</FONT> <a name="line.167"></a> |
| <FONT color="green">168</FONT> saveRequestAndRedirectToLogin(request, response);<a name="line.168"></a> |
| <FONT color="green">169</FONT> return false;<a name="line.169"></a> |
| <FONT color="green">170</FONT> }<a name="line.170"></a> |
| <FONT color="green">171</FONT> }<a name="line.171"></a> |
| <FONT color="green">172</FONT> <a name="line.172"></a> |
| <FONT color="green">173</FONT> /**<a name="line.173"></a> |
| <FONT color="green">174</FONT> * This default implementation merely returns <code>true</code> if the request is an HTTP <code>POST</code>,<a name="line.174"></a> |
| <FONT color="green">175</FONT> * <code>false</code> otherwise. Can be overridden by subclasses for custom login submission detection behavior.<a name="line.175"></a> |
| <FONT color="green">176</FONT> *<a name="line.176"></a> |
| <FONT color="green">177</FONT> * @param request the incoming ServletRequest<a name="line.177"></a> |
| <FONT color="green">178</FONT> * @param response the outgoing ServletResponse.<a name="line.178"></a> |
| <FONT color="green">179</FONT> * @return <code>true</code> if the request is an HTTP <code>POST</code>, <code>false</code> otherwise.<a name="line.179"></a> |
| <FONT color="green">180</FONT> */<a name="line.180"></a> |
| <FONT color="green">181</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.181"></a> |
| <FONT color="green">182</FONT> protected boolean isLoginSubmission(ServletRequest request, ServletResponse response) {<a name="line.182"></a> |
| <FONT color="green">183</FONT> return (request instanceof HttpServletRequest) && WebUtils.toHttp(request).getMethod().equalsIgnoreCase(POST_METHOD);<a name="line.183"></a> |
| <FONT color="green">184</FONT> }<a name="line.184"></a> |
| <FONT color="green">185</FONT> <a name="line.185"></a> |
| <FONT color="green">186</FONT> protected AuthenticationToken createToken(ServletRequest request, ServletResponse response) {<a name="line.186"></a> |
| <FONT color="green">187</FONT> String username = getUsername(request);<a name="line.187"></a> |
| <FONT color="green">188</FONT> String password = getPassword(request);<a name="line.188"></a> |
| <FONT color="green">189</FONT> return createToken(username, password, request, response);<a name="line.189"></a> |
| <FONT color="green">190</FONT> }<a name="line.190"></a> |
| <FONT color="green">191</FONT> <a name="line.191"></a> |
| <FONT color="green">192</FONT> protected boolean isRememberMe(ServletRequest request) {<a name="line.192"></a> |
| <FONT color="green">193</FONT> return WebUtils.isTrue(request, getRememberMeParam());<a name="line.193"></a> |
| <FONT color="green">194</FONT> }<a name="line.194"></a> |
| <FONT color="green">195</FONT> <a name="line.195"></a> |
| <FONT color="green">196</FONT> protected boolean onLoginSuccess(AuthenticationToken token, Subject subject,<a name="line.196"></a> |
| <FONT color="green">197</FONT> ServletRequest request, ServletResponse response) throws Exception {<a name="line.197"></a> |
| <FONT color="green">198</FONT> issueSuccessRedirect(request, response);<a name="line.198"></a> |
| <FONT color="green">199</FONT> //we handled the success redirect directly, prevent the chain from continuing:<a name="line.199"></a> |
| <FONT color="green">200</FONT> return false;<a name="line.200"></a> |
| <FONT color="green">201</FONT> }<a name="line.201"></a> |
| <FONT color="green">202</FONT> <a name="line.202"></a> |
| <FONT color="green">203</FONT> protected boolean onLoginFailure(AuthenticationToken token, AuthenticationException e,<a name="line.203"></a> |
| <FONT color="green">204</FONT> ServletRequest request, ServletResponse response) {<a name="line.204"></a> |
| <FONT color="green">205</FONT> setFailureAttribute(request, e);<a name="line.205"></a> |
| <FONT color="green">206</FONT> //login failed, let request continue back to the login page:<a name="line.206"></a> |
| <FONT color="green">207</FONT> return true;<a name="line.207"></a> |
| <FONT color="green">208</FONT> }<a name="line.208"></a> |
| <FONT color="green">209</FONT> <a name="line.209"></a> |
| <FONT color="green">210</FONT> protected void setFailureAttribute(ServletRequest request, AuthenticationException ae) {<a name="line.210"></a> |
| <FONT color="green">211</FONT> String className = ae.getClass().getName();<a name="line.211"></a> |
| <FONT color="green">212</FONT> request.setAttribute(getFailureKeyAttribute(), className);<a name="line.212"></a> |
| <FONT color="green">213</FONT> }<a name="line.213"></a> |
| <FONT color="green">214</FONT> <a name="line.214"></a> |
| <FONT color="green">215</FONT> protected String getUsername(ServletRequest request) {<a name="line.215"></a> |
| <FONT color="green">216</FONT> return WebUtils.getCleanParam(request, getUsernameParam());<a name="line.216"></a> |
| <FONT color="green">217</FONT> }<a name="line.217"></a> |
| <FONT color="green">218</FONT> <a name="line.218"></a> |
| <FONT color="green">219</FONT> protected String getPassword(ServletRequest request) {<a name="line.219"></a> |
| <FONT color="green">220</FONT> return WebUtils.getCleanParam(request, getPasswordParam());<a name="line.220"></a> |
| <FONT color="green">221</FONT> }<a name="line.221"></a> |
| <FONT color="green">222</FONT> <a name="line.222"></a> |
| <FONT color="green">223</FONT> <a name="line.223"></a> |
| <FONT color="green">224</FONT> }<a name="line.224"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
