Package org.forgerock.openig.util

Class KeyStoreUtil

java.lang.Object

org.forgerock.openig.util.KeyStoreUtil

public final class KeyStoreUtil
extends Object

Utility class to retrieve private keys from KeyStore.

Method Summary

Modifier and Type	Method	Description
static Key	getKey(KeyStore keyStore, String alias, String password)	Retrieves a PrivateKey or a SecretKey from a KeyStore.
static Key	getPublicKey(KeyStore keyStore, String alias, String password)	Retrieve the public key from the keystore: it could be a certificate or a symmetric key.
static String	storeTypeFromKeyStore(String filename)	Get default keystore type based on the keystore filename.

Methods inherited from class java.lang.Object

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

Method Detail

getKey

public static Key getKey(KeyStore keyStore,
                         String alias,
                         String password)

Retrieves a PrivateKey or a SecretKey from a KeyStore.

Parameters:

keyStore - The storage facility for cryptographic keys and certificates to search for the given key.

alias - The alias associated with the key.

password - The password for recovering the key.

Returns:

a Key or an IllegalArgumentException if it fails.

Throws:

IllegalArgumentException - If the key was not retrieved or if an exception occurred.

getPublicKey

public static Key getPublicKey(KeyStore keyStore,
                               String alias,
                               String password)

Retrieve the public key from the keystore: it could be a certificate or a symmetric key.

Parameters:

keyStore - The keystore where to find the key.

alias - The alias associated with the key.

password - The keystore password, could be null if the key is not symmetric. (Only symmetric key, SecretKey will require a password).

Returns:

The public key: certificate for asymmetric keys or SecretKey for symmetric keys, stored in the keystore.

storeTypeFromKeyStore

public static String storeTypeFromKeyStore(String filename)

Get default keystore type based on the keystore filename.

Parameters:

filename - name of the keystore file with extension

Returns:

default store type for the given filename or "PKCS12" if no default available.