org.apache.ambari.server.security.encryption

Class CredentialStoreServiceImpl

java.lang.Object

org.apache.ambari.server.security.encryption.CredentialStoreServiceImpl

All Implemented Interfaces:

CredentialStoreService

public class CredentialStoreServiceImpl
extends Object
implements CredentialStoreService

Constructor Summary

Constructors

Constructor and Description
CredentialStoreServiceImpl(Configuration configuration, SecurePasswordHelper securePasswordHelper)

Method Summary

Modifier and Type	Method and Description
static String	canonicalizeAlias(String clusterName, String alias) Canonicalizes an alias name by making sure that is contains the prefix indicating what cluster it belongs to.
boolean	containsCredential(String clusterName, String alias) Tests to see if the requested alias exists in any CredentialStore
boolean	containsCredential(String clusterName, String alias, CredentialStoreType credentialStoreType) Tests to see if the requested alias exists in ether the persistent or the temporary CredentialStore
static String	decanonicalizeAlias(String clusterName, String canonicaizedAlias) Removes the prefix (if exists) from the front of a canonicalized alias
Credential	getCredential(String clusterName, String alias) Retrieves the specified credential looking in the temporary and then the persistent CredentialStore
Credential	getCredential(String clusterName, String alias, CredentialStoreType credentialStoreType) Retrieves the specified credential looking in ether the persistent or the temporary CredentialStore
CredentialStoreType	getCredentialStoreType(String clusterName, String alias) Gets the type of the credential store used to store the requested credential
void	initializePersistedCredentialStore(File credentialStoreLocation, MasterKeyService masterKeyService)
void	initializeTemporaryCredentialStore(long retentionDuration, TimeUnit units, boolean activelyPurge)
boolean	isInitialized() Tests this CredentialStoreService to check if it has been properly initialized
boolean	isInitialized(CredentialStoreType credentialStoreType) Tests this CredentialStoreService to check if ether the persistent or the temporary CredentialStore has been properly initialized
Map<String,CredentialStoreType>	listCredentials(String clusterName) Maps the existing alias names to their relevant credential store types.
void	removeCredential(String clusterName, String alias) Removes the specified credential from all CredentialStores
void	removeCredential(String clusterName, String alias, CredentialStoreType credentialStoreType) Removes the specified credential from ether the persistent or the temporary CredentialStore
void	setCredential(String clusterName, String alias, Credential credential, CredentialStoreType credentialStoreType) Adds a new credential to either the persistent or the temporary CredentialStore The supplied key will be converted into UTF-8 bytes before being stored.

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialStoreServiceImpl

@Inject
public CredentialStoreServiceImpl(Configuration configuration,
                                          SecurePasswordHelper securePasswordHelper)

Method Detail

initializeTemporaryCredentialStore

public void initializeTemporaryCredentialStore(long retentionDuration,
                                               TimeUnit units,
                                               boolean activelyPurge)
                                        throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

initializePersistedCredentialStore

public void initializePersistedCredentialStore(File credentialStoreLocation,
                                               MasterKeyService masterKeyService)
                                        throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

setCredential

public void setCredential(String clusterName,
                          String alias,
                          Credential credential,
                          CredentialStoreType credentialStoreType)
                   throws org.apache.ambari.server.AmbariException

Adds a new credential to either the persistent or the temporary CredentialStore

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

The alias name will be canonicalized as follows:

• if a cluster name is supplied, then "cluster.name." will be prepended to it
• the characters will converted to all lowercase

Only a single instance of the named credential will be stored, therefore if a credential with alias ALIAS1 is stored in the persisted CredentialStore and a call is made to store a credentials with alias ALIAS1 into the temporary CredentialStore, the instance in the persisted CredentialStore will be removed.

Specified by:

setCredential in interface CredentialStoreService

Parameters:

clusterName - the name of the cluster this credential is related to

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

credential - the credential value to store

credentialStoreType - a CredentialStoreType indicating which credential store facility to use

Throws:

org.apache.ambari.server.AmbariException

getCredential

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

Description copied from interface: CredentialStoreService

Retrieves the specified credential looking in the temporary and then the persistent CredentialStore

Specified by:

getCredential in interface CredentialStoreService

Parameters:

clusterName - the name of the cluster the credential is related to

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

Returns:

the requested Credential

Throws:

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

getCredential

public Credential getCredential(String clusterName,
                                String alias,
                                CredentialStoreType credentialStoreType)
                         throws org.apache.ambari.server.AmbariException

