| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> |
| <span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> *</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> */</a> |
| <span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.mgt;</a> |
| <span class="sourceLineNo">020</span><a id="line.20"></a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authc.AuthenticationException;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.authc.AuthenticationInfo;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.authc.AuthenticationToken;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.authc.Authenticator;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.authc.LogoutAware;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.authz.Authorizer;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import org.apache.shiro.realm.Realm;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import org.apache.shiro.session.InvalidSessionException;</a> |
| <span class="sourceLineNo">029</span><a id="line.29">import org.apache.shiro.session.Session;</a> |
| <span class="sourceLineNo">030</span><a id="line.30">import org.apache.shiro.session.mgt.DefaultSessionContext;</a> |
| <span class="sourceLineNo">031</span><a id="line.31">import org.apache.shiro.session.mgt.DefaultSessionKey;</a> |
| <span class="sourceLineNo">032</span><a id="line.32">import org.apache.shiro.session.mgt.SessionContext;</a> |
| <span class="sourceLineNo">033</span><a id="line.33">import org.apache.shiro.session.mgt.SessionKey;</a> |
| <span class="sourceLineNo">034</span><a id="line.34">import org.apache.shiro.subject.PrincipalCollection;</a> |
| <span class="sourceLineNo">035</span><a id="line.35">import org.apache.shiro.subject.Subject;</a> |
| <span class="sourceLineNo">036</span><a id="line.36">import org.apache.shiro.subject.SubjectContext;</a> |
| <span class="sourceLineNo">037</span><a id="line.37">import org.apache.shiro.subject.support.DefaultSubjectContext;</a> |
| <span class="sourceLineNo">038</span><a id="line.38">import org.apache.shiro.util.CollectionUtils;</a> |
| <span class="sourceLineNo">039</span><a id="line.39">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">040</span><a id="line.40">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">041</span><a id="line.41"></a> |
| <span class="sourceLineNo">042</span><a id="line.42">import java.io.Serializable;</a> |
| <span class="sourceLineNo">043</span><a id="line.43">import java.util.Collection;</a> |
| <span class="sourceLineNo">044</span><a id="line.44"></a> |
| <span class="sourceLineNo">045</span><a id="line.45">/**</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * The Shiro framework's default concrete implementation of the {@link SecurityManager} interface,</a> |
| <span class="sourceLineNo">047</span><a id="line.47"> * based around a collection of {@link org.apache.shiro.realm.Realm}s. This implementation delegates its</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * authentication, authorization, and session operations to wrapped {@link Authenticator}, {@link Authorizer}, and</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * {@link org.apache.shiro.session.mgt.SessionManager SessionManager} instances respectively via superclass</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * implementation.</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> * <p/></a> |
| <span class="sourceLineNo">052</span><a id="line.52"> * To greatly reduce and simplify configuration, this implementation (and its superclasses) will</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> * create suitable defaults for all of its required dependencies, <em>except</em> the required one or more</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> * {@link Realm Realm}s. Because {@code Realm} implementations usually interact with an application's data model,</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> * they are almost always application specific; you will want to specify at least one custom</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> * {@code Realm} implementation that 'knows' about your application's data/security model</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> * (via {@link #setRealm} or one of the overloaded constructors). All other attributes in this class hierarchy</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> * will have suitable defaults for most enterprise applications.</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> * <p/></a> |
| <span class="sourceLineNo">060</span><a id="line.60"> * <b>RememberMe notice</b>: This class supports the ability to configure a</a> |
| <span class="sourceLineNo">061</span><a id="line.61"> * {@link #setRememberMeManager RememberMeManager}</a> |
| <span class="sourceLineNo">062</span><a id="line.62"> * for {@code RememberMe} identity services for login/logout, BUT, a default instance <em>will not</em> be created</a> |
| <span class="sourceLineNo">063</span><a id="line.63"> * for this attribute at startup.</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * <p/></a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * Because RememberMe services are inherently client tier-specific and</a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * therefore aplication-dependent, if you want {@code RememberMe} services enabled, you will have to specify an</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * instance yourself via the {@link #setRememberMeManager(RememberMeManager) setRememberMeManager}</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * mutator. However if you're reading this JavaDoc with the</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * expectation of operating in a Web environment, take a look at the</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> * {@code org.apache.shiro.web.DefaultWebSecurityManager} implementation, which</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * <em>does</em> support {@code RememberMe} services by default at startup.</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> *</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> * @since 0.2</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> */</a> |
| <span class="sourceLineNo">075</span><a id="line.75">public class DefaultSecurityManager extends SessionsSecurityManager {</a> |
| <span class="sourceLineNo">076</span><a id="line.76"></a> |
| <span class="sourceLineNo">077</span><a id="line.77"> private static final Logger log = LoggerFactory.getLogger(DefaultSecurityManager.class);</a> |
| <span class="sourceLineNo">078</span><a id="line.78"></a> |
| <span class="sourceLineNo">079</span><a id="line.79"> protected RememberMeManager rememberMeManager;</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> protected SubjectDAO subjectDAO;</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> protected SubjectFactory subjectFactory;</a> |
| <span class="sourceLineNo">082</span><a id="line.82"></a> |
| <span class="sourceLineNo">083</span><a id="line.83"> /**</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> * Default no-arg constructor.</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> */</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> public DefaultSecurityManager() {</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> super();</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> this.subjectFactory = new DefaultSubjectFactory();</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> this.subjectDAO = new DefaultSubjectDAO();</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> }</a> |
| <span class="sourceLineNo">091</span><a id="line.91"></a> |
| <span class="sourceLineNo">092</span><a id="line.92"> /**</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> * Supporting constructor for a single-realm application.</a> |
| <span class="sourceLineNo">094</span><a id="line.94"> *</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> * @param singleRealm the single realm used by this SecurityManager.</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> */</a> |
| <span class="sourceLineNo">097</span><a id="line.97"> public DefaultSecurityManager(Realm singleRealm) {</a> |
| <span class="sourceLineNo">098</span><a id="line.98"> this();</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> setRealm(singleRealm);</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> }</a> |
| <span class="sourceLineNo">101</span><a id="line.101"></a> |
| <span class="sourceLineNo">102</span><a id="line.102"> /**</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> * Supporting constructor for multiple {@link #setRealms realms}.</a> |
| <span class="sourceLineNo">104</span><a id="line.104"> *</a> |
| <span class="sourceLineNo">105</span><a id="line.105"> * @param realms the realm instances backing this SecurityManager.</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> */</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> public DefaultSecurityManager(Collection<Realm> realms) {</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> this();</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> setRealms(realms);</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> }</a> |
| <span class="sourceLineNo">111</span><a id="line.111"></a> |
| <span class="sourceLineNo">112</span><a id="line.112"> /**</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> * Returns the {@code SubjectFactory} responsible for creating {@link Subject} instances exposed to the application.</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> *</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> * @return the {@code SubjectFactory} responsible for creating {@link Subject} instances exposed to the application.</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> */</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> public SubjectFactory getSubjectFactory() {</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> return subjectFactory;</a> |
| <span class="sourceLineNo">119</span><a id="line.119"> }</a> |
| <span class="sourceLineNo">120</span><a id="line.120"></a> |
| <span class="sourceLineNo">121</span><a id="line.121"> /**</a> |
| <span class="sourceLineNo">122</span><a id="line.122"> * Sets the {@code SubjectFactory} responsible for creating {@link Subject} instances exposed to the application.</a> |
| <span class="sourceLineNo">123</span><a id="line.123"> *</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> * @param subjectFactory the {@code SubjectFactory} responsible for creating {@link Subject} instances exposed to the application.</a> |
| <span class="sourceLineNo">125</span><a id="line.125"> */</a> |
| <span class="sourceLineNo">126</span><a id="line.126"> public void setSubjectFactory(SubjectFactory subjectFactory) {</a> |
| <span class="sourceLineNo">127</span><a id="line.127"> this.subjectFactory = subjectFactory;</a> |
| <span class="sourceLineNo">128</span><a id="line.128"> }</a> |
| <span class="sourceLineNo">129</span><a id="line.129"></a> |
| <span class="sourceLineNo">130</span><a id="line.130"> /**</a> |
| <span class="sourceLineNo">131</span><a id="line.131"> * Returns the {@code SubjectDAO} responsible for persisting Subject state, typically used after login or when an</a> |
| <span class="sourceLineNo">132</span><a id="line.132"> * Subject identity is discovered (eg after RememberMe services). Unless configured otherwise, the default</a> |
| <span class="sourceLineNo">133</span><a id="line.133"> * implementation is a {@link DefaultSubjectDAO}.</a> |
| <span class="sourceLineNo">134</span><a id="line.134"> *</a> |
| <span class="sourceLineNo">135</span><a id="line.135"> * @return the {@code SubjectDAO} responsible for persisting Subject state, typically used after login or when an</a> |
| <span class="sourceLineNo">136</span><a id="line.136"> * Subject identity is discovered (eg after RememberMe services).</a> |
| <span class="sourceLineNo">137</span><a id="line.137"> * @see DefaultSubjectDAO</a> |
| <span class="sourceLineNo">138</span><a id="line.138"> * @since 1.2</a> |
| <span class="sourceLineNo">139</span><a id="line.139"> */</a> |
| <span class="sourceLineNo">140</span><a id="line.140"> public SubjectDAO getSubjectDAO() {</a> |
| <span class="sourceLineNo">141</span><a id="line.141"> return subjectDAO;</a> |
| <span class="sourceLineNo">142</span><a id="line.142"> }</a> |
| <span class="sourceLineNo">143</span><a id="line.143"></a> |
| <span class="sourceLineNo">144</span><a id="line.144"> /**</a> |
| <span class="sourceLineNo">145</span><a id="line.145"> * Sets the {@code SubjectDAO} responsible for persisting Subject state, typically used after login or when an</a> |
| <span class="sourceLineNo">146</span><a id="line.146"> * Subject identity is discovered (eg after RememberMe services). Unless configured otherwise, the default</a> |
| <span class="sourceLineNo">147</span><a id="line.147"> * implementation is a {@link DefaultSubjectDAO}.</a> |
| <span class="sourceLineNo">148</span><a id="line.148"> *</a> |
| <span class="sourceLineNo">149</span><a id="line.149"> * @param subjectDAO the {@code SubjectDAO} responsible for persisting Subject state, typically used after login or when an</a> |
| <span class="sourceLineNo">150</span><a id="line.150"> * Subject identity is discovered (eg after RememberMe services).</a> |
| <span class="sourceLineNo">151</span><a id="line.151"> * @see DefaultSubjectDAO</a> |
| <span class="sourceLineNo">152</span><a id="line.152"> * @since 1.2</a> |
| <span class="sourceLineNo">153</span><a id="line.153"> */</a> |
| <span class="sourceLineNo">154</span><a id="line.154"> public void setSubjectDAO(SubjectDAO subjectDAO) {</a> |
| <span class="sourceLineNo">155</span><a id="line.155"> this.subjectDAO = subjectDAO;</a> |
| <span class="sourceLineNo">156</span><a id="line.156"> }</a> |
| <span class="sourceLineNo">157</span><a id="line.157"></a> |
| <span class="sourceLineNo">158</span><a id="line.158"> public RememberMeManager getRememberMeManager() {</a> |
| <span class="sourceLineNo">159</span><a id="line.159"> return rememberMeManager;</a> |
| <span class="sourceLineNo">160</span><a id="line.160"> }</a> |
| <span class="sourceLineNo">161</span><a id="line.161"></a> |
| <span class="sourceLineNo">162</span><a id="line.162"> public void setRememberMeManager(RememberMeManager rememberMeManager) {</a> |
| <span class="sourceLineNo">163</span><a id="line.163"> this.rememberMeManager = rememberMeManager;</a> |
| <span class="sourceLineNo">164</span><a id="line.164"> }</a> |
| <span class="sourceLineNo">165</span><a id="line.165"></a> |
| <span class="sourceLineNo">166</span><a id="line.166"> protected SubjectContext createSubjectContext() {</a> |
| <span class="sourceLineNo">167</span><a id="line.167"> return new DefaultSubjectContext();</a> |
| <span class="sourceLineNo">168</span><a id="line.168"> }</a> |
| <span class="sourceLineNo">169</span><a id="line.169"></a> |
| <span class="sourceLineNo">170</span><a id="line.170"> /**</a> |
| <span class="sourceLineNo">171</span><a id="line.171"> * Creates a {@code Subject} instance for the user represented by the given method arguments.</a> |
| <span class="sourceLineNo">172</span><a id="line.172"> *</a> |
| <span class="sourceLineNo">173</span><a id="line.173"> * @param token the {@code AuthenticationToken} submitted for the successful authentication.</a> |
| <span class="sourceLineNo">174</span><a id="line.174"> * @param info the {@code AuthenticationInfo} of a newly authenticated user.</a> |
| <span class="sourceLineNo">175</span><a id="line.175"> * @param existing the existing {@code Subject} instance that initiated the authentication attempt</a> |
| <span class="sourceLineNo">176</span><a id="line.176"> * @return the {@code Subject} instance that represents the context and session data for the newly</a> |
| <span class="sourceLineNo">177</span><a id="line.177"> * authenticated subject.</a> |
| <span class="sourceLineNo">178</span><a id="line.178"> */</a> |
| <span class="sourceLineNo">179</span><a id="line.179"> protected Subject createSubject(AuthenticationToken token, AuthenticationInfo info, Subject existing) {</a> |
| <span class="sourceLineNo">180</span><a id="line.180"> SubjectContext context = createSubjectContext();</a> |
| <span class="sourceLineNo">181</span><a id="line.181"> context.setAuthenticated(true);</a> |
| <span class="sourceLineNo">182</span><a id="line.182"> context.setAuthenticationToken(token);</a> |
| <span class="sourceLineNo">183</span><a id="line.183"> context.setAuthenticationInfo(info);</a> |
| <span class="sourceLineNo">184</span><a id="line.184"> context.setSecurityManager(this);</a> |
| <span class="sourceLineNo">185</span><a id="line.185"> if (existing != null) {</a> |
| <span class="sourceLineNo">186</span><a id="line.186"> context.setSubject(existing);</a> |
| <span class="sourceLineNo">187</span><a id="line.187"> }</a> |
| <span class="sourceLineNo">188</span><a id="line.188"> return createSubject(context);</a> |
| <span class="sourceLineNo">189</span><a id="line.189"> }</a> |
| <span class="sourceLineNo">190</span><a id="line.190"></a> |
| <span class="sourceLineNo">191</span><a id="line.191"> /**</a> |
| <span class="sourceLineNo">192</span><a id="line.192"> * Binds a {@code Subject} instance created after authentication to the application for later use.</a> |
| <span class="sourceLineNo">193</span><a id="line.193"> * <p/></a> |
| <span class="sourceLineNo">194</span><a id="line.194"> * As of Shiro 1.2, this method has been deprecated in favor of {@link #save(org.apache.shiro.subject.Subject)},</a> |
| <span class="sourceLineNo">195</span><a id="line.195"> * which this implementation now calls.</a> |
| <span class="sourceLineNo">196</span><a id="line.196"> *</a> |
| <span class="sourceLineNo">197</span><a id="line.197"> * @param subject the {@code Subject} instance created after authentication to be bound to the application</a> |
| <span class="sourceLineNo">198</span><a id="line.198"> * for later use.</a> |
| <span class="sourceLineNo">199</span><a id="line.199"> * @see #save(org.apache.shiro.subject.Subject)</a> |
| <span class="sourceLineNo">200</span><a id="line.200"> * @deprecated in favor of {@link #save(org.apache.shiro.subject.Subject) save(subject)}.</a> |
| <span class="sourceLineNo">201</span><a id="line.201"> */</a> |
| <span class="sourceLineNo">202</span><a id="line.202"> @Deprecated</a> |
| <span class="sourceLineNo">203</span><a id="line.203"> protected void bind(Subject subject) {</a> |
| <span class="sourceLineNo">204</span><a id="line.204"> save(subject);</a> |
| <span class="sourceLineNo">205</span><a id="line.205"> }</a> |
| <span class="sourceLineNo">206</span><a id="line.206"></a> |
| <span class="sourceLineNo">207</span><a id="line.207"> protected void rememberMeSuccessfulLogin(AuthenticationToken token, AuthenticationInfo info, Subject subject) {</a> |
| <span class="sourceLineNo">208</span><a id="line.208"> RememberMeManager rmm = getRememberMeManager();</a> |
| <span class="sourceLineNo">209</span><a id="line.209"> if (rmm != null) {</a> |
| <span class="sourceLineNo">210</span><a id="line.210"> try {</a> |
| <span class="sourceLineNo">211</span><a id="line.211"> rmm.onSuccessfulLogin(subject, token, info);</a> |
| <span class="sourceLineNo">212</span><a id="line.212"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">213</span><a id="line.213"> if (log.isWarnEnabled()) {</a> |
| <span class="sourceLineNo">214</span><a id="line.214"> String msg = "Delegate RememberMeManager instance of type [" + rmm.getClass().getName() +</a> |
| <span class="sourceLineNo">215</span><a id="line.215"> "] threw an exception during onSuccessfulLogin. RememberMe services will not be " +</a> |
| <span class="sourceLineNo">216</span><a id="line.216"> "performed for account [" + info + "].";</a> |
| <span class="sourceLineNo">217</span><a id="line.217"> log.warn(msg, e);</a> |
| <span class="sourceLineNo">218</span><a id="line.218"> }</a> |
| <span class="sourceLineNo">219</span><a id="line.219"> }</a> |
| <span class="sourceLineNo">220</span><a id="line.220"> } else {</a> |
| <span class="sourceLineNo">221</span><a id="line.221"> if (log.isTraceEnabled()) {</a> |
| <span class="sourceLineNo">222</span><a id="line.222"> log.trace("This " + getClass().getName() + " instance does not have a " +</a> |
| <span class="sourceLineNo">223</span><a id="line.223"> "[" + RememberMeManager.class.getName() + "] instance configured. RememberMe services " +</a> |
| <span class="sourceLineNo">224</span><a id="line.224"> "will not be performed for account [" + info + "].");</a> |
| <span class="sourceLineNo">225</span><a id="line.225"> }</a> |
| <span class="sourceLineNo">226</span><a id="line.226"> }</a> |
| <span class="sourceLineNo">227</span><a id="line.227"> }</a> |
| <span class="sourceLineNo">228</span><a id="line.228"></a> |
| <span class="sourceLineNo">229</span><a id="line.229"> protected void rememberMeFailedLogin(AuthenticationToken token, AuthenticationException ex, Subject subject) {</a> |
| <span class="sourceLineNo">230</span><a id="line.230"> RememberMeManager rmm = getRememberMeManager();</a> |
| <span class="sourceLineNo">231</span><a id="line.231"> if (rmm != null) {</a> |
| <span class="sourceLineNo">232</span><a id="line.232"> try {</a> |
| <span class="sourceLineNo">233</span><a id="line.233"> rmm.onFailedLogin(subject, token, ex);</a> |
| <span class="sourceLineNo">234</span><a id="line.234"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">235</span><a id="line.235"> if (log.isWarnEnabled()) {</a> |
| <span class="sourceLineNo">236</span><a id="line.236"> String msg = "Delegate RememberMeManager instance of type [" + rmm.getClass().getName() +</a> |
| <span class="sourceLineNo">237</span><a id="line.237"> "] threw an exception during onFailedLogin for AuthenticationToken [" +</a> |
| <span class="sourceLineNo">238</span><a id="line.238"> token + "].";</a> |
| <span class="sourceLineNo">239</span><a id="line.239"> log.warn(msg, e);</a> |
| <span class="sourceLineNo">240</span><a id="line.240"> }</a> |
| <span class="sourceLineNo">241</span><a id="line.241"> }</a> |
| <span class="sourceLineNo">242</span><a id="line.242"> }</a> |
| <span class="sourceLineNo">243</span><a id="line.243"> }</a> |
| <span class="sourceLineNo">244</span><a id="line.244"></a> |
| <span class="sourceLineNo">245</span><a id="line.245"> protected void rememberMeLogout(Subject subject) {</a> |
| <span class="sourceLineNo">246</span><a id="line.246"> RememberMeManager rmm = getRememberMeManager();</a> |
| <span class="sourceLineNo">247</span><a id="line.247"> if (rmm != null) {</a> |
| <span class="sourceLineNo">248</span><a id="line.248"> try {</a> |
| <span class="sourceLineNo">249</span><a id="line.249"> rmm.onLogout(subject);</a> |
| <span class="sourceLineNo">250</span><a id="line.250"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">251</span><a id="line.251"> if (log.isWarnEnabled()) {</a> |
| <span class="sourceLineNo">252</span><a id="line.252"> String msg = "Delegate RememberMeManager instance of type [" + rmm.getClass().getName() +</a> |
| <span class="sourceLineNo">253</span><a id="line.253"> "] threw an exception during onLogout for subject with principals [" +</a> |
| <span class="sourceLineNo">254</span><a id="line.254"> (subject != null ? subject.getPrincipals() : null) + "]";</a> |
| <span class="sourceLineNo">255</span><a id="line.255"> log.warn(msg, e);</a> |
| <span class="sourceLineNo">256</span><a id="line.256"> }</a> |
| <span class="sourceLineNo">257</span><a id="line.257"> }</a> |
| <span class="sourceLineNo">258</span><a id="line.258"> }</a> |
| <span class="sourceLineNo">259</span><a id="line.259"> }</a> |
| <span class="sourceLineNo">260</span><a id="line.260"></a> |
| <span class="sourceLineNo">261</span><a id="line.261"> /**</a> |
| <span class="sourceLineNo">262</span><a id="line.262"> * First authenticates the {@code AuthenticationToken} argument, and if successful, constructs a</a> |
| <span class="sourceLineNo">263</span><a id="line.263"> * {@code Subject} instance representing the authenticated account's identity.</a> |
| <span class="sourceLineNo">264</span><a id="line.264"> * <p/></a> |
| <span class="sourceLineNo">265</span><a id="line.265"> * Once constructed, the {@code Subject} instance is then {@link #bind bound} to the application for</a> |
| <span class="sourceLineNo">266</span><a id="line.266"> * subsequent access before being returned to the caller.</a> |
| <span class="sourceLineNo">267</span><a id="line.267"> *</a> |
| <span class="sourceLineNo">268</span><a id="line.268"> * @param token the authenticationToken to process for the login attempt.</a> |
| <span class="sourceLineNo">269</span><a id="line.269"> * @return a Subject representing the authenticated user.</a> |
| <span class="sourceLineNo">270</span><a id="line.270"> * @throws AuthenticationException if there is a problem authenticating the specified {@code token}.</a> |
| <span class="sourceLineNo">271</span><a id="line.271"> */</a> |
| <span class="sourceLineNo">272</span><a id="line.272"> public Subject login(Subject subject, AuthenticationToken token) throws AuthenticationException {</a> |
| <span class="sourceLineNo">273</span><a id="line.273"> AuthenticationInfo info;</a> |
| <span class="sourceLineNo">274</span><a id="line.274"> try {</a> |
| <span class="sourceLineNo">275</span><a id="line.275"> info = authenticate(token);</a> |
| <span class="sourceLineNo">276</span><a id="line.276"> } catch (AuthenticationException ae) {</a> |
| <span class="sourceLineNo">277</span><a id="line.277"> try {</a> |
| <span class="sourceLineNo">278</span><a id="line.278"> onFailedLogin(token, ae, subject);</a> |
| <span class="sourceLineNo">279</span><a id="line.279"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">280</span><a id="line.280"> if (log.isInfoEnabled()) {</a> |
| <span class="sourceLineNo">281</span><a id="line.281"> log.info("onFailedLogin method threw an " +</a> |
| <span class="sourceLineNo">282</span><a id="line.282"> "exception. Logging and propagating original AuthenticationException.", e);</a> |
| <span class="sourceLineNo">283</span><a id="line.283"> }</a> |
| <span class="sourceLineNo">284</span><a id="line.284"> }</a> |
| <span class="sourceLineNo">285</span><a id="line.285"> throw ae; //propagate</a> |
| <span class="sourceLineNo">286</span><a id="line.286"> }</a> |
| <span class="sourceLineNo">287</span><a id="line.287"></a> |
| <span class="sourceLineNo">288</span><a id="line.288"> Subject loggedIn = createSubject(token, info, subject);</a> |
| <span class="sourceLineNo">289</span><a id="line.289"></a> |
| <span class="sourceLineNo">290</span><a id="line.290"> onSuccessfulLogin(token, info, loggedIn);</a> |
| <span class="sourceLineNo">291</span><a id="line.291"></a> |
| <span class="sourceLineNo">292</span><a id="line.292"> return loggedIn;</a> |
| <span class="sourceLineNo">293</span><a id="line.293"> }</a> |
| <span class="sourceLineNo">294</span><a id="line.294"></a> |
| <span class="sourceLineNo">295</span><a id="line.295"> protected void onSuccessfulLogin(AuthenticationToken token, AuthenticationInfo info, Subject subject) {</a> |
| <span class="sourceLineNo">296</span><a id="line.296"> rememberMeSuccessfulLogin(token, info, subject);</a> |
| <span class="sourceLineNo">297</span><a id="line.297"> }</a> |
| <span class="sourceLineNo">298</span><a id="line.298"></a> |
| <span class="sourceLineNo">299</span><a id="line.299"> protected void onFailedLogin(AuthenticationToken token, AuthenticationException ae, Subject subject) {</a> |
| <span class="sourceLineNo">300</span><a id="line.300"> rememberMeFailedLogin(token, ae, subject);</a> |
| <span class="sourceLineNo">301</span><a id="line.301"> }</a> |
| <span class="sourceLineNo">302</span><a id="line.302"></a> |
| <span class="sourceLineNo">303</span><a id="line.303"> protected void beforeLogout(Subject subject) {</a> |
| <span class="sourceLineNo">304</span><a id="line.304"> rememberMeLogout(subject);</a> |
| <span class="sourceLineNo">305</span><a id="line.305"> }</a> |
| <span class="sourceLineNo">306</span><a id="line.306"></a> |
| <span class="sourceLineNo">307</span><a id="line.307"> protected SubjectContext copy(SubjectContext subjectContext) {</a> |
| <span class="sourceLineNo">308</span><a id="line.308"> return new DefaultSubjectContext(subjectContext);</a> |
| <span class="sourceLineNo">309</span><a id="line.309"> }</a> |
| <span class="sourceLineNo">310</span><a id="line.310"></a> |
| <span class="sourceLineNo">311</span><a id="line.311"> /**</a> |
| <span class="sourceLineNo">312</span><a id="line.312"> * This implementation functions as follows:</a> |
| <span class="sourceLineNo">313</span><a id="line.313"> * <p/></a> |
| <span class="sourceLineNo">314</span><a id="line.314"> * <ol></a> |
| <span class="sourceLineNo">315</span><a id="line.315"> * <li>Ensures the {@code SubjectContext} is as populated as it can be, using heuristics to acquire</a> |
| <span class="sourceLineNo">316</span><a id="line.316"> * data that may not have already been available to it (such as a referenced session or remembered principals).</li></a> |
| <span class="sourceLineNo">317</span><a id="line.317"> * <li>Calls {@link #doCreateSubject(org.apache.shiro.subject.SubjectContext)} to actually perform the</a> |
| <span class="sourceLineNo">318</span><a id="line.318"> * {@code Subject} instance creation.</li></a> |
| <span class="sourceLineNo">319</span><a id="line.319"> * <li>calls {@link #save(org.apache.shiro.subject.Subject) save(subject)} to ensure the constructed</a> |
| <span class="sourceLineNo">320</span><a id="line.320"> * {@code Subject}'s state is accessible for future requests/invocations if necessary.</li></a> |
| <span class="sourceLineNo">321</span><a id="line.321"> * <li>returns the constructed {@code Subject} instance.</li></a> |
| <span class="sourceLineNo">322</span><a id="line.322"> * </ol></a> |
| <span class="sourceLineNo">323</span><a id="line.323"> *</a> |
| <span class="sourceLineNo">324</span><a id="line.324"> * @param subjectContext any data needed to direct how the Subject should be constructed.</a> |
| <span class="sourceLineNo">325</span><a id="line.325"> * @return the {@code Subject} instance reflecting the specified contextual data.</a> |
| <span class="sourceLineNo">326</span><a id="line.326"> * @see #ensureSecurityManager(org.apache.shiro.subject.SubjectContext)</a> |
| <span class="sourceLineNo">327</span><a id="line.327"> * @see #resolveSession(org.apache.shiro.subject.SubjectContext)</a> |
| <span class="sourceLineNo">328</span><a id="line.328"> * @see #resolvePrincipals(org.apache.shiro.subject.SubjectContext)</a> |
| <span class="sourceLineNo">329</span><a id="line.329"> * @see #doCreateSubject(org.apache.shiro.subject.SubjectContext)</a> |
| <span class="sourceLineNo">330</span><a id="line.330"> * @see #save(org.apache.shiro.subject.Subject)</a> |
| <span class="sourceLineNo">331</span><a id="line.331"> * @since 1.0</a> |
| <span class="sourceLineNo">332</span><a id="line.332"> */</a> |
| <span class="sourceLineNo">333</span><a id="line.333"> public Subject createSubject(SubjectContext subjectContext) {</a> |
| <span class="sourceLineNo">334</span><a id="line.334"> //create a copy so we don't modify the argument's backing map:</a> |
| <span class="sourceLineNo">335</span><a id="line.335"> SubjectContext context = copy(subjectContext);</a> |
| <span class="sourceLineNo">336</span><a id="line.336"></a> |
| <span class="sourceLineNo">337</span><a id="line.337"> //ensure that the context has a SecurityManager instance, and if not, add one:</a> |
| <span class="sourceLineNo">338</span><a id="line.338"> context = ensureSecurityManager(context);</a> |
| <span class="sourceLineNo">339</span><a id="line.339"></a> |
| <span class="sourceLineNo">340</span><a id="line.340"> //Resolve an associated Session (usually based on a referenced session ID), and place it in the context before</a> |
| <span class="sourceLineNo">341</span><a id="line.341"> //sending to the SubjectFactory. The SubjectFactory should not need to know how to acquire sessions as the</a> |
| <span class="sourceLineNo">342</span><a id="line.342"> //process is often environment specific - better to shield the SF from these details:</a> |
| <span class="sourceLineNo">343</span><a id="line.343"> context = resolveSession(context);</a> |
| <span class="sourceLineNo">344</span><a id="line.344"></a> |
| <span class="sourceLineNo">345</span><a id="line.345"> //Similarly, the SubjectFactory should not require any concept of RememberMe - translate that here first</a> |
| <span class="sourceLineNo">346</span><a id="line.346"> //if possible before handing off to the SubjectFactory:</a> |
| <span class="sourceLineNo">347</span><a id="line.347"> context = resolvePrincipals(context);</a> |
| <span class="sourceLineNo">348</span><a id="line.348"></a> |
| <span class="sourceLineNo">349</span><a id="line.349"> Subject subject = doCreateSubject(context);</a> |
| <span class="sourceLineNo">350</span><a id="line.350"></a> |
| <span class="sourceLineNo">351</span><a id="line.351"> //save this subject for future reference if necessary:</a> |
| <span class="sourceLineNo">352</span><a id="line.352"> //(this is needed here in case rememberMe principals were resolved and they need to be stored in the</a> |
| <span class="sourceLineNo">353</span><a id="line.353"> //session, so we don't constantly rehydrate the rememberMe PrincipalCollection on every operation).</a> |
| <span class="sourceLineNo">354</span><a id="line.354"> //Added in 1.2:</a> |
| <span class="sourceLineNo">355</span><a id="line.355"> save(subject);</a> |
| <span class="sourceLineNo">356</span><a id="line.356"></a> |
| <span class="sourceLineNo">357</span><a id="line.357"> return subject;</a> |
| <span class="sourceLineNo">358</span><a id="line.358"> }</a> |
| <span class="sourceLineNo">359</span><a id="line.359"></a> |
| <span class="sourceLineNo">360</span><a id="line.360"> /**</a> |
| <span class="sourceLineNo">361</span><a id="line.361"> * Actually creates a {@code Subject} instance by delegating to the internal</a> |
| <span class="sourceLineNo">362</span><a id="line.362"> * {@link #getSubjectFactory() subjectFactory}. By the time this method is invoked, all possible</a> |
| <span class="sourceLineNo">363</span><a id="line.363"> * {@code SubjectContext} data (session, principals, et. al.) has been made accessible using all known heuristics</a> |
| <span class="sourceLineNo">364</span><a id="line.364"> * and will be accessible to the {@code subjectFactory} via the {@code subjectContext.resolve*} methods.</a> |
| <span class="sourceLineNo">365</span><a id="line.365"> *</a> |
| <span class="sourceLineNo">366</span><a id="line.366"> * @param context the populated context (data map) to be used by the {@code SubjectFactory} when creating a</a> |
| <span class="sourceLineNo">367</span><a id="line.367"> * {@code Subject} instance.</a> |
| <span class="sourceLineNo">368</span><a id="line.368"> * @return a {@code Subject} instance reflecting the data in the specified {@code SubjectContext} data map.</a> |
| <span class="sourceLineNo">369</span><a id="line.369"> * @see #getSubjectFactory()</a> |
| <span class="sourceLineNo">370</span><a id="line.370"> * @see SubjectFactory#createSubject(org.apache.shiro.subject.SubjectContext)</a> |
| <span class="sourceLineNo">371</span><a id="line.371"> * @since 1.2</a> |
| <span class="sourceLineNo">372</span><a id="line.372"> */</a> |
| <span class="sourceLineNo">373</span><a id="line.373"> protected Subject doCreateSubject(SubjectContext context) {</a> |
| <span class="sourceLineNo">374</span><a id="line.374"> return getSubjectFactory().createSubject(context);</a> |
| <span class="sourceLineNo">375</span><a id="line.375"> }</a> |
| <span class="sourceLineNo">376</span><a id="line.376"></a> |
| <span class="sourceLineNo">377</span><a id="line.377"> /**</a> |
| <span class="sourceLineNo">378</span><a id="line.378"> * Saves the subject's state to a persistent location for future reference if necessary.</a> |
| <span class="sourceLineNo">379</span><a id="line.379"> * <p/></a> |
| <span class="sourceLineNo">380</span><a id="line.380"> * This implementation merely delegates to the internal {@link #setSubjectDAO(SubjectDAO) subjectDAO} and calls</a> |
| <span class="sourceLineNo">381</span><a id="line.381"> * {@link SubjectDAO#save(org.apache.shiro.subject.Subject) subjectDAO.save(subject)}.</a> |
| <span class="sourceLineNo">382</span><a id="line.382"> *</a> |
| <span class="sourceLineNo">383</span><a id="line.383"> * @param subject the subject for which state will potentially be persisted</a> |
| <span class="sourceLineNo">384</span><a id="line.384"> * @see SubjectDAO#save(org.apache.shiro.subject.Subject)</a> |
| <span class="sourceLineNo">385</span><a id="line.385"> * @since 1.2</a> |
| <span class="sourceLineNo">386</span><a id="line.386"> */</a> |
| <span class="sourceLineNo">387</span><a id="line.387"> protected void save(Subject subject) {</a> |
| <span class="sourceLineNo">388</span><a id="line.388"> this.subjectDAO.save(subject);</a> |
| <span class="sourceLineNo">389</span><a id="line.389"> }</a> |
| <span class="sourceLineNo">390</span><a id="line.390"></a> |
| <span class="sourceLineNo">391</span><a id="line.391"> /**</a> |
| <span class="sourceLineNo">392</span><a id="line.392"> * Removes (or 'unbinds') the Subject's state from the application, typically called during {@link #logout}..</a> |
| <span class="sourceLineNo">393</span><a id="line.393"> * <p/></a> |
| <span class="sourceLineNo">394</span><a id="line.394"> * This implementation merely delegates to the internal {@link #setSubjectDAO(SubjectDAO) subjectDAO} and calls</a> |
| <span class="sourceLineNo">395</span><a id="line.395"> * {@link SubjectDAO#delete(org.apache.shiro.subject.Subject) delete(subject)}.</a> |
| <span class="sourceLineNo">396</span><a id="line.396"> *</a> |
| <span class="sourceLineNo">397</span><a id="line.397"> * @param subject the subject for which state will be removed</a> |
| <span class="sourceLineNo">398</span><a id="line.398"> * @see SubjectDAO#delete(org.apache.shiro.subject.Subject)</a> |
| <span class="sourceLineNo">399</span><a id="line.399"> * @since 1.2</a> |
| <span class="sourceLineNo">400</span><a id="line.400"> */</a> |
| <span class="sourceLineNo">401</span><a id="line.401"> protected void delete(Subject subject) {</a> |
| <span class="sourceLineNo">402</span><a id="line.402"> this.subjectDAO.delete(subject);</a> |
| <span class="sourceLineNo">403</span><a id="line.403"> }</a> |
| <span class="sourceLineNo">404</span><a id="line.404"></a> |
| <span class="sourceLineNo">405</span><a id="line.405"> /**</a> |
| <span class="sourceLineNo">406</span><a id="line.406"> * Determines if there is a {@code SecurityManager} instance in the context, and if not, adds 'this' to the</a> |
| <span class="sourceLineNo">407</span><a id="line.407"> * context. This ensures the SubjectFactory instance will have access to a SecurityManager during Subject</a> |
| <span class="sourceLineNo">408</span><a id="line.408"> * construction if necessary.</a> |
| <span class="sourceLineNo">409</span><a id="line.409"> *</a> |
| <span class="sourceLineNo">410</span><a id="line.410"> * @param context the subject context data that may contain a SecurityManager instance.</a> |
| <span class="sourceLineNo">411</span><a id="line.411"> * @return The SubjectContext to use to pass to a {@link SubjectFactory} for subject creation.</a> |
| <span class="sourceLineNo">412</span><a id="line.412"> * @since 1.0</a> |
| <span class="sourceLineNo">413</span><a id="line.413"> */</a> |
| <span class="sourceLineNo">414</span><a id="line.414"> @SuppressWarnings({"unchecked"})</a> |
| <span class="sourceLineNo">415</span><a id="line.415"> protected SubjectContext ensureSecurityManager(SubjectContext context) {</a> |
| <span class="sourceLineNo">416</span><a id="line.416"> if (context.resolveSecurityManager() != null) {</a> |
| <span class="sourceLineNo">417</span><a id="line.417"> log.trace("Context already contains a SecurityManager instance. Returning.");</a> |
| <span class="sourceLineNo">418</span><a id="line.418"> return context;</a> |
| <span class="sourceLineNo">419</span><a id="line.419"> }</a> |
| <span class="sourceLineNo">420</span><a id="line.420"> log.trace("No SecurityManager found in context. Adding self reference.");</a> |
| <span class="sourceLineNo">421</span><a id="line.421"> context.setSecurityManager(this);</a> |
| <span class="sourceLineNo">422</span><a id="line.422"> return context;</a> |
| <span class="sourceLineNo">423</span><a id="line.423"> }</a> |
| <span class="sourceLineNo">424</span><a id="line.424"></a> |
| <span class="sourceLineNo">425</span><a id="line.425"> /**</a> |
| <span class="sourceLineNo">426</span><a id="line.426"> * Attempts to resolve any associated session based on the context and returns a</a> |
| <span class="sourceLineNo">427</span><a id="line.427"> * context that represents this resolved {@code Session} to ensure it may be referenced if necessary by the</a> |
| <span class="sourceLineNo">428</span><a id="line.428"> * invoked {@link SubjectFactory} that performs actual {@link Subject} construction.</a> |
| <span class="sourceLineNo">429</span><a id="line.429"> * <p/></a> |
| <span class="sourceLineNo">430</span><a id="line.430"> * If there is a {@code Session} already in the context because that is what the caller wants to be used for</a> |
| <span class="sourceLineNo">431</span><a id="line.431"> * {@code Subject} construction, or if no session is resolved, this method effectively does nothing</a> |
| <span class="sourceLineNo">432</span><a id="line.432"> * returns the context method argument unaltered.</a> |
| <span class="sourceLineNo">433</span><a id="line.433"> *</a> |
| <span class="sourceLineNo">434</span><a id="line.434"> * @param context the subject context data that may resolve a Session instance.</a> |
| <span class="sourceLineNo">435</span><a id="line.435"> * @return The context to use to pass to a {@link SubjectFactory} for subject creation.</a> |
| <span class="sourceLineNo">436</span><a id="line.436"> * @since 1.0</a> |
| <span class="sourceLineNo">437</span><a id="line.437"> */</a> |
| <span class="sourceLineNo">438</span><a id="line.438"> @SuppressWarnings({"unchecked"})</a> |
| <span class="sourceLineNo">439</span><a id="line.439"> protected SubjectContext resolveSession(SubjectContext context) {</a> |
| <span class="sourceLineNo">440</span><a id="line.440"> if (context.resolveSession() != null) {</a> |
| <span class="sourceLineNo">441</span><a id="line.441"> log.debug("Context already contains a session. Returning.");</a> |
| <span class="sourceLineNo">442</span><a id="line.442"> return context;</a> |
| <span class="sourceLineNo">443</span><a id="line.443"> }</a> |
| <span class="sourceLineNo">444</span><a id="line.444"> try {</a> |
| <span class="sourceLineNo">445</span><a id="line.445"> //Context couldn't resolve it directly, let's see if we can since we have direct access to </a> |
| <span class="sourceLineNo">446</span><a id="line.446"> //the session manager:</a> |
| <span class="sourceLineNo">447</span><a id="line.447"> Session session = resolveContextSession(context);</a> |
| <span class="sourceLineNo">448</span><a id="line.448"> if (session != null) {</a> |
| <span class="sourceLineNo">449</span><a id="line.449"> context.setSession(session);</a> |
| <span class="sourceLineNo">450</span><a id="line.450"> }</a> |
| <span class="sourceLineNo">451</span><a id="line.451"> } catch (InvalidSessionException e) {</a> |
| <span class="sourceLineNo">452</span><a id="line.452"> log.debug("Resolved SubjectContext context session is invalid. Ignoring and creating an anonymous " +</a> |
| <span class="sourceLineNo">453</span><a id="line.453"> "(session-less) Subject instance.", e);</a> |
| <span class="sourceLineNo">454</span><a id="line.454"> }</a> |
| <span class="sourceLineNo">455</span><a id="line.455"> return context;</a> |
| <span class="sourceLineNo">456</span><a id="line.456"> }</a> |
| <span class="sourceLineNo">457</span><a id="line.457"></a> |
| <span class="sourceLineNo">458</span><a id="line.458"> protected Session resolveContextSession(SubjectContext context) throws InvalidSessionException {</a> |
| <span class="sourceLineNo">459</span><a id="line.459"> SessionKey key = getSessionKey(context);</a> |
| <span class="sourceLineNo">460</span><a id="line.460"> if (key != null) {</a> |
| <span class="sourceLineNo">461</span><a id="line.461"> return getSession(key);</a> |
| <span class="sourceLineNo">462</span><a id="line.462"> }</a> |
| <span class="sourceLineNo">463</span><a id="line.463"> return null;</a> |
| <span class="sourceLineNo">464</span><a id="line.464"> }</a> |
| <span class="sourceLineNo">465</span><a id="line.465"></a> |
| <span class="sourceLineNo">466</span><a id="line.466"> protected SessionKey getSessionKey(SubjectContext context) {</a> |
| <span class="sourceLineNo">467</span><a id="line.467"> Serializable sessionId = context.getSessionId();</a> |
| <span class="sourceLineNo">468</span><a id="line.468"> if (sessionId != null) {</a> |
| <span class="sourceLineNo">469</span><a id="line.469"> return new DefaultSessionKey(sessionId);</a> |
| <span class="sourceLineNo">470</span><a id="line.470"> }</a> |
| <span class="sourceLineNo">471</span><a id="line.471"> return null;</a> |
| <span class="sourceLineNo">472</span><a id="line.472"> }</a> |
| <span class="sourceLineNo">473</span><a id="line.473"></a> |
| <span class="sourceLineNo">474</span><a id="line.474"> private static boolean isEmpty(PrincipalCollection pc) {</a> |
| <span class="sourceLineNo">475</span><a id="line.475"> return pc == null || pc.isEmpty();</a> |
| <span class="sourceLineNo">476</span><a id="line.476"> }</a> |
| <span class="sourceLineNo">477</span><a id="line.477"></a> |
| <span class="sourceLineNo">478</span><a id="line.478"> /**</a> |
| <span class="sourceLineNo">479</span><a id="line.479"> * Attempts to resolve an identity (a {@link PrincipalCollection}) for the context using heuristics. This</a> |
| <span class="sourceLineNo">480</span><a id="line.480"> * implementation functions as follows:</a> |
| <span class="sourceLineNo">481</span><a id="line.481"> * <ol></a> |
| <span class="sourceLineNo">482</span><a id="line.482"> * <li>Check the context to see if it can already {@link SubjectContext#resolvePrincipals resolve an identity}. If</a> |
| <span class="sourceLineNo">483</span><a id="line.483"> * so, this method does nothing and returns the method argument unaltered.</li></a> |
| <span class="sourceLineNo">484</span><a id="line.484"> * <li>Check for a RememberMe identity by calling {@link #getRememberedIdentity}. If that method returns a</a> |
| <span class="sourceLineNo">485</span><a id="line.485"> * non-null value, place the remembered {@link PrincipalCollection} in the context.</li></a> |
| <span class="sourceLineNo">486</span><a id="line.486"> * </ol></a> |
| <span class="sourceLineNo">487</span><a id="line.487"> *</a> |
| <span class="sourceLineNo">488</span><a id="line.488"> * @param context the subject context data that may provide (directly or indirectly through one of its values) a</a> |
| <span class="sourceLineNo">489</span><a id="line.489"> * {@link PrincipalCollection} identity.</a> |
| <span class="sourceLineNo">490</span><a id="line.490"> * @return The Subject context to use to pass to a {@link SubjectFactory} for subject creation.</a> |
| <span class="sourceLineNo">491</span><a id="line.491"> * @since 1.0</a> |
| <span class="sourceLineNo">492</span><a id="line.492"> */</a> |
| <span class="sourceLineNo">493</span><a id="line.493"> @SuppressWarnings({"unchecked"})</a> |
| <span class="sourceLineNo">494</span><a id="line.494"> protected SubjectContext resolvePrincipals(SubjectContext context) {</a> |
| <span class="sourceLineNo">495</span><a id="line.495"></a> |
| <span class="sourceLineNo">496</span><a id="line.496"> PrincipalCollection principals = context.resolvePrincipals();</a> |
| <span class="sourceLineNo">497</span><a id="line.497"></a> |
| <span class="sourceLineNo">498</span><a id="line.498"> if (isEmpty(principals)) {</a> |
| <span class="sourceLineNo">499</span><a id="line.499"> log.trace("No identity (PrincipalCollection) found in the context. Looking for a remembered identity.");</a> |
| <span class="sourceLineNo">500</span><a id="line.500"></a> |
| <span class="sourceLineNo">501</span><a id="line.501"> principals = getRememberedIdentity(context);</a> |
| <span class="sourceLineNo">502</span><a id="line.502"></a> |
| <span class="sourceLineNo">503</span><a id="line.503"> if (!isEmpty(principals)) {</a> |
| <span class="sourceLineNo">504</span><a id="line.504"> log.debug("Found remembered PrincipalCollection. Adding to the context to be used " +</a> |
| <span class="sourceLineNo">505</span><a id="line.505"> "for subject construction by the SubjectFactory.");</a> |
| <span class="sourceLineNo">506</span><a id="line.506"></a> |
| <span class="sourceLineNo">507</span><a id="line.507"> context.setPrincipals(principals);</a> |
| <span class="sourceLineNo">508</span><a id="line.508"></a> |
| <span class="sourceLineNo">509</span><a id="line.509"> // The following call was removed (commented out) in Shiro 1.2 because it uses the session as an</a> |
| <span class="sourceLineNo">510</span><a id="line.510"> // implementation strategy. Session use for Shiro's own needs should be controlled in a single place</a> |
| <span class="sourceLineNo">511</span><a id="line.511"> // to be more manageable for end-users: there are a number of stateless (e.g. REST) applications that</a> |
| <span class="sourceLineNo">512</span><a id="line.512"> // use Shiro that need to ensure that sessions are only used when desirable. If Shiro's internal</a> |
| <span class="sourceLineNo">513</span><a id="line.513"> // implementations used Subject sessions (setting attributes) whenever we wanted, it would be much</a> |
| <span class="sourceLineNo">514</span><a id="line.514"> // harder for end-users to control when/where that occurs.</a> |
| <span class="sourceLineNo">515</span><a id="line.515"> //</a> |
| <span class="sourceLineNo">516</span><a id="line.516"> // Because of this, the SubjectDAO was created as the single point of control, and session state logic</a> |
| <span class="sourceLineNo">517</span><a id="line.517"> // has been moved to the DefaultSubjectDAO implementation.</a> |
| <span class="sourceLineNo">518</span><a id="line.518"></a> |
| <span class="sourceLineNo">519</span><a id="line.519"> // Removed in Shiro 1.2. SHIRO-157 is still satisfied by the new DefaultSubjectDAO implementation</a> |
| <span class="sourceLineNo">520</span><a id="line.520"> // introduced in 1.2</a> |
| <span class="sourceLineNo">521</span><a id="line.521"> // Satisfies SHIRO-157:</a> |
| <span class="sourceLineNo">522</span><a id="line.522"> // bindPrincipalsToSession(principals, context);</a> |
| <span class="sourceLineNo">523</span><a id="line.523"></a> |
| <span class="sourceLineNo">524</span><a id="line.524"> } else {</a> |
| <span class="sourceLineNo">525</span><a id="line.525"> log.trace("No remembered identity found. Returning original context.");</a> |
| <span class="sourceLineNo">526</span><a id="line.526"> }</a> |
| <span class="sourceLineNo">527</span><a id="line.527"> }</a> |
| <span class="sourceLineNo">528</span><a id="line.528"></a> |
| <span class="sourceLineNo">529</span><a id="line.529"> return context;</a> |
| <span class="sourceLineNo">530</span><a id="line.530"> }</a> |
| <span class="sourceLineNo">531</span><a id="line.531"></a> |
| <span class="sourceLineNo">532</span><a id="line.532"> protected SessionContext createSessionContext(SubjectContext subjectContext) {</a> |
| <span class="sourceLineNo">533</span><a id="line.533"> DefaultSessionContext sessionContext = new DefaultSessionContext();</a> |
| <span class="sourceLineNo">534</span><a id="line.534"> if (!CollectionUtils.isEmpty(subjectContext)) {</a> |
| <span class="sourceLineNo">535</span><a id="line.535"> sessionContext.putAll(subjectContext);</a> |
| <span class="sourceLineNo">536</span><a id="line.536"> }</a> |
| <span class="sourceLineNo">537</span><a id="line.537"> Serializable sessionId = subjectContext.getSessionId();</a> |
| <span class="sourceLineNo">538</span><a id="line.538"> if (sessionId != null) {</a> |
| <span class="sourceLineNo">539</span><a id="line.539"> sessionContext.setSessionId(sessionId);</a> |
| <span class="sourceLineNo">540</span><a id="line.540"> }</a> |
| <span class="sourceLineNo">541</span><a id="line.541"> String host = subjectContext.resolveHost();</a> |
| <span class="sourceLineNo">542</span><a id="line.542"> if (host != null) {</a> |
| <span class="sourceLineNo">543</span><a id="line.543"> sessionContext.setHost(host);</a> |
| <span class="sourceLineNo">544</span><a id="line.544"> }</a> |
| <span class="sourceLineNo">545</span><a id="line.545"> return sessionContext;</a> |
| <span class="sourceLineNo">546</span><a id="line.546"> }</a> |
| <span class="sourceLineNo">547</span><a id="line.547"></a> |
| <span class="sourceLineNo">548</span><a id="line.548"> public void logout(Subject subject) {</a> |
| <span class="sourceLineNo">549</span><a id="line.549"></a> |
| <span class="sourceLineNo">550</span><a id="line.550"> if (subject == null) {</a> |
| <span class="sourceLineNo">551</span><a id="line.551"> throw new IllegalArgumentException("Subject method argument cannot be null.");</a> |
| <span class="sourceLineNo">552</span><a id="line.552"> }</a> |
| <span class="sourceLineNo">553</span><a id="line.553"></a> |
| <span class="sourceLineNo">554</span><a id="line.554"> beforeLogout(subject);</a> |
| <span class="sourceLineNo">555</span><a id="line.555"></a> |
| <span class="sourceLineNo">556</span><a id="line.556"> PrincipalCollection principals = subject.getPrincipals();</a> |
| <span class="sourceLineNo">557</span><a id="line.557"> if (principals != null && !principals.isEmpty()) {</a> |
| <span class="sourceLineNo">558</span><a id="line.558"> if (log.isDebugEnabled()) {</a> |
| <span class="sourceLineNo">559</span><a id="line.559"> log.debug("Logging out subject with primary principal {}", principals.getPrimaryPrincipal());</a> |
| <span class="sourceLineNo">560</span><a id="line.560"> }</a> |
| <span class="sourceLineNo">561</span><a id="line.561"> Authenticator authc = getAuthenticator();</a> |
| <span class="sourceLineNo">562</span><a id="line.562"> if (authc instanceof LogoutAware) {</a> |
| <span class="sourceLineNo">563</span><a id="line.563"> ((LogoutAware) authc).onLogout(principals);</a> |
| <span class="sourceLineNo">564</span><a id="line.564"> }</a> |
| <span class="sourceLineNo">565</span><a id="line.565"> }</a> |
| <span class="sourceLineNo">566</span><a id="line.566"></a> |
| <span class="sourceLineNo">567</span><a id="line.567"> try {</a> |
| <span class="sourceLineNo">568</span><a id="line.568"> delete(subject);</a> |
| <span class="sourceLineNo">569</span><a id="line.569"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">570</span><a id="line.570"> if (log.isDebugEnabled()) {</a> |
| <span class="sourceLineNo">571</span><a id="line.571"> String msg = "Unable to cleanly unbind Subject. Ignoring (logging out).";</a> |
| <span class="sourceLineNo">572</span><a id="line.572"> log.debug(msg, e);</a> |
| <span class="sourceLineNo">573</span><a id="line.573"> }</a> |
| <span class="sourceLineNo">574</span><a id="line.574"> } finally {</a> |
| <span class="sourceLineNo">575</span><a id="line.575"> try {</a> |
| <span class="sourceLineNo">576</span><a id="line.576"> stopSession(subject);</a> |
| <span class="sourceLineNo">577</span><a id="line.577"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">578</span><a id="line.578"> if (log.isDebugEnabled()) {</a> |
| <span class="sourceLineNo">579</span><a id="line.579"> String msg = "Unable to cleanly stop Session for Subject [" + subject.getPrincipal() + "] " +</a> |
| <span class="sourceLineNo">580</span><a id="line.580"> "Ignoring (logging out).";</a> |
| <span class="sourceLineNo">581</span><a id="line.581"> log.debug(msg, e);</a> |
| <span class="sourceLineNo">582</span><a id="line.582"> }</a> |
| <span class="sourceLineNo">583</span><a id="line.583"> }</a> |
| <span class="sourceLineNo">584</span><a id="line.584"> }</a> |
| <span class="sourceLineNo">585</span><a id="line.585"> }</a> |
| <span class="sourceLineNo">586</span><a id="line.586"></a> |
| <span class="sourceLineNo">587</span><a id="line.587"> protected void stopSession(Subject subject) {</a> |
| <span class="sourceLineNo">588</span><a id="line.588"> Session s = subject.getSession(false);</a> |
| <span class="sourceLineNo">589</span><a id="line.589"> if (s != null) {</a> |
| <span class="sourceLineNo">590</span><a id="line.590"> s.stop();</a> |
| <span class="sourceLineNo">591</span><a id="line.591"> }</a> |
| <span class="sourceLineNo">592</span><a id="line.592"> }</a> |
| <span class="sourceLineNo">593</span><a id="line.593"></a> |
| <span class="sourceLineNo">594</span><a id="line.594"> /**</a> |
| <span class="sourceLineNo">595</span><a id="line.595"> * Unbinds or removes the Subject's state from the application, typically called during {@link #logout}.</a> |
| <span class="sourceLineNo">596</span><a id="line.596"> * <p/></a> |
| <span class="sourceLineNo">597</span><a id="line.597"> * This has been deprecated in Shiro 1.2 in favor of the {@link #delete(org.apache.shiro.subject.Subject) delete}</a> |
| <span class="sourceLineNo">598</span><a id="line.598"> * method. The implementation has been updated to invoke that method.</a> |
| <span class="sourceLineNo">599</span><a id="line.599"> *</a> |
| <span class="sourceLineNo">600</span><a id="line.600"> * @param subject the subject to unbind from the application as it will no longer be used.</a> |
| <span class="sourceLineNo">601</span><a id="line.601"> * @deprecated in Shiro 1.2 in favor of {@link #delete(org.apache.shiro.subject.Subject)}</a> |
| <span class="sourceLineNo">602</span><a id="line.602"> */</a> |
| <span class="sourceLineNo">603</span><a id="line.603"> @Deprecated</a> |
| <span class="sourceLineNo">604</span><a id="line.604"> @SuppressWarnings({"UnusedDeclaration"})</a> |
| <span class="sourceLineNo">605</span><a id="line.605"> protected void unbind(Subject subject) {</a> |
| <span class="sourceLineNo">606</span><a id="line.606"> delete(subject);</a> |
| <span class="sourceLineNo">607</span><a id="line.607"> }</a> |
| <span class="sourceLineNo">608</span><a id="line.608"></a> |
| <span class="sourceLineNo">609</span><a id="line.609"> protected PrincipalCollection getRememberedIdentity(SubjectContext subjectContext) {</a> |
| <span class="sourceLineNo">610</span><a id="line.610"> RememberMeManager rmm = getRememberMeManager();</a> |
| <span class="sourceLineNo">611</span><a id="line.611"> if (rmm != null) {</a> |
| <span class="sourceLineNo">612</span><a id="line.612"> try {</a> |
| <span class="sourceLineNo">613</span><a id="line.613"> return rmm.getRememberedPrincipals(subjectContext);</a> |
| <span class="sourceLineNo">614</span><a id="line.614"> } catch (Exception e) {</a> |
| <span class="sourceLineNo">615</span><a id="line.615"> if (log.isWarnEnabled()) {</a> |
| <span class="sourceLineNo">616</span><a id="line.616"> String msg = "Delegate RememberMeManager instance of type [" + rmm.getClass().getName() +</a> |
| <span class="sourceLineNo">617</span><a id="line.617"> "] threw an exception during getRememberedPrincipals().";</a> |
| <span class="sourceLineNo">618</span><a id="line.618"> log.warn(msg, e);</a> |
| <span class="sourceLineNo">619</span><a id="line.619"> }</a> |
| <span class="sourceLineNo">620</span><a id="line.620"> }</a> |
| <span class="sourceLineNo">621</span><a id="line.621"> }</a> |
| <span class="sourceLineNo">622</span><a id="line.622"> return null;</a> |
| <span class="sourceLineNo">623</span><a id="line.623"> }</a> |
| <span class="sourceLineNo">624</span><a id="line.624">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
