# X509Certificate

public abstract class **X509Certificate** extends [Certificate](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/Certificate.html)  
Abstract class for X.509 v1 certificates. This provides a standard
way to access all the version 1 attributes of an X.509 certificate.
Attributes that are specific to X.509 v2 or v3 are not available
through this interface. Future API evolution will provide full access to
complete X.509 v3 attributes.


The basic X.509 format was defined by
ISO/IEC and ANSI X9 and is described below in ASN.1:

```
 Certificate  ::=  SEQUENCE  {
     tbsCertificate       TBSCertificate,
     signatureAlgorithm   AlgorithmIdentifier,
     signature            BIT STRING  }
 
```


These certificates are widely used to support authentication and
other functionality in Internet security systems. Common applications
include Privacy Enhanced Mail (PEM), Transport Layer Security (SSL),
code signing for trusted software distribution, and Secure Electronic
Transactions (SET).


These certificates are managed and vouched for by *Certificate
Authorities* (CAs). CAs are services which create certificates by
placing data in the X.509 standard format and then digitally signing
that data. CAs act as trusted third parties, making introductions
between principals who have no direct knowledge of each other.
CA certificates are either signed by themselves, or by some other
CA such as a "root" CA.


The ASN.1 definition of `tbsCertificate` is:

```
 TBSCertificate  ::=  SEQUENCE  {
     version         [0]  EXPLICIT Version DEFAULT v1,
     serialNumber         CertificateSerialNumber,
     signature            AlgorithmIdentifier,
     issuer               Name,
     validity             Validity,
     subject              Name,
     subjectPublicKeyInfo SubjectPublicKeyInfo,
     }
 
```


Here is sample code to instantiate an X.509 certificate:

```
 InputStream inStream = new FileInputStream("fileName-of-cert");
 X509Certificate cert = X509Certificate.getInstance(inStream);
 inStream.close();
 
```
OR

```
 byte[] certData = <certificate read from a file, say>
 X509Certificate cert = X509Certificate.getInstance(certData);
 
```


In either case, the code that instantiates an X.509 certificate
consults the value of the `cert.provider.x509v1` security property
to locate the actual implementation or instantiates a default implementation.


The `cert.provider.x509v1` property is set to a default
implementation for X.509 such as:

```
 cert.provider.x509v1=com.sun.security.cert.internal.x509.X509V1CertImpl
 
```


The value of this `cert.provider.x509v1` property has to be
changed to instantiate another implementation. If this security
property is not set, a default implementation will be used.
Currently, due to possible security restrictions on access to
Security properties, this value is looked up and cached at class
initialization time and will fallback on a default implementation if
the Security property is not accessible.

*Note: The classes in the package `javax.security.cert`
exist for compatibility with earlier versions of the
Java Secure Sockets Extension (JSSE). New applications should instead
use the standard Java SE certificate classes located in
`java.security.cert`.*

