Package eu.europa.esig.dss.xades.signature

Class XAdESSignatureBuilder

java.lang.Object

eu.europa.esig.dss.xades.signature.XAdESBuilder

eu.europa.esig.dss.xades.signature.XAdESSignatureBuilder

All Implemented Interfaces:

SignatureBuilder

public abstract class XAdESSignatureBuilder
extends XAdESBuilder
implements SignatureBuilder

This class implements all the necessary mechanisms to build each form of the XML signature.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	built	Indicates if the signature was already built.
protected DSSDocument	detachedDocument	This is the reference to the original document to sign
protected String	deterministicId
protected static String	KEYINFO_SUFFIX	id-suffixes for DOM elements
protected String	keyInfoCanonicalizationMethod
protected Element	keyInfoDom
protected static String	OBJECT_ID_SUFFIX
protected Element	qualifyingPropertiesDom
protected static String	REFERENCE_ID_SUFFIX
protected Element	signatureDom
protected Element	signatureValueDom
protected Element	signedDataObjectPropertiesDom
protected String	signedInfoCanonicalizationMethod
protected Element	signedInfoDom
protected String	signedPropertiesCanonicalizationMethod
protected Element	signedPropertiesDom
protected Element	signedSignaturePropertiesDom
protected static String	TIMESTAMP_SUFFIX
protected Element	unsignedSignaturePropertiesDom
protected static String	VALUE_SUFFIX
protected static String	XADES_SUFFIX

Fields inherited from class eu.europa.esig.dss.xades.signature.XAdESBuilder

certificateVerifier, documentDom, params, REFERENCED_DATA, SIGNATURE, TARGET, URI, xadesPaths

Constructor Summary

Constructors

Constructor	Description
XAdESSignatureBuilder(XAdESSignatureParameters params, DSSDocument detachedDocument, CertificateVerifier certificateVerifier)	The default constructor for SignatureBuilder.

Method Summary

Modifier and Type	Method	Description
protected void	addTimestamp(Element timestampElement, TimestampToken token)	Adds the content of a timestamp into a given timestamp element
protected void	alignNodes()
protected byte[]	applyTransformations(DSSReference reference, Node nodeToTransform)	Applies transforms on a node and returns the byte array to be used for a reference digest computation
byte[]	build()	This is the main method which is called to build the XML signature
protected Document	buildRootDocumentDom()
protected abstract DSSReference	createReference(DSSDocument document, int referenceIndex)
protected Node	getNodeToCanonicalize(Node node)
protected Node	getParentNodeOfSignature()
protected DigestAlgorithm	getReferenceDigestAlgorithmOrDefault(XAdESSignatureParameters params)	Returns params.referenceDigestAlgorithm if exists, params.digestAlgorithm otherwise
static XAdESSignatureBuilder	getSignatureBuilder(XAdESSignatureParameters params, DSSDocument document, CertificateVerifier certificateVerifier)	Creates the signature according to the packaging
protected void	incorporateFiles()
protected void	incorporateKeyInfo()	Creates KeyInfo tag.
protected void	incorporateObject()	This method incorporates the ds:Object tag
protected void	incorporateReferenceKeyInfo()	Method incorporates KeyInfo ds:References.
protected void	incorporateReferenceSignedProperties()	This method incorporates ds:References
void	incorporateSignatureDom()	This method creates a new instance of Signature element.
protected void	incorporateSignatureDom(Node parentNodeOfSignature)
protected void	incorporateSignatureValue()	This method incorporates the signature value.
void	incorporateSignedInfo()	This method incorporates the SignedInfo tag
protected void	incorporateSignedProperties()	Creates the SignedProperties DOM object element.
protected void	incorporateSignedSignatureProperties()	Creates the SignedSignatureProperties DOM object element.
DSSDocument	signDocument(byte[] signatureValue)	Adds signature value to the signature and returns XML signature (InMemoryDocument)
protected abstract DSSDocument	transformReference(DSSReference reference)	This method performs the reference transformation.

Methods inherited from class eu.europa.esig.dss.xades.signature.XAdESBuilder

