Package org.wildfly.security.credential.store.impl

Class VaultCredentialStore

java.lang.Object

org.wildfly.security.credential.store.CredentialStoreSpi

org.wildfly.security.credential.store.impl.VaultCredentialStore

public final class VaultCredentialStore
extends CredentialStoreSpi

Credential store implementation which uses the legacy "vault" format.

Author:

David M. Lloyd

Field Summary

Fields

Modifier and Type	Field	Description
private SecretKey	adminKey
private Map<String,byte[]>	data
private File	location
private static String	LOCATION
private boolean	modifiable
private static List<String>	validAttribtues
static String	VAULT_CREDENTIAL_STORE

Fields inherited from class org.wildfly.security.credential.store.CredentialStoreSpi

initialized

Constructor Summary

Constructors

Constructor	Description
VaultCredentialStore()	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
void	flush()	Flush the credential store contents to storage.
Set<String>	getAliases()	Returns credential aliases stored in this store as Set<String>.
void	initialize(Map<String,String> attributes, CredentialStore.ProtectionParameter protectionParameter, Provider[] providers)	Initialize credential store service with given attributes.
boolean	isModifiable()	Check if credential store service supports modification of its store
void	remove(String credentialAlias, Class<? extends Credential> credentialType, String credentialAlgorithm, AlgorithmParameterSpec parameterSpec)	Remove the credentialType with from given alias from the credential store service.
<C extends Credential> C	retrieve(String credentialAlias, Class<C> credentialType, String credentialAlgorithm, AlgorithmParameterSpec parameterSpec, CredentialStore.ProtectionParameter protectionParameter)	Retrieve the credential stored in the store under the given alias, matching the given criteria.
void	store(String credentialAlias, Credential credential, CredentialStore.ProtectionParameter protectionParameter)	Store credential to the credential store service under the given alias.

Methods inherited from class org.wildfly.security.credential.store.CredentialStoreSpi

exists, getCredentialTypesForAlias, isInitialized, validateAttribute

Methods inherited from class java.lang.Object

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

Field Detail

VAULT_CREDENTIAL_STORE

public static final String VAULT_CREDENTIAL_STORE

See Also:

Constant Field Values

LOCATION

private static final String LOCATION

See Also:

Constant Field Values

validAttribtues

private static final List<String> validAttribtues

data

private final Map<String,byte[]> data

adminKey

private SecretKey adminKey

location

private File location

modifiable

private volatile boolean modifiable

Constructor Detail

VaultCredentialStore

public VaultCredentialStore()

Construct a new instance.

Method Detail

initialize

public void initialize(Map<String,String> attributes,
                       CredentialStore.ProtectionParameter protectionParameter,
                       Provider[] providers)
                throws CredentialStoreException

Description copied from class: CredentialStoreSpi

Initialize credential store service with given attributes. This procedure should set CredentialStoreSpi.initialized after successful initialization.

Specified by:

initialize in class CredentialStoreSpi

Parameters:

attributes - attributes to used to pass information to credential store service

protectionParameter - the store-wide protection parameter to apply, or null for none

providers - providers to be injected into SPI implementation to get custom object instances of various type from, or null for none

Throws:

CredentialStoreException - if initialization fails due to any reason

isModifiable

public boolean isModifiable()

Description copied from class: CredentialStoreSpi

Check if credential store service supports modification of its store

Specified by:

isModifiable in class CredentialStoreSpi

Returns:

true in case of modification of the store is supported, false otherwise

store

public void store(String credentialAlias,
                  Credential credential,
                  CredentialStore.ProtectionParameter protectionParameter)
           throws CredentialStoreException,
                  UnsupportedCredentialTypeException

Description copied from class: CredentialStoreSpi

Store credential to the credential store service under the given alias. If given alias already contains specific credential type type the credential replaces older one. Note: CredentialStoreSpi supports storing of multiple entries (credential types) per alias. Each must be of different credential type, or differing algorithm, or differing parameters.

Specified by:

store in class CredentialStoreSpi

Parameters:

credentialAlias - to store the credential to the store

credential - instance of Credential to store

protectionParameter - the protection parameter to apply to the entry, or null for none

Throws:

CredentialStoreException - when the credential cannot be stored

UnsupportedCredentialTypeException - when the credentialType is not supported

retrieve

public <C extends Credential> C retrieve(String credentialAlias,
                                         Class<C> credentialType,
                                         String credentialAlgorithm,
                                         AlgorithmParameterSpec parameterSpec,
                                         CredentialStore.ProtectionParameter protectionParameter)
                                  throws CredentialStoreException

Description copied from class: CredentialStoreSpi

Retrieve the credential stored in the store under the given alias, matching the given criteria.

Specified by:

retrieve in class CredentialStoreSpi

Type Parameters:

C - the credential type

Parameters:

credentialAlias - to find the credential in the store

credentialType - the credential type class (must not be null)

credentialAlgorithm - the credential algorithm to match, or null to match any algorithm

parameterSpec - the parameter specification to match, or null to match any parameters

protectionParameter - the protection parameter to use to access the entry, or null for none

Returns:

instance of Credential stored in the store, or null if the credential is not found

Throws:

CredentialStoreException - if the credential cannot be retrieved due to an error

remove

public void remove(String credentialAlias,
                   Class<? extends Credential> credentialType,
                   String credentialAlgorithm,
                   AlgorithmParameterSpec parameterSpec)
            throws CredentialStoreException

Description copied from class: CredentialStoreSpi

Remove the credentialType with from given alias from the credential store service.

Specified by:

remove in class CredentialStoreSpi

Parameters:

credentialAlias - alias to remove

credentialType - the credential type class to match (must not be null)

credentialAlgorithm - the credential algorithm to match, or null to match all algorithms

parameterSpec - the credential parameters to match, or null to match all parameters

Throws:

CredentialStoreException - if the credential cannot be removed due to an error

flush

public void flush()
           throws CredentialStoreException

Description copied from class: CredentialStoreSpi

Flush the credential store contents to storage. If the credential store does not support or require explicit flushing, this method should do nothing and simply return.

Overrides:

flush in class CredentialStoreSpi

Throws:

CredentialStoreException - if the flush fails for some reason.

getAliases

public Set<String> getAliases()
                       throws UnsupportedOperationException,
                              CredentialStoreException

Description copied from class: CredentialStoreSpi

Returns credential aliases stored in this store as Set<String>. It is not mandatory to override this method (throws UnsupportedOperationException by default).

Overrides:

getAliases in class CredentialStoreSpi

Returns:

Set<String> of all keys stored in this store

Throws:

UnsupportedOperationException - when this method is not supported by the underlying credential store

CredentialStoreException - if there is any problem with internal store