org.apache.ambari.server.security.encryption

Class InMemoryCredentialStore

java.lang.Object

org.apache.ambari.server.security.encryption.AbstractCredentialStore

org.apache.ambari.server.security.encryption.InMemoryCredentialStore

All Implemented Interfaces:

CredentialStore

public class InMemoryCredentialStore
extends AbstractCredentialStore

InMemoryCredentialStore is a CredentialStore implementation that creates and manages a JCEKS (Java Cryptography Extension KeyStore) in memory. The key store and its contents are encrypted using the key from the supplied MasterKeyService.

This class handles the details of the in-memory storage buffer and associated input and output streams. Each credential is stored in its own KeyStore that may be be purged upon some retention timeout - if specified.

Field Summary

Fields inherited from class org.apache.ambari.server.security.encryption.AbstractCredentialStore

DEFAULT_STORE_TYPE

Constructor Summary

Constructors

Constructor and Description
InMemoryCredentialStore() Constructs a new InMemoryCredentialStore where credentials have no retention timeout
InMemoryCredentialStore(long retentionDuration, TimeUnit units, boolean activelyPurge) Constructs a new InMemoryCredentialStore with a specified credential timeout

Method Summary

Modifier and Type	Method and Description
void	addCredential(String alias, Credential credential) Adds a new credential to this CredentialStore The supplied key will be converted into UTF-8 bytes before being stored.
boolean	containsCredential(String alias) Tests this CredentialStore for the existence of a credential with the specified alias This implementation is thread-safe, allowing one thread at a time to access the credential store.
Credential	getCredential(String alias) Retrieves the specified credential from this CredentialStore This implementation is thread-safe, allowing one thread at a time to access the credential store.
Set<String>	listCredentials() Returns a list of the alias names for the credentials stored in the CredentialStore This implementation is thread-safe, allowing one thread at a time to access the credential store.
protected KeyStore	loadCredentialStore() Calls the implementation-specific facility to load the KeyStore
protected void	persistCredentialStore(KeyStore keyStore) Calls the implementation-specific facility to persist the KeyStore
void	removeCredential(String alias) Removes the specified credential from this CredentialStore This implementation is thread-safe, allowing one thread at a time to access the credential store.

Methods inherited from class org.apache.ambari.server.security.encryption.AbstractCredentialStore

addCredential, getCredential, getLock, loadKeyStore, setMasterKeyService, toBytes, toChars, writeKeyStore

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryCredentialStore

public InMemoryCredentialStore()

Constructs a new InMemoryCredentialStore where credentials have no retention timeout

InMemoryCredentialStore

public InMemoryCredentialStore(long retentionDuration,
                               TimeUnit units,
                               boolean activelyPurge)

Constructs a new InMemoryCredentialStore with a specified credential timeout

Parameters:

retentionDuration - the time in some units to keep stored credentials, from the time they are added

units - the units for the retention duration (minutes, seconds, etc...)

activelyPurge - true to actively purge credentials after the retention time has expired; otherwise false, to passively purge credentials after the retention time has expired

Method Detail

addCredential

public void addCredential(String alias,
                          Credential credential)
                   throws org.apache.ambari.server.AmbariException

Adds a new credential to this CredentialStore

The supplied key will be converted into UTF-8 bytes before being stored.

This implementation is thread-safe, allowing one thread at a time to access the credential store.

Specified by:

addCredential in interface CredentialStore

Overrides:

addCredential in class AbstractCredentialStore

Parameters:

alias - a string declaring the alias (or name) of the credential

credential - the credential to store

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while storing the new credential

getCredential

public Credential getCredential(String alias)
                         throws org.apache.ambari.server.AmbariException

Retrieves the specified credential from this CredentialStore

This implementation is thread-safe, allowing one thread at a time to access the credential store.

Specified by:

getCredential in interface CredentialStore

Overrides:

getCredential in class AbstractCredentialStore

Parameters:

alias - a string declaring the alias (or name) of the credential

Returns:

a Credential or null of not found

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while retrieving the new credential

removeCredential

public void removeCredential(String alias)
                      throws org.apache.ambari.server.AmbariException

Removes the specified credential from this CredentialStore

This implementation is thread-safe, allowing one thread at a time to access the credential store.

Specified by:

removeCredential in interface CredentialStore

Overrides:

removeCredential in class AbstractCredentialStore

Parameters:

alias - a string declaring the alias (or name) of the credential

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while removing the new credential

listCredentials

public Set<String> listCredentials()
                            throws org.apache.ambari.server.AmbariException

Returns a list of the alias names for the credentials stored in the CredentialStore

This implementation is thread-safe, allowing one thread at a time to access the credential store.

Specified by:

listCredentials in interface CredentialStore

Overrides:

listCredentials in class AbstractCredentialStore

Returns:

a Set of Strings representing alias names for the credentials stored in the CredentialStore

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while searching forthe credential

containsCredential

public boolean containsCredential(String alias)
                           throws org.apache.ambari.server.AmbariException

Tests this CredentialStore for the existence of a credential with the specified alias

This implementation is thread-safe, allowing one thread at a time to access the credential store.

Specified by:

containsCredential in interface CredentialStore

Overrides:

containsCredential in class AbstractCredentialStore

Parameters:

alias - a string declaring the alias (or name) of the credential

Returns:

true if the alias exists; otherwise false

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while searching forthe credential

persistCredentialStore

protected void persistCredentialStore(KeyStore keyStore)
                               throws org.apache.ambari.server.AmbariException

Description copied from class: AbstractCredentialStore

Calls the implementation-specific facility to persist the KeyStore

Specified by:

persistCredentialStore in class AbstractCredentialStore

Parameters:

keyStore - the KeyStore to persist

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while persisting the key store data

loadCredentialStore

protected KeyStore loadCredentialStore()
                                throws org.apache.ambari.server.AmbariException

Description copied from class: AbstractCredentialStore

Calls the implementation-specific facility to load the KeyStore

Specified by:

loadCredentialStore in class AbstractCredentialStore

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while loading the key store data