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