org.apache.hadoop.yarn.server.resourcemanager.security

Class AMRMTokenSecretManager

java.lang.Object

org.apache.hadoop.security.token.SecretManager<AMRMTokenIdentifier>

org.apache.hadoop.yarn.server.resourcemanager.security.AMRMTokenSecretManager

public class AMRMTokenSecretManager
extends SecretManager<AMRMTokenIdentifier>

AMRM-tokens are per ApplicationAttempt. If users redistribute their tokens, it is their headache, god save them. I mean you are not supposed to distribute keys to your vault, right? Anyways, ResourceManager saves each token locally in memory till application finishes and to a store for restart, so no need to remember master-keys even after rolling them.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.security.token.SecretManager

SecretManager.InvalidToken

Constructor Summary

Constructors

Constructor and Description
AMRMTokenSecretManager(Configuration conf) Create an AMRMTokenSecretManager

Method Summary

Methods

Modifier and Type	Method and Description
void	addPersistedPassword(Token<AMRMTokenIdentifier> token) Populate persisted password of AMRMToken back to AMRMTokenSecretManager.
void	applicationMasterFinished(ApplicationAttemptId appAttemptId)
AMRMTokenIdentifier	createIdentifier() Creates an empty TokenId to be used for de-serializing an AMRMTokenIdentifier by the RPC layer.
byte[]	createPassword(AMRMTokenIdentifier identifier) Create a password for a given AMRMTokenIdentifier.
SecretKey	getMasterKey()
byte[]	retrievePassword(AMRMTokenIdentifier identifier) Retrieve the password for the given AMRMTokenIdentifier.
void	setMasterKey(SecretKey masterKey)
void	start()
void	stop()

Methods inherited from class org.apache.hadoop.security.token.SecretManager

checkAvailableForRead, createPassword, createSecretKey, generateSecret

Methods inherited from class java.lang.Object

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

Constructor Detail

AMRMTokenSecretManager

public AMRMTokenSecretManager(Configuration conf)

Create an AMRMTokenSecretManager

Method Detail

start

public void start()

stop

public void stop()

applicationMasterFinished

public void applicationMasterFinished(ApplicationAttemptId appAttemptId)

setMasterKey

@InterfaceAudience.Private
public void setMasterKey(SecretKey masterKey)

getMasterKey

@InterfaceAudience.Private
public SecretKey getMasterKey()

createPassword

public byte[] createPassword(AMRMTokenIdentifier identifier)

Create a password for a given AMRMTokenIdentifier. Used to send to the AppicationAttempt which can give it back during authentication.

Specified by:

createPassword in class SecretManager<AMRMTokenIdentifier>

Parameters:

identifier - the identifier to use

Returns:

the new password

addPersistedPassword

public void addPersistedPassword(Token<AMRMTokenIdentifier> token)
                          throws IOException

Populate persisted password of AMRMToken back to AMRMTokenSecretManager.

Throws:

IOException

retrievePassword

public byte[] retrievePassword(AMRMTokenIdentifier identifier)
                        throws SecretManager.InvalidToken

Retrieve the password for the given AMRMTokenIdentifier. Used by RPC layer to validate a remote AMRMTokenIdentifier.

Specified by:

retrievePassword in class SecretManager<AMRMTokenIdentifier>

Parameters:

identifier - the identifier to validate

Returns:

the password to use

Throws:

SecretManager.InvalidToken - the token was invalid

createIdentifier

public AMRMTokenIdentifier createIdentifier()

Creates an empty TokenId to be used for de-serializing an AMRMTokenIdentifier by the RPC layer.

Specified by:

createIdentifier in class SecretManager<AMRMTokenIdentifier>

Returns:

the newly created empty token identifier