| <!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, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.security.provider;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.net.InetAddress;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Map;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import javax.security.sasl.SaslClient;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.conf.Configuration;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.security.SecurityInfo;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.security.User;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.security.UserGroupInformation;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.security.token.Token;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.security.token.TokenIdentifier;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.UserInformation;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span>/**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Encapsulation of client-side logic to authenticate to HBase via some means over SASL.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * Implementations should not directly implement this interface, but instead extend<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * {@link AbstractSaslClientAuthenticationProvider}. Implementations of this interface must make an<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * implementation of {@code hashCode()} which returns the same value across multiple instances of<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * the provider implementation.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> */<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.AUTHENTICATION)<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>@InterfaceStability.Evolving<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>public interface SaslClientAuthenticationProvider extends SaslAuthenticationProvider {<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> * Creates the SASL client instance for this auth'n method.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> SaslClient createClient(Configuration conf, InetAddress serverAddr, SecurityInfo securityInfo,<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> Token<? extends TokenIdentifier> token, boolean fallbackAllowed, Map<String, String> saslProps)<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> throws IOException;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Constructs a {@link UserInformation} from the given {@link UserGroupInformation}<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> UserInformation getUserInfo(User user);<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> /**<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * Returns the "real" user, the user who has the credentials being authenticated by the remote<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * service, in the form of an {@link UserGroupInformation} object. It is common in the Hadoop<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * "world" to have distinct notions of a "real" user and a "proxy" user. A "real" user is the user<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * which actually has the credentials (often, a Kerberos ticket), but some code may be running as<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * some other user who has no credentials. This method gives the authentication provider a chance<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * to acknowledge this is happening and ensure that any RPCs are executed with the real user's<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * credentials, because executing them as the proxy user would result in failure because no<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * credentials exist to authenticate the RPC. Not all implementations will need to implement this<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * method. By default, the provided User's UGI is returned directly.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> default UserGroupInformation getRealUser(User ugi) {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> return ugi.getUGI();<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> }<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> * Returns true if the implementation is capable of performing some action which may allow a<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * failed authentication to become a successful authentication. Otherwise, returns false<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> default boolean canRetry() {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> return false;<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> }<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> /**<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * Executes any necessary logic to re-login the client. Not all implementations will have any<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * logic that needs to be executed.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> */<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> default void relogin() throws IOException {<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
