| <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.servlet;<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.session.Session;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.subject.ExecutionException;<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.filter.mgt.FilterChainResolver;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.shiro.web.mgt.DefaultWebSecurityManager;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.apache.shiro.web.mgt.WebSecurityManager;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.apache.shiro.web.subject.WebSubject;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.slf4j.Logger;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import org.slf4j.LoggerFactory;<a name="line.30"></a> |
| <FONT color="green">031</FONT> <a name="line.31"></a> |
| <FONT color="green">032</FONT> import javax.servlet.FilterChain;<a name="line.32"></a> |
| <FONT color="green">033</FONT> import javax.servlet.ServletException;<a name="line.33"></a> |
| <FONT color="green">034</FONT> import javax.servlet.ServletRequest;<a name="line.34"></a> |
| <FONT color="green">035</FONT> import javax.servlet.ServletResponse;<a name="line.35"></a> |
| <FONT color="green">036</FONT> import javax.servlet.http.HttpServletRequest;<a name="line.36"></a> |
| <FONT color="green">037</FONT> import javax.servlet.http.HttpServletResponse;<a name="line.37"></a> |
| <FONT color="green">038</FONT> import java.io.IOException;<a name="line.38"></a> |
| <FONT color="green">039</FONT> import java.util.concurrent.Callable;<a name="line.39"></a> |
| <FONT color="green">040</FONT> <a name="line.40"></a> |
| <FONT color="green">041</FONT> /**<a name="line.41"></a> |
| <FONT color="green">042</FONT> * Abstract base class that provides all standard Shiro request filtering behavior and expects<a name="line.42"></a> |
| <FONT color="green">043</FONT> * subclasses to implement configuration-specific logic (INI, XML, .properties, etc).<a name="line.43"></a> |
| <FONT color="green">044</FONT> * <p/><a name="line.44"></a> |
| <FONT color="green">045</FONT> * Subclasses should perform configuration and construction logic in an overridden<a name="line.45"></a> |
| <FONT color="green">046</FONT> * {@link #init()} method implementation. That implementation should make available any constructed<a name="line.46"></a> |
| <FONT color="green">047</FONT> * {@code SecurityManager} and {@code FilterChainResolver} by calling<a name="line.47"></a> |
| <FONT color="green">048</FONT> * {@link #setSecurityManager(org.apache.shiro.web.mgt.WebSecurityManager)} and<a name="line.48"></a> |
| <FONT color="green">049</FONT> * {@link #setFilterChainResolver(org.apache.shiro.web.filter.mgt.FilterChainResolver)} methods respectively.<a name="line.49"></a> |
| <FONT color="green">050</FONT> * <h3>Static SecurityManager</h3><a name="line.50"></a> |
| <FONT color="green">051</FONT> * By default the {@code SecurityManager} instance enabled by this filter <em>will not</em> be enabled in static<a name="line.51"></a> |
| <FONT color="green">052</FONT> * memory via the {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}<a name="line.52"></a> |
| <FONT color="green">053</FONT> * method. Instead, it is expected that Subject instances will always be constructed on a request-processing thread<a name="line.53"></a> |
| <FONT color="green">054</FONT> * via instances of this Filter class.<a name="line.54"></a> |
| <FONT color="green">055</FONT> * <p/><a name="line.55"></a> |
| <FONT color="green">056</FONT> * However, if you need to construct {@code Subject} instances on separate (non request-processing) threads, it might<a name="line.56"></a> |
| <FONT color="green">057</FONT> * be easiest to enable the SecurityManager to be available in static memory via the<a name="line.57"></a> |
| <FONT color="green">058</FONT> * {@link SecurityUtils#getSecurityManager()} method. You can do this by additionally specifying an {@code init-param}:<a name="line.58"></a> |
| <FONT color="green">059</FONT> * <pre><a name="line.59"></a> |
| <FONT color="green">060</FONT> * &lt;filter&gt;<a name="line.60"></a> |
| <FONT color="green">061</FONT> * ... other config here ...<a name="line.61"></a> |
| <FONT color="green">062</FONT> * &lt;init-param&gt;<a name="line.62"></a> |
| <FONT color="green">063</FONT> * &lt;param-name&gt;staticSecurityManagerEnabled&lt;/param-name&gt;<a name="line.63"></a> |
| <FONT color="green">064</FONT> * &lt;param-value&gt;true&lt;/param-value&gt;<a name="line.64"></a> |
| <FONT color="green">065</FONT> * &lt;/init-param&gt;<a name="line.65"></a> |
| <FONT color="green">066</FONT> * &lt;/filter&gt;<a name="line.66"></a> |
| <FONT color="green">067</FONT> * </pre><a name="line.67"></a> |
| <FONT color="green">068</FONT> * See the Shiro <a href="http://shiro.apache.org/subject.html">Subject documentation</a> for more information as to<a name="line.68"></a> |
| <FONT color="green">069</FONT> * if you would do this, particularly the sections on the {@code Subject.Builder} and Thread Association.<a name="line.69"></a> |
| <FONT color="green">070</FONT> *<a name="line.70"></a> |
| <FONT color="green">071</FONT> * @since 1.0<a name="line.71"></a> |
| <FONT color="green">072</FONT> * @see <a href="http://shiro.apache.org/subject.html">Subject documentation</a><a name="line.72"></a> |
| <FONT color="green">073</FONT> */<a name="line.73"></a> |
| <FONT color="green">074</FONT> public abstract class AbstractShiroFilter extends OncePerRequestFilter {<a name="line.74"></a> |
| <FONT color="green">075</FONT> <a name="line.75"></a> |
| <FONT color="green">076</FONT> private static final Logger log = LoggerFactory.getLogger(AbstractShiroFilter.class);<a name="line.76"></a> |
| <FONT color="green">077</FONT> <a name="line.77"></a> |
| <FONT color="green">078</FONT> private static final String STATIC_INIT_PARAM_NAME = "staticSecurityManagerEnabled";<a name="line.78"></a> |
| <FONT color="green">079</FONT> <a name="line.79"></a> |
| <FONT color="green">080</FONT> // Reference to the security manager used by this filter<a name="line.80"></a> |
| <FONT color="green">081</FONT> private WebSecurityManager securityManager;<a name="line.81"></a> |
| <FONT color="green">082</FONT> <a name="line.82"></a> |
| <FONT color="green">083</FONT> // Used to determine which chain should handle an incoming request/response<a name="line.83"></a> |
| <FONT color="green">084</FONT> private FilterChainResolver filterChainResolver;<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> * Whether or not to bind the constructed SecurityManager instance to static memory (via<a name="line.87"></a> |
| <FONT color="green">088</FONT> * SecurityUtils.setSecurityManager). This was added to support https://issues.apache.org/jira/browse/SHIRO-287<a name="line.88"></a> |
| <FONT color="green">089</FONT> * @since 1.2<a name="line.89"></a> |
| <FONT color="green">090</FONT> */<a name="line.90"></a> |
| <FONT color="green">091</FONT> private boolean staticSecurityManagerEnabled;<a name="line.91"></a> |
| <FONT color="green">092</FONT> <a name="line.92"></a> |
| <FONT color="green">093</FONT> protected AbstractShiroFilter() {<a name="line.93"></a> |
| <FONT color="green">094</FONT> this.staticSecurityManagerEnabled = false;<a name="line.94"></a> |
| <FONT color="green">095</FONT> }<a name="line.95"></a> |
| <FONT color="green">096</FONT> <a name="line.96"></a> |
| <FONT color="green">097</FONT> public WebSecurityManager getSecurityManager() {<a name="line.97"></a> |
| <FONT color="green">098</FONT> return securityManager;<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> public void setSecurityManager(WebSecurityManager sm) {<a name="line.101"></a> |
| <FONT color="green">102</FONT> this.securityManager = sm;<a name="line.102"></a> |
| <FONT color="green">103</FONT> }<a name="line.103"></a> |
| <FONT color="green">104</FONT> <a name="line.104"></a> |
| <FONT color="green">105</FONT> public FilterChainResolver getFilterChainResolver() {<a name="line.105"></a> |
| <FONT color="green">106</FONT> return filterChainResolver;<a name="line.106"></a> |
| <FONT color="green">107</FONT> }<a name="line.107"></a> |
| <FONT color="green">108</FONT> <a name="line.108"></a> |
| <FONT color="green">109</FONT> public void setFilterChainResolver(FilterChainResolver filterChainResolver) {<a name="line.109"></a> |
| <FONT color="green">110</FONT> this.filterChainResolver = filterChainResolver;<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> /**<a name="line.113"></a> |
| <FONT color="green">114</FONT> * Returns {@code true} if the constructed {@link #getSecurityManager() securityManager} reference should be bound<a name="line.114"></a> |
| <FONT color="green">115</FONT> * to static memory (via<a name="line.115"></a> |
| <FONT color="green">116</FONT> * {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}),<a name="line.116"></a> |
| <FONT color="green">117</FONT> * {@code false} otherwise.<a name="line.117"></a> |
| <FONT color="green">118</FONT> * <p/><a name="line.118"></a> |
| <FONT color="green">119</FONT> * The default value is {@code false}.<a name="line.119"></a> |
| <FONT color="green">120</FONT> * <p/><a name="line.120"></a> |
| <FONT color="green">121</FONT> *<a name="line.121"></a> |
| <FONT color="green">122</FONT> *<a name="line.122"></a> |
| <FONT color="green">123</FONT> * @return {@code true} if the constructed {@link #getSecurityManager() securityManager} reference should be bound<a name="line.123"></a> |
| <FONT color="green">124</FONT> * to static memory (via {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}),<a name="line.124"></a> |
| <FONT color="green">125</FONT> * {@code false} otherwise.<a name="line.125"></a> |
| <FONT color="green">126</FONT> * @since 1.2<a name="line.126"></a> |
| <FONT color="green">127</FONT> * @see <a href="https://issues.apache.org/jira/browse/SHIRO-287">SHIRO-287</a><a name="line.127"></a> |
| <FONT color="green">128</FONT> */<a name="line.128"></a> |
| <FONT color="green">129</FONT> public boolean isStaticSecurityManagerEnabled() {<a name="line.129"></a> |
| <FONT color="green">130</FONT> return staticSecurityManagerEnabled;<a name="line.130"></a> |
| <FONT color="green">131</FONT> }<a name="line.131"></a> |
| <FONT color="green">132</FONT> <a name="line.132"></a> |
| <FONT color="green">133</FONT> /**<a name="line.133"></a> |
| <FONT color="green">134</FONT> * Sets if the constructed {@link #getSecurityManager() securityManager} reference should be bound<a name="line.134"></a> |
| <FONT color="green">135</FONT> * to static memory (via {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}).<a name="line.135"></a> |
| <FONT color="green">136</FONT> * <p/><a name="line.136"></a> |
| <FONT color="green">137</FONT> * The default value is {@code false}.<a name="line.137"></a> |
| <FONT color="green">138</FONT> *<a name="line.138"></a> |
| <FONT color="green">139</FONT> * @param staticSecurityManagerEnabled if the constructed {@link #getSecurityManager() securityManager} reference<a name="line.139"></a> |
| <FONT color="green">140</FONT> * should be bound to static memory (via<a name="line.140"></a> |
| <FONT color="green">141</FONT> * {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}).<a name="line.141"></a> |
| <FONT color="green">142</FONT> * @since 1.2<a name="line.142"></a> |
| <FONT color="green">143</FONT> * @see <a href="https://issues.apache.org/jira/browse/SHIRO-287">SHIRO-287</a><a name="line.143"></a> |
| <FONT color="green">144</FONT> */<a name="line.144"></a> |
| <FONT color="green">145</FONT> public void setStaticSecurityManagerEnabled(boolean staticSecurityManagerEnabled) {<a name="line.145"></a> |
| <FONT color="green">146</FONT> this.staticSecurityManagerEnabled = staticSecurityManagerEnabled;<a name="line.146"></a> |
| <FONT color="green">147</FONT> }<a name="line.147"></a> |
| <FONT color="green">148</FONT> <a name="line.148"></a> |
| <FONT color="green">149</FONT> protected final void onFilterConfigSet() throws Exception {<a name="line.149"></a> |
| <FONT color="green">150</FONT> //added in 1.2 for SHIRO-287:<a name="line.150"></a> |
| <FONT color="green">151</FONT> applyStaticSecurityManagerEnabledConfig();<a name="line.151"></a> |
| <FONT color="green">152</FONT> init();<a name="line.152"></a> |
| <FONT color="green">153</FONT> ensureSecurityManager();<a name="line.153"></a> |
| <FONT color="green">154</FONT> //added in 1.2 for SHIRO-287:<a name="line.154"></a> |
| <FONT color="green">155</FONT> if (isStaticSecurityManagerEnabled()) {<a name="line.155"></a> |
| <FONT color="green">156</FONT> SecurityUtils.setSecurityManager(getSecurityManager());<a name="line.156"></a> |
| <FONT color="green">157</FONT> }<a name="line.157"></a> |
| <FONT color="green">158</FONT> }<a name="line.158"></a> |
| <FONT color="green">159</FONT> <a name="line.159"></a> |
| <FONT color="green">160</FONT> /**<a name="line.160"></a> |
| <FONT color="green">161</FONT> * Checks if the init-param that configures the filter to use static memory has been configured, and if so,<a name="line.161"></a> |
| <FONT color="green">162</FONT> * sets the {@link #setStaticSecurityManagerEnabled(boolean)} attribute with the configured value.<a name="line.162"></a> |
| <FONT color="green">163</FONT> *<a name="line.163"></a> |
| <FONT color="green">164</FONT> * @since 1.2<a name="line.164"></a> |
| <FONT color="green">165</FONT> * @see <a href="https://issues.apache.org/jira/browse/SHIRO-287">SHIRO-287</a><a name="line.165"></a> |
| <FONT color="green">166</FONT> */<a name="line.166"></a> |
| <FONT color="green">167</FONT> private void applyStaticSecurityManagerEnabledConfig() {<a name="line.167"></a> |
| <FONT color="green">168</FONT> String value = getInitParam(STATIC_INIT_PARAM_NAME);<a name="line.168"></a> |
| <FONT color="green">169</FONT> if (value != null) {<a name="line.169"></a> |
| <FONT color="green">170</FONT> Boolean b = Boolean.valueOf(value);<a name="line.170"></a> |
| <FONT color="green">171</FONT> if (b != null) {<a name="line.171"></a> |
| <FONT color="green">172</FONT> setStaticSecurityManagerEnabled(b);<a name="line.172"></a> |
| <FONT color="green">173</FONT> }<a name="line.173"></a> |
| <FONT color="green">174</FONT> }<a name="line.174"></a> |
| <FONT color="green">175</FONT> }<a name="line.175"></a> |
| <FONT color="green">176</FONT> <a name="line.176"></a> |
| <FONT color="green">177</FONT> public void init() throws Exception {<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> * A fallback mechanism called in {@link #onFilterConfigSet()} to ensure that the<a name="line.181"></a> |
| <FONT color="green">182</FONT> * {@link #getSecurityManager() securityManager} property has been set by configuration, and if not,<a name="line.182"></a> |
| <FONT color="green">183</FONT> * creates one automatically.<a name="line.183"></a> |
| <FONT color="green">184</FONT> */<a name="line.184"></a> |
| <FONT color="green">185</FONT> private void ensureSecurityManager() {<a name="line.185"></a> |
| <FONT color="green">186</FONT> WebSecurityManager securityManager = getSecurityManager();<a name="line.186"></a> |
| <FONT color="green">187</FONT> if (securityManager == null) {<a name="line.187"></a> |
| <FONT color="green">188</FONT> log.info("No SecurityManager configured. Creating default.");<a name="line.188"></a> |
| <FONT color="green">189</FONT> securityManager = createDefaultSecurityManager();<a name="line.189"></a> |
| <FONT color="green">190</FONT> setSecurityManager(securityManager);<a name="line.190"></a> |
| <FONT color="green">191</FONT> }<a name="line.191"></a> |
| <FONT color="green">192</FONT> }<a name="line.192"></a> |
| <FONT color="green">193</FONT> <a name="line.193"></a> |
| <FONT color="green">194</FONT> protected WebSecurityManager createDefaultSecurityManager() {<a name="line.194"></a> |
| <FONT color="green">195</FONT> return new DefaultWebSecurityManager();<a name="line.195"></a> |
| <FONT color="green">196</FONT> }<a name="line.196"></a> |
| <FONT color="green">197</FONT> <a name="line.197"></a> |
| <FONT color="green">198</FONT> protected boolean isHttpSessions() {<a name="line.198"></a> |
| <FONT color="green">199</FONT> return getSecurityManager().isHttpSessionMode();<a name="line.199"></a> |
| <FONT color="green">200</FONT> }<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> * Wraps the original HttpServletRequest in a {@link ShiroHttpServletRequest}, which is required for supporting<a name="line.203"></a> |
| <FONT color="green">204</FONT> * Servlet Specification behavior backed by a {@link org.apache.shiro.subject.Subject Subject} instance.<a name="line.204"></a> |
| <FONT color="green">205</FONT> *<a name="line.205"></a> |
| <FONT color="green">206</FONT> * @param orig the original Servlet Container-provided incoming {@code HttpServletRequest} instance.<a name="line.206"></a> |
| <FONT color="green">207</FONT> * @return {@link ShiroHttpServletRequest ShiroHttpServletRequest} instance wrapping the original.<a name="line.207"></a> |
| <FONT color="green">208</FONT> * @since 1.0<a name="line.208"></a> |
| <FONT color="green">209</FONT> */<a name="line.209"></a> |
| <FONT color="green">210</FONT> protected ServletRequest wrapServletRequest(HttpServletRequest orig) {<a name="line.210"></a> |
| <FONT color="green">211</FONT> return new ShiroHttpServletRequest(orig, getServletContext(), isHttpSessions());<a name="line.211"></a> |
| <FONT color="green">212</FONT> }<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> * Prepares the {@code ServletRequest} instance that will be passed to the {@code FilterChain} for request<a name="line.215"></a> |
| <FONT color="green">216</FONT> * processing.<a name="line.216"></a> |
| <FONT color="green">217</FONT> * <p/><a name="line.217"></a> |
| <FONT color="green">218</FONT> * If the {@code ServletRequest} is an instance of {@link HttpServletRequest}, the value returned from this method<a name="line.218"></a> |
| <FONT color="green">219</FONT> * is obtained by calling {@link #wrapServletRequest(javax.servlet.http.HttpServletRequest)} to allow Shiro-specific<a name="line.219"></a> |
| <FONT color="green">220</FONT> * HTTP behavior, otherwise the original {@code ServletRequest} argument is returned.<a name="line.220"></a> |
| <FONT color="green">221</FONT> *<a name="line.221"></a> |
| <FONT color="green">222</FONT> * @param request the incoming ServletRequest<a name="line.222"></a> |
| <FONT color="green">223</FONT> * @param response the outgoing ServletResponse<a name="line.223"></a> |
| <FONT color="green">224</FONT> * @param chain the Servlet Container provided {@code FilterChain} that will receive the returned request.<a name="line.224"></a> |
| <FONT color="green">225</FONT> * @return the {@code ServletRequest} instance that will be passed to the {@code FilterChain} for request processing.<a name="line.225"></a> |
| <FONT color="green">226</FONT> * @since 1.0<a name="line.226"></a> |
| <FONT color="green">227</FONT> */<a name="line.227"></a> |
| <FONT color="green">228</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.228"></a> |
| <FONT color="green">229</FONT> protected ServletRequest prepareServletRequest(ServletRequest request, ServletResponse response, FilterChain chain) {<a name="line.229"></a> |
| <FONT color="green">230</FONT> ServletRequest toUse = request;<a name="line.230"></a> |
| <FONT color="green">231</FONT> if (request instanceof HttpServletRequest) {<a name="line.231"></a> |
| <FONT color="green">232</FONT> HttpServletRequest http = (HttpServletRequest) request;<a name="line.232"></a> |
| <FONT color="green">233</FONT> toUse = wrapServletRequest(http);<a name="line.233"></a> |
| <FONT color="green">234</FONT> }<a name="line.234"></a> |
| <FONT color="green">235</FONT> return toUse;<a name="line.235"></a> |
| <FONT color="green">236</FONT> }<a name="line.236"></a> |
| <FONT color="green">237</FONT> <a name="line.237"></a> |
| <FONT color="green">238</FONT> /**<a name="line.238"></a> |
| <FONT color="green">239</FONT> * Returns a new {@link ShiroHttpServletResponse} instance, wrapping the {@code orig} argument, in order to provide<a name="line.239"></a> |
| <FONT color="green">240</FONT> * correct URL rewriting behavior required by the Servlet Specification when using Shiro-based sessions (and not<a name="line.240"></a> |
| <FONT color="green">241</FONT> * Servlet Container HTTP-based sessions).<a name="line.241"></a> |
| <FONT color="green">242</FONT> *<a name="line.242"></a> |
| <FONT color="green">243</FONT> * @param orig the original {@code HttpServletResponse} instance provided by the Servlet Container.<a name="line.243"></a> |
| <FONT color="green">244</FONT> * @param request the {@code ShiroHttpServletRequest} instance wrapping the original request.<a name="line.244"></a> |
| <FONT color="green">245</FONT> * @return the wrapped ServletResponse instance to use during {@link FilterChain} execution.<a name="line.245"></a> |
| <FONT color="green">246</FONT> * @since 1.0<a name="line.246"></a> |
| <FONT color="green">247</FONT> */<a name="line.247"></a> |
| <FONT color="green">248</FONT> protected ServletResponse wrapServletResponse(HttpServletResponse orig, ShiroHttpServletRequest request) {<a name="line.248"></a> |
| <FONT color="green">249</FONT> return new ShiroHttpServletResponse(orig, getServletContext(), request);<a name="line.249"></a> |
| <FONT color="green">250</FONT> }<a name="line.250"></a> |
| <FONT color="green">251</FONT> <a name="line.251"></a> |
| <FONT color="green">252</FONT> /**<a name="line.252"></a> |
| <FONT color="green">253</FONT> * Prepares the {@code ServletResponse} instance that will be passed to the {@code FilterChain} for request<a name="line.253"></a> |
| <FONT color="green">254</FONT> * processing.<a name="line.254"></a> |
| <FONT color="green">255</FONT> * <p/><a name="line.255"></a> |
| <FONT color="green">256</FONT> * This implementation delegates to {@link #wrapServletRequest(javax.servlet.http.HttpServletRequest)}<a name="line.256"></a> |
| <FONT color="green">257</FONT> * only if Shiro-based sessions are enabled (that is, !{@link #isHttpSessions()}) and the request instance is a<a name="line.257"></a> |
| <FONT color="green">258</FONT> * {@link ShiroHttpServletRequest}. This ensures that any URL rewriting that occurs is handled correctly using the<a name="line.258"></a> |
| <FONT color="green">259</FONT> * Shiro-managed Session's sessionId and not a servlet container session ID.<a name="line.259"></a> |
| <FONT color="green">260</FONT> * <p/><a name="line.260"></a> |
| <FONT color="green">261</FONT> * If HTTP-based sessions are enabled (the default), then this method does nothing and just returns the<a name="line.261"></a> |
| <FONT color="green">262</FONT> * {@code ServletResponse} argument as-is, relying on the default Servlet Container URL rewriting logic.<a name="line.262"></a> |
| <FONT color="green">263</FONT> *<a name="line.263"></a> |
| <FONT color="green">264</FONT> * @param request the incoming ServletRequest<a name="line.264"></a> |
| <FONT color="green">265</FONT> * @param response the outgoing ServletResponse<a name="line.265"></a> |
| <FONT color="green">266</FONT> * @param chain the Servlet Container provided {@code FilterChain} that will receive the returned request.<a name="line.266"></a> |
| <FONT color="green">267</FONT> * @return the {@code ServletResponse} instance that will be passed to the {@code FilterChain} during request processing.<a name="line.267"></a> |
| <FONT color="green">268</FONT> * @since 1.0<a name="line.268"></a> |
| <FONT color="green">269</FONT> */<a name="line.269"></a> |
| <FONT color="green">270</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.270"></a> |
| <FONT color="green">271</FONT> protected ServletResponse prepareServletResponse(ServletRequest request, ServletResponse response, FilterChain chain) {<a name="line.271"></a> |
| <FONT color="green">272</FONT> ServletResponse toUse = response;<a name="line.272"></a> |
| <FONT color="green">273</FONT> if (!isHttpSessions() && (request instanceof ShiroHttpServletRequest) &&<a name="line.273"></a> |
| <FONT color="green">274</FONT> (response instanceof HttpServletResponse)) {<a name="line.274"></a> |
| <FONT color="green">275</FONT> //the ShiroHttpServletResponse exists to support URL rewriting for session ids. This is only needed if<a name="line.275"></a> |
| <FONT color="green">276</FONT> //using Shiro sessions (i.e. not simple HttpSession based sessions):<a name="line.276"></a> |
| <FONT color="green">277</FONT> toUse = wrapServletResponse((HttpServletResponse) response, (ShiroHttpServletRequest) request);<a name="line.277"></a> |
| <FONT color="green">278</FONT> }<a name="line.278"></a> |
| <FONT color="green">279</FONT> return toUse;<a name="line.279"></a> |
| <FONT color="green">280</FONT> }<a name="line.280"></a> |
| <FONT color="green">281</FONT> <a name="line.281"></a> |
| <FONT color="green">282</FONT> /**<a name="line.282"></a> |
| <FONT color="green">283</FONT> * Creates a {@link WebSubject} instance to associate with the incoming request/response pair which will be used<a name="line.283"></a> |
| <FONT color="green">284</FONT> * throughout the request/response execution.<a name="line.284"></a> |
| <FONT color="green">285</FONT> *<a name="line.285"></a> |
| <FONT color="green">286</FONT> * @param request the incoming {@code ServletRequest}<a name="line.286"></a> |
| <FONT color="green">287</FONT> * @param response the outgoing {@code ServletResponse}<a name="line.287"></a> |
| <FONT color="green">288</FONT> * @return the {@code WebSubject} instance to associate with the request/response execution<a name="line.288"></a> |
| <FONT color="green">289</FONT> * @since 1.0<a name="line.289"></a> |
| <FONT color="green">290</FONT> */<a name="line.290"></a> |
| <FONT color="green">291</FONT> protected WebSubject createSubject(ServletRequest request, ServletResponse response) {<a name="line.291"></a> |
| <FONT color="green">292</FONT> return new WebSubject.Builder(getSecurityManager(), request, response).buildWebSubject();<a name="line.292"></a> |
| <FONT color="green">293</FONT> }<a name="line.293"></a> |
| <FONT color="green">294</FONT> <a name="line.294"></a> |
| <FONT color="green">295</FONT> /**<a name="line.295"></a> |
| <FONT color="green">296</FONT> * Updates any 'native' Session's last access time that might exist to the timestamp when this method is called.<a name="line.296"></a> |
| <FONT color="green">297</FONT> * If native sessions are not enabled (that is, standard Servlet container sessions are being used) or there is no<a name="line.297"></a> |
| <FONT color="green">298</FONT> * session ({@code subject.getSession(false) == null}), this method does nothing.<a name="line.298"></a> |
| <FONT color="green">299</FONT> * <p/>This method implementation merely calls<a name="line.299"></a> |
| <FONT color="green">300</FONT> * <code>Session.{@link org.apache.shiro.session.Session#touch() touch}()</code> on the session.<a name="line.300"></a> |
| <FONT color="green">301</FONT> *<a name="line.301"></a> |
| <FONT color="green">302</FONT> * @param request incoming request - ignored, but available to subclasses that might wish to override this method<a name="line.302"></a> |
| <FONT color="green">303</FONT> * @param response outgoing response - ignored, but available to subclasses that might wish to override this method<a name="line.303"></a> |
| <FONT color="green">304</FONT> * @since 1.0<a name="line.304"></a> |
| <FONT color="green">305</FONT> */<a name="line.305"></a> |
| <FONT color="green">306</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.306"></a> |
| <FONT color="green">307</FONT> protected void updateSessionLastAccessTime(ServletRequest request, ServletResponse response) {<a name="line.307"></a> |
| <FONT color="green">308</FONT> if (!isHttpSessions()) { //'native' sessions<a name="line.308"></a> |
| <FONT color="green">309</FONT> Subject subject = SecurityUtils.getSubject();<a name="line.309"></a> |
| <FONT color="green">310</FONT> //Subject should never _ever_ be null, but just in case:<a name="line.310"></a> |
| <FONT color="green">311</FONT> if (subject != null) {<a name="line.311"></a> |
| <FONT color="green">312</FONT> Session session = subject.getSession(false);<a name="line.312"></a> |
| <FONT color="green">313</FONT> if (session != null) {<a name="line.313"></a> |
| <FONT color="green">314</FONT> try {<a name="line.314"></a> |
| <FONT color="green">315</FONT> session.touch();<a name="line.315"></a> |
| <FONT color="green">316</FONT> } catch (Throwable t) {<a name="line.316"></a> |
| <FONT color="green">317</FONT> log.error("session.touch() method invocation has failed. Unable to update" +<a name="line.317"></a> |
| <FONT color="green">318</FONT> "the corresponding session's last access time based on the incoming request.", t);<a name="line.318"></a> |
| <FONT color="green">319</FONT> }<a name="line.319"></a> |
| <FONT color="green">320</FONT> }<a name="line.320"></a> |
| <FONT color="green">321</FONT> }<a name="line.321"></a> |
| <FONT color="green">322</FONT> }<a name="line.322"></a> |
| <FONT color="green">323</FONT> }<a name="line.323"></a> |
| <FONT color="green">324</FONT> <a name="line.324"></a> |
| <FONT color="green">325</FONT> /**<a name="line.325"></a> |
| <FONT color="green">326</FONT> * {@code doFilterInternal} implementation that sets-up, executes, and cleans-up a Shiro-filtered request. It<a name="line.326"></a> |
| <FONT color="green">327</FONT> * performs the following ordered operations:<a name="line.327"></a> |
| <FONT color="green">328</FONT> * <ol><a name="line.328"></a> |
| <FONT color="green">329</FONT> * <li>{@link #prepareServletRequest(ServletRequest, ServletResponse, FilterChain) Prepares}<a name="line.329"></a> |
| <FONT color="green">330</FONT> * the incoming {@code ServletRequest} for use during Shiro's processing</li><a name="line.330"></a> |
| <FONT color="green">331</FONT> * <li>{@link #prepareServletResponse(ServletRequest, ServletResponse, FilterChain) Prepares}<a name="line.331"></a> |
| <FONT color="green">332</FONT> * the outgoing {@code ServletResponse} for use during Shiro's processing</li><a name="line.332"></a> |
| <FONT color="green">333</FONT> * <li> {@link #createSubject(javax.servlet.ServletRequest, javax.servlet.ServletResponse) Creates} a<a name="line.333"></a> |
| <FONT color="green">334</FONT> * {@link Subject} instance based on the specified request/response pair.</li><a name="line.334"></a> |
| <FONT color="green">335</FONT> * <li>Finally {@link Subject#execute(Runnable) executes} the<a name="line.335"></a> |
| <FONT color="green">336</FONT> * {@link #updateSessionLastAccessTime(javax.servlet.ServletRequest, javax.servlet.ServletResponse)} and<a name="line.336"></a> |
| <FONT color="green">337</FONT> * {@link #executeChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)}<a name="line.337"></a> |
| <FONT color="green">338</FONT> * methods</li><a name="line.338"></a> |
| <FONT color="green">339</FONT> * </ol><a name="line.339"></a> |
| <FONT color="green">340</FONT> * <p/><a name="line.340"></a> |
| <FONT color="green">341</FONT> * The {@code Subject.}{@link Subject#execute(Runnable) execute(Runnable)} call in step #4 is used as an<a name="line.341"></a> |
| <FONT color="green">342</FONT> * implementation technique to guarantee proper thread binding and restoration is completed successfully.<a name="line.342"></a> |
| <FONT color="green">343</FONT> *<a name="line.343"></a> |
| <FONT color="green">344</FONT> * @param servletRequest the incoming {@code ServletRequest}<a name="line.344"></a> |
| <FONT color="green">345</FONT> * @param servletResponse the outgoing {@code ServletResponse}<a name="line.345"></a> |
| <FONT color="green">346</FONT> * @param chain the container-provided {@code FilterChain} to execute<a name="line.346"></a> |
| <FONT color="green">347</FONT> * @throws IOException if an IO error occurs<a name="line.347"></a> |
| <FONT color="green">348</FONT> * @throws javax.servlet.ServletException if an Throwable other than an IOException<a name="line.348"></a> |
| <FONT color="green">349</FONT> */<a name="line.349"></a> |
| <FONT color="green">350</FONT> protected void doFilterInternal(ServletRequest servletRequest, ServletResponse servletResponse, final FilterChain chain)<a name="line.350"></a> |
| <FONT color="green">351</FONT> throws ServletException, IOException {<a name="line.351"></a> |
| <FONT color="green">352</FONT> <a name="line.352"></a> |
| <FONT color="green">353</FONT> Throwable t = null;<a name="line.353"></a> |
| <FONT color="green">354</FONT> <a name="line.354"></a> |
| <FONT color="green">355</FONT> try {<a name="line.355"></a> |
| <FONT color="green">356</FONT> final ServletRequest request = prepareServletRequest(servletRequest, servletResponse, chain);<a name="line.356"></a> |
| <FONT color="green">357</FONT> final ServletResponse response = prepareServletResponse(request, servletResponse, chain);<a name="line.357"></a> |
| <FONT color="green">358</FONT> <a name="line.358"></a> |
| <FONT color="green">359</FONT> final Subject subject = createSubject(request, response);<a name="line.359"></a> |
| <FONT color="green">360</FONT> <a name="line.360"></a> |
| <FONT color="green">361</FONT> //noinspection unchecked<a name="line.361"></a> |
| <FONT color="green">362</FONT> subject.execute(new Callable() {<a name="line.362"></a> |
| <FONT color="green">363</FONT> public Object call() throws Exception {<a name="line.363"></a> |
| <FONT color="green">364</FONT> updateSessionLastAccessTime(request, response);<a name="line.364"></a> |
| <FONT color="green">365</FONT> executeChain(request, response, chain);<a name="line.365"></a> |
| <FONT color="green">366</FONT> return null;<a name="line.366"></a> |
| <FONT color="green">367</FONT> }<a name="line.367"></a> |
| <FONT color="green">368</FONT> });<a name="line.368"></a> |
| <FONT color="green">369</FONT> } catch (ExecutionException ex) {<a name="line.369"></a> |
| <FONT color="green">370</FONT> t = ex.getCause();<a name="line.370"></a> |
| <FONT color="green">371</FONT> } catch (Throwable throwable) {<a name="line.371"></a> |
| <FONT color="green">372</FONT> t = throwable;<a name="line.372"></a> |
| <FONT color="green">373</FONT> }<a name="line.373"></a> |
| <FONT color="green">374</FONT> <a name="line.374"></a> |
| <FONT color="green">375</FONT> if (t != null) {<a name="line.375"></a> |
| <FONT color="green">376</FONT> if (t instanceof ServletException) {<a name="line.376"></a> |
| <FONT color="green">377</FONT> throw (ServletException) t;<a name="line.377"></a> |
| <FONT color="green">378</FONT> }<a name="line.378"></a> |
| <FONT color="green">379</FONT> if (t instanceof IOException) {<a name="line.379"></a> |
| <FONT color="green">380</FONT> throw (IOException) t;<a name="line.380"></a> |
| <FONT color="green">381</FONT> }<a name="line.381"></a> |
| <FONT color="green">382</FONT> //otherwise it's not one of the two exceptions expected by the filter method signature - wrap it in one:<a name="line.382"></a> |
| <FONT color="green">383</FONT> String msg = "Filtered request failed.";<a name="line.383"></a> |
| <FONT color="green">384</FONT> throw new ServletException(msg, t);<a name="line.384"></a> |
| <FONT color="green">385</FONT> }<a name="line.385"></a> |
| <FONT color="green">386</FONT> }<a name="line.386"></a> |
| <FONT color="green">387</FONT> <a name="line.387"></a> |
| <FONT color="green">388</FONT> /**<a name="line.388"></a> |
| <FONT color="green">389</FONT> * Returns the {@code FilterChain} to execute for the given request.<a name="line.389"></a> |
| <FONT color="green">390</FONT> * <p/><a name="line.390"></a> |
| <FONT color="green">391</FONT> * The {@code origChain} argument is the<a name="line.391"></a> |
| <FONT color="green">392</FONT> * original {@code FilterChain} supplied by the Servlet Container, but it may be modified to provide<a name="line.392"></a> |
| <FONT color="green">393</FONT> * more behavior by pre-pending further chains according to the Shiro configuration.<a name="line.393"></a> |
| <FONT color="green">394</FONT> * <p/><a name="line.394"></a> |
| <FONT color="green">395</FONT> * This implementation returns the chain that will actually be executed by acquiring the chain from a<a name="line.395"></a> |
| <FONT color="green">396</FONT> * {@link #getFilterChainResolver() filterChainResolver}. The resolver determines exactly which chain to<a name="line.396"></a> |
| <FONT color="green">397</FONT> * execute, typically based on URL configuration. If no chain is returned from the resolver call<a name="line.397"></a> |
| <FONT color="green">398</FONT> * (returns {@code null}), then the {@code origChain} will be returned by default.<a name="line.398"></a> |
| <FONT color="green">399</FONT> *<a name="line.399"></a> |
| <FONT color="green">400</FONT> * @param request the incoming ServletRequest<a name="line.400"></a> |
| <FONT color="green">401</FONT> * @param response the outgoing ServletResponse<a name="line.401"></a> |
| <FONT color="green">402</FONT> * @param origChain the original {@code FilterChain} provided by the Servlet Container<a name="line.402"></a> |
| <FONT color="green">403</FONT> * @return the {@link FilterChain} to execute for the given request<a name="line.403"></a> |
| <FONT color="green">404</FONT> * @since 1.0<a name="line.404"></a> |
| <FONT color="green">405</FONT> */<a name="line.405"></a> |
| <FONT color="green">406</FONT> protected FilterChain getExecutionChain(ServletRequest request, ServletResponse response, FilterChain origChain) {<a name="line.406"></a> |
| <FONT color="green">407</FONT> FilterChain chain = origChain;<a name="line.407"></a> |
| <FONT color="green">408</FONT> <a name="line.408"></a> |
| <FONT color="green">409</FONT> FilterChainResolver resolver = getFilterChainResolver();<a name="line.409"></a> |
| <FONT color="green">410</FONT> if (resolver == null) {<a name="line.410"></a> |
| <FONT color="green">411</FONT> log.debug("No FilterChainResolver configured. Returning original FilterChain.");<a name="line.411"></a> |
| <FONT color="green">412</FONT> return origChain;<a name="line.412"></a> |
| <FONT color="green">413</FONT> }<a name="line.413"></a> |
| <FONT color="green">414</FONT> <a name="line.414"></a> |
| <FONT color="green">415</FONT> FilterChain resolved = resolver.getChain(request, response, origChain);<a name="line.415"></a> |
| <FONT color="green">416</FONT> if (resolved != null) {<a name="line.416"></a> |
| <FONT color="green">417</FONT> log.trace("Resolved a configured FilterChain for the current request.");<a name="line.417"></a> |
| <FONT color="green">418</FONT> chain = resolved;<a name="line.418"></a> |
| <FONT color="green">419</FONT> } else {<a name="line.419"></a> |
| <FONT color="green">420</FONT> log.trace("No FilterChain configured for the current request. Using the default.");<a name="line.420"></a> |
| <FONT color="green">421</FONT> }<a name="line.421"></a> |
| <FONT color="green">422</FONT> <a name="line.422"></a> |
| <FONT color="green">423</FONT> return chain;<a name="line.423"></a> |
| <FONT color="green">424</FONT> }<a name="line.424"></a> |
| <FONT color="green">425</FONT> <a name="line.425"></a> |
| <FONT color="green">426</FONT> /**<a name="line.426"></a> |
| <FONT color="green">427</FONT> * Executes a {@link FilterChain} for the given request.<a name="line.427"></a> |
| <FONT color="green">428</FONT> * <p/><a name="line.428"></a> |
| <FONT color="green">429</FONT> * This implementation first delegates to<a name="line.429"></a> |
| <FONT color="green">430</FONT> * <code>{@link #getExecutionChain(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain) getExecutionChain}</code><a name="line.430"></a> |
| <FONT color="green">431</FONT> * to allow the application's Shiro configuration to determine exactly how the chain should execute. The resulting<a name="line.431"></a> |
| <FONT color="green">432</FONT> * value from that call is then executed directly by calling the returned {@code FilterChain}'s<a name="line.432"></a> |
| <FONT color="green">433</FONT> * {@link FilterChain#doFilter doFilter} method. That is:<a name="line.433"></a> |
| <FONT color="green">434</FONT> * <pre><a name="line.434"></a> |
| <FONT color="green">435</FONT> * FilterChain chain = {@link #getExecutionChain}(request, response, origChain);<a name="line.435"></a> |
| <FONT color="green">436</FONT> * chain.{@link FilterChain#doFilter doFilter}(request,response);</pre><a name="line.436"></a> |
| <FONT color="green">437</FONT> *<a name="line.437"></a> |
| <FONT color="green">438</FONT> * @param request the incoming ServletRequest<a name="line.438"></a> |
| <FONT color="green">439</FONT> * @param response the outgoing ServletResponse<a name="line.439"></a> |
| <FONT color="green">440</FONT> * @param origChain the Servlet Container-provided chain that may be wrapped further by an application-configured<a name="line.440"></a> |
| <FONT color="green">441</FONT> * chain of Filters.<a name="line.441"></a> |
| <FONT color="green">442</FONT> * @throws IOException if the underlying {@code chain.doFilter} call results in an IOException<a name="line.442"></a> |
| <FONT color="green">443</FONT> * @throws ServletException if the underlying {@code chain.doFilter} call results in a ServletException<a name="line.443"></a> |
| <FONT color="green">444</FONT> * @since 1.0<a name="line.444"></a> |
| <FONT color="green">445</FONT> */<a name="line.445"></a> |
| <FONT color="green">446</FONT> protected void executeChain(ServletRequest request, ServletResponse response, FilterChain origChain)<a name="line.446"></a> |
| <FONT color="green">447</FONT> throws IOException, ServletException {<a name="line.447"></a> |
| <FONT color="green">448</FONT> FilterChain chain = getExecutionChain(request, response, origChain);<a name="line.448"></a> |
| <FONT color="green">449</FONT> chain.doFilter(request, response);<a name="line.449"></a> |
| <FONT color="green">450</FONT> }<a name="line.450"></a> |
| <FONT color="green">451</FONT> }<a name="line.451"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
