iaik.ixsil.keyinfo

Class KeyManagerImpl

java.lang.Object

iaik.ixsil.keyinfo.KeyManagerImpl

All Implemented Interfaces:

SignerKeyManager, VerifierKeyManager

public class KeyManagerImpl
extends java.lang.Object
implements VerifierKeyManager, SignerKeyManager

This class provides a standard implementation of a key manager for IXSIL. It implements the two interfaces SignerKeyManager and SignerKeyManager, and therefore it can be used both in the signature creation and in the signature verification use case.

A lot of different key information hints can be used with XML signatures. This key manager copes with this large amount of information by employing so called key providers. A key provider is responsible for a certain type of key information hints, such as KeyValue or X509Data hints. The functionality, which this key manager requires form a key provider both in the signature creation and in the signature verification use case, is specified in the interface KeyProviderInterface.

Signature verification

If this key manager is initialized with the DOM representation of the XML signature's KeyInfo element, it tries to instantiate a key provider for each type of key information found in this element. If a key provider is actually instantiated, depends on the associations between key information types and their corresponding implementation classes provided with the IXSIL keymanager properties.

If this key manager is asked to provide the verification key in the verification use case, it delegates this request to its registerred key providers. If the first registerred key provider fails to provide the verfication key, the second registerred key provider is asked for it, and so forth. If a key provider can provide the key, no more key providers are asked.

Signature creation

In the signature creation use case, key providers are registerred with the method addKeyProvider(iaik.ixsil.keyinfo.KeyProviderInterface). If the key manager is asked by IXSIL to provide the DOM representation of the KeyInfo XML element, which should be incorporated into the XML signature, it asks every registerred key provider for the DOM representation of the key information hints the key provider is responsible for, collects the hints provided by all key providers into a XML KeyInfo element, and delivers this XML KeyInfo element to IXSIL.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	id_ Value for the "Id" attribute of the XML Object element.
protected java.util.Vector	keyProviders_ A list of all key providers (KeyProviderInterface), which are registerred at this key manager.
protected org.w3c.dom.Document	signatureDOMDoc_ The DOM document bearing the XML signature.
protected URIResolverParameters	uRIResolverParameters_ Parameters used by the key manager when resolving URIs.

Constructor Summary

Constructors

Constructor and Description
KeyManagerImpl() This constructor will be used by IXSIL in case of signature verification.
KeyManagerImpl(org.w3c.dom.Document signatureDOMDoc) This constructor can be used in case of signature creation, if the application wants to create a new key manager.

Method Summary

Methods

Modifier and Type	Method and Description
void	addKeyProvider(KeyProviderInterface keyProvider) Used by the application to register a key provider at this key manager.
java.lang.String	getId() Gets the Id attribute of the KeyInfo Element represented by this this KeyManagerImpl object.
org.w3c.dom.Element	getKeyInfo() Gets the DOM representation of the XML KeyInfo element including all the keying information, which should be incorporated into the XML signature.
KeyProviderInterface	getKeyProvider() Returns a reference to the particular key provider that provided the verification public key to this KeyManagerImpl.
KeyProviderInterface[]	getKeyProviders() Gets an array of all key providers registerred at this key manager.
protected java.lang.String	getSubelementName(int ranking) Gets the name of the preferred KeyInfo subelement with the specified ranking from the IXSIL keymanager properties.
java.security.Key	getVerifierKey() Gets the key which will be used to verify the XML signature.
void	removeKeyProvider(KeyProviderInterface keyProvider) Removes the specified key provider from this key manager's list of registerred key providers.
void	setId(java.lang.String id) Sets the Id attribute of the KeyInfo Element represented by this KeyManagerImpl object.
void	setKeyInfo(org.w3c.dom.Element keyInfo) Initializes this key manager with the DOM representation of the XML KeyInfo element, as found in the XML signature to be verified.
void	setURIResolverParameters(URIResolverParameters params) Sets the parameters to be used by the key mananger when resolving URIs.

Methods inherited from class java.lang.Object

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

Field Detail

id_

protected java.lang.String id_

Value for the "Id" attribute of the XML Object element.

keyProviders_

protected java.util.Vector keyProviders_

A list of all key providers (KeyProviderInterface), which are registerred at this key manager.

signatureDOMDoc_

protected org.w3c.dom.Document signatureDOMDoc_

The DOM document bearing the XML signature. Used in method getKeyInfo() to create DOM nodes.

uRIResolverParameters_

protected URIResolverParameters uRIResolverParameters_

Parameters used by the key manager when resolving URIs.

Constructor Detail

KeyManagerImpl

public KeyManagerImpl()

This constructor will be used by IXSIL in case of signature verification.

KeyManagerImpl

public KeyManagerImpl(org.w3c.dom.Document signatureDOMDoc)

