org.apache.hadoop.hbase.security.token

Class TokenUtil

java.lang.Object

org.apache.hadoop.hbase.security.token.TokenUtil

@InterfaceAudience.Public
public class TokenUtil
extends Object

Utility methods for obtaining authentication tokens.

Field Summary

Fields

Modifier and Type	Field and Description
private static com.google.protobuf.ServiceException	injectedException
private static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
TokenUtil()

Method Summary

Modifier and Type	Method and Description
static void	addTokenForJob(Connection conn, org.apache.hadoop.mapred.JobConf job, User user) Checks for an authentication token for the given user, obtaining a new token if necessary, and adds it to the credentials for the given map reduce job.
static void	addTokenForJob(Connection conn, User user, org.apache.hadoop.mapreduce.Job job) Checks for an authentication token for the given user, obtaining a new token if necessary, and adds it to the credentials for the given map reduce job.
static boolean	addTokenIfMissing(Connection conn, User user) Checks if an authentication tokens exists for the connected cluster, obtaining one if needed and adding it to the user's credentials.
private static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier>	getAuthToken(org.apache.hadoop.conf.Configuration conf, User user) Get the authentication token of the user for the cluster specified in the configuration
private static org.apache.hadoop.io.Text	getClusterId(org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> token)
private static void	injectFault()
static void	obtainAndCacheToken(Connection conn, User user) Obtain an authentication token for the given user and add it to the user's credentials.
static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier>	obtainToken(org.apache.hadoop.conf.Configuration conf) Deprecated. Since 2.0.0.
static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier>	obtainToken(Connection conn) Obtain and return an authentication token for the current user.
static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier>	obtainToken(Connection conn, User user) Obtain and return an authentication token for the current user.
static void	obtainTokenForJob(Connection conn, org.apache.hadoop.mapred.JobConf job, User user) Obtain an authentication token on behalf of the given user and add it to the credentials for the given map reduce job.
static void	obtainTokenForJob(Connection conn, User user, org.apache.hadoop.mapreduce.Job job) Obtain an authentication token on behalf of the given user and add it to the credentials for the given map reduce job.
static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier>	toToken(org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.Token proto) Converts a protobuf Token message back into a Token instance.
static org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.Token	toToken(org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> token) Converts a Token instance (with embedded identifier) to the protobuf representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.slf4j.Logger LOG

injectedException

private static com.google.protobuf.ServiceException injectedException

Constructor Detail

TokenUtil

public TokenUtil()

Method Detail

injectFault

private static void injectFault()
                         throws com.google.protobuf.ServiceException

Throws:

com.google.protobuf.ServiceException

obtainToken

@Deprecated
public static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> obtainToken(org.apache.hadoop.conf.Configuration conf)
                                                                                                     throws IOException

Deprecated. Since 2.0.0.

It was removed in HBase-2.0 but added again as spark code relies on this method to obtain delegation token

Throws:

IOException

obtainToken

public static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> obtainToken(Connection conn)
                                                                                         throws IOException

Obtain and return an authentication token for the current user.

Parameters:

conn - The HBase cluster connection

Returns:

the authentication token instance

Throws:

IOException - if a remote error or serialization problem occurs.

toToken

public static org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.Token toToken(org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> token)

Converts a Token instance (with embedded identifier) to the protobuf representation.

Parameters:

token - the Token instance to copy

Returns:

the protobuf Token message

obtainToken

public static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> obtainToken(Connection conn,
                                                                                                User user)
                                                                                         throws IOException,
                                                                                                InterruptedException

Obtain and return an authentication token for the current user.

Parameters:

conn - The HBase cluster connection

Returns:

the authentication token instance

Throws:

IOException

InterruptedException

getClusterId

private static org.apache.hadoop.io.Text getClusterId(org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> token)
                                               throws IOException

Throws:

IOException

obtainAndCacheToken

public static void obtainAndCacheToken(Connection conn,
                                       User user)
                                throws IOException,
                                       InterruptedException

Obtain an authentication token for the given user and add it to the user's credentials.

Parameters:

conn - The HBase cluster connection

user - The user for whom to obtain the token

Throws:

IOException - If making a remote call to the authentication service fails

InterruptedException - If executing as the given user is interrupted

obtainTokenForJob

public static void obtainTokenForJob(Connection conn,
                                     User user,
                                     org.apache.hadoop.mapreduce.Job job)
                              throws IOException,
                                     InterruptedException

Obtain an authentication token on behalf of the given user and add it to the credentials for the given map reduce job.

Parameters:

conn - The HBase cluster connection

user - The user for whom to obtain the token

job - The job instance in which the token should be stored

Throws:

IOException - If making a remote call to the authentication service fails

InterruptedException - If executing as the given user is interrupted

obtainTokenForJob

public static void obtainTokenForJob(Connection conn,
                                     org.apache.hadoop.mapred.JobConf job,
                                     User user)
                              throws IOException,
                                     InterruptedException

Obtain an authentication token on behalf of the given user and add it to the credentials for the given map reduce job.

Parameters:

conn - The HBase cluster connection

user - The user for whom to obtain the token

job - The job configuration in which the token should be stored

Throws:

IOException - If making a remote call to the authentication service fails

InterruptedException - If executing as the given user is interrupted

addTokenForJob

public static void addTokenForJob(Connection conn,
                                  org.apache.hadoop.mapred.JobConf job,
                                  User user)
                           throws IOException,
                                  InterruptedException

Checks for an authentication token for the given user, obtaining a new token if necessary, and adds it to the credentials for the given map reduce job.

Parameters:

conn - The HBase cluster connection

user - The user for whom to obtain the token

job - The job configuration in which the token should be stored

Throws:

IOException - If making a remote call to the authentication service fails

InterruptedException - If executing as the given user is interrupted

addTokenForJob

public static void addTokenForJob(Connection conn,
                                  User user,
                                  org.apache.hadoop.mapreduce.Job job)
                           throws IOException,
                                  InterruptedException

Checks for an authentication token for the given user, obtaining a new token if necessary, and adds it to the credentials for the given map reduce job.

Parameters:

conn - The HBase cluster connection

user - The user for whom to obtain the token

job - The job instance in which the token should be stored

Throws:

IOException - If making a remote call to the authentication service fails

InterruptedException - If executing as the given user is interrupted

addTokenIfMissing

public static boolean addTokenIfMissing(Connection conn,
                                        User user)
                                 throws IOException,
                                        InterruptedException

Checks if an authentication tokens exists for the connected cluster, obtaining one if needed and adding it to the user's credentials.

Parameters:

conn - The HBase cluster connection

user - The user for whom to obtain the token

Returns:

true if the token was added, false if it already existed

Throws:

IOException - If making a remote call to the authentication service fails

InterruptedException - If executing as the given user is interrupted

getAuthToken

private static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> getAuthToken(org.apache.hadoop.conf.Configuration conf,
                                                                                                  User user)
                                                                                           throws IOException,
                                                                                                  InterruptedException

Get the authentication token of the user for the cluster specified in the configuration

Returns:

null if the user does not have the token, otherwise the auth token for the cluster.

Throws:

IOException

InterruptedException

toToken

public static org.apache.hadoop.security.token.Token<AuthenticationTokenIdentifier> toToken(org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.Token proto)

Converts a protobuf Token message back into a Token instance.

Parameters:

proto - the protobuf Token message

Returns:

the Token instance