org.apache.hadoop.hbase.security

Class User

java.lang.Object

org.apache.hadoop.hbase.security.User

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract class User
extends java.lang.Object

Wrapper to abstract out usage of user and group information in HBase.

This class provides a common interface for interacting with user and group information across changing APIs in different versions of Hadoop. It only provides access to the common set of functionality in org.apache.hadoop.security.UserGroupInformation currently needed by HBase, but can be extended as needs change.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HBASE_SECURITY_AUTHORIZATION_CONF_KEY
static java.lang.String	HBASE_SECURITY_CONF_KEY
protected UserGroupInformation	ugi

Constructor Summary

Constructors

Constructor and Description
User()

Method Summary

Modifier and Type	Method and Description
void	addToken(<any> token) Adds the given Token to the user's credentials.
static User	create(UserGroupInformation ugi) Wraps an underlying UserGroupInformation instance.
static User	createUserForTesting(Configuration conf, java.lang.String name, java.lang.String[] groups) Generates a new User instance specifically for use in test code.
boolean	equals(java.lang.Object o)
static User	getCurrent() Returns the User instance within current execution context.
java.lang.String[]	getGroupNames() Returns the list of groups of which this user is a member.
java.lang.String	getName() Returns the full user name.
abstract java.lang.String	getShortName() Returns the shortened version of the user name -- the portion that maps to an operating system user name.
<any>	getToken(java.lang.String kind, java.lang.String service) Returns the Token of the specified kind associated with this user, or null if the Token is not present.
java.util.Collection<<any>>	getTokens() Returns all the tokens stored in the user's credentials.
UserGroupInformation	getUGI()
int	hashCode()
static boolean	isHBaseSecurityEnabled(Configuration conf) Returns whether or not secure authentication is enabled for HBase.
static boolean	isSecurityEnabled() Returns whether or not Kerberos authentication is configured for Hadoop.
static void	login(Configuration conf, java.lang.String fileConfKey, java.lang.String principalConfKey, java.lang.String localhost) Log in the current process using the given configuration keys for the credential file and login principal.
abstract void	obtainAuthTokenForJob(Configuration conf, Job job) Deprecated. Use TokenUtil.obtainAuthTokenForJob(Connection,User,Job) instead.
abstract void	obtainAuthTokenForJob(JobConf job) Deprecated. Use TokenUtil.obtainAuthTokenForJob(Connection,JobConf,User) instead.
abstract <T> T	runAs(java.security.PrivilegedAction<T> action) Executes the given action within the context of this user.
abstract <T> T	runAs(java.security.PrivilegedExceptionAction<T> action) Executes the given action within the context of this user.
static <T> T	runAsLoginUser(java.security.PrivilegedExceptionAction<T> action) Executes the given action as the login user
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HBASE_SECURITY_CONF_KEY

public static final java.lang.String HBASE_SECURITY_CONF_KEY

See Also:

Constant Field Values

HBASE_SECURITY_AUTHORIZATION_CONF_KEY

public static final java.lang.String HBASE_SECURITY_AUTHORIZATION_CONF_KEY

See Also:

Constant Field Values

ugi

protected UserGroupInformation ugi

Constructor Detail

User

public User()

Method Detail

getUGI

public UserGroupInformation getUGI()

getName

public java.lang.String getName()

Returns the full user name. For Kerberos principals this will include the host and realm portions of the principal name.

Returns:

User full name.

getGroupNames

public java.lang.String[] getGroupNames()

Returns the list of groups of which this user is a member. On secure Hadoop this returns the group information for the user as resolved on the server. For 0.20 based Hadoop, the group names are passed from the client.

getShortName

public abstract java.lang.String getShortName()

Returns the shortened version of the user name -- the portion that maps to an operating system user name.

Returns:

Short name

runAs

public abstract <T> T runAs(java.security.PrivilegedAction<T> action)

Executes the given action within the context of this user.

runAs

public abstract <T> T runAs(java.security.PrivilegedExceptionAction<T> action)
                     throws java.io.IOException,
                            java.lang.InterruptedException

Executes the given action within the context of this user.

Throws:

java.io.IOException

java.lang.InterruptedException

obtainAuthTokenForJob

@Deprecated
public abstract void obtainAuthTokenForJob(Configuration conf,
                                                       Job job)
                                                throws java.io.IOException,
                                                       java.lang.InterruptedException

Deprecated. Use TokenUtil.obtainAuthTokenForJob(Connection,User,Job) instead.

Requests an authentication token for this user and stores it in the user's credentials.

Throws:

java.io.IOException

java.lang.InterruptedException

obtainAuthTokenForJob

@Deprecated
public abstract void obtainAuthTokenForJob(JobConf job)
                                                throws java.io.IOException,
                                                       java.lang.InterruptedException

Deprecated. Use TokenUtil.obtainAuthTokenForJob(Connection,JobConf,User) instead.

Requests an authentication token for this user and stores it in the user's credentials.

Throws:

java.io.IOException

java.lang.InterruptedException

getToken

public <any> getToken(java.lang.String kind,
                      java.lang.String service)
               throws java.io.IOException

Returns the Token of the specified kind associated with this user, or null if the Token is not present.

Parameters:

kind - the kind of token

service - service on which the token is supposed to be used

Returns:

the token of the specified kind.

Throws:

java.io.IOException

getTokens

public java.util.Collection<<any>> getTokens()

Returns all the tokens stored in the user's credentials.

addToken

public void addToken(<any> token)

Adds the given Token to the user's credentials.

Parameters:

token - the token to add

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCurrent

public static User getCurrent()
                       throws java.io.IOException

Returns the User instance within current execution context.

Throws:

java.io.IOException

runAsLoginUser

public static <T> T runAsLoginUser(java.security.PrivilegedExceptionAction<T> action)
                            throws java.io.IOException

Executes the given action as the login user

Parameters:

action -

Returns:

the result of the action

Throws:

java.io.IOException

java.lang.InterruptedException

create

public static User create(UserGroupInformation ugi)

Wraps an underlying UserGroupInformation instance.

Parameters:

ugi - The base Hadoop user

Returns:

User

createUserForTesting

public static User createUserForTesting(Configuration conf,
                                        java.lang.String name,
                                        java.lang.String[] groups)

Generates a new User instance specifically for use in test code.

Parameters:

name - the full username

groups - the group names to which the test user will belong

Returns:

a new User instance

login

public static void login(Configuration conf,
                         java.lang.String fileConfKey,
                         java.lang.String principalConfKey,
                         java.lang.String localhost)
                  throws java.io.IOException

Log in the current process using the given configuration keys for the credential file and login principal.

This is only applicable when running on secure Hadoop -- see org.apache.hadoop.security.SecurityUtil#login(Configuration,String,String,String). On regular Hadoop (without security features), this will safely be ignored.

Parameters:

conf - The configuration data to use

fileConfKey - Property key used to configure path to the credential file

principalConfKey - Property key used to configure login principal

localhost - Current hostname to use in any credentials

Throws:

java.io.IOException - underlying exception from SecurityUtil.login() call

isSecurityEnabled

public static boolean isSecurityEnabled()

Returns whether or not Kerberos authentication is configured for Hadoop. For non-secure Hadoop, this always returns false. For secure Hadoop, it will return the value from UserGroupInformation.isSecurityEnabled().

isHBaseSecurityEnabled

public static boolean isHBaseSecurityEnabled(Configuration conf)

Returns whether or not secure authentication is enabled for HBase. Note that HBase security requires HDFS security to provide any guarantees, so it is recommended that secure HBase should run on secure HDFS.