Class BasicOCSPResponse

Represents the BasicOCSPResponse structure described in RFC6960

Hierarchy

PkiObject
- BasicOCSPResponse

Implements

IBasicOCSPResponse

Index

Constructors

constructor

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

Properties

`Optional` certs

certs?: Certificate[]

signature

signature: BitString

signatureAlgorithm

signatureAlgorithm: AlgorithmIdentifier

tbsResponseData

tbsResponseData: ResponseData

`Static` CLASS_NAME

CLASS_NAME: string = "BasicOCSPResponse"

Name of the class

Accessors

className

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

Methods

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/BasicOCSPResponse.ts:196

getCertificateStatus

getCertificateStatus(certificate: Certificate, issuerCertificate: Certificate, crypto?: ICryptoEngine): Promise<CertificateStatus>
Get OCSP response status for specific certificate
Parameters
- certificate: Certificate
  
  Certificate to be checked
- issuerCertificate: Certificate
  
  Certificate of issuer for certificate to be checked
- crypto: ICryptoEngine = ...
  
  Crypto engine
Returns Promise<CertificateStatus>
- Defined in src/BasicOCSPResponse.ts:271

sign

sign(privateKey: CryptoKey, hashAlgorithm?: string, crypto?: ICryptoEngine): Promise<void>
Make signature for current OCSP Basic Response
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/BasicOCSPResponse.ts:348

toJSON

toJSON(): BasicOCSPResponseJson
Converts the class to JSON object

Returns
JSON object

Returns BasicOCSPResponseJson
Overrides PkiObject.toJSON
- Defined in src/BasicOCSPResponse.ts:251

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/BasicOCSPResponse.ts:219

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(params?: BasicOCSPResponseVerifyParams, crypto?: ICryptoEngine): Promise<boolean>
Verify existing OCSP Basic Response
Parameters
- params: BasicOCSPResponseVerifyParams = {}
  
  Additional parameters
- crypto: ICryptoEngine = ...
  
  Crypto engine
Returns Promise<boolean>
- Defined in src/BasicOCSPResponse.ts:379

`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/BasicOCSPResponse.ts:119

`Static` defaultValues

defaultValues(memberName: "tbsResponseData"): ResponseData
Returns default values for all class members

Returns
Default value
Parameters
- memberName: "tbsResponseData"
  
  String name for a class member
Returns ResponseData
Overrides PkiObject.defaultValues
- Defined in src/BasicOCSPResponse.ts:95
defaultValues(memberName: "signatureAlgorithm"): AlgorithmIdentifier
Parameters
- memberName: "signatureAlgorithm"
Returns AlgorithmIdentifier
Overrides PkiObject.defaultValues
- Defined in src/BasicOCSPResponse.ts:96
defaultValues(memberName: "signature"): BitString
Parameters
- memberName: "signature"
Returns BitString
Overrides PkiObject.defaultValues
- Defined in src/BasicOCSPResponse.ts:97
defaultValues(memberName: "certs"): Certificate[]
Parameters
- memberName: "certs"
Returns Certificate[]
Overrides PkiObject.defaultValues
- Defined in src/BasicOCSPResponse.ts:98

`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<{ certs?: CertificateSchema; signature?: string; signatureAlgorithm?: AlgorithmIdentifierSchema; tbsResponseData?: ResponseDataSchema }>): any
Returns value of pre-defined ASN.1 schema for current class

Returns
ASN.1 schema object
Parameters
- parameters: SchemaParameters<{ certs?: CertificateSchema; signature?: string; signatureAlgorithm?: AlgorithmIdentifierSchema; tbsResponseData?: ResponseDataSchema }> = {}
  
  Input parameters for the schema
Returns any
Overrides PkiObject.schema
- Defined in src/BasicOCSPResponse.ts:155

Class BasicOCSPResponse

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: BasicOCSPResponseParameters = {}

Returns BasicOCSPResponse

Properties

Optional certs

signature

signatureAlgorithm

tbsResponseData

Static CLASS_NAME

Accessors

className

Returns string

Methods

fromSchema

Parameters

schema: any

Returns void

getCertificateStatus

Parameters

certificate: Certificate

issuerCertificate: Certificate

crypto: ICryptoEngine = ...

Returns Promise<CertificateStatus>

sign

Parameters

privateKey: CryptoKey

hashAlgorithm: string = "SHA-1"

crypto: ICryptoEngine = ...

Returns Promise<void>

toJSON

Returns

Returns BasicOCSPResponseJson

toSchema

Returns

Returns Sequence

toString

Parameters

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

Returns string

verify

Parameters

params: BasicOCSPResponseVerifyParams = {}

crypto: ICryptoEngine = ...

Returns Promise<boolean>

Static blockName

Returns

Returns string

Static compareWithDefault

Parameters

memberName: string

memberValue: any

Returns boolean

Static defaultValues

Returns

Parameters

memberName: "tbsResponseData"

Returns ResponseData

Parameters

memberName: "signatureAlgorithm"

Returns AlgorithmIdentifier

Parameters

memberName: "signature"

Returns BitString

Parameters

memberName: "certs"

Returns Certificate[]

Static fromBER

Returns

Type Parameters

T extends PkiObject<T>

`Optional` certs

`Static` CLASS_NAME

`Static` blockName

`Static` compareWithDefault

`Static` defaultValues

`Static` fromBER

`Static` schema