| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a> |
| <FONT color="green">017</FONT> * under the License.<a name="line.17"></a> |
| <FONT color="green">018</FONT> */<a name="line.18"></a> |
| <FONT color="green">019</FONT> package org.apache.shiro.authc.pam;<a name="line.19"></a> |
| <FONT color="green">020</FONT> <a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.shiro.authc.*;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.shiro.realm.Realm;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.shiro.subject.PrincipalCollection;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.shiro.util.CollectionUtils;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.slf4j.Logger;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.slf4j.LoggerFactory;<a name="line.26"></a> |
| <FONT color="green">027</FONT> <a name="line.27"></a> |
| <FONT color="green">028</FONT> import java.util.Collection;<a name="line.28"></a> |
| <FONT color="green">029</FONT> <a name="line.29"></a> |
| <FONT color="green">030</FONT> /**<a name="line.30"></a> |
| <FONT color="green">031</FONT> * A {@code ModularRealmAuthenticator} delgates account lookups to a pluggable (modular) collection of<a name="line.31"></a> |
| <FONT color="green">032</FONT> * {@link Realm}s. This enables PAM (Pluggable Authentication Module) behavior in Shiro.<a name="line.32"></a> |
| <FONT color="green">033</FONT> * In addition to authorization duties, a Shiro Realm can also be thought of a PAM 'module'.<a name="line.33"></a> |
| <FONT color="green">034</FONT> * <p/><a name="line.34"></a> |
| <FONT color="green">035</FONT> * Using this Authenticator allows you to &quot;plug-in&quot; your own<a name="line.35"></a> |
| <FONT color="green">036</FONT> * {@code Realm}s as you see fit. Common realms are those based on accessing<a name="line.36"></a> |
| <FONT color="green">037</FONT> * LDAP, relational databases, file systems, etc.<a name="line.37"></a> |
| <FONT color="green">038</FONT> * <p/><a name="line.38"></a> |
| <FONT color="green">039</FONT> * If only one realm is configured (this is often the case for most applications), authentication success is naturally<a name="line.39"></a> |
| <FONT color="green">040</FONT> * only dependent upon invoking this one Realm's<a name="line.40"></a> |
| <FONT color="green">041</FONT> * {@link Realm#getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)} method.<a name="line.41"></a> |
| <FONT color="green">042</FONT> * <p/><a name="line.42"></a> |
| <FONT color="green">043</FONT> * But if two or more realms are configured, PAM behavior is implemented by iterating over the collection of realms<a name="line.43"></a> |
| <FONT color="green">044</FONT> * and interacting with each over the course of the authentication attempt. As this is more complicated, this<a name="line.44"></a> |
| <FONT color="green">045</FONT> * authenticator allows customized behavior for interpreting what happens when interacting with multiple realms - for<a name="line.45"></a> |
| <FONT color="green">046</FONT> * example, you might require all realms to be successful during the attempt, or perhaps only at least one must be<a name="line.46"></a> |
| <FONT color="green">047</FONT> * successful, or some other interpretation. This customized behavior can be performed via the use of a<a name="line.47"></a> |
| <FONT color="green">048</FONT> * {@link #setAuthenticationStrategy(AuthenticationStrategy) AuthenticationStrategy}, which<a name="line.48"></a> |
| <FONT color="green">049</FONT> * you can inject as a property of this class.<a name="line.49"></a> |
| <FONT color="green">050</FONT> * <p/><a name="line.50"></a> |
| <FONT color="green">051</FONT> * The strategy object provides callback methods that allow you to<a name="line.51"></a> |
| <FONT color="green">052</FONT> * determine what constitutes a success or failure in a multi-realm (PAM) scenario. And because this only makes sense<a name="line.52"></a> |
| <FONT color="green">053</FONT> * in a mult-realm scenario, the strategy object is only utilized when more than one Realm is configured.<a name="line.53"></a> |
| <FONT color="green">054</FONT> * <p/><a name="line.54"></a> |
| <FONT color="green">055</FONT> * As most multi-realm applications require at least one Realm authenticates successfully, the default<a name="line.55"></a> |
| <FONT color="green">056</FONT> * implementation is the {@link AtLeastOneSuccessfulStrategy}.<a name="line.56"></a> |
| <FONT color="green">057</FONT> *<a name="line.57"></a> |
| <FONT color="green">058</FONT> * @see #setRealms<a name="line.58"></a> |
| <FONT color="green">059</FONT> * @see AtLeastOneSuccessfulStrategy<a name="line.59"></a> |
| <FONT color="green">060</FONT> * @see AllSuccessfulStrategy<a name="line.60"></a> |
| <FONT color="green">061</FONT> * @see FirstSuccessfulStrategy<a name="line.61"></a> |
| <FONT color="green">062</FONT> * @since 0.1<a name="line.62"></a> |
| <FONT color="green">063</FONT> */<a name="line.63"></a> |
| <FONT color="green">064</FONT> public class ModularRealmAuthenticator extends AbstractAuthenticator {<a name="line.64"></a> |
| <FONT color="green">065</FONT> <a name="line.65"></a> |
| <FONT color="green">066</FONT> /*--------------------------------------------<a name="line.66"></a> |
| <FONT color="green">067</FONT> | C O N S T A N T S |<a name="line.67"></a> |
| <FONT color="green">068</FONT> ============================================*/<a name="line.68"></a> |
| <FONT color="green">069</FONT> private static final Logger log = LoggerFactory.getLogger(ModularRealmAuthenticator.class);<a name="line.69"></a> |
| <FONT color="green">070</FONT> <a name="line.70"></a> |
| <FONT color="green">071</FONT> /*--------------------------------------------<a name="line.71"></a> |
| <FONT color="green">072</FONT> | I N S T A N C E V A R I A B L E S |<a name="line.72"></a> |
| <FONT color="green">073</FONT> ============================================*/<a name="line.73"></a> |
| <FONT color="green">074</FONT> /**<a name="line.74"></a> |
| <FONT color="green">075</FONT> * List of realms that will be iterated through when a user authenticates.<a name="line.75"></a> |
| <FONT color="green">076</FONT> */<a name="line.76"></a> |
| <FONT color="green">077</FONT> private Collection<Realm> realms;<a name="line.77"></a> |
| <FONT color="green">078</FONT> <a name="line.78"></a> |
| <FONT color="green">079</FONT> /**<a name="line.79"></a> |
| <FONT color="green">080</FONT> * The authentication strategy to use during authentication attempts, defaults to a<a name="line.80"></a> |
| <FONT color="green">081</FONT> * {@link org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy} instance.<a name="line.81"></a> |
| <FONT color="green">082</FONT> */<a name="line.82"></a> |
| <FONT color="green">083</FONT> private AuthenticationStrategy authenticationStrategy;<a name="line.83"></a> |
| <FONT color="green">084</FONT> <a name="line.84"></a> |
| <FONT color="green">085</FONT> /*--------------------------------------------<a name="line.85"></a> |
| <FONT color="green">086</FONT> | C O N S T R U C T O R S |<a name="line.86"></a> |
| <FONT color="green">087</FONT> ============================================*/<a name="line.87"></a> |
| <FONT color="green">088</FONT> <a name="line.88"></a> |
| <FONT color="green">089</FONT> /**<a name="line.89"></a> |
| <FONT color="green">090</FONT> * Default no-argument constructor which<a name="line.90"></a> |
| <FONT color="green">091</FONT> * {@link #setAuthenticationStrategy(AuthenticationStrategy) enables} an<a name="line.91"></a> |
| <FONT color="green">092</FONT> * {@link org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy} by default.<a name="line.92"></a> |
| <FONT color="green">093</FONT> */<a name="line.93"></a> |
| <FONT color="green">094</FONT> public ModularRealmAuthenticator() {<a name="line.94"></a> |
| <FONT color="green">095</FONT> this.authenticationStrategy = new AtLeastOneSuccessfulStrategy();<a name="line.95"></a> |
| <FONT color="green">096</FONT> }<a name="line.96"></a> |
| <FONT color="green">097</FONT> <a name="line.97"></a> |
| <FONT color="green">098</FONT> /*--------------------------------------------<a name="line.98"></a> |
| <FONT color="green">099</FONT> | A C C E S S O R S / M O D I F I E R S |<a name="line.99"></a> |
| <FONT color="green">100</FONT> ============================================*/<a name="line.100"></a> |
| <FONT color="green">101</FONT> <a name="line.101"></a> |
| <FONT color="green">102</FONT> /**<a name="line.102"></a> |
| <FONT color="green">103</FONT> * Sets all realms used by this Authenticator, providing PAM (Pluggable Authentication Module) configuration.<a name="line.103"></a> |
| <FONT color="green">104</FONT> *<a name="line.104"></a> |
| <FONT color="green">105</FONT> * @param realms the realms to consult during authentication attempts.<a name="line.105"></a> |
| <FONT color="green">106</FONT> */<a name="line.106"></a> |
| <FONT color="green">107</FONT> public void setRealms(Collection<Realm> realms) {<a name="line.107"></a> |
| <FONT color="green">108</FONT> this.realms = realms;<a name="line.108"></a> |
| <FONT color="green">109</FONT> }<a name="line.109"></a> |
| <FONT color="green">110</FONT> <a name="line.110"></a> |
| <FONT color="green">111</FONT> /**<a name="line.111"></a> |
| <FONT color="green">112</FONT> * Returns the realm(s) used by this {@code Authenticator} during an authentication attempt.<a name="line.112"></a> |
| <FONT color="green">113</FONT> *<a name="line.113"></a> |
| <FONT color="green">114</FONT> * @return the realm(s) used by this {@code Authenticator} during an authentication attempt.<a name="line.114"></a> |
| <FONT color="green">115</FONT> */<a name="line.115"></a> |
| <FONT color="green">116</FONT> protected Collection<Realm> getRealms() {<a name="line.116"></a> |
| <FONT color="green">117</FONT> return this.realms;<a name="line.117"></a> |
| <FONT color="green">118</FONT> }<a name="line.118"></a> |
| <FONT color="green">119</FONT> <a name="line.119"></a> |
| <FONT color="green">120</FONT> /**<a name="line.120"></a> |
| <FONT color="green">121</FONT> * Returns the {@code AuthenticationStrategy} utilized by this modular authenticator during a multi-realm<a name="line.121"></a> |
| <FONT color="green">122</FONT> * log-in attempt. This object is only used when two or more Realms are configured.<a name="line.122"></a> |
| <FONT color="green">123</FONT> * <p/><a name="line.123"></a> |
| <FONT color="green">124</FONT> * Unless overridden by<a name="line.124"></a> |
| <FONT color="green">125</FONT> * the {@link #setAuthenticationStrategy(AuthenticationStrategy)} method, the default implementation<a name="line.125"></a> |
| <FONT color="green">126</FONT> * is the {@link org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy}.<a name="line.126"></a> |
| <FONT color="green">127</FONT> *<a name="line.127"></a> |
| <FONT color="green">128</FONT> * @return the {@code AuthenticationStrategy} utilized by this modular authenticator during a log-in attempt.<a name="line.128"></a> |
| <FONT color="green">129</FONT> * @since 0.2<a name="line.129"></a> |
| <FONT color="green">130</FONT> */<a name="line.130"></a> |
| <FONT color="green">131</FONT> public AuthenticationStrategy getAuthenticationStrategy() {<a name="line.131"></a> |
| <FONT color="green">132</FONT> return authenticationStrategy;<a name="line.132"></a> |
| <FONT color="green">133</FONT> }<a name="line.133"></a> |
| <FONT color="green">134</FONT> <a name="line.134"></a> |
| <FONT color="green">135</FONT> /**<a name="line.135"></a> |
| <FONT color="green">136</FONT> * Allows overriding the default {@code AuthenticationStrategy} utilized during multi-realm log-in attempts.<a name="line.136"></a> |
| <FONT color="green">137</FONT> * This object is only used when two or more Realms are configured.<a name="line.137"></a> |
| <FONT color="green">138</FONT> *<a name="line.138"></a> |
| <FONT color="green">139</FONT> * @param authenticationStrategy the strategy implementation to use during log-in attempts.<a name="line.139"></a> |
| <FONT color="green">140</FONT> * @since 0.2<a name="line.140"></a> |
| <FONT color="green">141</FONT> */<a name="line.141"></a> |
| <FONT color="green">142</FONT> public void setAuthenticationStrategy(AuthenticationStrategy authenticationStrategy) {<a name="line.142"></a> |
| <FONT color="green">143</FONT> this.authenticationStrategy = authenticationStrategy;<a name="line.143"></a> |
| <FONT color="green">144</FONT> }<a name="line.144"></a> |
| <FONT color="green">145</FONT> <a name="line.145"></a> |
| <FONT color="green">146</FONT> /*--------------------------------------------<a name="line.146"></a> |
| <FONT color="green">147</FONT> | M E T H O D S |<a name="line.147"></a> |
| <FONT color="green">148</FONT> <a name="line.148"></a> |
| <FONT color="green">149</FONT> /**<a name="line.149"></a> |
| <FONT color="green">150</FONT> * Used by the internal {@link #doAuthenticate} implementation to ensure that the {@code realms} property<a name="line.150"></a> |
| <FONT color="green">151</FONT> * has been set. The default implementation ensures the property is not null and not empty.<a name="line.151"></a> |
| <FONT color="green">152</FONT> *<a name="line.152"></a> |
| <FONT color="green">153</FONT> * @throws IllegalStateException if the {@code realms} property is configured incorrectly.<a name="line.153"></a> |
| <FONT color="green">154</FONT> */<a name="line.154"></a> |
| <FONT color="green">155</FONT> <a name="line.155"></a> |
| <FONT color="green">156</FONT> protected void assertRealmsConfigured() throws IllegalStateException {<a name="line.156"></a> |
| <FONT color="green">157</FONT> Collection<Realm> realms = getRealms();<a name="line.157"></a> |
| <FONT color="green">158</FONT> if (CollectionUtils.isEmpty(realms)) {<a name="line.158"></a> |
| <FONT color="green">159</FONT> String msg = "Configuration error: No realms have been configured! One or more realms must be " +<a name="line.159"></a> |
| <FONT color="green">160</FONT> "present to execute an authentication attempt.";<a name="line.160"></a> |
| <FONT color="green">161</FONT> throw new IllegalStateException(msg);<a name="line.161"></a> |
| <FONT color="green">162</FONT> }<a name="line.162"></a> |
| <FONT color="green">163</FONT> }<a name="line.163"></a> |
| <FONT color="green">164</FONT> <a name="line.164"></a> |
| <FONT color="green">165</FONT> /**<a name="line.165"></a> |
| <FONT color="green">166</FONT> * Performs the authentication attempt by interacting with the single configured realm, which is significantly<a name="line.166"></a> |
| <FONT color="green">167</FONT> * simpler than performing multi-realm logic.<a name="line.167"></a> |
| <FONT color="green">168</FONT> *<a name="line.168"></a> |
| <FONT color="green">169</FONT> * @param realm the realm to consult for AuthenticationInfo.<a name="line.169"></a> |
| <FONT color="green">170</FONT> * @param token the submitted AuthenticationToken representing the subject's (user's) log-in principals and credentials.<a name="line.170"></a> |
| <FONT color="green">171</FONT> * @return the AuthenticationInfo associated with the user account corresponding to the specified {@code token}<a name="line.171"></a> |
| <FONT color="green">172</FONT> */<a name="line.172"></a> |
| <FONT color="green">173</FONT> protected AuthenticationInfo doSingleRealmAuthentication(Realm realm, AuthenticationToken token) {<a name="line.173"></a> |
| <FONT color="green">174</FONT> if (!realm.supports(token)) {<a name="line.174"></a> |
| <FONT color="green">175</FONT> String msg = "Realm [" + realm + "] does not support authentication token [" +<a name="line.175"></a> |
| <FONT color="green">176</FONT> token + "]. Please ensure that the appropriate Realm implementation is " +<a name="line.176"></a> |
| <FONT color="green">177</FONT> "configured correctly or that the realm accepts AuthenticationTokens of this type.";<a name="line.177"></a> |
| <FONT color="green">178</FONT> throw new UnsupportedTokenException(msg);<a name="line.178"></a> |
| <FONT color="green">179</FONT> }<a name="line.179"></a> |
| <FONT color="green">180</FONT> AuthenticationInfo info = realm.getAuthenticationInfo(token);<a name="line.180"></a> |
| <FONT color="green">181</FONT> if (info == null) {<a name="line.181"></a> |
| <FONT color="green">182</FONT> String msg = "Realm [" + realm + "] was unable to find account data for the " +<a name="line.182"></a> |
| <FONT color="green">183</FONT> "submitted AuthenticationToken [" + token + "].";<a name="line.183"></a> |
| <FONT color="green">184</FONT> throw new UnknownAccountException(msg);<a name="line.184"></a> |
| <FONT color="green">185</FONT> }<a name="line.185"></a> |
| <FONT color="green">186</FONT> return info;<a name="line.186"></a> |
| <FONT color="green">187</FONT> }<a name="line.187"></a> |
| <FONT color="green">188</FONT> <a name="line.188"></a> |
| <FONT color="green">189</FONT> /**<a name="line.189"></a> |
| <FONT color="green">190</FONT> * Performs the multi-realm authentication attempt by calling back to a {@link AuthenticationStrategy} object<a name="line.190"></a> |
| <FONT color="green">191</FONT> * as each realm is consulted for {@code AuthenticationInfo} for the specified {@code token}.<a name="line.191"></a> |
| <FONT color="green">192</FONT> *<a name="line.192"></a> |
| <FONT color="green">193</FONT> * @param realms the multiple realms configured on this Authenticator instance.<a name="line.193"></a> |
| <FONT color="green">194</FONT> * @param token the submitted AuthenticationToken representing the subject's (user's) log-in principals and credentials.<a name="line.194"></a> |
| <FONT color="green">195</FONT> * @return an aggregated AuthenticationInfo instance representing account data across all the successfully<a name="line.195"></a> |
| <FONT color="green">196</FONT> * consulted realms.<a name="line.196"></a> |
| <FONT color="green">197</FONT> */<a name="line.197"></a> |
| <FONT color="green">198</FONT> protected AuthenticationInfo doMultiRealmAuthentication(Collection<Realm> realms, AuthenticationToken token) {<a name="line.198"></a> |
| <FONT color="green">199</FONT> <a name="line.199"></a> |
| <FONT color="green">200</FONT> AuthenticationStrategy strategy = getAuthenticationStrategy();<a name="line.200"></a> |
| <FONT color="green">201</FONT> <a name="line.201"></a> |
| <FONT color="green">202</FONT> AuthenticationInfo aggregate = strategy.beforeAllAttempts(realms, token);<a name="line.202"></a> |
| <FONT color="green">203</FONT> <a name="line.203"></a> |
| <FONT color="green">204</FONT> if (log.isTraceEnabled()) {<a name="line.204"></a> |
| <FONT color="green">205</FONT> log.trace("Iterating through {} realms for PAM authentication", realms.size());<a name="line.205"></a> |
| <FONT color="green">206</FONT> }<a name="line.206"></a> |
| <FONT color="green">207</FONT> <a name="line.207"></a> |
| <FONT color="green">208</FONT> for (Realm realm : realms) {<a name="line.208"></a> |
| <FONT color="green">209</FONT> <a name="line.209"></a> |
| <FONT color="green">210</FONT> aggregate = strategy.beforeAttempt(realm, token, aggregate);<a name="line.210"></a> |
| <FONT color="green">211</FONT> <a name="line.211"></a> |
| <FONT color="green">212</FONT> if (realm.supports(token)) {<a name="line.212"></a> |
| <FONT color="green">213</FONT> <a name="line.213"></a> |
| <FONT color="green">214</FONT> log.trace("Attempting to authenticate token [{}] using realm [{}]", token, realm);<a name="line.214"></a> |
| <FONT color="green">215</FONT> <a name="line.215"></a> |
| <FONT color="green">216</FONT> AuthenticationInfo info = null;<a name="line.216"></a> |
| <FONT color="green">217</FONT> Throwable t = null;<a name="line.217"></a> |
| <FONT color="green">218</FONT> try {<a name="line.218"></a> |
| <FONT color="green">219</FONT> info = realm.getAuthenticationInfo(token);<a name="line.219"></a> |
| <FONT color="green">220</FONT> } catch (Throwable throwable) {<a name="line.220"></a> |
| <FONT color="green">221</FONT> t = throwable;<a name="line.221"></a> |
| <FONT color="green">222</FONT> if (log.isDebugEnabled()) {<a name="line.222"></a> |
| <FONT color="green">223</FONT> String msg = "Realm [" + realm + "] threw an exception during a multi-realm authentication attempt:";<a name="line.223"></a> |
| <FONT color="green">224</FONT> log.debug(msg, t);<a name="line.224"></a> |
| <FONT color="green">225</FONT> }<a name="line.225"></a> |
| <FONT color="green">226</FONT> }<a name="line.226"></a> |
| <FONT color="green">227</FONT> <a name="line.227"></a> |
| <FONT color="green">228</FONT> aggregate = strategy.afterAttempt(realm, token, info, aggregate, t);<a name="line.228"></a> |
| <FONT color="green">229</FONT> <a name="line.229"></a> |
| <FONT color="green">230</FONT> } else {<a name="line.230"></a> |
| <FONT color="green">231</FONT> log.debug("Realm [{}] does not support token {}. Skipping realm.", realm, token);<a name="line.231"></a> |
| <FONT color="green">232</FONT> }<a name="line.232"></a> |
| <FONT color="green">233</FONT> }<a name="line.233"></a> |
| <FONT color="green">234</FONT> <a name="line.234"></a> |
| <FONT color="green">235</FONT> aggregate = strategy.afterAllAttempts(token, aggregate);<a name="line.235"></a> |
| <FONT color="green">236</FONT> <a name="line.236"></a> |
| <FONT color="green">237</FONT> return aggregate;<a name="line.237"></a> |
| <FONT color="green">238</FONT> }<a name="line.238"></a> |
| <FONT color="green">239</FONT> <a name="line.239"></a> |
| <FONT color="green">240</FONT> <a name="line.240"></a> |
| <FONT color="green">241</FONT> /**<a name="line.241"></a> |
| <FONT color="green">242</FONT> * Attempts to authenticate the given token by iterating over the internal collection of<a name="line.242"></a> |
| <FONT color="green">243</FONT> * {@link Realm}s. For each realm, first the {@link Realm#supports(org.apache.shiro.authc.AuthenticationToken)}<a name="line.243"></a> |
| <FONT color="green">244</FONT> * method will be called to determine if the realm supports the {@code authenticationToken} method argument.<a name="line.244"></a> |
| <FONT color="green">245</FONT> * <p/><a name="line.245"></a> |
| <FONT color="green">246</FONT> * If a realm does support<a name="line.246"></a> |
| <FONT color="green">247</FONT> * the token, its {@link Realm#getAuthenticationInfo(org.apache.shiro.authc.AuthenticationToken)}<a name="line.247"></a> |
| <FONT color="green">248</FONT> * method will be called. If the realm returns a non-null account, the token will be<a name="line.248"></a> |
| <FONT color="green">249</FONT> * considered authenticated for that realm and the account data recorded. If the realm returns {@code null},<a name="line.249"></a> |
| <FONT color="green">250</FONT> * the next realm will be consulted. If no realms support the token or all supporting realms return null,<a name="line.250"></a> |
| <FONT color="green">251</FONT> * an {@link AuthenticationException} will be thrown to indicate that the user could not be authenticated.<a name="line.251"></a> |
| <FONT color="green">252</FONT> * <p/><a name="line.252"></a> |
| <FONT color="green">253</FONT> * After all realms have been consulted, the information from each realm is aggregated into a single<a name="line.253"></a> |
| <FONT color="green">254</FONT> * {@link AuthenticationInfo} object and returned.<a name="line.254"></a> |
| <FONT color="green">255</FONT> *<a name="line.255"></a> |
| <FONT color="green">256</FONT> * @param authenticationToken the token containing the authentication principal and credentials for the<a name="line.256"></a> |
| <FONT color="green">257</FONT> * user being authenticated.<a name="line.257"></a> |
| <FONT color="green">258</FONT> * @return account information attributed to the authenticated user.<a name="line.258"></a> |
| <FONT color="green">259</FONT> * @throws IllegalStateException if no realms have been configured at the time this method is invoked<a name="line.259"></a> |
| <FONT color="green">260</FONT> * @throws AuthenticationException if the user could not be authenticated or the user is denied authentication<a name="line.260"></a> |
| <FONT color="green">261</FONT> * for the given principal and credentials.<a name="line.261"></a> |
| <FONT color="green">262</FONT> */<a name="line.262"></a> |
| <FONT color="green">263</FONT> protected AuthenticationInfo doAuthenticate(AuthenticationToken authenticationToken) throws AuthenticationException {<a name="line.263"></a> |
| <FONT color="green">264</FONT> assertRealmsConfigured();<a name="line.264"></a> |
| <FONT color="green">265</FONT> Collection<Realm> realms = getRealms();<a name="line.265"></a> |
| <FONT color="green">266</FONT> if (realms.size() == 1) {<a name="line.266"></a> |
| <FONT color="green">267</FONT> return doSingleRealmAuthentication(realms.iterator().next(), authenticationToken);<a name="line.267"></a> |
| <FONT color="green">268</FONT> } else {<a name="line.268"></a> |
| <FONT color="green">269</FONT> return doMultiRealmAuthentication(realms, authenticationToken);<a name="line.269"></a> |
| <FONT color="green">270</FONT> }<a name="line.270"></a> |
| <FONT color="green">271</FONT> }<a name="line.271"></a> |
| <FONT color="green">272</FONT> <a name="line.272"></a> |
| <FONT color="green">273</FONT> /**<a name="line.273"></a> |
| <FONT color="green">274</FONT> * First calls <code>super.onLogout(principals)</code> to ensure a logout notification is issued, and for each<a name="line.274"></a> |
| <FONT color="green">275</FONT> * wrapped {@code Realm} that implements the {@link LogoutAware LogoutAware} interface, calls<a name="line.275"></a> |
| <FONT color="green">276</FONT> * <code>((LogoutAware)realm).onLogout(principals)</code> to allow each realm the opportunity to perform<a name="line.276"></a> |
| <FONT color="green">277</FONT> * logout/cleanup operations during an user-logout.<a name="line.277"></a> |
| <FONT color="green">278</FONT> * <p/><a name="line.278"></a> |
| <FONT color="green">279</FONT> * Shiro's Realm implementations all implement the {@code LogoutAware} interface by default and can be<a name="line.279"></a> |
| <FONT color="green">280</FONT> * overridden for realm-specific logout logic.<a name="line.280"></a> |
| <FONT color="green">281</FONT> *<a name="line.281"></a> |
| <FONT color="green">282</FONT> * @param principals the application-specific Subject/user identifier.<a name="line.282"></a> |
| <FONT color="green">283</FONT> */<a name="line.283"></a> |
| <FONT color="green">284</FONT> public void onLogout(PrincipalCollection principals) {<a name="line.284"></a> |
| <FONT color="green">285</FONT> super.onLogout(principals);<a name="line.285"></a> |
| <FONT color="green">286</FONT> Collection<Realm> realms = getRealms();<a name="line.286"></a> |
| <FONT color="green">287</FONT> if (!CollectionUtils.isEmpty(realms)) {<a name="line.287"></a> |
| <FONT color="green">288</FONT> for (Realm realm : realms) {<a name="line.288"></a> |
| <FONT color="green">289</FONT> if (realm instanceof LogoutAware) {<a name="line.289"></a> |
| <FONT color="green">290</FONT> ((LogoutAware) realm).onLogout(principals);<a name="line.290"></a> |
| <FONT color="green">291</FONT> }<a name="line.291"></a> |
| <FONT color="green">292</FONT> }<a name="line.292"></a> |
| <FONT color="green">293</FONT> }<a name="line.293"></a> |
| <FONT color="green">294</FONT> }<a name="line.294"></a> |
| <FONT color="green">295</FONT> }<a name="line.295"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
