Modifier and Type	Class and Description
public static class	CertInformationCollector.CertSignatureInformation Data class to hold Signature, Certificate (and its chain(s)) and revocation Information

Modifier and Type	Field and Description
private final JcaX509CertificateConverter	certConverter
private final Set<X509Certificate>	certificateSet
private static final Log	LOG
private static final int	MAX_CERTIFICATE_CHAIN_DEPTH
private CertInformationCollector.CertSignatureInformation	rootCertInfo
private final Set<String>	urlSet

Access	Constructor and Description
public	CertInformationCollector()

Method Summary

Modifier and Type	Method and Description
private void	addAllCerts(Collection<X509CertificateHolder> Collection of X509CertificateHolder certHolders) Adds multiple Certificates out of a Collection of X509CertificateHolder into certificateSet.
public void	addAllCertsFromHolders(X509CertificateHolder[] Array of X509CertificateHolder certHolders) Gets a list of X509Certificate out of an array of X509CertificateHolder.
private void	addTimestampCerts(SignerInformation of the signature, to get unsigned attributes from it. signerInformation) Processes an embedded signed timestamp, that has been placed into a signature.
private void	getAlternativeIssuerCertificate(CertInformationCollector.CertSignatureInformation base Certificate Information, on which to put the alternative Certificate certInfo, int Maximum depth to dig through the chain from here on. maxDepth) Get alternative certificate chain, from the Authority Information (a url).
private X509Certificate	Returns: a X509Certificate or `null` when there was an Error with the Certificate getCertFromHolder(X509CertificateHolder to get the certificate from certificateHolder) Gets the X509Certificate out of the X509CertificateHolder.
public Set<X509Certificate>	Returns: a set of serial numbers to certificates. getCertificateSet() Get the set of all processed certificates until now.
private CertInformationCollector.CertSignatureInformation	Returns: the CertSignatureInformation for this signature getCertInfo(byte[] the byte[]-Content of the signature signatureContent) Processes one signature and its including certificates.
pack-priv CertInformationCollector.CertSignatureInformation	getCertInfo(X509Certificate certificate) Traverse a certificate.
public CertInformationCollector.CertSignatureInformation	Returns: the CertSignatureInformation containing all certificate information getLastCertInfo(PDSignature the signature of the document. signature, String of the document. fileName) Gets the certificate information of a signature.
private SignerInformation	Returns: Signer Information of the processed certificatesStore for further usage. processSignerStore(CMSSignedData data from which to get the SignerInformation signedData, CertInformationCollector.CertSignatureInformation where to add certificate information certInfo) Processes a signer store and goes through the signers certificate-chain.
private void	traverseChain(X509Certificate Actual Certificate to be processed certificate, CertInformationCollector.CertSignatureInformation where to add the Certificate (and chain) information certInfo, int Max depth from this point to go through CertChain (could be infinite) maxDepth) Traverse through the Cert-Chain of the given Certificate and add it to the CertInfo recursively.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

certConverter	back to summary
private final JcaX509CertificateConverter certConverter

certificateSet	back to summary
private final Set<X509Certificate> certificateSet

LOG	back to summary
private static final Log LOG

MAX_CERTIFICATE_CHAIN_DEPTH	back to summary
private static final int MAX_CERTIFICATE_CHAIN_DEPTH

rootCertInfo	back to summary
private CertInformationCollector.CertSignatureInformation rootCertInfo

urlSet	back to summary
private final Set<String> urlSet

Constructor Detail

CertInformationCollector	back to summary
public CertInformationCollector()

Method Detail

addAllCerts	back to summary
private void addAllCerts(Collection<X509CertificateHolder> certHolders) Adds multiple Certificates out of a Collection of X509CertificateHolder into certificateSet. Parameters certHolders:Collection<X509CertificateHolder> Collection of X509CertificateHolder

addAllCerts

back to summary

private void addAllCerts(Collection<X509CertificateHolder> certHolders)

Adds multiple Certificates out of a Collection of X509CertificateHolder into certificateSet.

