eu.europa.esig.dss.validation

Class SignedDocumentValidator

java.lang.Object

eu.europa.esig.dss.validation.SignedDocumentValidator

All Implemented Interfaces:

DocumentValidator

public abstract class SignedDocumentValidator
extends Object
implements DocumentValidator

Validate the signed document. The content of the document is determined automatically. It can be: XML, CAdES(p7m), PDF or ASiC(zip). SignatureScopeFinder can be set using the appropriate setter (ex. setCadesSignatureScopeFinder). By default, this class will use the default SignatureScopeFinder as defined by eu.europa.esig.dss.validation.scope.SignatureScopeFinderFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected CertificateVerifier	certificateVerifier The reference to the certificate verifier.
protected List<DSSDocument>	detachedContents In case of a detached signature this List contains the signed documents.
protected DSSDocument	document The document to validated (with the signature(s))
protected ProcessExecutor	processExecutor This variable can hold a specific ProcessExecutor
protected CertificateToken	providedSigningCertificateToken
protected SignaturePolicyProvider	signaturePolicyProvider
protected SignatureScopeFinder	signatureScopeFinder
protected CertificatePool	validationCertPool This is the pool of certificates used in the validation process.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SignedDocumentValidator(SignatureScopeFinder signatureScopeFinder)

Method Summary

Methods

Modifier and Type	Method and Description
void	defineSigningCertificate(CertificateToken token) This method allows to define the signing certificate.
protected void	ensureSignaturePolicyDetectorInitialized()
static SignedDocumentValidator	fromDocument(DSSDocument dssDocument) This method guesses the document format and returns an appropriate document validator.
protected ContainerInfo	getContainerInfo() This method allows to retrieve the container information (ASiC Container)
abstract boolean	isSupported(DSSDocument dssDocument)
List<AdvancedSignature>	processSignaturesValidation(ValidationContext validationContext, boolean structuralValidation)
protected eu.europa.esig.dss.validation.reports.Reports	processValidationPolicy(eu.europa.esig.dss.jaxb.diagnostic.DiagnosticData diagnosticData, ValidationPolicy validationPolicy)
ProcessExecutor	provideProcessExecutorInstance() This method returns the process executor.
void	setCertificateVerifier(CertificateVerifier certificateVerifier) To carry out the validation process of the signature(s) some external sources of certificates and of revocation data can be needed.
void	setDetachedContents(List<DSSDocument> detachedContents) Sets the List of DSSDocument containing the original contents to sign, for detached signature scenarios.
void	setProcessExecutor(ProcessExecutor processExecutor) This method provides the possibility to set the specific ProcessExecutor
void	setSignaturePolicyProvider(SignaturePolicyProvider signaturePolicyProvider) This method allows to set a provider for Signature policies
void	setValidationLevel(ValidationLevel validationLevel) This method allows to specify the validation level (Basic / Timestamp / Long Term / Archival).
eu.europa.esig.dss.validation.reports.Reports	validateDocument() Validates the document and all its signatures.
eu.europa.esig.dss.validation.reports.Reports	validateDocument(eu.europa.esig.jaxb.policy.ConstraintsParameters validationPolicyJaxb) Validates the document and all its signatures.
eu.europa.esig.dss.validation.reports.Reports	validateDocument(File policyFile) Validates the document and all its signatures.
eu.europa.esig.dss.validation.reports.Reports	validateDocument(InputStream policyDataStream) Validates the document and all its signatures.
eu.europa.esig.dss.validation.reports.Reports	validateDocument(String policyResourcePath) Validates the document and all its signatures.
eu.europa.esig.dss.validation.reports.Reports	validateDocument(URL validationPolicyURL) Validates the document and all its signatures.
eu.europa.esig.dss.validation.reports.Reports	validateDocument(ValidationPolicy validationPolicy) Validates the document and all its signatures.

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.DocumentValidator

getOriginalDocuments, getSignatures

Field Detail

processExecutor

protected ProcessExecutor processExecutor

This variable can hold a specific ProcessExecutor

validationCertPool

protected CertificatePool validationCertPool

This is the pool of certificates used in the validation process. The pools present in the certificate verifier are merged and added to this pool.

document

protected DSSDocument document

The document to validated (with the signature(s))

detachedContents

protected List<DSSDocument> detachedContents

In case of a detached signature this List contains the signed documents.

providedSigningCertificateToken

protected CertificateToken providedSigningCertificateToken

certificateVerifier

protected CertificateVerifier certificateVerifier

The reference to the certificate verifier. The current DSS implementation proposes CommonCertificateVerifier. This verifier encapsulates the references to different sources used in the signature validation process.

signatureScopeFinder

