org.cryptacular.x509

Class ExtensionReader

java.lang.Object

org.cryptacular.x509.ExtensionReader

public final class ExtensionReader
extends java.lang.Object

Reads X.509v3 extended properties from an X509Certificate object. The available properties are described in section 4.2 of RFC 2459, http://www.faqs.org/rfcs/rfc2459.html.

Field Summary

Fields

Modifier and Type	Field and Description
private java.security.cert.X509Certificate	certificate The X509Certificate whose extension fields will be read.

Constructor Summary

Constructors

Constructor and Description
ExtensionReader(java.security.cert.X509Certificate cert) Creates a new instance that can read extension fields from the given X.509 certificate.

Method Summary

Modifier and Type	Method and Description
org.bouncycastle.asn1.ASN1Encodable	read(ExtensionType extension) Reads the value of the given certificate extension field.
org.bouncycastle.asn1.ASN1Encodable	read(java.lang.String extensionOidOrName) Reads the value of the extension given by OID or name as defined in section 4.2 of RFC 2459.
java.util.List<org.bouncycastle.asn1.x509.AccessDescription>	readAuthorityInformationAccess() Reads the value of the AuthorityInformationAccess extension field of the certificate.
org.bouncycastle.asn1.x509.AuthorityKeyIdentifier	readAuthorityKeyIdentifier() Reads the value of the AuthorityKeyIdentifier extension field of the certificate.
org.bouncycastle.asn1.x509.BasicConstraints	readBasicConstraints() Reads the value of the BasicConstraints extension field of the certificate.
java.util.List<org.bouncycastle.asn1.x509.PolicyInformation>	readCertificatePolicies() Reads the value of the CertificatePolicies extension field of the certificate.
java.util.List<org.bouncycastle.asn1.x509.DistributionPoint>	readCRLDistributionPoints() Reads the value of the CRLDistributionPoints extension field of the certificate.
java.util.List<org.bouncycastle.asn1.x509.KeyPurposeId>	readExtendedKeyUsage() Reads the value of the ExtendedKeyUsage extension field of the certificate.
org.bouncycastle.asn1.x509.GeneralNames	readIssuerAlternativeName() Reads the value of the IssuerAlternativeName extension field of the certificate.
org.bouncycastle.asn1.x509.KeyUsage	readKeyUsage() Reads the value of the KeyUsage extension field of the certificate.
org.bouncycastle.asn1.x509.GeneralNames	readSubjectAlternativeName() Reads the value of the SubjectAlternativeName extension field of the certificate.
org.bouncycastle.asn1.x509.SubjectKeyIdentifier	readSubjectKeyIdentifier() Reads the value of the SubjectKeyIdentifier extension field of the certificate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

certificate

private final java.security.cert.X509Certificate certificate

The X509Certificate whose extension fields will be read.

Constructor Detail

ExtensionReader

public ExtensionReader(java.security.cert.X509Certificate cert)

Creates a new instance that can read extension fields from the given X.509 certificate.

Parameters:

cert - Certificate to read.

Method Detail

read

public org.bouncycastle.asn1.ASN1Encodable read(java.lang.String extensionOidOrName)
                                         throws EncodingException

Reads the value of the extension given by OID or name as defined in section 4.2 of RFC 2459.

Parameters:

extensionOidOrName - OID or extension name, e.g. 2.5.29.14 orSubjectK eyIdentifier. In the case of extension name, the name is case-sensitive and follows the conventions in RFC 2459.

Returns:

Extension type containing data from requested extension field.

Throws:

EncodingException - On certificate field parse errors.

read

public org.bouncycastle.asn1.ASN1Encodable read(ExtensionType extension)

Reads the value of the given certificate extension field.

Parameters:

extension - Extension to read from certificate.

Returns:

Extension type containing data from requested extension field.

Throws:

EncodingException - On certificate field parse errors.

readSubjectAlternativeName

public org.bouncycastle.asn1.x509.GeneralNames readSubjectAlternativeName()
                                                                   throws EncodingException

Reads the value of the SubjectAlternativeName extension field of the certificate.

Returns:

Collection of subject alternative names or null if the certificate does not define this extension field. Note that an empty collection of names is different from a null return value; in the former case the field is defined but empty, whereas in the latter the field is not defined on the certificate.

Throws:

EncodingException - On certificate field parse errors.

readIssuerAlternativeName

public org.bouncycastle.asn1.x509.GeneralNames readIssuerAlternativeName()
                                                                  throws EncodingException

Reads the value of the IssuerAlternativeName extension field of the certificate.

Returns:

Collection of issuer alternative names or null if the certificate does not define this extension field. Note that an empty collection of names is different from a null return value; in the former case the field is defined but empty, whereas in the latter the field is not defined on the certificate.

Throws:

EncodingException - On certificate field parse errors.

readBasicConstraints

public org.bouncycastle.asn1.x509.BasicConstraints readBasicConstraints()
                                                                 throws EncodingException

Reads the value of the BasicConstraints extension field of the certificate.

Returns:

Basic constraints defined on certificate or null if the certificate does not define the field.

Throws:

EncodingException - On certificate field parse errors.

readCertificatePolicies

public java.util.List<org.bouncycastle.asn1.x509.PolicyInformation> readCertificatePolicies()
                                                                                     throws EncodingException

Reads the value of the CertificatePolicies extension field of the certificate.

Returns:

List of certificate policies defined on certificate or null if the certificate does not define the field.

Throws:

EncodingException - On certificate field parse errors.

readSubjectKeyIdentifier

public org.bouncycastle.asn1.x509.SubjectKeyIdentifier readSubjectKeyIdentifier()
                                                                         throws EncodingException

Reads the value of the SubjectKeyIdentifier extension field of the certificate.

Returns:

Subject key identifier.

Throws:

EncodingException - On certificate field parse errors.

readAuthorityKeyIdentifier

public org.bouncycastle.asn1.x509.AuthorityKeyIdentifier readAuthorityKeyIdentifier()
                                                                             throws EncodingException

Reads the value of the AuthorityKeyIdentifier extension field of the certificate.

Returns:

Authority key identifier.

Throws:

EncodingException - On certificate field parse errors.

readKeyUsage

public org.bouncycastle.asn1.x509.KeyUsage readKeyUsage()
                                                 throws EncodingException

Reads the value of the KeyUsage extension field of the certificate.

Returns:

Key usage data or null if extension field is not defined.

Throws:

EncodingException - On certificate field parse errors.

readExtendedKeyUsage

public java.util.List<org.bouncycastle.asn1.x509.KeyPurposeId> readExtendedKeyUsage()
                                                                             throws EncodingException

Reads the value of the ExtendedKeyUsage extension field of the certificate.

Returns:

List of supported extended key usages or null if extension is not defined.

Throws:

EncodingException - On certificate field parse errors.

readCRLDistributionPoints

public java.util.List<org.bouncycastle.asn1.x509.DistributionPoint> readCRLDistributionPoints()
                                                                                       throws EncodingException

Reads the value of the CRLDistributionPoints extension field of the certificate.

Returns:

List of CRL distribution points or null if extension is not defined.

Throws:

EncodingException - On certificate field parse errors.

readAuthorityInformationAccess

public java.util.List<org.bouncycastle.asn1.x509.AccessDescription> readAuthorityInformationAccess()
                                                                                            throws EncodingException

Reads the value of the AuthorityInformationAccess extension field of the certificate.

Returns:

List of access descriptions or null if extension is not defined.

Throws:

EncodingException - On certificate field parse errors.