| <!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.realm.Realm;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Collection;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>/**<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * A {@code AuthenticationStrategy} implementation assists the {@link ModularRealmAuthenticator} during the<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * log-in process in a pluggable realm (PAM) environment.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> *<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * <p>The {@code ModularRealmAuthenticator} will consult implementations of this interface on what to do during each<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * interaction with the configured Realms. This allows a pluggable strategy of whether or not an authentication<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * attempt must be successful for all realms, only 1 or more realms, no realms, etc.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> *<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * @see AllSuccessfulStrategy<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * @see AtLeastOneSuccessfulStrategy<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @see FirstSuccessfulStrategy<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 interface AuthenticationStrategy {<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> /**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Method invoked by the ModularAuthenticator signifying that the authentication process is about to begin for the<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * specified {@code token} - called before any {@code Realm} is actually invoked.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <p>The {@code AuthenticationInfo} object returned from this method is essentially an empty place holder for<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * aggregating account data across multiple realms. It should be populated by the strategy implementation over the<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * course of authentication attempts across the multiple realms. It will be passed into the<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * {@link #beforeAttempt} calls, allowing inspection of the aggregated account data up to that point in the<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * multi-realm authentication, allowing any logic to be executed accordingly.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> *<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @param realms the Realms that will be consulted during the authentication process for the specified token.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @param token the Principal/Credential representation to be used during authentication for a corresponding subject.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @return an empty AuthenticationInfo object that will populated with data from multiple realms.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @throws AuthenticationException if the strategy implementation does not wish the Authentication attempt to execute.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> AuthenticationInfo beforeAllAttempts(Collection<? extends Realm> realms, AuthenticationToken token) throws AuthenticationException;<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> * Method invoked by the ModularAuthenticator just prior to the realm being consulted for account data,<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * allowing pre-authentication-attempt logic for that realm only.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> *<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <p>This method returns an {@code AuthenticationInfo} object that will be used for further interaction with realms. Most<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * implementations will merely return the {@code aggregate} method argument if they don't have a need to<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * manipulate it.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> *<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @param realm the realm that will be consulted for {@code AuthenticationInfo} for the specified {@code token}.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param token the {@code AuthenticationToken} submitted for the subject attempting system log-in.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @param aggregate the aggregated AuthenticationInfo object being used across the multi-realm authentication attempt<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @return the AuthenticationInfo object that will be presented to further realms in the authentication process - returning<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * the {@code aggregate} method argument is the normal case if no special action needs to be taken.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * @throws org.apache.shiro.authc.AuthenticationException<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * an exception thrown by the Strategy implementation if it wishes the login<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * process for the associated subject (user) to stop immediately.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> AuthenticationInfo beforeAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo aggregate) throws AuthenticationException;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> /**<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * Method invoked by the ModularAuthenticator just after the given realm has been consulted for authentication,<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * allowing post-authentication-attempt logic for that realm only.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> *<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * <p>This method returns an {@code AuthenticationInfo} object that will be used for further interaction with realms. Most<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * implementations will merge the {@code singleRealmInfo} into the {@code aggregateInfo} and<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * just return the {@code aggregateInfo} for continued use throughout the authentication process.</p><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> *<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @param realm the realm that was just consulted for {@code AuthenticationInfo} for the given {@code token}.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param token the {@code AuthenticationToken} submitted for the subject attempting system log-in.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @param singleRealmInfo the info returned from a single realm.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param aggregateInfo the aggregate info representing all realms in a multi-realm environment.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @param t the Throwable thrown by the Realm during the attempt, or {@code null} if the method returned normally.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @return the AuthenticationInfo object that will be presented to further realms in the authentication process - returning<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * the {@code aggregateAccount} method argument is the normal case if no special action needs to be taken.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @throws AuthenticationException an exception thrown by the Strategy implementation if it wishes the login process<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * for the associated subject (user) to stop immediately.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> */<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> AuthenticationInfo afterAttempt(Realm realm, AuthenticationToken token, AuthenticationInfo singleRealmInfo, AuthenticationInfo aggregateInfo, Throwable t)<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> throws AuthenticationException;<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> * Method invoked by the ModularAuthenticator signifying that all of its configured Realms have been consulted<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * for account data, allowing post-proccessing after all realms have completed.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> *<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * <p>Returns the final AuthenticationInfo object that will be returned from the Authenticator to the authenticate() caller.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * This is most likely the aggregate AuthenticationInfo object that has been populated by many realms, but the actual return value is<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * always up to the implementation.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> *<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @param token the {@code AuthenticationToken} submitted for the subject attempting system log-in.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param aggregate the aggregate {@code AuthenticationInfo} instance populated by all realms during the log-in attempt.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @return the final {@code AuthenticationInfo} object to return to the Authenticator.authenticate() caller.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @throws AuthenticationException if the Strategy implementation wishes to fail the authentication attempt.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> */<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> AuthenticationInfo afterAllAttempts(AuthenticationToken token, AuthenticationInfo aggregate) throws AuthenticationException;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span>}<a name="line.115"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
