Class Certificate

X.509 Certificate.

This is a high-level class on top of PKI.js Certificate, to make the use of Relaynet certificates easy and safe.

Index

Accessors

expiryDate startDate

Methods

calculateSubjectId getCertificationPath getCommonName getIssuerId getPublicKey getSerialNumber getSerialNumberHex isEqual serialize validate deserialize issue

Accessors

expiryDate

get expiryDate(): Date
Returns Date
- Defined in src/lib/crypto/x509/Certificate.ts:26

startDate

get startDate(): Date
Returns Date
- Defined in src/lib/crypto/x509/Certificate.ts:22

Methods

calculateSubjectId

calculateSubjectId(): Promise<string>
Returns Promise<string>
- Defined in src/lib/crypto/x509/Certificate.ts:200

getCertificationPath

getCertificationPath(intermediateCaCertificates, trustedCertificates): Promise<readonly Certificate[]>
Return the certification path (aka "certificate chain") if this certificate can be trusted.
Parameters
- intermediateCaCertificates: readonly Certificate[]
  The alleged chain for the certificate
- trustedCertificates: readonly Certificate[]
  The collection of certificates that are actually trusted
Returns Promise<readonly Certificate[]>
Throws
CertificateError when this certificate is not on a certificate path from a CA in trustedCertificates
- Defined in src/lib/crypto/x509/Certificate.ts:230

getCommonName

getCommonName(): string
Returns string
- Defined in src/lib/crypto/x509/Certificate.ts:157

getIssuerId

getIssuerId(): null | string
Returns null | string
- Defined in src/lib/crypto/x509/Certificate.ts:208

getPublicKey

getPublicKey(): Promise<CryptoKey>
Returns Promise<CryptoKey>
- Defined in src/lib/crypto/x509/Certificate.ts:167

getSerialNumber

getSerialNumber(): Buffer
Return serial number.

This doesn't return a number or BigInt because the serial number could require more than 8 octets (which is the maximum number of octets required to represent a 64-bit unsigned integer).

Returns Buffer
- Defined in src/lib/crypto/x509/Certificate.ts:146

getSerialNumberHex

getSerialNumberHex(): string
Returns string
- Defined in src/lib/crypto/x509/Certificate.ts:152

isEqual

isEqual(otherCertificate): boolean
Report whether this certificate is the same as otherCertificate.
Parameters
- otherCertificate: Certificate
Returns boolean
- Defined in src/lib/crypto/x509/Certificate.ts:176

serialize

serialize(): ArrayBuffer
Serialize certificate as DER-encoded buffer.

Returns ArrayBuffer
- Defined in src/lib/crypto/x509/Certificate.ts:134

validate

validate(): void
Returns void
- Defined in src/lib/crypto/x509/Certificate.ts:182

`Static` deserialize

deserialize(certDer): Certificate
Deserialize certificate from DER-encoded value.
Parameters
- certDer: ArrayBuffer
  DER-encoded X.509 certificate
Returns Certificate
- Defined in src/lib/crypto/x509/Certificate.ts:35

`Static` issue

issue(options): Promise<Certificate>
Issue a Relaynet PKI certificate.
Parameters
- options: default
Returns Promise<Certificate>
- Defined in src/lib/crypto/x509/Certificate.ts:46

Generated using TypeDoc