createXmlDocument, getCurrentXAdESElements, getCurrentXAdESPaths, getXades141Namespace, getXadesNamespace, getXmldsigNamespace, incorporateCert, incorporateCertificateRef, incorporateDigestMethod, incorporateDigestValue, incorporateDigestValue, incorporateIssuerV1, incorporateIssuerV2

Methods inherited from class java.lang.Object

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

Field Details

built

protected boolean built

Indicates if the signature was already built. (Two steps building)

detachedDocument

protected DSSDocument detachedDocument

This is the reference to the original document to sign

keyInfoCanonicalizationMethod

protected String keyInfoCanonicalizationMethod

signedInfoCanonicalizationMethod

protected String signedInfoCanonicalizationMethod

signedPropertiesCanonicalizationMethod

protected String signedPropertiesCanonicalizationMethod

deterministicId

protected final String deterministicId

signatureDom

protected Element signatureDom

keyInfoDom

protected Element keyInfoDom

signedInfoDom

protected Element signedInfoDom

signatureValueDom

protected Element signatureValueDom

qualifyingPropertiesDom

protected Element qualifyingPropertiesDom

signedPropertiesDom

protected Element signedPropertiesDom

signedSignaturePropertiesDom

protected Element signedSignaturePropertiesDom

signedDataObjectPropertiesDom

protected Element signedDataObjectPropertiesDom

unsignedSignaturePropertiesDom

protected Element unsignedSignaturePropertiesDom

KEYINFO_SUFFIX

protected static final String KEYINFO_SUFFIX

id-suffixes for DOM elements

See Also:

Constant Field Values

TIMESTAMP_SUFFIX

protected static final String TIMESTAMP_SUFFIX

See Also:

Constant Field Values

VALUE_SUFFIX

protected static final String VALUE_SUFFIX

See Also:

Constant Field Values

XADES_SUFFIX

protected static final String XADES_SUFFIX

See Also:

Constant Field Values

OBJECT_ID_SUFFIX

protected static final String OBJECT_ID_SUFFIX

See Also:

Constant Field Values

REFERENCE_ID_SUFFIX

protected static final String REFERENCE_ID_SUFFIX

See Also:

Constant Field Values

Constructor Details

XAdESSignatureBuilder

public XAdESSignatureBuilder(XAdESSignatureParameters params, DSSDocument detachedDocument, CertificateVerifier certificateVerifier)

The default constructor for SignatureBuilder.

Parameters:

params - The set of parameters relating to the structure and process of the creation or extension of the electronic signature.

detachedDocument - The original document to sign.

certificateVerifier - the certificate verifier with its OCSPSource,...

Method Details

getSignatureBuilder

public static XAdESSignatureBuilder getSignatureBuilder(XAdESSignatureParameters params, DSSDocument document, CertificateVerifier certificateVerifier)

Creates the signature according to the packaging

Parameters:

params - The set of parameters relating to the structure and process of the creation or extension of the electronic signature.

document - The original document to sign.

certificateVerifier - the certificate verifier with its OCSPSource,...

Returns:

the signature builder linked to the packaging

build

public byte[] build() throws DSSException

This is the main method which is called to build the XML signature

Returns:

A byte array is returned with XML that represents the canonicalized SignedInfo segment of signature. This data are used to define the SignatureValue element.

Throws:

DSSException - if an error occurred

incorporateFiles

protected void incorporateFiles()

buildRootDocumentDom

protected Document buildRootDocumentDom()

incorporateSignatureDom

public void incorporateSignatureDom()

This method creates a new instance of Signature element.

getParentNodeOfSignature

protected Node getParentNodeOfSignature()

incorporateSignatureDom

protected void incorporateSignatureDom(Node parentNodeOfSignature)

incorporateSignedInfo

public void incorporateSignedInfo()

This method incorporates the SignedInfo tag

  
   	<ds:SignedInfo>
 			<ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
   		<ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
   		...
   	</ds:SignedInfo>
  
 

incorporateKeyInfo

protected void incorporateKeyInfo() throws DSSException

