Class XAdESService

java.lang.Object

eu.europa.esig.dss.signature.AbstractSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>

eu.europa.esig.dss.xades.signature.XAdESService

All Implemented Interfaces:

EvidenceRecordIncorporationService<XAdESEvidenceRecordIncorporationParameters>, CounterSignatureService<XAdESCounterSignatureParameters>, DocumentSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>, MultipleDocumentsSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>, Serializable

public class XAdESService
extends AbstractSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>
implements MultipleDocumentsSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>, CounterSignatureService<XAdESCounterSignatureParameters>, EvidenceRecordIncorporationService<XAdESEvidenceRecordIncorporationParameters>

XAdES implementation of DocumentSignatureService

See Also:

• Serialized Form

Field Summary

Fields inherited from class AbstractSignatureService

certificateVerifier, tspSource

Constructor Summary

Constructors

Constructor	Description
XAdESService(CertificateVerifier certificateVerifier)	This is the constructor to create an instance of the XAdESService.

Method Summary

Modifier and Type	Method	Description
DSSDocument	addSignatureEvidenceRecord(DSSDocument signatureDocument, DSSDocument evidenceRecordDocument, XAdESEvidenceRecordIncorporationParameters parameters)	Incorporates the Evidence Record as an unsigned property into the signature
DSSDocument	addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore)	Incorporates a Signature Policy Store as an unsigned property into the XAdES Signature
DSSDocument	counterSignSignature(DSSDocument signatureDocument, XAdESCounterSignatureParameters parameters, SignatureValue signatureValue)	Counter-signs the signatureDocument with the provided signatureValue.
DSSDocument	extendDocument(DSSDocument toExtendDocument, XAdESSignatureParameters parameters)	Extends the level of the signatures in the toExtendDocument
TimestampToken	getContentTimestamp(DSSDocument toSignDocument, XAdESSignatureParameters parameters)	This method allows to compute a content-timestamp (which is added in the signed properties)
TimestampToken	getContentTimestamp(List<DSSDocument> toSignDocuments, XAdESSignatureParameters parameters)	Creates a content-timestamp attribute (to be include in the signed-data)
ToBeSigned	getDataToBeCounterSigned(DSSDocument signatureDocument, XAdESCounterSignatureParameters parameters)	Retrieves the bytes of the data that need to be counter-signed from signatureDocument.
ToBeSigned	getDataToSign(DSSDocument toSignDocument, XAdESSignatureParameters parameters)	Retrieves the bytes of the data that need to be signed based on the toSignDocument and parameters.
ToBeSigned	getDataToSign(List<DSSDocument> toSignDocuments, XAdESSignatureParameters parameters)	Retrieves the bytes of the data that need to be signed based on the toSignDocuments and parameters.
DSSDocument	signDocument(DSSDocument toSignDocument, XAdESSignatureParameters parameters, SignatureValue signatureValue)	Signs the toSignDocument with the provided signatureValue.
DSSDocument	signDocument(List<DSSDocument> toSignDocuments, XAdESSignatureParameters parameters, SignatureValue signatureValue)	Signs the toSignDocuments with the provided signatureValue.
DSSDocument	timestamp(List<DSSDocument> toTimestampDocuments, XAdESTimestampParameters parameters)	Timestamps the toSignDocuments with the provided signatureValue.

Methods inherited from class AbstractSignatureService

assertSigningCertificateValid, ensureSignatureValue, getFinalDocumentName, getFinalDocumentName, getFinalFileName, getFinalFileName, getFinalFileName, isValidSignatureValue, setTspSource, timestamp

Methods inherited from class Object

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

Methods inherited from interface CounterSignatureService

setTspSource

Methods inherited from interface MultipleDocumentsSignatureService

isValidSignatureValue

Constructor Details

XAdESService

public XAdESService(CertificateVerifier certificateVerifier)

This is the constructor to create an instance of the XAdESService. A certificate verifier must be provided.

Parameters:

certificateVerifier - CertificateVerifier provides information on the sources to be used in the validation process in the context of a signature.

Method Details

getContentTimestamp

public TimestampToken getContentTimestamp(DSSDocument toSignDocument,
 XAdESSignatureParameters parameters)

Description copied from interface: DocumentSignatureService

This method allows to compute a content-timestamp (which is added in the signed properties)

Specified by:

getContentTimestamp in interface DocumentSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>

Parameters:

toSignDocument - document to sign or the already existing signature

parameters - set of the driving signing parameters

Returns:

a timestamp token

getContentTimestamp

public TimestampToken getContentTimestamp(List<DSSDocument> toSignDocuments,
 XAdESSignatureParameters parameters)

Description copied from interface: MultipleDocumentsSignatureService

Creates a content-timestamp attribute (to be include in the signed-data)

Specified by:

getContentTimestamp in interface MultipleDocumentsSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>

Parameters:

toSignDocuments - list of documents to sign

parameters - set of the driving signing parameters

Returns:

a timestamp token

getDataToSign

public ToBeSigned getDataToSign(DSSDocument toSignDocument,
 XAdESSignatureParameters parameters)

Description copied from interface: DocumentSignatureService

Retrieves the bytes of the data that need to be signed based on the toSignDocument and parameters. When toSignDocument contains an already existing signature the returned bytes are related to a new parallel signature. - Enveloped signature (XML): a new signature is added and the signed data corresponds to that pointed by the first signature; - Enveloping signature: - - XML: The parallel signature is not possible - - CMS: A new parallel signature is added - Detached signature: - - XML: The parallel signature is added - - CMS: A new parallel signature is added

