Package com.helger.security.keystore

Class KeyStoreHelper

java.lang.Object

com.helger.security.keystore.KeyStoreHelper

@ThreadSafe
public final class KeyStoreHelper
extends Object

Helper methods to access Java key stores of type JKS (Java KeyStore).

Author:

PEPPOL.AT, BRZ, Philip Helger

Method Summary

Modifier and Type	Method	Description
static KeyStore	createKeyStoreWithOnlyOneItem(KeyStore aBaseKeyStore, String sAliasToCopy, char[] aAliasPassword)	Create a new key store based on an existing key store
static com.helger.commons.io.resourceprovider.IReadableResourceProvider	getResourceProvider()
static KeyStore	getSimiliarKeyStore(KeyStore aOther)
static LoadedKeyStore	loadKeyStore(IKeyStoreType aKeyStoreType, String sKeyStorePath, String sKeyStorePassword)	Load the provided key store in a safe manner.
static KeyStore	loadKeyStoreDirect(IKeyStoreType aKeyStoreType, String sKeyStorePath, char[] aKeyStorePassword)	Load a key store from a resource.
static KeyStore	loadKeyStoreDirect(IKeyStoreType aKeyStoreType, String sKeyStorePath, String sKeyStorePassword)	Load a key store from a resource.
static LoadedKey<KeyStore.PrivateKeyEntry>	loadPrivateKey(KeyStore aKeyStore, String sKeyStorePath, String sKeyStoreKeyAlias, char[] aKeyStoreKeyPassword)	Load the specified private key entry from the provided key store.
static LoadedKey<KeyStore.SecretKeyEntry>	loadSecretKey(KeyStore aKeyStore, String sKeyStorePath, String sKeyStoreKeyAlias, char[] aKeyStoreKeyPassword)	Load the specified secret key entry from the provided key store.
static LoadedKey<KeyStore.TrustedCertificateEntry>	loadTrustedCertificateKey(KeyStore aKeyStore, String sKeyStorePath, String sKeyStoreKeyAlias, char[] aKeyStoreKeyPassword)	Load the specified private key entry from the provided key store.
static void	setResourceProvider(com.helger.commons.io.resourceprovider.IReadableResourceProvider aResourceProvider)

Methods inherited from class java.lang.Object

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

Method Detail

getResourceProvider

@Nonnull
public static com.helger.commons.io.resourceprovider.IReadableResourceProvider getResourceProvider()

setResourceProvider

public static void setResourceProvider(@Nonnull
                                       com.helger.commons.io.resourceprovider.IReadableResourceProvider aResourceProvider)

getSimiliarKeyStore

@Nonnull
public static KeyStore getSimiliarKeyStore(@Nonnull
                                           KeyStore aOther)
                                    throws KeyStoreException

Throws:

KeyStoreException

loadKeyStoreDirect

@Nonnull
public static KeyStore loadKeyStoreDirect(@Nonnull
                                          IKeyStoreType aKeyStoreType,
                                          @Nullable
                                          String sKeyStorePath,
                                          @Nullable
                                          String sKeyStorePassword)
                                   throws GeneralSecurityException,
                                          IOException

Load a key store from a resource.

Parameters:

aKeyStoreType - Type of key store. May not be null.

sKeyStorePath - The path pointing to the key store. May only be null for EKeyStoreType.PKCS11.

sKeyStorePassword - The key store password. May be null to indicate that no password is required.

Returns:

The Java key-store object.

Throws:

GeneralSecurityException - In case of a key store error

IOException - In case key store loading fails

IllegalArgumentException - If the key store path is invalid

loadKeyStoreDirect

@Nonnull
public static KeyStore loadKeyStoreDirect(@Nonnull
                                          IKeyStoreType aKeyStoreType,
                                          @Nullable
                                          String sKeyStorePath,
                                          @Nullable
                                          char[] aKeyStorePassword)
                                   throws GeneralSecurityException,
                                          IOException

Load a key store from a resource.

Parameters:

aKeyStoreType - Type of key store. May not be null.

sKeyStorePath - The path pointing to the key store. May only be null for EKeyStoreType.PKCS11 or other key store types that don't require a path.

