Package org.apache.hadoop.mapreduce.security

Class TokenCache

java.lang.Object

org.apache.hadoop.mapreduce.security.TokenCache

@Public
@Evolving
public class TokenCache
extends Object

This class provides user facing APIs for transferring secrets from the job client to the tasks. The secrets can be stored just before submission of jobs and read during the task execution.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_TOKEN_HDFS_FILE	file name used on HDFS for generated job token
static final String	JOB_TOKENS_FILENAME	conf setting for job tokens cache file name

Constructor Summary

Constructors

Constructor	Description
TokenCache()

Method Summary

Modifier and Type	Method	Description
static void	cleanUpTokenReferral(Configuration conf)	Remove jobtoken referrals which don't make sense in the context of the task execution.
static Token<?>	getDelegationToken(Credentials credentials, String namenode)	Deprecated. Use Credentials.getToken(org.apache.hadoop.io.Text) instead, this method is included for compatibility against Hadoop-1
static byte[]	getEncryptedSpillKey(Credentials credentials)
static Token<org.apache.hadoop.mapreduce.security.token.JobTokenIdentifier>	getJobToken(Credentials credentials)
static byte[]	getSecretKey(Credentials credentials, Text alias)	auxiliary method to get user's secret keys..
static byte[]	getShuffleSecretKey(Credentials credentials)
static Credentials	loadTokens(String jobTokenFile, Configuration conf)	Deprecated. Use Credentials.readTokenStorageFile(org.apache.hadoop.fs.Path, org.apache.hadoop.conf.Configuration) instead, this method is included for compatibility against Hadoop-1.
static Credentials	loadTokens(String jobTokenFile, JobConf conf)	Deprecated. Use Credentials.readTokenStorageFile(org.apache.hadoop.fs.Path, org.apache.hadoop.conf.Configuration) instead, this method is included for compatibility against Hadoop-1.
static void	obtainTokensForNamenodes(Credentials credentials, Path[] ps, Configuration conf)	Convenience method to obtain delegation tokens from namenodes corresponding to the paths passed.
static void	setEncryptedSpillKey(byte[] key, Credentials credentials)
static void	setJobToken(Token<? extends TokenIdentifier> t, Credentials credentials)	store job token
static void	setShuffleSecretKey(byte[] key, Credentials credentials)

Methods inherited from class java.lang.Object

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

Field Details

JOB_TOKEN_HDFS_FILE

@Private
public static final String JOB_TOKEN_HDFS_FILE

file name used on HDFS for generated job token

See Also:

• Constant Field Values

JOB_TOKENS_FILENAME

@Private
public static final String JOB_TOKENS_FILENAME

conf setting for job tokens cache file name

See Also:

• Constant Field Values

Constructor Details

TokenCache

public TokenCache()

Method Details

getSecretKey

public static byte[] getSecretKey(Credentials credentials,
 Text alias)

auxiliary method to get user's secret keys..

Parameters:

alias -

Returns:

secret key from the storage

obtainTokensForNamenodes

public static void obtainTokensForNamenodes(Credentials credentials,
 Path[] ps,
 Configuration conf)
                                     throws IOException

Convenience method to obtain delegation tokens from namenodes corresponding to the paths passed.

Parameters:

credentials -

ps - array of paths

conf - configuration

Throws:

IOException

cleanUpTokenReferral

public static void cleanUpTokenReferral(Configuration conf)

Remove jobtoken referrals which don't make sense in the context of the task execution.

Parameters:

conf -

loadTokens

@Private
@Deprecated
public static Credentials loadTokens(String jobTokenFile,
 JobConf conf)
                              throws IOException

Deprecated.

Use Credentials.readTokenStorageFile(org.apache.hadoop.fs.Path, org.apache.hadoop.conf.Configuration) instead, this method is included for compatibility against Hadoop-1.

load job token from a file

Parameters:

conf -

Throws:

IOException

loadTokens

@Private
@Deprecated
public static Credentials loadTokens(String jobTokenFile,
 Configuration conf)
                              throws IOException

Deprecated.

Use Credentials.readTokenStorageFile(org.apache.hadoop.fs.Path, org.apache.hadoop.conf.Configuration) instead, this method is included for compatibility against Hadoop-1.

load job token from a file

Parameters:

conf -

Throws:

IOException

setJobToken

@Private
public static void setJobToken(Token<? extends TokenIdentifier> t,
 Credentials credentials)

store job token

Parameters:

t -

getJobToken

@Private
public static Token<org.apache.hadoop.mapreduce.security.token.JobTokenIdentifier> getJobToken(Credentials credentials)

Returns:

job token

setShuffleSecretKey

@Private
public static void setShuffleSecretKey(byte[] key,
 Credentials credentials)

getShuffleSecretKey

@Private
public static byte[] getShuffleSecretKey(Credentials credentials)

setEncryptedSpillKey

@Private
public static void setEncryptedSpillKey(byte[] key,
 Credentials credentials)

getEncryptedSpillKey

@Private
public static byte[] getEncryptedSpillKey(Credentials credentials)

getDelegationToken

@Private
@Deprecated
public static Token<?> getDelegationToken(Credentials credentials,
 String namenode)

Deprecated.

Use Credentials.getToken(org.apache.hadoop.io.Text) instead, this method is included for compatibility against Hadoop-1

Parameters:

namenode -

Returns:

delegation token