Module jpms_dss_validation

Package eu.europa.esig.dss.validation

Interface DocumentValidator

All Superinterfaces:

ProcessExecutorProvider<DocumentProcessExecutor>

All Known Subinterfaces:

EvidenceRecordValidator

All Known Implementing Classes:

DetachedTimestampValidator, SignedDocumentValidator

public interface DocumentValidator
extends ProcessExecutorProvider<DocumentProcessExecutor>

This is the interface to be used when implementing different signature validators.

Method Summary

Modifier and Type	Method	Description
List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord>	getDetachedEvidenceRecords()	Retrieves the detached evidence records found in the document
List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken>	getDetachedTimestamps()	Retrieves the detached timestamps found in the document
List<eu.europa.esig.dss.model.DSSDocument>	getOriginalDocuments(eu.europa.esig.dss.spi.signature.AdvancedSignature advancedSignature)	This method returns the signed document(s) without their signature(s)
List<eu.europa.esig.dss.model.DSSDocument>	getOriginalDocuments(String signatureId)	This method returns the signed document(s) without their signature(s)
List<eu.europa.esig.dss.spi.signature.AdvancedSignature>	getSignatures()	Retrieves the signatures found in the document
<T extends eu.europa.esig.dss.spi.signature.AdvancedSignature> eu.europa.esig.dss.spi.validation.ValidationDataContainer	getValidationData(Collection<T> signatures)	Extracts a validation data for provided collection of signatures
<T extends eu.europa.esig.dss.spi.signature.AdvancedSignature> eu.europa.esig.dss.spi.validation.ValidationDataContainer	getValidationData(Collection<T> signatures, Collection<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> detachedTimestamps)	Extracts a validation data for provided collection of signatures and/or timestamps
void	setCertificateVerifier(eu.europa.esig.dss.spi.validation.CertificateVerifier certificateVerifier)	Provides a CertificateVerifier to be used during the validation process.
void	setContainerContents(List<eu.europa.esig.dss.model.DSSDocument> archiveContents)	Sets the List of DSSDocument containing the original container content for ASiC-S signatures.
void	setDefaultDigestAlgorithm(eu.europa.esig.dss.enumerations.DigestAlgorithm digestAlgorithm)	This method allows to change the Digest Algorithm that will be used for tokens' digest calculation Default : DigestAlgorithm.SHA256
void	setDetachedContents(List<eu.europa.esig.dss.model.DSSDocument> detachedContent)	Sets the List of DSSDocument containing the original contents to sign, for detached signature scenarios.
void	setDetachedEvidenceRecordDocuments(List<eu.europa.esig.dss.model.DSSDocument> detachedEvidenceRecordDocuments)	Sets a List of DSSDocument containing the evidence record documents covering the signature document.
void	setEnableEtsiValidationReport(boolean enableEtsiValidationReport)	This method allows to specify if the ETSI Validation Report must be generated.
void	setIncludeSemantics(boolean include)	This method allows to enable/disable the semantics inclusion in the reports (Indication / SubIndication meanings) Disabled by default
void	setManifestFile(eu.europa.esig.dss.model.ManifestFile manifestFile)	Sets a related ManifestFile to the document to be validated.
void	setSignaturePolicyProvider(eu.europa.esig.dss.spi.policy.SignaturePolicyProvider signaturePolicyProvider)	This method allows to set a provider for Signature policies
void	setSigningCertificateSource(eu.europa.esig.dss.spi.x509.CertificateSource certificateSource)	Set a certificate source which allows to find the signing certificate by kid or certificate's digest
void	setTokenExtractionStrategy(eu.europa.esig.dss.enumerations.TokenExtractionStrategy tokenExtractionStrategy)	This method allows to set the token extraction strategy to follow in the diagnostic data generation.
void	setTokenIdentifierProvider(eu.europa.esig.dss.model.identifier.TokenIdentifierProvider tokenIdentifierProvider)	Sets the TokenIdentifierProvider
void	setValidationContextExecutor(eu.europa.esig.dss.spi.validation.executor.ValidationContextExecutor validationContextExecutor)	This method sets ValidationContextExecutor for validation of the prepared ValidationContext Default: eu.europa.esig.dss.validation.executor.context.DefaultValidationContextExecutor (performs basic validation of tokens, including certificate chain building and revocation data extraction, without processing of validity checks)
void	setValidationLevel(eu.europa.esig.dss.enumerations.ValidationLevel validationLevel)	This method allows to specify the validation level (Basic / Timestamp / Long Term / Archival).
void	setValidationTime(Date validationTime)	Allows to define a custom validation time
Reports	validateDocument()	Validates the document and all its signatures.
Reports	validateDocument(eu.europa.esig.dss.model.DSSDocument policyDocument)	Validates the document and all its signatures.
Reports	validateDocument(eu.europa.esig.dss.policy.jaxb.ConstraintsParameters validationPolicyJaxb)	Validates the document and all its signatures.
Reports	validateDocument(eu.europa.esig.dss.policy.ValidationPolicy validationPolicy)	Validates the document and all its signatures.
Reports	validateDocument(File policyFile)	Validates the document and all its signatures.
Reports	validateDocument(InputStream policyDataStream)	Validates the document and all its signatures.
Reports	validateDocument(String policyResourcePath)	Validates the document and all its signatures.
Reports	validateDocument(URL validationPolicyURL)	Validates the document and all its signatures.

