PicketLink Federation Core 2.1.6.Final-redhat-2

org.picketlink.identity.federation.core.interfaces
Interface TrustKeyManager

All Known Implementing Classes:
KeyStoreKeyManager

public interface TrustKeyManager

Key Manager interface used in trust decisions

Since:
Jan 22, 2009
Author:
Anil.Saldhana@redhat.com

Method Summary
 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 of the domain
 void setAuthProperties(List<AuthPropertyType> authList)
          Provide a set of properties used for authentication into the storage of keys - keystore, ldap, db, HSM etc
 void setValidatingAlias(List<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
 

Method Detail

setAuthProperties

void setAuthProperties(List<AuthPropertyType> authList)
                       throws TrustKeyConfigurationException,
                              TrustKeyProcessingException
Provide a set of properties used for authentication into the storage of keys - keystore, ldap, db, HSM etc

Parameters:
authList -
Throws:
{@link - IOException}
TrustKeyConfigurationException
TrustKeyProcessingException

setValidatingAlias

void setValidatingAlias(List<KeyValueType> aliases)
                        throws TrustKeyConfigurationException,
                               TrustKeyProcessingException
Set a list of (domain,alias) tuple to trust domains The alias is a string that represents the validating key stored for a domain

Parameters:
aliases -
Throws:
{@link - IOException}
TrustKeyConfigurationException
TrustKeyProcessingException

getSigningKey

PrivateKey getSigningKey()
                         throws TrustKeyConfigurationException,
                                TrustKeyProcessingException
Get the Signing Key

Returns:
Throws:
{@link - CertificateException}
TrustKeyConfigurationException
TrustKeyProcessingException

getSigningKeyPair

KeyPair getSigningKeyPair()
                          throws TrustKeyConfigurationException,
                                 TrustKeyProcessingException

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

Returns:
the constructed KeyPair object.
Throws:
TrustKeyConfigurationException
TrustKeyProcessingException

getCertificate

Certificate getCertificate(String alias)
                           throws TrustKeyConfigurationException,
                                  TrustKeyProcessingException
Get the certificate given an alias

Parameters:
alias -
Returns:
Throws:
{@link - CertificateException}
TrustKeyConfigurationException
TrustKeyProcessingException

getPublicKey

PublicKey getPublicKey(String alias)
                       throws TrustKeyConfigurationException,
                              TrustKeyProcessingException
Get a Public Key given an alias

Parameters:
alias -
Returns:
Throws:
{@link - CertificateException}
TrustKeyConfigurationException
TrustKeyProcessingException

getEncryptionKey

SecretKey getEncryptionKey(String domain,
                           String encryptionAlgorithm,
                           int keyLength)
                           throws TrustKeyConfigurationException,
                                  TrustKeyProcessingException
Given a domain, obtain a secret key

Parameters:
domain -
encryptionAlgorithm - Encryption Algorithm
keyLength - length of keys
Returns:
Throws:
TrustKeyConfigurationException
TrustKeyProcessingException
See Also:
EncryptionKeyUtil}

getValidatingKey

PublicKey getValidatingKey(String domain)
                           throws TrustKeyConfigurationException,
                                  TrustKeyProcessingException
Get the Validating Public Key of the domain

Parameters:
domain -
Returns:
Throws:
TrustKeyConfigurationException
TrustKeyProcessingException

addAdditionalOption

void addAdditionalOption(String key,
                         Object value)
Add general options

Parameters:
key -
value -

getAdditionalOption

Object getAdditionalOption(String key)
Get additional option

Parameters:
key -
Returns:

PicketLink Federation Core 2.1.6.Final-redhat-2

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.