Class: BasicOCSPResponse

Represents the BasicOCSPResponse structure described in RFC6960

Hierarchy

• PkiObject

  ↳ BasicOCSPResponse

Implements

• IBasicOCSPResponse

Constructors

constructor

• new BasicOCSPResponse(parameters?): BasicOCSPResponse

Initializes a new instance of the BasicOCSPResponse class

Parameters

Name	Type	Description
parameters	BasicOCSPResponseParameters	Initialization parameters

Returns

BasicOCSPResponse

Overrides

PkiObject.constructor

Properties

certs

• Optional certs: Certificate[]

Implementation of

IBasicOCSPResponse.certs

---

signature

• signature: BitString

Implementation of

IBasicOCSPResponse.signature

---

signatureAlgorithm

• signatureAlgorithm: AlgorithmIdentifier

Implementation of

IBasicOCSPResponse.signatureAlgorithm

---

tbsResponseData

• tbsResponseData: ResponseData

Implementation of

IBasicOCSPResponse.tbsResponseData

---

CLASS_NAME

▪ Static CLASS_NAME: string = "BasicOCSPResponse"

Name of the class

Overrides

PkiObject.CLASS_NAME

Accessors

className

• get className(): string

Returns

string

Inherited from

PkiObject.className

Methods

fromSchema

▸ fromSchema(schema): void

Converts parsed ASN.1 object into current class

Parameters

Name	Type	Description
schema	any	ASN.1 schema

Returns

void

Overrides

PkiObject.fromSchema

---

getCertificateStatus

▸ getCertificateStatus(certificate, issuerCertificate, crypto?): Promise<CertificateStatus>

Get OCSP response status for specific certificate

Parameters

Name	Type	Description
certificate	Certificate	Certificate to be checked
issuerCertificate	Certificate	Certificate of issuer for certificate to be checked
crypto	ICryptoEngine	Crypto engine

Returns

Promise<CertificateStatus>

---

sign

▸ sign(privateKey, hashAlgorithm?, crypto?): Promise<void>

Make signature for current OCSP Basic Response

Parameters

Name	Type	Default value	Description
privateKey	CryptoKey	undefined	Private key for "subjectPublicKeyInfo" structure
hashAlgorithm	string	"SHA-1"	Hashing algorithm. Default SHA-1
crypto	ICryptoEngine	undefined	Crypto engine

Returns

Promise<void>

---

toJSON

▸ toJSON(): BasicOCSPResponseJson

Converts the class to JSON object

Returns

BasicOCSPResponseJson

JSON object

Overrides

PkiObject.toJSON

---

toSchema

▸ toSchema(): Sequence

Converts current object to ASN.1 object and sets correct values

Returns

Sequence

ASN.1 object

Overrides

PkiObject.toSchema

---

toString

▸ toString(encoding?): string

Parameters

Name	Type	Default value
encoding	"base64" | "base64url" | "hex"	"hex"

Returns

string

Inherited from

PkiObject.toString

---

verify

▸ verify(params?, crypto?): Promise<boolean>

Verify existing OCSP Basic Response

Parameters

Name	Type	Description
params	BasicOCSPResponseVerifyParams	Additional parameters
crypto	ICryptoEngine	Crypto engine

Returns

Promise<boolean>

---

blockName

▸ blockName(): string

Returns block name

Returns

string

Returns string block name

Inherited from

PkiObject.blockName

---

compareWithDefault

▸ compareWithDefault(memberName, memberValue): boolean

Compare values with default values for all class members

Parameters

Name	Type	Description
memberName	string	String name for a class member
memberValue	any	Value to compare with default value

Returns

boolean

---

defaultValues

▸ defaultValues(memberName): ResponseData

Returns default values for all class members

Parameters

Name	Type	Description
memberName	"tbsResponseData"	String name for a class member

Returns

ResponseData

Default value

Overrides

PkiObject.defaultValues

▸ defaultValues(memberName): AlgorithmIdentifier

Parameters

Name	Type
memberName	"signatureAlgorithm"

Returns

AlgorithmIdentifier

Overrides

PkiObject.defaultValues

▸ defaultValues(memberName): BitString

Parameters

Name	Type
memberName	"signature"

Returns

BitString

Overrides

PkiObject.defaultValues

▸ defaultValues(memberName): Certificate[]

Parameters

Name	Type
memberName	"certs"

Returns

Certificate[]

Overrides

PkiObject.defaultValues

---

fromBER

▸ fromBER<T>(this, raw): T

Creates PKI object from the raw data

Type parameters

Name	Type
T	extends PkiObject

Parameters

Name	Type	Description
this	PkiObjectConstructor<T>	-
raw	BufferSource	ASN.1 encoded raw data

Returns

T

Initialized and filled current class object

Inherited from

PkiObject.fromBER

---

schema

▸ schema(parameters?): any

Returns value of pre-defined ASN.1 schema for current class

Parameters

Name	Type	Description
parameters	SchemaParameters<{ certs?: CertificateSchema ; signature?: string ; signatureAlgorithm?: AlgorithmIdentifierSchema ; tbsResponseData?: ResponseDataSchema }>	Input parameters for the schema

Returns

any

ASN.1 schema object

Overrides

PkiObject.schema