eu.europa.esig.dss.validation

Class DefaultAdvancedSignature

java.lang.Object

eu.europa.esig.dss.validation.DefaultAdvancedSignature

All Implemented Interfaces:

AdvancedSignature, Serializable

public abstract class DefaultAdvancedSignature
extends Object
implements AdvancedSignature

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultAdvancedSignature.RevocationDataForInclusion

Field Summary

Fields

Modifier and Type	Field and Description
protected List<TimestampToken>	archiveTimestamps
protected CandidatesForSigningCertificate	candidatesForSigningCertificate The reference to the object containing all candidates to the signing certificate.
protected CertificatePool	certPool This is the reference to the global (external) pool of certificates.
protected List<TimestampToken>	contentTimestamps
protected List<DSSDocument>	detachedContents In case of a detached signature this is the signed document.
protected OfflineCRLSource	offlineCRLSource
protected OfflineOCSPSource	offlineOCSPSource
protected CertificateToken	providedSigningCertificateToken In the case of a non AdES signature the signing certificate is not mandatory within the signature and can be provided by the driving application.
protected List<TimestampToken>	refsOnlyTimestamps
protected List<TimestampToken>	sigAndRefsTimestamps
protected SignatureCryptographicVerification	signatureCryptographicVerification This variable contains the result of the signature mathematical validation.
protected SignaturePolicy	signaturePolicy
protected List<TimestampToken>	signatureTimestamps
protected String	structureValidation
protected Set<DigestAlgorithm>	usedCertificatesDigestAlgorithms This list represents all digest algorithms used to calculate the digest values of certificates.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultAdvancedSignature(CertificatePool certPool)

Method Summary

Methods

Modifier and Type	Method and Description
void	addExternalTimestamp(TimestampToken timestamp) This method allows to add an external timestamp.
protected void	addReferencesFromOfflineCRLSource(List<TimestampReference> references) This method adds references to retrieved CRL responses from LT level.
protected void	addReferencesFromOfflineOCSPSource(List<TimestampReference> references) This method adds references to retrieved OCSP responses from LT level.
void	checkSignaturePolicy(SignaturePolicyProvider signaturePolicyDetector)
void	findSignatureScope(SignatureScopeFinder signatureScopeFinder)
List<CertificateToken>	getCertificates() Returns an unmodifiable list of all certificate tokens encapsulated in the signature
Set<CertificateToken>	getCertificatesForInclusion(ValidationContext validationContext) This method returns all certificates used during the validation process.
List<CertificateToken>	getCertificatesWithinSignatureAndTimestamps()
Map<String,List<CertificateToken>>	getCertificatesWithinSignatureAndTimestamps(boolean skipLastArchiveTimestamp)
SignatureLevel	getDataFoundUpToLevel()
List<DSSDocument>	getDetachedContents()
AdvancedSignature	getMasterSignature()
SignaturePolicy	getPolicyId() Returns the Signature Policy OID from the signature.
CertificateToken	getProvidedSigningCertificateToken()
DefaultAdvancedSignature.RevocationDataForInclusion	getRevocationDataForInclusion(ValidationContext validationContext) This method returns revocation values (ocsp and crl) that will be included in the LT profile.
SignatureCryptographicVerification	getSignatureCryptographicVerification()
String	getSignatureFilename() This method returns the signature filename (useful for ASiC and multiple signature files)
List<SignatureScope>	getSignatureScopes()
ValidationContext	getSignatureValidationContext(CertificateVerifier certificateVerifier) This method validates the signing certificate and all timestamps.
CertificateToken	getSigningCertificateToken() This method returns the signing certificate token or null if there is no valid signing certificate.
String	getStructureValidationResult()
Set<DigestAlgorithm>	getUsedCertificatesDigestAlgorithms() Returns the set of digest algorithms used to build the certificate's digest.
boolean	hasLTAProfile()
boolean	hasLTProfile()
boolean	hasTProfile()
void	prepareTimestamps(ValidationContext validationContext) This method adds to the ValidationContext all timestamps to be validated.
void	setDetachedContents(List<DSSDocument> detachedContents) This method allows to set the signed contents in the case of the detached signature.
void	setMasterSignature(AdvancedSignature masterSignature) This setter allows to indicate the master signature.
void	setProvidedSigningCertificateToken(CertificateToken certificateToken) This method allows to provide a signing certificate to be used in the validation process.
void	setSignatureFilename(String signatureFilename) This method allows to set the signature filename (useful in case of ASiC)
void	validateStructure() This method allows the structure validation of the signature.
void	validateTimestamps() This method adds all timestamps to be validated.

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.validation.AdvancedSignature

