Package se.swedenconnect.security.credential.factory

Class KeyStoreFactory

java.lang.Object

se.swedenconnect.security.credential.factory.KeyStoreFactory

public class KeyStoreFactory
extends Object

Factory class for loading and unlocking a KeyStore.

Author:

Martin Lindström

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PKCS11_KEYSTORE_TYPE	Symbolic constant for the PKCS11 KeyStore type.

Constructor Summary

Constructors

Constructor	Description
KeyStoreFactory()

Method Summary

Modifier and Type	Method	Description
static KeyStore	loadKeyStore(InputStream stream, char[] password, String type, String provider)	Loads and unlocks a KeyStore.
static KeyStore	loadKeyStore(StoreConfiguration storeConfiguration, ConfigurationResourceLoader resourceLoader)	Given a StoreConfiguration object, this method loads and unlocks a KeyStore.
static KeyStore	loadPkcs11KeyStore(Pkcs11Configuration pkcs11Configuration, char[] pin)	Loads and unlocks a PKCS#11 key store.

Methods inherited from class java.lang.Object

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

Field Details

PKCS11_KEYSTORE_TYPE

public static final String PKCS11_KEYSTORE_TYPE

Symbolic constant for the PKCS11 KeyStore type.

See Also:

• Constant Field Values

Constructor Details

KeyStoreFactory

public KeyStoreFactory()

Method Details

loadKeyStore

@Nonnull
public static KeyStore loadKeyStore(@Nullable
 InputStream stream,
 @Nullable
 char[] password,
 @Nullable
 String type,
 @Nullable
 String provider)
                             throws KeyStoreException,
NoSuchProviderException

Loads and unlocks a KeyStore.

To create a KeyStore for a PKCS#11 device, use loadPkcs11KeyStore(Pkcs11Configuration, char[]).

Parameters:

stream - an InputStream pointing at the key store (if null an empty KeyStore will be created)

password - the password for unlocking the key store (may be null)

type - the key store type, if not supplied, KeyStore.getDefaultType() will be assumed

provider - the security provider to use (if not provided, the default provider will be used)

Returns:

a loaded and unlocked KeyStore

Throws:

KeyStoreException - for errors during loading and unlocking of the key store

NoSuchProviderException - if the given provider does not exist

loadPkcs11KeyStore

@Nonnull
public static KeyStore loadPkcs11KeyStore(@Nonnull
 Pkcs11Configuration pkcs11Configuration,
 @Nonnull
 char[] pin)
                                   throws KeyStoreException

Loads and unlocks a PKCS#11 key store.

Parameters:

pkcs11Configuration - the PKCS#11 configuration

pin - the PIN to unlock the key store

Returns:

a loaded and unlocked KeyStore

Throws:

KeyStoreException - for errors during loading and unlocking of the key store

loadKeyStore

@Nonnull
public static KeyStore loadKeyStore(@Nonnull
 StoreConfiguration storeConfiguration,
 @Nullable
 ConfigurationResourceLoader resourceLoader)
                             throws IllegalArgumentException,
KeyStoreException,
NoSuchProviderException,
IOException,
Pkcs11ConfigurationException

Given a StoreConfiguration object, this method loads and unlocks a KeyStore.

Parameters:

storeConfiguration - the configuration object

resourceLoader - for reading configuration resources into InputStreams, if null, a DefaultConfigurationResourceLoader will be used

Returns:

a KeyStore

Throws:

IllegalArgumentException - for missing or illegal input values

KeyStoreException - for problems unlocking the key store

NoSuchProviderException - if a reference security provider does not exist

IOException - for errors reading files referenced in the configuration

Pkcs11ConfigurationException - for invalid PKCS#11 configuration