iaik.ixsil.keyinfo

Class KeyProviderImplKeyValue

java.lang.Object

iaik.ixsil.keyinfo.KeyProviderImplKeyValue

All Implemented Interfaces:

KeyProviderInterface

public class KeyProviderImplKeyValue
extends java.lang.Object
implements KeyProviderInterface

This class implements the KeyProviderInterface for KeyValue key information hints. A KeyValue key information hint contains the encoded public key fitting for the public key cryptography algorithm used as the signature algorithm for the XML signature. Public keys for the RSA, DSA and EC algorithm are supported by this implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DSA_JCA_ALGID_ The identifier used for DSA keys within the Java Cryptography Architecture.
protected static java.lang.String	EC_JCA_ALGID_ The identifier used for EC keys within the Java Cryptography Architecture.
protected static java.lang.String	RSA_JCA_ALGID_ The identifier used for RSA keys within the Java Cryptography Architecture.
protected org.w3c.dom.Document	signatureDOMDoc_ The DOM document bearing the XML signature.
protected java.security.Key	verifierKey_ The key to be used for verification.

Constructor Summary

Constructors

Constructor and Description
KeyProviderImplKeyValue() This constructor will be used by the KeyManagerImpl class in the verification use case.
KeyProviderImplKeyValue(org.w3c.dom.Document signatureDOMDoc) This constructor can be used by the application in the signature creation use case to create a new instance of this key provider.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	bigInteger2Base64(java.math.BigInteger bigPositiveInt) Gets the base64 encoded byte representation of a BigInteger, excluding the sign bit.
protected byte[]	getBase64DecodedText(org.w3c.dom.Element parent) Gets the base64 decoded bytes from the first DOM Text child of the specified DOM element.
protected org.w3c.dom.Element	getChildElement(org.w3c.dom.Element parent, java.lang.String localName) Gets the child DOM element with the specified local name of the specified parent DOM element.
protected org.w3c.dom.Element	getChildElement(org.w3c.dom.Element parent, java.lang.String namespaceURI, java.lang.String localName) Gets the child DOM element with the specified name space and local name of the specified parent DOM element.
org.w3c.dom.Element[]	getKeyInfoSubelements() Produdes a single key information hint (KeyValue subelement) as representation of the verification key, which has been set previously by the application.
java.security.Key	getVerifierKey() Provides the key to be used for verification.
void	setKeyInfoSubelements(org.w3c.dom.Element[] keyValueSubelements) Analyzes the first of the specified KeyInfo subelements of type KeyValue and tries to create either a RSAPublicKey, DSAPublicKey or a ECPublicKey from that info.
void	setURIResolverParameters(URIResolverParameters params) Sets the parameters to be used by the key provider when resolving URIs.
void	setVerifierKey(java.security.Key verifierKey) Can be used by the application in the signature creation use case, in order to provide the verification key, for which a key information hint (KeyValue subelement of the KeyInfo element) should be incorporated into the XML signature.

Methods inherited from class java.lang.Object

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

Field Detail

DSA_JCA_ALGID_

protected static final java.lang.String DSA_JCA_ALGID_

The identifier used for DSA keys within the Java Cryptography Architecture.

See Also:

Constant Field Values

RSA_JCA_ALGID_

protected static final java.lang.String RSA_JCA_ALGID_

The identifier used for RSA keys within the Java Cryptography Architecture.

See Also:

Constant Field Values

EC_JCA_ALGID_

protected static final java.lang.String EC_JCA_ALGID_

The identifier used for EC keys within the Java Cryptography Architecture.

See Also:

Constant Field Values

verifierKey_

protected java.security.Key verifierKey_

The key to be used for verification.

signatureDOMDoc_

protected org.w3c.dom.Document signatureDOMDoc_

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

Constructor Detail

KeyProviderImplKeyValue

public KeyProviderImplKeyValue()

This constructor will be used by the KeyManagerImpl class in the verification use case.

KeyProviderImplKeyValue

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

This constructor can be used by the application in the signature creation use case to create a new instance of this key provider. After instantiation, the application must configure this key provider with the fitting methods provided by this class.

Parameters:

signatureDOMDoc - The DOM document bearing the XML signature. Used in method getKeyInfoSubelements() to create DOM nodes. Must not be null.

