Module org.apache.santuario.xmlsec

Package org.apache.xml.security.encryption.keys.content

Class AgreementMethodImpl

java.lang.Object

org.apache.xml.security.utils.ElementProxy

org.apache.xml.security.utils.EncryptionElementProxy

org.apache.xml.security.encryption.keys.content.AgreementMethodImpl

All Implemented Interfaces:

AgreementMethod, KeyInfoContent

public class AgreementMethodImpl
extends EncryptionElementProxy
implements KeyInfoContent, AgreementMethod

The implementation of the AgreementMethod interface. The element contains information about the key agreement algorithm for deriving the encryption key.

Field Summary

Fields

Modifier and Type	Field	Description
private List<Element>	agreementMethodInformation
private String	algorithmURI
private byte[]	kaNonce
private KeyDerivationMethod	keyDerivationMethod
protected static final System.Logger	LOG
private OriginatorKeyInfo	originatorKeyInfo
private RecipientKeyInfo	recipientKeyInfo

Fields inherited from class org.apache.xml.security.utils.ElementProxy

baseURI

Constructor Summary

Constructors

Constructor	Description
AgreementMethodImpl(Document doc, String algorithm)	Constructor AgreementMethodImpl for generating AgreementMethod from scratch based on algorithm URI.
AgreementMethodImpl(Document doc, KeyAgreementParameters keyAgreementParameter)	Constructor AgreementMethodImpl for generating AgreementMethod from scratch based on KeyAgreementParameters.
AgreementMethodImpl(Element element)	Constructor AgreementMethodImpl based on XML Element.

Method Summary

Modifier and Type	Method	Description
void	addAgreementMethodInformation(Element info)	Adds additional AgreementMethod information.
private KeyDerivationMethod	createKeyDerivationMethod(KeyAgreementParameters keyAgreementParameter)	Method creates a KeyDerivationMethod element based on parameters: KeyAgreementParameters.
Iterator<Element>	getAgreementMethodInformation()	Returns additional information regarding the AgreementMethod.
String	getAlgorithm()	Returns the algorithm URI of this CryptographicMethod.
String	getBaseLocalName()	Returns the localname of the Elements of the sub-class.
private ConcatKDFParamsImpl	getConcatKDFParams(KeyDerivationParameters parameter)	Method creates a ConcatKDFParamsImpl based on ConcatKDFParams.
private HKDFParamsImpl	getHKDFParams(KeyDerivationParameters parameter)	Method creates a HKDFParamsImpl based on HKDFParams.
byte[]	getKANonce()	Returns a byte array.
KeyDerivationMethod	getKeyDerivationMethod()	Returns KeyDerivationMethod information used in the AgreementMethod.
OriginatorKeyInfo	getOriginatorKeyInfo()	Returns information relating to the originator's shared secret.
RecipientKeyInfo	getRecipientKeyInfo()	Returns information relating to the recipient's shared secret.
void	removeAgreementMethodInformation(Element info)	Removes additional AgreementMethod information.
void	setKANonce(byte[] kanonce)	Sets the KANonce.jj
void	setKeyDerivationMethod(KeyDerivationMethod keyDerivationMethod)	This method is used to set the KeyDerivationMethod when the AgreementMethod is being used to derive a key.
void	setOriginatorKeyInfo(OriginatorKeyInfo keyInfo)	Sets the information relating to the originator's shared secret.
void	setOriginatorPublicKey(PublicKey publicKey)	Sets the originator's PublicKey to generate the secret
void	setRecipientKeyInfo(RecipientKeyInfo keyInfo)	Sets the information relating to the recipient's shared secret.

Methods inherited from class org.apache.xml.security.utils.EncryptionElementProxy

getBaseNamespace

Methods inherited from class org.apache.xml.security.utils.ElementProxy

