Package se.swedenconnect.security.credential.container

Class AbstractPkiCredentialContainer

java.lang.Object

se.swedenconnect.security.credential.container.AbstractPkiCredentialContainer

All Implemented Interfaces:

PkiCredentialContainer

Direct Known Subclasses:

AbstractKeyStorePkiCredentialContainer, InMemoryPkiCredentialContainer

public abstract class AbstractPkiCredentialContainer
extends Object
implements PkiCredentialContainer

Abstract implementation of the PkiCredentialContainer interface.

Author:

Martin Lindström (martin@idsec.se), Stefan Santesson (stefan@idsec.se)

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	DEFAULT_SUPPORTED_KEY_TYPES	The key gen types (see KeyGenType) that are supported by default.

Constructor Summary

Constructors

Constructor	Description
AbstractPkiCredentialContainer(Provider provider)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Traverses through all credentials in the multi credential key store and delets the expired ones.
protected BigInteger	generateAlias()	Overridable function to generate the unique alias for each generated key.
protected KeyPairGeneratorFactory	getKeyGeneratorFactory(String keyTypeName)	Gets a KeyPairGeneratorFactory that can be used to generate key pairs given the supplied keyTypeName.
protected Duration	getKeyValidity()	Gets the key validity.
protected Provider	getProvider()	Gets the security provider used by the container.
protected boolean	isExpired(String alias)	Checks if the entry identified with alias is expired.
void	setKeyValidity(Duration keyValidity)	Assigns the duration for the validity of generated credentials.
void	setSupportedKeyTypes(List<String> supportedKeyTypes)	Assigns the key types that this container supports.

Methods inherited from class java.lang.Object

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

Methods inherited from interface se.swedenconnect.security.credential.container.PkiCredentialContainer

deleteCredential, generateCredential, getCredential, getExpiryTime, listCredentials

Field Details

DEFAULT_SUPPORTED_KEY_TYPES

public static final String[] DEFAULT_SUPPORTED_KEY_TYPES

The key gen types (see KeyGenType) that are supported by default. To change this, use setSupportedKeyTypes(List).

Constructor Details

AbstractPkiCredentialContainer

public AbstractPkiCredentialContainer(@Nonnull
 Provider provider)

Constructor.

Parameters:

provider - the provider that is used to create and manage keys

Method Details

generateAlias

@Nonnull
protected BigInteger generateAlias()

Overridable function to generate the unique alias for each generated key.

Returns:

BigInteger key alias

cleanup

public void cleanup()
             throws PkiCredentialContainerException

Traverses through all credentials in the multi credential key store and delets the expired ones.

Specified by:

cleanup in interface PkiCredentialContainer

Throws:

PkiCredentialContainerException - error performing cleanup

isExpired

protected boolean isExpired(@Nonnull
 String alias)
                     throws PkiCredentialContainerException

Checks if the entry identified with alias is expired.

Parameters:

alias - the key entry alias

Returns:

true if the entry has expired, and false otherwise

Throws:

PkiCredentialContainerException - for errors getting the entry

setKeyValidity

public void setKeyValidity(@Nullable
 Duration keyValidity)

Assigns the duration for the validity of generated credentials.

If supplied with null the generated key pairs will never expire. In these cases each generated credential must be manually deleted using PkiCredentialContainer.deleteCredential(String).

Specified by:

setKeyValidity in interface PkiCredentialContainer

Parameters:

keyValidity - the validity

getKeyValidity

@Nullable
protected Duration getKeyValidity()

Gets the key validity. A value of null means that credentials never expire.

Returns:

the validity, or null

setSupportedKeyTypes

public void setSupportedKeyTypes(@Nonnull
 List<String> supportedKeyTypes)

Assigns the key types that this container supports. The default is DEFAULT_SUPPORTED_KEY_TYPES.

Specified by:

setSupportedKeyTypes in interface PkiCredentialContainer

Parameters:

supportedKeyTypes - a list of supported key types

getProvider

@Nonnull
protected Provider getProvider()

Gets the security provider used by the container.

Returns:

the provider

getKeyGeneratorFactory

@Nonnull
protected KeyPairGeneratorFactory getKeyGeneratorFactory(@Nonnull
 String keyTypeName)
                                                  throws NoSuchAlgorithmException

Gets a KeyPairGeneratorFactory that can be used to generate key pairs given the supplied keyTypeName.

Parameters:

keyTypeName - the key type name

Returns:

a KeyPairGeneratorFactory

Throws:

NoSuchAlgorithmException - if no match is found