iaik.xml.crypto.dsig

Class SignedInfoImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.XmldsigDOMStructure

iaik.xml.crypto.dsig.SignedInfoImpl

All Implemented Interfaces:

SignedInfo, XMLStructure

public class SignedInfoImpl
extends XmldsigDOMStructure
implements SignedInfo

An implementation of the SignedInfo 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 CachedInputStream	cachedCanonicalizedData_ The canonicalized SignedInfo cache filter;
protected CanonicalizationMethod	canonicalizationMethod_ The CanonicalizationMethod.
protected String	id_ The id-attribute value.
protected List	references_ The list of ReferenceImpls.
protected AbstractSignatureMethodImpl	signatureMethod_ The SignatureMethod.

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

implMap_, state_, STATE_CREATED, STATE_MARSHALED, STATE_UNINITIALIZED, STATE_UNMARSHALED

Constructor Summary

Constructors

Constructor and Description
SignedInfoImpl(CanonicalizationMethod canonicalizationMethod, AbstractSignatureMethodImpl signatureMethod, List references, String id) Creates a new instance of this SignedInfoImpl with the specified canonicalization method, signature method, list of ReferenceImpls and id-attribute value.
SignedInfoImpl(DOMCryptoContext context, Node node) Creates a new instance of this SignedInfoImpl with the specified context and node to unmarshal from.

Method Summary

Modifier and Type	Method and Description
byte[]	calculateSignatureValue(XMLCryptoContext context, Key key) Calculates the signature value using the contained SignatureValue.
protected InputStream	canonicalize(XMLCryptoContext context) Canonicalizes this SignedInfo element using the contained CanonicalizationMethod.
void	generateReferences(DOMCryptoContext context) Generates each Reference in this SignedInfo by calling ReferenceImpl.generateReference(DOMCryptoContext) for each Reference.
CanonicalizationMethod	getCanonicalizationMethod() Returns the canonicalization method of this SignedInfo.
InputStream	getCanonicalizedData() Returns the canonicalized signed info bytes after a signing or validation operation.
protected List	getChildStructures() Returns the contained CanonicalizationMethod, SignatureMethod and References.
String	getId() Returns the optional Id attribute of this SignedInfo.
String	getLocalName() Returns the local name of the represented XML element.
List	getReferences() Returns an unmodifiable list of one or more References.
SignatureMethod	getSignatureMethod() Returns the signature method of this SignedInfo.
protected Attr	marshalIDAttribute(DOMCryptoContext context, Element parent) Marshals the XML representation of an optional Id-attribute represented by this DOMStructure.
protected void	putChildStructure(DOMStructure childStructure) Puts the contained CanonicalizationMethod, SignatureMethod and References.
protected void	unmarshalAttributes(NamedNodeMap attributes, DOMCryptoContext context) Unmarshals the Id-attribute.
boolean	validateReferences(XMLValidateContext validateContext) Validates each Reference in this SignedInfo by calling ReferenceImpl.validate(XMLValidateContext) for each Reference.
boolean	validateSignatureValue(XMLCryptoContext context, byte[] value, Key key) Validate the signature value using the contained SignatureMethod.

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

getNamespace, init

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, marshal, marshalAttributes, marshalElement, newIDforLookUp, putImplClass, setBackToCompatibilityPrior1_14, setNode, setParentStructure, toString, unmarshal, unmarshalElement, unmarshalIDAttribute, unmarshalStructures, 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.XMLStructure

isFeatureSupported

Field Detail

id_

protected String id_

The id-attribute value.

canonicalizationMethod_

protected CanonicalizationMethod canonicalizationMethod_

The CanonicalizationMethod. (may not be null)

signatureMethod_

protected AbstractSignatureMethodImpl signatureMethod_

The SignatureMethod. (may not be null)

references_

protected List references_

The list of ReferenceImpls. (may not be null)

cachedCanonicalizedData_

protected CachedInputStream cachedCanonicalizedData_

The canonicalized SignedInfo cache filter;

Constructor Detail

SignedInfoImpl

public SignedInfoImpl(DOMCryptoContext context,
                      Node node)
               throws MarshalException

Creates a new instance of this SignedInfoImpl 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

SignedInfoImpl

public SignedInfoImpl(CanonicalizationMethod canonicalizationMethod,
                      AbstractSignatureMethodImpl signatureMethod,
                      List references,
                      String id)

Creates a new instance of this SignedInfoImpl with the specified canonicalization method, signature method, list of ReferenceImpls and id-attribute value.

Parameters:

canonicalizationMethod - the canonicalization method

signatureMethod - the signature method

references - a list of ReferenceImpls

id - the id-attribute value (may be null)

Throws:

NullPointerException - if canonicalizationMethod, signatureMethod or references is null

IllegalArgumentException - if references is empty

ClassCastException - if any of the references is not of type ReferenceImpl

Method Detail

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()

getCanonicalizationMethod

public CanonicalizationMethod getCanonicalizationMethod()

Description copied from interface: javax.xml.crypto.dsig.SignedInfo