checkSignatureIntegrity, checkSigningCertificate, getArchiveTimestampData, getArchiveTimestamps, getCandidatesForSigningCertificate, getCertificateRefs, getCertificateSource, getCertifiedSignerRoles, getClaimedSignerRoles, getCommitmentTypeIndication, getContentHints, getContentIdentifier, getContentTimestampData, getContentTimestamps, getContentType, getCounterSignatures, getCRLRefs, getCRLSource, getDigestAlgorithm, getEncryptionAlgorithm, getId, getMaskGenerationFunction, getOCSPRefs, getOCSPSource, getSignatureAlgorithm, getSignatureForm, getSignatureLevels, getSignatureProductionPlace, getSignatureTimestampData, getSignatureTimestamps, getSigningTime, getTimestampedReferences, getTimestampsX1, getTimestampsX2, getTimestampX1Data, getTimestampX2Data, isDataForSignatureLevelPresent

Field Detail

certPool

protected final CertificatePool certPool

This is the reference to the global (external) pool of certificates. All encapsulated certificates in the signature are added to this pool. See CertificatePool

providedSigningCertificateToken

protected CertificateToken providedSigningCertificateToken

In the case of a non AdES signature the signing certificate is not mandatory within the signature and can be provided by the driving application.

detachedContents

protected List<DSSDocument> detachedContents

In case of a detached signature this is the signed document.

signatureCryptographicVerification

protected SignatureCryptographicVerification signatureCryptographicVerification

This variable contains the result of the signature mathematical validation. It is initialised when the method checkSignatureIntegrity is called.

structureValidation

protected String structureValidation

candidatesForSigningCertificate

protected CandidatesForSigningCertificate candidatesForSigningCertificate

The reference to the object containing all candidates to the signing certificate.

contentTimestamps

protected List<TimestampToken> contentTimestamps

signatureTimestamps

protected transient List<TimestampToken> signatureTimestamps

sigAndRefsTimestamps

protected List<TimestampToken> sigAndRefsTimestamps

refsOnlyTimestamps

protected List<TimestampToken> refsOnlyTimestamps

archiveTimestamps

protected List<TimestampToken> archiveTimestamps

offlineCRLSource

protected OfflineCRLSource offlineCRLSource

offlineOCSPSource

protected OfflineOCSPSource offlineOCSPSource

signaturePolicy

protected SignaturePolicy signaturePolicy

usedCertificatesDigestAlgorithms

protected Set<DigestAlgorithm> usedCertificatesDigestAlgorithms

This list represents all digest algorithms used to calculate the digest values of certificates.

Constructor Detail

DefaultAdvancedSignature

protected DefaultAdvancedSignature(CertificatePool certPool)

Parameters:

certPool - can be null

Method Detail

getSignatureFilename

public String getSignatureFilename()

Description copied from interface: AdvancedSignature

This method returns the signature filename (useful for ASiC and multiple signature files)

Specified by:

getSignatureFilename in interface AdvancedSignature

Returns:

the signature filename

setSignatureFilename

public void setSignatureFilename(String signatureFilename)

Description copied from interface: AdvancedSignature

This method allows to set the signature filename (useful in case of ASiC)

Specified by:

setSignatureFilename in interface AdvancedSignature

getDetachedContents

public List<DSSDocument> getDetachedContents()

Specified by:

getDetachedContents in interface AdvancedSignature

Returns:

in the case of the detached signature this is the List of signed contents.

setDetachedContents

public void setDetachedContents(List<DSSDocument> detachedContents)

Description copied from interface: AdvancedSignature

This method allows to set the signed contents in the case of the detached signature.

Specified by:

setDetachedContents in interface AdvancedSignature

Parameters:

detachedContents - List of DSSDocument representing the signed detached contents.

getDataFoundUpToLevel

public SignatureLevel getDataFoundUpToLevel()

Specified by:

getDataFoundUpToLevel in interface AdvancedSignature

Returns:

the upper level for which data have been found. Doesn't mean any validity of the data found. Null if unknown.

getSignatureValidationContext

public ValidationContext getSignatureValidationContext(CertificateVerifier certificateVerifier)

This method validates the signing certificate and all timestamps.

Returns:

signature validation context containing all certificates and revocation data used during the validation process.

getCertificates

public List<CertificateToken> getCertificates()

Returns an unmodifiable list of all certificate tokens encapsulated in the signature

Specified by:

getCertificates in interface AdvancedSignature

Returns:

a list of certificate contained within the signature

See Also:

AdvancedSignature.getCertificates()

getCertificatesForInclusion

public Set<CertificateToken> getCertificatesForInclusion(ValidationContext validationContext)

This method returns all certificates used during the validation process. If a certificate is already present within the signature then it is ignored.

Parameters:

validationContext - validation context containing all information about the validation process of the signing certificate and time-stamps

Returns:

set of certificates not yet present within the signature

getCertificatesWithinSignatureAndTimestamps

public List<CertificateToken> getCertificatesWithinSignatureAndTimestamps()

getCertificatesWithinSignatureAndTimestamps

public Map<String,List<CertificateToken>> getCertificatesWithinSignatureAndTimestamps(boolean skipLastArchiveTimestamp)

