Package com.itextpdf.signatures
Class PdfPKCS7
java.lang.Object
com.itextpdf.signatures.PdfPKCS7
This class does all the processing related to signing
and verifying a PKCS#7 / CMS signature.
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) IBasicOCSPResponse
BouncyCastle IBasicOCSPResponseprivate static final IBouncyCastleFactory
private final Collection
<Certificate> All the X.509 certificates in no particular order.private Collection
<CRL> private final String
The ID of the digest algorithm, e.g.The digest algorithmsprivate byte[]
The digest attributesprivate byte[]
The content to which the signature applies, if encapsulated in the PKCS #7 payload.private MessageDigest
encrypted digestprivate byte[]
Externally specified encapsulated message content.private byte[]
The signature value or signed digest, if created outside this classprivate PdfName
private IExternalDigest
private boolean
True if it's a CAdES signature type.private boolean
True if there's a PAdES LTV time stamp.private String
Holds value of property location.private MessageDigest
The object that will create the digestprivate final String
The encryption provider, e.g.private String
Holds value of property reason.private Signature
Class from the Java SDK that provides the functionality of a digital signature algorithm.private byte[]
Signature attributesprivate byte[]
Signature attributes (maybe not necessary, but we use it as fallback)private String
The signature algorithm.private IASN1Encodable
private ISignaturePolicyIdentifier
private byte[]
The raw signature value as calculated by this class (or extracted from an existing PDF)private X509Certificate
The X.509 certificate that is used to sign the digest.(package private) Collection
<Certificate> All the X.509 certificates used for the main signature.private Calendar
Holds value of property signDate.private final Collection
<CRL> private final Collection
<IBasicOCSPResponse> private final Collection
<IASN1Sequence> Collection to store revocation info other than OCSP and CRL responses, e.g.private int
Version of the PKCS#7 "SignerInfo" object.private String
Holds value of property signName.private Collection
<Certificate> private PdfPKCS7
Inner timestamp signature container.private ITSTInfo
BouncyCastle TSTInfo.private final IASN1EncodableVector
private boolean
Indicates if a signature has already been verifiedprivate boolean
The result of the verificationprivate int
Version of the PKCS#7 object -
Constructor Summary
ConstructorsConstructorDescriptionUse this constructor if you want to verify a signature using the sub-filter adbe.x509.rsa_sha1.Use this constructor if you want to verify a signature.PdfPKCS7
(PrivateKey privKey, Certificate[] certChain, String hashAlgorithm, String provider, boolean hasEncapContent) Assembles all the elements needed to create a signature, except for the data.PdfPKCS7
(PrivateKey privKey, Certificate[] certChain, String hashAlgorithm, String provider, IExternalDigest interfaceDigest, boolean hasEncapContent) Assembles all the elements needed to create a signature, except for the data. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addTimestampTokenToUnsignedAttributes
(byte[] timeStampToken) Added by Aiken Sam, 2006-11-15, modifed by Martin Brunecky 07/12/2007 to start with the timeStampToken (signedData 1.2.840.113549.1.7.2).private void
configureSignatureMechanismParameters
(Signature signature) (package private) void
findCRL
(IASN1Sequence seq) Helper method that tries to construct the CRLs.private void
findOcsp
(IASN1Sequence seq) Helper method that creates the IBasicOCSPResp object.byte[]
getAuthenticatedAttributeBytes
(byte[] secondDigest, PdfSigner.CryptoStandard sigtype, Collection<byte[]> ocsp, Collection<byte[]> crlBytes) When using authenticatedAttributes the authentication process is different.private IDERSet
getAuthenticatedAttributeSet
(byte[] secondDigest, Collection<byte[]> ocsp, Collection<byte[]> crlBytes, PdfSigner.CryptoStandard sigtype) This method provides that encoding and the parameters must be exactly the same as ingetEncodedPKCS7(byte[])
.Get all the X.509 certificates associated with this PKCS#7 object in no particular order.getCRLs()
Get the X.509 certificate revocation lists associated with this PKCS#7 object (stored in Signer Info).Returns the name of the digest algorithm, e.g.Getter for the ID of the digest algorithm, e.g.byte[]
Gets the bytes for the PKCS#1 object.byte[]
Gets the bytes for the PKCS7SignedData object.byte[]
getEncodedPKCS7
(byte[] secondDigest) Gets the bytes for the PKCS7SignedData object.byte[]
getEncodedPKCS7
(byte[] secondDigest, PdfSigner.CryptoStandard sigtype, ITSAClient tsaClient, Collection<byte[]> ocsp, Collection<byte[]> crlBytes) Gets the bytes for the PKCS7SignedData object.Getter for the filter subtype.Getter for property location.getOcsp()
Gets the OCSP basic response from the SignerInfo if there is one.Getter for property reason.Returns the name of the signature algorithm only (disregarding the digest function, if any).Get the signature mechanism identifier, including both the digest function and the signature algorithm, e.g.Getter for the signature algorithm OID.Get the X.509 sign certificate chain associated with this PKCS#7 object.Getter for property signDate.Get the X.509 certificate revocation lists associated with this PKCS#7 Signed Data object.Gets the OCSP basic response collection retrieved from SignedData structure.Get the X.509 certificate actually used to sign the digest.int
Get the version of the PKCS#7 "SignerInfo" object.Getter for property sigName.Get all X.509 certificates associated with this PKCS#7 object timestamp in no particular order.Gets the timestamp date.Retrieves inner timestamp signature container if there is one.Gets the timestamp token info if there is one.Get unsigned attributes associated with this PKCS7 signature container.int
Get the version of the PKCS#7 object.private Signature
initSignature
(PrivateKey key) private Signature
initSignature
(PublicKey key) boolean
Checks if OCSP revocation refers to the document signing certificate.boolean
isTsp()
Check if it's a PAdES-LTV time stamp.void
setExternalSignatureValue
(byte[] signatureValue, byte[] signedMessageContent, String signatureAlgorithm) Sets the signature to an externally calculated value.void
setExternalSignatureValue
(byte[] signatureValue, byte[] signedMessageContent, String signatureAlgorithm, ISignatureMechanismParams signatureMechanismParams) Sets the signature to an externally calculated value.void
setLocation
(String location) Setter for property location.void
Setter for property reason.void
setSignaturePolicy
(ISignaturePolicyIdentifier signaturePolicy) Set signature policy identifier to be used during signature creation.void
setSignaturePolicy
(SignaturePolicyInfo signaturePolicy) Set signature policy identifier to be used during signature creation.void
setSignDate
(Calendar signDate) Setter for property signDate.void
setSignName
(String signName) Setter for property sigName.private void
Helper method that creates the collection of certificates used for the main signature based on the complete list of certificates and the sign certificate.void
update
(byte[] buf, int off, int len) Update the digest with the specified bytes.private boolean
verifySigAttributes
(byte[] attr) boolean
Verifies that signature integrity is intact (or in other words that signed data wasn't modified) by checking that embedded data digest corresponds to the calculated one.boolean
Checks if the timestamp refers to this document.
-
Field Details
-
BOUNCY_CASTLE_FACTORY
-
signaturePolicyIdentifier
-
provider
The encryption provider, e.g. "BC" if you use BouncyCastle. -
signName
Holds value of property signName. -
reason
Holds value of property reason. -
location
Holds value of property location. -
signDate
Holds value of property signDate. -
signedDataRevocationInfo
Collection to store revocation info other than OCSP and CRL responses, e.g. SCVP Request and Response. -
unsignedAttributes
-
version
private int versionVersion of the PKCS#7 object -
signerversion
private int signerversionVersion of the PKCS#7 "SignerInfo" object. -
digestAlgorithmOid
The ID of the digest algorithm, e.g. "2.16.840.1.101.3.4.2.1". -
messageDigest
The object that will create the digest -
digestalgos
The digest algorithms -
digestAttr
private byte[] digestAttrThe digest attributes -
filterSubtype
-
signatureMechanismOid
The signature algorithm. -
signatureMechanismParameters
-
interfaceDigest
-
externalSignatureValue
private byte[] externalSignatureValueThe signature value or signed digest, if created outside this class -
externalEncapMessageContent
private byte[] externalEncapMessageContentExternally specified encapsulated message content. -
sig
Class from the Java SDK that provides the functionality of a digital signature algorithm. -
signatureValue
private byte[] signatureValueThe raw signature value as calculated by this class (or extracted from an existing PDF) -
encapMessageContent
private byte[] encapMessageContentThe content to which the signature applies, if encapsulated in the PKCS #7 payload. -
sigAttr
private byte[] sigAttrSignature attributes -
sigAttrDer
private byte[] sigAttrDerSignature attributes (maybe not necessary, but we use it as fallback) -
encContDigest
encrypted digest -
verified
private boolean verifiedIndicates if a signature has already been verified -
verifyResult
private boolean verifyResultThe result of the verification -
certs
All the X.509 certificates in no particular order. -
timestampCerts
-
signCerts
Collection<Certificate> signCertsAll the X.509 certificates used for the main signature. -
signCert
The X.509 certificate that is used to sign the digest. -
crls
-
signedDataCrls
-
basicResp
IBasicOCSPResponse basicRespBouncyCastle IBasicOCSPResponse -
signedDataOcsps
-
isTsp
private boolean isTspTrue if there's a PAdES LTV time stamp. -
isCades
private boolean isCadesTrue if it's a CAdES signature type. -
timestampSignatureContainer
Inner timestamp signature container. -
timeStampTokenInfo
BouncyCastle TSTInfo.
-
-
Constructor Details
-
PdfPKCS7
public PdfPKCS7(PrivateKey privKey, Certificate[] certChain, String hashAlgorithm, String provider, IExternalDigest interfaceDigest, boolean hasEncapContent) throws InvalidKeyException, NoSuchProviderException, NoSuchAlgorithmException Assembles all the elements needed to create a signature, except for the data.- Parameters:
privKey
- the private keycertChain
- the certificate chainhashAlgorithm
- the hash algorithmprovider
- the provider ornull
for the default providerinterfaceDigest
- the interface digesthasEncapContent
-true
if the sub-filter is adbe.pkcs7.sha1- Throws:
InvalidKeyException
- on errorNoSuchProviderException
- on errorNoSuchAlgorithmException
- on error
-
PdfPKCS7
public PdfPKCS7(PrivateKey privKey, Certificate[] certChain, String hashAlgorithm, String provider, boolean hasEncapContent) throws InvalidKeyException, NoSuchProviderException, NoSuchAlgorithmException Assembles all the elements needed to create a signature, except for the data.- Parameters:
privKey
- the private keycertChain
- the certificate chainhashAlgorithm
- the hash algorithmprovider
- the provider ornull
for the default providerhasEncapContent
-true
if the sub-filter is adbe.pkcs7.sha1- Throws:
InvalidKeyException
- on errorNoSuchProviderException
- on errorNoSuchAlgorithmException
- on error
-
PdfPKCS7
Use this constructor if you want to verify a signature using the sub-filter adbe.x509.rsa_sha1.- Parameters:
contentsKey
- the /Contents keycertsKey
- the /Cert keyprovider
- the provider ornull
for the default provider
-
PdfPKCS7
Use this constructor if you want to verify a signature.- Parameters:
contentsKey
- the /Contents keyfilterSubtype
- the filtersubtypeprovider
- the provider ornull
for the default provider
-
-
Method Details
-
getUnsignedAttributes
Get unsigned attributes associated with this PKCS7 signature container.- Returns:
- unsigned attributes as
IASN1EncodableVector
-
setSignaturePolicy
Set signature policy identifier to be used during signature creation.- Parameters:
signaturePolicy
-SignaturePolicyInfo
to be used during signature creation
-
setSignaturePolicy
Set signature policy identifier to be used during signature creation.- Parameters:
signaturePolicy
-ISignaturePolicyIdentifier
to be used during signature creation
-
getSignName
Getter for property sigName.- Returns:
- Value of property sigName.
-
setSignName
Setter for property sigName.- Parameters:
signName
- New value of property sigName.
-
getReason
Getter for property reason.- Returns:
- Value of property reason.
-
setReason
Setter for property reason.- Parameters:
reason
- New value of property reason.
-
getLocation
Getter for property location.- Returns:
- Value of property location.
-
setLocation
Setter for property location.- Parameters:
location
- New value of property location.
-
getSignDate
Getter for property signDate.- Returns:
- Value of property signDate.
-
setSignDate
Setter for property signDate.- Parameters:
signDate
- New value of property signDate.
-
getVersion
public int getVersion()Get the version of the PKCS#7 object.- Returns:
- the version of the PKCS#7 object.
-
getSigningInfoVersion
public int getSigningInfoVersion()Get the version of the PKCS#7 "SignerInfo" object.- Returns:
- the version of the PKCS#7 "SignerInfo" object.
-
getDigestAlgorithmOid
Getter for the ID of the digest algorithm, e.g. "2.16.840.1.101.3.4.2.1". See ISO-32000-1, section 12.8.3.3 PKCS#7 Signatures as used in ISO 32000- Returns:
- the ID of the digest algorithm
-
getDigestAlgorithmName
Returns the name of the digest algorithm, e.g. "SHA256".- Returns:
- the digest algorithm name, e.g. "SHA256"
-
getSignatureMechanismOid
Getter for the signature algorithm OID. See ISO-32000-1, section 12.8.3.3 PKCS#7 Signatures as used in ISO 32000- Returns:
- the signature algorithm OID
-
getSignatureMechanismName
Get the signature mechanism identifier, including both the digest function and the signature algorithm, e.g. "SHA1withRSA". See ISO-32000-1, section 12.8.3.3 PKCS#7 Signatures as used in ISO 32000- Returns:
- the algorithm used to calculate the signature
-
getSignatureAlgorithmName
Returns the name of the signature algorithm only (disregarding the digest function, if any).- Returns:
- the name of an encryption algorithm
-
setExternalSignatureValue
public void setExternalSignatureValue(byte[] signatureValue, byte[] signedMessageContent, String signatureAlgorithm) Sets the signature to an externally calculated value.- Parameters:
signatureValue
- the signature valuesignedMessageContent
- the extra data that goes into the data tag in PKCS#7signatureAlgorithm
- the signature algorithm. It must benull
if thesignatureValue
is alsonull
. If thesignatureValue
is notnull
, possible values include "RSA", "DSA", "ECDSA", "Ed25519" and "Ed448".
-
setExternalSignatureValue
public void setExternalSignatureValue(byte[] signatureValue, byte[] signedMessageContent, String signatureAlgorithm, ISignatureMechanismParams signatureMechanismParams) Sets the signature to an externally calculated value.- Parameters:
signatureValue
- the signature valuesignedMessageContent
- the extra data that goes into the data tag in PKCS#7signatureAlgorithm
- the signature algorithm. It must benull
if thesignatureValue
is alsonull
. If thesignatureValue
is notnull
, possible values include "RSA", "RSASSA-PSS", "DSA", "ECDSA", "Ed25519" and "Ed448".signatureMechanismParams
- parameters for the signature mechanism, if required
-
initSignature
private Signature initSignature(PrivateKey key) throws NoSuchAlgorithmException, NoSuchProviderException, InvalidKeyException -
initSignature
private Signature initSignature(PublicKey key) throws NoSuchAlgorithmException, NoSuchProviderException, InvalidKeyException -
configureSignatureMechanismParameters
-
update
Update the digest with the specified bytes. This method is used both for signing and verifying- Parameters:
buf
- the data bufferoff
- the offset in the data bufferlen
- the data length- Throws:
SignatureException
- on error
-
getEncodedPKCS1
public byte[] getEncodedPKCS1()Gets the bytes for the PKCS#1 object.- Returns:
- a byte array
-
getEncodedPKCS7
public byte[] getEncodedPKCS7()Gets the bytes for the PKCS7SignedData object.- Returns:
- the bytes for the PKCS7SignedData object
-
getEncodedPKCS7
public byte[] getEncodedPKCS7(byte[] secondDigest) Gets the bytes for the PKCS7SignedData object. Optionally the authenticatedAttributes in the signerInfo can also be set. If either of the parameters isnull
, none will be used.- Parameters:
secondDigest
- the digest in the authenticatedAttributes- Returns:
- the bytes for the PKCS7SignedData object
-
getEncodedPKCS7
public byte[] getEncodedPKCS7(byte[] secondDigest, PdfSigner.CryptoStandard sigtype, ITSAClient tsaClient, Collection<byte[]> ocsp, Collection<byte[]> crlBytes) Gets the bytes for the PKCS7SignedData object. Optionally the authenticatedAttributes in the signerInfo can also be set, and/or a time-stamp-authority client may be provided.- Parameters:
secondDigest
- the digest in the authenticatedAttributessigtype
- specifies the PKCS7 standard flavor to which created PKCS7SignedData object will adhere: either basic CMS or CAdEStsaClient
- TSAClient - null or an optional time stamp authority clientocsp
- collection of DER-encoded BasicOCSPResponses for the certificate in the signature certificates chain, or null if OCSP revocation data is not to be added.crlBytes
- collection of DER-encoded CRL for certificates from the signature certificates chain, or null if CRL revocation data is not to be added.- Returns:
- byte[] the bytes for the PKCS7SignedData object
- See Also:
-
addTimestampTokenToUnsignedAttributes
Added by Aiken Sam, 2006-11-15, modifed by Martin Brunecky 07/12/2007 to start with the timeStampToken (signedData 1.2.840.113549.1.7.2). Token is the TSA response without response status, which is usually handled by the (vendor supplied) TSA request/response interface).- Parameters:
timeStampToken
- byte[] - time stamp token, DER encoded signedData- Throws:
IOException
- if an I/O error occurs.
-
getAuthenticatedAttributeBytes
public byte[] getAuthenticatedAttributeBytes(byte[] secondDigest, PdfSigner.CryptoStandard sigtype, Collection<byte[]> ocsp, Collection<byte[]> crlBytes) When using authenticatedAttributes the authentication process is different. The document digest is generated and put inside the attribute. The signing is done over the DER encoded authenticatedAttributes. This method provides that encoding and the parameters must be exactly the same as ingetEncodedPKCS7(byte[])
.Note: do not pass in the full DER-encoded OCSPResponse object obtained from the responder, only the DER-encoded IBasicOCSPResponse value contained in the response data.
A simple example:
Calendar cal = Calendar.getInstance(); PdfPKCS7 pk7 = new PdfPKCS7(key, chain, null, "SHA1", null, false); MessageDigest messageDigest = MessageDigest.getInstance("SHA1"); byte[] buf = new byte[8192]; int n; InputStream inp = sap.getRangeStream(); while ((n = inp.read(buf)) > 0) { messageDigest.update(buf, 0, n); } byte[] hash = messageDigest.digest(); byte[] sh = pk7.getAuthenticatedAttributeBytes(hash, cal); pk7.update(sh, 0, sh.length); byte[] sg = pk7.getEncodedPKCS7(hash, cal);
- Parameters:
secondDigest
- the content digestsigtype
- specifies the PKCS7 standard flavor to which created PKCS7SignedData object will adhere: either basic CMS or CAdESocsp
- collection of DER-encoded BasicOCSPResponses for the certificate in the signature certificates chain, or null if OCSP revocation data is not to be added.crlBytes
- collection of DER-encoded CRL for certificates from the signature certificates chain, or null if CRL revocation data is not to be added.- Returns:
- the byte array representation of the authenticatedAttributes ready to be signed
- See Also:
-
getAuthenticatedAttributeSet
private IDERSet getAuthenticatedAttributeSet(byte[] secondDigest, Collection<byte[]> ocsp, Collection<byte[]> crlBytes, PdfSigner.CryptoStandard sigtype) This method provides that encoding and the parameters must be exactly the same as ingetEncodedPKCS7(byte[])
.- Parameters:
secondDigest
- the content digest- Returns:
- the byte array representation of the authenticatedAttributes ready to be signed
-
verifySignatureIntegrityAndAuthenticity
Verifies that signature integrity is intact (or in other words that signed data wasn't modified) by checking that embedded data digest corresponds to the calculated one. Also ensures that signature is genuine and is created by the owner of private key that corresponds to the declared public certificate.Even though signature can be authentic and signed data integrity can be intact, one shall also always check that signed data is not only a part of PDF contents but is actually a complete PDF file. In order to check that given signature covers the current
PdfDocument
please useSignatureUtil.signatureCoversWholeDocument(String)
method.- Returns:
true
if the signature checks out,false
otherwise- Throws:
GeneralSecurityException
- if this signature object is not initialized properly, the passed-in signature is improperly encoded or of the wrong type, if this signature algorithm is unable to process the input data provided, if the public key is invalid or if security provider or signature algorithm are not recognized, etc.
-
verifySigAttributes
- Throws:
GeneralSecurityException
-
verifyTimestampImprint
Checks if the timestamp refers to this document.- Returns:
- true if it checks false otherwise
- Throws:
GeneralSecurityException
- on error
-
getCertificates
Get all the X.509 certificates associated with this PKCS#7 object in no particular order. Other certificates, from OCSP for example, will also be included.- Returns:
- the X.509 certificates associated with this PKCS#7 object
-
getTimestampCertificates
Get all X.509 certificates associated with this PKCS#7 object timestamp in no particular order.- Returns:
Certificate
array
-
getSignCertificateChain
Get the X.509 sign certificate chain associated with this PKCS#7 object. Only the certificates used for the main signature will be returned, with the signing certificate first.- Returns:
- the X.509 certificates associated with this PKCS#7 object
-
getSigningCertificate
Get the X.509 certificate actually used to sign the digest.- Returns:
- the X.509 certificate actually used to sign the digest
-
signCertificateChain
private void signCertificateChain()Helper method that creates the collection of certificates used for the main signature based on the complete list of certificates and the sign certificate. -
getCRLs
Get the X.509 certificate revocation lists associated with this PKCS#7 object (stored in Signer Info).- Returns:
- the X.509 certificate revocation lists associated with this PKCS#7 object.
-
getSignedDataCRLs
Get the X.509 certificate revocation lists associated with this PKCS#7 Signed Data object.- Returns:
- the X.509 certificate revocation lists associated with this PKCS#7 Signed Data object.
-
findCRL
Helper method that tries to construct the CRLs. -
getSignedDataOcsps
Gets the OCSP basic response collection retrieved from SignedData structure.- Returns:
- the OCSP basic response collection.
-
getOcsp
Gets the OCSP basic response from the SignerInfo if there is one.- Returns:
- the OCSP basic response or null.
-
isRevocationValid
public boolean isRevocationValid()Checks if OCSP revocation refers to the document signing certificate.- Returns:
- true if it checks, false otherwise
-
findOcsp
Helper method that creates the IBasicOCSPResp object.- Parameters:
seq
-IASN1Sequence
wrapper- Throws:
IOException
- if some I/O error occurred.
-
isTsp
public boolean isTsp()Check if it's a PAdES-LTV time stamp.- Returns:
- true if it's a PAdES-LTV time stamp, false otherwise
-
getTimestampSignatureContainer
Retrieves inner timestamp signature container if there is one.- Returns:
- timestamp signature container or null.
-
getTimeStampTokenInfo
Gets the timestamp token info if there is one.- Returns:
- the timestamp token info or null
-
getTimeStampDate
Gets the timestamp date.In case the signed document doesn't contain timestamp,
TimestampConstants.UNDEFINED_TIMESTAMP_DATE
will be returned.- Returns:
- the timestamp date
-
getFilterSubtype
Getter for the filter subtype.- Returns:
- the filter subtype
-