Methods inherited from interface eu.europa.esig.dss.validation.executor.ProcessExecutorProvider

getDefaultProcessExecutor, setProcessExecutor

Method Details

getSignatures

List<eu.europa.esig.dss.spi.signature.AdvancedSignature> getSignatures()

Retrieves the signatures found in the document

Returns:

a list of AdvancedSignatures for validation purposes

getDetachedTimestamps

List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> getDetachedTimestamps()

Retrieves the detached timestamps found in the document

Returns:

a list of TimestampToken for validation purposes

getDetachedEvidenceRecords

List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> getDetachedEvidenceRecords()

Retrieves the detached evidence records found in the document

Returns:

a list of Evidence Records for validation purposes

setCertificateVerifier

void setCertificateVerifier(eu.europa.esig.dss.spi.validation.CertificateVerifier certificateVerifier)

Provides a CertificateVerifier to be used during the validation process.

Parameters:

certificateVerifier - CertificateVerifier

setValidationContextExecutor

void setValidationContextExecutor(eu.europa.esig.dss.spi.validation.executor.ValidationContextExecutor validationContextExecutor)

This method sets ValidationContextExecutor for validation of the prepared ValidationContext Default: eu.europa.esig.dss.validation.executor.context.DefaultValidationContextExecutor (performs basic validation of tokens, including certificate chain building and revocation data extraction, without processing of validity checks)

Parameters:

validationContextExecutor - ValidationContextExecutor

setDefaultDigestAlgorithm

void setDefaultDigestAlgorithm(eu.europa.esig.dss.enumerations.DigestAlgorithm digestAlgorithm)

This method allows to change the Digest Algorithm that will be used for tokens' digest calculation Default : DigestAlgorithm.SHA256

Parameters:

digestAlgorithm - DigestAlgorithm to use

setTokenExtractionStrategy

void setTokenExtractionStrategy(eu.europa.esig.dss.enumerations.TokenExtractionStrategy tokenExtractionStrategy)

This method allows to set the token extraction strategy to follow in the diagnostic data generation.

Parameters:

tokenExtractionStrategy - the TokenExtractionStrategy

setTokenIdentifierProvider

void setTokenIdentifierProvider(eu.europa.esig.dss.model.identifier.TokenIdentifierProvider tokenIdentifierProvider)

Sets the TokenIdentifierProvider

Parameters:

tokenIdentifierProvider - TokenIdentifierProvider

setIncludeSemantics

void setIncludeSemantics(boolean include)

This method allows to enable/disable the semantics inclusion in the reports (Indication / SubIndication meanings) Disabled by default

Parameters:

include - true to enable the inclusion of the semantics

setValidationTime

void setValidationTime(Date validationTime)

Allows to define a custom validation time

Parameters:

validationTime - Date

setDetachedContents

void setDetachedContents(List<eu.europa.esig.dss.model.DSSDocument> detachedContent)

Sets the List of DSSDocument containing the original contents to sign, for detached signature scenarios.

Parameters:

detachedContent - the List of DSSDocument to set

setDetachedEvidenceRecordDocuments

void setDetachedEvidenceRecordDocuments(List<eu.europa.esig.dss.model.DSSDocument> detachedEvidenceRecordDocuments)

Sets a List of DSSDocument containing the evidence record documents covering the signature document.

Parameters:

detachedEvidenceRecordDocuments - the List of DSSDocument to set

setContainerContents

void setContainerContents(List<eu.europa.esig.dss.model.DSSDocument> archiveContents)

Sets the List of DSSDocument containing the original container content for ASiC-S signatures.

Parameters:

archiveContents - the List of DSSDocument to set

setManifestFile

void setManifestFile(eu.europa.esig.dss.model.ManifestFile manifestFile)

Sets a related ManifestFile to the document to be validated.

Parameters:

manifestFile - a ManifestFile to set

setSigningCertificateSource

