Class ASiCWithCAdESService

java.lang.Object

eu.europa.esig.dss.signature.AbstractSignatureService<ASiCWithCAdESSignatureParameters, ASiCWithCAdESTimestampParameters>

eu.europa.esig.dss.asic.common.signature.AbstractASiCSignatureService<ASiCWithCAdESSignatureParameters, ASiCWithCAdESTimestampParameters, CAdESCounterSignatureParameters, CAdESEvidenceRecordIncorporationParameters>

eu.europa.esig.dss.asic.cades.signature.ASiCWithCAdESService

All Implemented Interfaces:

EvidenceRecordIncorporationService<CAdESEvidenceRecordIncorporationParameters>, CounterSignatureService<CAdESCounterSignatureParameters>, DocumentSignatureService<ASiCWithCAdESSignatureParameters, ASiCWithCAdESTimestampParameters>, MultipleDocumentsSignatureService<ASiCWithCAdESSignatureParameters, ASiCWithCAdESTimestampParameters>, Serializable

public class ASiCWithCAdESService
extends AbstractASiCSignatureService<ASiCWithCAdESSignatureParameters, ASiCWithCAdESTimestampParameters, CAdESCounterSignatureParameters, CAdESEvidenceRecordIncorporationParameters>

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

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DSSResourcesHandlerBuilder	resourcesHandlerBuilder	This object is used to create data container objects such as an OutputStream or a DSSDocument

Fields inherited from class AbstractSignatureService

certificateVerifier, tspSource

Constructor Summary

Constructors

