blob: 86454b63bf7e1c24c7db35a838f54ab4d9048283 [file] [log] [blame]
<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.slf4j.Logger;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.slf4j.LoggerFactory;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.authc.AuthenticationException;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.authc.AuthenticationInfo;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.shiro.authc.AuthenticationToken;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.shiro.authc.UnknownAccountException;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.shiro.realm.Realm;<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 name="line.31"></a>
<FONT color="green">032</FONT> * &lt;tt&gt;AuthenticationStrategy&lt;/tt&gt; implementation that requires &lt;em&gt;all&lt;/em&gt; configured realms to<a name="line.32"></a>
<FONT color="green">033</FONT> * &lt;b&gt;successfully&lt;/b&gt; process the submitted &lt;tt&gt;AuthenticationToken&lt;/tt&gt; during the log-in attempt.<a name="line.33"></a>
<FONT color="green">034</FONT> * &lt;p/&gt;<a name="line.34"></a>
<FONT color="green">035</FONT> * &lt;p&gt;If one or more realms do not support the submitted token, or one or more are unable to acquire<a name="line.35"></a>
<FONT color="green">036</FONT> * &lt;tt&gt;AuthenticationInfo&lt;/tt&gt; for the token, this implementation will immediately fail the log-in attempt for the<a name="line.36"></a>
<FONT color="green">037</FONT> * associated subject (user).<a name="line.37"></a>
<FONT color="green">038</FONT> *<a name="line.38"></a>
<FONT color="green">039</FONT> * @since 0.2<a name="line.39"></a>
<FONT color="green">040</FONT> */<a name="line.40"></a>
<FONT color="green">041</FONT> public class AllSuccessfulStrategy extends AbstractAuthenticationStrategy {<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> /** Private class log instance. */<a name="line.43"></a>
<FONT color="green">044</FONT> private static final Logger log = LoggerFactory.getLogger(AllSuccessfulStrategy.class);<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> /**<a name="line.46"></a>
<FONT color="green">047</FONT> * Because all realms in this strategy must complete successfully, this implementation ensures that the given<a name="line.47"></a>
<FONT color="green">048</FONT> * &lt;code&gt;Realm&lt;/code&gt; {@link org.apache.shiro.realm.Realm#supports(org.apache.shiro.authc.AuthenticationToken) supports} the given<a name="line.48"></a>
<FONT color="green">049</FONT> * &lt;code&gt;token&lt;/code&gt; argument. If it does not, this method throws an<a name="line.49"></a>
<FONT color="green">050</FONT> * {@link UnsupportedTokenException UnsupportedTokenException} to end the authentication<a name="line.50"></a>
<FONT color="green">051</FONT> * process immediately. If the realm does support the token, the &lt;code&gt;info&lt;/code&gt; argument is returned immediately.<a name="line.51"></a>
<FONT color="green">052</FONT> */<a name="line.52"></a>
<FONT color="green">053</FONT> public AuthenticationInfo beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo info) throws AuthenticationException {<a name="line.53"></a>
<FONT color="green">054</FONT> if (!realm.supports(token)) {<a name="line.54"></a>
<FONT color="green">055</FONT> String msg = "Realm [" + realm + "] of type [" + realm.getClass().getName() + "] does not support " +<a name="line.55"></a>
<FONT color="green">056</FONT> " the submitted AuthenticationToken [" + token + "]. The [" + getClass().getName() +<a name="line.56"></a>
<FONT color="green">057</FONT> "] implementation requires all configured realm(s) to support and be able to process the submitted " +<a name="line.57"></a>
<FONT color="green">058</FONT> "AuthenticationToken.";<a name="line.58"></a>
<FONT color="green">059</FONT> throw new UnsupportedTokenException(msg);<a name="line.59"></a>
<FONT color="green">060</FONT> }<a name="line.60"></a>
<FONT color="green">061</FONT> <a name="line.61"></a>
<FONT color="green">062</FONT> return info;<a name="line.62"></a>
<FONT color="green">063</FONT> }<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> /**<a name="line.65"></a>
<FONT color="green">066</FONT> * Merges the specified &lt;code&gt;info&lt;/code&gt; into the &lt;code&gt;aggregate&lt;/code&gt; argument and returns it (just as the<a name="line.66"></a>
<FONT color="green">067</FONT> * parent implementation does), but additionally ensures the following:<a name="line.67"></a>
<FONT color="green">068</FONT> * &lt;ol&gt;<a name="line.68"></a>
<FONT color="green">069</FONT> * &lt;li&gt;if the &lt;code&gt;Throwable&lt;/code&gt; argument is not &lt;code&gt;null&lt;/code&gt;, re-throws it to immediately cancel the<a name="line.69"></a>
<FONT color="green">070</FONT> * authentication process, since this strategy requires all realms to authenticate successfully.&lt;/li&gt;<a name="line.70"></a>
<FONT color="green">071</FONT> * &lt;li&gt;neither the &lt;code&gt;info&lt;/code&gt; or &lt;code&gt;aggregate&lt;/code&gt; argument is &lt;code&gt;null&lt;/code&gt; to ensure that each<a name="line.71"></a>
<FONT color="green">072</FONT> * realm did in fact authenticate successfully&lt;/li&gt;<a name="line.72"></a>
<FONT color="green">073</FONT> * &lt;/ol&gt;<a name="line.73"></a>
<FONT color="green">074</FONT> */<a name="line.74"></a>
<FONT color="green">075</FONT> public AuthenticationInfo afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo info, AuthenticationInfo aggregate, Throwable t)<a name="line.75"></a>
<FONT color="green">076</FONT> throws AuthenticationException {<a name="line.76"></a>
<FONT color="green">077</FONT> if (t != null) {<a name="line.77"></a>
<FONT color="green">078</FONT> if (t instanceof AuthenticationException) {<a name="line.78"></a>
<FONT color="green">079</FONT> //propagate:<a name="line.79"></a>
<FONT color="green">080</FONT> throw ((AuthenticationException) t);<a name="line.80"></a>
<FONT color="green">081</FONT> } else {<a name="line.81"></a>
<FONT color="green">082</FONT> String msg = "Unable to acquire account data from realm [" + realm + "]. The [" +<a name="line.82"></a>
<FONT color="green">083</FONT> getClass().getName() + " implementation requires all configured realm(s) to operate successfully " +<a name="line.83"></a>
<FONT color="green">084</FONT> "for a successful authentication.";<a name="line.84"></a>
<FONT color="green">085</FONT> throw new AuthenticationException(msg, t);<a name="line.85"></a>
<FONT color="green">086</FONT> }<a name="line.86"></a>
<FONT color="green">087</FONT> }<a name="line.87"></a>
<FONT color="green">088</FONT> if (info == null) {<a name="line.88"></a>
<FONT color="green">089</FONT> String msg = "Realm [" + realm + "] could not find any associated account data for the submitted " +<a name="line.89"></a>
<FONT color="green">090</FONT> "AuthenticationToken [" + token + "]. The [" + getClass().getName() + "] implementation requires " +<a name="line.90"></a>
<FONT color="green">091</FONT> "all configured realm(s) to acquire valid account data for a submitted token during the " +<a name="line.91"></a>
<FONT color="green">092</FONT> "log-in process.";<a name="line.92"></a>
<FONT color="green">093</FONT> throw new UnknownAccountException(msg);<a name="line.93"></a>
<FONT color="green">094</FONT> }<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> log.debug("Account successfully authenticated using realm [{}]", realm);<a name="line.96"></a>
<FONT color="green">097</FONT> <a name="line.97"></a>
<FONT color="green">098</FONT> // If non-null account is returned, then the realm was able to authenticate the<a name="line.98"></a>
<FONT color="green">099</FONT> // user - so merge the account with any accumulated before:<a name="line.99"></a>
<FONT color="green">100</FONT> merge(info, aggregate);<a name="line.100"></a>
<FONT color="green">101</FONT> <a name="line.101"></a>
<FONT color="green">102</FONT> return aggregate;<a name="line.102"></a>
<FONT color="green">103</FONT> }<a name="line.103"></a>
<FONT color="green">104</FONT> }<a name="line.104"></a>
</PRE>
</BODY>
</HTML>