iaik.xml.crypto.alg.transform

Class EnvelopedSignatureTransformService

java.lang.Object

javax.xml.crypto.dsig.TransformService

iaik.xml.crypto.alg.transform.TransformServiceImpl

iaik.xml.crypto.alg.transform.EnvelopedSignatureTransformService

All Implemented Interfaces:

AlgorithmMethod, Transform, XMLStructure

public class EnvelopedSignatureTransformService
extends TransformServiceImpl

This TransformService implements the Enveloped Signature transform (http://www.w3.org/2000/09/xmldsig#enveloped-signature) as specified by the W3C recommendation XML-Signature Syntax and Processing.

An enveloped signature transform T removes the whole Signature element containing T from the digest calculation of the Reference element containing T. The entire string of characters used by an XML processor to match the Signature with the XML production element is removed. The output of the transform is equivalent to the output that would result from replacing T with an XPath transform containing the following XPath parameter element:

 <XPath xmlns:dsig="&dsig;">
      count(ancestor-or-self::dsig:Signature |
      here()/ancestor::dsig:Signature[1]) >
      count(ancestor-or-self::dsig:Signature)</XPath>
 

The input and output requirements of this transform are identical to those of the XPath transform, but may only be applied to a node-set from its parent XML document. Note that it is not necessary to use an XPath expression evaluator to create this transform. However, this transform MUST produce output in exactly the same manner as the XPath transform parameterized by the XPath expression above.

This transform is implemented using the SubtreeSieve.

Note: If NodeSetData is provided as input, the Nodes returned by the Iterator must be given in document order!

Supported algorithm parameter:

• none (null)

Transform result type:

• NodeSetData (Iterator returns DOM Nodes in document-order)

Field Summary

Fields inherited from class iaik.xml.crypto.alg.transform.TransformServiceImpl

transformNode_

Fields inherited from interface javax.xml.crypto.dsig.Transform

BASE64, ENVELOPED, XPATH, XPATH2, XSLT

Constructor Summary

Constructors

Constructor and Description
EnvelopedSignatureTransformService()

Method Summary

Modifier and Type	Method and Description
List	getAlgorithmParameters() Returns the list of algorithm parameter.
AlgorithmParameterSpec	getParameterSpec() Returns the algorithm-specific input parameters associated with this Transform.
protected void	setParameterSpec(AlgorithmParameterSpec spec) Sets the algorithm parameter for this TransformService.
protected void	setParameterSpec(List params) Sets the algorithm parameter for this TransformService.
Data	transform(Data data, XMLCryptoContext context) Transforms the specified data using the underlying transform algorithm.

Methods inherited from class iaik.xml.crypto.alg.transform.TransformServiceImpl

init, init, isFeatureSupported, marshalParams, parse, parse, transform

Methods inherited from class javax.xml.crypto.dsig.TransformService

getAlgorithm, getInstance, getInstance, getInstance, getMechanismType, getProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvelopedSignatureTransformService

public EnvelopedSignatureTransformService()

Method Detail

setParameterSpec

protected void setParameterSpec(AlgorithmParameterSpec spec)
                         throws InvalidAlgorithmParameterException

Description copied from class: TransformServiceImpl

Sets the algorithm parameter for this TransformService.

Specified by:

setParameterSpec in class TransformServiceImpl

Parameters:

spec - the AlgorithmParameterSpec

Throws:

InvalidAlgorithmParameterException - if the supplied spec is not appropriate for this TransformService

See Also:

TransformServiceImpl.setParameterSpec(java.security.spec.AlgorithmParameterSpec)

setParameterSpec

protected void setParameterSpec(List params)
                         throws InvalidAlgorithmParameterException

Description copied from class: TransformServiceImpl

Sets the algorithm parameter for this TransformService.

Specified by:

setParameterSpec in class TransformServiceImpl

Parameters:

params - the list of AlgorithmParameterImpls

Throws:

InvalidAlgorithmParameterException - if supplied params are not appropriate for this TransformService

See Also:

TransformServiceImpl.setParameterSpec(java.util.List)

getAlgorithmParameters

public List getAlgorithmParameters()

Description copied from class: TransformServiceImpl

Returns the list of algorithm parameter.

Specified by:

getAlgorithmParameters in class TransformServiceImpl

Returns:

a list of AlgorithmParameterImpls (may be empty but never null)

See Also:

TransformServiceImpl.getAlgorithmParameters()

getParameterSpec

public AlgorithmParameterSpec getParameterSpec()

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

Returns the algorithm-specific input parameters associated with this Transform.

The returned parameters can be typecast to a TransformParameterSpec object.

Returns:

the algorithm parameters of this AlgorithmMethod. Returns null if this AlgorithmMethod does not require parameters and they are not specified.

See Also:

AlgorithmMethod.getParameterSpec()

transform

public Data transform(Data data,
                      XMLCryptoContext context)
               throws TransformException

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

Transforms the specified data using the underlying transform algorithm.

Parameters:

data - the data to be transformed

context - the XMLCryptoContext containing additional context (may be null if not applicable)

Returns:

the transformed data

Throws:

TransformException - if an error occurs while executing the transform

See Also:

Transform.transform(javax.xml.crypto.Data, javax.xml.crypto.XMLCryptoContext)