Parameters

certHolders:Collection<X509CertificateHolder>: Collection of X509CertificateHolder

addAllCertsFromHolders	back to summary
public void addAllCertsFromHolders(X509CertificateHolder[] certHolders) throws CertificateProccessingException Gets a list of X509Certificate out of an array of X509CertificateHolder. The certificates will be added to certificateSet. Parameters certHolders:X509CertificateHolder[] Array of X509CertificateHolder Exceptions CertificateProccessingException: when one of the Certificates could not be parsed.

addAllCertsFromHolders

back to summary

public void addAllCertsFromHolders(X509CertificateHolder[] certHolders) throws CertificateProccessingException

Gets a list of X509Certificate out of an array of X509CertificateHolder. The certificates will be added to certificateSet.

Parameters

certHolders:X509CertificateHolder[]: Array of X509CertificateHolder

Exceptions

CertificateProccessingException:: when one of the Certificates could not be parsed.

addTimestampCerts	back to summary
private void addTimestampCerts(SignerInformation signerInformation) throws IOException, CertificateProccessingException Processes an embedded signed timestamp, that has been placed into a signature. The certificates and its chain(s) will be processed the same way as the signature itself. Parameters signerInformation:SignerInformation of the signature, to get unsigned attributes from it.

addTimestampCerts

back to summary

private void addTimestampCerts(SignerInformation signerInformation) throws IOException, CertificateProccessingException

Processes an embedded signed timestamp, that has been placed into a signature. The certificates and its chain(s) will be processed the same way as the signature itself.

Parameters

signerInformation:SignerInformation: of the signature, to get unsigned attributes from it.

getAlternativeIssuerCertificate	back to summary
private void getAlternativeIssuerCertificate(CertInformationCollector.CertSignatureInformation certInfo, int maxDepth) throws CertificateProccessingException Get alternative certificate chain, from the Authority Information (a url). If the chain is not included in the signature, this is the main chain. Otherwise there might be a second chain. Exceptions which happen on this chain will be logged and ignored, because the cert might not be available at the time or other reasons. Parameters certInfo:CertInformationCollector.CertSignatureInformation base Certificate Information, on which to put the alternative Certificate maxDepth:int Maximum depth to dig through the chain from here on. Exceptions CertificateProccessingException: on a specific error with a certificate

getAlternativeIssuerCertificate

back to summary

private void getAlternativeIssuerCertificate(CertInformationCollector.CertSignatureInformation certInfo, int maxDepth) throws CertificateProccessingException

Get alternative certificate chain, from the Authority Information (a url). If the chain is not included in the signature, this is the main chain. Otherwise there might be a second chain. Exceptions which happen on this chain will be logged and ignored, because the cert might not be available at the time or other reasons.

Parameters

certInfo:CertInformationCollector.CertSignatureInformation: base Certificate Information, on which to put the alternative Certificate
maxDepth:int: Maximum depth to dig through the chain from here on.

Exceptions

CertificateProccessingException:: on a specific error with a certificate

getCertFromHolder back to summary

getCertFromHolder	back to summary
private X509Certificate getCertFromHolder(X509CertificateHolder certificateHolder) throws CertificateProccessingException Gets the X509Certificate out of the X509CertificateHolder. Parameters certificateHolder:X509CertificateHolder to get the certificate from Returns:X509Certificate a X509Certificate or `null` when there was an Error with the Certificate Exceptions CertificateProccessingException: on failed conversion from X509CertificateHolder to X509Certificate

private X509Certificate getCertFromHolder(X509CertificateHolder certificateHolder) throws CertificateProccessingException

Gets the X509Certificate out of the X509CertificateHolder.

Parameters

certificateHolder:X509CertificateHolder: to get the certificate from

Returns:X509Certificate

a X509Certificate or null when there was an Error with the Certificate

Exceptions

CertificateProccessingException:: on failed conversion from X509CertificateHolder to X509Certificate