<br />

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/Certificate.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/X509Extension.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html`

### Public Constructor Summary

|---|---|
|   | [X509Certificate](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#X509Certificate())() Creates a new `X509Certificate`. |

### Public Method Summary

|---|---|
| abstract void | [checkValidity](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#checkValidity())() Checks whether the certificate is currently valid. |
| abstract void | [checkValidity](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#checkValidity(java.util.Date))([Date](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Date.html) date) Checks that the specified date is within the certificate's validity period. |
| final static [X509Certificate](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html) | [getInstance](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getInstance(byte[]))(byte\[\] certData) Creates a new `X509Certificate` and initializes it from the specified byte array. |
| final static [X509Certificate](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html) | [getInstance](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getInstance(java.io.InputStream))([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) inStream) Instantiates an X509Certificate object, and initializes it with the data read from the input stream `inStream`. |
| abstract [Principal](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Principal.html) | [getIssuerDN](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getIssuerDN())() Gets the `issuer` (issuer distinguished name) value from the certificate. |
| abstract [Date](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Date.html) | [getNotAfter](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getNotAfter())() Gets the `notAfter` date from the validity period of the certificate. |
| abstract [Date](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Date.html) | [getNotBefore](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getNotBefore())() Gets the `notBefore` date from the validity period of the certificate. |
| abstract BigInteger | [getSerialNumber](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getSerialNumber())() Gets the `serialNumber` value from the certificate. |
| abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getSigAlgName](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getSigAlgName())() Gets the signature algorithm name for the certificate signature algorithm. |
| abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getSigAlgOID](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getSigAlgOID())() Gets the signature algorithm OID string from the certificate. |
| abstract byte\[\] | [getSigAlgParams](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getSigAlgParams())() Gets the DER-encoded signature algorithm parameters from this certificate's signature algorithm. |
| abstract [Principal](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Principal.html) | [getSubjectDN](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getSubjectDN())() Gets the `subject` (subject distinguished name) value from the certificate. |
| abstract int | [getVersion](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getVersion())() Gets the `version` (version number) value from the certificate. |

### Inherited Method Summary

From class [javax.security.cert.Certificate](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/Certificate.html)

|---|---|
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/Certificate.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) other) Compares this certificate for equality with the specified object. |
| abstract byte\[\] | [getEncoded](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/Certificate.html#getEncoded())() Returns the encoded form of this certificate. |
| abstract [PublicKey](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/PublicKey.html) | [getPublicKey](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/Certificate.html#getPublicKey())() Gets the public key from this certificate. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/Certificate.html#hashCode())() Returns a hashcode value for this certificate from its encoded form. |
| abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/Certificate.html#toString())() Returns a string representation of this certificate. |
| abstract void | [verify](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/Certificate.html#verify(java.security.PublicKey,%20java.lang.String))([PublicKey](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/PublicKey.html) key, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) sigProvider) Verifies that this certificate was signed using the private key that corresponds to the specified public key. |
| abstract void | [verify](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/Certificate.html#verify(java.security.PublicKey))([PublicKey](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/PublicKey.html) key) Verifies that this certificate was signed using the private key that corresponds to the specified public key. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Public Constructors

#### public
**X509Certificate**
()

Creates a new `X509Certificate`.

## Public Methods

#### public abstract void
**checkValidity**
()

Checks whether the certificate is currently valid.


The validity period consists of two date/time values:
the first and last dates (and times) on which the certificate
is valid. It is defined in
ASN.1 as:

```
 validity             Validity

 Validity ::= SEQUENCE {
     notBefore      CertificateValidityDate,
     notAfter       CertificateValidityDate }

 CertificateValidityDate ::= CHOICE {
     utcTime        UTCTime,
     generalTime    GeneralizedTime }
 
```

<br />

##### Throws

| [CertificateExpiredException](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/CertificateExpiredException.html) | if the certificate has expired. |
| [CertificateNotYetValidException](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/CertificateNotYetValidException.html) | if the certificate is not yet valid. |
|---|---|

#### public abstract void
**checkValidity**
([Date](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Date.html) date)

Checks that the specified date is within the certificate's
validity period. In other words, this determines whether the
certificate would be valid at the specified date/time.

##### Parameters

| date | the Date to check against to see if this certificate is valid at that date/time. |
|---|---|

##### Throws

| [CertificateExpiredException](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/CertificateExpiredException.html) | if the certificate has expired with respect to the `date` supplied. |
| [CertificateNotYetValidException](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/CertificateNotYetValidException.html) | if the certificate is not yet valid with respect to the `date` supplied. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#checkValidity()`

#### public static final [X509Certificate](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html)
**getInstance**
(byte\[\] certData)

Creates a new `X509Certificate` and initializes it from the
specified byte array.

##### Parameters

| certData | byte array containing data to initialize the certificate. |
|---|---|

##### Returns

- the certificate initialized from the specified byte array

##### Throws

| [CertificateException](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/CertificateException.html) | if the certificate cannot be created or initialized. |
|---|---|

#### public static final [X509Certificate](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html)
**getInstance**
([InputStream](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/InputStream.html) inStream)

Instantiates an X509Certificate object, and initializes it with
the data read from the input stream `inStream`.
The implementation (X509Certificate is an abstract class) is
provided by the class specified as the value of the
`cert.provider.x509v1` security property.

Note: Only one DER-encoded
certificate is expected to be in the input stream.
Also, all X509Certificate
subclasses must provide a constructor of the form:

    public <subClass>(InputStream inStream) ...
     
<br />

##### Parameters

| inStream | an input stream with the data to be read to initialize the certificate. |
|---|---|

##### Returns

- an X509Certificate object initialized with the data from the input stream.

##### Throws

| [CertificateException](https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/CertificateException.html) | if a class initialization or certificate parsing error occurs. |
|---|---|

#### public abstract [Principal](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Principal.html)
**getIssuerDN**
()

