iaik.xml.crypto.enc.keyinfo

Class AgreementMethodImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dsig.AlgorithmMethodImpl

iaik.xml.crypto.enc.keyinfo.AgreementMethodImpl

All Implemented Interfaces:

AlgorithmMethod, AgreementMethod, XMLStructure

public class AgreementMethodImpl
extends AlgorithmMethodImpl
implements AgreementMethod

An implementation of the AgreementMethod element that supports the DOM XML representation and processing mechanism.

Nested Class Summary

Nested classes/interfaces inherited from class iaik.xml.crypto.dom.DOMStructure

DOMStructure.NodeWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected DigestMethodImpl	digestMethod_ The DigestMethod
protected KANonceImpl	kaNonce_ The KA-Nonce.
protected KeyInfoImpl	originiatorKeyInfo_ The OriginatorKeyInfo.
protected KeyInfoImpl	recipientKeyInfo_ The RecipientKeyInfo.

Fields inherited from class iaik.xml.crypto.dsig.AlgorithmMethodImpl

algorithm_, params_, spec_

Fields inherited from class iaik.xml.crypto.dom.DOMStructure

implMap_, state_, STATE_CREATED, STATE_MARSHALED, STATE_UNINITIALIZED, STATE_UNMARSHALED

Fields inherited from interface javax.xml.crypto.enc.keyinfo.AgreementMethod

DH

Constructor Summary

Constructors

Constructor and Description
AgreementMethodImpl(DOMCryptoContext context, Node node) Creates a new instance of this AgreementMethodImpl with the specified context and node to unmarshal from.
AgreementMethodImpl(String algorithm, byte[] kaNonce, KeyInfoImpl originiatorKeyInfo, KeyInfoImpl recipientKeyInfo, AgreementMethodParameterSpec params) Creates a new instance of this AgreementMethodImpl with the specified algorithm URI, agreement method parameters, originator KeyInfo, recipient KeyInfo and KA-Nonce.

Method Summary

Modifier and Type	Method and Description
protected byte[]	generateAgreedSecret(PrivateKey privKey, PublicKey pubKey, String algorithm)
SecretKey	generateSecretKey(EncryptionMethod em, PublicKey pubKey) Generates a secret key of the type specified in EncrpytionMethod
protected void	getAlgorithmInstanceUncaught(XSecProvider.Purpose purpose)
protected List	getChildStructures() Returns the list of child structures of this DOMStructure.
byte[]	getKANonce() Returns a nonce that assures different key materials are generated.
String	getLocalName() Returns the local name of the represented XML element.
String	getNamespace() Returns the namespace URI of the represented XML element.
XMLStructure	getOriginatorKeyInfo() Returns key information from the originator used to determine the secret key.
protected Class	getParameterSpecClass()
XMLStructure	getRecipientKeyInfo() Returns key information from the recipient used to determine the secret key.
protected void	putChildStructure(DOMStructure childStructure) Put an unmarshalled child structure.
void	setPrivateKey(PrivateKey key)
protected void	unmarshalStructures(NodeList nodes, DOMCryptoContext context) Unmarshals DOMStructures from the given nodes.

Methods inherited from class iaik.xml.crypto.dsig.AlgorithmMethodImpl

containsElements, getAlgorithm, getAlgorithmInstance, getParameterSpec, getParamInstanceUncaught, marshal, marshalAttributes, unmarshalAttributes

Methods inherited from class iaik.xml.crypto.dom.DOMStructure

addBytesToElement, addBytesToElement, clearMarshalling, clearMarshalling, getBytesFromElement, getBytesFromElementStream, getChildStructureVersion, getHere, getImplClass, getInstance, getInstance, getNode, getParentStructure, getParentStructureOf, getQualifiedName, getQualifiedName, hasNSDeclAttrInScope, isFeatureSupported, isNSDeclInScope, marshalElement, marshalIDAttribute, newIDforLookUp, putImplClass, setBackToCompatibilityPrior1_14, setNode, setParentStructure, toString, unmarshal, unmarshalElement, unmarshalIDAttribute, wrapNode

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.crypto.enc.keyinfo.AgreementMethod

getParameterSpec

Methods inherited from interface javax.xml.crypto.AlgorithmMethod

getAlgorithm

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Field Detail

originiatorKeyInfo_

protected KeyInfoImpl originiatorKeyInfo_

The OriginatorKeyInfo.

recipientKeyInfo_

protected KeyInfoImpl recipientKeyInfo_

The RecipientKeyInfo.

kaNonce_

protected KANonceImpl kaNonce_

The KA-Nonce.

digestMethod_

protected DigestMethodImpl digestMethod_

The DigestMethod

Constructor Detail

AgreementMethodImpl

public AgreementMethodImpl(DOMCryptoContext context,
                           Node node)
                    throws MarshalException

Creates a new instance of this AgreementMethodImpl with the specified context and node to unmarshal from.

Parameters:

context - the context

node - the node to unmarshal from

Throws:

MarshalException - if an exception occurs during unmarshaling

AgreementMethodImpl

public AgreementMethodImpl(String algorithm,
                           byte[] kaNonce,
                           KeyInfoImpl originiatorKeyInfo,
                           KeyInfoImpl recipientKeyInfo,
                           AgreementMethodParameterSpec params)
                    throws NoSuchAlgorithmException,
                           InvalidAlgorithmParameterException

Creates a new instance of this AgreementMethodImpl with the specified algorithm URI, agreement method parameters, originator KeyInfo, recipient KeyInfo and KA-Nonce.

Parameters:

algorithm - the algorithm URI (must be RFC 2396 compliant)