void setSigningCertificateSource(eu.europa.esig.dss.spi.x509.CertificateSource certificateSource)

Set a certificate source which allows to find the signing certificate by kid or certificate's digest

Parameters:

certificateSource - the certificate source

setValidationLevel

void setValidationLevel(eu.europa.esig.dss.enumerations.ValidationLevel validationLevel)

This method allows to specify the validation level (Basic / Timestamp / Long Term / Archival). By default, the selected validation is ARCHIVAL

Parameters:

validationLevel - ValidationLevel

setEnableEtsiValidationReport

void setEnableEtsiValidationReport(boolean enableEtsiValidationReport)

This method allows to specify if the ETSI Validation Report must be generated. Default : TRUE (the ETSI Validation report will be generated).

Parameters:

enableEtsiValidationReport - - TRUE if the report must be generated, FALSE otherwise

setSignaturePolicyProvider

void setSignaturePolicyProvider(eu.europa.esig.dss.spi.policy.SignaturePolicyProvider signaturePolicyProvider)

This method allows to set a provider for Signature policies

Parameters:

signaturePolicyProvider - SignaturePolicyProvider

validateDocument

Reports validateDocument()

Validates the document and all its signatures. The default constraint file is used.

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

Reports validateDocument(URL validationPolicyURL)

Validates the document and all its signatures. If the validation policy URL is set then the policy constraints are retrieved from this location. If null or empty the default file is used.

Parameters:

validationPolicyURL - URL

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

Reports validateDocument(String policyResourcePath)

Validates the document and all its signatures. The policyResourcePath specifies the constraint file. If null or empty the default file is used.

Parameters:

policyResourcePath - is located against the classpath (getClass().getResourceAsStream), and NOT the filesystem

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

Reports validateDocument(File policyFile)

Validates the document and all its signatures. The File parameter specifies the constraint file. If null or empty the default file is used.

Parameters:

policyFile - contains the validation policy (xml) as File

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

Reports validateDocument(eu.europa.esig.dss.model.DSSDocument policyDocument)

Validates the document and all its signatures. The policyDataStream contains the constraint file. If null or empty the default file is used.

Parameters:

policyDocument - contains the validation policy (xml) as DSSDocument

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

Reports validateDocument(InputStream policyDataStream)

Validates the document and all its signatures. The policyDataStream contains the constraint file. If null or empty the default file is used.

Parameters:

policyDataStream - contains the validation policy (xml) as InputStream

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

Reports validateDocument(eu.europa.esig.dss.policy.jaxb.ConstraintsParameters validationPolicyJaxb)

Validates the document and all its signatures. The validationPolicyJaxb contains the constraint file. If null or empty the default file is used.

Parameters:

validationPolicyJaxb - ConstraintsParameters

Returns:

Reports

validateDocument

Reports validateDocument(eu.europa.esig.dss.policy.ValidationPolicy validationPolicy)

Validates the document and all its signatures. The validationPolicy contains the constraint file. If null or empty the default file is used.

Parameters:

validationPolicy - ValidationPolicy

Returns:

Reports

getOriginalDocuments

List<eu.europa.esig.dss.model.DSSDocument> getOriginalDocuments(String signatureId)

This method returns the signed document(s) without their signature(s)

Parameters:

signatureId - the DSS ID of the signature to extract original signer data for

Returns:

list of DSSDocuments

getOriginalDocuments

List<eu.europa.esig.dss.model.DSSDocument> getOriginalDocuments(eu.europa.esig.dss.spi.signature.AdvancedSignature advancedSignature)

This method returns the signed document(s) without their signature(s)

Parameters:

advancedSignature - AdvancedSignature to find signer documents for

Returns:

list of DSSDocuments

getValidationData

<T extends eu.europa.esig.dss.spi.signature.AdvancedSignature>
eu.europa.esig.dss.spi.validation.ValidationDataContainer getValidationData(Collection<T> signatures)

Extracts a validation data for provided collection of signatures

Type Parameters:

T - AdvancedSignature implementation

Parameters:

signatures - a collection of AdvancedSignatures

Returns:

ValidationDataContainer

getValidationData

<T extends eu.europa.esig.dss.spi.signature.AdvancedSignature>
eu.europa.esig.dss.spi.validation.ValidationDataContainer getValidationData(Collection<T> signatures,
 Collection<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> detachedTimestamps)

Extracts a validation data for provided collection of signatures and/or timestamps

Type Parameters:

T - AdvancedSignature implementation

Parameters:

signatures - a collection of AdvancedSignatures

detachedTimestamps - a collection of detached TimestampTokens

Returns:

ValidationDataContainer