iaik.xml.crypto.dsig

Class ReferenceImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dsig.DOMURIReferenceImpl

iaik.xml.crypto.dsig.ReferenceType

iaik.xml.crypto.dsig.ReferenceImpl

All Implemented Interfaces:

DOMURIReference, Reference, URIReference, XMLStructure

public class ReferenceImpl
extends ReferenceType
implements Reference, DOMURIReference

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

Nested Class Summary

Nested classes/interfaces inherited from class iaik.xml.crypto.dsig.ReferenceType

ReferenceType.SubTreeNodeSetFix

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

DOMStructure.NodeWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	calculatedDigestValue_ The calculated digest value.
protected DigestMethodImpl	digestMethod_ The DigestMethod.
protected DigestValueImpl	digestValue_ The DigestValue.
protected List	distNS_ Has the distributed NamespaceDeclarations during the processing if the Reference was built with NodeSetData as Data supplied and applied Transforms.
protected boolean	valid_ Is this Reference valid.

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

cachedCanonInputData_, cachedDereferencedData_, cachedDigestInput_, id_, result_, transforms_

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

type_, uri_

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

implMap_, state_, STATE_CREATED, STATE_MARSHALED, STATE_UNINITIALIZED, STATE_UNMARSHALED

Constructor Summary

Constructors

Modifier	Constructor and Description
	ReferenceImpl(DOMCryptoContext context, Node node) Creates a new instance of this ReferenceImpl with the specified context and node to unmarshal from.
	ReferenceImpl(String uri, DigestMethodImpl dm, List appliedTransforms, Data result, List transforms, String type, String id) Creates a Reference with the specified parameters.
	ReferenceImpl(String uri, DigestMethodImpl digestMethod, List transforms, String type, String id) Creates a new instance of this ReferenceImpl with the specified URI-attribute value, digest method, list of TransformImpls, Type-attribute value and Id-attribute value.
	ReferenceImpl(String uri, DigestMethodImpl digestMethod, List transforms, String type, String id, byte[] digestValue) Creates a new instance of this ReferenceImpl with the specified URI-attribute value, digest method, list of TransformImpls, Type-attribute value and Id-attribute value and pre-calculated digest value.
protected	ReferenceImpl(String uri, TransformsImpl transforms, String type, String id) Creates a new instance of this ReferenceImpl with the specified URI-attribute value, digest method, transforms of TransformsType containing a list of Transforms, Type-attribute value and Id-attribute value.

Method Summary

Modifier and Type	Method and Description
void	generateReference(DOMCryptoContext context) Calculates the digest value of this Reference and appends a DigestValue element with the calculated digest value.
byte[]	getCalculatedDigestValue() Returns the calculated digest value of this Reference after a validation operation.
protected List	getChildStructures() Returns the DigestMethodImpl and DigestValueImpl.
InputStream	getDigestInputStream() Returns the pre-digested input stream, if reference caching is enabled.
DigestMethod	getDigestMethod() Returns the digest method of this Reference.
byte[]	getDigestValue() Returns the digest value of this Reference.
String	getNamespace() Returns the namespace URI of the represented XML element.
protected void	putChildStructure(DOMStructure childStructure) Puts the DigestMethodImpl and DigestValueImpl.
void	setPreCalculatedDigestValue(DOMCryptoContext context, byte[] digestValue) Sets pre calculated digest value for this Reference and appends it to the DigestValue child before signature creation.
boolean	validate(XMLValidateContext validateContext) Validates this reference.
boolean	validateReference(XMLValidateContext validateContext) Validates the Reference according to the Reference Validation rules defined in XML-Signature Syntax and Processing section 3.2.2 Reference Validation .

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

dereference, dereferenceAndCanonicalize, dereferenceButDontTransform, getCanonInputData, getDereferencedData, getId, getLocalName, getTransforms, marshalIDAttribute, unmarshalAttributes

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

getHere, getType, getURI, marshalAttributes

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