Method Detail

getVerifierKey

public java.security.Key getVerifierKey()
                                 throws KeyProviderException

Provides the key to be used for verification.

Specified by:

getVerifierKey in interface KeyProviderInterface

Returns:

the verification key deduced from the key information hint named KeyValue.

Throws:

KeyProviderException - if the verification key cannot be deduced from the key information hint.

getKeyInfoSubelements

public org.w3c.dom.Element[] getKeyInfoSubelements()
                                            throws KeyProviderException

Produdes a single key information hint (KeyValue subelement) as representation of the verification key, which has been set previously by the application. If no verification key has been set, this method returns an array with 0 elements.

Specified by:

getKeyInfoSubelements in interface KeyProviderInterface

Returns:

an array with a single KeyValue element as representation of the verification key, or an array of length 0 if no verification key has been set.

Throws:

KeyProviderException - if the wrong constructor has been used by the application, and therefore no DOM Document has been specified.

setURIResolverParameters

public void setURIResolverParameters(URIResolverParameters params)

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

Specified by:

setURIResolverParameters in interface KeyProviderInterface

Parameters:

params - The parameters to be set. May be null to indicate a restore of the default values.

setKeyInfoSubelements

public void setKeyInfoSubelements(org.w3c.dom.Element[] keyValueSubelements)
                           throws KeyProviderException

Analyzes the first of the specified KeyInfo subelements of type KeyValue and tries to create either a RSAPublicKey, DSAPublicKey or a ECPublicKey from that info. If more than one KeyValue subelements have been specified, all but the first will be ignored.

If non of RSAPublicKey , DSAPublicKey or ECPublicKey can be created from the first KeyValue element, this method will have no effect.

Specified by:

setKeyInfoSubelements in interface KeyProviderInterface

Parameters:

keyValueSubelements - an array of KeyValue elements. The array must contain at least one entry.

Throws:

KeyProviderException - if neither a RSAPublicKey nor DSAPublicKey nore a nor ECPublicKey can be deduced from the information given in the first element of the array.

setVerifierKey

public void setVerifierKey(java.security.Key verifierKey)

Can be used by the application in the signature creation use case, in order to provide the verification key, for which a key information hint (KeyValue subelement of the KeyInfo element) should be incorporated into the XML signature.

Parameters:

verifierKey - The verification key. May be null. If not null, it must be an instance of either RSAPublicKey or DSAPublicKey or ECPublicKey.

bigInteger2Base64

protected java.lang.String bigInteger2Base64(java.math.BigInteger bigPositiveInt)

Gets the base64 encoded byte representation of a BigInteger, excluding the sign bit.

Parameters:

bigPositiveInt - A positive BigInteger.

Returns:

the base64 encoded byte representation of the specified BigInteger.

getChildElement

protected org.w3c.dom.Element getChildElement(org.w3c.dom.Element parent,
                                              java.lang.String localName)
                                       throws KeyProviderException

Gets the child DOM element with the specified local name of the specified parent DOM element.

Parameters:

parent - The parent DOM element.

localName - The local tag name of the element, which must be in the XML Signature namespace.

Returns:

the child DOM element with the specified local name.

Throws:

KeyProviderException - if the specified child DOM element cannot be found.

getChildElement

protected org.w3c.dom.Element getChildElement(org.w3c.dom.Element parent,
                                              java.lang.String namespaceURI,
                                              java.lang.String localName)
                                       throws KeyProviderException

Gets the child DOM element with the specified name space and local name of the specified parent DOM element.

Parameters:

parent - The parent DOM element.

namespaceURI - The XML Signature namespace.

localName - The local tag name of the element.

Returns:

the child DOM element with the specified local name.

Throws:

KeyProviderException - if the specified child DOM element cannot be found.

getBase64DecodedText

protected byte[] getBase64DecodedText(org.w3c.dom.Element parent)
                               throws KeyProviderException

Gets the base64 decoded bytes from the first DOM Text child of the specified DOM element.

Parameters:

parent - The DOM element containing the DOM Text child.

Returns:

the base64 decoded bytes from the first DOM Text child in the specified DOM element.

Throws:

KeyProviderException - if no Text child can be found, or if the content of the Text child cannot be base64 decoded.