com.lowagie.text.pdf.PdfPKCS7 Maven / Gradle / Ivy
/*
* Copyright 2004 by Paulo Soares.
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* https://github.com/LibrePDF/OpenPDF
*/
package com.lowagie.text.pdf;
import static org.bouncycastle.asn1.x509.Extension.authorityInfoAccess;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.math.BigInteger;
import java.nio.charset.StandardCharsets;
import java.security.InvalidKeyException;
import java.security.KeyStore;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.security.NoSuchProviderException;
import java.security.PrivateKey;
import java.security.Signature;
import java.security.SignatureException;
import java.security.cert.CRL;
import java.security.cert.Certificate;
import java.security.cert.X509CRL;
import java.security.cert.X509Certificate;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Calendar;
import java.util.Collection;
import java.util.Date;
import java.util.Enumeration;
import java.util.GregorianCalendar;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import org.bouncycastle.asn1.ASN1Encodable;
import org.bouncycastle.asn1.ASN1EncodableVector;
import org.bouncycastle.asn1.ASN1Encoding;
import org.bouncycastle.asn1.ASN1Enumerated;
import org.bouncycastle.asn1.ASN1InputStream;
import org.bouncycastle.asn1.ASN1Integer;
import org.bouncycastle.asn1.ASN1ObjectIdentifier;
import org.bouncycastle.asn1.ASN1OctetString;
import org.bouncycastle.asn1.ASN1OutputStream;
import org.bouncycastle.asn1.ASN1Primitive;
import org.bouncycastle.asn1.ASN1Sequence;
import org.bouncycastle.asn1.ASN1Set;
import org.bouncycastle.asn1.ASN1String;
import org.bouncycastle.asn1.ASN1TaggedObject;
import org.bouncycastle.asn1.DERNull;
import org.bouncycastle.asn1.DEROctetString;
import org.bouncycastle.asn1.DERSequence;
import org.bouncycastle.asn1.DERSet;
import org.bouncycastle.asn1.DERTaggedObject;
import org.bouncycastle.asn1.DERUTCTime;
import org.bouncycastle.asn1.cms.Attribute;
import org.bouncycastle.asn1.cms.AttributeTable;
import org.bouncycastle.asn1.cms.ContentInfo;
import org.bouncycastle.asn1.ocsp.BasicOCSPResponse;
import org.bouncycastle.asn1.ocsp.OCSPObjectIdentifiers;
import org.bouncycastle.asn1.pkcs.PKCSObjectIdentifiers;
import org.bouncycastle.asn1.tsp.MessageImprint;
import org.bouncycastle.cert.jcajce.JcaX509CertificateHolder;
import org.bouncycastle.cert.ocsp.BasicOCSPResp;
import org.bouncycastle.cert.ocsp.CertificateID;
import org.bouncycastle.cert.ocsp.SingleResp;
import org.bouncycastle.jcajce.provider.asymmetric.x509.CertificateFactory;
import org.bouncycastle.jce.provider.X509CRLParser;
import org.bouncycastle.operator.DigestCalculatorProvider;
import org.bouncycastle.operator.jcajce.JcaDigestCalculatorProviderBuilder;
import org.bouncycastle.tsp.TimeStampToken;
import org.bouncycastle.tsp.TimeStampTokenInfo;
import com.lowagie.text.ExceptionConverter;
/**
* This class does all the processing related to signing and verifying a PKCS#7 signature.
*
* It's based in code found at org.bouncycastle.
*/
public class PdfPKCS7 {
private static final String ID_PKCS7_DATA = "1.2.840.113549.1.7.1";
private static final String ID_PKCS7_SIGNED_DATA = "1.2.840.113549.1.7.2";
private static final String ID_RSA = "1.2.840.113549.1.1.1";
private static final String ID_DSA = "1.2.840.10040.4.1";
private static final String ID_ECDSA = "1.2.840.10045.2.1";
private static final String ID_CONTENT_TYPE = "1.2.840.113549.1.9.3";
private static final String ID_MESSAGE_DIGEST = "1.2.840.113549.1.9.4";
private static final String ID_SIGNING_TIME = "1.2.840.113549.1.9.5";
private static final String ID_ADBE_REVOCATION = "1.2.840.113583.1.1.8";
private static final Map digestNames = new HashMap<>();
private static final Map algorithmNames = new HashMap<>();
private static final Map allowedDigests = new HashMap<>();
static {
digestNames.put("1.2.840.113549.2.5", "MD5");
digestNames.put("1.2.840.113549.2.2", "MD2");
digestNames.put("1.3.14.3.2.26", "SHA1");
digestNames.put("2.16.840.1.101.3.4.2.4", "SHA224");
digestNames.put("2.16.840.1.101.3.4.2.1", "SHA256");
digestNames.put("2.16.840.1.101.3.4.2.2", "SHA384");
digestNames.put("2.16.840.1.101.3.4.2.3", "SHA512");
digestNames.put("1.3.36.3.2.2", "RIPEMD128");
digestNames.put("1.3.36.3.2.1", "RIPEMD160");
digestNames.put("1.3.36.3.2.3", "RIPEMD256");
digestNames.put("1.2.840.113549.1.1.4", "MD5");
digestNames.put("1.2.840.113549.1.1.2", "MD2");
digestNames.put("1.2.840.113549.1.1.5", "SHA1");
digestNames.put("1.2.840.113549.1.1.14", "SHA224");
digestNames.put("1.2.840.113549.1.1.11", "SHA256");
digestNames.put("1.2.840.113549.1.1.12", "SHA384");
digestNames.put("1.2.840.113549.1.1.13", "SHA512");
digestNames.put("1.2.840.10040.4.3", "SHA1"); // TODO: bug - duplicate key - overwrites this with DSA
digestNames.put("2.16.840.1.101.3.4.3.1", "SHA224"); // TODO: bug - duplicate key - overwrites this with DSA
digestNames.put("2.16.840.1.101.3.4.3.2", "SHA256");
digestNames.put("2.16.840.1.101.3.4.3.3", "SHA384");
digestNames.put("2.16.840.1.101.3.4.3.4", "SHA512");
digestNames.put("1.3.36.3.3.1.3", "RIPEMD128");
digestNames.put("1.3.36.3.3.1.2", "RIPEMD160");
digestNames.put("1.3.36.3.3.1.4", "RIPEMD256");
algorithmNames.put("1.2.840.113549.1.1.1", "RSA");
algorithmNames.put("1.2.840.10040.4.1", "DSA");
algorithmNames.put("1.2.840.113549.1.1.2", "RSA");
algorithmNames.put("1.2.840.113549.1.1.4", "RSA");
algorithmNames.put("1.2.840.113549.1.1.5", "RSA");
algorithmNames.put("1.2.840.113549.1.1.14", "RSA");
algorithmNames.put("1.2.840.113549.1.1.11", "RSA");
algorithmNames.put("1.2.840.113549.1.1.12", "RSA");
algorithmNames.put("1.2.840.113549.1.1.13", "RSA");
algorithmNames.put("1.2.840.10040.4.3", "DSA");
algorithmNames.put("2.16.840.1.101.3.4.3.1", "DSA");
algorithmNames.put("2.16.840.1.101.3.4.3.2", "DSA");
algorithmNames.put("1.3.36.3.3.1.3", "RSA");
algorithmNames.put("1.3.36.3.3.1.2", "RSA");
algorithmNames.put("1.3.36.3.3.1.4", "RSA");
algorithmNames.put(ID_ECDSA, "ECDSA");
algorithmNames.put("1.2.840.10045.4.1", "ECDSA");
algorithmNames.put("1.2.840.10045.4.3", "ECDSA");
algorithmNames.put("1.2.840.10045.4.3.2", "ECDSA");
algorithmNames.put("1.2.840.10045.4.3.3", "ECDSA");
algorithmNames.put("1.2.840.10045.4.3.4", "ECDSA");
algorithmNames.put("1.2.840.113549.1.1.10", "RSAandMGF1");
allowedDigests.put("MD5", "1.2.840.113549.2.5");
allowedDigests.put("MD2", "1.2.840.113549.2.2");
allowedDigests.put("SHA1", "1.3.14.3.2.26");
allowedDigests.put("SHA224", "2.16.840.1.101.3.4.2.4");
allowedDigests.put("SHA256", "2.16.840.1.101.3.4.2.1");
allowedDigests.put("SHA384", "2.16.840.1.101.3.4.2.2");
allowedDigests.put("SHA512", "2.16.840.1.101.3.4.2.3");
allowedDigests.put("MD-5", "1.2.840.113549.2.5");
allowedDigests.put("MD-2", "1.2.840.113549.2.2");
allowedDigests.put("SHA-1", "1.3.14.3.2.26");
allowedDigests.put("SHA-224", "2.16.840.1.101.3.4.2.4");
allowedDigests.put("SHA-256", "2.16.840.1.101.3.4.2.1");
allowedDigests.put("SHA-384", "2.16.840.1.101.3.4.2.2");
allowedDigests.put("SHA-512", "2.16.840.1.101.3.4.2.3");
allowedDigests.put("RIPEMD128", "1.3.36.3.2.2");
allowedDigests.put("RIPEMD-128", "1.3.36.3.2.2");
allowedDigests.put("RIPEMD160", "1.3.36.3.2.1");
allowedDigests.put("RIPEMD-160", "1.3.36.3.2.1");
allowedDigests.put("RIPEMD256", "1.3.36.3.2.3");
allowedDigests.put("RIPEMD-256", "1.3.36.3.2.3");
}
private final List certs;
private final List crls;
private final String provider;
private byte[] sigAttr;
private byte[] digestAttr;
private int version, signerversion;
private Set digestalgos;
private List signCerts;
private X509Certificate signCert;
private byte[] digest;
private MessageDigest messageDigest;
private String digestAlgorithm, digestEncryptionAlgorithm;
private Signature sig;
private transient PrivateKey privKey;
private byte[] RSAdata;
private boolean verified;
private boolean verifyResult;
private byte[] externalDigest;
private byte[] externalRSAdata;
/**
* Holds value of property reason.
*/
private String reason;
/**
* Holds value of property location.
*/
private String location;
/**
* Holds value of property signDate.
*/
private Calendar signDate;
/**
* Holds value of property signName.
*/
private String signName;
private TimeStampToken timeStampToken;
private BasicOCSPResp basicResp;
/**
* Verifies a signature using the sub-filter adbe.x509.rsa_sha1.
*
* @param contentsKey the /Contents key
* @param certsKey the /Cert key
* @param provider the provider or null for the default provider
*/
@SuppressWarnings("unchecked")
public PdfPKCS7(byte[] contentsKey, byte[] certsKey, String provider) {
try {
this.provider = provider;
CertificateFactory certificateFactory = new CertificateFactory();
Collection certificates = certificateFactory.engineGenerateCertificates(
new ByteArrayInputStream(certsKey));
certs = new ArrayList<>(certificates);
signCerts = certs;
signCert = (X509Certificate) certs.iterator().next();
crls = new ArrayList<>();
ASN1InputStream in = new ASN1InputStream(new ByteArrayInputStream(contentsKey));
digest = ((DEROctetString) in.readObject()).getOctets();
if (provider == null) {
sig = Signature.getInstance("SHA1withRSA");
} else {
sig = Signature.getInstance("SHA1withRSA", provider);
}
sig.initVerify(signCert.getPublicKey());
} catch (Exception e) {
throw new ExceptionConverter(e);
}
}
/**
* Verifies a signature using the sub-filter adbe.pkcs7.detached or adbe.pkcs7.sha1.
*
* @param contentsKey the /Contents key
* @param provider the provider or null for the default provider
*/
@SuppressWarnings("unchecked")
public PdfPKCS7(byte[] contentsKey, String provider) {
try {
this.provider = provider;
ASN1InputStream din = new ASN1InputStream(new ByteArrayInputStream(
contentsKey));
//
// Basic checks to make sure it's a PKCS#7 SignedData Object
//
ASN1Primitive pkcs;
try {
pkcs = din.readObject();
} catch (IOException e) {
throw new IllegalArgumentException("PdfPKCS7 Error");
}
if (!(pkcs instanceof ASN1Sequence)) {
throw new IllegalArgumentException("PdfPKCS7 Error");
}
ASN1Sequence signedData = (ASN1Sequence) pkcs;
ASN1ObjectIdentifier objId = (ASN1ObjectIdentifier) signedData
.getObjectAt(0);
if (!objId.getId().equals(ID_PKCS7_SIGNED_DATA)) {
throw new IllegalArgumentException("PdfPKCS7 Error");
}
ASN1Sequence content = (ASN1Sequence) ((ASN1TaggedObject) signedData.getObjectAt(
1)).getBaseObject(); // the positions that we care are:
// the positions that we care are:
// 0 - version
// 1 - digestAlgorithms
// 2 - possible ID_PKCS7_DATA
// (the certificates and crls are taken out by other means)
// last - signerInfos
// the version
version = ((ASN1Integer) content.getObjectAt(0)).getValue().intValue();
// the digestAlgorithms
digestalgos = new HashSet<>();
Enumeration e = ((ASN1Set) content.getObjectAt(1)).getObjects();
while (e.hasMoreElements()) {
ASN1Sequence s = (ASN1Sequence) e.nextElement();
ASN1ObjectIdentifier o = (ASN1ObjectIdentifier) s.getObjectAt(0);
digestalgos.add(o.getId());
}
// the certificates and crls
CertificateFactory certificateFactory = new CertificateFactory();
Collection certificates = certificateFactory.engineGenerateCertificates(
new ByteArrayInputStream(contentsKey));
this.certs = new ArrayList<>(certificates);
X509CRLParser cl = new X509CRLParser();
cl.engineInit(new ByteArrayInputStream(contentsKey));
crls = (List) cl.engineReadAll();
// the possible ID_PKCS7_DATA
ASN1Sequence rsaData = (ASN1Sequence) content.getObjectAt(2);
if (rsaData.size() > 1) {
ASN1OctetString rsaDataContent = (ASN1OctetString) ((ASN1TaggedObject) rsaData.getObjectAt(
1)).getBaseObject();
RSAdata = rsaDataContent.getOctets();
}
int next = 3;
while (content.getObjectAt(next) instanceof ASN1TaggedObject) {
++next;
}
// the signerInfos
ASN1Set signerInfos = (ASN1Set) content.getObjectAt(next);
if (signerInfos.size() != 1) {
throw new IllegalArgumentException("PdfPKCS7 Error");
}
ASN1Sequence signerInfo = (ASN1Sequence) signerInfos.getObjectAt(0);
// the positions that we care are
// 0 - version
// 1 - the signing certificate serial number
// 2 - the digest algorithm
// 3 or 4 - digestEncryptionAlgorithm
// 4 or 5 - encryptedDigest
signerversion = ((ASN1Integer) signerInfo.getObjectAt(0)).getValue()
.intValue();
// Get the signing certificate
ASN1Sequence issuerAndSerialNumber = (ASN1Sequence) signerInfo
.getObjectAt(1);
BigInteger serialNumber = ((ASN1Integer) issuerAndSerialNumber
.getObjectAt(1)).getValue();
for (Object cert1 : this.certs) {
X509Certificate cert = (X509Certificate) cert1;
if (serialNumber.equals(cert.getSerialNumber())) {
signCert = cert;
break;
}
}
if (signCert == null) {
throw new IllegalArgumentException("PdfPKCS7 Error");
}
signCertificateChain();
digestAlgorithm = ((ASN1ObjectIdentifier) ((ASN1Sequence) signerInfo
.getObjectAt(2)).getObjectAt(0)).getId();
next = 3;
if (signerInfo.getObjectAt(next) instanceof ASN1TaggedObject) {
ASN1TaggedObject tagsig = (ASN1TaggedObject) signerInfo
.getObjectAt(next);
ASN1Set sseq = ASN1Set.getInstance(tagsig, false);
sigAttr = sseq.getEncoded(ASN1Encoding.DER);
for (int k = 0; k < sseq.size(); ++k) {
ASN1Sequence seq2 = (ASN1Sequence) sseq.getObjectAt(k);
if (((ASN1ObjectIdentifier) seq2.getObjectAt(0)).getId().equals(
ID_MESSAGE_DIGEST)) {
ASN1Set set = (ASN1Set) seq2.getObjectAt(1);
digestAttr = ((DEROctetString) set.getObjectAt(0)).getOctets();
} else if (((ASN1ObjectIdentifier) seq2.getObjectAt(0)).getId()
.equals(ID_ADBE_REVOCATION)) {
ASN1Set setout = (ASN1Set) seq2.getObjectAt(1);
ASN1Sequence seqout = (ASN1Sequence) setout.getObjectAt(0);
for (int j = 0; j < seqout.size(); ++j) {
ASN1TaggedObject tg = (ASN1TaggedObject) seqout.getObjectAt(j);
if (tg.getTagNo() != 1) {
continue;
}
ASN1Sequence seqin = (ASN1Sequence) tg.getBaseObject();
findOcsp(seqin);
}
}
}
if (digestAttr == null) {
throw new IllegalArgumentException("PdfPKCS7 Error");
}
++next;
}
digestEncryptionAlgorithm = ((ASN1ObjectIdentifier) ((ASN1Sequence) signerInfo
.getObjectAt(next++)).getObjectAt(0)).getId();
digest = ((DEROctetString) signerInfo.getObjectAt(next++)).getOctets();
if (next < signerInfo.size() && (signerInfo.getObjectAt(next) instanceof ASN1TaggedObject)) {
ASN1TaggedObject taggedObject = (ASN1TaggedObject) signerInfo.getObjectAt(next);
ASN1Set unat = ASN1Set.getInstance(taggedObject, false);
AttributeTable attble = new AttributeTable(unat);
Attribute ts = attble.get(PKCSObjectIdentifiers.id_aa_signatureTimeStampToken);
if (ts != null && ts.getAttrValues().size() > 0) {
ASN1Set attributeValues = ts.getAttrValues();
ASN1Sequence tokenSequence = ASN1Sequence.getInstance(attributeValues.getObjectAt(0));
ContentInfo contentInfo = ContentInfo.getInstance(tokenSequence);
this.timeStampToken = new TimeStampToken(contentInfo);
}
}
if (RSAdata != null || digestAttr != null) {
if (provider == null || provider.startsWith("SunPKCS11")) {
messageDigest = MessageDigest.getInstance(getStandardJavaName(getHashAlgorithm()));
} else {
messageDigest = MessageDigest.getInstance(getStandardJavaName(getHashAlgorithm()),
provider);
}
}
if (provider == null) {
sig = Signature.getInstance(getDigestAlgorithm());
} else {
sig = Signature.getInstance(getDigestAlgorithm(), provider);
}
sig.initVerify(signCert.getPublicKey());
} catch (Exception e) {
throw new ExceptionConverter(e);
}
}
/**
* Generates a signature.
*
* @param privKey the private key
* @param certChain the certificate chain
* @param crlList the certificate revocation list
* @param hashAlgorithm the hash algorithm
* @param provider the provider or null for the default provider
* @param hasRSAdata true if the sub-filter is adbe.pkcs7.sha1
* @throws InvalidKeyException on error
* @throws NoSuchProviderException on error
* @throws NoSuchAlgorithmException on error
*/
public PdfPKCS7(PrivateKey privKey, Certificate[] certChain, CRL[] crlList,
String hashAlgorithm, String provider, boolean hasRSAdata)
throws InvalidKeyException, NoSuchProviderException,
NoSuchAlgorithmException {
this.privKey = privKey;
this.provider = provider;
digestAlgorithm = allowedDigests.get(hashAlgorithm.toUpperCase());
if (digestAlgorithm == null) {
throw new IllegalArgumentException("PdfPKCS7 Error");
}
version = signerversion = 1;
certs = new ArrayList<>();
crls = new ArrayList<>();
digestalgos = new HashSet<>();
digestalgos.add(digestAlgorithm);
//
// Copy in the certificates and crls used to sign the private key.
//
signCert = (X509Certificate) certChain[0];
certs.addAll(Arrays.asList(certChain));
if (crlList != null) {
crls.addAll(Arrays.asList(crlList));
}
if (privKey != null) {
//
// Now we have private key, find out what the digestEncryptionAlgorithm
// is.
//
digestEncryptionAlgorithm = privKey.getAlgorithm();
if (digestEncryptionAlgorithm.equals("RSA")) {
digestEncryptionAlgorithm = ID_RSA;
} else if (digestEncryptionAlgorithm.equals("DSA")) {
digestEncryptionAlgorithm = ID_DSA;
} else if (digestEncryptionAlgorithm.equals("EC") || digestEncryptionAlgorithm.equals("ECDSA")) {
digestEncryptionAlgorithm = ID_ECDSA;
} else {
throw new NoSuchAlgorithmException("Unknown Algorithm");
}
}
if (hasRSAdata) {
RSAdata = new byte[0];
if (provider == null || provider.startsWith("SunPKCS11")) {
messageDigest = MessageDigest.getInstance(getStandardJavaName(getHashAlgorithm()));
} else {
messageDigest = MessageDigest.getInstance(getStandardJavaName(getHashAlgorithm()), provider);
}
}
if (privKey != null) {
if (provider == null) {
sig = Signature.getInstance(getDigestAlgorithm());
} else {
sig = Signature.getInstance(getDigestAlgorithm(), provider);
}
sig.initSign(privKey);
}
}
/**
* Gets the digest name for a certain id
*
* @param oid an id (for instance "1.2.840.113549.2.5")
* @return a digest name (for instance "MD5")
* @since 2.1.6
*/
public static String getDigest(String oid) {
return Optional.ofNullable(digestNames.get(oid))
.orElse(oid);
}
/**
* Gets the algorithm name for a certain id.
*
* @param oid an id (for instance "1.2.840.113549.1.1.1")
* @return an algorithm name (for instance "RSA")
* @since 2.1.6
*/
public static String getAlgorithm(String oid) {
return Optional.ofNullable(algorithmNames.get(oid))
.orElse(oid);
}
/**
* Gets the oid for given digest name.
*
* @param digestName digest name (for instance "SHA-256")
* @return a digest OID (for instance "2.16.840.1.101.3.4.2.1") or {@code null} if the oid for provided name is not
* found
*/
public static String getDigestOid(String digestName) {
return digestName != null ? allowedDigests.get(digestName) : null;
}
/**
* Loads the default root certificates at <java.home>/lib/security/cacerts with the default provider.
*
* @return a KeyStore
*/
public static KeyStore loadCacertsKeyStore() {
return loadCacertsKeyStore(null);
}
/**
* Loads the default root certificates at <java.home>/lib/security/cacerts.
*
* @param provider the provider or null for the default provider
* @return a KeyStore
*/
public static KeyStore loadCacertsKeyStore(String provider) {
File file = new File(System.getProperty("java.home"), "lib");
file = new File(file, "security");
file = new File(file, "cacerts");
try (FileInputStream fin = new FileInputStream(file)) {
KeyStore k;
if (provider == null) {
k = KeyStore.getInstance("JKS");
} else {
k = KeyStore.getInstance("JKS", provider);
}
k.load(fin, null);
return k;
} catch (Exception e) {
throw new ExceptionConverter(e);
}
}
/**
* Verifies a single certificate.
*
* @param cert the certificate to verify
* @param crls the certificate revocation list or null
* @param calendar the date or null for the current date
* @return a String with the error description or
* null if no error
*/
public static String verifyCertificate(X509Certificate cert, Collection crls,
Calendar calendar) {
if (calendar == null) {
calendar = new GregorianCalendar();
}
if (cert.hasUnsupportedCriticalExtension()) {
return "Has unsupported critical extension";
}
try {
cert.checkValidity(calendar.getTime());
} catch (Exception e) {
return e.getMessage();
}
if (crls != null) {
for (Object crl : crls) {
if (((CRL) crl).isRevoked(cert)) {
return "Certificate revoked";
}
}
}
return null;
}
/**
* Verifies a certificate chain against a KeyStore.
*
* @param certs the certificate chain
* @param keystore the KeyStore
* @param crls the certificate revocation list or null
* @param calendar the date or null for the current date
* @return null if the certificate chain could be validated or a
* Object[]{cert,error} where cert is the
* failed certificate and error is the error message
*/
public static Object[] verifyCertificates(Certificate[] certs,
KeyStore keystore, Collection crls, Calendar calendar) {
if (calendar == null) {
calendar = new GregorianCalendar();
}
for (int k = 0; k < certs.length; ++k) {
X509Certificate cert = (X509Certificate) certs[k];
String err = verifyCertificate(cert, crls, calendar);
if (err != null) {
return new Object[] { cert, err };
}
try {
for (Enumeration aliases = keystore.aliases(); aliases
.hasMoreElements();) {
try {
String alias = (String) aliases.nextElement();
if (!keystore.isCertificateEntry(alias)) {
continue;
}
X509Certificate certStoreX509 = (X509Certificate) keystore
.getCertificate(alias);
if (verifyCertificate(certStoreX509, crls, calendar) != null) {
continue;
}
try {
cert.verify(certStoreX509.getPublicKey());
return null;
} catch (Exception ignored) {
}
} catch (Exception ignored) {
}
}
} catch (Exception ignored) {
}
int j;
for (j = 0; j < certs.length; ++j) {
if (j == k) {
continue;
}
X509Certificate certNext = (X509Certificate) certs[j];
try {
cert.verify(certNext.getPublicKey());
break;
} catch (Exception ignored) {
}
}
if (j == certs.length) {
return new Object[] { cert,
"Cannot be verified against the KeyStore or the certificate chain" };
}
}
return new Object[] { null,
"Invalid state. Possible circular certificate chain" };
}
/**
* Retrieves the OCSP URL from the given certificate.
*
* @param certificate the certificate
* @return the URL or null
* @since 2.1.6
*/
public static String getOCSPURL(X509Certificate certificate) {
try {
ASN1Primitive obj = getExtensionValue(certificate, authorityInfoAccess.getId());
if (obj == null) {
return null;
}
ASN1Sequence AccessDescriptions = (ASN1Sequence) obj;
for (int i = 0; i < AccessDescriptions.size(); i++) {
ASN1Sequence AccessDescription = (ASN1Sequence) AccessDescriptions
.getObjectAt(i);
if (AccessDescription.size() == 2) {
if ((AccessDescription.getObjectAt(0) instanceof ASN1ObjectIdentifier)
&& ((ASN1ObjectIdentifier) AccessDescription.getObjectAt(0))
.getId().equals("1.3.6.1.5.5.7.48.1")) {
return getStringFromGeneralName((ASN1Primitive) AccessDescription
.getObjectAt(1));
}
}
}
} catch (Exception ignored) {
}
return null;
}
private static ASN1Primitive getExtensionValue(X509Certificate cert,
String oid) throws IOException {
byte[] bytes = cert.getExtensionValue(oid);
if (bytes == null) {
return null;
}
ASN1InputStream aIn = new ASN1InputStream(new ByteArrayInputStream(bytes));
ASN1OctetString octs = (ASN1OctetString) aIn.readObject();
aIn = new ASN1InputStream(new ByteArrayInputStream(octs.getOctets()));
return aIn.readObject();
}
private static String getStringFromGeneralName(ASN1Primitive names) {
ASN1TaggedObject taggedObject = (ASN1TaggedObject) names;
return new String(ASN1OctetString.getInstance(taggedObject, false)
.getOctets(), StandardCharsets.ISO_8859_1);
}
/**
* Get the "issuer" from the TBSCertificate bytes that are passed in
*
* @param enc a TBSCertificate in a byte array
* @return a ASN1Primitive
*/
private static ASN1Primitive getIssuer(byte[] enc) {
try {
ASN1InputStream in = new ASN1InputStream(new ByteArrayInputStream(enc));
ASN1Sequence seq = (ASN1Sequence) in.readObject();
return (ASN1Primitive) seq
.getObjectAt(seq.getObjectAt(0) instanceof ASN1TaggedObject ? 3 : 2);
} catch (IOException e) {
throw new ExceptionConverter(e);
}
}
/**
* Get the "subject" from the TBSCertificate bytes that are passed in
*
* @param enc A TBSCertificate in a byte array
* @return a ASN1Primitive
*/
private static ASN1Primitive getSubject(byte[] enc) {
try {
ASN1InputStream in = new ASN1InputStream(new ByteArrayInputStream(enc));
ASN1Sequence seq = (ASN1Sequence) in.readObject();
return (ASN1Primitive) seq
.getObjectAt(seq.getObjectAt(0) instanceof ASN1TaggedObject ? 5 : 4);
} catch (IOException e) {
throw new ExceptionConverter(e);
}
}
/**
* Get the issuer fields from an X509 Certificate
*
* @param cert an X509Certificate
* @return an X509Name
*/
public static X509Name getIssuerFields(X509Certificate cert) {
try {
return new X509Name((ASN1Sequence) getIssuer(cert.getTBSCertificate()));
} catch (Exception e) {
throw new ExceptionConverter(e);
}
}
/**
* Get the subject fields from an X509 Certificate
*
* @param cert an X509Certificate
* @return an X509Name
*/
public static X509Name getSubjectFields(X509Certificate cert) {
try {
return new X509Name((ASN1Sequence) getSubject(cert.getTBSCertificate()));
} catch (Exception e) {
throw new ExceptionConverter(e);
}
}
private static String getStandardJavaName(String algName) {
if ("SHA1".equals(algName)) {
return "SHA-1";
}
if ("SHA224".equals(algName)) {
return "SHA-224";
}
if ("SHA256".equals(algName)) {
return "SHA-256";
}
if ("SHA384".equals(algName)) {
return "SHA-384";
}
if ("SHA512".equals(algName)) {
return "SHA-512";
}
return algName;
}
/**
* Gets the timestamp token if there is one.
*
* @return the timestamp token or null
* @since 2.1.6
*/
public TimeStampToken getTimeStampToken() {
return timeStampToken;
}
/**
* Gets the timestamp date
*
* @return a date
* @since 2.1.6
*/
public Calendar getTimeStampDate() {
if (timeStampToken == null) {
return null;
}
Calendar cal = new GregorianCalendar();
Date date = timeStampToken.getTimeStampInfo().getGenTime();
cal.setTime(date);
return cal;
}
/**
* Gets the OCSP basic response if there is one.
*
* @return the OCSP basic response or null
* @since 2.1.6
*/
public BasicOCSPResp getOcsp() {
return basicResp;
}
private void findOcsp(ASN1Sequence seq) throws IOException {
basicResp = null;
while ((!(seq.getObjectAt(0) instanceof ASN1ObjectIdentifier))
|| !((ASN1ObjectIdentifier) seq.getObjectAt(0)).getId().equals(
OCSPObjectIdentifiers.id_pkix_ocsp_basic.getId())) {
boolean ret = true;
int k = 0;
while (k < seq.size()) {
if (seq.getObjectAt(k) instanceof ASN1Sequence) {
seq = (ASN1Sequence) seq.getObjectAt(0);
ret = false;
break;
}
if (seq.getObjectAt(k) instanceof ASN1TaggedObject) {
ASN1TaggedObject tag = (ASN1TaggedObject) seq.getObjectAt(k);
if (tag.getBaseObject() instanceof ASN1Sequence) {
seq = (ASN1Sequence) tag.getBaseObject();
ret = false;
break;
} else {
return;
}
}
++k;
}
if (ret) {
return;
}
}
DEROctetString os = (DEROctetString) seq.getObjectAt(1);
ASN1InputStream inp = new ASN1InputStream(os.getOctets());
BasicOCSPResponse resp = BasicOCSPResponse.getInstance(inp.readObject());
basicResp = new BasicOCSPResp(resp);
}
/**
* Update the digest with the specified bytes. This method is used both for signing and verifying
*
* @param buf the data buffer
* @param off the offset in the data buffer
* @param len the data length
* @throws SignatureException on error
*/
public void update(byte[] buf, int off, int len) throws SignatureException {
if (RSAdata != null || digestAttr != null) {
messageDigest.update(buf, off, len);
} else {
sig.update(buf, off, len);
}
}
/**
* Verify the digest.
*
* @return true if the signature checks out, false
* otherwise
* @throws SignatureException on error
*/
public boolean verify() throws SignatureException {
if (verified) {
return verifyResult;
}
if (sigAttr != null) {
sig.update(sigAttr);
if (RSAdata != null) {
byte[] msd = messageDigest.digest();
messageDigest.update(msd);
}
verifyResult = (Arrays.equals(messageDigest.digest(), digestAttr) && sig
.verify(digest));
} else {
if (RSAdata != null) {
sig.update(messageDigest.digest());
}
verifyResult = sig.verify(digest);
}
verified = true;
return verifyResult;
}
/**
* Checks if the timestamp refers to this document.
*
* @return true if it checks false otherwise
* @throws java.security.NoSuchAlgorithmException on error
* @since 2.1.6
*/
public boolean verifyTimestampImprint() throws NoSuchAlgorithmException {
if (timeStampToken == null) {
return false;
}
MessageImprint imprint = timeStampToken.getTimeStampInfo().toASN1Structure()
.getMessageImprint();
TimeStampTokenInfo info = timeStampToken.getTimeStampInfo();
String algOID = info.getMessageImprintAlgOID().getId();
byte[] md = MessageDigest.getInstance(getStandardJavaName(getDigest(algOID))).digest(digest);
byte[] imphashed = imprint.getHashedMessage();
return Arrays.equals(md, imphashed);
}
/**
* 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.
*
* @return the X.509 certificates associated with this PKCS#7 object
*/
public Certificate[] getCertificates() {
return certs.toArray(new Certificate[0]);
}
// OJO... Modificacion de
// Felix--------------------------------------------------
// Sin uso
// /**
// * Verifies an OCSP response against a KeyStore.
// * @param ocsp the OCSP response
// * @param keystore the KeyStore
// * @param provider the provider or null to use the BouncyCastle
// provider
// * @return true is a certificate was found
// * @since 2.1.6
// */
// public static boolean verifyOcspCertificates(BasicOCSPResp ocsp, KeyStore
// keystore, String provider) {
// if (provider == null)
// provider = "BC";
// try {
// for (Enumeration aliases = keystore.aliases(); aliases.hasMoreElements();)
// {
// try {
// String alias = (String)aliases.nextElement();
// if (!keystore.isCertificateEntry(alias))
// continue;
// X509Certificate certStoreX509 =
// (X509Certificate)keystore.getCertificate(alias);
// if (ocsp.verify(certStoreX509.getPublicKey(), provider))
// return true;
// }
// catch (Exception ex) {
// }
// }
// }
// catch (Exception e) {
// }
// return false;
// }
//
// /**
// * Verifies a timestamp against a KeyStore.
// * @param ts the timestamp
// * @param keystore the KeyStore
// * @param provider the provider or null to use the BouncyCastle
// provider
// * @return true is a certificate was found
// * @since 2.1.6
// */
// public static boolean verifyTimestampCertificates(TimeStampToken ts,
// KeyStore keystore, String provider) {
// if (provider == null)
// provider = "BC";
// try {
// for (Enumeration aliases = keystore.aliases(); aliases.hasMoreElements();)
// {
// try {
// String alias = (String)aliases.nextElement();
// if (!keystore.isCertificateEntry(alias))
// continue;
// X509Certificate certStoreX509 =
// (X509Certificate)keystore.getCertificate(alias);
// ts.validate(certStoreX509, provider);
// return true;
// }
// catch (Exception ex) {
// }
// }
// }
// catch (Exception e) {
// }
// return false;
// }
// ******************************************************************************
/**
* 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.
*
* @return the X.509 certificates associated with this PKCS#7 object
* @since 2.1.6
*/
public Certificate[] getSignCertificateChain() {
return signCerts.toArray(new X509Certificate[0]);
}
private void signCertificateChain() {
List cc = new ArrayList<>();
cc.add(signCert);
List oc = new ArrayList<>(certs);
for (int k = 0; k < oc.size(); ++k) {
if (signCert.getSerialNumber().equals(
((X509Certificate) oc.get(k)).getSerialNumber())) {
oc.remove(k);
--k;
}
}
boolean found = true;
while (found) {
X509Certificate v = (X509Certificate) cc.get(cc.size() - 1);
found = false;
for (int k = 0; k < oc.size(); ++k) {
try {
if (provider == null) {
v.verify(oc.get(k).getPublicKey());
} else {
v.verify(oc.get(k).getPublicKey(), provider);
}
found = true;
cc.add(oc.get(k));
oc.remove(k);
break;
} catch (Exception ignored) {
}
}
}
signCerts = cc;
}
/**
* Get the X.509 certificate revocation lists associated with this PKCS#7 object
*
* @return the X.509 certificate revocation lists associated with this PKCS#7 object
*/
public Collection getCRLs() {
return crls;
}
/**
* Get the X.509 certificate actually used to sign the digest.
*
* @return the X.509 certificate actually used to sign the digest
*/
public X509Certificate getSigningCertificate() {
return signCert;
}
/**
* Get the version of the PKCS#7 object. Always 1
*
* @return the version of the PKCS#7 object. Always 1
*/
public int getVersion() {
return version;
}
/**
* Get the version of the PKCS#7 "SignerInfo" object. Always 1
*
* @return the version of the PKCS#7 "SignerInfo" object. Always 1
*/
public int getSigningInfoVersion() {
return signerversion;
}
/**
* Get the algorithm used to calculate the message digest
*
* @return the algorithm used to calculate the message digest
*/
public String getDigestAlgorithm() {
String dea = getAlgorithm(digestEncryptionAlgorithm);
if (dea == null) {
dea = digestEncryptionAlgorithm;
}
return getHashAlgorithm() + "with" + dea;
}
/**
* Returns the algorithm.
*
* @return the digest algorithm
*/
public String getHashAlgorithm() {
return getDigest(digestAlgorithm);
}
/**
* Checks if OCSP revocation refers to the document signing certificate.
*
* @return true if it checks false otherwise
* @since 2.1.6
*/
public boolean isRevocationValid() {
if (basicResp == null) {
return false;
}
if (signCerts.size() < 2) {
return false;
}
try {
X509Certificate[] cs = (X509Certificate[]) getSignCertificateChain();
SingleResp sr = basicResp.getResponses()[0];
CertificateID cid = sr.getCertID();
X509Certificate sigcer = getSigningCertificate();
X509Certificate isscer = cs[1];
// OJO... Modificacion de
// Felix--------------------------------------------------
// CertificateID tis = new CertificateID(CertificateID.HASH_SHA1, isscer,
// sigcer.getSerialNumber());
DigestCalculatorProvider digCalcProv = new JcaDigestCalculatorProviderBuilder()
.setProvider(provider).build();
CertificateID id = new CertificateID(
digCalcProv.get(CertificateID.HASH_SHA1),
new JcaX509CertificateHolder(isscer), sigcer.getSerialNumber());
return id.equals(cid);
// ******************************************************************************
} catch (Exception ignored) {
}
return false;
}
/**
* Gets the bytes for the PKCS#1 object.
*
* @return a byte array
*/
public byte[] getEncodedPKCS1() {
try {
if (externalDigest != null) {
digest = externalDigest;
} else {
digest = sig.sign();
}
ByteArrayOutputStream bOut = new ByteArrayOutputStream();
ASN1OutputStream dout = ASN1OutputStream.create(bOut);
dout.writeObject(new DEROctetString(digest));
dout.close();
return bOut.toByteArray();
} catch (Exception e) {
throw new ExceptionConverter(e);
}
}
/**
* Sets the digest/signature to an external calculated value.
*
* @param digest the digest. This is the actual signature
* @param RSAdata the extra data that goes into the data tag in PKCS#7
* @param digestEncryptionAlgorithm the encryption algorithm. It may must be null if the
* digest is also null. If the
* digest is not null then it may be "RSA"
* or "DSA"
*/
public void setExternalDigest(byte[] digest, byte[] RSAdata,
String digestEncryptionAlgorithm) {
externalDigest = digest;
externalRSAdata = RSAdata;
if (digestEncryptionAlgorithm != null) {
if (digestEncryptionAlgorithm.equals("RSA")) {
this.digestEncryptionAlgorithm = ID_RSA;
} else if (digestEncryptionAlgorithm.equals("DSA")) {
this.digestEncryptionAlgorithm = ID_DSA;
} else if (digestEncryptionAlgorithm.equals("EC")) {
digestEncryptionAlgorithm = ID_ECDSA;
} else {
throw new IllegalArgumentException("PdfPKCS7 Error");
}
}
}
/**
* Gets the bytes for the PKCS7SignedData object.
*
* @return the bytes for the PKCS7SignedData object
*/
public byte[] getEncodedPKCS7() {
return getEncodedPKCS7(null, null, null, null);
}
/**
* Gets the bytes for the PKCS7SignedData object. Optionally the authenticatedAttributes in the signerInfo can also
* be set. If either of the parameters is null, none will be used.
*
* @param secondDigest the digest in the authenticatedAttributes
* @param signingTime the signing time in the authenticatedAttributes
* @return the bytes for the PKCS7SignedData object
*/
public byte[] getEncodedPKCS7(byte[] secondDigest, Calendar signingTime) {
return getEncodedPKCS7(secondDigest, signingTime, null, null);
}
/**
* 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.
*
* @param secondDigest the digest in the authenticatedAttributes
* @param signingTime the signing time in the authenticatedAttributes
* @param tsaClient TSAClient - null or an optional time stamp authority client
* @param ocsp a byte array
* @return byte[] the bytes for the PKCS7SignedData object
* @since 2.1.6
*/
public byte[] getEncodedPKCS7(byte[] secondDigest, Calendar signingTime,
TSAClient tsaClient, byte[] ocsp) {
try {
if (externalDigest != null) {
digest = externalDigest;
if (RSAdata != null) {
RSAdata = externalRSAdata;
}
} else if (externalRSAdata != null && RSAdata != null) {
RSAdata = externalRSAdata;
sig.update(RSAdata);
digest = sig.sign();
} else {
if (RSAdata != null) {
RSAdata = messageDigest.digest();
sig.update(RSAdata);
}
digest = sig.sign();
}
// Create the set of Hash algorithms
ASN1EncodableVector digestAlgorithms = new ASN1EncodableVector();
for (String digestalgo : digestalgos) {
ASN1EncodableVector algos = new ASN1EncodableVector();
algos.add(new ASN1ObjectIdentifier(digestalgo));
algos.add(DERNull.INSTANCE);
digestAlgorithms.add(new DERSequence(algos));
}
// Create the contentInfo.
ASN1EncodableVector v = new ASN1EncodableVector();
v.add(new ASN1ObjectIdentifier(ID_PKCS7_DATA));
if (RSAdata != null) {
v.add(new DERTaggedObject(0, new DEROctetString(RSAdata)));
}
DERSequence contentinfo = new DERSequence(v);
// Get all the certificates
//
v = new ASN1EncodableVector();
for (Object cert : certs) {
ASN1InputStream tempstream = new ASN1InputStream(
new ByteArrayInputStream(((X509Certificate) cert).getEncoded()));
v.add(tempstream.readObject());
}
DERSet dercertificates = new DERSet(v);
// Create signerinfo structure.
//
ASN1EncodableVector signerinfo = new ASN1EncodableVector();
// Add the signerInfo version
//
signerinfo.add(new ASN1Integer(signerversion));
v = new ASN1EncodableVector();
v.add(getIssuer(signCert.getTBSCertificate()));
v.add(new ASN1Integer(signCert.getSerialNumber()));
signerinfo.add(new DERSequence(v));
// Add the digestAlgorithm
v = new ASN1EncodableVector();
v.add(new ASN1ObjectIdentifier(digestAlgorithm));
v.add(DERNull.INSTANCE);
signerinfo.add(new DERSequence(v));
// add the authenticated attribute if present
if (secondDigest != null && signingTime != null) {
signerinfo.add(new DERTaggedObject(false, 0,
getAuthenticatedAttributeSet(secondDigest, signingTime, ocsp)));
}
// Add the digestEncryptionAlgorithm
v = new ASN1EncodableVector();
v.add(new ASN1ObjectIdentifier(digestEncryptionAlgorithm));
v.add(DERNull.INSTANCE);
signerinfo.add(new DERSequence(v));
// Add the digest
signerinfo.add(new DEROctetString(digest));
// When requested, go get and add the timestamp. May throw an exception.
if (tsaClient != null) {
byte[] tsImprint = tsaClient.getMessageDigest().digest(digest);
byte[] tsToken = tsaClient.getTimeStampToken(this, tsImprint);
if (tsToken != null) {
ASN1EncodableVector unauthAttributes = buildUnauthenticatedAttributes(tsToken);
if (unauthAttributes != null) {
signerinfo.add(new DERTaggedObject(false, 1, new DERSet(
unauthAttributes)));
}
}
}
// Finally build the body out of all the components above
ASN1EncodableVector body = new ASN1EncodableVector();
body.add(new ASN1Integer(version));
body.add(new DERSet(digestAlgorithms));
body.add(contentinfo);
body.add(new DERTaggedObject(false, 0, dercertificates));
// Only allow one signerInfo
body.add(new DERSet(new DERSequence(signerinfo)));
// Now we have the body, wrap it in it's PKCS7Signed shell
// and return it
//
ASN1EncodableVector whole = new ASN1EncodableVector();
whole.add(new ASN1ObjectIdentifier(ID_PKCS7_SIGNED_DATA));
whole.add(new DERTaggedObject(0, new DERSequence(body)));
ByteArrayOutputStream bOut = new ByteArrayOutputStream();
ASN1OutputStream dout = ASN1OutputStream.create(bOut);
dout.writeObject(new DERSequence(whole));
dout.close();
return bOut.toByteArray();
} catch (Exception e) {
throw new ExceptionConverter(e);
}
}
/**
* 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).
*
* @param timeStampToken byte[] - time stamp token, DER encoded signedData
* @return ASN1EncodableVector
* @throws IOException
*/
private ASN1EncodableVector buildUnauthenticatedAttributes(
byte[] timeStampToken) throws IOException {
if (timeStampToken == null) {
return null;
}
// @todo: move this together with the rest of the defintions
String ID_TIME_STAMP_TOKEN = "1.2.840.113549.1.9.16.2.14"; // RFC 3161
// id-aa-timeStampToken
ASN1InputStream tempstream = new ASN1InputStream(new ByteArrayInputStream(
timeStampToken));
ASN1EncodableVector unauthAttributes = new ASN1EncodableVector();
ASN1EncodableVector v = new ASN1EncodableVector();
v.add(new ASN1ObjectIdentifier(ID_TIME_STAMP_TOKEN)); // id-aa-timeStampToken
ASN1Sequence seq = (ASN1Sequence) tempstream.readObject();
v.add(new DERSet(seq));
unauthAttributes.add(new DERSequence(v));
return unauthAttributes;
}
/**
* 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 in {@link #getEncodedPKCS7(byte[], Calendar)}. 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);
*
*
* @param secondDigest the content digest
* @param signingTime the signing time
* @param ocsp a byte array
* @return the byte array representation of the authenticatedAttributes ready to be signed
*/
public byte[] getAuthenticatedAttributeBytes(byte[] secondDigest,
Calendar signingTime, byte[] ocsp) {
try {
return getAuthenticatedAttributeSet(secondDigest, signingTime, ocsp)
.getEncoded(ASN1Encoding.DER);
} catch (Exception e) {
throw new ExceptionConverter(e);
}
}
private DERSet getAuthenticatedAttributeSet(byte[] secondDigest,
Calendar signingTime, byte[] ocsp) {
try {
ASN1EncodableVector attribute = new ASN1EncodableVector();
ASN1EncodableVector v = new ASN1EncodableVector();
v.add(new ASN1ObjectIdentifier(ID_CONTENT_TYPE));
v.add(new DERSet(new ASN1ObjectIdentifier(ID_PKCS7_DATA)));
attribute.add(new DERSequence(v));
v = new ASN1EncodableVector();
v.add(new ASN1ObjectIdentifier(ID_SIGNING_TIME));
v.add(new DERSet(new DERUTCTime(signingTime.getTime())));
attribute.add(new DERSequence(v));
v = new ASN1EncodableVector();
v.add(new ASN1ObjectIdentifier(ID_MESSAGE_DIGEST));
v.add(new DERSet(new DEROctetString(secondDigest)));
attribute.add(new DERSequence(v));
if (ocsp != null) {
v = new ASN1EncodableVector();
v.add(new ASN1ObjectIdentifier(ID_ADBE_REVOCATION));
DEROctetString doctet = new DEROctetString(ocsp);
ASN1EncodableVector vo1 = new ASN1EncodableVector();
ASN1EncodableVector v2 = new ASN1EncodableVector();
v2.add(OCSPObjectIdentifiers.id_pkix_ocsp_basic);
v2.add(doctet);
ASN1Enumerated den = new ASN1Enumerated(0);
ASN1EncodableVector v3 = new ASN1EncodableVector();
v3.add(den);
v3.add(new DERTaggedObject(true, 0, new DERSequence(v2)));
vo1.add(new DERSequence(v3));
v.add(new DERSet(new DERSequence(new DERTaggedObject(true, 1,
new DERSequence(vo1)))));
attribute.add(new DERSequence(v));
} else if (!crls.isEmpty()) {
v = new ASN1EncodableVector();
v.add(new ASN1ObjectIdentifier(ID_ADBE_REVOCATION));
ASN1EncodableVector v2 = new ASN1EncodableVector();
for (Object crl : crls) {
ASN1InputStream t = new ASN1InputStream(new ByteArrayInputStream(
((X509CRL) crl).getEncoded()));
v2.add(t.readObject());
}
v.add(new DERSet(new DERSequence(new DERTaggedObject(true, 0,
new DERSequence(v2)))));
attribute.add(new DERSequence(v));
}
return new DERSet(attribute);
} catch (Exception e) {
throw new ExceptionConverter(e);
}
}
/**
* Getter for property reason.
*
* @return Value of property reason.
*/
public String getReason() {
return this.reason;
}
/**
* Setter for property reason.
*
* @param reason New value of property reason.
*/
public void setReason(String reason) {
this.reason = reason;
}
/**
* Getter for property location.
*
* @return Value of property location.
*/
public String getLocation() {
return this.location;
}
/**
* Setter for property location.
*
* @param location New value of property location.
*/
public void setLocation(String location) {
this.location = location;
}
/**
* Getter for property signDate.
*
* @return Value of property signDate.
*/
public Calendar getSignDate() {
return this.signDate;
}
/**
* Setter for property signDate.
*
* @param signDate New value of property signDate.
*/
public void setSignDate(Calendar signDate) {
this.signDate = signDate;
}
/**
* Getter for property sigName.
*
* @return Value of property sigName.
*/
public String getSignName() {
return this.signName;
}
/**
* Setter for property sigName.
*
* @param signName New value of property sigName.
*/
public void setSignName(String signName) {
this.signName = signName;
}
/**
* a class that holds an X509 name
*/
public static class X509Name {
/**
* country code - StringType(SIZE(2))
*/
public static final ASN1ObjectIdentifier C = new ASN1ObjectIdentifier(
"2.5.4.6");
/**
* organization - StringType(SIZE(1..64))
*/
public static final ASN1ObjectIdentifier O = new ASN1ObjectIdentifier(
"2.5.4.10");
/**
* organizational unit name - StringType(SIZE(1..64))
*/
public static final ASN1ObjectIdentifier OU = new ASN1ObjectIdentifier(
"2.5.4.11");
/**
* Title
*/
public static final ASN1ObjectIdentifier T = new ASN1ObjectIdentifier(
"2.5.4.12");
/**
* common name - StringType(SIZE(1..64))
*/
public static final ASN1ObjectIdentifier CN = new ASN1ObjectIdentifier(
"2.5.4.3");
/**
* device serial number name - StringType(SIZE(1..64))
*/
public static final ASN1ObjectIdentifier SN = new ASN1ObjectIdentifier(
"2.5.4.5");
/**
* locality name - StringType(SIZE(1..64))
*/
public static final ASN1ObjectIdentifier L = new ASN1ObjectIdentifier(
"2.5.4.7");
/**
* state, or province name - StringType(SIZE(1..64))
*/
public static final ASN1ObjectIdentifier ST = new ASN1ObjectIdentifier(
"2.5.4.8");
/**
* Naming attribute of type X520name
*/
public static final ASN1ObjectIdentifier SURNAME = new ASN1ObjectIdentifier(
"2.5.4.4");
/**
* Naming attribute of type X520name
*/
public static final ASN1ObjectIdentifier GIVENNAME = new ASN1ObjectIdentifier(
"2.5.4.42");
/**
* Naming attribute of type X520name
*/
public static final ASN1ObjectIdentifier INITIALS = new ASN1ObjectIdentifier(
"2.5.4.43");
/**
* Naming attribute of type X520name
*/
public static final ASN1ObjectIdentifier GENERATION = new ASN1ObjectIdentifier(
"2.5.4.44");
/**
* Naming attribute of type X520name
*/
public static final ASN1ObjectIdentifier UNIQUE_IDENTIFIER = new ASN1ObjectIdentifier(
"2.5.4.45");
/**
* Email address (RSA PKCS#9 extension) - IA5String.
*
* Note: if you're trying to be ultra orthodox, don't use this! It shouldn't be in here.
*/
public static final ASN1ObjectIdentifier EmailAddress = new ASN1ObjectIdentifier(
"1.2.840.113549.1.9.1");
/**
* email address in Verisign certificates
*/
public static final ASN1ObjectIdentifier E = EmailAddress;
/**
* object identifier
*/
public static final ASN1ObjectIdentifier DC = new ASN1ObjectIdentifier(
"0.9.2342.19200300.100.1.25");
/**
* LDAP User id.
*/
public static final ASN1ObjectIdentifier UID = new ASN1ObjectIdentifier(
"0.9.2342.19200300.100.1.1");
/**
* A HashMap with default symbols
*/
public static Map defaultSymbols = new HashMap<>();
static {
defaultSymbols.put(C, "C");
defaultSymbols.put(O, "O");
defaultSymbols.put(T, "T");
defaultSymbols.put(OU, "OU");
defaultSymbols.put(CN, "CN");
defaultSymbols.put(L, "L");
defaultSymbols.put(ST, "ST");
defaultSymbols.put(SN, "SN");
defaultSymbols.put(EmailAddress, "E");
defaultSymbols.put(DC, "DC");
defaultSymbols.put(UID, "UID");
defaultSymbols.put(SURNAME, "SURNAME");
defaultSymbols.put(GIVENNAME, "GIVENNAME");
defaultSymbols.put(INITIALS, "INITIALS");
defaultSymbols.put(GENERATION, "GENERATION");
}
/**
* A HashMap with values
*/
public Map> valuesMap = new HashMap<>();
/**
* Constructs an X509 name
*
* @param seq an ASN1 Sequence
*/
public X509Name(ASN1Sequence seq) {
Enumeration e = seq.getObjects();
while (e.hasMoreElements()) {
ASN1Set set = (ASN1Set) e.nextElement();
for (int i = 0; i < set.size(); i++) {
ASN1Sequence s = (ASN1Sequence) set.getObjectAt(i);
ASN1Encodable encodable = s.getObjectAt(0);
String id = defaultSymbols.get(encodable);
if (id == null) {
continue;
}
List vs = valuesMap.computeIfAbsent(id, k -> new ArrayList<>());
vs.add(((ASN1String) s.getObjectAt(1)).getString());
}
}
}
/**
* Constructs an X509 name
*
* @param dirName a directory name
*/
public X509Name(String dirName) {
X509NameTokenizer nTok = new X509NameTokenizer(dirName);
while (nTok.hasMoreTokens()) {
String token = nTok.nextToken();
int index = token.indexOf('=');
if (index == -1) {
throw new IllegalArgumentException("Unxpected Error");
}
String id = token.substring(0, index).toUpperCase();
String value = token.substring(index + 1);
List vs = valuesMap.computeIfAbsent(id, k -> new ArrayList<>());
vs.add(value);
}
}
public String getField(String name) {
List vs = valuesMap.get(name);
return vs == null ? null : vs.get(0);
}
/**
* gets a field array from the values Hashmap
*
* @param name the name of the field array to get
* @return an ArrayList
*/
public List getFieldsByName(String name) {
return valuesMap.get(name);
}
/**
* getter for values
*
* @return a HashMap with the fields of the X509 name
*/
public Map> getAllFields() {
return valuesMap;
}
/**
* @return values string representation
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return valuesMap.toString();
}
}
/**
* class for breaking up an X500 Name into it's component tokens, ala java.util.StringTokenizer. We need this class
* as some of the lightweight Java environment don't support classes like StringTokenizer.
*/
public static class X509NameTokenizer {
private final String oid;
private final StringBuffer buf = new StringBuffer();
private int index;
public X509NameTokenizer(String oid) {
this.oid = oid;
this.index = -1;
}
public boolean hasMoreTokens() {
return (index != oid.length());
}
public String nextToken() {
if (index == oid.length()) {
return null;
}
int end = index + 1;
boolean quoted = false;
boolean escaped = false;
buf.setLength(0);
while (end != oid.length()) {
char c = oid.charAt(end);
if (c == '"') {
if (!escaped) {
quoted = !quoted;
} else {
buf.append(c);
}
escaped = false;
} else {
if (escaped || quoted) {
buf.append(c);
escaped = false;
} else if (c == '\\') {
escaped = true;
} else if (c == ',') {
break;
} else {
buf.append(c);
}
}
end++;
}
index = end;
return buf.toString().trim();
}
}
}