Description copied from interface: CredentialStoreService

Retrieves the specified credential looking in ether the persistent or the temporary CredentialStore

Specified by:

getCredential in interface CredentialStoreService

Parameters:

clusterName - the name of the cluster this credential is related to

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

credentialStoreType - a CredentialStoreType indicating which credential store facility to use

Returns:

the requested Credential

Throws:

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

removeCredential

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

Description copied from interface: CredentialStoreService

Removes the specified credential from all CredentialStores

Specified by:

removeCredential in interface CredentialStoreService

Parameters:

clusterName - the name of the cluster this credential is related to

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

Throws:

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

removeCredential

public void removeCredential(String clusterName,
                             String alias,
                             CredentialStoreType credentialStoreType)
                      throws org.apache.ambari.server.AmbariException

Description copied from interface: CredentialStoreService

Removes the specified credential from ether the persistent or the temporary CredentialStore

Specified by:

removeCredential in interface CredentialStoreService

Parameters:

clusterName - the name of the cluster this credential is related to

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

credentialStoreType - a CredentialStoreType indicating which credential store facility to use

Throws:

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

containsCredential

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

Description copied from interface: CredentialStoreService

Tests to see if the requested alias exists in any CredentialStore

Specified by:

containsCredential in interface CredentialStoreService

Parameters:

clusterName - the name of the cluster this credential is related to

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

Returns:

true if it exists; otherwise false

Throws:

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

containsCredential

public boolean containsCredential(String clusterName,
                                  String alias,
                                  CredentialStoreType credentialStoreType)
                           throws org.apache.ambari.server.AmbariException

Description copied from interface: CredentialStoreService

Tests to see if the requested alias exists in ether the persistent or the temporary CredentialStore

Specified by:

containsCredential in interface CredentialStoreService

Parameters:

clusterName - the name of the cluster this credential is related to

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

credentialStoreType - a CredentialStoreType indicating which credential store facility to use

Returns:

true if it exists; otherwise false

Throws:

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

getCredentialStoreType

public CredentialStoreType getCredentialStoreType(String clusterName,
                                                  String alias)
                                           throws org.apache.ambari.server.AmbariException

Description copied from interface: CredentialStoreService

Gets the type of the credential store used to store the requested credential

Specified by:

getCredentialStoreType in interface CredentialStoreService

Parameters:

clusterName - the name of the cluster this credential is related to

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

Returns:

a CredentialStoreType

Throws:

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

listCredentials

public Map<String,CredentialStoreType> listCredentials(String clusterName)
                                                throws org.apache.ambari.server.AmbariException

Description copied from interface: CredentialStoreService

Maps the existing alias names to their relevant credential store types.

Specified by:

listCredentials in interface CredentialStoreService

Parameters:

clusterName - the name of the cluster this credential is related to

Returns:

a map of alias names to CredentialStoreTypes

Throws:

org.apache.ambari.server.AmbariException - if an error occurs while searching for the credentials

isInitialized

public boolean isInitialized()

Description copied from interface: CredentialStoreService

Tests this CredentialStoreService to check if it has been properly initialized

Specified by:

isInitialized in interface CredentialStoreService

Returns:

true if initialized; otherwise false

isInitialized

public boolean isInitialized(CredentialStoreType credentialStoreType)

Description copied from interface: CredentialStoreService

Tests this CredentialStoreService to check if ether the persistent or the temporary CredentialStore has been properly initialized

Specified by:

isInitialized in interface CredentialStoreService

Parameters:

credentialStoreType - a CredentialStoreType indicating which credential store facility to use

Returns:

true if initialized; otherwise false

canonicalizeAlias

public static String canonicalizeAlias(String clusterName,
                                       String alias)

Canonicalizes an alias name by making sure that is contains the prefix indicating what cluster it belongs to. This helps to reduce collisions of alias between clusters pointing to the same keystore files.

Each alias is expected to have a prefix of cluster.:clusterName., and the combination is to be converted to have all lowercase characters. For example if the alias was "external.DB" and the cluster name is "c1", then the canonicalized alias name would be "cluster.c1.external.db".

Parameters:

clusterName - the name of the cluster

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

Returns:

a ccanonicalized alias name

decanonicalizeAlias

public static String decanonicalizeAlias(String clusterName,
                                         String canonicaizedAlias)

Removes the prefix (if exists) from the front of a canonicalized alias

Parameters:

clusterName - the name the name of the cluster

canonicaizedAlias - the canonicalized alias to process

Returns:

an alias name