addBase64Element, addBase64Text, addBigIntegerElement, addReturnToSelf, addText, addTextElement, appendOther, appendSelf, appendSelf, createElementForFamily, createElementForFamilyLocal, createText, getBaseURI, getBigIntegerFromChildElement, getBytesFromTextChild, getDefaultPrefix, getDocument, getElement, getElementPlusReturns, getFirstChild, getLocalAttribute, getTextFromChildElement, getTextFromTextChild, length, registerDefaultPrefixes, setDefaultPrefix, setDocument, setElement, setElement, setLocalAttribute, setLocalIdAttribute, setXPathNamespaceContext

Methods inherited from class java.lang.Object

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

Field Details

LOG

protected static final System.Logger LOG

kaNonce

private byte[] kaNonce

agreementMethodInformation

private List<Element> agreementMethodInformation

keyDerivationMethod

private KeyDerivationMethod keyDerivationMethod

originatorKeyInfo

private OriginatorKeyInfo originatorKeyInfo

recipientKeyInfo

private RecipientKeyInfo recipientKeyInfo

algorithmURI

private String algorithmURI

Constructor Details

AgreementMethodImpl

public AgreementMethodImpl(Document doc,
 KeyAgreementParameters keyAgreementParameter)
                    throws XMLEncryptionException

Constructor AgreementMethodImpl for generating AgreementMethod from scratch based on KeyAgreementParameters. The constructor generates KeyDerivationMethod if given and OriginatorKeyInfo based on originator public key for ECDH-ES key agreement. It generates a placeholder element for RecipientKeyInfo. The recipient key info value must be set later.

Parameters:

doc - the Document in which AgreementMethod will be placed

keyAgreementParameter - the KeyAgreementParameters from which AgreementMethod will be generated

Throws:

XMLEncryptionException - if the Key derivation algorithm is not supported or invalid parameters are given.

AgreementMethodImpl

public AgreementMethodImpl(Document doc,
 String algorithm)

Constructor AgreementMethodImpl for generating AgreementMethod from scratch based on algorithm URI. The constructor builds a placeholder element for KeyDerivationMethod, OriginatorKeyInfo and RecipientKeyInfo. The values for these elements must be set later.

Parameters:

algorithm - the algorithm URI for the key agreement algorithm

AgreementMethodImpl

public AgreementMethodImpl(Element element)
                    throws XMLSecurityException

Constructor AgreementMethodImpl based on XML Element.

Parameters:

element - the XML Element containing AgreementMethod information

Throws:

XMLSecurityException - if the AgreementMethod element has invalid XML structure

Method Details

getKANonce

public byte[] getKANonce()

Returns a byte array.

Specified by:

getKANonce in interface AgreementMethod

Returns:

a byte array.

setKANonce

public void setKANonce(byte[] kanonce)

Sets the KANonce.jj

Specified by:

setKANonce in interface AgreementMethod

getAgreementMethodInformation

public Iterator<Element> getAgreementMethodInformation()

Returns additional information regarding the AgreementMethod.

Specified by:

getAgreementMethodInformation in interface AgreementMethod

Returns:

additional information regarding the AgreementMethod.

addAgreementMethodInformation

public void addAgreementMethodInformation(Element info)

Adds additional AgreementMethod information.

Specified by:

addAgreementMethodInformation in interface AgreementMethod

Parameters:

info - a Element that represents additional information specified by

removeAgreementMethodInformation

public void removeAgreementMethodInformation(Element info)

Removes additional AgreementMethod information.

Specified by:

removeAgreementMethodInformation in interface AgreementMethod

Parameters:

info - a Element that represents additional information specified by

getKeyDerivationMethod

public KeyDerivationMethod getKeyDerivationMethod()
                                           throws XMLSecurityException

Returns KeyDerivationMethod information used in the AgreementMethod.

Specified by:

getKeyDerivationMethod in interface AgreementMethod

Returns:

The KeyDerivationMethod information regarding the AgreementMethod.

Throws:

