Package com.itextpdf.text.pdf.security
Class PdfPKCS7
java.lang.Object
com.itextpdf.text.pdf.security.PdfPKCS7
This class does all the processing related to signing
and verifying a PKCS#7 signature.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.bouncycastle.cert.ocsp.BasicOCSPResp
BouncyCastle BasicOCSPRespprivate Collection
<Certificate> All the X.509 certificates in no particular order.private Collection
<CRL> private byte[]
The signed digest as calculated by this class (or extracted from an existing PDF)private String
The ID of the digest algorithm, e.g.The digest algorithmsprivate byte[]
The digest attributesprivate String
The encryption algorithm.private MessageDigest
encrypted digestprivate byte[]
The signed digest if created outside this classprivate byte[]
External RSA dataprivate PdfName
private ExternalDigest
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 String
The encryption provider, e.g.private String
Holds value of property reason.private byte[]
The RSA dataprivate 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 org.bouncycastle.asn1.esf.SignaturePolicyIdentifier
private X509Certificate
The X.509 certificate that is used to sign the digest.private Collection
<Certificate> All the X.509 certificates used for the main signature.private Calendar
Holds value of property signDate.private int
Version of the PKCS#7 "SignerInfo" object.private String
Holds value of property signName.private org.bouncycastle.tsp.TimeStampToken
BouncyCastle TimeStampToken.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, ExternalDigest interfaceDigest, boolean hasRSAdata) Assembles all the elements needed to create a signature, except for the data. -
Method Summary
Modifier and TypeMethodDescriptionprivate org.bouncycastle.asn1.ASN1EncodableVector
buildUnauthenticatedAttributes
(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
findCRL
(org.bouncycastle.asn1.ASN1Sequence seq) Helper method that tries to construct the CRLs.private void
findOcsp
(org.bouncycastle.asn1.ASN1Sequence seq) Helper method that creates the BasicOCSPResp object.byte[]
getAuthenticatedAttributeBytes
(byte[] secondDigest, byte[] ocsp, Collection<byte[]> crlBytes, MakeSignature.CryptoStandard sigtype) When using authenticatedAttributes the authentication process is different.private org.bouncycastle.asn1.DERSet
getAuthenticatedAttributeSet
(byte[] secondDigest, byte[] ocsp, Collection<byte[]> crlBytes, MakeSignature.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 objectGet the algorithm used to calculate the message digest, e.g.Getter for the ID of the digest algorithm, e.g.Getter for the digest encryption algorithmbyte[]
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, TSAClient tsaClient, byte[] ocsp, Collection<byte[]> crlBytes, MakeSignature.CryptoStandard sigtype) Gets the bytes for the PKCS7SignedData object.Returns the encryption algorithmReturns the filter subtype.Returns the name of the digest algorithm, e.g.Getter for property location.org.bouncycastle.cert.ocsp.BasicOCSPResp
getOcsp()
Gets the OCSP basic response if there is one.Getter for property reason.Get the X.509 sign certificate chain associated with this PKCS#7 object.Getter for property signDate.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.Gets the timestamp dateorg.bouncycastle.tsp.TimeStampToken
Gets the timestamp token if there is one.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
setExternalDigest
(byte[] digest, byte[] RSAdata, String digestEncryptionAlgorithm) Sets the digest/signature to an external calculated value.void
setLocation
(String location) Setter for property location.void
Setter for property reason.void
setSignaturePolicy
(SignaturePolicyInfo signaturePolicy) void
setSignaturePolicy
(org.bouncycastle.asn1.esf.SignaturePolicyIdentifier signaturePolicy) 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.boolean
verify()
Verify the digest.private boolean
verifySigAttributes
(byte[] attr) boolean
Checks if the timestamp refers to this document.
-
Field Details
-
provider
The encryption provider, e.g. "BC" if you use BouncyCastle. -
signaturePolicyIdentifier
private org.bouncycastle.asn1.esf.SignaturePolicyIdentifier signaturePolicyIdentifier -
signName
Holds value of property signName. -
reason
Holds value of property reason. -
location
Holds value of property location. -
signDate
Holds value of property signDate. -
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
-
digestEncryptionAlgorithmOid
The encryption algorithm. -
interfaceDigest
-
externalDigest
private byte[] externalDigestThe signed digest if created outside this class -
externalRSAdata
private byte[] externalRSAdataExternal RSA data -
sig
Class from the Java SDK that provides the functionality of a digital signature algorithm. -
digest
private byte[] digestThe signed digest as calculated by this class (or extracted from an existing PDF) -
RSAdata
private byte[] RSAdataThe RSA data -
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. -
signCerts
All the X.509 certificates used for the main signature. -
signCert
The X.509 certificate that is used to sign the digest. -
crls
-
basicResp
private org.bouncycastle.cert.ocsp.BasicOCSPResp basicRespBouncyCastle BasicOCSPResp -
isTsp
private boolean isTspTrue if there's a PAdES LTV time stamp. -
isCades
private boolean isCadesTrue if it's a CAdES signature type. -
timeStampToken
private org.bouncycastle.tsp.TimeStampToken timeStampTokenBouncyCastle TimeStampToken.
-
-
Constructor Details
-
PdfPKCS7
public PdfPKCS7(PrivateKey privKey, Certificate[] certChain, String hashAlgorithm, String provider, ExternalDigest interfaceDigest, boolean hasRSAdata) 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 digesthasRSAdata
-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
-
setSignaturePolicy
-
setSignaturePolicy
public void setSignaturePolicy(org.bouncycastle.asn1.esf.SignaturePolicyIdentifier signaturePolicy) -
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" -
getHashAlgorithm
Returns the name of the digest algorithm, e.g. "SHA256".- Returns:
- the digest algorithm name, e.g. "SHA256"
-
getDigestEncryptionAlgorithmOid
Getter for the digest encryption algorithm -
getDigestAlgorithm
Get the algorithm used to calculate the message digest, e.g. "SHA1withRSA".- Returns:
- the algorithm used to calculate the message digest
-
setExternalDigest
Sets the digest/signature to an external calculated value.- Parameters:
digest
- the digest. This is the actual signatureRSAdata
- the extra data that goes into the data tag in PKCS#7digestEncryptionAlgorithm
- the encryption algorithm. It may must benull
if thedigest
is alsonull
. If thedigest
is notnull
then it may be "RSA" or "DSA"
-
initSignature
private Signature initSignature(PrivateKey key) throws NoSuchAlgorithmException, NoSuchProviderException, InvalidKeyException -
initSignature
private Signature initSignature(PublicKey key) throws NoSuchAlgorithmException, NoSuchProviderException, InvalidKeyException -
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, TSAClient tsaClient, byte[] ocsp, Collection<byte[]> crlBytes, MakeSignature.CryptoStandard sigtype) Gets the bytes for the PKCS7SignedData object. Optionally the authenticatedAttributes in the signerInfo can also be set, OR a time-stamp-authority client may be provided.- Parameters:
secondDigest
- the digest in the authenticatedAttributestsaClient
- TSAClient - null or an optional time stamp authority client- Returns:
- byte[] the bytes for the PKCS7SignedData object
- Since:
- 2.1.6
-
buildUnauthenticatedAttributes
private org.bouncycastle.asn1.ASN1EncodableVector buildUnauthenticatedAttributes(byte[] timeStampToken) throws IOException 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- Returns:
- ASN1EncodableVector
- Throws:
IOException
-
getAuthenticatedAttributeBytes
public byte[] getAuthenticatedAttributeBytes(byte[] secondDigest, byte[] ocsp, Collection<byte[]> crlBytes, MakeSignature.CryptoStandard sigtype) 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[])
.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 digest- Returns:
- the byte array representation of the authenticatedAttributes ready to be signed
-
getAuthenticatedAttributeSet
private org.bouncycastle.asn1.DERSet getAuthenticatedAttributeSet(byte[] secondDigest, byte[] ocsp, Collection<byte[]> crlBytes, MakeSignature.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
-
verify
Verify the digest.- Returns:
true
if the signature checks out,false
otherwise- Throws:
SignatureException
- on errorGeneralSecurityException
-
verifySigAttributes
- Throws:
GeneralSecurityException
-
verifyTimestampImprint
Checks if the timestamp refers to this document.- Returns:
- true if it checks false otherwise
- Throws:
GeneralSecurityException
- on error- Since:
- 2.1.6
-
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
-
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
- Since:
- 2.1.6
-
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- Returns:
- the X.509 certificate revocation lists associated with this PKCS#7 object
-
findCRL
private void findCRL(org.bouncycastle.asn1.ASN1Sequence seq) Helper method that tries to construct the CRLs. -
getOcsp
public org.bouncycastle.cert.ocsp.BasicOCSPResp getOcsp()Gets the OCSP basic response if there is one.- Returns:
- the OCSP basic response or null
- Since:
- 2.1.6
-
isRevocationValid
public boolean isRevocationValid()Checks if OCSP revocation refers to the document signing certificate.- Returns:
- true if it checks, false otherwise
- Since:
- 2.1.6
-
findOcsp
Helper method that creates the BasicOCSPResp object.- Parameters:
seq
-- Throws:
IOException
-
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
-
getTimeStampToken
public org.bouncycastle.tsp.TimeStampToken getTimeStampToken()Gets the timestamp token if there is one.- Returns:
- the timestamp token or null
- Since:
- 2.1.6
-
getTimeStampDate
Gets the timestamp date- Returns:
- a date
- Since:
- 2.1.6
-
getFilterSubtype
Returns the filter subtype. -
getEncryptionAlgorithm
Returns the encryption algorithm- Returns:
- the name of an encryption algorithm
-