Class CertificateRevocationList

Represents the CertificateRevocationList structure described in RFC5280

Hierarchy

PkiObject
- CertificateRevocationList

Implements

ICertificateRevocationList

Index

Constructors

constructor

new CertificateRevocationList(parameters?: CertificateRevocationListParameters): CertificateRevocationList
Initializes a new instance of the CertificateRevocationList class
Parameters
- parameters: CertificateRevocationListParameters = {}
  
  Initialization parameters
Returns CertificateRevocationList
Overrides PkiObject.constructor
- Defined in src/CertificateRevocationList.ts:219

Properties

`Optional` crlExtensions

crlExtensions?: Extensions

issuer

issuer: RelativeDistinguishedNames

`Optional` nextUpdate

nextUpdate?: Time

`Optional` revokedCertificates

revokedCertificates?: RevokedCertificate[]

signature

signature: AlgorithmIdentifier

signatureAlgorithm

signatureAlgorithm: AlgorithmIdentifier

signatureValue

signatureValue: BitString

tbsView

tbsView: Uint8Array

thisUpdate

thisUpdate: Time

version

version: number

`Static` CLASS_NAME

CLASS_NAME: string = "CertificateRevocationList"

Name of the class

Accessors

className

get className(): string
Returns string
Inherited from PkiObject.className
- Defined in src/PkiObject.ts:65

tbs

get tbs(): ArrayBuffer
Deprecated
Since version 3.0.0

Returns ArrayBuffer
Implementation of ICertificateRevocationList.tbs
- Defined in src/CertificateRevocationList.ts:195
set tbs(value: ArrayBuffer): void
Deprecated
Since version 3.0.0
Parameters
- value: ArrayBuffer
Returns void
Implementation of ICertificateRevocationList.tbs
- Defined in src/CertificateRevocationList.ts:202

Methods

`Protected` encodeTBS

encodeTBS(): Sequence
Returns Sequence
- Defined in src/CertificateRevocationList.ts:358

fromSchema

fromSchema(schema: any): void
Converts parsed ASN.1 object into current class
Parameters
- schema: any
  
  ASN.1 schema
Returns void
Overrides PkiObject.fromSchema
- Defined in src/CertificateRevocationList.ts:323

isCertificateRevoked

isCertificateRevoked(certificate: Certificate): boolean
Returns true if supplied certificate is revoked, otherwise false
Parameters
- certificate: Certificate
Returns boolean
- Defined in src/CertificateRevocationList.ts:467

sign

sign(privateKey: CryptoKey, hashAlgorithm?: string, crypto?: ICryptoEngine): Promise<void>
Make a signature for existing CRL data
Parameters
- privateKey: CryptoKey
  
  Private key for "subjectPublicKeyInfo" structure
- hashAlgorithm: string = "SHA-1"
  
  Hashing algorithm. Default SHA-1
- crypto: ICryptoEngine = ...
  
  Crypto engine
Returns Promise<void>
- Defined in src/CertificateRevocationList.ts:494

toJSON

toJSON(): CertificateRevocationListJson
Converts the class to JSON object

Returns
JSON object

Returns CertificateRevocationListJson
Overrides PkiObject.toJSON
- Defined in src/CertificateRevocationList.ts:434

toSchema

toSchema(encodeFlag?: boolean): any
Convert current object to asn1js object and set correct values

Returns
asn1js object
Parameters
- encodeFlag: boolean = false
Returns any
Overrides PkiObject.toSchema
- Defined in src/CertificateRevocationList.ts:403

toString

toString(encoding?: "base64" | "base64url" | "hex"): string
Parameters
- encoding: "base64" | "base64url" | "hex" = "hex"
Returns string
Inherited from PkiObject.toString
- Defined in src/PkiObject.ts:88

verify

verify(parameters?: CertificateRevocationListVerifyParams, crypto?: ICryptoEngine): Promise<boolean>
Verify existing signature
Parameters
- parameters: CertificateRevocationListVerifyParams = {}
- crypto: ICryptoEngine = ...
  
  Crypto engine
Returns Promise<boolean>
- Defined in src/CertificateRevocationList.ts:522

`Static` blockName

blockName(): string
Returns block name

Returns
Returns string block name

Returns string
Inherited from PkiObject.blockName
- Defined in src/PkiObject.ts:27

`Static` defaultValues

defaultValues(memberName: "tbs"): ArrayBuffer
Returns default values for all class members

Returns
Default value
Parameters
- memberName: "tbs"
  
  String name for a class member
