Package eu.europa.esig.dss.jades.signature

Class JAdESService

java.lang.Object

eu.europa.esig.dss.signature.AbstractSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>

eu.europa.esig.dss.jades.signature.JAdESService

All Implemented Interfaces:

CounterSignatureService<JAdESCounterSignatureParameters>, DocumentSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>, MultipleDocumentsSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>, Serializable

public class JAdESService
extends AbstractSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>
implements MultipleDocumentsSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>, CounterSignatureService<JAdESCounterSignatureParameters>

Contains methods for JAdES signature creation/extension

See Also:

• Serialized Form

Field Summary

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

certificateVerifier, tspSource

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DSSDocument	addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore)	Incorporates a Signature Policy Store as a base64Url-encoded unsigned property into the JAdES Signature
DSSDocument	addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore, boolean base64UrlInstance)	Incorporates a Signature Policy Store as an unsigned property into the JAdES Signature
protected void	assertSigningCertificateValid(AbstractSignatureParameters<?> parameters)	This method raises an exception if the signing rules forbid the use the certificate.
DSSDocument	counterSignSignature(DSSDocument signatureDocument, JAdESCounterSignatureParameters parameters, SignatureValue signatureValue)	Counter signs the signatureDocument with the provided signatureValue.
DSSDocument	extendDocument(DSSDocument toExtendDocument, JAdESSignatureParameters parameters)	Extends the level of the signatures in the toExtendDocument
TimestampToken	getContentTimestamp(DSSDocument toSignDocument, JAdESSignatureParameters parameters)	This method allows to compute a content-timestamp (which is added in the signed properties)
TimestampToken	getContentTimestamp(List<DSSDocument> toSignDocuments, JAdESSignatureParameters parameters)	This methods allows to create a TimestampToken for a detached JAdES (with a 'sigD' parameter).
ToBeSigned	getDataToBeCounterSigned(DSSDocument signatureDocument, JAdESCounterSignatureParameters parameters)	Retrieves the bytes of the data that need to be counter signed from signatureDocument.
ToBeSigned	getDataToSign(DSSDocument toSignDocument, JAdESSignatureParameters parameters)	Retrieves the bytes of the data that need to be signed based on the toSignDocument and parameters.
ToBeSigned	getDataToSign(List<DSSDocument> toSignDocuments, JAdESSignatureParameters parameters)	Retrieves the bytes of the data that need to be signed based on the toSignDocuments and parameters.
protected JAdESBuilder	getJAdESBuilder(JAdESSignatureParameters parameters, List<DSSDocument> documentsToSign)	Returns the JAdESBuilder to be used
boolean	isValidSignatureValue(ToBeSigned toBeSigned, SignatureValue signatureValue, CertificateToken signingCertificate)	Verifies the signature value against a ToBeSigned and a CertificateToken
DSSDocument	signDocument(DSSDocument toSignDocument, JAdESSignatureParameters parameters, SignatureValue signatureValue)	Signs the toSignDocument with the provided signatureValue.
DSSDocument	signDocument(List<DSSDocument> toSignDocuments, JAdESSignatureParameters parameters, SignatureValue signatureValue)	Signs the toSignDocuments with the provided signatureValue.
DSSDocument	timestamp(List<DSSDocument> toTimestampDocuments, JAdESTimestampParameters parameters)	Timestamps the toSignDocuments with the provided signatureValue.

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

ensureSignatureValue, getFinalDocumentName, getFinalDocumentName, getFinalFileName, getFinalFileName, getFinalFileName, setTspSource, timestamp

Methods inherited from class java.lang.Object

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

Constructor Details

JAdESService

public JAdESService(CertificateVerifier certificateVerifier)

This is the constructor to create an instance of the JAdESService. 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,
 JAdESSignatureParameters 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<JAdESSignatureParameters,JAdESTimestampParameters>

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,
 JAdESSignatureParameters parameters)

This methods allows to create a TimestampToken for a detached JAdES (with a 'sigD' parameter). NOTE: The toSignDocuments must be present in the same order they will be passed to signature computation process