addBytesToElement, addBytesToElement, clearMarshalling, clearMarshalling, getBytesFromElement, getBytesFromElementStream, getChildStructureVersion, getImplClass, getInstance, getInstance, getNode, getParentStructure, getParentStructureOf, getQualifiedName, getQualifiedName, hasNSDeclAttrInScope, isFeatureSupported, isNSDeclInScope, marshal, 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.dsig.Reference

getDereferencedData, getId, getTransforms

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Methods inherited from interface javax.xml.crypto.dom.DOMURIReference

getHere

Methods inherited from interface javax.xml.crypto.URIReference

getType, getURI

Field Detail

digestMethod_

protected DigestMethodImpl digestMethod_

The DigestMethod. (may never be null)

digestValue_

protected DigestValueImpl digestValue_

The DigestValue. (may never be null)

calculatedDigestValue_

protected byte[] calculatedDigestValue_

The calculated digest value.

valid_

protected boolean valid_

Is this Reference valid.

distNS_

protected List distNS_

Has the distributed NamespaceDeclarations during the processing if the Reference was built with NodeSetData as Data supplied and applied Transforms.

Constructor Detail

ReferenceImpl

public ReferenceImpl(DOMCryptoContext context,
                     Node node)
              throws MarshalException

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

ReferenceImpl

protected ReferenceImpl(String uri,
                        TransformsImpl transforms,
                        String type,
                        String id)

Creates a new instance of this ReferenceImpl with the specified URI-attribute value, digest method, transforms of TransformsType containing a list of Transforms, Type-attribute value and Id-attribute value.

See Also:

ReferenceType.ReferenceType(String, TransformsType, String, String)

ReferenceImpl

public ReferenceImpl(String uri,
                     DigestMethodImpl digestMethod,
                     List transforms,
                     String type,
                     String id)

Creates a new instance of this ReferenceImpl with the specified URI-attribute value, digest method, list of TransformImpls, Type-attribute value and Id-attribute value.

Parameters:

uri - the URI-attribute value (may be null)

digestMethod - the digest method

transforms - a list of TransformImpls (may be null or empty)

type - the Type-attribute value (may be null)

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

Throws:

NullPointerException - if digestMethod is null

IllegalArgumentException - if uri is not RFC 2396 compliant

ClassCastException - if any of the transforms is not of type TransformImpl

ReferenceImpl

public ReferenceImpl(String uri,
                     DigestMethodImpl digestMethod,
                     List transforms,
                     String type,
                     String id,
                     byte[] digestValue)

Creates a new instance of this ReferenceImpl with the specified URI-attribute value, digest method, list of TransformImpls, Type-attribute value and Id-attribute value and pre-calculated digest value.

Parameters:

uri - the URI-attribute value (may be null)

digestMethod - the digest method

transforms - a list of TransformImpls (may be null or empty)

type - the Type-attribute value (may be null)

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

digestValue - the pre-calculated digest value. The array is cloned to protect against subsequent modification.

Throws:

NullPointerException - if digestMethod or digestValue is null

IllegalArgumentException - if uri is not RFC 2396 compliant

ClassCastException - if any of the transforms is not of type TransformImpl

ReferenceImpl

public ReferenceImpl(String uri,
                     DigestMethodImpl dm,
                     List appliedTransforms,
                     Data result,
                     List transforms,
                     String type,
                     String id)

Creates a Reference with the specified parameters.

This method is useful when a list of transforms have already been applied to the Reference. See for example, the OASIS-DSS (Digital Signature Services) specification.

When an XMLSignature containing this reference is generated, the specified transforms (if non-null) are applied to the specified result. The Transforms element of the resulting Reference element is set to the concatenation of the appliedTransforms and transforms.

Parameters:

uri - the reference URI (may be null)

dm - the digest method

appliedTransforms - a list of Transform s that have already been applied. The list is defensively copied to protect against subsequent modification. The list must contain at least one entry.

result - the result of processing the sequence of appliedTransforms

transforms - a list of Transform s that are to be applied when generating the signature. The list is defensively copied to protect against subsequent modification. May be null or empty.

type - the reference type, as a URI (may be null)

id - the reference ID (may be null)

Throws:

ClassCastException - if any of the transforms (in either list) are not of type Transform

