se.swedenconnect.opensaml.xmlsec.encryption

Interface ConcatKDFParams

All Superinterfaces:

XMLObject

All Known Implementing Classes:

ConcatKDFParamsImpl

public interface ConcatKDFParams
extends XMLObject

Representation of the ConcatKDF key derivation method.

 
 <element name="ConcatKDFParams" type="xenc11:ConcatKDFParamsType"/>
 
 <complexType name="ConcatKDFParamsType">
   <sequence>
     <element ref="ds:DigestMethod"/>
   </sequence>
   <attribute name="AlgorithmID" type="hexBinary"/>
   <attribute name="PartyUInfo" type="hexBinary"/>
   <attribute name="PartyVInfo" type="hexBinary"/>
   <attribute name="SuppPubInfo" type="hexBinary"/>
   <attribute name="SuppPrivInfo" type="hexBinary"/
 </complexType>
 

The AlgorithmID, PartyUInfo, PartyVInfo, SuppPubInfo and SuppPrivInfo attributes are all defined as arbitrary-length bitstrings, thus they may need to be padded in order to be encoded into hexBinary for XML Encryption. The following padding and encoding method must be used when encoding bitstring values for the AlgorithmID, PartyUInfo, PartyVInfo, SuppPubInfo and SuppPrivInfo:

1. The bitstring is divided into octets using big-endian encoding. If the length of the bitstring is not a multiple of 8 then add padding bits (value 0) as necessary to the last octet to make it a multiple of 8.
2. Prepend one octet to the octets string from step 1. This octet shall identify (in a big-endian representation) the number of padding bits added to the last octet in step 1.
3. Encode the octet string resulting from step 2 as a hexBinary string.

Example: the bitstring 11011, which is 5 bits long, gets 3 additional padding bits to become the bitstring 11011000 (or D8 in hex). This bitstring is then prepended with one octet identifying the number of padding bits to become the octet string (in hex) 03D8, which then finally is encoded as a hexBinary string value of "03D8".

Author:

Martin Lindström (martin@idsec.se), Stefan Santesson (stefan@idsec.se)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALGORITHMID_ATTRIBUTE_NAME AlgorithmID attribute name.
static String	DEFAULT_ELEMENT_LOCAL_NAME Element local name.
static QName	DEFAULT_ELEMENT_NAME Default element name.
static String	PARTY_UI_NFO_ATTRIBUTE_NAME PartyUInfo attribute name.
static String	PARTY_V_INFO_ATTRIBUTE_NAME PartyVInfo attribute name.
static String	SUPP_PRIV_INFO_ATTRIBUTE_NAME SuppPrivInfo attribute name.
static String	SUPP_PUB_INFO_ATTRIBUTE_NAME SuppPubInfo attribute name.
static String	TYPE_LOCAL_NAME Local name of the XSI type.
static QName	TYPE_NAME QName of the XSI type.

Method Summary

Modifier and Type	Method and Description
byte[]	getAlgorithmID() Gets the AlgorithmID attribute in its padded and encoded form.
DigestMethod	getDigestMethod() Gets the digest method.
byte[]	getPartyUInfo() Gets the PartyUInfo attribute in its padded and encoded form.
byte[]	getPartyVInfo() Gets the PartyVInfo attribute in its padded and encoded form.
byte[]	getSuppPrivInfo() Gets the SuppPrivInfo attribute in its padded and encoded form.
byte[]	getSuppPubInfo() Gets the SuppPubInfo attribute in its padded and encoded form.
void	setAlgorithmID(byte[] algorithmID) Sets the AlgorithmID attribute.
void	setDigestMethod(DigestMethod digestMethod) Sets the digest method.
void	setPartyUInfo(byte[] partyUInfo) Sets the PartyUInfo attribute.
void	setPartyVInfo(byte[] partyVInfo) Sets the PartyVInfo attribute.
void	setSuppPrivInfo(byte[] suppPrivInfo) Sets the SuppPrivInfo attribute.
void	setSuppPubInfo(byte[] suppPubInfo) Sets the SuppPubInfo attribute.

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Detail

