org.picketlink.identity.federation.core.impl

Class KeyStoreKeyManager

java.lang.Object

org.picketlink.identity.federation.core.impl.KeyStoreKeyManager

All Implemented Interfaces:

TrustKeyManager

public class KeyStoreKeyManager
extends Object
implements TrustKeyManager

KeyStore based Trust Key Manager

Since:

Jan 22, 2009

Author:

Anil.Saldhana@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEYSTORE_PASS
static String	KEYSTORE_URL
static String	SIGNING_KEY_ALIAS
static String	SIGNING_KEY_PASS

Constructor Summary

Constructors

Constructor and Description
KeyStoreKeyManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAdditionalOption(String key, Object value) Add general options
Object	getAdditionalOption(String key) Get additional option
Certificate	getCertificate(String alias) Get the certificate given an alias
SecretKey	getEncryptionKey(String domain, String encryptionAlgorithm, int keyLength) Given a domain, obtain a secret key
PublicKey	getPublicKey(String alias) Get a Public Key given an alias
PrivateKey	getSigningKey() Get the Signing Key
KeyPair	getSigningKeyPair() Constructs a KeyPair instance containing the signing key (PrivateKey) and associated PublicKey.
PublicKey	getValidatingKey(String domain) Get the validating public key Note:: The domain is mapped to an alias in the keystore
void	setAuthProperties(List<org.picketlink.config.federation.AuthPropertyType> authList) Provide a set of properties used for authentication into the storage of keys - keystore, ldap, db, HSM etc
void	setValidatingAlias(List<org.picketlink.config.federation.KeyValueType> aliases) Set a list of (domain,alias) tuple to trust domains The alias is a string that represents the validating key stored for a domain

Methods inherited from class java.lang.Object

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

Field Detail

KEYSTORE_URL

public static final String KEYSTORE_URL

See Also:

Constant Field Values

KEYSTORE_PASS

public static final String KEYSTORE_PASS

See Also:

Constant Field Values

SIGNING_KEY_PASS

public static final String SIGNING_KEY_PASS

See Also:

Constant Field Values

SIGNING_KEY_ALIAS

public static final String SIGNING_KEY_ALIAS

See Also:

Constant Field Values

Constructor Detail

KeyStoreKeyManager

public KeyStoreKeyManager()

Method Detail

getSigningKey

public PrivateKey getSigningKey()
                         throws org.picketlink.common.exceptions.TrustKeyConfigurationException,
                                org.picketlink.common.exceptions.TrustKeyProcessingException

Description copied from interface: TrustKeyManager

Get the Signing Key

Specified by:

getSigningKey in interface TrustKeyManager

Returns:

Throws:

org.picketlink.common.exceptions.TrustKeyConfigurationException

org.picketlink.common.exceptions.TrustKeyProcessingException

See Also:

TrustKeyManager.getSigningKey()

getSigningKeyPair

public KeyPair getSigningKeyPair()
                          throws org.picketlink.common.exceptions.TrustKeyConfigurationException,
                                 org.picketlink.common.exceptions.TrustKeyProcessingException

Description copied from interface: TrustKeyManager

Constructs a KeyPair instance containing the signing key (PrivateKey) and associated PublicKey.

Specified by:

getSigningKeyPair in interface TrustKeyManager

Returns:

the constructed KeyPair object.

Throws:

org.picketlink.common.exceptions.TrustKeyConfigurationException

org.picketlink.common.exceptions.TrustKeyProcessingException

getCertificate

public Certificate getCertificate(String alias)
                           throws org.picketlink.common.exceptions.TrustKeyConfigurationException,
                                  org.picketlink.common.exceptions.TrustKeyProcessingException

Description copied from interface: TrustKeyManager

Get the certificate given an alias

Specified by:

getCertificate in interface TrustKeyManager

Returns:

Throws:

org.picketlink.common.exceptions.TrustKeyConfigurationException

org.picketlink.common.exceptions.TrustKeyProcessingException

