Class CertID

Represents an CertID described in RFC6960

Hierarchy

PkiObject
- CertID

Implements

ICertID

Index

Constructors

constructor

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

Properties

hashAlgorithm

hashAlgorithm: AlgorithmIdentifier

Hash algorithm used to generate the issuerNameHash and issuerKeyHash values

issuerKeyHash

issuerKeyHash: OctetString

Hash of the issuer's public key. The hash shall be calculated over the value (excluding tag and length) of the subject public key field in the issuer's certificate.

issuerNameHash

issuerNameHash: OctetString

Hash of the issuer's distinguished name (DN). The hash shall be calculated over the DER encoding of the issuer's name field in the certificate being checked.

serialNumber

serialNumber: Integer

Serial number of the certificate for which status is being requested

`Static` CLASS_NAME

CLASS_NAME: string = "CertID"

Name of the class

Accessors

className

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

Methods

createForCertificate

createForCertificate(certificate: Certificate, parameters: CertIDCreateParams, crypto?: ICryptoEngine): Promise<void>
Making OCSP certificate identifier for specific certificate
Parameters
- certificate: Certificate
  
  Certificate making OCSP Request for
- parameters: CertIDCreateParams
  
  Additional parameters
- crypto: ICryptoEngine = ...
  
  Crypto engine
Returns Promise<void>
- Defined in src/CertID.ts:258

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/CertID.ts:179

isEqual

isEqual(certificateID: CertID): boolean
Checks that two "CertIDs" are equal
Parameters
- certificateID: CertID
  
  Identifier of the certificate to be checked
Returns boolean
- Defined in src/CertID.ts:228

toJSON

toJSON(): CertIDJson
Converts the class to JSON object

Returns
JSON object

Returns CertIDJson
Overrides PkiObject.toJSON
- Defined in src/CertID.ts:215

toSchema

toSchema(): Sequence
Converts current object to ASN.1 object and sets correct values

Returns
ASN.1 object

Returns Sequence
Overrides PkiObject.toSchema
- Defined in src/CertID.ts:204

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

`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` compareWithDefault

compareWithDefault(memberName: string, memberValue: any): boolean
Compare values with default values for all class members
Parameters
- memberName: string
  
  String name for a class member
- memberValue: any
  
  Value to compare with default value
Returns boolean
- Defined in src/CertID.ts:137

`Static` create

create(certificate: Certificate, parameters: CertIDCreateParams, crypto?: ICryptoEngine): Promise<CertID>
Making OCSP certificate identifier for specific certificate

Returns
Returns created CertID object
Parameters
- certificate: Certificate
  
  Certificate making OCSP Request for
- parameters: CertIDCreateParams
  
  Additional parameters
- crypto: ICryptoEngine = ...
  
  Crypto engine
Returns Promise<CertID>
- Defined in src/CertID.ts:80

`Static` defaultValues

defaultValues(memberName: "hashAlgorithm"): AlgorithmIdentifier
Returns default values for all class members

Returns
Default value
Parameters
- memberName: "hashAlgorithm"
  
  String name for a class member
Returns AlgorithmIdentifier
Overrides PkiObject.defaultValues
- Defined in src/CertID.ts:114
defaultValues(memberName: "issuerNameHash"): OctetString
Parameters
- memberName: "issuerNameHash"
Returns OctetString
Overrides PkiObject.defaultValues
- Defined in src/CertID.ts:115
defaultValues(memberName: "issuerKeyHash"): OctetString
Parameters
- memberName: "issuerKeyHash"
Returns OctetString
Overrides PkiObject.defaultValues
- Defined in src/CertID.ts:116
defaultValues(memberName: "serialNumber"): Integer
Parameters
- memberName: "serialNumber"
Returns Integer
Overrides PkiObject.defaultValues
- Defined in src/CertID.ts:117

`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?: CertIDSchema): any
Returns value of pre-defined ASN.1 schema for current class

Returns
ASN.1 schema object
Parameters
- parameters: CertIDSchema = {}
  
  Input parameters for the schema
Returns any
Overrides PkiObject.schema
- Defined in src/CertID.ts:161

Class CertID

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: CertIDParameters = {}

Returns CertID

Properties

hashAlgorithm

issuerKeyHash

issuerNameHash

serialNumber

Static CLASS_NAME

Accessors

className

Returns string

Methods

createForCertificate

Parameters

certificate: Certificate

parameters: CertIDCreateParams

crypto: ICryptoEngine = ...

Returns Promise<void>

fromSchema

Parameters

schema: any

Returns void

isEqual

Parameters

certificateID: CertID

Returns boolean

toJSON

Returns

Returns CertIDJson

toSchema

Returns

Returns Sequence

toString

Parameters

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

Returns string

Static blockName

Returns

Returns string

Static compareWithDefault

Parameters

memberName: string

memberValue: any

Returns boolean

Static create

Returns

Parameters

certificate: Certificate

parameters: CertIDCreateParams

crypto: ICryptoEngine = ...

Returns Promise<CertID>

Static defaultValues

Returns

Parameters

memberName: "hashAlgorithm"

Returns AlgorithmIdentifier

Parameters

memberName: "issuerNameHash"

Returns OctetString

Parameters

memberName: "issuerKeyHash"

Returns OctetString

Parameters

memberName: "serialNumber"

Returns Integer

Static fromBER

Returns

Type Parameters

T extends PkiObject<T>

`Static` CLASS_NAME

`Static` blockName

`Static` compareWithDefault

`Static` create

`Static` defaultValues

`Static` fromBER

`Static` schema