Creates KeyInfo tag. NOTE: when trust anchor baseline profile policy is defined only the certificates previous to the trust anchor are included.

        
 		<ds:KeyInfo>
 			<ds:X509Data>
  			<ds:X509Certificate>
 					MIIB....
 				</ds:X509Certificate>
 				<ds:X509Certificate>
 					MIIB+...
 				</ds:X509Certificate>
 			</ds:X509Data>
 		</ds:KeyInfo>
 
 

        
 		<ds:KeyInfo>
 			<ds:X509Data>
  			<ds:X509Certificate>
 					MIIB....
 				</ds:X509Certificate>
 				<ds:X509Certificate>
 					MIIB+...
 				</ds:X509Certificate>
 			</ds:X509Data>
 		</ds:KeyInfo>
 
 

Throws:

DSSException - if an error occurred

incorporateObject

protected void incorporateObject()

This method incorporates the ds:Object tag

        
 		<ds:Object>
 			<xades:QualifyingProperties>
 				<xades:SignedProperties>
 					...
 				</xades:SignedProperties>
 			</xades:QualifyingProperties>
 		</ds:Object>
 
 

incorporateReferenceSignedProperties

protected void incorporateReferenceSignedProperties()

This method incorporates ds:References

        
 		<ds:Reference Type="http://uri.etsi.org/01903#SignedProperties" URI=
	"#xades-id-A43023AFEB149830C242377CC941360F">
			<ds:Transforms>
				<ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
			</ds:Transforms>
			<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
			<ds:DigestValue>uijX/nvuu8g10ZVEklEnYatvFe8=</ds:DigestValue>
		</ds:Reference>
 
 

incorporateReferenceKeyInfo

protected void incorporateReferenceKeyInfo()

Method incorporates KeyInfo ds:References.

        
 		<ds:Reference URI="#keyInfo-id-A43023AFEB149830C242377CC941360F">
			<ds:Transforms>
				<ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/>
			</ds:Transforms>
			<ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
			<ds:DigestValue>uijX/nvuu2g10ZVEklEnYatvFe4=</ds:DigestValue>
		</ds:Reference>
 
 

getReferenceDigestAlgorithmOrDefault

protected DigestAlgorithm getReferenceDigestAlgorithmOrDefault(XAdESSignatureParameters params)

Returns params.referenceDigestAlgorithm if exists, params.digestAlgorithm otherwise

Returns:

DigestAlgorithm

createReference

protected abstract DSSReference createReference(DSSDocument document, int referenceIndex)

transformReference

protected abstract DSSDocument transformReference(DSSReference reference)

This method performs the reference transformation.

Parameters:

reference - DSSReference to be transformed

Returns:

DSSDocument containing transformed reference's data

incorporateSignatureValue

protected void incorporateSignatureValue()

This method incorporates the signature value.

incorporateSignedProperties

protected void incorporateSignedProperties()

Creates the SignedProperties DOM object element.

 
 		<SignedProperties Id="xades-ide5c549340079fe19f3f90f03354a5965">
 
 

incorporateSignedSignatureProperties

protected void incorporateSignedSignatureProperties()

Creates the SignedSignatureProperties DOM object element.

 
 		<SignedSignatureProperties>
 		...
 		</SignedSignatureProperties>
 
 

signDocument

public DSSDocument signDocument(byte[] signatureValue) throws DSSException

Adds signature value to the signature and returns XML signature (InMemoryDocument)

Specified by:

signDocument in interface SignatureBuilder

Parameters:

signatureValue -

Returns:

DSSDocument representing the signature

Throws:

DSSException

addTimestamp

protected void addTimestamp(Element timestampElement, TimestampToken token)

Adds the content of a timestamp into a given timestamp element

Parameters:

timestampElement -

applyTransformations

protected byte[] applyTransformations(DSSReference reference, Node nodeToTransform)

Applies transforms on a node and returns the byte array to be used for a reference digest computation

Parameters:

reference - a DSSReference to apply transforms from

nodeToTransform - Node to apply transforms on

Returns:

a byte array, representing a content obtained after transformations

getNodeToCanonicalize

protected Node getNodeToCanonicalize(Node node)

alignNodes

protected void alignNodes()

Specified by:

alignNodes in class XAdESBuilder