Returns the canonicalization method of this SignedInfo.

Specified by:

getCanonicalizationMethod in interface SignedInfo

Returns:

the canonicalization method

See Also:

SignedInfo.getCanonicalizationMethod()

getSignatureMethod

public SignatureMethod getSignatureMethod()

Description copied from interface: javax.xml.crypto.dsig.SignedInfo

Returns the signature method of this SignedInfo.

Specified by:

getSignatureMethod in interface SignedInfo

Returns:

the signature method

See Also:

SignedInfo.getSignatureMethod()

getReferences

public List getReferences()

Description copied from interface: javax.xml.crypto.dsig.SignedInfo

Returns an unmodifiable list of one or more References.

Specified by:

getReferences in interface SignedInfo

Returns:

an unmodifiable list of one or more References

See Also:

SignedInfo.getReferences()

getId

public String getId()

Description copied from interface: javax.xml.crypto.dsig.SignedInfo

Returns the optional Id attribute of this SignedInfo.

Specified by:

getId in interface SignedInfo

Returns:

the id (may be null if not specified)

See Also:

SignedInfo.getId()

getCanonicalizedData

public InputStream getCanonicalizedData()

Description copied from interface: javax.xml.crypto.dsig.SignedInfo

Returns the canonicalized signed info bytes after a signing or validation operation. This method is useful for debugging.

Specified by:

getCanonicalizedData in interface SignedInfo

Returns:

an InputStream containing the canonicalized bytes, or null if this SignedInfo has not been signed or validated yet

See Also:

SignedInfo.getCanonicalizedData()

getChildStructures

protected List getChildStructures()

Returns the contained CanonicalizationMethod, SignatureMethod and References.

Overrides:

getChildStructures in class DOMStructure

Returns:

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

putChildStructure

protected void putChildStructure(DOMStructure childStructure)
                          throws MarshalException

Puts the contained CanonicalizationMethod, SignatureMethod and References.

Overrides:

putChildStructure in class DOMStructure

Parameters:

childStructure - the unmarshalled child structure

Throws:

MarshalException

marshalIDAttribute

protected Attr marshalIDAttribute(DOMCryptoContext context,
                                  Element parent)

Description copied from class: DOMStructure

Marshals the XML representation of an optional Id-attribute represented by this DOMStructure.

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

A subclass has to overwrite this method in order to marshal an Id-attribute.

Overrides:

marshalIDAttribute in class DOMStructure

Parameters:

context - the marshal context

parent - the element is the parent of the attribute node created however, an the attribute node is not a child of it's parent element. see XPath.

Returns:

the marshaled Id-attribute if any, otherwise null

See Also:

DOMStructure.marshalIDAttribute(DOMCryptoContext, Element)

unmarshalAttributes

protected void unmarshalAttributes(NamedNodeMap attributes,
                                   DOMCryptoContext context)
                            throws MarshalException

Unmarshals the Id-attribute.

Overrides:

unmarshalAttributes in class DOMStructure

Parameters:

attributes - the Attributes to unmarshal

context - the marshal context

Throws:

MarshalException - if an exception occurs during unmarshaling

validateReferences

public boolean validateReferences(XMLValidateContext validateContext)
                           throws XMLSignatureException

Validates each Reference in this SignedInfo by calling ReferenceImpl.validate(XMLValidateContext) for each Reference.

Parameters:

validateContext - the validation context

Returns:

true if all references are valid, or else false

Throws:

XMLSignatureException - if an unexpected exception occurs during validation

generateReferences

public void generateReferences(DOMCryptoContext context)
                        throws XMLSignatureException,
                               MarshalException

Generates each Reference in this SignedInfo by calling ReferenceImpl.generateReference(DOMCryptoContext) for each Reference.

Parameters:

context - the marshal context

Throws:

XMLSignatureException - if an unexpected exception occurs during generation

MarshalException - if an exception occurs during marshaling

canonicalize

protected InputStream canonicalize(XMLCryptoContext context)
                            throws XMLSignatureException

Canonicalizes this SignedInfo element using the contained CanonicalizationMethod.

Parameters:

context - the context

Returns:

the canonicalized SignedInfo element

Throws:

XMLSignatureException - if an unexpected exception occurs during canonicalization

calculateSignatureValue

public byte[] calculateSignatureValue(XMLCryptoContext context,
                                      Key key)
                               throws XMLSignatureException

Calculates the signature value using the contained SignatureValue.

Parameters:

context - the context

key - the signing key

Returns:

the raw signature value

Throws:

XMLSignatureException - if an unexpected exception occurs during the signature value calculation

validateSignatureValue

public boolean validateSignatureValue(XMLCryptoContext context,
                                      byte[] value,
                                      Key key)
                               throws XMLSignatureException

Validate the signature value using the contained SignatureMethod.

Parameters:

context - the context

value - the raw signature value

key - the verifying key

Returns:

true if the signature is valid, false otherwise

Throws:

XMLSignatureException - if an unexpected exception occurs during the signature value validation