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