getCertificateSet	back to summary
public Set<X509Certificate> getCertificateSet() Get the set of all processed certificates until now. Returns:Set<X509Certificate> a set of serial numbers to certificates.

getCertificateSet

back to summary

public Set<X509Certificate> getCertificateSet()

Get the set of all processed certificates until now.

Returns:Set<X509Certificate>: a set of serial numbers to certificates.

getCertInfo	back to summary
private CertInformationCollector.CertSignatureInformation getCertInfo(byte[] signatureContent) throws CertificateProccessingException, IOException Processes one signature and its including certificates. Parameters signatureContent:byte[] the byte[]-Content of the signature Returns:CertInformationCollector.CertSignatureInformation the CertSignatureInformation for this signature

getCertInfo

back to summary

private CertInformationCollector.CertSignatureInformation getCertInfo(byte[] signatureContent) throws CertificateProccessingException, IOException

Processes one signature and its including certificates.

Parameters

signatureContent:byte[]: the byte[]-Content of the signature

Returns:CertInformationCollector.CertSignatureInformation

the CertSignatureInformation for this signature

getCertInfo	back to summary
pack-priv CertInformationCollector.CertSignatureInformation getCertInfo(X509Certificate certificate) throws CertificateProccessingException Traverse a certificate.

getLastCertInfo	back to summary
public CertInformationCollector.CertSignatureInformation getLastCertInfo(PDSignature signature, String fileName) throws CertificateProccessingException, IOException Gets the certificate information of a signature. Parameters signature:PDSignature the signature of the document. fileName:String of the document. Returns:CertInformationCollector.CertSignatureInformation the CertSignatureInformation containing all certificate information Exceptions CertificateProccessingException: when there is an error processing the certificates IOException: on a data processing error

getLastCertInfo

back to summary

public CertInformationCollector.CertSignatureInformation getLastCertInfo(PDSignature signature, String fileName) throws CertificateProccessingException, IOException

Gets the certificate information of a signature.

Parameters

signature:PDSignature: the signature of the document.
fileName:String: of the document.

Returns:CertInformationCollector.CertSignatureInformation

the CertSignatureInformation containing all certificate information

Exceptions

CertificateProccessingException:: when there is an error processing the certificates
IOException:: on a data processing error

processSignerStore	back to summary
private SignerInformation processSignerStore(CMSSignedData signedData, CertInformationCollector.CertSignatureInformation certInfo) throws IOException, CertificateProccessingException Processes a signer store and goes through the signers certificate-chain. Adds the found data to the certInfo. Handles only the first signer, although multiple would be possible, but is not yet practicable. Parameters signedData:CMSSignedData data from which to get the SignerInformation certInfo:CertInformationCollector.CertSignatureInformation where to add certificate information Returns:SignerInformation Signer Information of the processed certificatesStore for further usage. Exceptions IOException: on data-processing error CertificateProccessingException: on a specific error with a certificate

processSignerStore

back to summary

private SignerInformation processSignerStore(CMSSignedData signedData, CertInformationCollector.CertSignatureInformation certInfo) throws IOException, CertificateProccessingException

Processes a signer store and goes through the signers certificate-chain. Adds the found data to the certInfo. Handles only the first signer, although multiple would be possible, but is not yet practicable.

Parameters

signedData:CMSSignedData: data from which to get the SignerInformation
certInfo:CertInformationCollector.CertSignatureInformation: where to add certificate information

Returns:SignerInformation

Signer Information of the processed certificatesStore for further usage.

Exceptions

IOException:: on data-processing error
CertificateProccessingException:: on a specific error with a certificate

traverseChain	back to summary
private void traverseChain(X509Certificate certificate, CertInformationCollector.CertSignatureInformation certInfo, int maxDepth) throws IOException, CertificateProccessingException Traverse through the Cert-Chain of the given Certificate and add it to the CertInfo recursively. Parameters certificate:X509Certificate Actual Certificate to be processed certInfo:CertInformationCollector.CertSignatureInformation where to add the Certificate (and chain) information maxDepth:int Max depth from this point to go through CertChain (could be infinite) Exceptions IOException: on data-processing error CertificateProccessingException: on a specific error with a certificate

