Class TimeStampReq

Time-Stamp Request structure for RFC 3161 Time-Stamp Protocol.

A TimeStampReq is sent to a Time Stamping Authority (TSA) to request a timestamp for data. The request contains a hash of the data to be timestamped (MessageImprint) along with optional parameters like policy requirements and nonce for replay protection.

Asn

TimeStampReq ::= SEQUENCE { version INTEGER { v1(1) }, messageImprint MessageImprint, reqPolicy TSAPolicyId OPTIONAL, nonce TSANonce OPTIONAL, certReq BOOLEAN DEFAULT FALSE, extensions [0] IMPLICIT Extensions OPTIONAL }

TSAPolicyId ::= OBJECT IDENTIFIER TSANonce ::= INTEGER

Example

// Create a timestamp request for some data
const data = new TextEncoder().encode("Important document")
const algorithm = AlgorithmIdentifier.digestAlgorithm('SHA-256')

const messageImprint = new MessageImprint({
    hashAlgorithm: algorithm,
    hashedMessage: new Uint8Array(await algorithm.digest(data))
})

const tsReq = new TimeStampReq({
    version: 1,
    messageImprint: messageImprint,
    reqPolicy: "1.3.6.1.4.1.123.456.1", // TSA policy OID
    nonce: crypto.getRandomValues(new Uint8Array(16)),
    certReq: true // Request TSA certificate in response
})

// Send to TSA
const tsResp = await tsReq.request({
    url: 'http://timestamp.example.com/tsa',
    timeout: 30000
})

See

RFC 3161 Section 2.4.1 - TSAReq Structure

Hierarchy (View Summary)

PkiBase<TimeStampReq>
- TimeStampReq

Index

Constructors

constructor

new TimeStampReq(
    options: {
        certReq?: boolean;
        extensions?: Extension[];
        messageImprint: MessageImprint;
        nonce?: Uint8Array<ArrayBufferLike>;
        reqPolicy?: ObjectIdentifierString;
        version?: number;
    },
): TimeStampReq
Creates a new TimeStampReq instance.
Parameters
- options: {
      certReq?: boolean;
      extensions?: Extension[];
      messageImprint: MessageImprint;
      nonce?: Uint8Array<ArrayBufferLike>;
      reqPolicy?: ObjectIdentifierString;
      version?: number;
  }
  Configuration object for the timestamp request
  - OptionalcertReq?: boolean
    Whether to request the TSA certificate
  - Optionalextensions?: Extension[]
    Optional request extensions
  - messageImprint: MessageImprint
    Hash imprint of the data to timestamp
  - Optionalnonce?: Uint8Array<ArrayBufferLike>
    Optional nonce for replay protection
  - OptionalreqPolicy?: ObjectIdentifierString
    Optional TSA policy OID
  - Optionalversion?: number
    Protocol version, defaults to 1
Returns TimeStampReq
Example
```
const request = new TimeStampReq({
    messageImprint: messageImprint,
    reqPolicy: "1.3.6.1.4.1.123.456.1",
    nonce: crypto.getRandomValues(new Uint8Array(8)),
    certReq: true
})
```
Overrides PkiBase.constructor
- Defined in packages/pki-lite/src/timestamp/TimeStampReq.ts:100

Properties

certReq

certReq: boolean = false

Whether to include the TSA certificate in the response

`Optional`extensions

extensions?: Extension[]

Optional extensions for additional functionality

messageImprint

messageImprint: MessageImprint

Hash of the data to be timestamped

`Optional`nonce

nonce?: Uint8Array<ArrayBufferLike>

Optional nonce for replay protection, should be unique per request

`Optional`reqPolicy

reqPolicy?: ObjectIdentifier

Optional TSA policy identifier specifying how the timestamp should be created

version

version: number

Version of the TSA request format, currently always 1

Accessors

pemHeader

get pemHeader(): string
Gets the PEM header name for this object type. Converts the class name to uppercase for use in PEM encoding.

Returns string
Inherited from PkiBase.pemHeader
- Defined in packages/pki-lite/src/core/PkiBase.ts:60

pkiType

get pkiType(): string
Gets the PKI type name for this object (typically the class name). Used for PEM headers and debugging output.

Returns string
Inherited from PkiBase.pkiType
- Defined in packages/pki-lite/src/core/PkiBase.ts:52

Methods

equals

equals(other: PkiBase<any>): boolean
Compares this PKI object with another for equality. Two objects are considered equal if their DER encodings are identical.
Parameters
- other: PkiBase<any>
  The other PKI object to compare with