DEFAULT_ELEMENT_LOCAL_NAME

static final String DEFAULT_ELEMENT_LOCAL_NAME

Element local name.

See Also:

Constant Field Values

DEFAULT_ELEMENT_NAME

static final QName DEFAULT_ELEMENT_NAME

Default element name.

TYPE_LOCAL_NAME

static final String TYPE_LOCAL_NAME

Local name of the XSI type.

See Also:

Constant Field Values

TYPE_NAME

static final QName TYPE_NAME

QName of the XSI type.

ALGORITHMID_ATTRIBUTE_NAME

static final String ALGORITHMID_ATTRIBUTE_NAME

AlgorithmID attribute name.

See Also:

Constant Field Values

PARTY_UI_NFO_ATTRIBUTE_NAME

static final String PARTY_UI_NFO_ATTRIBUTE_NAME

PartyUInfo attribute name.

See Also:

Constant Field Values

PARTY_V_INFO_ATTRIBUTE_NAME

static final String PARTY_V_INFO_ATTRIBUTE_NAME

PartyVInfo attribute name.

See Also:

Constant Field Values

SUPP_PUB_INFO_ATTRIBUTE_NAME

static final String SUPP_PUB_INFO_ATTRIBUTE_NAME

SuppPubInfo attribute name.

See Also:

Constant Field Values

SUPP_PRIV_INFO_ATTRIBUTE_NAME

static final String SUPP_PRIV_INFO_ATTRIBUTE_NAME

SuppPrivInfo attribute name.

See Also:

Constant Field Values

Method Detail

getDigestMethod

DigestMethod getDigestMethod()

Gets the digest method.

Returns:

the digest method

setDigestMethod

void setDigestMethod(DigestMethod digestMethod)

Sets the digest method.

Parameters:

digestMethod - the digest method

getAlgorithmID

byte[] getAlgorithmID()

Gets the AlgorithmID attribute in its padded and encoded form.

Returns:

the AlgorithmID attribute

setAlgorithmID

void setAlgorithmID(byte[] algorithmID)

Sets the AlgorithmID attribute.

Parameters:

algorithmID - the AlgorithmID attribute in its padded and encoded form

getPartyUInfo

byte[] getPartyUInfo()

Gets the PartyUInfo attribute in its padded and encoded form.

Returns:

the PartyUInfo attribute

setPartyUInfo

void setPartyUInfo(byte[] partyUInfo)

Sets the PartyUInfo attribute.

Parameters:

partyUInfo - the PartyUInfo attribute in its padded and encoded form

getPartyVInfo

byte[] getPartyVInfo()

Gets the PartyVInfo attribute in its padded and encoded form.

Returns:

the PartyVInfo attribute

setPartyVInfo

void setPartyVInfo(byte[] partyVInfo)

Sets the PartyVInfo attribute.

Parameters:

partyVInfo - the PartyVInfo attribute in its padded and encoded form

getSuppPubInfo

byte[] getSuppPubInfo()

Gets the SuppPubInfo attribute in its padded and encoded form.

Returns:

the SuppPubInfo attribute

setSuppPubInfo

void setSuppPubInfo(byte[] suppPubInfo)

Sets the SuppPubInfo attribute.

Parameters:

suppPubInfo - the SuppPubInfo attribute in its padded and encoded form

getSuppPrivInfo

byte[] getSuppPrivInfo()

Gets the SuppPrivInfo attribute in its padded and encoded form.

Returns:

the SuppPrivInfo attribute

setSuppPrivInfo

void setSuppPrivInfo(byte[] suppPrivInfo)

Sets the SuppPrivInfo attribute.

Parameters:

suppPrivInfo - the SuppPrivInfo attribute in its padded and encoded form