IllegalArgumentException - if uri is not RFC 2396 compliant or appliedTransforms is empty

NullPointerException - if dm, appliedTransforms or result is null

Method Detail

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

getDigestMethod

public DigestMethod getDigestMethod()

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

Returns the digest method of this Reference.

Specified by:

getDigestMethod in interface Reference

Returns:

the digest method

See Also:

Reference.getDigestMethod()

getDigestValue

public byte[] getDigestValue()

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

Returns the digest value of this Reference.

Specified by:

getDigestValue in interface Reference

Returns:

the raw digest value, or null if this reference has not been digested yet. Each invocation of this method returns a new clone to protect against subsequent modification.

See Also:

Reference.getDigestValue()

getCalculatedDigestValue

public byte[] getCalculatedDigestValue()

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

Returns the calculated digest value of this Reference after a validation operation. This method is useful for debugging if the reference fails to validate.

Specified by:

getCalculatedDigestValue in interface Reference

Returns:

the calculated digest value, or null if this reference has not been validated yet. Each invocation of this method returns a new clone to protect against subsequent modification.

See Also:

Reference.getCalculatedDigestValue()

getDigestInputStream

public InputStream getDigestInputStream()

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

Returns the pre-digested input stream, if reference caching is enabled. This is the input to the digest operation during a validation or signing operation.

Specified by:

getDigestInputStream in interface Reference

Returns:

an input stream containing the pre-digested input, or null if reference caching is not enabled or this reference has not been generated or validated

See Also:

Reference.getDigestInputStream()

getChildStructures

protected List getChildStructures()

Returns the DigestMethodImpl and DigestValueImpl.

Overrides:

getChildStructures in class ReferenceType

Returns:

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

putChildStructure

protected void putChildStructure(DOMStructure childStructure)
                          throws MarshalException

Puts the DigestMethodImpl and DigestValueImpl.

Overrides:

putChildStructure in class ReferenceType

Parameters:

childStructure - the unmarshalled child structure

Throws:

MarshalException

generateReference

public void generateReference(DOMCryptoContext context)
                       throws MarshalException,
                              XMLSignatureException

Calculates the digest value of this Reference and appends a DigestValue element with the calculated digest value.

Parameters:

context - the marshal context

Throws:

MarshalException - if an exception occurs during marshaling

XMLSignatureException - if an unexpected exception occurs during digesting

setPreCalculatedDigestValue

public void setPreCalculatedDigestValue(DOMCryptoContext context,
                                        byte[] digestValue)
                                 throws MarshalException,
                                        XMLSignatureException

Sets pre calculated digest value for this Reference and appends it to the DigestValue child before signature creation.
Note, that the DigestValue child must already exist, but the hash value itsself must be null. Hence the method does not override the hash that may have been already computed.
It is recommended to use this method only for signature creation.

Parameters:

context - the marshal context

digestValue - The digest value.

Throws:

MarshalException - if an exception occurs during marshaling

XMLSignatureException - if an unexpected exception occurs during digesting

validate

public boolean validate(XMLValidateContext validateContext)
                 throws XMLSignatureException

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

Validates this reference. This method verifies the digest of this reference.

This method only validates the reference the first time it is invoked. On subsequent invocations, it returns a cached result.

Specified by:

validate in interface Reference

Parameters:

validateContext - the validating context

Returns:

true if this reference was validated successfully; false otherwise

Throws:

XMLSignatureException - if an unexpected exception occurs while validating the reference

See Also:

Reference.validate(javax.xml.crypto.dsig.XMLValidateContext)

validateReference

public boolean validateReference(XMLValidateContext validateContext)
                          throws XMLSignatureException

Validates the Reference according to the Reference Validation rules defined in XML-Signature Syntax and Processing section 3.2.2 Reference Validation .

NOTE: This method assumes, that DOMUtils.distributeNSDeclarations(Element) has been called for the underlying document.

Parameters:

validateContext - the validation context

Returns:

true if this reference is reference-valid, false otherwise

Throws:

XMLSignatureException - if an unexpected exception occurs during validation