org.apache.accumulo.core.client.security.tokens

Class KerberosToken

java.lang.Object

org.apache.accumulo.core.client.security.tokens.KerberosToken

All Implemented Interfaces:

Cloneable, Destroyable, AuthenticationToken, org.apache.hadoop.io.Writable

public class KerberosToken
extends Object
implements AuthenticationToken

Authentication token for Kerberos authenticated clients

Since:

1.7.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.accumulo.core.client.security.tokens.AuthenticationToken

AuthenticationToken.AuthenticationTokenSerializer, AuthenticationToken.Properties, AuthenticationToken.TokenProperty

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
KerberosToken() Creates a token using the login user as returned by UserGroupInformation.getCurrentUser()
KerberosToken(String principal) Creates a token using the provided principal and the currently logged-in user via UserGroupInformation.
KerberosToken(String principal, File keytab) Creates a Kerberos token for the specified principal using the provided keytab.
KerberosToken(String principal, File keytab, boolean replaceCurrentUser) Deprecated. since 1.8.0, @see #KerberosToken(String, File)

Method Summary

Modifier and Type	Method and Description
KerberosToken	clone()
void	destroy()
boolean	equals(Object obj)
File	getKeytab() The keytab file used to perform Kerberos login.
String	getPrincipal() The identity of the user to which this token belongs to according to Kerberos
Set<AuthenticationToken.TokenProperty>	getProperties()
int	hashCode()
void	init(AuthenticationToken.Properties properties)
boolean	isDestroyed()
void	readFields(DataInput in)
void	write(DataOutput out)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_NAME

public static final String CLASS_NAME

Constructor Detail

KerberosToken

public KerberosToken(String principal)
              throws IOException

Creates a token using the provided principal and the currently logged-in user via UserGroupInformation. This method expects the current user (as defined by UserGroupInformation.getCurrentUser() to be authenticated via Kerberos or as a Proxy (on top of another user). An IllegalArgumentException will be thrown for all other cases.

Parameters:

principal - The user that is logged in

Throws:

IllegalArgumentException - If the current user is not authentication via Kerberos or Proxy methods.

IOException

See Also:

UserGroupInformation.getCurrentUser(), UserGroupInformation.getAuthenticationMethod()

KerberosToken

public KerberosToken(String principal,
                     File keytab)
              throws IOException

Creates a Kerberos token for the specified principal using the provided keytab. The principal and keytab combination are verified by attempting a log in.

This constructor does not have any side effects.

Parameters:

principal - The Kerberos principal

keytab - A keytab file containing the principal's credentials.

Throws:

IOException

KerberosToken

@Deprecated
public KerberosToken(String principal,
                                 File keytab,
                                 boolean replaceCurrentUser)
                          throws IOException

Deprecated. since 1.8.0, @see #KerberosToken(String, File)

Creates a token and logs in via UserGroupInformation using the provided principal and keytab. A key for the principal must exist in the keytab, otherwise login will fail.

Parameters:

principal - The Kerberos principal

keytab - A keytab file

replaceCurrentUser - Should the current Hadoop user be replaced with this user

Throws:

IOException

KerberosToken

public KerberosToken()
              throws IOException

Creates a token using the login user as returned by UserGroupInformation.getCurrentUser()

Throws:

IOException - If the current logged in user cannot be computed.

Method Detail

clone

public KerberosToken clone()

Specified by:

clone in interface AuthenticationToken

Overrides:

clone in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getPrincipal

public String getPrincipal()

The identity of the user to which this token belongs to according to Kerberos

Returns:

The principal

getKeytab

public File getKeytab()

The keytab file used to perform Kerberos login. Optional, may be null.

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

IOException

destroy

public void destroy()
             throws DestroyFailedException

Specified by:

destroy in interface Destroyable

Throws:

DestroyFailedException

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable

init

public void init(AuthenticationToken.Properties properties)

Specified by:

init in interface AuthenticationToken

getProperties

public Set<AuthenticationToken.TokenProperty> getProperties()

Specified by:

getProperties in interface AuthenticationToken

hashCode

public int hashCode()

Overrides:

hashCode in class Object