org.apache.ambari.server.security.encryption

Class AbstractCredentialStore

java.lang.Object

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

All Implemented Interfaces:

CredentialStore

Direct Known Subclasses:

FileBasedCredentialStore, InMemoryCredentialStore

public abstract class AbstractCredentialStore
extends Object
implements CredentialStore

AbstractCredentialStore is an abstract implementation of CredentialStore that loads and stores @{link KeyStore} data. Implementations of this class, provide the input and output streams used to read and write the data.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_STORE_TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractCredentialStore()

Method Summary

Modifier and Type	Method and Description
protected void	addCredential(KeyStore keyStore, String alias, Credential credential) Adds a new credential to the supplied KeyStore The supplied key will be converted into UTF-8 bytes before being stored.
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.
protected Credential	getCredential(KeyStore keyStore, String alias) Retrieves the specified credential from a KeyStore
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.
protected Lock	getLock() Gets the lock object used to protect access to 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 abstract KeyStore	loadCredentialStore() Calls the implementation-specific facility to load the KeyStore
protected KeyStore	loadKeyStore(InputStream inputStream, String keyStoreType) Loads a KeyStore from an InputStream Implementations are expected to call this to load the relevant KeyStore data from the InputStream of some storage facility.
protected abstract 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.
void	setMasterKeyService(MasterKeyService masterKeyService) Sets the MasterKeyService for this CredentialStore
protected byte[]	toBytes(char[] chars) Converts an array of characters to an array of bytes by encoding each character into UTF-8 bytes.
protected char[]	toChars(byte[] bytes) Converts an array of bytes to an array of character by decoding the bytes using the UTF-8 character set.
protected void	writeKeyStore(KeyStore keyStore, OutputStream outputStream) Writes a KeyStore to an OutputStream Implementations are expected to call this to write the relevant KeyStore data to the OutputStream of some storage facility.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STORE_TYPE

protected static final String DEFAULT_STORE_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractCredentialStore

public AbstractCredentialStore()

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

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

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

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

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

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

setMasterKeyService

public void setMasterKeyService(MasterKeyService masterKeyService)

Description copied from interface: CredentialStore

Sets the MasterKeyService for this CredentialStore

Specified by:

setMasterKeyService in interface CredentialStore

Parameters:

masterKeyService - the MasterKeyService

addCredential

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

Adds a new credential to the supplied KeyStore

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

Parameters:

keyStore - the KeyStore

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

protected Credential getCredential(KeyStore keyStore,
                                   String alias)
                            throws org.apache.ambari.server.AmbariException

Retrieves the specified credential from a KeyStore

Parameters:

keyStore - the KeyStore

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

Returns:

an array of chars containing the credential

Throws:

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

persistCredentialStore

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

Calls the implementation-specific facility to persist the KeyStore

Parameters:

keyStore - the KeyStore to persist

Throws:

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

loadCredentialStore

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

Calls the implementation-specific facility to load the KeyStore

Throws:

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

getLock

protected Lock getLock()

Gets the lock object used to protect access to the credential store

Returns:

a Lock object

loadKeyStore

protected KeyStore loadKeyStore(InputStream inputStream,
                                String keyStoreType)
                         throws org.apache.ambari.server.AmbariException

Loads a KeyStore from an InputStream

Implementations are expected to call this to load the relevant KeyStore data from the InputStream of some storage facility.

Parameters:

inputStream - the InputStream to read the data from

keyStoreType - the type of key store data expected

Returns:

a new KeyStore instance with the loaded data

Throws:

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

writeKeyStore

protected void writeKeyStore(KeyStore keyStore,
                             OutputStream outputStream)
                      throws org.apache.ambari.server.AmbariException

Writes a KeyStore to an OutputStream

Implementations are expected to call this to write the relevant KeyStore data to the OutputStream of some storage facility.

Parameters:

keyStore - the KeyStore to write

outputStream - the OutputStream to write the data into

Throws:

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

toBytes

protected byte[] toBytes(char[] chars)

Converts an array of characters to an array of bytes by encoding each character into UTF-8 bytes.

An attempt is made to clear out sensitive data by filling any buffers with 0's

Parameters:

chars - the array of chars to convert

Returns:

an array of bytes, or null if the original array was null

toChars

protected char[] toChars(byte[] bytes)

Converts an array of bytes to an array of character by decoding the bytes using the UTF-8 character set.

An attempt is made to clear out sensitive data by filling any buffers with 0's

Parameters:

bytes - the array of bytes to convert

Returns:

an array of chars, or null if the original array was null