Returns boolean
true if the objects are equal, false otherwise
Inherited from PkiBase.equals
- Defined in packages/pki-lite/src/core/PkiBase.ts:122

parseAs

parseAs<T>(type: ParseableAsn1<T>): T
Parses this object as a different PKI type. Useful for converting between related PKI structures.
Type Parameters
- T
  The target type to parse as
Parameters
- type: ParseableAsn1<T>
  The target type constructor with parsing capabilities
Returns T
A new instance of the target type
Inherited from PkiBase.parseAs
- Defined in packages/pki-lite/src/core/PkiBase.ts:134

request

request(
    options: {
        otherRequestOptions?: RequestInit;
        password?: string;
        timeout?: number;
        url: string;
        username?: string;
    },
): Promise<TimeStampResp>
Sends the timestamp request to a Time Stamping Authority (TSA).

This method handles the HTTP protocol for communicating with RFC 3161 compliant TSA servers. It sends the request as application/timestamp-query and expects an application/timestamp-reply response.
Parameters
- options: {
      otherRequestOptions?: RequestInit;
      password?: string;
      timeout?: number;
      url: string;
      username?: string;
  }
  Request configuration
  - OptionalotherRequestOptions?: RequestInit
    Additional fetch options
  - Optionalpassword?: string
    Optional basic auth password
  - Optionaltimeout?: number
    Optional request timeout in milliseconds
  - url: string
    TSA server URL
  - Optionalusername?: string
    Optional basic auth username
Returns Promise<TimeStampResp>
Promise resolving to the timestamp response
Throws
Error if the HTTP request fails or TSA returns an error
Example
```
// Simple request to public TSA
const response = await tsReq.request({
    url: 'http://timestamp.digicert.com'
})

// Authenticated request with timeout
const response = await tsReq.request({
    url: 'https://tsa.example.com/tsa',
    username: 'user',
    password: 'pass',
    timeout: 30000
})

if (response.status.status === 0) { // Granted
    console.log('Timestamp obtained:', response.timeStampToken)
} else {
    console.error('Timestamp request failed:', response.status.failInfo)
}
```
- Defined in packages/pki-lite/src/timestamp/TimeStampReq.ts:326

toAsn1

toAsn1(): Asn1BaseBlock
Converts the TimeStampReq to its ASN.1 representation.

Creates a SEQUENCE containing all the request fields in the proper order according to RFC 3161 specification.

Returns Asn1BaseBlock
ASN.1 structure representing the timestamp request
Example
```
const asn1 = tsReq.toAsn1()
const der = asn1.toBER(false) // Convert to DER for transmission
```
Overrides PkiBase.toAsn1
- Defined in packages/pki-lite/src/timestamp/TimeStampReq.ts:141

toDer

toDer(): Uint8Array
Converts this PKI object to DER (Distinguished Encoding Rules) format.

Returns Uint8Array
The DER-encoded bytes of this object
Inherited from PkiBase.toDer
- Defined in packages/pki-lite/src/core/PkiBase.ts:100

toHumanString

toHumanString(): string
Returns a human-readable string representation of this object. By default, returns the same as toString(), but subclasses can override for more user-friendly output.

Returns string
A human-readable string representation
Inherited from PkiBase.toHumanString
- Defined in packages/pki-lite/src/core/PkiBase.ts:90

toJSON

toJSON(): ToJson<T>
Converts this object to a JSON representation.

Returns ToJson<T>
A JSON-serializable representation of this object
Inherited from PkiBase.toJSON
- Defined in packages/pki-lite/src/core/PkiBase.ts:69

toPem

toPem(): string
Converts this PKI object to PEM (Privacy-Enhanced Mail) format.

Returns string
A PEM-encoded string with appropriate headers
Inherited from PkiBase.toPem
- Defined in packages/pki-lite/src/core/PkiBase.ts:109

toString

toString(): string
Returns a string representation of this PKI object. Includes the type name and ASN.1 structure.

Returns string
A string representation for debugging
Inherited from PkiBase.toString
- Defined in packages/pki-lite/src/core/PkiBase.ts:79

`Static`create

create(
    options: {
        certReq?: boolean;
        extensions?: Extension[];
        messageImprint: MessageImprint;
        nonce?: Uint8Array<ArrayBufferLike>;
        reqPolicy?: ObjectIdentifierString;
        version?: number;
    },
): TimeStampReq
Creates a TimeStampReq with the specified options.

