Class SigV4Signer

Stateful SigV4 signer with credential caching and automatic clock skew correction. Convenience wrapper around the stateless functions.

Example

const signer = new SigV4Signer({
  credentials: envCredentials(),
  region: "us-east-1",
  service: "s3",
});
const signed = await signer.sign({ method: "GET", url: "https://s3.amazonaws.com/...", headers: {}, body: null });

Index

Constructors

constructor

Methods

sign presign signPostPolicy initChunked updateClockSkew handleClockSkewError

Constructors

constructor

new SigV4Signer(
config: Omit<SigningConfig, "signingDate" | "clockSkewSecs">,
): SigV4Signer
Parameters
- config: Omit<SigningConfig, "signingDate" | "clockSkewSecs">
  Signing configuration (signingDate and clockSkewSecs are managed internally)
Returns SigV4Signer
- Defined in src/aws-sigv4.ts:1119

Methods

sign

sign(request: SignableRequest): Promise<SignedRequest>
Sign a request with the current configuration and accumulated clock skew.
Parameters
- request: SignableRequest
  The request to sign
Returns Promise<SignedRequest>
Signed request with Authorization and x-amz-* headers populated
- Defined in src/aws-sigv4.ts:1127

presign

presign(request: SignableRequest, options?: PresignOptions): Promise<string>
Generate a presigned URL for a request.
Parameters
- request: SignableRequest
  The request to presign
- Optionaloptions: PresignOptions
  Presigning options (expiry, extra params)
Returns Promise<string>
Presigned URL string with query-string auth params
- Defined in src/aws-sigv4.ts:1141

signPostPolicy

signPostPolicy(policy: S3PostPolicy): Promise<S3PostSignature>
Sign an S3 POST policy for browser-based uploads.
Parameters
- policy: S3PostPolicy
  The POST policy (expiration + conditions)
Returns Promise<S3PostSignature>
Form fields to include in the multipart POST
- Defined in src/aws-sigv4.ts:1158

initChunked

initChunked(
request: SignableRequest,
): Promise<{ signedRequest: SignedRequest; state: ChunkedSigningState }>
Initialize state for a chunked/streaming upload.
Parameters
- request: SignableRequest
  The base request (body will be replaced with chunks)
Returns Promise<{ signedRequest: SignedRequest; state: ChunkedSigningState }>
An object containing signedRequest (the seed request with chunked headers) and state (the initial chunked signing state for subsequent signChunk calls).
- Defined in src/aws-sigv4.ts:1179

updateClockSkew

updateClockSkew(responseHeaders: Record<string, string>): void
Update the clock skew correction based on a server response. Call this whenever you receive a clock skew error.
Parameters
- responseHeaders: Record<string, string>
Returns void
- Defined in src/aws-sigv4.ts:1195

handleClockSkewError

handleClockSkewError(
    status: number,
    body: string,
    responseHeaders: Record<string, string>,
): boolean
Check if a response is a clock skew error and auto-correct. Returns true if the skew was detected and updated (caller should retry).
Parameters
- status: number
- body: string
- responseHeaders: Record<string, string>
Returns boolean
- Defined in src/aws-sigv4.ts:1204

Class SigV4Signer

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SigV4Signer

Methods

sign

Parameters

Returns Promise<SignedRequest>

presign

Parameters

Returns Promise<string>

signPostPolicy

Parameters

Returns Promise<S3PostSignature>

initChunked

Parameters

Returns Promise<{ signedRequest: SignedRequest; state: ChunkedSigningState }>

updateClockSkew

Parameters

Returns void

handleClockSkewError

Parameters

Returns boolean

Settings

On This Page