XMLSecurityException

setKeyDerivationMethod

public void setKeyDerivationMethod(KeyDerivationMethod keyDerivationMethod)

This method is used to set the KeyDerivationMethod when the AgreementMethod is being used to derive a key. The KeyDerivationMethod is declared as but is used in ECDH_ES

Specified by:

setKeyDerivationMethod in interface AgreementMethod

getOriginatorKeyInfo

public OriginatorKeyInfo getOriginatorKeyInfo()
                                       throws XMLSecurityException

Returns information relating to the originator's shared secret.

Specified by:

getOriginatorKeyInfo in interface AgreementMethod

Returns:

information relating to the originator's shared secret.

Throws:

XMLSecurityException

setOriginatorKeyInfo

public void setOriginatorKeyInfo(OriginatorKeyInfo keyInfo)

Sets the information relating to the originator's shared secret.

Specified by:

setOriginatorKeyInfo in interface AgreementMethod

Parameters:

keyInfo - information relating to the originator's shared secret.

setOriginatorPublicKey

public void setOriginatorPublicKey(PublicKey publicKey)

Sets the originator's PublicKey to generate the secret

Specified by:

setOriginatorPublicKey in interface AgreementMethod

Parameters:

publicKey - originator's PublicKey

getRecipientKeyInfo

public RecipientKeyInfo getRecipientKeyInfo()
                                     throws XMLSecurityException

Returns information relating to the recipient's shared secret.

Specified by:

getRecipientKeyInfo in interface AgreementMethod

Returns:

information relating to the recipient's shared secret.

Throws:

XMLSecurityException

setRecipientKeyInfo

public void setRecipientKeyInfo(RecipientKeyInfo keyInfo)

Sets the information relating to the recipient's shared secret.

Specified by:

setRecipientKeyInfo in interface AgreementMethod

Parameters:

keyInfo - information relating to the recipient's shared secret.

getAlgorithm

public String getAlgorithm()

Returns the algorithm URI of this CryptographicMethod.

Specified by:

getAlgorithm in interface AgreementMethod

Returns:

the algorithm URI of this CryptographicMethod

getBaseLocalName

public String getBaseLocalName()

Description copied from class: ElementProxy

Returns the localname of the Elements of the sub-class.

Specified by:

getBaseLocalName in class ElementProxy

Returns:

the localname of the Elements of the sub-class.

createKeyDerivationMethod

private KeyDerivationMethod createKeyDerivationMethod(KeyAgreementParameters keyAgreementParameter)
                                               throws XMLEncryptionException

Method creates a KeyDerivationMethod element based on parameters: KeyAgreementParameters. The method supports parameter types ConcatKDFParams and HKDFParams.

Parameters:

keyAgreementParameter - the KeyAgreementParameters from which KeyDerivationMethod will be generated.

Returns:

the generated KeyDerivationMethod element based on KeyAgreementParameters

Throws:

XMLEncryptionException - if the Key derivation algorithm is not supported or invalid parameters are given.

IllegalArgumentException - if KeyAgreementParameters is missing or wrong class type for derivation algorithm

getConcatKDFParams

private ConcatKDFParamsImpl getConcatKDFParams(KeyDerivationParameters parameter)

Method creates a ConcatKDFParamsImpl based on ConcatKDFParams.

Parameters:

parameter - the KeyDerivationParameters from which ConcatKDFParamsImpl will be generated.

Returns:

the ConcatKDFParamsImpl

Throws:

IllegalArgumentException - if parameter is not instance of ConcatKDFParams

getHKDFParams

private HKDFParamsImpl getHKDFParams(KeyDerivationParameters parameter)

Method creates a HKDFParamsImpl based on HKDFParams.

Parameters:

parameter - the KeyDerivationParameters containing HKDF parameters.

Returns:

the HKDFParamsImpl

Throws:

IllegalArgumentException - if parameter is not instance of HKDFParams