getRevocationDataForInclusion

public DefaultAdvancedSignature.RevocationDataForInclusion getRevocationDataForInclusion(ValidationContext validationContext)

This method returns revocation values (ocsp and crl) that will be included in the LT profile.

Parameters:

validationContext - ValidationContext contains all the revocation data retrieved during the validation process.

Returns:

RevocationDataForInclusion

setMasterSignature

public void setMasterSignature(AdvancedSignature masterSignature)

Description copied from interface: AdvancedSignature

This setter allows to indicate the master signature. It means that this is a countersignature.

Specified by:

setMasterSignature in interface AdvancedSignature

Parameters:

masterSignature - AdvancedSignature

getMasterSignature

public AdvancedSignature getMasterSignature()

Specified by:

getMasterSignature in interface AdvancedSignature

Returns:

AdvancedSignature

getSignatureCryptographicVerification

public SignatureCryptographicVerification getSignatureCryptographicVerification()

Specified by:

getSignatureCryptographicVerification in interface AdvancedSignature

Returns:

SignatureCryptographicVerification with all the information collected during the validation process.

getProvidedSigningCertificateToken

public CertificateToken getProvidedSigningCertificateToken()

Specified by:

getProvidedSigningCertificateToken in interface AdvancedSignature

Returns:

This method returns the provided signing certificate or null

setProvidedSigningCertificateToken

public void setProvidedSigningCertificateToken(CertificateToken certificateToken)

Description copied from interface: AdvancedSignature

This method allows to provide a signing certificate to be used in the validation process. It can happen in the case of a non-AdES signature without the signing certificate within the signature.

Specified by:

setProvidedSigningCertificateToken in interface AdvancedSignature

Parameters:

certificateToken - CertificateToken representing the signing certificate token.

getSigningCertificateToken

public CertificateToken getSigningCertificateToken()

Description copied from interface: AdvancedSignature

This method returns the signing certificate token or null if there is no valid signing certificate. Note that to determinate the signing certificate the signature must be validated: the method checkSignatureIntegrity must be called.

Specified by:

getSigningCertificateToken in interface AdvancedSignature

Returns:

prepareTimestamps

public void prepareTimestamps(ValidationContext validationContext)

This method adds to the ValidationContext all timestamps to be validated.

Specified by:

prepareTimestamps in interface AdvancedSignature

Parameters:

validationContext - ValidationContext to which the timestamps must be added

validateTimestamps

public void validateTimestamps()

This method adds all timestamps to be validated.

Specified by:

validateTimestamps in interface AdvancedSignature

validateStructure

public void validateStructure()

Description copied from interface: AdvancedSignature

This method allows the structure validation of the signature.

Specified by:

validateStructure in interface AdvancedSignature

getStructureValidationResult

public String getStructureValidationResult()

Specified by:

getStructureValidationResult in interface AdvancedSignature

addReferencesFromOfflineOCSPSource

protected void addReferencesFromOfflineOCSPSource(List<TimestampReference> references)

This method adds references to retrieved OCSP responses from LT level. With LTA level, we have a proof of existence

Parameters:

references -

addReferencesFromOfflineCRLSource

protected void addReferencesFromOfflineCRLSource(List<TimestampReference> references)

This method adds references to retrieved CRL responses from LT level. With LTA level, we have a proof of existence

Parameters:

references -

getUsedCertificatesDigestAlgorithms

public Set<DigestAlgorithm> getUsedCertificatesDigestAlgorithms()

Description copied from interface: AdvancedSignature

Returns the set of digest algorithms used to build the certificate's digest. For example, these digests are referenced in CompleteCertificateRefs in the case of XAdES signature.

Specified by:

getUsedCertificatesDigestAlgorithms in interface AdvancedSignature

Returns:

getPolicyId

public SignaturePolicy getPolicyId()

Description copied from interface: AdvancedSignature

Returns the Signature Policy OID from the signature.

Specified by:

getPolicyId in interface AdvancedSignature

Returns:

SignaturePolicy

checkSignaturePolicy

public void checkSignaturePolicy(SignaturePolicyProvider signaturePolicyDetector)

Specified by:

checkSignaturePolicy in interface AdvancedSignature

findSignatureScope

public void findSignatureScope(SignatureScopeFinder signatureScopeFinder)

Specified by:

findSignatureScope in interface AdvancedSignature

getSignatureScopes

public List<SignatureScope> getSignatureScopes()

Specified by:

getSignatureScopes in interface AdvancedSignature

addExternalTimestamp

public void addExternalTimestamp(TimestampToken timestamp)

Description copied from interface: AdvancedSignature

This method allows to add an external timestamp. The given timestamp must be checked before.

Specified by:

addExternalTimestamp in interface AdvancedSignature

Parameters:

timestamp - the timestamp token

hasTProfile

public boolean hasTProfile()

hasLTProfile

public boolean hasLTProfile()

hasLTAProfile

public boolean hasLTAProfile()