package org.bouncycastle.cert;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.OutputStream;
import java.io.Serializable;
import java.math.BigInteger;
import java.util.Date;
import java.util.List;
import java.util.Set;

import org.bouncycastle.asn1.ASN1ObjectIdentifier;
import org.bouncycastle.asn1.DEROutputStream;
import org.bouncycastle.asn1.x500.X500Name;
import org.bouncycastle.asn1.x509.AlgorithmIdentifier;
import org.bouncycastle.asn1.x509.Certificate;
import org.bouncycastle.asn1.x509.Extension;
import org.bouncycastle.asn1.x509.Extensions;
import org.bouncycastle.asn1.x509.SubjectPublicKeyInfo;
import org.bouncycastle.asn1.x509.TBSCertificate;
import org.bouncycastle.operator.ContentVerifier;
import org.bouncycastle.operator.ContentVerifierProvider;
import org.bouncycastle.util.Encodable;

Holding class for an X.509 Certificate structure.
/** * Holding class for an X.509 Certificate structure. */
public class X509CertificateHolder implements Encodable, Serializable { private static final long serialVersionUID = 20170722001L; private transient Certificate x509Certificate; private transient Extensions extensions; private static Certificate parseBytes(byte[] certEncoding) throws IOException { try { return Certificate.getInstance(CertUtils.parseNonEmptyASN1(certEncoding)); } catch (ClassCastException e) { throw new CertIOException("malformed data: " + e.getMessage(), e); } catch (IllegalArgumentException e) { throw new CertIOException("malformed data: " + e.getMessage(), e); } }
Create a X509CertificateHolder from the passed in bytes.
Params:
  • certEncoding – BER/DER encoding of the certificate.
Throws:
  • IOException – in the event of corrupted data, or an incorrect structure.
/** * Create a X509CertificateHolder from the passed in bytes. * * @param certEncoding BER/DER encoding of the certificate. * @throws IOException in the event of corrupted data, or an incorrect structure. */
public X509CertificateHolder(byte[] certEncoding) throws IOException { this(parseBytes(certEncoding)); }
Create a X509CertificateHolder from the passed in ASN.1 structure.
Params:
  • x509Certificate – an ASN.1 Certificate structure.
/** * Create a X509CertificateHolder from the passed in ASN.1 structure. * * @param x509Certificate an ASN.1 Certificate structure. */
public X509CertificateHolder(Certificate x509Certificate) { init(x509Certificate); } private void init(Certificate x509Certificate) { this.x509Certificate = x509Certificate; this.extensions = x509Certificate.getTBSCertificate().getExtensions(); } public int getVersionNumber() { return x509Certificate.getVersionNumber(); }
Deprecated:use getVersionNumber
/** * @deprecated use getVersionNumber */
public int getVersion() { return x509Certificate.getVersionNumber(); }
Return whether or not the holder's certificate contains extensions.
Returns:true if extension are present, false otherwise.
/** * Return whether or not the holder's certificate contains extensions. * * @return true if extension are present, false otherwise. */
public boolean hasExtensions() { return extensions != null; }
Look up the extension associated with the passed in OID.
Params:
  • oid – the OID of the extension of interest.
Returns:the extension if present, null otherwise.
/** * Look up the extension associated with the passed in OID. * * @param oid the OID of the extension of interest. * * @return the extension if present, null otherwise. */
public Extension getExtension(ASN1ObjectIdentifier oid) { if (extensions != null) { return extensions.getExtension(oid); } return null; }
Return the extensions block associated with this certificate if there is one.
Returns:the extensions block, null otherwise.
/** * Return the extensions block associated with this certificate if there is one. * * @return the extensions block, null otherwise. */
public Extensions getExtensions() { return extensions; }
Returns a list of ASN1ObjectIdentifier objects representing the OIDs of the extensions contained in this holder's certificate.
Returns:a list of extension OIDs.
/** * Returns a list of ASN1ObjectIdentifier objects representing the OIDs of the * extensions contained in this holder's certificate. * * @return a list of extension OIDs. */
public List getExtensionOIDs() { return CertUtils.getExtensionOIDs(extensions); }
Returns a set of ASN1ObjectIdentifier objects representing the OIDs of the critical extensions contained in this holder's certificate.
Returns:a set of critical extension OIDs.
/** * Returns a set of ASN1ObjectIdentifier objects representing the OIDs of the * critical extensions contained in this holder's certificate. * * @return a set of critical extension OIDs. */
public Set getCriticalExtensionOIDs() { return CertUtils.getCriticalExtensionOIDs(extensions); }
Returns a set of ASN1ObjectIdentifier objects representing the OIDs of the non-critical extensions contained in this holder's certificate.
Returns:a set of non-critical extension OIDs.
/** * Returns a set of ASN1ObjectIdentifier objects representing the OIDs of the * non-critical extensions contained in this holder's certificate. * * @return a set of non-critical extension OIDs. */
public Set getNonCriticalExtensionOIDs() { return CertUtils.getNonCriticalExtensionOIDs(extensions); }
Return the serial number of this attribute certificate.
Returns:the serial number.
/** * Return the serial number of this attribute certificate. * * @return the serial number. */
public BigInteger getSerialNumber() { return x509Certificate.getSerialNumber().getValue(); }
Return the issuer of this certificate.
Returns:the certificate issuer.
/** * Return the issuer of this certificate. * * @return the certificate issuer. */
public X500Name getIssuer() { return X500Name.getInstance(x509Certificate.getIssuer()); }
Return the subject this certificate is for.
Returns:the subject for the certificate.
/** * Return the subject this certificate is for. * * @return the subject for the certificate. */
public X500Name getSubject() { return X500Name.getInstance(x509Certificate.getSubject()); }
Return the date before which this certificate is not valid.
Returns:the start time for the certificate's validity period.
/** * Return the date before which this certificate is not valid. * * @return the start time for the certificate's validity period. */
public Date getNotBefore() { return x509Certificate.getStartDate().getDate(); }
Return the date after which this certificate is not valid.
Returns:the final time for the certificate's validity period.
/** * Return the date after which this certificate is not valid. * * @return the final time for the certificate's validity period. */
public Date getNotAfter() { return x509Certificate.getEndDate().getDate(); }
Return the SubjectPublicKeyInfo describing the public key this certificate is carrying.
Returns:the public key ASN.1 structure contained in the certificate.
/** * Return the SubjectPublicKeyInfo describing the public key this certificate is carrying. * * @return the public key ASN.1 structure contained in the certificate. */
public SubjectPublicKeyInfo getSubjectPublicKeyInfo() { return x509Certificate.getSubjectPublicKeyInfo(); }
Return the underlying ASN.1 structure for the certificate in this holder.
Returns:a Certificate object.
/** * Return the underlying ASN.1 structure for the certificate in this holder. * * @return a Certificate object. */
public Certificate toASN1Structure() { return x509Certificate; }
Return the details of the signature algorithm used to create this attribute certificate.
Returns:the AlgorithmIdentifier describing the signature algorithm used to create this attribute certificate.
/** * Return the details of the signature algorithm used to create this attribute certificate. * * @return the AlgorithmIdentifier describing the signature algorithm used to create this attribute certificate. */
public AlgorithmIdentifier getSignatureAlgorithm() { return x509Certificate.getSignatureAlgorithm(); }
Return the bytes making up the signature associated with this attribute certificate.
Returns:the attribute certificate signature bytes.
/** * Return the bytes making up the signature associated with this attribute certificate. * * @return the attribute certificate signature bytes. */
public byte[] getSignature() { return x509Certificate.getSignature().getOctets(); }
Return whether or not this certificate is valid on a particular date.
Params:
  • date – the date of interest.
Returns:true if the certificate is valid, false otherwise.
/** * Return whether or not this certificate is valid on a particular date. * * @param date the date of interest. * @return true if the certificate is valid, false otherwise. */
public boolean isValidOn(Date date) { return !date.before(x509Certificate.getStartDate().getDate()) && !date.after(x509Certificate.getEndDate().getDate()); }
Validate the signature on the certificate in this holder.
Params:
  • verifierProvider – a ContentVerifierProvider that can generate a verifier for the signature.
Throws:
  • CertException – if the signature cannot be processed or is inappropriate.
Returns:true if the signature is valid, false otherwise.
/** * Validate the signature on the certificate in this holder. * * @param verifierProvider a ContentVerifierProvider that can generate a verifier for the signature. * @return true if the signature is valid, false otherwise. * @throws CertException if the signature cannot be processed or is inappropriate. */
public boolean isSignatureValid(ContentVerifierProvider verifierProvider) throws CertException { TBSCertificate tbsCert = x509Certificate.getTBSCertificate(); if (!CertUtils.isAlgIdEqual(tbsCert.getSignature(), x509Certificate.getSignatureAlgorithm())) { throw new CertException("signature invalid - algorithm identifier mismatch"); } ContentVerifier verifier; try { verifier = verifierProvider.get((tbsCert.getSignature())); OutputStream sOut = verifier.getOutputStream(); DEROutputStream dOut = new DEROutputStream(sOut); dOut.writeObject(tbsCert); sOut.close(); } catch (Exception e) { throw new CertException("unable to process signature: " + e.getMessage(), e); } return verifier.verify(this.getSignature()); } public boolean equals( Object o) { if (o == this) { return true; } if (!(o instanceof X509CertificateHolder)) { return false; } X509CertificateHolder other = (X509CertificateHolder)o; return this.x509Certificate.equals(other.x509Certificate); } public int hashCode() { return this.x509Certificate.hashCode(); }
Return the ASN.1 encoding of this holder's certificate.
Throws:
Returns:a DER encoded byte array.
/** * Return the ASN.1 encoding of this holder's certificate. * * @return a DER encoded byte array. * @throws IOException if an encoding cannot be generated. */
public byte[] getEncoded() throws IOException { return x509Certificate.getEncoded(); } private void readObject( ObjectInputStream in) throws IOException, ClassNotFoundException { in.defaultReadObject(); init(Certificate.getInstance(in.readObject())); } private void writeObject( ObjectOutputStream out) throws IOException { out.defaultWriteObject(); out.writeObject(this.getEncoded()); } }