| <!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.AuthenticationException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.shiro.authc.AuthenticationToken;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.shiro.authc.UsernamePasswordToken;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.authz.UnauthenticatedException;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.subject.Subject;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import javax.servlet.ServletException;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import javax.servlet.ServletRequest;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import javax.servlet.ServletResponse;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.io.IOException;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.Arrays;<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> * An <code>AuthenticationFilter</code> that is capable of automatically performing an authentication attempt<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * based on the incoming request.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> *<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * @since 0.9<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>public abstract class AuthenticatingFilter extends AuthenticationFilter {<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> public static final String PERMISSIVE = "permissive";<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> //TODO - complete JavaDoc<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> protected boolean executeLogin(ServletRequest request, ServletResponse response) throws Exception {<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> AuthenticationToken token = createToken(request, response);<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> if (token == null) {<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> String msg = "createToken method implementation returned null. A valid non-null AuthenticationToken " +<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> "must be created in order to execute a login attempt.";<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> throw new IllegalStateException(msg);<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> }<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> try {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> Subject subject = getSubject(request, response);<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> subject.login(token);<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> return onLoginSuccess(token, subject, request, response);<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> } catch (AuthenticationException e) {<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> return onLoginFailure(token, e, request, response);<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> }<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> }<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> protected abstract AuthenticationToken createToken(ServletRequest request, ServletResponse response) throws Exception;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> protected AuthenticationToken createToken(String username, String password,<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> ServletRequest request, ServletResponse response) {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> boolean rememberMe = isRememberMe(request);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> String host = getHost(request);<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> return createToken(username, password, rememberMe, host);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> }<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> protected AuthenticationToken createToken(String username, String password,<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> boolean rememberMe, String host) {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> return new UsernamePasswordToken(username, password, rememberMe, host);<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> }<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> protected boolean onLoginSuccess(AuthenticationToken token, Subject subject,<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> ServletRequest request, ServletResponse response) throws Exception {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> return true;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> }<a name="line.77"></a> |
| <span class="sourceLineNo">078</span><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> protected boolean onLoginFailure(AuthenticationToken token, AuthenticationException e,<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> ServletRequest request, ServletResponse response) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> return false;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> }<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> /**<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Returns the host name or IP associated with the current subject. This method is primarily provided for use<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * during construction of an <code>AuthenticationToken</code>.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <p/><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * The default implementation merely returns {@link ServletRequest#getRemoteHost()}.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> *<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @param request the incoming ServletRequest<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @return the <code>InetAddress</code> to associate with the login attempt.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> protected String getHost(ServletRequest request) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> return request.getRemoteHost();<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> /**<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * Returns <code>true</code> if &quot;rememberMe&quot; should be enabled for the login attempt associated with the<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * current <code>request</code>, <code>false</code> otherwise.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * <p/><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * This implementation always returns <code>false</code> and is provided as a template hook to subclasses that<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * support <code>rememberMe</code> logins and wish to determine <code>rememberMe</code> in a custom mannner<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * based on the current <code>request</code>.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> *<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @param request the incoming ServletRequest<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @return <code>true</code> if &quot;rememberMe&quot; should be enabled for the login attempt associated with the<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * current <code>request</code>, <code>false</code> otherwise.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> protected boolean isRememberMe(ServletRequest request) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> return false;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> /**<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * Determines whether the current subject should be allowed to make the current request.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * <p/><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * The default implementation returns <code>true</code> if the user is authenticated. Will also return<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * <code>true</code> if the {@link #isLoginRequest} returns false and the &quot;permissive&quot; flag is set.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> *<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @return <code>true</code> if request should be allowed access<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> */<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> @Override<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> protected boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> return super.isAccessAllowed(request, response, mappedValue) ||<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> (!isLoginRequest(request, response) && isPermissive(mappedValue));<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> /**<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * Returns <code>true</code> if the mappedValue contains the {@link #PERMISSIVE} qualifier.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> *<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @return <code>true</code> if this filter should be permissive<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> */<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> protected boolean isPermissive(Object mappedValue) {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> if(mappedValue != null) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> String[] values = (String[]) mappedValue;<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> return Arrays.binarySearch(values, PERMISSIVE) >= 0;<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> }<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> return false;<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> /**<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * Overrides the default behavior to call {@link #onAccessDenied} and swallow the exception if the exception is<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * {@link UnauthenticatedException}.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> @Override<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> protected void cleanup(ServletRequest request, ServletResponse response, Exception existing) throws ServletException, IOException {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> if (existing instanceof UnauthenticatedException || (existing instanceof ServletException && existing.getCause() instanceof UnauthenticatedException))<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> try {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> onAccessDenied(request, response);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> existing = null;<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> } catch (Exception e) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> existing = e;<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> }<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> super.cleanup(request, response, existing);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> }<a name="line.157"></a> |
| <span class="sourceLineNo">158</span>}<a name="line.158"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
