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