Class CertificateListBuilder

Builder class for creating X.509 Certificate Revocation Lists (CRLs).

Provides a fluent API for constructing CRLs with revoked certificates, extensions, and signing them with a CA's private key.

Example

const crl = await CertificateList.builder()
    .setIssuer('CN=My CA, O=My Org')
    .setPrivateKey(caPrivateKey)
    .setThisUpdate(new Date())
    .setNextUpdate(new Date(Date.now() + 30 * 24 * 60 * 60 * 1000))
    .addRevokedCertificate({
        serialNumber: 12345,
        revocationDate: new Date(),
    })
    .build()

Implements

AsyncBuilder<CertificateList>

Index

Constructors

constructor

Methods

addExtension addExtensions addRevokedCertificate build revokeCertificate setAlgorithm setIssuer setIssuerFromCertificate setNextUpdate setPrivateKey setThisUpdate

Constructors

constructor

new CertificateListBuilder(): CertificateListBuilder
Returns CertificateListBuilder

Methods

addExtension

addExtension(extension: Extension): this
Adds a CRL extension (e.g., CRL number, authority key identifier).
Parameters
- extension: Extension
  The extension to add
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateListBuilder.ts:166

addExtensions

addExtensions(...extensions: Extension[]): this
Adds multiple CRL extensions.
Parameters
- ...extensions: Extension[]
  The extensions to add
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateListBuilder.ts:179

addRevokedCertificate

addRevokedCertificate(
    entry:
        | RevokedCertificate
        | {
            crlEntryExtensions?: Extension[];
            revocationDate: Date;
            serialNumber: string
            | number;
        },
): this
Adds a revoked certificate entry.
Parameters
- entry:
      | RevokedCertificate
      | {
          crlEntryExtensions?: Extension[];
          revocationDate: Date;
          serialNumber: string
          | number;
      }
  Revoked certificate details, or a RevokedCertificate instance
Returns this
This builder for chaining
Example
```
builder.addRevokedCertificate({
    serialNumber: 12345,
    revocationDate: new Date(),
})
```
- Defined in packages/pki-lite/src/core/builders/CertificateListBuilder.ts:120

build

build(): Promise<CertificateList>
Builds and signs the CRL.

Returns Promise<CertificateList>
Promise resolving to the signed CertificateList
Implementation of AsyncBuilder.build
- Defined in packages/pki-lite/src/core/builders/CertificateListBuilder.ts:215

revokeCertificate

revokeCertificate(certificate: Certificate, revocationDate?: Date): this
Revokes a certificate by reference. Uses the certificate's serial number and the current time as the revocation date if not provided.
Parameters
- certificate: Certificate
  The certificate to revoke
- OptionalrevocationDate: Date
  The revocation date (defaults to now)
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateListBuilder.ts:153

setAlgorithm

setAlgorithm(
    algorithm:
        | SignatureAlgorithmIdentifier
        | AsymmetricEncryptionAlgorithmParams,
): this
Sets the signature algorithm.
Parameters
- algorithm: SignatureAlgorithmIdentifier | AsymmetricEncryptionAlgorithmParams
  Algorithm parameters or SignatureAlgorithmIdentifier
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateListBuilder.ts:192

setIssuer

setIssuer(issuer: string | RDNSequence): this
Sets the CRL issuer (the CA name).
Parameters
- issuer: string | RDNSequence
  Issuer DN as string or Name object
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateListBuilder.ts:56

setIssuerFromCertificate

setIssuerFromCertificate(caCertificate: Certificate): this
Sets the issuer from a CA certificate's subject.
Parameters
- caCertificate: Certificate
  The CA certificate
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateListBuilder.ts:67

setNextUpdate

setNextUpdate(date: Date): this
Sets the nextUpdate time (when the next CRL will be issued). Defaults to 30 days after thisUpdate if not set.
Parameters
- date: Date
  The next update date
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateListBuilder.ts:102

setPrivateKey

setPrivateKey(privateKey: PrivateKeyInfo): this
Sets the private key for signing the CRL.
Parameters
- privateKey: PrivateKeyInfo
  The CA's private key
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateListBuilder.ts:78

setThisUpdate

setThisUpdate(date: Date): this
Sets the thisUpdate time (when this CRL was issued). Defaults to current time if not set.
Parameters
- date: Date
  The issue date
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateListBuilder.ts:90

Class CertificateListBuilder

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Returns CertificateListBuilder

Methods

addExtension

Parameters

Returns this

addExtensions

Parameters

Returns this

addRevokedCertificate

Parameters

Returns this

Example

build

Returns Promise<CertificateList>

revokeCertificate

Parameters

Returns this

setAlgorithm

Parameters

Returns this

setIssuer

Parameters

Returns this

setIssuerFromCertificate

Parameters

Returns this

setNextUpdate

Parameters

Returns this

setPrivateKey

Parameters

Returns this

setThisUpdate

Parameters

Returns this

Settings

On This Page