This constructor can be used in case of signature creation, if the application wants to create a new key manager.

Parameters:

signatureDOMDoc - A reference to the DOM document bearing the XML Signature. Used in method getKeyInfo() to create DOM nodes. Must not be null.

Method Detail

setId

public void setId(java.lang.String id)

Sets the Id attribute of the KeyInfo Element represented by this KeyManagerImpl object. If the attribute has already been set previously, its value will be overwritten. If the specified value is null, the attribute will be removed.

Parameters:

id - The value for the Id attribute.

getId

public java.lang.String getId()

Gets the Id attribute of the KeyInfo Element represented by this this KeyManagerImpl object.

Specified by:

getId in interface SignerKeyManager

Specified by:

getId in interface VerifierKeyManager

Returns:

the value of the Id attribute, or null if the attribute is not set.

getVerifierKey

public java.security.Key getVerifierKey()
                                 throws KeyManagerException

Gets the key which will be used to verify the XML signature. The registered key providers will be called for the key one after the other, until one of them can deliver the key.

Specified by:

getVerifierKey in interface VerifierKeyManager

Returns:

the key which will be used to verify the XML signature.

Throws:

KeyManagerException - if no key provider is registerred, or if none of the registerred key providers can deliver the key.

getKeyInfo

public org.w3c.dom.Element getKeyInfo()
                               throws KeyManagerException

Gets the DOM representation of the XML KeyInfo element including all the keying information, which should be incorporated into the XML signature. The method getKeyInfoSubelements of each registerred key provider will be invoked in order to collect all key information hints which should be incorporated into the XML KeyInfo element.

Specified by:

getKeyInfo in interface SignerKeyManager

Returns:

the DOM representation of the XML KeyInfo element containing at least one key information hint, or null, if there are no key information hints available.

Throws:

KeyManagerException - if producing the XML KeyInfo element fails for any reason.

setKeyInfo

public void setKeyInfo(org.w3c.dom.Element keyInfo)
                throws KeyManagerException

Initializes this key manager with the DOM representation of the XML KeyInfo element, as found in the XML signature to be verified. Firstly, this method will scan the IXSIL keymanager properties for a list of names of preferred KeyInfo subelements. For each category of preferred KeyInfo subelements the corresponding KeyProviderInterface implementation class will be instantiated and initialized if such subelements are found within the KeyInfo element. The mappings between subelement name and KeyProviderInterface implementation classname are specified in the IXSIL KeyInfo Properties.

Specified by:

setKeyInfo in interface VerifierKeyManager

Parameters:

keyInfo - The DOM representation of the XML KeyInfo element, as found in the XML signature.

Throws:

KeyManagerException - if the KeyInfo element cannot be interpreted well.

addKeyProvider

public void addKeyProvider(KeyProviderInterface keyProvider)

Used by the application to register a key provider at this key manager.

Parameters:

keyProvider - The key provider to be added to this key manager. Must not be null.

removeKeyProvider

public void removeKeyProvider(KeyProviderInterface keyProvider)

Removes the specified key provider from this key manager's list of registerred key providers.

Parameters:

keyProvider - The key provider to be removed. Must not be null. If the specified key provider is not registerred, this method will have no effect.

getKeyProviders

public KeyProviderInterface[] getKeyProviders()

Gets an array of all key providers registerred at this key manager.

Specified by:

getKeyProviders in interface SignerKeyManager

Specified by:

getKeyProviders in interface VerifierKeyManager

Returns:

an array of all registerred key providers, or null, if there are no registerred providers available.

getKeyProvider

public KeyProviderInterface getKeyProvider()

Returns a reference to the particular key provider that provided the verification public key to this KeyManagerImpl.

Specified by:

getKeyProvider in interface VerifierKeyManager

Returns:

a reference to the key provider that provided the verification public key, or null, if there is no such key provider.

getSubelementName

protected java.lang.String getSubelementName(int ranking)
                                      throws InitException

Gets the name of the preferred KeyInfo subelement with the specified ranking from the IXSIL keymanager properties.

Parameters:

ranking - The ranking of the preferred subelement, which name is requested. Must match interval [1,99].

Returns:

the name of the preferred KeyInfo subelement with the specified ranking, or null, if no preferred KeyInfo subelement is available for the specified ranking.

Throws:

InitException - if the IXSIL KeyInfo Properties cannot be found.

setURIResolverParameters

public void setURIResolverParameters(URIResolverParameters params)

Sets the parameters to be used by the key mananger when resolving URIs.

Specified by:

setURIResolverParameters in interface SignerKeyManager

Specified by:

setURIResolverParameters in interface VerifierKeyManager

Parameters:

params - The parameters to be set. May be null to indicate a restore of the default values. The base URI will be set to a dummy value in that case.