co.cask.cdap.security.auth

Class FileBasedKeyManager

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

co.cask.cdap.security.auth.AbstractKeyManager

co.cask.cdap.security.auth.MapBackedKeyManager

co.cask.cdap.security.auth.FileBasedKeyManager

All Implemented Interfaces:

KeyManager, com.google.common.util.concurrent.Service

public class FileBasedKeyManager
extends MapBackedKeyManager

Maintains secret keys used to sign and validate authentication tokens. Writes and loads a serialized secret key from file.

Nested Class Summary

Nested classes/interfaces inherited from interface co.cask.cdap.security.auth.KeyManager

KeyManager.DigestId

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields inherited from class co.cask.cdap.security.auth.MapBackedKeyManager

allKeys

Fields inherited from class co.cask.cdap.security.auth.AbstractKeyManager

currentKey, keyAlgo, keyExpirationPeriod, keyGenerator, keyLength, threadLocalMac

Constructor Summary

Constructors

Constructor and Description
FileBasedKeyManager(CConfiguration conf, Codec<KeyIdentifier> keyIdentifierCodec) Create a new FileBasedKeyManager instance that persists keys in a local file.

Method Summary

Methods

Modifier and Type	Method and Description
void	doInit() Extended classes must override this method to initialize/read the key(s) used for signing tokens.
void	shutDown()

Methods inherited from class co.cask.cdap.security.auth.MapBackedKeyManager

addKey, getKey, hasKey

Methods inherited from class co.cask.cdap.security.auth.AbstractKeyManager

generateKey, generateMAC, generateMAC, generateMAC, startUp, validateMAC

Methods inherited from class com.google.common.util.concurrent.AbstractIdleService

addListener, executor, isRunning, start, startAndWait, state, stop, stopAndWait, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, isRunning, start, startAndWait, state, stop, stopAndWait

Constructor Detail

FileBasedKeyManager

public FileBasedKeyManager(CConfiguration conf,
                   Codec<KeyIdentifier> keyIdentifierCodec)

Create a new FileBasedKeyManager instance that persists keys in a local file.

Parameters:

conf -

Method Detail

doInit

public void doInit()
            throws IOException

Description copied from class: AbstractKeyManager

Extended classes must override this method to initialize/read the key(s) used for signing tokens.

Specified by:

doInit in class AbstractKeyManager

Throws:

IOException

shutDown

public void shutDown()

Specified by:

shutDown in class com.google.common.util.concurrent.AbstractIdleService