Gets the `issuer` (issuer distinguished name) value from
the certificate. The issuer name identifies the entity that signed (and
issued) the certificate.

The issuer name field contains an
X.500 distinguished name (DN).
The ASN.1 definition for this is:

```
 issuer    Name

 Name ::= CHOICE { RDNSequence }
 RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
 RelativeDistinguishedName ::=
     SET OF AttributeValueAssertion

 AttributeValueAssertion ::= SEQUENCE {
                               AttributeType,
                               AttributeValue }
 AttributeType ::= OBJECT IDENTIFIER
 AttributeValue ::= ANY
 
```
The `Name` describes a hierarchical name composed of attributes, such as country name, and corresponding values, such as US. The type of the `AttributeValue` component is determined by the `AttributeType`; in general it will be a `directoryString`. A `directoryString` is usually one of `PrintableString`, `TeletexString` or `UniversalString`.

<br />

##### Returns

- a Principal whose name is the issuer distinguished name.

#### public abstract [Date](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Date.html)
**getNotAfter**
()

Gets the `notAfter` date from the validity period of
the certificate. See `https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getNotBefore()`
for relevant ASN.1 definitions.

##### Returns

- the end date of the validity period.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#checkValidity()`

#### public abstract [Date](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Date.html)
**getNotBefore**
()

Gets the `notBefore` date from the validity period of
the certificate.
The relevant ASN.1 definitions are:

```
 validity             Validity

 Validity ::= SEQUENCE {
     notBefore      CertificateValidityDate,
     notAfter       CertificateValidityDate }

 CertificateValidityDate ::= CHOICE {
     utcTime        UTCTime,
     generalTime    GeneralizedTime }
 
```

<br />

##### Returns

- the start date of the validity period.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#checkValidity()`

#### public abstract BigInteger
**getSerialNumber**
()

Gets the `serialNumber` value from the certificate.
The serial number is an integer assigned by the certification
authority to each certificate. It must be unique for each
certificate issued by a given CA (i.e., the issuer name and
serial number identify a unique certificate).
The ASN.1 definition for this is:

```
 serialNumber     CertificateSerialNumber

 CertificateSerialNumber  ::=  INTEGER
 
```

<br />

##### Returns

- the serial number.

#### public abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getSigAlgName**
()

Gets the signature algorithm name for the certificate
signature algorithm. An example is the string "SHA-1/DSA".
The ASN.1 definition for this is:

```
 signatureAlgorithm   AlgorithmIdentifier

 AlgorithmIdentifier  ::=  SEQUENCE  {
     algorithm               OBJECT IDENTIFIER,
     parameters              ANY DEFINED BY algorithm OPTIONAL  }
                             -- contains a value of the type
                             -- registered for use with the
                             -- algorithm object identifier value
 
```

The algorithm name is determined from the `algorithm`
OID string.

##### Returns

- the signature algorithm name.

#### public abstract [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getSigAlgOID**
()

Gets the signature algorithm OID string from the certificate.
An OID is represented by a set of positive whole numbers separated
by periods.
For example, the string "1.2.840.10040.4.3" identifies the SHA-1
with DSA signature algorithm, as per the PKIX part I.

See `https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getSigAlgName()` for
relevant ASN.1 definitions.

##### Returns

- the signature algorithm OID string.

#### public abstract byte\[\]
**getSigAlgParams**
()

Gets the DER-encoded signature algorithm parameters from this
certificate's signature algorithm. In most cases, the signature
algorithm parameters are null; the parameters are usually
supplied with the certificate's public key.

See `https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getSigAlgName()` for
relevant ASN.1 definitions.

##### Returns

- the DER-encoded signature algorithm parameters, or null if no parameters are present.

#### public abstract [Principal](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Principal.html)
**getSubjectDN**
()

Gets the `subject` (subject distinguished name) value
from the certificate.
The ASN.1 definition for this is:

```
 subject    Name
 
```

See `https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getIssuerDN()` for `Name`
and other relevant definitions.

##### Returns

- a Principal whose name is the subject name.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/javax/security/cert/X509Certificate.html#getIssuerDN()`

#### public abstract int
**getVersion**
()

Gets the `version` (version number) value from the
certificate. The ASN.1 definition for this is:

```
 version         [0]  EXPLICIT Version DEFAULT v1

 Version  ::=  INTEGER  {  v1(0), v2(1), v3(2)  }
 
```

<br />

##### Returns

- the version number from the ASN.1 encoding, i.e. 0, 1 or 2.