blob: 4720f92ee4c44a7e8c0010fcd340498e7fcb46ee [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.mgt;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.mgt.DefaultSecurityManager;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.mgt.DefaultSubjectDAO;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.mgt.SessionStorageEvaluator;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.mgt.SubjectDAO;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.realm.Realm;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.shiro.session.mgt.SessionContext;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.shiro.session.mgt.SessionKey;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.shiro.session.mgt.SessionManager;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.shiro.subject.Subject;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.shiro.subject.SubjectContext;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.shiro.util.LifecycleUtils;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.shiro.web.servlet.ShiroHttpServletRequest;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.shiro.web.session.mgt.*;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.apache.shiro.web.subject.WebSubject;<a name="line.34"></a>
<FONT color="green">035</FONT> import org.apache.shiro.web.subject.WebSubjectContext;<a name="line.35"></a>
<FONT color="green">036</FONT> import org.apache.shiro.web.subject.support.DefaultWebSubjectContext;<a name="line.36"></a>
<FONT color="green">037</FONT> import org.apache.shiro.web.util.WebUtils;<a name="line.37"></a>
<FONT color="green">038</FONT> import org.slf4j.Logger;<a name="line.38"></a>
<FONT color="green">039</FONT> import org.slf4j.LoggerFactory;<a name="line.39"></a>
<FONT color="green">040</FONT> <a name="line.40"></a>
<FONT color="green">041</FONT> import javax.servlet.ServletRequest;<a name="line.41"></a>
<FONT color="green">042</FONT> import javax.servlet.ServletResponse;<a name="line.42"></a>
<FONT color="green">043</FONT> import java.io.Serializable;<a name="line.43"></a>
<FONT color="green">044</FONT> import java.util.Collection;<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> <a name="line.46"></a>
<FONT color="green">047</FONT> /**<a name="line.47"></a>
<FONT color="green">048</FONT> * Default {@link WebSecurityManager WebSecurityManager} implementation used in web-based applications or any<a name="line.48"></a>
<FONT color="green">049</FONT> * application that requires HTTP connectivity (SOAP, http remoting, etc).<a name="line.49"></a>
<FONT color="green">050</FONT> *<a name="line.50"></a>
<FONT color="green">051</FONT> * @since 0.2<a name="line.51"></a>
<FONT color="green">052</FONT> */<a name="line.52"></a>
<FONT color="green">053</FONT> public class DefaultWebSecurityManager extends DefaultSecurityManager implements WebSecurityManager {<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> //TODO - complete JavaDoc<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> private static final Logger log = LoggerFactory.getLogger(DefaultWebSecurityManager.class);<a name="line.57"></a>
<FONT color="green">058</FONT> <a name="line.58"></a>
<FONT color="green">059</FONT> @Deprecated<a name="line.59"></a>
<FONT color="green">060</FONT> public static final String HTTP_SESSION_MODE = "http";<a name="line.60"></a>
<FONT color="green">061</FONT> @Deprecated<a name="line.61"></a>
<FONT color="green">062</FONT> public static final String NATIVE_SESSION_MODE = "native";<a name="line.62"></a>
<FONT color="green">063</FONT> <a name="line.63"></a>
<FONT color="green">064</FONT> /**<a name="line.64"></a>
<FONT color="green">065</FONT> * @deprecated as of 1.2. This should NOT be used for anything other than determining if the sessionMode has changed.<a name="line.65"></a>
<FONT color="green">066</FONT> */<a name="line.66"></a>
<FONT color="green">067</FONT> @Deprecated<a name="line.67"></a>
<FONT color="green">068</FONT> private String sessionMode;<a name="line.68"></a>
<FONT color="green">069</FONT> <a name="line.69"></a>
<FONT color="green">070</FONT> public DefaultWebSecurityManager() {<a name="line.70"></a>
<FONT color="green">071</FONT> super();<a name="line.71"></a>
<FONT color="green">072</FONT> ((DefaultSubjectDAO) this.subjectDAO).setSessionStorageEvaluator(new DefaultWebSessionStorageEvaluator());<a name="line.72"></a>
<FONT color="green">073</FONT> this.sessionMode = HTTP_SESSION_MODE;<a name="line.73"></a>
<FONT color="green">074</FONT> setSubjectFactory(new DefaultWebSubjectFactory());<a name="line.74"></a>
<FONT color="green">075</FONT> setRememberMeManager(new CookieRememberMeManager());<a name="line.75"></a>
<FONT color="green">076</FONT> setSessionManager(new ServletContainerSessionManager());<a name="line.76"></a>
<FONT color="green">077</FONT> }<a name="line.77"></a>
<FONT color="green">078</FONT> <a name="line.78"></a>
<FONT color="green">079</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.79"></a>
<FONT color="green">080</FONT> public DefaultWebSecurityManager(Realm singleRealm) {<a name="line.80"></a>
<FONT color="green">081</FONT> this();<a name="line.81"></a>
<FONT color="green">082</FONT> setRealm(singleRealm);<a name="line.82"></a>
<FONT color="green">083</FONT> }<a name="line.83"></a>
<FONT color="green">084</FONT> <a name="line.84"></a>
<FONT color="green">085</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.85"></a>
<FONT color="green">086</FONT> public DefaultWebSecurityManager(Collection&lt;Realm&gt; realms) {<a name="line.86"></a>
<FONT color="green">087</FONT> this();<a name="line.87"></a>
<FONT color="green">088</FONT> setRealms(realms);<a name="line.88"></a>
<FONT color="green">089</FONT> }<a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> @Override<a name="line.91"></a>
<FONT color="green">092</FONT> protected SubjectContext createSubjectContext() {<a name="line.92"></a>
<FONT color="green">093</FONT> return new DefaultWebSubjectContext();<a name="line.93"></a>
<FONT color="green">094</FONT> }<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> @Override<a name="line.96"></a>
<FONT color="green">097</FONT> //since 1.2.1 for fixing SHIRO-350<a name="line.97"></a>
<FONT color="green">098</FONT> public void setSubjectDAO(SubjectDAO subjectDAO) {<a name="line.98"></a>
<FONT color="green">099</FONT> super.setSubjectDAO(subjectDAO);<a name="line.99"></a>
<FONT color="green">100</FONT> applySessionManagerToSessionStorageEvaluatorIfPossible();<a name="line.100"></a>
<FONT color="green">101</FONT> }<a name="line.101"></a>
<FONT color="green">102</FONT> <a name="line.102"></a>
<FONT color="green">103</FONT> //since 1.2.1 for fixing SHIRO-350<a name="line.103"></a>
<FONT color="green">104</FONT> @Override<a name="line.104"></a>
<FONT color="green">105</FONT> protected void afterSessionManagerSet() {<a name="line.105"></a>
<FONT color="green">106</FONT> super.afterSessionManagerSet();<a name="line.106"></a>
<FONT color="green">107</FONT> applySessionManagerToSessionStorageEvaluatorIfPossible();<a name="line.107"></a>
<FONT color="green">108</FONT> }<a name="line.108"></a>
<FONT color="green">109</FONT> <a name="line.109"></a>
<FONT color="green">110</FONT> //since 1.2.1 for fixing SHIRO-350:<a name="line.110"></a>
<FONT color="green">111</FONT> private void applySessionManagerToSessionStorageEvaluatorIfPossible() {<a name="line.111"></a>
<FONT color="green">112</FONT> SubjectDAO subjectDAO = getSubjectDAO();<a name="line.112"></a>
<FONT color="green">113</FONT> if (subjectDAO instanceof DefaultSubjectDAO) {<a name="line.113"></a>
<FONT color="green">114</FONT> SessionStorageEvaluator evaluator = ((DefaultSubjectDAO)subjectDAO).getSessionStorageEvaluator();<a name="line.114"></a>
<FONT color="green">115</FONT> if (evaluator instanceof DefaultWebSessionStorageEvaluator) {<a name="line.115"></a>
<FONT color="green">116</FONT> ((DefaultWebSessionStorageEvaluator)evaluator).setSessionManager(getSessionManager());<a name="line.116"></a>
<FONT color="green">117</FONT> }<a name="line.117"></a>
<FONT color="green">118</FONT> }<a name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
<FONT color="green">120</FONT> <a name="line.120"></a>
<FONT color="green">121</FONT> @Override<a name="line.121"></a>
<FONT color="green">122</FONT> protected SubjectContext copy(SubjectContext subjectContext) {<a name="line.122"></a>
<FONT color="green">123</FONT> if (subjectContext instanceof WebSubjectContext) {<a name="line.123"></a>
<FONT color="green">124</FONT> return new DefaultWebSubjectContext((WebSubjectContext) subjectContext);<a name="line.124"></a>
<FONT color="green">125</FONT> }<a name="line.125"></a>
<FONT color="green">126</FONT> return super.copy(subjectContext);<a name="line.126"></a>
<FONT color="green">127</FONT> }<a name="line.127"></a>
<FONT color="green">128</FONT> <a name="line.128"></a>
<FONT color="green">129</FONT> @SuppressWarnings({"UnusedDeclaration"})<a name="line.129"></a>
<FONT color="green">130</FONT> @Deprecated<a name="line.130"></a>
<FONT color="green">131</FONT> public String getSessionMode() {<a name="line.131"></a>
<FONT color="green">132</FONT> return sessionMode;<a name="line.132"></a>
<FONT color="green">133</FONT> }<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> * @param sessionMode<a name="line.136"></a>
<FONT color="green">137</FONT> * @deprecated since 1.2<a name="line.137"></a>
<FONT color="green">138</FONT> */<a name="line.138"></a>
<FONT color="green">139</FONT> @Deprecated<a name="line.139"></a>
<FONT color="green">140</FONT> public void setSessionMode(String sessionMode) {<a name="line.140"></a>
<FONT color="green">141</FONT> log.warn("The 'sessionMode' property has been deprecated. Please configure an appropriate WebSessionManager " +<a name="line.141"></a>
<FONT color="green">142</FONT> "instance instead of using this property. This property/method will be removed in a later version.");<a name="line.142"></a>
<FONT color="green">143</FONT> String mode = sessionMode;<a name="line.143"></a>
<FONT color="green">144</FONT> if (mode == null) {<a name="line.144"></a>
<FONT color="green">145</FONT> throw new IllegalArgumentException("sessionMode argument cannot be null.");<a name="line.145"></a>
<FONT color="green">146</FONT> }<a name="line.146"></a>
<FONT color="green">147</FONT> mode = sessionMode.toLowerCase();<a name="line.147"></a>
<FONT color="green">148</FONT> if (!HTTP_SESSION_MODE.equals(mode) &amp;&amp; !NATIVE_SESSION_MODE.equals(mode)) {<a name="line.148"></a>
<FONT color="green">149</FONT> String msg = "Invalid sessionMode [" + sessionMode + "]. Allowed values are " +<a name="line.149"></a>
<FONT color="green">150</FONT> "public static final String constants in the " + getClass().getName() + " class: '"<a name="line.150"></a>
<FONT color="green">151</FONT> + HTTP_SESSION_MODE + "' or '" + NATIVE_SESSION_MODE + "', with '" +<a name="line.151"></a>
<FONT color="green">152</FONT> HTTP_SESSION_MODE + "' being the default.";<a name="line.152"></a>
<FONT color="green">153</FONT> throw new IllegalArgumentException(msg);<a name="line.153"></a>
<FONT color="green">154</FONT> }<a name="line.154"></a>
<FONT color="green">155</FONT> boolean recreate = this.sessionMode == null || !this.sessionMode.equals(mode);<a name="line.155"></a>
<FONT color="green">156</FONT> this.sessionMode = mode;<a name="line.156"></a>
<FONT color="green">157</FONT> if (recreate) {<a name="line.157"></a>
<FONT color="green">158</FONT> LifecycleUtils.destroy(getSessionManager());<a name="line.158"></a>
<FONT color="green">159</FONT> SessionManager sessionManager = createSessionManager(mode);<a name="line.159"></a>
<FONT color="green">160</FONT> this.setInternalSessionManager(sessionManager);<a name="line.160"></a>
<FONT color="green">161</FONT> }<a name="line.161"></a>
<FONT color="green">162</FONT> }<a name="line.162"></a>
<FONT color="green">163</FONT> <a name="line.163"></a>
<FONT color="green">164</FONT> @Override<a name="line.164"></a>
<FONT color="green">165</FONT> public void setSessionManager(SessionManager sessionManager) {<a name="line.165"></a>
<FONT color="green">166</FONT> this.sessionMode = null;<a name="line.166"></a>
<FONT color="green">167</FONT> if (sessionManager != null &amp;&amp; !(sessionManager instanceof WebSessionManager)) {<a name="line.167"></a>
<FONT color="green">168</FONT> if (log.isWarnEnabled()) {<a name="line.168"></a>
<FONT color="green">169</FONT> String msg = "The " + getClass().getName() + " implementation expects SessionManager instances " +<a name="line.169"></a>
<FONT color="green">170</FONT> "that implement the " + WebSessionManager.class.getName() + " interface. The " +<a name="line.170"></a>
<FONT color="green">171</FONT> "configured instance is of type [" + sessionManager.getClass().getName() + "] which does not " +<a name="line.171"></a>
<FONT color="green">172</FONT> "implement this interface.. This may cause unexpected behavior.";<a name="line.172"></a>
<FONT color="green">173</FONT> log.warn(msg);<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> setInternalSessionManager(sessionManager);<a name="line.176"></a>
<FONT color="green">177</FONT> }<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> * @param sessionManager<a name="line.180"></a>
<FONT color="green">181</FONT> * @since 1.2<a name="line.181"></a>
<FONT color="green">182</FONT> */<a name="line.182"></a>
<FONT color="green">183</FONT> private void setInternalSessionManager(SessionManager sessionManager) {<a name="line.183"></a>
<FONT color="green">184</FONT> super.setSessionManager(sessionManager);<a name="line.184"></a>
<FONT color="green">185</FONT> }<a name="line.185"></a>
<FONT color="green">186</FONT> <a name="line.186"></a>
<FONT color="green">187</FONT> /**<a name="line.187"></a>
<FONT color="green">188</FONT> * @since 1.0<a name="line.188"></a>
<FONT color="green">189</FONT> */<a name="line.189"></a>
<FONT color="green">190</FONT> public boolean isHttpSessionMode() {<a name="line.190"></a>
<FONT color="green">191</FONT> SessionManager sessionManager = getSessionManager();<a name="line.191"></a>
<FONT color="green">192</FONT> return sessionManager instanceof WebSessionManager &amp;&amp; ((WebSessionManager)sessionManager).isServletContainerSessions();<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> protected SessionManager createSessionManager(String sessionMode) {<a name="line.195"></a>
<FONT color="green">196</FONT> if (sessionMode == null || !sessionMode.equalsIgnoreCase(NATIVE_SESSION_MODE)) {<a name="line.196"></a>
<FONT color="green">197</FONT> log.info("{} mode - enabling ServletContainerSessionManager (HTTP-only Sessions)", HTTP_SESSION_MODE);<a name="line.197"></a>
<FONT color="green">198</FONT> return new ServletContainerSessionManager();<a name="line.198"></a>
<FONT color="green">199</FONT> } else {<a name="line.199"></a>
<FONT color="green">200</FONT> log.info("{} mode - enabling DefaultWebSessionManager (non-HTTP and HTTP Sessions)", NATIVE_SESSION_MODE);<a name="line.200"></a>
<FONT color="green">201</FONT> return new DefaultWebSessionManager();<a name="line.201"></a>
<FONT color="green">202</FONT> }<a name="line.202"></a>
<FONT color="green">203</FONT> }<a name="line.203"></a>
<FONT color="green">204</FONT> <a name="line.204"></a>
<FONT color="green">205</FONT> @Override<a name="line.205"></a>
<FONT color="green">206</FONT> protected SessionContext createSessionContext(SubjectContext subjectContext) {<a name="line.206"></a>
<FONT color="green">207</FONT> SessionContext sessionContext = super.createSessionContext(subjectContext);<a name="line.207"></a>
<FONT color="green">208</FONT> if (subjectContext instanceof WebSubjectContext) {<a name="line.208"></a>
<FONT color="green">209</FONT> WebSubjectContext wsc = (WebSubjectContext) subjectContext;<a name="line.209"></a>
<FONT color="green">210</FONT> ServletRequest request = wsc.resolveServletRequest();<a name="line.210"></a>
<FONT color="green">211</FONT> ServletResponse response = wsc.resolveServletResponse();<a name="line.211"></a>
<FONT color="green">212</FONT> DefaultWebSessionContext webSessionContext = new DefaultWebSessionContext(sessionContext);<a name="line.212"></a>
<FONT color="green">213</FONT> if (request != null) {<a name="line.213"></a>
<FONT color="green">214</FONT> webSessionContext.setServletRequest(request);<a name="line.214"></a>
<FONT color="green">215</FONT> }<a name="line.215"></a>
<FONT color="green">216</FONT> if (response != null) {<a name="line.216"></a>
<FONT color="green">217</FONT> webSessionContext.setServletResponse(response);<a name="line.217"></a>
<FONT color="green">218</FONT> }<a name="line.218"></a>
<FONT color="green">219</FONT> <a name="line.219"></a>
<FONT color="green">220</FONT> sessionContext = webSessionContext;<a name="line.220"></a>
<FONT color="green">221</FONT> }<a name="line.221"></a>
<FONT color="green">222</FONT> return sessionContext;<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>
<FONT color="green">225</FONT> @Override<a name="line.225"></a>
<FONT color="green">226</FONT> protected SessionKey getSessionKey(SubjectContext context) {<a name="line.226"></a>
<FONT color="green">227</FONT> if (WebUtils.isWeb(context)) {<a name="line.227"></a>
<FONT color="green">228</FONT> Serializable sessionId = context.getSessionId();<a name="line.228"></a>
<FONT color="green">229</FONT> ServletRequest request = WebUtils.getRequest(context);<a name="line.229"></a>
<FONT color="green">230</FONT> ServletResponse response = WebUtils.getResponse(context);<a name="line.230"></a>
<FONT color="green">231</FONT> return new WebSessionKey(sessionId, request, response);<a name="line.231"></a>
<FONT color="green">232</FONT> } else {<a name="line.232"></a>
<FONT color="green">233</FONT> return super.getSessionKey(context);<a name="line.233"></a>
<FONT color="green">234</FONT> <a name="line.234"></a>
<FONT color="green">235</FONT> }<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> @Override<a name="line.238"></a>
<FONT color="green">239</FONT> protected void beforeLogout(Subject subject) {<a name="line.239"></a>
<FONT color="green">240</FONT> super.beforeLogout(subject);<a name="line.240"></a>
<FONT color="green">241</FONT> removeRequestIdentity(subject);<a name="line.241"></a>
<FONT color="green">242</FONT> }<a name="line.242"></a>
<FONT color="green">243</FONT> <a name="line.243"></a>
<FONT color="green">244</FONT> protected void removeRequestIdentity(Subject subject) {<a name="line.244"></a>
<FONT color="green">245</FONT> if (subject instanceof WebSubject) {<a name="line.245"></a>
<FONT color="green">246</FONT> WebSubject webSubject = (WebSubject) subject;<a name="line.246"></a>
<FONT color="green">247</FONT> ServletRequest request = webSubject.getServletRequest();<a name="line.247"></a>
<FONT color="green">248</FONT> if (request != null) {<a name="line.248"></a>
<FONT color="green">249</FONT> request.setAttribute(ShiroHttpServletRequest.IDENTITY_REMOVED_KEY, Boolean.TRUE);<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> }<a name="line.253"></a>
</PRE>
</BODY>
</HTML>