Specified by:

getContentTimestamp in interface MultipleDocumentsSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>

Parameters:

toSignDocuments - a list of DSSDocuments to be timestamped

parameters - JAdESSignatureParameters

Returns:

content TimestampToken

getDataToSign

public ToBeSigned getDataToSign(DSSDocument toSignDocument,
 JAdESSignatureParameters 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<JAdESSignatureParameters,JAdESTimestampParameters>

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,
 JAdESSignatureParameters 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<JAdESSignatureParameters,JAdESTimestampParameters>

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

Description copied from interface: DocumentSignatureService

Signs the toSignDocument with the provided signatureValue.

Specified by:

signDocument in interface DocumentSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>

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

Description copied from interface: MultipleDocumentsSignatureService

Signs the toSignDocuments with the provided signatureValue.

Specified by:

signDocument in interface MultipleDocumentsSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>

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

getJAdESBuilder

protected JAdESBuilder getJAdESBuilder(JAdESSignatureParameters parameters,
 List<DSSDocument> documentsToSign)

Returns the JAdESBuilder to be used

Parameters:

parameters - JAdESSignatureParameters

documentsToSign - a list of DSSDocuments

Returns:

JAdESBuilder

extendDocument

public DSSDocument extendDocument(DSSDocument toExtendDocument,
 JAdESSignatureParameters parameters)

Description copied from interface: MultipleDocumentsSignatureService

Extends the level of the signatures in the toExtendDocument

Specified by:

extendDocument in interface DocumentSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>

Specified by:

extendDocument in interface MultipleDocumentsSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>

Parameters:

toExtendDocument - document to extend

parameters - set of the driving signing parameters

Returns:

the extended signature

timestamp

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

Description copied from interface: MultipleDocumentsSignatureService

Timestamps the toSignDocuments with the provided signatureValue.

Specified by:

timestamp in interface MultipleDocumentsSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>

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 a base64Url-encoded unsigned property into the JAdES Signature

Parameters:

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

signaturePolicyStore - SignaturePolicyStore to add

Returns:

DSSDocument JAdESSignature with an incorporates SignaturePolicyStore

addSignaturePolicyStore

public DSSDocument addSignaturePolicyStore(DSSDocument document,
 SignaturePolicyStore signaturePolicyStore,
 boolean base64UrlInstance)

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

Parameters:

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

signaturePolicyStore - SignaturePolicyStore to add

base64UrlInstance - defines if the SignaturePolicyStore shall be incorporated in its corresponding base64Url representation, otherwise if FALSE incorporates in the clear JSON representation

Returns:

DSSDocument JAdESSignature with an incorporates SignaturePolicyStore

getDataToBeCounterSigned

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

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

Description copied from interface: CounterSignatureService

Counter signs the signatureDocument with the provided signatureValue.

Specified by:

counterSignSignature in interface CounterSignatureService<JAdESCounterSignatureParameters>

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

isValidSignatureValue

public boolean isValidSignatureValue(ToBeSigned toBeSigned,
 SignatureValue signatureValue,
 CertificateToken signingCertificate)

Description copied from interface: DocumentSignatureService

Verifies the signature value against a ToBeSigned and a CertificateToken

Specified by:

isValidSignatureValue in interface DocumentSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>

Specified by:

isValidSignatureValue in interface MultipleDocumentsSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>

Overrides:

isValidSignatureValue in class AbstractSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>

Parameters:

toBeSigned - the signed data

signatureValue - the signature value

signingCertificate - the used certificate to create the signature value

Returns:

true if the signature value is valid

assertSigningCertificateValid

protected void assertSigningCertificateValid(AbstractSignatureParameters<?> parameters)

Description copied from class: AbstractSignatureService

This method raises an exception if the signing rules forbid the use the certificate.

Overrides:

assertSigningCertificateValid in class AbstractSignatureService<JAdESSignatureParameters,JAdESTimestampParameters>

Parameters:

parameters - set of driving signing parameters