Constructor	Description
ASiCWithCAdESService(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, CAdESEvidenceRecordIncorporationParameters 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 CAdES Signature
protected void	assertAddSignaturePolicyStorePossible(ASiCContent asicContent)	Verifies if incorporation of a SignaturePolicyStore is possible
protected void	assertCounterSignatureParametersValid(CAdESCounterSignatureParameters parameters)	Verifies a validity of counter signature parameters
DSSDocument	counterSignSignature(DSSDocument asicContainer, CAdESCounterSignatureParameters parameters, SignatureValue signatureValue)	Counter-signs the signatureDocument with the provided signatureValue.
DSSDocument	extendDocument(DSSDocument toExtendDocument, ASiCWithCAdESSignatureParameters 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
protected CAdESCounterSignatureBuilder	getCAdESCounterSignatureBuilder()	Creates a new instance of CAdESCounterSignatureBuilder
protected CAdESSignatureParameters	getCAdESParameters(ASiCWithCAdESSignatureParameters parameters)	Returns CAdESSignatureParameters from the given ASiCWithCAdESSignatureParameters
protected CAdESSignatureParameters	getCAdESParameters(ASiCWithCAdESSignatureParameters parameters, GetDataToSignASiCWithCAdESHelper dataToSignHelper)	Returns CAdESSignatureParameters from the given ASiCWithCAdESSignatureParameters and GetDataToSignASiCWithCAdESHelper
protected CAdESService	getCAdESService()	Returns the CAdESService to be used for signature/timestamp creation
TimestampToken	getContentTimestamp(List<DSSDocument> toSignDocuments, ASiCWithCAdESSignatureParameters parameters)	Creates a content-timestamp attribute (to be include in the signed-data)
ToBeSigned	getDataToBeCounterSigned(DSSDocument asicContainer, CAdESCounterSignatureParameters parameters)	Retrieves the bytes of the data that need to be counter-signed from signatureDocument.
ToBeSigned	getDataToSign(List<DSSDocument> toSignDocuments, ASiCWithCAdESSignatureParameters parameters)	Retrieves the bytes of the data that need to be signed based on the toSignDocuments and parameters.
protected ASiCWithCAdESSignatureExtension	getExtensionProfile(SignatureLevel signatureLevel, ASiCContainerType containerType)	Returns the extension profile to be used for the current signature
protected ASiCWithCAdESLevelBaselineLTA	getLTALevelExtensionProfile()	Gets an extension profile for an LTA-level signature augmentation
void	setAsicFilenameFactory(ASiCWithCAdESFilenameFactory asicFilenameFactory)	Sets ASiCWithCAdESFilenameFactory defining a set of rules for naming of newly create ZIP entries, such as signature files.
void	setResourcesHandlerBuilder(DSSResourcesHandlerBuilder resourcesHandlerBuilder)	This method sets a DSSResourcesHandlerBuilder to be used for operating with internal objects during the signature creation procedure.
DSSDocument	signDocument(List<DSSDocument> toSignDocuments, ASiCWithCAdESSignatureParameters parameters, SignatureValue signatureValue)	Signs the toSignDocuments with the provided signatureValue.
DSSDocument	timestamp(List<DSSDocument> toTimestampDocuments, ASiCWithCAdESTimestampParameters parameters)	Timestamps the toSignDocuments with the provided signatureValue.

Methods inherited from class AbstractASiCSignatureService

addContainerEvidenceRecord, 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

Field Details

resourcesHandlerBuilder

protected DSSResourcesHandlerBuilder resourcesHandlerBuilder

This object is used to create data container objects such as an OutputStream or a DSSDocument

Constructor Details

ASiCWithCAdESService

public ASiCWithCAdESService(CertificateVerifier certificateVerifier)

The default constructor to instantiate the service

Parameters:

certificateVerifier - CertificateVerifier to use

Method Details

setResourcesHandlerBuilder

public void setResourcesHandlerBuilder(DSSResourcesHandlerBuilder resourcesHandlerBuilder)

This method sets a DSSResourcesHandlerBuilder to be used for operating with internal objects during the signature creation procedure. NOTE: The DSSResourcesHandlerBuilder is supported only within the 'dss-cms-stream' module!

Parameters:

resourcesHandlerBuilder - DSSResourcesHandlerBuilder

setAsicFilenameFactory

public void setAsicFilenameFactory(ASiCWithCAdESFilenameFactory asicFilenameFactory)

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

Parameters:

asicFilenameFactory - ASiCWithCAdESFilenameFactory

getContentTimestamp

public TimestampToken getContentTimestamp(List<DSSDocument> toSignDocuments,
 ASiCWithCAdESSignatureParameters 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,
 ASiCWithCAdESSignatureParameters 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,
 ASiCWithCAdESSignatureParameters 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,
 ASiCWithCAdESTimestampParameters 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,
 ASiCWithCAdESSignatureParameters 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

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<ASiCWithCAdESSignatureParameters, ASiCWithCAdESTimestampParameters, CAdESCounterSignatureParameters, CAdESEvidenceRecordIncorporationParameters>

Parameters:

archive - DSSDocument to get an extractor for

Returns:

an instance of DefaultASiCContainerExtractor

getCAdESService

protected CAdESService getCAdESService()

Returns the CAdESService to be used for signature/timestamp creation

Returns:

CAdESService

getCAdESParameters

protected CAdESSignatureParameters getCAdESParameters(ASiCWithCAdESSignatureParameters parameters)

Returns CAdESSignatureParameters from the given ASiCWithCAdESSignatureParameters

Parameters:

parameters - ASiCWithCAdESSignatureParameters

Returns:

CAdESSignatureParameters

getCAdESParameters

protected CAdESSignatureParameters getCAdESParameters(ASiCWithCAdESSignatureParameters parameters,
 GetDataToSignASiCWithCAdESHelper dataToSignHelper)

Returns CAdESSignatureParameters from the given ASiCWithCAdESSignatureParameters and GetDataToSignASiCWithCAdESHelper

Parameters:

parameters - ASiCWithCAdESSignatureParameters

dataToSignHelper - GetDataToSignASiCWithCAdESHelper

Returns:

CAdESSignatureParameters

addSignaturePolicyStore

public DSSDocument addSignaturePolicyStore(DSSDocument asicContainer,
 SignaturePolicyStore signaturePolicyStore)

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

Parameters:

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

signaturePolicyStore - SignaturePolicyStore to add

Returns:

DSSDocument ASiC with CAdES container with an incorporated SignaturePolicyStore

assertAddSignaturePolicyStorePossible

protected void assertAddSignaturePolicyStorePossible(ASiCContent asicContent)

Description copied from class: AbstractASiCSignatureService

Verifies if incorporation of a SignaturePolicyStore is possible

Overrides:

assertAddSignaturePolicyStorePossible in class AbstractASiCSignatureService<ASiCWithCAdESSignatureParameters, ASiCWithCAdESTimestampParameters, CAdESCounterSignatureParameters, CAdESEvidenceRecordIncorporationParameters>

Parameters:

asicContent - ASiCContent

getDataToBeCounterSigned

public ToBeSigned getDataToBeCounterSigned(DSSDocument asicContainer,
 CAdESCounterSignatureParameters 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,
 CAdESCounterSignatureParameters 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,
 CAdESEvidenceRecordIncorporationParameters 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<ASiCWithCAdESSignatureParameters, ASiCWithCAdESTimestampParameters, CAdESCounterSignatureParameters, CAdESEvidenceRecordIncorporationParameters>

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

getExtensionProfile

protected ASiCWithCAdESSignatureExtension getExtensionProfile(SignatureLevel signatureLevel,
 ASiCContainerType containerType)

Returns the extension profile to be used for the current signature

Parameters:

signatureLevel - SignatureLevel

containerType - ASiCContainerType

Returns:

ASiCWithCAdESSignatureExtension related to the pre-defined profile

getLTALevelExtensionProfile

protected ASiCWithCAdESLevelBaselineLTA getLTALevelExtensionProfile()

Gets an extension profile for an LTA-level signature augmentation

Returns:

ASiCWithCAdESLevelBaselineLTA

getCAdESCounterSignatureBuilder

protected CAdESCounterSignatureBuilder getCAdESCounterSignatureBuilder()

Creates a new instance of CAdESCounterSignatureBuilder

Returns:

CAdESCounterSignatureBuilder

assertCounterSignatureParametersValid

protected void assertCounterSignatureParametersValid(CAdESCounterSignatureParameters parameters)

Description copied from class: AbstractASiCSignatureService

Verifies a validity of counter signature parameters

Overrides:

assertCounterSignatureParametersValid in class AbstractASiCSignatureService<ASiCWithCAdESSignatureParameters, ASiCWithCAdESTimestampParameters, CAdESCounterSignatureParameters, CAdESEvidenceRecordIncorporationParameters>

Parameters:

parameters - counter signature parameters to verify