kaNonce - the KA-Nonce (may be null)

originiatorKeyInfo - the originator KeyInfo (may be null)

recipientKeyInfo - the recipient KeyInfo (may be null)

params - the agreement method parameters (may be null)

Throws:

NullPointerException - if config or algorithm is null

NoSuchAlgorithmException - if algorithm is not supported

InvalidAlgorithmParameterException

InvalidAlgorithmParameterException - if the given algorithm specific parameters are not appropriate for the specified algorithm

Method Detail

getAlgorithmInstanceUncaught

protected void getAlgorithmInstanceUncaught(XSecProvider.Purpose purpose)
                                     throws NoSuchAlgorithmException

Specified by:

getAlgorithmInstanceUncaught in class AlgorithmMethodImpl

Throws:

NoSuchAlgorithmException

getLocalName

public String getLocalName()

Description copied from class: DOMStructure

Returns the local name of the represented XML element.

Specified by:

getLocalName in class DOMStructure

Returns:

the local name of the represented XML element

See Also:

DOMStructure.getLocalName()

getKANonce

public byte[] getKANonce()

Description copied from interface: javax.xml.crypto.enc.keyinfo.AgreementMethod

Returns a nonce that assures different key materials are generated. Each invocation of this method returns a new clone.

Specified by:

getKANonce in interface AgreementMethod

Returns:

a nonce, or null if not specified

See Also:

AgreementMethod.getKANonce()

getOriginatorKeyInfo

public XMLStructure getOriginatorKeyInfo()

Description copied from interface: javax.xml.crypto.enc.keyinfo.AgreementMethod

Returns key information from the originator used to determine the secret key. The marshalling method should ensure that the OriginatorKeyInfo belongs to the xenc namespace.

Specified by:

getOriginatorKeyInfo in interface AgreementMethod

Returns:

a KeyInfo or null if not specified

See Also:

AgreementMethod.getOriginatorKeyInfo()

getRecipientKeyInfo

public XMLStructure getRecipientKeyInfo()

Description copied from interface: javax.xml.crypto.enc.keyinfo.AgreementMethod

Returns key information from the recipient used to determine the secret key. The marshalling method should ensure that the OriginatorKeyInfo belongs to the xenc namespace.

Specified by:

getRecipientKeyInfo in interface AgreementMethod

Returns:

a KeyInfo or null if not specified

See Also:

AgreementMethod.getRecipientKeyInfo()

getNamespace

public String getNamespace()

Description copied from class: DOMStructure

Returns the namespace URI of the represented XML element.

Specified by:

getNamespace in class DOMStructure

Returns:

the namespace URI of the represented XML element

See Also:

DOMStructure.getNamespace()

unmarshalStructures

protected void unmarshalStructures(NodeList nodes,
                                   DOMCryptoContext context)
                            throws MarshalException

Description copied from class: DOMStructure

Unmarshals DOMStructures from the given nodes.

This method is called by DOMStructure.unmarshal(DOMCryptoContext).

This method calls DOMStructure.getInstance(Node, DOMCryptoContext) for every Element in the list of nodes. If DOMStructure.getInstance(Node, DOMCryptoContext) returns a DOMStructure DOMStructure.putChildStructure(DOMStructure) is called with the returned DOMStructure as parameter.

Overrides:

unmarshalStructures in class AlgorithmMethodImpl

Parameters:

nodes - the nodes to unmarshal from

context - the marshal context

Throws:

MarshalException - if an exception occurs during marshaling

See Also:

DOMStructure.unmarshalStructures(NodeList, DOMCryptoContext)

getChildStructures

protected List getChildStructures()

Description copied from class: DOMStructure

Returns the list of child structures of this DOMStructure.

This method is called by DOMStructure.marshal(DOMCryptoContext, Node, Node).

A subclass has to overwrite this method to return a list of DOMStrucutres represented by this subclass.

Overrides:

getChildStructures in class DOMStructure

Returns:

a list of DOMStructures (may be empty, but never null)

See Also:

DOMStructure.getChildStructures()

putChildStructure

protected void putChildStructure(DOMStructure childStructure)
                          throws MarshalException

Description copied from class: DOMStructure

Put an unmarshalled child structure.

This method is called by DOMStructure.unmarshalStructures(NodeList, DOMCryptoContext) for every unmarshalled child structure.

A subclass has to overwrite this method to store the given child structure in its the corresponding field.

Overrides:

putChildStructure in class DOMStructure

Parameters:

childStructure - the unmarshalled child structure

Throws:

MarshalException

See Also:

DOMStructure.putChildStructure(iaik.xml.crypto.dom.DOMStructure)

generateSecretKey

public SecretKey generateSecretKey(EncryptionMethod em,
                                   PublicKey pubKey)
                            throws XMLEncryptionException

Generates a secret key of the type specified in EncrpytionMethod

Parameters:

em - The EncryptionMethod, the generated key will be used with

pubKey -

Throws:

XMLEncryptionException

generateAgreedSecret

protected byte[] generateAgreedSecret(PrivateKey privKey,
                                      PublicKey pubKey,
                                      String algorithm)
                               throws XMLEncryptionException

Throws:

XMLEncryptionException

setPrivateKey

public void setPrivateKey(PrivateKey key)

getParameterSpecClass

protected Class getParameterSpecClass()

Specified by:

getParameterSpecClass in class AlgorithmMethodImpl

Returns:

the Class of the concrete parameter spec to be returned by AlgorithmMethodImpl.getParameterSpec().

Since:

1.17

See Also:

AlgorithmMethodImpl.getParameterSpecClass()