Returns ArrayBuffer
Overrides PkiObject.defaultValues
- Defined in src/CertificateRevocationList.ts:249
defaultValues(memberName: "version"): number
Parameters
- memberName: "version"
Returns number
Overrides PkiObject.defaultValues
- Defined in src/CertificateRevocationList.ts:250
defaultValues(memberName: "signature"): AlgorithmIdentifier
Parameters
- memberName: "signature"
Returns AlgorithmIdentifier
Overrides PkiObject.defaultValues
- Defined in src/CertificateRevocationList.ts:251
defaultValues(memberName: "issuer"): RelativeDistinguishedNames
Parameters
- memberName: "issuer"
Returns RelativeDistinguishedNames
Overrides PkiObject.defaultValues
- Defined in src/CertificateRevocationList.ts:252
defaultValues(memberName: "thisUpdate"): Time
Parameters
- memberName: "thisUpdate"
Returns Time
Overrides PkiObject.defaultValues
- Defined in src/CertificateRevocationList.ts:253
defaultValues(memberName: "nextUpdate"): Time
Parameters
- memberName: "nextUpdate"
Returns Time
Overrides PkiObject.defaultValues
- Defined in src/CertificateRevocationList.ts:254
defaultValues(memberName: "revokedCertificates"): RevokedCertificate[]
Parameters
- memberName: "revokedCertificates"
Returns RevokedCertificate[]
Overrides PkiObject.defaultValues
- Defined in src/CertificateRevocationList.ts:255
defaultValues(memberName: "crlExtensions"): Extensions
Parameters
- memberName: "crlExtensions"
Returns Extensions
Overrides PkiObject.defaultValues
- Defined in src/CertificateRevocationList.ts:256
defaultValues(memberName: "signatureAlgorithm"): AlgorithmIdentifier
Parameters
- memberName: "signatureAlgorithm"
Returns AlgorithmIdentifier
Overrides PkiObject.defaultValues
- Defined in src/CertificateRevocationList.ts:257
defaultValues(memberName: "signatureValue"): BitString
Parameters
- memberName: "signatureValue"
Returns BitString
Overrides PkiObject.defaultValues
- Defined in src/CertificateRevocationList.ts:258

`Static` fromBER

fromBER<T>(this: PkiObjectConstructor<T>, raw: BufferSource): T
Creates PKI object from the raw data

Returns
Initialized and filled current class object
Type Parameters
- T extends PkiObject<T>
Parameters
- this: PkiObjectConstructor<T>
- raw: BufferSource
  
  ASN.1 encoded raw data
Returns T
Inherited from PkiObject.fromBER
- Defined in src/PkiObject.ts:36

`Static` schema

schema(parameters?: SchemaParameters<{ crlExtensions?: ExtensionsSchema; issuer?: RelativeDistinguishedNamesSchema; signature?: AlgorithmIdentifierSchema; signatureAlgorithm?: AlgorithmIdentifierSchema; signatureValue?: string; tbsCertListNextUpdate?: TimeSchema; tbsCertListRevokedCertificates?: string; tbsCertListThisUpdate?: TimeSchema; tbsCertListVersion?: string }>): any
Returns value of pre-defined ASN.1 schema for current class

Returns
ASN.1 schema object
Parameters
- parameters: SchemaParameters<{ crlExtensions?: ExtensionsSchema; issuer?: RelativeDistinguishedNamesSchema; signature?: AlgorithmIdentifierSchema; signatureAlgorithm?: AlgorithmIdentifierSchema; signatureValue?: string; tbsCertListNextUpdate?: TimeSchema; tbsCertListRevokedCertificates?: string; tbsCertListThisUpdate?: TimeSchema; tbsCertListVersion?: string }> = {}
  
  Input parameters for the schema
Returns any
Overrides PkiObject.schema
- Defined in src/CertificateRevocationList.ts:296

Class CertificateRevocationList

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: CertificateRevocationListParameters = {}

Returns CertificateRevocationList

Properties

Optional crlExtensions

issuer

Optional nextUpdate

Optional revokedCertificates

signature

signatureAlgorithm

signatureValue

tbsView

thisUpdate

version

Static CLASS_NAME

Accessors

className

Returns string

tbs

Deprecated

Returns ArrayBuffer

Deprecated

Parameters

value: ArrayBuffer

Returns void

Methods

Protected encodeTBS

Returns Sequence

fromSchema

Parameters

schema: any

Returns void

isCertificateRevoked

Parameters

certificate: Certificate

Returns boolean

sign

Parameters

privateKey: CryptoKey

hashAlgorithm: string = "SHA-1"

crypto: ICryptoEngine = ...

Returns Promise<void>

toJSON

Returns

Returns CertificateRevocationListJson

toSchema

Returns

Parameters

encodeFlag: boolean = false

Returns any

toString

Parameters

encoding: "base64" | "base64url" | "hex" = "hex"

Returns string

verify

Parameters

parameters: CertificateRevocationListVerifyParams = {}

crypto: ICryptoEngine = ...

Returns Promise<boolean>

Static blockName

Returns

Returns string

Static defaultValues

Returns

Parameters

memberName: "tbs"

Returns ArrayBuffer

Parameters

memberName: "version"

Returns number

`Optional` crlExtensions

`Optional` nextUpdate

`Optional` revokedCertificates

`Static` CLASS_NAME

`Protected` encodeTBS

`Static` blockName

`Static` defaultValues

`Static` fromBER

`Static` schema