Class CAdESService
java.lang.Object
eu.europa.esig.dss.signature.AbstractSignatureService<CAdESSignatureParameters,CAdESTimestampParameters>
eu.europa.esig.dss.cades.signature.CAdESService
- All Implemented Interfaces:
EvidenceRecordIncorporationService<CAdESEvidenceRecordIncorporationParameters>,CounterSignatureService<CAdESCounterSignatureParameters>,DocumentSignatureService<CAdESSignatureParameters,,CAdESTimestampParameters> Serializable
public class CAdESService
extends AbstractSignatureService<CAdESSignatureParameters,CAdESTimestampParameters>
implements CounterSignatureService<CAdESCounterSignatureParameters>, EvidenceRecordIncorporationService<CAdESEvidenceRecordIncorporationParameters>
CAdES implementation of DocumentSignatureService
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected DSSResourcesHandlerBuilderThis object is used to create data container objects such as an OutputStream or a DSSDocumentFields inherited from class eu.europa.esig.dss.signature.AbstractSignatureService
certificateVerifier, tspSource -
Constructor Summary
ConstructorsConstructorDescriptionCAdESService(CertificateVerifier certificateVerifier) This is the constructor to create an instance of theCAdESService. -
Method Summary
Modifier and TypeMethodDescriptionaddSignatureEvidenceRecord(DSSDocument signatureDocument, DSSDocument evidenceRecordDocument, CAdESEvidenceRecordIncorporationParameters parameters) Incorporates the Evidence Record as an unsigned property into the signatureaddSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore) Incorporates a Signature Policy Store as an unsigned property into the CAdES SignaturecounterSignSignature(DSSDocument signatureDocument, CAdESCounterSignatureParameters parameters, SignatureValue signatureValue) Counter-signs thesignatureDocumentwith the provided signatureValue.extendDocument(DSSDocument toExtendDocument, CAdESSignatureParameters parameters) Extends the level of the signatures in thetoExtendDocumentprotected CAdESCounterSignatureBuilderLoads the relevantCAdESCounterSignatureBuilderprotected CAdESSignaturePolicyStoreBuilderLoads the relevantCAdESSignaturePolicyStoreBuildergetContentTimestamp(DSSDocument toSignDocument, CAdESSignatureParameters parameters) This method allows to compute a content-timestamp (which is added in the signed properties)getDataToBeCounterSigned(DSSDocument signatureDocument, CAdESCounterSignatureParameters parameters) Retrieves the bytes of the data that need to be counter-signed fromsignatureDocument.getDataToBeCounterSigned(org.bouncycastle.cms.SignerInformation signerInfoToCounterSign, CAdESSignatureParameters parameters) Returns a data toBeSigned for a counter signature on the givensignerInfoToCounterSigngetDataToSign(DSSDocument toSignDocument, CAdESSignatureParameters parameters) Retrieves the bytes of the data that need to be signed based on thetoSignDocumentandparameters.voidsetResourcesHandlerBuilder(DSSResourcesHandlerBuilder resourcesHandlerBuilder) This method sets aDSSResourcesHandlerBuilderto be used for operating with internal objects during the signature creation procedure.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, timestampMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface eu.europa.esig.dss.signature.CounterSignatureService
setTspSource
-
Field Details
-
resourcesHandlerBuilder
This object is used to create data container objects such as an OutputStream or a DSSDocument
-
-
Constructor Details
-
CAdESService
This is the constructor to create an instance of theCAdESService. A certificate verifier must be provided.- Parameters:
certificateVerifier-CertificateVerifierprovides information on the sources to be used in the validation process in the context of a signature.
-
-
Method Details
-
setResourcesHandlerBuilder
This method sets aDSSResourcesHandlerBuilderto be used for operating with internal objects during the signature creation procedure. NOTE: TheDSSResourcesHandlerBuilderis supported only within the 'dss-cms-stream' module!- Parameters:
resourcesHandlerBuilder-DSSResourcesHandlerBuilder
-
getContentTimestamp
public TimestampToken getContentTimestamp(DSSDocument toSignDocument, CAdESSignatureParameters parameters) Description copied from interface:DocumentSignatureServiceThis method allows to compute a content-timestamp (which is added in the signed properties)- Specified by:
getContentTimestampin interfaceDocumentSignatureService<CAdESSignatureParameters,CAdESTimestampParameters> - Parameters:
toSignDocument- document to sign or the already existing signatureparameters- set of the driving signing parameters- Returns:
- a timestamp token
-
getDataToSign
Description copied from interface:DocumentSignatureServiceRetrieves the bytes of the data that need to be signed based on thetoSignDocumentandparameters. WhentoSignDocumentcontains 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:
getDataToSignin interfaceDocumentSignatureService<CAdESSignatureParameters,CAdESTimestampParameters> - Parameters:
toSignDocument- document to sign or the already existing signatureparameters- 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:DocumentSignatureServiceSigns the toSignDocument with the provided signatureValue.- Specified by:
signDocumentin interfaceDocumentSignatureService<CAdESSignatureParameters,CAdESTimestampParameters> - Parameters:
toSignDocument- document to signparameters- set of the driving signing parameterssignatureValue- the signature value to incorporate- Returns:
- the signed document (
toSignDocumentwith the incorporated signature or the detached signature)
-
extendDocument
public DSSDocument extendDocument(DSSDocument toExtendDocument, CAdESSignatureParameters parameters) Description copied from interface:DocumentSignatureServiceExtends the level of the signatures in thetoExtendDocument- Specified by:
extendDocumentin interfaceDocumentSignatureService<CAdESSignatureParameters,CAdESTimestampParameters> - Parameters:
toExtendDocument- document to extendparameters- 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-DSSDocumentcontaining a CAdES Signature to add a SignaturePolicyStore tosignaturePolicyStore-SignaturePolicyStoreto add- Returns:
DSSDocumentCAdESSignature with an incorporated SignaturePolicyStore
-
getCAdESSignaturePolicyStoreBuilder
Loads the relevantCAdESSignaturePolicyStoreBuilder- Returns:
CAdESSignaturePolicyStoreBuilder
-
getDataToBeCounterSigned
public ToBeSigned getDataToBeCounterSigned(DSSDocument signatureDocument, CAdESCounterSignatureParameters parameters) Description copied from interface:CounterSignatureServiceRetrieves the bytes of the data that need to be counter-signed fromsignatureDocument.signatureDocumentshall be a valid signature of the same type- Specified by:
getDataToBeCounterSignedin interfaceCounterSignatureService<CAdESCounterSignatureParameters>- Parameters:
signatureDocument-DSSDocumentrepresenting the original signature to be counter-signedparameters- set of the driving signing parameters for a counter-signature- Returns:
ToBeSignedto be counter-signed byte array (signature value retrieved from thesignatureDocument)
-
getDataToBeCounterSigned
public ToBeSigned getDataToBeCounterSigned(org.bouncycastle.cms.SignerInformation signerInfoToCounterSign, CAdESSignatureParameters parameters) Returns a data toBeSigned for a counter signature on the givensignerInfoToCounterSign- Parameters:
signerInfoToCounterSign-SignerInformationto counter-signparameters-CAdESSignatureParameters- Returns:
ToBeSigned
-
counterSignSignature
public DSSDocument counterSignSignature(DSSDocument signatureDocument, CAdESCounterSignatureParameters parameters, SignatureValue signatureValue) Description copied from interface:CounterSignatureServiceCounter-signs thesignatureDocumentwith the provided signatureValue.- Specified by:
counterSignSignaturein interfaceCounterSignatureService<CAdESCounterSignatureParameters>- Parameters:
signatureDocument-DSSDocumentto be counter-signedparameters- set of the driving signing parameters for a counter-signaturesignatureValue-SignatureValuethe signature value to incorporate- Returns:
DSSDocumentthe signature document enveloping a newly created counter-signature
-
getCAdESCounterSignatureBuilder
Loads the relevantCAdESCounterSignatureBuilder- Returns:
CAdESCounterSignatureBuilder
-
addSignatureEvidenceRecord
public DSSDocument addSignatureEvidenceRecord(DSSDocument signatureDocument, DSSDocument evidenceRecordDocument, CAdESEvidenceRecordIncorporationParameters parameters) Description copied from interface:EvidenceRecordIncorporationServiceIncorporates the Evidence Record as an unsigned property into the signature- Specified by:
addSignatureEvidenceRecordin interfaceEvidenceRecordIncorporationService<CAdESEvidenceRecordIncorporationParameters>- Parameters:
signatureDocument-DSSDocumentcontaining the signature to add the evidence record intoevidenceRecordDocument-DSSDocumentto addparameters-SerializableEvidenceRecordIncorporationParametersproviding configuration for the evidence record incorporation- Returns:
DSSDocumentsignature document with an incorporated evidence record
-