See Also:

TrustKeyManager.getCertificate(String)

getPublicKey

public PublicKey getPublicKey(String alias)
                       throws org.picketlink.common.exceptions.TrustKeyConfigurationException,
                              org.picketlink.common.exceptions.TrustKeyProcessingException

Description copied from interface: TrustKeyManager

Get a Public Key given an alias

Specified by:

getPublicKey in interface TrustKeyManager

Returns:

Throws:

org.picketlink.common.exceptions.TrustKeyConfigurationException

org.picketlink.common.exceptions.TrustKeyProcessingException

See Also:

TrustKeyManager.getPublicKey(String)

getValidatingKey

public PublicKey getValidatingKey(String domain)
                           throws org.picketlink.common.exceptions.TrustKeyConfigurationException,
                                  org.picketlink.common.exceptions.TrustKeyProcessingException

Get the validating public key Note:: The domain is mapped to an alias in the keystore

Specified by:

getValidatingKey in interface TrustKeyManager

Returns:

Throws:

IOException

org.picketlink.common.exceptions.TrustKeyConfigurationException

org.picketlink.common.exceptions.TrustKeyProcessingException

See Also:

TrustKeyManager.getValidatingKey(String), TrustKeyManager.getPublicKey(String)

setAuthProperties

public void setAuthProperties(List<org.picketlink.config.federation.AuthPropertyType> authList)
                       throws org.picketlink.common.exceptions.TrustKeyConfigurationException,
                              org.picketlink.common.exceptions.TrustKeyProcessingException

Description copied from interface: TrustKeyManager

Provide a set of properties used for authentication into the storage of keys - keystore, ldap, db, HSM etc

Specified by:

setAuthProperties in interface TrustKeyManager

Throws:

org.picketlink.common.exceptions.TrustKeyConfigurationException

org.picketlink.common.exceptions.TrustKeyProcessingException

See Also:

TrustKeyManager.setAuthProperties(List)

setValidatingAlias

public void setValidatingAlias(List<org.picketlink.config.federation.KeyValueType> aliases)
                        throws org.picketlink.common.exceptions.TrustKeyConfigurationException,
                               org.picketlink.common.exceptions.TrustKeyProcessingException

Description copied from interface: TrustKeyManager

Set a list of (domain,alias) tuple to trust domains The alias is a string that represents the validating key stored for a domain

Specified by:

setValidatingAlias in interface TrustKeyManager

Throws:

org.picketlink.common.exceptions.TrustKeyConfigurationException

org.picketlink.common.exceptions.TrustKeyProcessingException

See Also:

TrustKeyManager.setValidatingAlias(List)

getEncryptionKey

public SecretKey getEncryptionKey(String domain,
                         String encryptionAlgorithm,
                         int keyLength)
                           throws org.picketlink.common.exceptions.TrustKeyConfigurationException,
                                  org.picketlink.common.exceptions.TrustKeyProcessingException

Description copied from interface: TrustKeyManager

Given a domain, obtain a secret key

Specified by:

getEncryptionKey in interface TrustKeyManager

encryptionAlgorithm - Encryption Algorithm

keyLength - length of keys

Returns:

Throws:

GeneralSecurityException

org.picketlink.common.exceptions.TrustKeyConfigurationException

org.picketlink.common.exceptions.TrustKeyProcessingException

See Also:

TrustKeyManager#getEncryptionKey(String)

addAdditionalOption

public void addAdditionalOption(String key,
                       Object value)

Description copied from interface: TrustKeyManager

Add general options

Specified by:

addAdditionalOption in interface TrustKeyManager

See Also:

TrustKeyManager.addAdditionalOption(java.lang.String, java.lang.Object)

getAdditionalOption

public Object getAdditionalOption(String key)

Description copied from interface: TrustKeyManager

Get additional option

Specified by:

getAdditionalOption in interface TrustKeyManager

Returns:

See Also:

TrustKeyManager.getAdditionalOption(java.lang.String)