Package se.swedenconnect.security.credential.container

Class SoftPkiCredentialContainer

java.lang.Object

se.swedenconnect.security.credential.container.AbstractPkiCredentialContainer

se.swedenconnect.security.credential.container.AbstractKeyStorePkiCredentialContainer

se.swedenconnect.security.credential.container.SoftPkiCredentialContainer

All Implemented Interfaces:

PkiCredentialContainer

public class SoftPkiCredentialContainer
extends AbstractKeyStorePkiCredentialContainer

Implements a PkiCredentialContainer based on a KeyStore that is held in memory (i.e. not using an HSM device for key storage).

Also see InMemoryPkiCredentialContainer that is an in-memory container that does not use key stores (and thus, does not generate any certificates as part of the key generation process).

Author:

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

Field Summary

Fields inherited from class se.swedenconnect.security.credential.container.AbstractPkiCredentialContainer

DEFAULT_SUPPORTED_KEY_TYPES

Constructor Summary

Constructors

Constructor	Description
SoftPkiCredentialContainer(String providerName)	Constructor loading the security provider identified by providerName.
SoftPkiCredentialContainer(String providerName, String password)	Constructor loading the security provider identified by providerName.
SoftPkiCredentialContainer(Provider provider)	Constructor.
SoftPkiCredentialContainer(Provider provider, String password)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected KeyStore	createKeyStore(Provider provider, char[] password)	Creates the key store used to store generated keys.
PkiCredential	getCredentialFromAlias(String alias)	Gets the credential for a specific alias from the credential container.

Methods inherited from class se.swedenconnect.security.credential.container.AbstractKeyStorePkiCredentialContainer

deleteCredential, generateCredential, getAlgorithmName, getCredential, getExpiryTime, getKeyStore, getPassword, getX500Name, listCredentials

Methods inherited from class se.swedenconnect.security.credential.container.AbstractPkiCredentialContainer

cleanup, generateAlias, getKeyGeneratorFactory, getKeyValidity, getProvider, isExpired, setKeyValidity, setSupportedKeyTypes

Methods inherited from class java.lang.Object

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

Constructor Details

SoftPkiCredentialContainer

public SoftPkiCredentialContainer(@Nonnull
 String providerName)
                           throws KeyStoreException

Constructor loading the security provider identified by providerName. No password is used for the generated key store.

Parameters:

providerName - the name of the security provider

Throws:

KeyStoreException - for errors creating the key store

SoftPkiCredentialContainer

public SoftPkiCredentialContainer(@Nonnull
 Provider provider)
                           throws KeyStoreException

Constructor. No password is used for the generated key store.

Parameters:

provider - the security provider

Throws:

KeyStoreException - for errors creating the key store

SoftPkiCredentialContainer

public SoftPkiCredentialContainer(@Nonnull
 String providerName,
 @Nullable
 String password)
                           throws KeyStoreException

Constructor loading the security provider identified by providerName.

Parameters:

providerName - the name of the security provider

password - the store password that we should use for the generated key store (may be null)

Throws:

KeyStoreException - for errors creating the key store

SoftPkiCredentialContainer

public SoftPkiCredentialContainer(@Nonnull
 Provider provider,
 @Nullable
 String password)
                           throws KeyStoreException

Constructor.

Parameters:

provider - the security provider

password - the store password that we should use for the generated key store (may be null)

Throws:

KeyStoreException - for errors creating the key store

Method Details

createKeyStore

@Nonnull
protected KeyStore createKeyStore(@Nonnull
 Provider provider,
 @Nullable
 char[] password)
                           throws KeyStoreException

Creates the key store used to store generated keys.

Specified by:

createKeyStore in class AbstractKeyStorePkiCredentialContainer

Parameters:

provider - the provider for the key store

password - the password for the key store

Returns:

key store

Throws:

KeyStoreException - error creating the key store

getCredentialFromAlias

@Nonnull
public PkiCredential getCredentialFromAlias(@Nonnull
 String alias)
                                     throws PkiCredentialContainerException

Gets the credential for a specific alias from the credential container.

Specified by:

getCredentialFromAlias in class AbstractKeyStorePkiCredentialContainer

Parameters:

alias - the alias of the credential to get

Returns:

credential for the specified alias

Throws:

PkiCredentialContainerException - for errors obtaining the requested credential