Class CAdESSignature
java.lang.Object
eu.europa.esig.dss.validation.DefaultAdvancedSignature
eu.europa.esig.dss.cades.validation.CAdESSignature
- All Implemented Interfaces:
AdvancedSignature,Serializable
- Direct Known Subclasses:
PAdESSignature
public class CAdESSignature extends DefaultAdvancedSignature
CAdES Signature class helper
- See Also:
- Serialized Form
-
Field Summary
Fields inherited from class eu.europa.esig.dss.validation.DefaultAdvancedSignature
counterSignatures, detachedContents, manifestFile, offlineCertificateSource, referenceValidations, signatureCRLSource, signatureCryptographicVerification, signatureIdentifier, signatureOCSPSource, signaturePolicy, signatureTimestampSource, signingCertificateSource, structureValidationMessages -
Constructor Summary
Constructors Constructor Description CAdESSignature(org.bouncycastle.cms.CMSSignedData cmsSignedData, org.bouncycastle.cms.SignerInformation signerInformation)The default constructor for CAdESSignature. -
Method Summary
Modifier and Type Method Description voidcheckSignatureIntegrity()Verifies the signature integrity; checks if the signed content has not been tampered with.SignatureCertificateSourcegetCertificateSource()Gets a certificate source which contains ALL certificates embedded in the signature.List<SignerRole>getCertifiedSignerRoles()Returns the certified roles of the signer.List<SignerRole>getClaimedSignerRoles()Returns the claimed roles of the signer.org.bouncycastle.cms.CMSSignedDatagetCmsSignedData()Gets CMSSignedDataList<CommitmentTypeIndication>getCommitmentTypeIndications()This method obtains the information concerning commitment type indication linked to the signatureStringgetContentHints()Gets Content HintsStringgetContentIdentifier()Gets ContentIdentifier StringStringgetContentType()Returns the value of the signed attribute content-typeList<AdvancedSignature>getCounterSignatures()Returns a list of counter signatures applied to this signatureprotected org.bouncycastle.cms.SignerInformationStoregetCounterSignatureStore()Returns a SignerInformationStore containing counter signaturesOfflineCRLSourcegetCRLSource()Gets a CRL source which contains ALL CRLs embedded in the signature.StringgetDAIdentifier()This method returns an identifier provided by the Driving Application (DA) Note: used only for XAdESSignatureLevelgetDataFoundUpToLevel()This method returns the signature levelDigestgetDataToBeSignedRepresentation()TS 119 102-1 (4.2.8 Data to be signed representation (DTBSR)) : The DTBS preparation component shall take the DTBSF and hash it according to the hash algorithm specified in the cryptographic suite.DigestAlgorithmgetDigestAlgorithm()Retrieves the digest algorithm used for generating the signature.EncryptionAlgorithmgetEncryptionAlgorithm()Retrieves the encryption algorithm used for generating the signature.MaskGenerationFunctiongetMaskGenerationFunction()Retrieves the mask generation function used for generating the signature.Set<DigestAlgorithm>getMessageDigestAlgorithms()Returns a set of usedDigestAlgorithms incorporated into the CMSSignedDatabyte[]getMessageDigestValue()Returns a digest value incorporated in an attribute "message-digest" in CMS Signed DataStringgetMimeType()Returns the value of the signed attribute mime-typeOfflineOCSPSourcegetOCSPSource()Gets an OCSP source which contains ALL OCSP responses embedded in the signature.DSSDocumentgetOriginalDocument()Returns the original signed documentList<ReferenceValidation>getReferenceValidations()Returns individual validation foreach reference (XAdES) or for the message-imprint (CAdES)List<ReferenceValidation>getReferenceValidations(org.bouncycastle.cms.SignerInformation signerInformationToCheck)Returns the reference validationSignatureAlgorithmgetSignatureAlgorithm()Retrieves the signature algorithm (or cipher) used for generating the signature.SignatureDigestReferencegetSignatureDigestReference(DigestAlgorithm digestAlgorithm)TS 119 442 - V1.1.1 - Electronic Signatures and Infrastructures (ESI), ch. 5.1.4.2.1.3 XML component: In case of CAdES signatures, the input to the digest value computation shall be one of the DER-encoded instances of SignedInfo type present within the CMS structure.SignatureFormgetSignatureForm()Specifies the format of the signatureprotected SignatureIdentifierBuildergetSignatureIdentifierBuilder()Returns a builder to define and build a signature IdSignaturePolicygetSignaturePolicy()Returns the Signature Policy OID from the signature.SignaturePolicyStoregetSignaturePolicyStore()Returns the Signature Policy Store from the signatureSignatureProductionPlacegetSignatureProductionPlace()Returns information about the place where the signature was generatedbyte[]getSignatureValue()Returns the digital signature valueList<SignerRole>getSignedAssertions()Returns the list of embedded signed assertions.org.bouncycastle.cms.SignerIdgetSignerId()ReturnsSignerIdof the related to the signaturesignerInformationorg.bouncycastle.cms.SignerInformationgetSignerInformation()Gets a SignedInformationSet<CertificateIdentifier>getSignerInformationStoreInfos()Returns a Set of CertificateIdentifier extracted from a SignerInformationStore of CMS Signed DataDategetSigningTime()Returns the signing time included within the signature.CAdESTimestampSourcegetTimestampSource()Gets a Signature Timestamp source which contains ALL timestamps embedded in the signature.booleanhasAProfile()Checks if the signature has the 101733-A profilebooleanhasBProfile()Checks if the signature has the BASELINE-B profilebooleanhasCProfile()Checks if the signature has the 101733-C profilebooleanhasXProfile()Checks if the signature has the 101733-X profilebooleanisCounterSignature()Checks if the current signature is a counter signature (i.e. has a Master signature)Methods inherited from class eu.europa.esig.dss.validation.DefaultAdvancedSignature
addExternalTimestamp, areAllSelfSignedCertificates, equals, findSignatureScope, getAllTimestamps, getArchiveTimestamps, getCandidatesForSigningCertificate, getCertificates, getCertificateSourcesExceptLastArchiveTimestamp, getCompleteCertificateSource, getCompleteCRLSource, getCompleteOCSPSource, getContainerContents, getContentTimestamps, getCounterSignaturesCertificateSource, getCounterSignaturesCRLSource, getCounterSignaturesOCSPSource, getDetachedContents, getDocumentTimestamps, getDSSId, getId, getManifestFile, getMasterSignature, getSignatureCryptographicVerification, getSignatureFilename, getSignatureScopes, getSignatureTimestamps, getSignatureValidationContext, getSignerRoles, getSigningCertificateToken, getStructureValidationResult, getTimestampsX1, getTimestampsX2, hashCode, hasLTAProfile, hasLTProfile, hasTProfile, isDocHashOnlyValidation, isHashOnlyValidation, prepareCounterSignatures, prepareOfflineCertificateVerifier, prepareTimestamps, resetCertificateSource, resetRevocationSources, resetTimestampSource, setContainerContents, setDetachedContents, setManifestFile, setMasterSignature, setSignatureFilename, setSigningCertificateSource, toString, validateStructure
-
Constructor Details
-
CAdESSignature
public CAdESSignature(org.bouncycastle.cms.CMSSignedData cmsSignedData, org.bouncycastle.cms.SignerInformation signerInformation)The default constructor for CAdESSignature.- Parameters:
cmsSignedData- CMSSignedDatasignerInformation- an expanded SignerInfo block from a CMS Signed message
-
-
Method Details
-
getSignatureForm
Description copied from interface:AdvancedSignatureSpecifies the format of the signature- Returns:
SignatureForm
-
getCertificateSource
Description copied from interface:AdvancedSignatureGets a certificate source which contains ALL certificates embedded in the signature.- Returns:
SignatureCertificateSource
-
getCRLSource
Description copied from interface:AdvancedSignatureGets a CRL source which contains ALL CRLs embedded in the signature.- Returns:
OfflineRevocationSource
-
getOCSPSource
Description copied from interface:AdvancedSignatureGets an OCSP source which contains ALL OCSP responses embedded in the signature.- Returns:
OfflineRevocationSource
-
getTimestampSource
Description copied from interface:AdvancedSignatureGets a Signature Timestamp source which contains ALL timestamps embedded in the signature.- Returns:
SignatureTimestampSource
-
getSignerId
public org.bouncycastle.cms.SignerId getSignerId()ReturnsSignerIdof the related to the signaturesignerInformation- Returns:
SignerId
-
getSignaturePolicy
Description copied from interface:AdvancedSignatureReturns the Signature Policy OID from the signature.- Returns:
SignaturePolicy
-
getSignaturePolicyStore
Description copied from interface:AdvancedSignatureReturns the Signature Policy Store from the signature- Returns:
SignaturePolicyStore
-
getSigningTime
Description copied from interface:AdvancedSignatureReturns the signing time included within the signature.- Returns:
Daterepresenting the signing time or null
-
getCmsSignedData
public org.bouncycastle.cms.CMSSignedData getCmsSignedData()Gets CMSSignedData- Returns:
CMSSignedDatathe cmsSignedData
-
getSignatureProductionPlace
Description copied from interface:AdvancedSignatureReturns information about the place where the signature was generated- Returns:
SignatureProductionPlace
-
getCommitmentTypeIndications
Description copied from interface:AdvancedSignatureThis method obtains the information concerning commitment type indication linked to the signature- Returns:
- a list of
CommitmentTypeIndications
-
getSignedAssertions
Description copied from interface:AdvancedSignatureReturns the list of embedded signed assertions.- Returns:
- list of the assertions s
-
getClaimedSignerRoles
Description copied from interface:AdvancedSignatureReturns the claimed roles of the signer.- Returns:
- list of the
SignerRoles
-
getCertifiedSignerRoles
Description copied from interface:AdvancedSignatureReturns the certified roles of the signer.- Returns:
- list of the
SignerRoles
-
getEncryptionAlgorithm
Description copied from interface:AdvancedSignatureRetrieves the encryption algorithm used for generating the signature.- Returns:
EncryptionAlgorithm
-
getDigestAlgorithm
Description copied from interface:AdvancedSignatureRetrieves the digest algorithm used for generating the signature.- Returns:
DigestAlgorithm
-
getMaskGenerationFunction
Description copied from interface:AdvancedSignatureRetrieves the mask generation function used for generating the signature.- Returns:
MaskGenerationFunction
-
getSignatureAlgorithm
Description copied from interface:AdvancedSignatureRetrieves the signature algorithm (or cipher) used for generating the signature.- Returns:
SignatureAlgorithm
-
checkSignatureIntegrity
public void checkSignatureIntegrity()Description copied from interface:AdvancedSignatureVerifies the signature integrity; checks if the signed content has not been tampered with. In the case of a non-AdES signature no including the signing certificate then the latter must be provided by callingsetProvidedSigningCertificateTokenIn the case of a detached signature the signed content must be provided by callingsetProvidedSigningCertificateToken -
getReferenceValidations
public List<ReferenceValidation> getReferenceValidations(org.bouncycastle.cms.SignerInformation signerInformationToCheck)Returns the reference validation- Parameters:
signerInformationToCheck-SignerInformation- Returns:
- a list of
ReferenceValidations
-
getReferenceValidations
Description copied from interface:AdvancedSignatureReturns individual validation foreach reference (XAdES) or for the message-imprint (CAdES)- Returns:
- a list with one or more
ReferenceValidation
-
getSignatureDigestReference
TS 119 442 - V1.1.1 - Electronic Signatures and Infrastructures (ESI), ch. 5.1.4.2.1.3 XML component: In case of CAdES signatures, the input to the digest value computation shall be one of the DER-encoded instances of SignedInfo type present within the CMS structure.- Parameters:
digestAlgorithm-DigestAlgorithmto use- Returns:
SignatureDigestReference
-
getDataToBeSignedRepresentation
Description copied from interface:AdvancedSignatureTS 119 102-1 (4.2.8 Data to be signed representation (DTBSR)) : The DTBS preparation component shall take the DTBSF and hash it according to the hash algorithm specified in the cryptographic suite.- Returns:
DigestDTBSR, which is then used to create the signature.
-
getMessageDigestAlgorithms
Returns a set of usedDigestAlgorithms incorporated into the CMSSignedData- Returns:
- a set of
DigestAlgorithms
-
getMessageDigestValue
public byte[] getMessageDigestValue()Returns a digest value incorporated in an attribute "message-digest" in CMS Signed Data- Returns:
- a byte array representing a signed content digest value
-
getContentType
Description copied from interface:AdvancedSignatureReturns the value of the signed attribute content-type- Returns:
- content type as
String
-
getMimeType
Description copied from interface:AdvancedSignatureReturns the value of the signed attribute mime-type- Returns:
- mime type as
String
-
getContentIdentifier
Gets ContentIdentifier String- Returns:
- content identifier as
String
-
getContentHints
Gets Content Hints- Returns:
- content hints as
String
-
getSignerInformation
public org.bouncycastle.cms.SignerInformation getSignerInformation()Gets a SignedInformation- Returns:
SignerInformationthe signerInformation
-
getSignatureValue
public byte[] getSignatureValue()Description copied from interface:AdvancedSignatureReturns the digital signature value- Returns:
- digital signature value byte array
-
isCounterSignature
public boolean isCounterSignature()Description copied from interface:AdvancedSignatureChecks if the current signature is a counter signature (i.e. has a Master signature)- Specified by:
isCounterSignaturein interfaceAdvancedSignature- Overrides:
isCounterSignaturein classDefaultAdvancedSignature- Returns:
- TRUE if it is a counter signature, FALSE otherwise
-
getCounterSignatures
Description copied from interface:AdvancedSignatureReturns a list of counter signatures applied to this signature- Returns:
- a
ListofAdvancedSignaturesrepresenting the counter signatures
-
getCounterSignatureStore
protected org.bouncycastle.cms.SignerInformationStore getCounterSignatureStore()Returns a SignerInformationStore containing counter signatures- Returns:
SignerInformationStore
-
getOriginalDocument
Returns the original signed document- Returns:
DSSDocument
-
getSignatureIdentifierBuilder
Description copied from class:DefaultAdvancedSignatureReturns a builder to define and build a signature Id- Specified by:
getSignatureIdentifierBuilderin classDefaultAdvancedSignature- Returns:
SignatureIdentifierBuilder
-
getDAIdentifier
Description copied from interface:AdvancedSignatureThis method returns an identifier provided by the Driving Application (DA) Note: used only for XAdES- Returns:
- The signature identifier
-
getSignerInformationStoreInfos
Returns a Set of CertificateIdentifier extracted from a SignerInformationStore of CMS Signed Data- Returns:
- a Set of
CertificateIdentifiers
-
getDataFoundUpToLevel
Description copied from interface:AdvancedSignatureThis method returns the signature level- Returns:
- a value of
SignatureLevel
-
hasBProfile
public boolean hasBProfile()Checks if the signature has the BASELINE-B profile- Returns:
- TRUE if the signature has a BASELINE-B profile, FALSE otherwise
-
hasCProfile
public boolean hasCProfile()Checks if the signature has the 101733-C profile- Returns:
- TRUE if the signature has a 101733-C profile, FALSE otherwise
-
hasXProfile
public boolean hasXProfile()Checks if the signature has the 101733-X profile- Returns:
- TRUE if the signature has a 101733-X profile, FALSE otherwise
-
hasAProfile
public boolean hasAProfile()Checks if the signature has the 101733-A profile- Returns:
- TRUE if the signature has a 101733-A profile, FALSE otherwise
-