Class CertificateRequestBuilder

Builder class for creating PKCS#10 certificate signing requests (CSRs).

This builder provides a fluent API for constructing CSRs with various options including subject, extensions, and signature algorithm.

Example

// Create a simple CSR
const csr = await CertificateRequest.builder()
    .setSubject('CN=example.com, O=My Org, C=US')
    .setPublicKey(publicKey)
    .setPrivateKey(privateKey)
    .addKeyUsage({ digitalSignature: true, keyEncipherment: true })
    .addSubjectAltName('example.com', '*.example.com')
    .build()

Implements

AsyncBuilder<CertificateRequest>

Index

Constructors

constructor

Methods

addExtendedKeyUsage addExtension addExtensions addKeyUsage addSubjectAltName build setAlgorithm setPrivateKey setPublicKey setSubject

Constructors

constructor

new CertificateRequestBuilder(): CertificateRequestBuilder
Returns CertificateRequestBuilder

Methods

addExtendedKeyUsage

addExtendedKeyUsage(
    options: {
        clientAuth?: boolean;
        codeSigning?: boolean;
        emailProtection?: boolean;
        ocspSigning?: boolean;
        serverAuth?: boolean;
        timeStamping?: boolean;
    } & { [oid: string]: boolean },
): this
Adds an Extended Key Usage extension to the CSR.
Parameters
- options: {
      clientAuth?: boolean;
      codeSigning?: boolean;
      emailProtection?: boolean;
      ocspSigning?: boolean;
      serverAuth?: boolean;
      timeStamping?: boolean;
  } & { [oid: string]: boolean }
  Extended key usage purposes
Returns this
This builder for chaining
Example
```
builder.addExtendedKeyUsage({
    serverAuth: true,
    clientAuth: true
})
```
- Defined in packages/pki-lite/src/core/builders/CertificateRequestBuilder.ts:166

addExtension

addExtension(extension: Extension): this
Adds an extension to the CSR. Extensions are included in the extensionRequest attribute.
Parameters
- extension: Extension
  The extension to add
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateRequestBuilder.ts:91

addExtensions

addExtensions(...extensions: Extension[]): this
Adds multiple extensions to the CSR.
Parameters
- ...extensions: Extension[]
  Array of extensions to add
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateRequestBuilder.ts:102

addKeyUsage

addKeyUsage(options: KeyUsageOptions): this
Adds a Key Usage extension to the CSR.
Parameters
- options: KeyUsageOptions
  Key usage flags
Returns this
This builder for chaining
Example
```
builder.addKeyUsage({
    digitalSignature: true,
    keyEncipherment: true
})
```
- Defined in packages/pki-lite/src/core/builders/CertificateRequestBuilder.ts:120

addSubjectAltName

addSubjectAltName(...altNames: (string | GeneralName)[]): this
Adds a Subject Alternative Name extension to the CSR. Strings are automatically converted to DNS names.
Parameters
- ...altNames: (string | GeneralName)[]
  Alternative names for the subject (strings or GeneralName objects)
Returns this
This builder for chaining
Example
```
// Simple DNS names as strings
builder.addSubjectAltName('example.com', '*.example.com')

// Or use GeneralName objects for other types
builder.addSubjectAltName(
    new GeneralName.dNSName({ value: 'example.com' }),
    new GeneralName.rfc822Name({ value: 'admin@example.com' })
)
```
- Defined in packages/pki-lite/src/core/builders/CertificateRequestBuilder.ts:143

build

build(): Promise<CertificateRequest>
Builds and signs the certificate signing request.

Returns Promise<CertificateRequest>
Promise resolving to the signed CSR

Throws
Error if required fields are missing
Implementation of AsyncBuilder.build
- Defined in packages/pki-lite/src/core/builders/CertificateRequestBuilder.ts:222

setAlgorithm

setAlgorithm(
    algorithm:
        | SignatureAlgorithmIdentifier
        | AsymmetricEncryptionAlgorithmParams,
): this
Sets the signature algorithm.
Parameters
- algorithm: SignatureAlgorithmIdentifier | AsymmetricEncryptionAlgorithmParams
  Algorithm parameters or SignatureAlgorithmIdentifier
Returns this
This builder for chaining
Example
```
// Using algorithm parameters
builder.setAlgorithm({
    type: 'ECDSA',
    params: { namedCurve: 'P-256', hash: 'SHA-256' }
})
```
- Defined in packages/pki-lite/src/core/builders/CertificateRequestBuilder.ts:191

setPrivateKey

setPrivateKey(privateKey: PrivateKeyInfo): this
Sets the private key for signing the CSR.
Parameters
- privateKey: PrivateKeyInfo
  The private key
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateRequestBuilder.ts:79

setPublicKey

setPublicKey(publicKey: SubjectPublicKeyInfo): this
Sets the subject's public key.
Parameters
- publicKey: SubjectPublicKeyInfo
  The subject's public key
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateRequestBuilder.ts:68

setSubject

setSubject(subject: string | RDNSequence): this
Sets the subject distinguished name for the CSR.
Parameters
- subject: string | RDNSequence
  Subject DN as string or Name object
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/CertificateRequestBuilder.ts:56

Class CertificateRequestBuilder

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Returns CertificateRequestBuilder

Methods

addExtendedKeyUsage

Parameters

Returns this

Example

addExtension

Parameters

Returns this

addExtensions

Parameters

Returns this

addKeyUsage

Parameters

Returns this

Example

addSubjectAltName

Parameters

Returns this

Example

build

Returns Promise<CertificateRequest>

Throws

setAlgorithm

Parameters

Returns this

Example

setPrivateKey

Parameters

Returns this

setPublicKey

Parameters

Returns this

setSubject

Parameters

Returns this

Settings

On This Page