blob: a7dd330800788f5f7376e62f44088e6cf193db48 [file] [log] [blame]
<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;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.SecurityUtils;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.subject.Subject;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.web.util.WebUtils;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> import javax.servlet.ServletRequest;<a name="line.25"></a>
<FONT color="green">026</FONT> import javax.servlet.ServletResponse;<a name="line.26"></a>
<FONT color="green">027</FONT> import java.io.IOException;<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> /**<a name="line.29"></a>
<FONT color="green">030</FONT> * Superclass for any filter that controls access to a resource and may redirect the user to the login page<a name="line.30"></a>
<FONT color="green">031</FONT> * if they are not authenticated. This superclass provides the method<a name="line.31"></a>
<FONT color="green">032</FONT> * {@link #saveRequestAndRedirectToLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse)}<a name="line.32"></a>
<FONT color="green">033</FONT> * which is used by many subclasses as the behavior when a user is unauthenticated.<a name="line.33"></a>
<FONT color="green">034</FONT> *<a name="line.34"></a>
<FONT color="green">035</FONT> * @since 0.9<a name="line.35"></a>
<FONT color="green">036</FONT> */<a name="line.36"></a>
<FONT color="green">037</FONT> public abstract class AccessControlFilter extends PathMatchingFilter {<a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> /**<a name="line.39"></a>
<FONT color="green">040</FONT> * Simple default login URL equal to &lt;code&gt;/login.jsp&lt;/code&gt;, which can be overridden by calling the<a name="line.40"></a>
<FONT color="green">041</FONT> * {@link #setLoginUrl(String) setLoginUrl} method.<a name="line.41"></a>
<FONT color="green">042</FONT> */<a name="line.42"></a>
<FONT color="green">043</FONT> public static final String DEFAULT_LOGIN_URL = "/login.jsp";<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> /**<a name="line.45"></a>
<FONT color="green">046</FONT> * Constant representing the HTTP 'GET' request method, equal to &lt;code&gt;GET&lt;/code&gt;.<a name="line.46"></a>
<FONT color="green">047</FONT> */<a name="line.47"></a>
<FONT color="green">048</FONT> public static final String GET_METHOD = "GET";<a name="line.48"></a>
<FONT color="green">049</FONT> <a name="line.49"></a>
<FONT color="green">050</FONT> /**<a name="line.50"></a>
<FONT color="green">051</FONT> * Constant representing the HTTP 'POST' request method, equal to &lt;code&gt;POST&lt;/code&gt;.<a name="line.51"></a>
<FONT color="green">052</FONT> */<a name="line.52"></a>
<FONT color="green">053</FONT> public static final String POST_METHOD = "POST";<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> /**<a name="line.55"></a>
<FONT color="green">056</FONT> * The login url to used to authenticate a user, used when redirecting users if authentication is required.<a name="line.56"></a>
<FONT color="green">057</FONT> */<a name="line.57"></a>
<FONT color="green">058</FONT> private String loginUrl = DEFAULT_LOGIN_URL;<a name="line.58"></a>
<FONT color="green">059</FONT> <a name="line.59"></a>
<FONT color="green">060</FONT> /**<a name="line.60"></a>
<FONT color="green">061</FONT> * Returns the login URL used to authenticate a user.<a name="line.61"></a>
<FONT color="green">062</FONT> * &lt;p/&gt;<a name="line.62"></a>
<FONT color="green">063</FONT> * Most Shiro filters use this url<a name="line.63"></a>
<FONT color="green">064</FONT> * as the location to redirect a user when the filter requires authentication. Unless overridden, the<a name="line.64"></a>
<FONT color="green">065</FONT> * {@link #DEFAULT_LOGIN_URL DEFAULT_LOGIN_URL} is assumed, which can be overridden via<a name="line.65"></a>
<FONT color="green">066</FONT> * {@link #setLoginUrl(String) setLoginUrl}.<a name="line.66"></a>
<FONT color="green">067</FONT> *<a name="line.67"></a>
<FONT color="green">068</FONT> * @return the login URL used to authenticate a user, used when redirecting users if authentication is required.<a name="line.68"></a>
<FONT color="green">069</FONT> */<a name="line.69"></a>
<FONT color="green">070</FONT> public String getLoginUrl() {<a name="line.70"></a>
<FONT color="green">071</FONT> return loginUrl;<a name="line.71"></a>
<FONT color="green">072</FONT> }<a name="line.72"></a>
<FONT color="green">073</FONT> <a name="line.73"></a>
<FONT color="green">074</FONT> /**<a name="line.74"></a>
<FONT color="green">075</FONT> * Sets the login URL used to authenticate a user.<a name="line.75"></a>
<FONT color="green">076</FONT> * &lt;p/&gt;<a name="line.76"></a>
<FONT color="green">077</FONT> * Most Shiro filters use this url as the location to redirect a user when the filter requires<a name="line.77"></a>
<FONT color="green">078</FONT> * authentication. Unless overridden, the {@link #DEFAULT_LOGIN_URL DEFAULT_LOGIN_URL} is assumed.<a name="line.78"></a>
<FONT color="green">079</FONT> *<a name="line.79"></a>
<FONT color="green">080</FONT> * @param loginUrl the login URL used to authenticate a user, used when redirecting users if authentication is required.<a name="line.80"></a>
<FONT color="green">081</FONT> */<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> this.loginUrl = loginUrl;<a name="line.83"></a>
<FONT color="green">084</FONT> }<a name="line.84"></a>
<FONT color="green">085</FONT> <a name="line.85"></a>
<FONT color="green">086</FONT> /**<a name="line.86"></a>
<FONT color="green">087</FONT> * Convenience method that acquires the Subject associated with the request.<a name="line.87"></a>
<FONT color="green">088</FONT> * &lt;p/&gt;<a name="line.88"></a>
<FONT color="green">089</FONT> * The default implementation simply returns<a name="line.89"></a>
<FONT color="green">090</FONT> * {@link org.apache.shiro.SecurityUtils#getSubject() SecurityUtils.getSubject()}.<a name="line.90"></a>
<FONT color="green">091</FONT> *<a name="line.91"></a>
<FONT color="green">092</FONT> * @param request the incoming &lt;code&gt;ServletRequest&lt;/code&gt;<a name="line.92"></a>
<FONT color="green">093</FONT> * @param response the outgoing &lt;code&gt;ServletResponse&lt;/code&gt;<a name="line.93"></a>
<FONT color="green">094</FONT> * @return the Subject associated with the request.<a name="line.94"></a>
<FONT color="green">095</FONT> */<a name="line.95"></a>
<FONT color="green">096</FONT> protected Subject getSubject(ServletRequest request, ServletResponse response) {<a name="line.96"></a>
<FONT color="green">097</FONT> return SecurityUtils.getSubject();<a name="line.97"></a>
<FONT color="green">098</FONT> }<a name="line.98"></a>
<FONT color="green">099</FONT> <a name="line.99"></a>
<FONT color="green">100</FONT> /**<a name="line.100"></a>
<FONT color="green">101</FONT> * Returns &lt;code&gt;true&lt;/code&gt; if the request is allowed to proceed through the filter normally, or &lt;code&gt;false&lt;/code&gt;<a name="line.101"></a>
<FONT color="green">102</FONT> * if the request should be handled by the<a name="line.102"></a>
<FONT color="green">103</FONT> * {@link #onAccessDenied(ServletRequest,ServletResponse,Object) onAccessDenied(request,response,mappedValue)}<a name="line.103"></a>
<FONT color="green">104</FONT> * method instead.<a name="line.104"></a>
<FONT color="green">105</FONT> *<a name="line.105"></a>
<FONT color="green">106</FONT> * @param request the incoming &lt;code&gt;ServletRequest&lt;/code&gt;<a name="line.106"></a>
<FONT color="green">107</FONT> * @param response the outgoing &lt;code&gt;ServletResponse&lt;/code&gt;<a name="line.107"></a>
<FONT color="green">108</FONT> * @param mappedValue the filter-specific config value mapped to this filter in the URL rules mappings.<a name="line.108"></a>
<FONT color="green">109</FONT> * @return &lt;code&gt;true&lt;/code&gt; if the request should proceed through the filter normally, &lt;code&gt;false&lt;/code&gt; if the<a name="line.109"></a>
<FONT color="green">110</FONT> * request should be processed by this filter's<a name="line.110"></a>
<FONT color="green">111</FONT> * {@link #onAccessDenied(ServletRequest,ServletResponse,Object)} method instead.<a name="line.111"></a>
<FONT color="green">112</FONT> * @throws Exception if an error occurs during processing.<a name="line.112"></a>
<FONT color="green">113</FONT> */<a name="line.113"></a>
<FONT color="green">114</FONT> protected abstract boolean isAccessAllowed(ServletRequest request, ServletResponse response, Object mappedValue) throws Exception;<a name="line.114"></a>
<FONT color="green">115</FONT> <a name="line.115"></a>
<FONT color="green">116</FONT> /**<a name="line.116"></a>
<FONT color="green">117</FONT> * Processes requests where the subject was denied access as determined by the<a name="line.117"></a>
<FONT color="green">118</FONT> * {@link #isAccessAllowed(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Object) isAccessAllowed}<a name="line.118"></a>
<FONT color="green">119</FONT> * method, retaining the {@code mappedValue} that was used during configuration.<a name="line.119"></a>
<FONT color="green">120</FONT> * &lt;p/&gt;<a name="line.120"></a>
<FONT color="green">121</FONT> * This method immediately delegates to {@link #onAccessDenied(ServletRequest,ServletResponse)} as a<a name="line.121"></a>
<FONT color="green">122</FONT> * convenience in that most post-denial behavior does not need the mapped config again.<a name="line.122"></a>
<FONT color="green">123</FONT> *<a name="line.123"></a>
<FONT color="green">124</FONT> * @param request the incoming &lt;code&gt;ServletRequest&lt;/code&gt;<a name="line.124"></a>
<FONT color="green">125</FONT> * @param response the outgoing &lt;code&gt;ServletResponse&lt;/code&gt;<a name="line.125"></a>
<FONT color="green">126</FONT> * @param mappedValue the config specified for the filter in the matching request's filter chain.<a name="line.126"></a>
<FONT color="green">127</FONT> * @return &lt;code&gt;true&lt;/code&gt; if the request should continue to be processed; false if the subclass will<a name="line.127"></a>
<FONT color="green">128</FONT> * handle/render the response directly.<a name="line.128"></a>
<FONT color="green">129</FONT> * @throws Exception if there is an error processing the request.<a name="line.129"></a>
<FONT color="green">130</FONT> * @since 1.0<a name="line.130"></a>
<FONT color="green">131</FONT> */<a name="line.131"></a>
<FONT color="green">132</FONT> protected boolean onAccessDenied(ServletRequest request, ServletResponse response, Object mappedValue) throws Exception {<a name="line.132"></a>
<FONT color="green">133</FONT> return onAccessDenied(request, response);<a name="line.133"></a>
<FONT color="green">134</FONT> }<a name="line.134"></a>
<FONT color="green">135</FONT> <a name="line.135"></a>
<FONT color="green">136</FONT> /**<a name="line.136"></a>
<FONT color="green">137</FONT> * Processes requests where the subject was denied access as determined by the<a name="line.137"></a>
<FONT color="green">138</FONT> * {@link #isAccessAllowed(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Object) isAccessAllowed}<a name="line.138"></a>
<FONT color="green">139</FONT> * method.<a name="line.139"></a>
<FONT color="green">140</FONT> *<a name="line.140"></a>
<FONT color="green">141</FONT> * @param request the incoming &lt;code&gt;ServletRequest&lt;/code&gt;<a name="line.141"></a>
<FONT color="green">142</FONT> * @param response the outgoing &lt;code&gt;ServletResponse&lt;/code&gt;<a name="line.142"></a>
<FONT color="green">143</FONT> * @return &lt;code&gt;true&lt;/code&gt; if the request should continue to be processed; false if the subclass will<a name="line.143"></a>
<FONT color="green">144</FONT> * handle/render the response directly.<a name="line.144"></a>
<FONT color="green">145</FONT> * @throws Exception if there is an error processing the request.<a name="line.145"></a>
<FONT color="green">146</FONT> */<a name="line.146"></a>
<FONT color="green">147</FONT> protected abstract boolean onAccessDenied(ServletRequest request, ServletResponse response) throws Exception;<a name="line.147"></a>
<FONT color="green">148</FONT> <a name="line.148"></a>
<FONT color="green">149</FONT> /**<a name="line.149"></a>
<FONT color="green">150</FONT> * Returns &lt;code&gt;true&lt;/code&gt; if<a name="line.150"></a>
<FONT color="green">151</FONT> * {@link #isAccessAllowed(ServletRequest,ServletResponse,Object) isAccessAllowed(Request,Response,Object)},<a name="line.151"></a>
<FONT color="green">152</FONT> * otherwise returns the result of<a name="line.152"></a>
<FONT color="green">153</FONT> * {@link #onAccessDenied(ServletRequest,ServletResponse,Object) onAccessDenied(Request,Response,Object)}.<a name="line.153"></a>
<FONT color="green">154</FONT> *<a name="line.154"></a>
<FONT color="green">155</FONT> * @return &lt;code&gt;true&lt;/code&gt; if<a name="line.155"></a>
<FONT color="green">156</FONT> * {@link #isAccessAllowed(javax.servlet.ServletRequest, javax.servlet.ServletResponse, Object) isAccessAllowed},<a name="line.156"></a>
<FONT color="green">157</FONT> * otherwise returns the result of<a name="line.157"></a>
<FONT color="green">158</FONT> * {@link #onAccessDenied(javax.servlet.ServletRequest, javax.servlet.ServletResponse) onAccessDenied}.<a name="line.158"></a>
<FONT color="green">159</FONT> * @throws Exception if an error occurs.<a name="line.159"></a>
<FONT color="green">160</FONT> */<a name="line.160"></a>
<FONT color="green">161</FONT> public boolean onPreHandle(ServletRequest request, ServletResponse response, Object mappedValue) throws Exception {<a name="line.161"></a>
<FONT color="green">162</FONT> return isAccessAllowed(request, response, mappedValue) || onAccessDenied(request, response, mappedValue);<a name="line.162"></a>
<FONT color="green">163</FONT> }<a name="line.163"></a>
<FONT color="green">164</FONT> <a name="line.164"></a>
<FONT color="green">165</FONT> /**<a name="line.165"></a>
<FONT color="green">166</FONT> * Returns &lt;code&gt;true&lt;/code&gt; if the incoming request is a login request, &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.166"></a>
<FONT color="green">167</FONT> * &lt;p/&gt;<a name="line.167"></a>
<FONT color="green">168</FONT> * The default implementation merely returns &lt;code&gt;true&lt;/code&gt; if the incoming request matches the configured<a name="line.168"></a>
<FONT color="green">169</FONT> * {@link #getLoginUrl() loginUrl} by calling<a name="line.169"></a>
<FONT color="green">170</FONT> * &lt;code&gt;{@link #pathsMatch(String, String) pathsMatch(loginUrl, request)}&lt;/code&gt;.<a name="line.170"></a>
<FONT color="green">171</FONT> *<a name="line.171"></a>
<FONT color="green">172</FONT> * @param request the incoming &lt;code&gt;ServletRequest&lt;/code&gt;<a name="line.172"></a>
<FONT color="green">173</FONT> * @param response the outgoing &lt;code&gt;ServletResponse&lt;/code&gt;<a name="line.173"></a>
<FONT color="green">174</FONT> * @return &lt;code&gt;true&lt;/code&gt; if the incoming request is a login request, &lt;code&gt;false&lt;/code&gt; otherwise.<a name="line.174"></a>
<FONT color="green">175</FONT> */<a name="line.175"></a>
<FONT color="green">176</FONT> protected boolean isLoginRequest(ServletRequest request, ServletResponse response) {<a name="line.176"></a>
<FONT color="green">177</FONT> return pathsMatch(getLoginUrl(), request);<a name="line.177"></a>
<FONT color="green">178</FONT> }<a name="line.178"></a>
<FONT color="green">179</FONT> <a name="line.179"></a>
<FONT color="green">180</FONT> /**<a name="line.180"></a>
<FONT color="green">181</FONT> * Convenience method for subclasses to use when a login redirect is required.<a name="line.181"></a>
<FONT color="green">182</FONT> * &lt;p/&gt;<a name="line.182"></a>
<FONT color="green">183</FONT> * This implementation simply calls {@link #saveRequest(javax.servlet.ServletRequest) saveRequest(request)}<a name="line.183"></a>
<FONT color="green">184</FONT> * and then {@link #redirectToLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse) redirectToLogin(request,response)}.<a name="line.184"></a>
<FONT color="green">185</FONT> *<a name="line.185"></a>
<FONT color="green">186</FONT> * @param request the incoming &lt;code&gt;ServletRequest&lt;/code&gt;<a name="line.186"></a>
<FONT color="green">187</FONT> * @param response the outgoing &lt;code&gt;ServletResponse&lt;/code&gt;<a name="line.187"></a>
<FONT color="green">188</FONT> * @throws IOException if an error occurs.<a name="line.188"></a>
<FONT color="green">189</FONT> */<a name="line.189"></a>
<FONT color="green">190</FONT> protected void saveRequestAndRedirectToLogin(ServletRequest request, ServletResponse response) throws IOException {<a name="line.190"></a>
<FONT color="green">191</FONT> saveRequest(request);<a name="line.191"></a>
<FONT color="green">192</FONT> redirectToLogin(request, response);<a name="line.192"></a>
<FONT color="green">193</FONT> }<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> * Convenience method merely delegates to<a name="line.196"></a>
<FONT color="green">197</FONT> * {@link WebUtils#saveRequest(javax.servlet.ServletRequest) WebUtils.saveRequest(request)} to save the request<a name="line.197"></a>
<FONT color="green">198</FONT> * state for reuse later. This is mostly used to retain user request state when a redirect is issued to<a name="line.198"></a>
<FONT color="green">199</FONT> * return the user to their originally requested url/resource.<a name="line.199"></a>
<FONT color="green">200</FONT> * &lt;p/&gt;<a name="line.200"></a>
<FONT color="green">201</FONT> * If you need to save and then immediately redirect the user to login, consider using<a name="line.201"></a>
<FONT color="green">202</FONT> * {@link #saveRequestAndRedirectToLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse)<a name="line.202"></a>
<FONT color="green">203</FONT> * saveRequestAndRedirectToLogin(request,response)} directly.<a name="line.203"></a>
<FONT color="green">204</FONT> *<a name="line.204"></a>
<FONT color="green">205</FONT> * @param request the incoming ServletRequest to save for re-use later (for example, after a redirect).<a name="line.205"></a>
<FONT color="green">206</FONT> */<a name="line.206"></a>
<FONT color="green">207</FONT> protected void saveRequest(ServletRequest request) {<a name="line.207"></a>
<FONT color="green">208</FONT> WebUtils.saveRequest(request);<a name="line.208"></a>
<FONT color="green">209</FONT> }<a name="line.209"></a>
<FONT color="green">210</FONT> <a name="line.210"></a>
<FONT color="green">211</FONT> /**<a name="line.211"></a>
<FONT color="green">212</FONT> * Convenience method for subclasses that merely acquires the {@link #getLoginUrl() getLoginUrl} and redirects<a name="line.212"></a>
<FONT color="green">213</FONT> * the request to that url.<a name="line.213"></a>
<FONT color="green">214</FONT> * &lt;p/&gt;<a name="line.214"></a>
<FONT color="green">215</FONT> * &lt;b&gt;N.B.&lt;/b&gt; If you want to issue a redirect with the intention of allowing the user to then return to their<a name="line.215"></a>
<FONT color="green">216</FONT> * originally requested URL, don't use this method directly. Instead you should call<a name="line.216"></a>
<FONT color="green">217</FONT> * {@link #saveRequestAndRedirectToLogin(javax.servlet.ServletRequest, javax.servlet.ServletResponse)<a name="line.217"></a>
<FONT color="green">218</FONT> * saveRequestAndRedirectToLogin(request,response)}, which will save the current request state so that it can<a name="line.218"></a>
<FONT color="green">219</FONT> * be reconstructed and re-used after a successful login.<a name="line.219"></a>
<FONT color="green">220</FONT> *<a name="line.220"></a>
<FONT color="green">221</FONT> * @param request the incoming &lt;code&gt;ServletRequest&lt;/code&gt;<a name="line.221"></a>
<FONT color="green">222</FONT> * @param response the outgoing &lt;code&gt;ServletResponse&lt;/code&gt;<a name="line.222"></a>
<FONT color="green">223</FONT> * @throws IOException if an error occurs.<a name="line.223"></a>
<FONT color="green">224</FONT> */<a name="line.224"></a>
<FONT color="green">225</FONT> protected void redirectToLogin(ServletRequest request, ServletResponse response) throws IOException {<a name="line.225"></a>
<FONT color="green">226</FONT> String loginUrl = getLoginUrl();<a name="line.226"></a>
<FONT color="green">227</FONT> WebUtils.issueRedirect(request, response, loginUrl);<a name="line.227"></a>
<FONT color="green">228</FONT> }<a name="line.228"></a>
<FONT color="green">229</FONT> <a name="line.229"></a>
<FONT color="green">230</FONT> }<a name="line.230"></a>
</PRE>
</BODY>
</HTML>