X509Certificate

Encapsulates an X509 certificate and provides read-only access to its information.

const { X509Certificate } = await import('node:crypto');

const x509 = new X509Certificate('{... pem encoded cert ...}');

console.log(x509.subject);

Since

v15.6.0

Constructors

X509Certificate

constructor(buffer: BinaryLike)

Properties

val ca: Boolean

Will be \`true\` if this is a Certificate Authority (CA) certificate.

fingerprint

val fingerprint: String

The SHA-1 fingerprint of this certificate.

fingerprint256

val fingerprint256: String

The SHA-256 fingerprint of this certificate.

fingerprint512

val fingerprint512: String

The SHA-512 fingerprint of this certificate.

infoAccess

val infoAccess: String?

A textual representation of the certificate's authority information access extension.

issuer

val issuer: String

The issuer identification included in this certificate.

issuerCertificate

val issuerCertificate: X509Certificate?

The issuer certificate or undefined if the issuer certificate is not available.

keyUsage

val keyUsage: ReadonlyArray<String>

An array detailing the key usages for this certificate.

publicKey

val publicKey: KeyObject

The public key KeyObject for this certificate.

raw

val raw: Buffer

A Buffer containing the DER encoding of this certificate.

serialNumber

val serialNumber: String

The serial number of this certificate.

subject

val subject: String

The complete subject of this certificate.

subjectAltName

val subjectAltName: String?

The subject alternative name specified for this certificate.

validFrom

val validFrom: String

The date/time from which this certificate is considered valid.

validTo

val validTo: String

The date/time until which this certificate is considered valid.

Functions

checkEmail

fun checkEmail(email: String, options: X509CheckOptions = definedExternally): String?

Checks whether the certificate matches the given email address.

checkHost

fun checkHost(name: String, options: X509CheckOptions = definedExternally): String?

Checks whether the certificate matches the given host name.

checkIP

fun checkIP(ip: String): String?

Checks whether the certificate matches the given IP address (IPv4 or IPv6).

checkIssued

fun checkIssued(otherCert: X509Certificate): Boolean

Checks whether this certificate was issued by the given otherCert.

checkPrivateKey

fun checkPrivateKey(privateKey: KeyObject): Boolean

Checks whether the public key for this certificate is consistent with the given private key.

toJSON

fun toJSON(): String

There is no standard JSON encoding for X509 certificates. ThetoJSON() method returns a string containing the PEM encoded certificate.

toLegacyObject

fun toLegacyObject(): PeerCertificate

Returns information about this certificate using the legacy certificate object encoding.

toString

open override fun toString(): String

Returns the PEM-encoded certificate.

verify

fun verify(publicKey: KeyObject): Boolean

Verifies that this certificate was signed by the given public key. Does not perform any other validation checks on the certificate.