aKeyStorePassword - The key store password. May be null to indicate that no password is required.

Returns:

The Java key-store object.

Throws:

GeneralSecurityException - In case of a key store error

IOException - In case key store loading fails

IllegalArgumentException - If the key store path is invalid

See Also:

KeyStore.load(InputStream, char[])

createKeyStoreWithOnlyOneItem

@Nonnull
public static KeyStore createKeyStoreWithOnlyOneItem(@Nonnull
                                                     KeyStore aBaseKeyStore,
                                                     @Nonnull
                                                     String sAliasToCopy,
                                                     @Nullable
                                                     char[] aAliasPassword)
                                              throws GeneralSecurityException,
                                                     IOException

Create a new key store based on an existing key store

Parameters:

aBaseKeyStore - The source key store. May not be null

sAliasToCopy - The name of the alias in the source key store that should be put in the new key store

aAliasPassword - The optional password to access the alias in the source key store. If it is not null the same password will be used in the created key store

Returns:

The created in-memory key store

Throws:

GeneralSecurityException - In case of a key store error

IOException - In case key store loading fails

loadKeyStore

@Nonnull
public static LoadedKeyStore loadKeyStore(@Nonnull
                                          IKeyStoreType aKeyStoreType,
                                          @Nullable
                                          String sKeyStorePath,
                                          @Nullable
                                          String sKeyStorePassword)

Load the provided key store in a safe manner.

Parameters:

aKeyStoreType - Type of key store. May not be null.

sKeyStorePath - Path to the key store. May not be null for all key store types that require a path.

sKeyStorePassword - Password for the key store. May not be null to succeed.

Returns:

The key store loading result. Never null.

loadPrivateKey

@Nonnull
public static LoadedKey<KeyStore.PrivateKeyEntry> loadPrivateKey(@Nonnull
                                                                 KeyStore aKeyStore,
                                                                 @Nonnull
                                                                 String sKeyStorePath,
                                                                 @Nullable
                                                                 String sKeyStoreKeyAlias,
                                                                 @Nullable
                                                                 char[] aKeyStoreKeyPassword)

Load the specified private key entry from the provided key store.

Parameters:

aKeyStore - The key store to load the key from. May not be null.

sKeyStorePath - Key store path. For nice error messages only. May not be null.

sKeyStoreKeyAlias - The alias to be resolved in the key store. Must be non- null to succeed.

aKeyStoreKeyPassword - The key password for the key store. Must be non-null to succeed.

Returns:

The key loading result. Never null.

loadSecretKey

@Nonnull
public static LoadedKey<KeyStore.SecretKeyEntry> loadSecretKey(@Nonnull
                                                               KeyStore aKeyStore,
                                                               @Nonnull
                                                               String sKeyStorePath,
                                                               @Nullable
                                                               String sKeyStoreKeyAlias,
                                                               @Nullable
                                                               char[] aKeyStoreKeyPassword)

Load the specified secret key entry from the provided key store.

Parameters:

aKeyStore - The key store to load the key from. May not be null.

sKeyStorePath - Key store path. For nice error messages only. May not be null.

sKeyStoreKeyAlias - The alias to be resolved in the key store. Must be non- null to succeed.

aKeyStoreKeyPassword - The key password for the key store. Must be non-null to succeed.

Returns:

The key loading result. Never null.

loadTrustedCertificateKey

@Nonnull
public static LoadedKey<KeyStore.TrustedCertificateEntry> loadTrustedCertificateKey(@Nonnull
                                                                                    KeyStore aKeyStore,
                                                                                    @Nonnull
                                                                                    String sKeyStorePath,
                                                                                    @Nullable
                                                                                    String sKeyStoreKeyAlias,
                                                                                    @Nullable
                                                                                    char[] aKeyStoreKeyPassword)

Load the specified private key entry from the provided key store.

Parameters:

aKeyStore - The key store to load the key from. May not be null.

sKeyStorePath - Key store path. For nice error messages only. May not be null.

sKeyStoreKeyAlias - The alias to be resolved in the key store. Must be non- null to succeed.

aKeyStoreKeyPassword - The key password for the key store. Must be non-null to succeed.

Returns:

The key loading result. Never null.