X509Crl

Representation of X.509 Certificate Revocation List (CRL)

Extends

• PemData<CertificateList>

Constructors

Constructor

new X509Crl(asn, options?): X509Crl

Creates a new instance from ASN.1 CertificateList object

Parameters

asn

CertificateList

ASN.1 CertificateList object

options?

any

Optional ASN.1 parse options (e.g. asn1js.fromBER resource limits)

Returns

X509Crl

Overrides

PemData.constructor

Constructor

new X509Crl(raw, options?): X509Crl

Creates a new instance

Parameters

raw

AsnEncodedType

Encoded buffer (DER, PEM, HEX, Base64, Base64Url)

options?

any

Optional ASN.1 parse options (e.g. asn1js.fromBER resource limits)

Returns

X509Crl

Overrides

PemData.constructor

Properties

asn

protected readonly asn: CertificateList

ASN.1 object

Inherited from

PemData.asn

---

tag

protected readonly tag: string = PemConverter.CrlTag

PEM tag

Overrides

PemData.tag

---

NAME

static NAME: string = "ASN"

Inherited from

PemData.NAME

Accessors

entries

Get Signature

get entries(): readonly X509CrlEntry[]

Gets a crlEntries from the CRL

Remarks

Reading this property parses all revoked certificates, which can be slow for large CRLs. Use findRevoked() for efficient searching of specific certificates.

Returns

readonly X509CrlEntry[]

---

extensions

Get Signature

get extensions(): Extension[]

Gets a list of crl extensions

Returns

Extension[]

---

issuer

Get Signature

get issuer(): string

Gets a string issuer name

Returns

string

---

issuerName

Get Signature

get issuerName(): Name

Gets the issuer value from the crl as an Name

Returns

Name

---

nextUpdate

Get Signature

get nextUpdate(): Date | undefined

Gets a nextUpdate date from the CRL

Returns

Date | undefined

---

parseOptions

Get Signature

get protected parseOptions(): any

Gets the ASN.1 parse options the instance was created with

Returns

any

Inherited from

PemData.parseOptions

---

rawData

Get Signature

get rawData(): ArrayBuffer

Gets a DER encoded buffer

Returns

ArrayBuffer

Inherited from

PemData.rawData

---

signature

Get Signature

get signature(): ArrayBuffer

Gets a signature

Returns

ArrayBuffer

---

signatureAlgorithm

Get Signature

get signatureAlgorithm(): HashedAlgorithm

Gets a signature algorithm

Returns

HashedAlgorithm

---

thisUpdate

Get Signature

get thisUpdate(): Date

Gets a thisUpdate date from the CRL

Returns

Date

---

version

Get Signature

get version(): any

Gets a version

Returns

any

Methods

equal()

equal(data): data is X509Crl

Returns true if ASN.1 data is equal to another ASN.1 data, otherwise false

Parameters

data

any

Any data

Returns

data is X509Crl

Inherited from

PemData.equal

---

findRevoked()

findRevoked(certOrSerialNumber): X509CrlEntry | null

Gets the CRL entry, with the given X509Certificate or certificate serialNumber.

Parameters

certOrSerialNumber

certificate | serialNumber

string | X509Certificate

Returns

X509CrlEntry | null

---

getExtension()

Call Signature

getExtension<T>(type): T | null

Returns an extension of specified type

Type Parameters

T

T extends Extension

Parameters

type

string

Extension identifier

Returns

T | null

Extension or null

Call Signature

getExtension<T>(type): T | null

Returns an extension of specified type

Type Parameters

T

T extends Extension

Parameters

type

(raw) => T

Extension type

Returns

T | null

Extension or null

---

getExtensions()

Returns a list of extensions of specified type

Param

Extension identifier

Call Signature

getExtensions<T>(type): T[]

Returns a list of extensions of specified type

Type Parameters

T

T extends Extension

Parameters

type

string

Extension identifier

Returns

T[]

Call Signature

getExtensions<T>(type): T[]

Returns a list of extensions of specified type

Type Parameters

T

T extends Extension

Parameters

type

(raw) => T

Extension type

Returns

T[]

---

getTextName()

protected getTextName(): string

Returns

string

Inherited from

PemData.getTextName

---

getThumbprint()

Call Signature

getThumbprint(crypto?): Promise<ArrayBuffer>

Returns a SHA-1 certificate thumbprint

Parameters

crypto?

Crypto

Crypto provider. Default is from CryptoProvider

Returns

Promise<ArrayBuffer>

Call Signature

getThumbprint(algorithm, crypto?): Promise<ArrayBuffer>

Returns a certificate thumbprint for specified mechanism

Parameters

algorithm

AlgorithmIdentifier

Hash algorithm

crypto?

Crypto

Crypto provider. Default is from CryptoProvider

Returns

Promise<ArrayBuffer>

---

onInit()

protected onInit(_asn): void

Occurs on instance initialization

Parameters

_asn

CertificateList

Returns

void

Overrides

PemData.onInit

---

toString()

Call Signature

toString(): string

Returns encoded object in PEM format

Returns

string

Inherited from

PemData.toString

Call Signature

toString(format): string

Returns encoded object in selected format

Parameters

format

AsnExportType

hex, base64, base64url, pem, asn, text

Returns

string

Inherited from

PemData.toString

---

toTextObject()

toTextObject(): TextObject

Returns the object in textual representation

Returns

TextObject

Inherited from

PemData.toTextObject

---

toTextObjectEmpty()

protected toTextObjectEmpty(value?): TextObject

Parameters

value?

string

Returns

TextObject

Inherited from

PemData.toTextObjectEmpty

---

verify()

verify(params, crypto): Promise<boolean>

Validates a crl signature

Parameters

params

X509CrlVerifyParams

Verification parameters

crypto

Crypto = ...

Crypto provider. Default is from CryptoProvider

Returns

Promise<boolean>

---

isAsnEncoded()

static isAsnEncoded(data): data is AsnEncodedType

Parameters

data

any

Returns

data is AsnEncodedType

Inherited from

PemData.isAsnEncoded

---

toArrayBuffer()

static toArrayBuffer(raw): ArrayBuffer

Converts encoded raw to ArrayBuffer. Supported formats are HEX, DER, Base64, Base64Url, PEM

Parameters

raw

Encoded data

string | BufferSource

Returns

ArrayBuffer

Inherited from

PemData.toArrayBuffer