blob: 1ef7bd89a7970d90ffcd67904991ccc894d54a2b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<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.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.subject.PrincipalCollection;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>/**<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;tt&gt;AuthenticationStrategy&lt;/tt&gt; implementation that requires &lt;em&gt;at least one&lt;/em&gt; configured realm to<a name="line.27"></a>
<span class="sourceLineNo">028</span> * successfully process the submitted &lt;tt&gt;AuthenticationToken&lt;/tt&gt; during the log-in attempt.<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p/&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;p&gt;This means any number of configured realms do not have to support the submitted log-in token, or they may<a name="line.30"></a>
<span class="sourceLineNo">031</span> * be unable to acquire &lt;tt&gt;AuthenticationInfo&lt;/tt&gt; for the token, but as long as at least one can do both, this<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Strategy implementation will allow the log-in process to be successful.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;p/&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;Note that this implementation will aggregate the account data from &lt;em&gt;all&lt;/em&gt; successfully consulted<a name="line.34"></a>
<span class="sourceLineNo">035</span> * realms during the authentication attempt. If you want only the account data from the first successfully<a name="line.35"></a>
<span class="sourceLineNo">036</span> * consulted realm and want to ignore all subsequent realms, use the<a name="line.36"></a>
<span class="sourceLineNo">037</span> * {@link FirstSuccessfulStrategy FirstSuccessfulAuthenticationStrategy} instead.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @see FirstSuccessfulStrategy FirstSuccessfulAuthenticationStrategy<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @since 0.2<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span>public class AtLeastOneSuccessfulStrategy extends AbstractAuthenticationStrategy {<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> private static boolean isEmpty(PrincipalCollection pc) {<a name="line.44"></a>
<span class="sourceLineNo">045</span> return pc == null || pc.isEmpty();<a name="line.45"></a>
<span class="sourceLineNo">046</span> }<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> /**<a name="line.48"></a>
<span class="sourceLineNo">049</span> * Ensures that the &lt;code&gt;aggregate&lt;/code&gt; method argument is not &lt;code&gt;null&lt;/code&gt; and<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;code&gt;aggregate.{@link org.apache.shiro.authc.AuthenticationInfo#getPrincipals() getPrincipals()}&lt;/code&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * is not &lt;code&gt;null&lt;/code&gt;, and if either is &lt;code&gt;null&lt;/code&gt;, throws an AuthenticationException to indicate<a name="line.51"></a>
<span class="sourceLineNo">052</span> * that none of the realms authenticated successfully.<a name="line.52"></a>
<span class="sourceLineNo">053</span> */<a name="line.53"></a>
<span class="sourceLineNo">054</span> public AuthenticationInfo afterAllAttempts(AuthenticationToken token, AuthenticationInfo aggregate) throws AuthenticationException {<a name="line.54"></a>
<span class="sourceLineNo">055</span> //we know if one or more were able to successfully authenticate if the aggregated account object does not<a name="line.55"></a>
<span class="sourceLineNo">056</span> //contain null or empty data:<a name="line.56"></a>
<span class="sourceLineNo">057</span> if (aggregate == null || isEmpty(aggregate.getPrincipals())) {<a name="line.57"></a>
<span class="sourceLineNo">058</span> throw new AuthenticationException("Authentication token of type [" + token.getClass() + "] " +<a name="line.58"></a>
<span class="sourceLineNo">059</span> "could not be authenticated by any configured realms. Please ensure that at least one realm can " +<a name="line.59"></a>
<span class="sourceLineNo">060</span> "authenticate these tokens.");<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> return aggregate;<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span>}<a name="line.65"></a>
</pre>
</div>
</body>
</html>