Package eu.europa.esig.dss.cades.signature

Class CAdESService

java.lang.Object

eu.europa.esig.dss.signature.AbstractSignatureService<CAdESSignatureParameters,CAdESTimestampParameters>

eu.europa.esig.dss.cades.signature.CAdESService

All Implemented Interfaces:

CounterSignatureService<CAdESCounterSignatureParameters>, DocumentSignatureService<CAdESSignatureParameters,CAdESTimestampParameters>, Serializable

public class CAdESService
extends AbstractSignatureService<CAdESSignatureParameters,CAdESTimestampParameters>
implements CounterSignatureService<CAdESCounterSignatureParameters>

CAdES implementation of DocumentSignatureService

See Also:

• Serialized Form

Field Summary

Fields inherited from class eu.europa.esig.dss.signature.AbstractSignatureService

certificateVerifier, tspSource

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DSSDocument	addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore)	Incorporates a Signature Policy Store as an unsigned property into the CAdES Signature
DSSDocument	counterSignSignature(DSSDocument signatureDocument, CAdESCounterSignatureParameters parameters, SignatureValue signatureValue)	Counter-signs the signatureDocument with the provided signatureValue.
DSSDocument	extendDocument(DSSDocument toExtendDocument, CAdESSignatureParameters parameters)	Extends the level of the signatures in the toExtendDocument
TimestampToken	getContentTimestamp(DSSDocument toSignDocument, CAdESSignatureParameters parameters)	This method allows to compute a content-timestamp (which is added in the signed properties)
ToBeSigned	getDataToBeCounterSigned(DSSDocument signatureDocument, CAdESCounterSignatureParameters parameters)	Retrieves the bytes of the data that need to be counter-signed from signatureDocument.
ToBeSigned	getDataToBeCounterSigned(org.bouncycastle.cms.SignerInformation signerInfoToCounterSign, CAdESSignatureParameters parameters)	Returns a data toBeSigned for a counter signature on the given signerInfoToCounterSign
ToBeSigned	getDataToSign(DSSDocument toSignDocument, CAdESSignatureParameters parameters)	Retrieves the bytes of the data that need to be signed based on the toSignDocument and parameters.
DSSDocument	signDocument(DSSDocument toSignDocument, CAdESSignatureParameters parameters, SignatureValue signatureValue)	Signs the toSignDocument with the provided signatureValue.

Methods inherited from class eu.europa.esig.dss.signature.AbstractSignatureService

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.europa.esig.dss.signature.CounterSignatureService

setTspSource

Constructor Details

CAdESService

public CAdESService(CertificateVerifier certificateVerifier)

This is the constructor to create an instance of the CAdESService. 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,
 CAdESSignatureParameters 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<CAdESSignatureParameters,CAdESTimestampParameters>

Parameters:

toSignDocument - document to sign or the already existing signature

parameters - set of the driving signing parameters

Returns:

a timestamp token

getDataToSign

public ToBeSigned getDataToSign(DSSDocument toSignDocument,
 CAdESSignatureParameters 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<CAdESSignatureParameters,CAdESTimestampParameters>

Parameters:

toSignDocument - document to sign or the already existing signature

parameters - set of the driving signing parameters

Returns:

the data to be signed

signDocument

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

Description copied from interface: DocumentSignatureService

Signs the toSignDocument with the provided signatureValue.

Specified by:

signDocument in interface DocumentSignatureService<CAdESSignatureParameters,CAdESTimestampParameters>

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)

extendDocument

public DSSDocument extendDocument(DSSDocument toExtendDocument,
 CAdESSignatureParameters parameters)

Description copied from interface: DocumentSignatureService

Extends the level of the signatures in the toExtendDocument

Specified by:

extendDocument in interface DocumentSignatureService<CAdESSignatureParameters,CAdESTimestampParameters>

Parameters:

toExtendDocument - document to extend

parameters - set of the driving signing parameters

Returns:

the extended signature

addSignaturePolicyStore

public DSSDocument addSignaturePolicyStore(DSSDocument document,
 SignaturePolicyStore signaturePolicyStore)

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

Parameters:

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

signaturePolicyStore - SignaturePolicyStore to add

Returns:

DSSDocument CAdESSignature with an incorporated SignaturePolicyStore

getDataToBeCounterSigned

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

Specified by:

getDataToBeCounterSigned in interface CounterSignatureService<CAdESCounterSignatureParameters>

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)

getDataToBeCounterSigned

public ToBeSigned getDataToBeCounterSigned(org.bouncycastle.cms.SignerInformation signerInfoToCounterSign,
 CAdESSignatureParameters parameters)

Returns a data toBeSigned for a counter signature on the given signerInfoToCounterSign

Parameters:

signerInfoToCounterSign - SignerInformation to counter-sign

parameters - CAdESSignatureParameters

Returns:

ToBeSigned

counterSignSignature

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

Description copied from interface: CounterSignatureService

Counter-signs the signatureDocument with the provided signatureValue.

Specified by:

counterSignSignature in interface CounterSignatureService<CAdESCounterSignatureParameters>

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