protected final SignatureScopeFinder signatureScopeFinder

signaturePolicyProvider

protected SignaturePolicyProvider signaturePolicyProvider

Constructor Detail

SignedDocumentValidator

protected SignedDocumentValidator(SignatureScopeFinder signatureScopeFinder)

Method Detail

fromDocument

public static SignedDocumentValidator fromDocument(DSSDocument dssDocument)

This method guesses the document format and returns an appropriate document validator.

Parameters:

dssDocument - The instance of DSSDocument to validate

Returns:

returns the specific instance of SignedDocumentValidator in terms of the document type

isSupported

public abstract boolean isSupported(DSSDocument dssDocument)

defineSigningCertificate

public void defineSigningCertificate(CertificateToken token)

Description copied from interface: DocumentValidator

This method allows to define the signing certificate. It is useful in the case of ,non AdES signatures.

Specified by:

defineSigningCertificate in interface DocumentValidator

setCertificateVerifier

public void setCertificateVerifier(CertificateVerifier certificateVerifier)

To carry out the validation process of the signature(s) some external sources of certificates and of revocation data can be needed. The certificate verifier is used to pass these values. Note that once this setter is called any change in the content of the CommonTrustedCertificateSource or in adjunct certificate source is not taken into account.

Specified by:

setCertificateVerifier in interface DocumentValidator

Parameters:

certificateVerifier -

setDetachedContents

public void setDetachedContents(List<DSSDocument> detachedContents)

Description copied from interface: DocumentValidator

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

Specified by:

setDetachedContents in interface DocumentValidator

Parameters:

detachedContents - the List of DSSDocument to set

setValidationLevel

public void setValidationLevel(ValidationLevel validationLevel)

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

Specified by:

setValidationLevel in interface DocumentValidator

validateDocument

public eu.europa.esig.dss.validation.reports.Reports validateDocument()

Description copied from interface: DocumentValidator

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

Specified by:

validateDocument in interface DocumentValidator

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

public eu.europa.esig.dss.validation.reports.Reports validateDocument(URL validationPolicyURL)

Description copied from interface: DocumentValidator

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.

Specified by:

validateDocument in interface DocumentValidator

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

public eu.europa.esig.dss.validation.reports.Reports validateDocument(String policyResourcePath)

Description copied from interface: DocumentValidator

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

Specified by:

validateDocument in interface DocumentValidator

Parameters:

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

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

public eu.europa.esig.dss.validation.reports.Reports validateDocument(File policyFile)

Description copied from interface: DocumentValidator

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

Specified by:

validateDocument in interface DocumentValidator

Parameters:

policyFile - contains the validation policy (xml) as File

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

public eu.europa.esig.dss.validation.reports.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.

Specified by:

validateDocument in interface DocumentValidator

Parameters:

policyDataStream - InputStream

Returns:

Reports: diagnostic data, detailed report and simple report

validateDocument

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

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

Specified by:

validateDocument in interface DocumentValidator

Parameters:

validationPolicyJaxb - Document

Returns:

validateDocument

public eu.europa.esig.dss.validation.reports.Reports validateDocument(ValidationPolicy validationPolicy)

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

Specified by:

validateDocument in interface DocumentValidator

Parameters:

validationPolicy - ValidationPolicy

Returns:

processSignaturesValidation

public List<AdvancedSignature> processSignaturesValidation(ValidationContext validationContext,
                                                  boolean structuralValidation)

Specified by:

processSignaturesValidation in interface DocumentValidator

getContainerInfo

protected ContainerInfo getContainerInfo()

This method allows to retrieve the container information (ASiC Container)

Returns:

processValidationPolicy

protected eu.europa.esig.dss.validation.reports.Reports processValidationPolicy(eu.europa.esig.dss.jaxb.diagnostic.DiagnosticData diagnosticData,
                                                                    ValidationPolicy validationPolicy)

setSignaturePolicyProvider

public void setSignaturePolicyProvider(SignaturePolicyProvider signaturePolicyProvider)

Description copied from interface: DocumentValidator

This method allows to set a provider for Signature policies

Specified by:

setSignaturePolicyProvider in interface DocumentValidator

ensureSignaturePolicyDetectorInitialized

protected void ensureSignaturePolicyDetectorInitialized()

setProcessExecutor

public void setProcessExecutor(ProcessExecutor processExecutor)

Description copied from interface: DocumentValidator

This method provides the possibility to set the specific ProcessExecutor

Specified by:

setProcessExecutor in interface DocumentValidator

provideProcessExecutorInstance

public ProcessExecutor provideProcessExecutorInstance()

This method returns the process executor. If the instance of this class is not yet instantiated then the new instance is created.

Returns:

ProcessExecutor