Class ASiCWithXAdESService

java.lang.Object

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

eu.europa.esig.dss.asic.common.signature.AbstractASiCSignatureService<ASiCWithXAdESSignatureParameters, XAdESTimestampParameters, XAdESCounterSignatureParameters, XAdESEvidenceRecordIncorporationParameters>

eu.europa.esig.dss.asic.xades.signature.ASiCWithXAdESService

All Implemented Interfaces:

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

public class ASiCWithXAdESService
extends AbstractASiCSignatureService<ASiCWithXAdESSignatureParameters, XAdESTimestampParameters, XAdESCounterSignatureParameters, XAdESEvidenceRecordIncorporationParameters>

The service containing the main methods for ASiC with XAdES signature creation/extension

See Also:

• Serialized Form

Field Summary

Fields inherited from class AbstractSignatureService

certificateVerifier, tspSource

Constructor Summary

Constructors

Constructor	Description
ASiCWithXAdESService(CertificateVerifier certificateVerifier)	The default constructor to instantiate the service

Method Summary

Modifier and Type	Method	Description
DSSDocument	addContainerEvidenceRecord(List<DSSDocument> documents, DSSDocument evidenceRecordDocument, ASiCContainerEvidenceRecordParameters parameters)	Creates a new ASiC container with the evidenceRecordDocument applied to the documents.
DSSDocument	addSignatureEvidenceRecord(DSSDocument asicContainer, DSSDocument evidenceRecordDocument, XAdESEvidenceRecordIncorporationParameters parameters)	Incorporates the Evidence Record as an unsigned property into the signature
DSSDocument	addSignaturePolicyStore(DSSDocument asicContainer, SignaturePolicyStore signaturePolicyStore)	Incorporates a Signature Policy Store as an unsigned property into the ASiC with XAdES Signature
DSSDocument	counterSignSignature(DSSDocument asicContainer, XAdESCounterSignatureParameters parameters, SignatureValue signatureValue)	Counter-signs the signatureDocument with the provided signatureValue.
DSSDocument	extendDocument(DSSDocument toExtendDocument, ASiCWithXAdESSignatureParameters parameters)	Extends the level of the signatures in the toExtendDocument
protected DefaultASiCContainerExtractor	getArchiveExtractor(DSSDocument archive)	Returns a relevant ASiC container extractor for the given format
TimestampToken	getContentTimestamp(List<DSSDocument> toSignDocuments, ASiCWithXAdESSignatureParameters parameters)	Creates a content-timestamp attribute (to be include in the signed-data)
ToBeSigned	getDataToBeCounterSigned(DSSDocument asicContainer, XAdESCounterSignatureParameters parameters)	Retrieves the bytes of the data that need to be counter-signed from signatureDocument.
ToBeSigned	getDataToSign(List<DSSDocument> toSignDocuments, ASiCWithXAdESSignatureParameters parameters)	Retrieves the bytes of the data that need to be signed based on the toSignDocuments and parameters.
protected List<DSSDocument>	getDetachedContents(ASiCContent asicContent, boolean isOpenDocument)	This method returns a detached contents to be used for a signature validation
protected XAdESService	getXAdESService()	Returns the XAdESService to be used for signing
void	setAsicFilenameFactory(ASiCWithXAdESFilenameFactory asicFilenameFactory)	Sets ASiCWithXAdESFilenameFactory defining a set of rules for naming of newly create ZIP entries, such as signature files.
DSSDocument	signDocument(List<DSSDocument> toSignDocuments, ASiCWithXAdESSignatureParameters 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 AbstractASiCSignatureService

addContainerEvidenceRecord, assertAddSignaturePolicyStorePossible, assertCounterSignatureParametersValid, assertSignaturePossible, buildASiCContainer, buildASiCContainer, extractCurrentArchive, getContentTimestamp, getDataToSign, getFinalArchiveName, signDocument, timestamp

Methods inherited from class AbstractSignatureService

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

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

ASiCWithXAdESService

public ASiCWithXAdESService(CertificateVerifier certificateVerifier)

The default constructor to instantiate the service

Parameters:

certificateVerifier - CertificateVerifier to use

Method Details

setAsicFilenameFactory

public void setAsicFilenameFactory(ASiCWithXAdESFilenameFactory asicFilenameFactory)

Sets ASiCWithXAdESFilenameFactory defining a set of rules for naming of newly create ZIP entries, such as signature files.

Parameters:

asicFilenameFactory - ASiCWithXAdESFilenameFactory

getContentTimestamp

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

Description copied from interface: MultipleDocumentsSignatureService

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

Parameters:

toSignDocuments - list of documents to sign

parameters - set of the driving signing parameters

Returns:

a timestamp token

getDataToSign

public ToBeSigned getDataToSign(List<DSSDocument> toSignDocuments,
 ASiCWithXAdESSignatureParameters 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.

Parameters:

toSignDocuments - list of documents to sign

parameters - set of the driving signing parameters

Returns:

the data to be signed

signDocument

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

Description copied from interface: MultipleDocumentsSignatureService

Signs the toSignDocuments with the provided signatureValue.

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

timestamp

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

Description copied from interface: MultipleDocumentsSignatureService

Timestamps the toSignDocuments with the provided signatureValue.

Parameters:

toTimestampDocuments - list of documents to timestamp

parameters - set of the driving timestamping parameters

Returns:

the container with the added timestamp token

extendDocument

public DSSDocument extendDocument(DSSDocument toExtendDocument,
 ASiCWithXAdESSignatureParameters parameters)

Description copied from interface: DocumentSignatureService

Extends the level of the signatures in the toExtendDocument

Parameters:

toExtendDocument - document to extend

parameters - set of the driving signing parameters

Returns:

the extended signature

getDetachedContents

protected List<DSSDocument> getDetachedContents(ASiCContent asicContent,
 boolean isOpenDocument)

This method returns a detached contents to be used for a signature validation

Parameters:

asicContent - ASiCContent representing the extracted ASiC container

isOpenDocument - defining whether the current container represents an OpenDocument

Returns:

a list of DSSDocuments

getXAdESService

protected XAdESService getXAdESService()

Returns the XAdESService to be used for signing

Returns:

XAdESService

getArchiveExtractor

protected DefaultASiCContainerExtractor getArchiveExtractor(DSSDocument archive)

Description copied from class: AbstractASiCSignatureService

Returns a relevant ASiC container extractor for the given format

Specified by:

getArchiveExtractor in class AbstractASiCSignatureService<ASiCWithXAdESSignatureParameters, XAdESTimestampParameters, XAdESCounterSignatureParameters, XAdESEvidenceRecordIncorporationParameters>

Parameters:

archive - DSSDocument to get an extractor for

Returns:

an instance of DefaultASiCContainerExtractor

addSignaturePolicyStore

public DSSDocument addSignaturePolicyStore(DSSDocument asicContainer,
 SignaturePolicyStore signaturePolicyStore)

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

Parameters:

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

signaturePolicyStore - SignaturePolicyStore to add

Returns:

DSSDocument ASiC with XAdES container with an incorporated SignaturePolicyStore

getDataToBeCounterSigned

public ToBeSigned getDataToBeCounterSigned(DSSDocument asicContainer,
 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

Parameters:

asicContainer - 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 asicContainer,
 XAdESCounterSignatureParameters parameters,
 SignatureValue signatureValue)

Description copied from interface: CounterSignatureService

Counter-signs the signatureDocument with the provided signatureValue.

Parameters:

asicContainer - 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 asicContainer,
 DSSDocument evidenceRecordDocument,
 XAdESEvidenceRecordIncorporationParameters parameters)

Description copied from interface: EvidenceRecordIncorporationService

Incorporates the Evidence Record as an unsigned property into the signature

Parameters:

asicContainer - 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

addContainerEvidenceRecord

public DSSDocument addContainerEvidenceRecord(List<DSSDocument> documents,
 DSSDocument evidenceRecordDocument,
 ASiCContainerEvidenceRecordParameters parameters)

Description copied from class: AbstractASiCSignatureService

Creates a new ASiC container with the evidenceRecordDocument applied to the documents.

If the provided original document is an existing ASiC container, then the evidenceRecordDocument will be evaluated against the container files and places within the container.

Specified by:

addContainerEvidenceRecord in class AbstractASiCSignatureService<ASiCWithXAdESSignatureParameters, XAdESTimestampParameters, XAdESCounterSignatureParameters, XAdESEvidenceRecordIncorporationParameters>

Parameters:

documents - a list of DSSDocuments preserved by an evidence record

evidenceRecordDocument - DSSDocument to add

parameters - ASiCContainerEvidenceRecordParameters providing configuration for the evidence record incorporation

Returns:

DSSDocument ASiC container containing the evidence record file document