Alternative constructor method that provides more explicit parameter naming.
Parameters
- options: {
      certReq?: boolean;
      extensions?: Extension[];
      messageImprint: MessageImprint;
      nonce?: Uint8Array<ArrayBufferLike>;
      reqPolicy?: ObjectIdentifierString;
      version?: number;
  }
  Request configuration
Returns TimeStampReq
A new TimeStampReq instance
Example
```
const request = TimeStampReq.create({
    messageImprint: messageImprint,
    reqPolicy: "1.3.6.1.4.1.123.456.1",
    nonce: crypto.getRandomValues(new Uint8Array(16)),
    certReq: true
})
```
- Defined in packages/pki-lite/src/timestamp/TimeStampReq.ts:402

`Static`fromAsn1

fromAsn1(asn1: Asn1BaseBlock): TimeStampReq
Creates a TimeStampReq from an ASN.1 structure.

Parses the ASN.1 SEQUENCE and extracts all optional and required fields according to RFC 3161 specification.
Parameters
- asn1: Asn1BaseBlock
  The ASN.1 structure to parse
Returns TimeStampReq
The parsed TimeStampReq object
Throws
Asn1ParseError if the ASN.1 structure is invalid
Example
```
const asn1 = derToAsn1(requestBytes)
const request = TimeStampReq.fromAsn1(asn1)

console.log(request.version) // Should be 1
console.log(request.messageImprint.hashAlgorithm)
console.log(request.certReq) // Certificate requested
```
- Defined in packages/pki-lite/src/timestamp/TimeStampReq.ts:203

`Static`fromDer

fromDer(der: Uint8Array): TimeStampReq
Creates a TimeStampReq from DER-encoded bytes.
Parameters
- der: Uint8Array
  The DER-encoded timestamp request bytes
Returns TimeStampReq
The parsed TimeStampReq

Throws
Error if DER parsing fails
- Defined in packages/pki-lite/src/timestamp/TimeStampReq.ts:284

`Static`fromMessageImprint

fromMessageImprint(messageImprint: MessageImprint): TimeStampReq
Creates a simple TimeStampReq from a MessageImprint.

Convenience method for creating a basic timestamp request with default settings.
Parameters
- messageImprint: MessageImprint
  The message imprint to timestamp
Returns TimeStampReq
A new TimeStampReq with version 1 and the given message imprint
Example
```
const request = TimeStampReq.fromMessageImprint(messageImprint)
```
- Defined in packages/pki-lite/src/timestamp/TimeStampReq.ts:380

Class TimeStampReq

Asn

Example

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalcertReq?: boolean

Optionalextensions?: Extension[]

messageImprint: MessageImprint

Optionalnonce?: Uint8Array<ArrayBufferLike>

OptionalreqPolicy?: ObjectIdentifierString

Optionalversion?: number

Returns TimeStampReq

Example

Properties

certReq

Optionalextensions

messageImprint

Optionalnonce

OptionalreqPolicy

version

Accessors

pemHeader

Returns string

pkiType

Returns string

Methods

equals

Parameters

Returns boolean

parseAs

Type Parameters

Parameters

Returns T

request

Parameters

OptionalotherRequestOptions?: RequestInit

Optionalpassword?: string

Optionaltimeout?: number

url: string

Optionalusername?: string

Returns Promise<TimeStampResp>

Throws

Example

toAsn1

Returns Asn1BaseBlock

Example

toDer

Returns Uint8Array

toHumanString

Returns string

toJSON

Returns ToJson<T>

toPem

Returns string

toString

Returns string

Staticcreate

Parameters

Returns TimeStampReq

Example

StaticfromAsn1

Parameters

Returns TimeStampReq

Throws

Example

StaticfromDer

Parameters

Returns TimeStampReq

Throws

StaticfromMessageImprint

Parameters

Returns TimeStampReq

`Optional`certReq?: boolean

`Optional`extensions?: Extension[]

`Optional`nonce?: Uint8Array<ArrayBufferLike>

`Optional`reqPolicy?: ObjectIdentifierString

`Optional`version?: number

`Optional`extensions

`Optional`nonce

`Optional`reqPolicy

`Optional`otherRequestOptions?: RequestInit

`Optional`password?: string

`Optional`timeout?: number

`Optional`username?: string

`Static`create

`Static`fromAsn1

`Static`fromDer

`Static`fromMessageImprint