traverseChain

back to summary

private void traverseChain(X509Certificate certificate, CertInformationCollector.CertSignatureInformation certInfo, int maxDepth) throws IOException, CertificateProccessingException

Traverse through the Cert-Chain of the given Certificate and add it to the CertInfo recursively.

Parameters

certificate:X509Certificate: Actual Certificate to be processed
certInfo:CertInformationCollector.CertSignatureInformation: where to add the Certificate (and chain) information
maxDepth:int: Max depth from this point to go through CertChain (could be infinite)

Exceptions

IOException:: on data-processing error
CertificateProccessingException:: on a specific error with a certificate

org.apache.pdfbox.examples.signature.validation back to summary

public Class CertInformationCollector.CertSignatureInformation

Class Inheritance

extends Object

java.lang.Object
org.apache.pdfbox.examples.signature.validation.CertInformationCollector.CertSignatureInformation

Data class to hold Signature, Certificate (and its chain(s)) and revocation Information

Field Summary

Modifier and Type	Field and Description
private CertInformationCollector.CertSignatureInformation	alternativeCertChain
private CertInformationCollector.CertSignatureInformation	certChain
private X509Certificate	certificate
private String	crlUrl
private boolean	isSelfSigned
private final Set<X509Certificate>	issuerCertificates
private String	issuerUrl
private String	ocspUrl
private String	signatureHash
private CertInformationCollector.CertSignatureInformation	tsaCerts

Constructor Summary

Access	Constructor and Description
public	CertSignatureInformation()

Method Summary

Modifier and Type	Method and Description
public CertInformationCollector.CertSignatureInformation	getAlternativeCertChain()
public CertInformationCollector.CertSignatureInformation	getCertChain()
public X509Certificate	getCertificate()
public String	getCrlUrl()
public Set<X509Certificate>	getIssuerCertificates()
public String	getOcspUrl()
public String	getSignatureHash()
public CertInformationCollector.CertSignatureInformation	getTsaCerts()
public boolean	isSelfSigned()
public void	setIssuerUrl(String issuerUrl)
public void	setOcspUrl(String ocspUrl)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

alternativeCertChain	back to summary
private CertInformationCollector.CertSignatureInformation alternativeCertChain

certChain	back to summary
private CertInformationCollector.CertSignatureInformation certChain

certificate	back to summary
private X509Certificate certificate

crlUrl	back to summary
private String crlUrl

isSelfSigned	back to summary
private boolean isSelfSigned

issuerCertificates	back to summary
private final Set<X509Certificate> issuerCertificates

issuerUrl	back to summary
private String issuerUrl

ocspUrl	back to summary
private String ocspUrl

signatureHash	back to summary
private String signatureHash

tsaCerts	back to summary
private CertInformationCollector.CertSignatureInformation tsaCerts

Constructor Detail

CertSignatureInformation	back to summary
public CertSignatureInformation()

Method Detail

getAlternativeCertChain	back to summary
public CertInformationCollector.CertSignatureInformation getAlternativeCertChain()

getCertChain	back to summary
public CertInformationCollector.CertSignatureInformation getCertChain()

getCertificate	back to summary
public X509Certificate getCertificate()

getCrlUrl	back to summary
public String getCrlUrl()

getIssuerCertificates	back to summary
public Set<X509Certificate> getIssuerCertificates()

getOcspUrl	back to summary
public String getOcspUrl()

getSignatureHash	back to summary
public String getSignatureHash()

getTsaCerts	back to summary
public CertInformationCollector.CertSignatureInformation getTsaCerts()

isSelfSigned	back to summary
public boolean isSelfSigned()

setIssuerUrl	back to summary
public void setIssuerUrl(String issuerUrl)

setOcspUrl	back to summary
public void setOcspUrl(String ocspUrl)

public Class CertInformationCollector

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class CertInformationCollector.CertSignatureInformation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail