Class TimeStampReqBuilder

Builder class for creating RFC 3161 Time-Stamp Requests.

Provides a fluent API for constructing TimeStampReq objects, including automatic hashing of input data.

Example

// Build from raw data (hash computed automatically)
const tsReq = await TimeStampReq.builder()
    .setData(documentBytes)
    .setHashAlgorithm('SHA-256')
    .setCertReq(true)
    .setNonce(crypto.getRandomValues(new Uint8Array(8)))
    .build()

// Send to TSA
const response = await tsReq.request({ url: 'https://freetsa.org/tsr' })

Implements

AsyncBuilder<TimeStampReq>

Index

Constructors

constructor

Methods

addExtension build setCertReq setData setHashAlgorithm setMessageImprint setNonce setRandomNonce setReqPolicy setVersion

Constructors

constructor

new TimeStampReqBuilder(): TimeStampReqBuilder
Returns TimeStampReqBuilder

Methods

addExtension

addExtension(extension: Extension): this
Adds a request extension.
Parameters
- extension: Extension
  The extension to add
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/TimeStampReqBuilder.ts:125

build

build(): Promise<TimeStampReq>
Builds the timestamp request, computing the message imprint hash if data was provided via setData().

Returns Promise<TimeStampReq>
Promise resolving to the TimeStampReq
Implementation of AsyncBuilder.build
- Defined in packages/pki-lite/src/core/builders/TimeStampReqBuilder.ts:147

setCertReq

setCertReq(certReq?: boolean): this
Sets whether to request the TSA certificate in the response.
Parameters
- certReq: boolean = true
  Whether to request the TSA certificate
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/TimeStampReqBuilder.ts:114

setData

setData(data: string | Uint8Array<ArrayBuffer>): this
Sets the data to be timestamped. The hash will be computed automatically during build() using the configured hash algorithm.
Parameters
- data: string | Uint8Array<ArrayBuffer>
  The data to timestamp (raw bytes or string)
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/TimeStampReqBuilder.ts:46

setHashAlgorithm

setHashAlgorithm(hash: HashAlgorithm): this
Sets the hash algorithm used to compute the message imprint. Only used when setData() is provided. Defaults to 'SHA-256'.
Parameters
- hash: HashAlgorithm
  The hash algorithm
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/TimeStampReqBuilder.ts:70

setMessageImprint

setMessageImprint(messageImprint: MessageImprint): this
Sets a pre-computed message imprint, bypassing automatic hashing.
Parameters
- messageImprint: MessageImprint
  The message imprint
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/TimeStampReqBuilder.ts:58

setNonce

setNonce(nonce: Uint8Array<ArrayBuffer>): this
Sets the nonce for replay protection.
Parameters
- nonce: Uint8Array<ArrayBuffer>
  The nonce bytes (typically 8-16 random bytes)
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/TimeStampReqBuilder.ts:92

setRandomNonce

setRandomNonce(byteLength?: number): this
Generates and sets a random nonce for replay protection.
Parameters
- byteLength: number = 8
  The length of the random nonce (default 8)
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/TimeStampReqBuilder.ts:103

setReqPolicy

setReqPolicy(policy: ObjectIdentifierString): this
Sets the requested TSA policy OID.
Parameters
- policy: ObjectIdentifierString
  The TSA policy identifier
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/TimeStampReqBuilder.ts:81

setVersion

setVersion(version: number): this
Sets the protocol version. Defaults to 1.
Parameters
- version: number
  The protocol version
Returns this
This builder for chaining
- Defined in packages/pki-lite/src/core/builders/TimeStampReqBuilder.ts:136

Class TimeStampReqBuilder

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Returns TimeStampReqBuilder

Methods

addExtension

Parameters

Returns this

build

Returns Promise<TimeStampReq>

setCertReq

Parameters

Returns this

setData

Parameters

Returns this

setHashAlgorithm

Parameters

Returns this

setMessageImprint

Parameters

Returns this

setNonce

Parameters

Returns this

setRandomNonce

Parameters

Returns this

setReqPolicy

Parameters

Returns this

setVersion

Parameters

Returns this

Settings

On This Page