Specified by:

getDataToSign in interface DocumentSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>

Parameters:

toSignDocument - document to sign or the already existing signature

parameters - set of the driving signing parameters

Returns:

the data to be signed

getDataToSign

public ToBeSigned getDataToSign(List<DSSDocument> toSignDocuments,
 XAdESSignatureParameters parameters)

Description copied from interface: MultipleDocumentsSignatureService

Retrieves the bytes of the data that need to be signed based on the toSignDocuments and parameters. When toSignDocuments contains an already existing signature the returned bytes are related to a new parallel signature.

Specified by:

getDataToSign in interface MultipleDocumentsSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>

Parameters:

toSignDocuments - list of documents to sign

parameters - set of the driving signing parameters

Returns:

the data to be signed

signDocument

public DSSDocument signDocument(DSSDocument toSignDocument,
 XAdESSignatureParameters parameters,
 SignatureValue signatureValue)

Description copied from interface: DocumentSignatureService

Signs the toSignDocument with the provided signatureValue.

Specified by:

signDocument in interface DocumentSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>

Parameters:

toSignDocument - document to sign

parameters - set of the driving signing parameters

signatureValue - the signature value to incorporate

Returns:

the signed document (toSignDocument with the incorporated signature or the detached signature)

signDocument

public DSSDocument signDocument(List<DSSDocument> toSignDocuments,
 XAdESSignatureParameters parameters,
 SignatureValue signatureValue)

Description copied from interface: MultipleDocumentsSignatureService

Signs the toSignDocuments with the provided signatureValue.

Specified by:

signDocument in interface MultipleDocumentsSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>

Parameters:

toSignDocuments - list of documents to sign

parameters - set of the driving signing parameters

signatureValue - the signature value to incorporate

Returns:

the container with the signature and the documents (ASiC) or the signature file

extendDocument

public DSSDocument extendDocument(DSSDocument toExtendDocument,
 XAdESSignatureParameters parameters)

Description copied from interface: DocumentSignatureService

Extends the level of the signatures in the toExtendDocument

Specified by:

extendDocument in interface DocumentSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>

Specified by:

extendDocument in interface MultipleDocumentsSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>

Parameters:

toExtendDocument - document to extend

parameters - set of the driving signing parameters

Returns:

the extended signature

timestamp

public DSSDocument timestamp(List<DSSDocument> toTimestampDocuments,
 XAdESTimestampParameters parameters)

Description copied from interface: MultipleDocumentsSignatureService

Timestamps the toSignDocuments with the provided signatureValue.

Specified by:

timestamp in interface MultipleDocumentsSignatureService<XAdESSignatureParameters, XAdESTimestampParameters>

Parameters:

toTimestampDocuments - list of documents to timestamp

parameters - set of the driving timestamping parameters

Returns:

the container with the added timestamp token

addSignaturePolicyStore

public DSSDocument addSignaturePolicyStore(DSSDocument document,
 SignaturePolicyStore signaturePolicyStore)

Incorporates a Signature Policy Store as an unsigned property into the XAdES Signature

Parameters:

document - DSSDocument containing a XAdES Signature to add a SignaturePolicyStore to

signaturePolicyStore - SignaturePolicyStore to add

Returns:

DSSDocument XAdESSignature with an incorporated SignaturePolicyStore

getDataToBeCounterSigned

public ToBeSigned getDataToBeCounterSigned(DSSDocument signatureDocument,
 XAdESCounterSignatureParameters parameters)

Description copied from interface: CounterSignatureService

Retrieves the bytes of the data that need to be counter-signed from signatureDocument. signatureDocument shall be a valid signature of the same type

Specified by:

getDataToBeCounterSigned in interface CounterSignatureService<XAdESCounterSignatureParameters>

Parameters:

signatureDocument - DSSDocument representing the original signature to be counter-signed

parameters - set of the driving signing parameters for a counter-signature

Returns:

ToBeSigned to be counter-signed byte array (signature value retrieved from the signatureDocument)

counterSignSignature

public DSSDocument counterSignSignature(DSSDocument signatureDocument,
 XAdESCounterSignatureParameters parameters,
 SignatureValue signatureValue)

Description copied from interface: CounterSignatureService

Counter-signs the signatureDocument with the provided signatureValue.

Specified by:

counterSignSignature in interface CounterSignatureService<XAdESCounterSignatureParameters>

Parameters:

signatureDocument - DSSDocument to be counter-signed

parameters - set of the driving signing parameters for a counter-signature

signatureValue - SignatureValue the signature value to incorporate

Returns:

DSSDocument the signature document enveloping a newly created counter-signature

addSignatureEvidenceRecord

public DSSDocument addSignatureEvidenceRecord(DSSDocument signatureDocument,
 DSSDocument evidenceRecordDocument,
 XAdESEvidenceRecordIncorporationParameters parameters)

Description copied from interface: EvidenceRecordIncorporationService

Incorporates the Evidence Record as an unsigned property into the signature

Specified by:

addSignatureEvidenceRecord in interface EvidenceRecordIncorporationService<XAdESEvidenceRecordIncorporationParameters>

Parameters:

signatureDocument - DSSDocument containing the signature to add the evidence record into

evidenceRecordDocument - DSSDocument to add

parameters - SerializableEvidenceRecordIncorporationParameters providing configuration for the evidence record incorporation

Returns:

DSSDocument signature document with an incorporated evidence record