@smithy/signature-v4 5.6.3 → 5.6.5

package/dist-cjs/index.js

@@ -20,27 +20,27 @@ class HeaderFormatter {
     formatHeaderValue(header) {
         switch (header.type) {
             case "boolean":
-                return Uint8Array.from([header.value ? 0 : 1]);
+                return Uint8Array.from([header.value ? HEADER_VALUE_TYPE.boolTrue : HEADER_VALUE_TYPE.boolFalse]);
             case "byte":
-                return Uint8Array.from([2, header.value]);
+                return Uint8Array.from([HEADER_VALUE_TYPE.byte, header.value]);
             case "short":
                 const shortView = new DataView(new ArrayBuffer(3));
-                shortView.setUint8(0, 3);
+                shortView.setUint8(0, HEADER_VALUE_TYPE.short);
                 shortView.setInt16(1, header.value, false);
                 return new Uint8Array(shortView.buffer);
             case "integer":
                 const intView = new DataView(new ArrayBuffer(5));
-                intView.setUint8(0, 4);
+                intView.setUint8(0, HEADER_VALUE_TYPE.integer);
                 intView.setInt32(1, header.value, false);
                 return new Uint8Array(intView.buffer);
             case "long":
                 const longBytes = new Uint8Array(9);
-                longBytes[0] = 5;
+                longBytes[0] = HEADER_VALUE_TYPE.long;
                 longBytes.set(header.value.bytes, 1);
                 return longBytes;
             case "binary":
                 const binView = new DataView(new ArrayBuffer(3 + header.value.byteLength));
-                binView.setUint8(0, 6);
+                binView.setUint8(0, HEADER_VALUE_TYPE.byteArray);
                 binView.setUint16(1, header.value.byteLength, false);
                 const binBytes = new Uint8Array(binView.buffer);
                 binBytes.set(header.value, 3);
@@ -48,14 +48,14 @@ class HeaderFormatter {
             case "string":
                 const utf8Bytes = fromUtf8(header.value);
                 const strView = new DataView(new ArrayBuffer(3 + utf8Bytes.byteLength));
-                strView.setUint8(0, 7);
+                strView.setUint8(0, HEADER_VALUE_TYPE.string);
                 strView.setUint16(1, utf8Bytes.byteLength, false);
                 const strBytes = new Uint8Array(strView.buffer);
                 strBytes.set(utf8Bytes, 3);
                 return strBytes;
             case "timestamp":
                 const tsBytes = new Uint8Array(9);
-                tsBytes[0] = 8;
+                tsBytes[0] = HEADER_VALUE_TYPE.timestamp;
                 tsBytes.set(Int64.fromNumber(header.value.valueOf()).bytes, 1);
                 return tsBytes;
             case "uuid":
@@ -63,8 +63,8 @@ class HeaderFormatter {
                     throw new Error(`Invalid UUID received: ${header.value}`);
                 }
                 const uuidBytes = new Uint8Array(17);
-                uuidBytes[0] = 9;
-                uuidBytes.set(fromHex(header.value.replace(/\-/g, "")), 1);
+                uuidBytes[0] = HEADER_VALUE_TYPE.uuid;
+                uuidBytes.set(fromHex(header.value.replace(/-/g, "")), 1);
                 return uuidBytes;
         }
     }
@@ -278,7 +278,7 @@ ${toHex(hashedRequest)}`;
         }
     }
     formatDate(now) {
-        const longDate = iso8601(now).replace(/[\-:]/g, "");
+        const longDate = iso8601(now).replace(/[-:]/g, "");
         return {
             longDate,
             shortDate: longDate.slice(0, 8),

package/dist-es/HeaderFormatter.js

@@ -17,27 +17,27 @@ export class HeaderFormatter {
     formatHeaderValue(header) {
         switch (header.type) {
             case "boolean":
-                return Uint8Array.from([header.value ? 0 : 1]);
+                return Uint8Array.from([header.value ? HEADER_VALUE_TYPE.boolTrue : HEADER_VALUE_TYPE.boolFalse]);
             case "byte":
-                return Uint8Array.from([2, header.value]);
+                return Uint8Array.from([HEADER_VALUE_TYPE.byte, header.value]);
             case "short":
                 const shortView = new DataView(new ArrayBuffer(3));
-                shortView.setUint8(0, 3);
+                shortView.setUint8(0, HEADER_VALUE_TYPE.short);
                 shortView.setInt16(1, header.value, false);
                 return new Uint8Array(shortView.buffer);
             case "integer":
                 const intView = new DataView(new ArrayBuffer(5));
-                intView.setUint8(0, 4);
+                intView.setUint8(0, HEADER_VALUE_TYPE.integer);
                 intView.setInt32(1, header.value, false);
                 return new Uint8Array(intView.buffer);
             case "long":
                 const longBytes = new Uint8Array(9);
-                longBytes[0] = 5;
+                longBytes[0] = HEADER_VALUE_TYPE.long;
                 longBytes.set(header.value.bytes, 1);
                 return longBytes;
             case "binary":
                 const binView = new DataView(new ArrayBuffer(3 + header.value.byteLength));
-                binView.setUint8(0, 6);
+                binView.setUint8(0, HEADER_VALUE_TYPE.byteArray);
                 binView.setUint16(1, header.value.byteLength, false);
                 const binBytes = new Uint8Array(binView.buffer);
                 binBytes.set(header.value, 3);
@@ -45,14 +45,14 @@ export class HeaderFormatter {
             case "string":
                 const utf8Bytes = fromUtf8(header.value);
                 const strView = new DataView(new ArrayBuffer(3 + utf8Bytes.byteLength));
-                strView.setUint8(0, 7);
+                strView.setUint8(0, HEADER_VALUE_TYPE.string);
                 strView.setUint16(1, utf8Bytes.byteLength, false);
                 const strBytes = new Uint8Array(strView.buffer);
                 strBytes.set(utf8Bytes, 3);
                 return strBytes;
             case "timestamp":
                 const tsBytes = new Uint8Array(9);
-                tsBytes[0] = 8;
+                tsBytes[0] = HEADER_VALUE_TYPE.timestamp;
                 tsBytes.set(Int64.fromNumber(header.value.valueOf()).bytes, 1);
                 return tsBytes;
             case "uuid":
@@ -60,8 +60,8 @@ export class HeaderFormatter {
                     throw new Error(`Invalid UUID received: ${header.value}`);
                 }
                 const uuidBytes = new Uint8Array(17);
-                uuidBytes[0] = 9;
-                uuidBytes.set(fromHex(header.value.replace(/\-/g, "")), 1);
+                uuidBytes[0] = HEADER_VALUE_TYPE.uuid;
+                uuidBytes.set(fromHex(header.value.replace(/-/g, "")), 1);
                 return uuidBytes;
         }
     }

package/dist-es/SignatureV4Base.js

@@ -66,7 +66,7 @@ ${toHex(hashedRequest)}`;
         }
     }
     formatDate(now) {
-        const longDate = iso8601(now).replace(/[\-:]/g, "");
+        const longDate = iso8601(now).replace(/[-:]/g, "");
         return {
             longDate,
             shortDate: longDate.slice(0, 8),

package/dist-types/ts3.4/HeaderFormatter.d.ts

@@ -0,0 +1,25 @@
+import { Int64 as IInt64, MessageHeaders } from "@smithy/types";
+/**
+ * TODO: duplicated from @smithy/eventstream-codec to break large dependency.
+ * TODO: This should be moved to its own deduped submodule in @smithy/core when submodules are implemented.
+ *
+ * @internal
+ */
+export declare class HeaderFormatter {
+    format(headers: MessageHeaders): Uint8Array;
+    private formatHeaderValue;
+}
+/**
+ * TODO: duplicated from @smithy/eventstream-codec to break large dependency.
+ * TODO: This should be moved to its own deduped submodule in @smithy/core when submodules are implemented.
+ */
+export declare class Int64 implements IInt64 {
+    readonly bytes: Uint8Array;
+    constructor(bytes: Uint8Array);
+    static fromNumber(number: number): Int64;
+    /**
+     * Called implicitly by infix arithmetic operators.
+     */
+    valueOf(): number;
+    toString(): string;
+}

package/dist-types/ts3.4/SignatureV4.d.ts

@@ -0,0 +1,20 @@
+import { EventSigner, EventSigningArguments, FormattedEvent, HttpRequest, MessageSigner, MessageSigningArguments, RequestPresigner, RequestPresigningArguments, RequestSigner, RequestSigningArguments, SignableMessage, SignedMessage, SigningArguments, StringSigner } from "@smithy/types";
+import { SignatureV4Base, SignatureV4CryptoInit, SignatureV4Init } from "./SignatureV4Base";
+/**
+ * @public
+ */
+export declare class SignatureV4 extends SignatureV4Base implements RequestPresigner, RequestSigner, StringSigner, EventSigner, MessageSigner {
+    private readonly headerFormatter;
+    constructor({ applyChecksum, credentials, region, service, sha256, uriEscapePath, }: SignatureV4Init & SignatureV4CryptoInit);
+    presign(originalRequest: HttpRequest, options?: RequestPresigningArguments): Promise<HttpRequest>;
+    sign(stringToSign: string, options?: SigningArguments): Promise<string>;
+    sign(event: FormattedEvent, options: EventSigningArguments): Promise<string>;
+    sign(event: SignableMessage, options: MessageSigningArguments): Promise<SignedMessage>;
+    sign(requestToSign: HttpRequest, options?: RequestSigningArguments): Promise<HttpRequest>;
+    private signEvent;
+    signMessage(signableMessage: SignableMessage, { signingDate, signingRegion, signingService, eventStreamCredentials }: MessageSigningArguments): Promise<SignedMessage>;
+    private signString;
+    private signRequest;
+    private getSignature;
+    private getSigningKey;
+}

package/dist-types/ts3.4/SignatureV4Base.d.ts

@@ -0,0 +1,69 @@
+import { AwsCredentialIdentity, ChecksumConstructor, DateInput, HashConstructor, HeaderBag, HttpRequest, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface SignatureV4Init {
+    /**
+     * The service signing name.
+     */
+    service: string;
+    /**
+     * The region name or a function that returns a promise that will be
+     * resolved with the region name.
+     */
+    region: string | Provider<string>;
+    /**
+     * The credentials with which the request should be signed or a function
+     * that returns a promise that will be resolved with credentials.
+     */
+    credentials: AwsCredentialIdentity | Provider<AwsCredentialIdentity>;
+    /**
+     * A constructor function for a hash object that will calculate SHA-256 HMAC
+     * checksums.
+     */
+    sha256?: ChecksumConstructor | HashConstructor;
+    /**
+     * Whether to uri-escape the request URI path as part of computing the
+     * canonical request string. This is required for every AWS service, except
+     * Amazon S3, as of late 2017.
+     *
+     * @default [true]
+     */
+    uriEscapePath?: boolean;
+    /**
+     * Whether to calculate a checksum of the request body and include it as
+     * either a request header (when signing) or as a query string parameter
+     * (when presigning). This is required for AWS Glacier and Amazon S3 and optional for
+     * every other AWS service as of late 2017.
+     *
+     * @default [true]
+     */
+    applyChecksum?: boolean;
+}
+/**
+ * @public
+ */
+export interface SignatureV4CryptoInit {
+    sha256: ChecksumConstructor | HashConstructor;
+}
+/**
+ * @internal
+ */
+export declare abstract class SignatureV4Base {
+    protected readonly service: string;
+    protected readonly regionProvider: Provider<string>;
+    protected readonly credentialProvider: Provider<AwsCredentialIdentity>;
+    protected readonly sha256: ChecksumConstructor | HashConstructor;
+    private readonly uriEscapePath;
+    protected readonly applyChecksum: boolean;
+    protected constructor({ applyChecksum, credentials, region, service, sha256, uriEscapePath, }: SignatureV4Init & SignatureV4CryptoInit);
+    protected createCanonicalRequest(request: HttpRequest, canonicalHeaders: HeaderBag, payloadHash: string): string;
+    protected createStringToSign(longDate: string, credentialScope: string, canonicalRequest: string, algorithmIdentifier: string): Promise<string>;
+    private getCanonicalPath;
+    protected validateResolvedCredentials(credentials: unknown): void;
+    protected formatDate(now: DateInput): {
+        longDate: string;
+        shortDate: string;
+    };
+    protected getCanonicalHeaderList(headers: object): string;
+}

package/dist-types/ts3.4/constants.d.ts

@@ -0,0 +1,43 @@
+export declare const ALGORITHM_QUERY_PARAM = "X-Amz-Algorithm";
+export declare const CREDENTIAL_QUERY_PARAM = "X-Amz-Credential";
+export declare const AMZ_DATE_QUERY_PARAM = "X-Amz-Date";
+export declare const SIGNED_HEADERS_QUERY_PARAM = "X-Amz-SignedHeaders";
+export declare const EXPIRES_QUERY_PARAM = "X-Amz-Expires";
+export declare const SIGNATURE_QUERY_PARAM = "X-Amz-Signature";
+export declare const TOKEN_QUERY_PARAM = "X-Amz-Security-Token";
+export declare const REGION_SET_PARAM = "X-Amz-Region-Set";
+export declare const AUTH_HEADER = "authorization";
+export declare const AMZ_DATE_HEADER: string;
+export declare const DATE_HEADER = "date";
+export declare const GENERATED_HEADERS: string[];
+export declare const SIGNATURE_HEADER: string;
+export declare const SHA256_HEADER = "x-amz-content-sha256";
+export declare const TOKEN_HEADER: string;
+export declare const HOST_HEADER = "host";
+export declare const ALWAYS_UNSIGNABLE_HEADERS: {
+    authorization: boolean;
+    "cache-control": boolean;
+    connection: boolean;
+    expect: boolean;
+    from: boolean;
+    "keep-alive": boolean;
+    "max-forwards": boolean;
+    pragma: boolean;
+    referer: boolean;
+    te: boolean;
+    trailer: boolean;
+    "transfer-encoding": boolean;
+    upgrade: boolean;
+    "user-agent": boolean;
+    "x-amzn-trace-id": boolean;
+};
+export declare const PROXY_HEADER_PATTERN: RegExp;
+export declare const SEC_HEADER_PATTERN: RegExp;
+export declare const UNSIGNABLE_PATTERNS: RegExp[];
+export declare const ALGORITHM_IDENTIFIER = "AWS4-HMAC-SHA256";
+export declare const ALGORITHM_IDENTIFIER_V4A = "AWS4-ECDSA-P256-SHA256";
+export declare const EVENT_ALGORITHM_IDENTIFIER = "AWS4-HMAC-SHA256-PAYLOAD";
+export declare const UNSIGNED_PAYLOAD = "UNSIGNED-PAYLOAD";
+export declare const MAX_CACHE_SIZE = 50;
+export declare const KEY_TYPE_IDENTIFIER = "aws4_request";
+export declare const MAX_PRESIGNED_TTL: number;

package/dist-types/ts3.4/credentialDerivation.d.ts

@@ -0,0 +1,30 @@
+import { AwsCredentialIdentity, ChecksumConstructor, HashConstructor } from "@smithy/types";
+/**
+ * Create a string describing the scope of credentials used to sign a request.
+ *
+ * @internal
+ *
+ * @param shortDate - the current calendar date in the form YYYYMMDD.
+ * @param region    - the AWS region in which the service resides.
+ * @param service   - the service to which the signed request is being sent.
+ */
+export declare const createScope: (shortDate: string, region: string, service: string) => string;
+/**
+ * Derive a signing key from its composite parts.
+ *
+ * @internal
+ *
+ * @param sha256Constructor - a constructor function that can instantiate SHA-256
+ *                          hash objects.
+ * @param credentials       - the credentials with which the request will be
+ *                          signed.
+ * @param shortDate         - the current calendar date in the form YYYYMMDD.
+ * @param region            - the AWS region in which the service resides.
+ * @param service           - the service to which the signed request is being
+ *                          sent.
+ */
+export declare const getSigningKey: (sha256Constructor: ChecksumConstructor | HashConstructor, credentials: AwsCredentialIdentity, shortDate: string, region: string, service: string) => Promise<Uint8Array>;
+/**
+ * @internal
+ */
+export declare const clearCredentialCache: () => void;

package/dist-types/ts3.4/getCanonicalHeaders.d.ts

@@ -0,0 +1,5 @@
+import { HeaderBag, HttpRequest } from "@smithy/types";
+/**
+ * @internal
+ */
+export declare const getCanonicalHeaders: ({ headers }: HttpRequest, unsignableHeaders?: Set<string>, signableHeaders?: Set<string>) => HeaderBag;

package/dist-types/ts3.4/getCanonicalQuery.d.ts

@@ -0,0 +1,5 @@
+import { HttpRequest } from "@smithy/types";
+/**
+ * @internal
+ */
+export declare const getCanonicalQuery: ({ query }: HttpRequest) => string;

package/dist-types/ts3.4/getPayloadHash.d.ts

@@ -0,0 +1,5 @@
+import { ChecksumConstructor, HashConstructor, HttpRequest } from "@smithy/types";
+/**
+ * @internal
+ */
+export declare const getPayloadHash: ({ headers, body }: HttpRequest, hashConstructor: ChecksumConstructor | HashConstructor) => Promise<string>;

package/dist-types/ts3.4/headerUtil.d.ts

@@ -0,0 +1,4 @@
+import { HeaderBag } from "@smithy/types";
+export declare const hasHeader: (soughtHeader: string, headers: HeaderBag) => boolean;
+export declare const getHeaderValue: (soughtHeader: string, headers: HeaderBag) => string | undefined;
+export declare const deleteHeader: (soughtHeader: string, headers: HeaderBag) => void;

package/dist-types/ts3.4/index.d.ts

@@ -0,0 +1,12 @@
+export { SignatureV4 } from "./SignatureV4";
+export { ALGORITHM_IDENTIFIER, ALGORITHM_IDENTIFIER_V4A, ALGORITHM_QUERY_PARAM, ALWAYS_UNSIGNABLE_HEADERS, AMZ_DATE_HEADER, AMZ_DATE_QUERY_PARAM, AUTH_HEADER, CREDENTIAL_QUERY_PARAM, DATE_HEADER, EVENT_ALGORITHM_IDENTIFIER, EXPIRES_QUERY_PARAM, GENERATED_HEADERS, HOST_HEADER, KEY_TYPE_IDENTIFIER, MAX_CACHE_SIZE, MAX_PRESIGNED_TTL, PROXY_HEADER_PATTERN, REGION_SET_PARAM, SEC_HEADER_PATTERN, SHA256_HEADER, SIGNATURE_HEADER, SIGNATURE_QUERY_PARAM, SIGNED_HEADERS_QUERY_PARAM, TOKEN_HEADER, TOKEN_QUERY_PARAM, UNSIGNABLE_PATTERNS, UNSIGNED_PAYLOAD, } from "./constants";
+export { getCanonicalHeaders } from "./getCanonicalHeaders";
+export { getCanonicalQuery } from "./getCanonicalQuery";
+export { getPayloadHash } from "./getPayloadHash";
+export { moveHeadersToQuery } from "./moveHeadersToQuery";
+export { prepareRequest } from "./prepareRequest";
+export { clearCredentialCache, createScope, getSigningKey } from "./credentialDerivation";
+export { SignatureV4Base, SignatureV4Init, SignatureV4CryptoInit } from "./SignatureV4Base";
+export { hasHeader } from "./headerUtil";
+export { signatureV4aContainer } from "./signature-v4a-container";
+export { OptionalSigV4aSigner } from "./signature-v4a-container";

package/dist-types/ts3.4/moveHeadersToQuery.d.ts

@@ -0,0 +1,10 @@
+import { HttpRequest as IHttpRequest, QueryParameterBag } from "@smithy/types";
+/**
+ * @internal
+ */
+export declare const moveHeadersToQuery: (request: IHttpRequest, options?: {
+    unhoistableHeaders?: Set<string>;
+    hoistableHeaders?: Set<string>;
+}) => IHttpRequest & {
+    query: QueryParameterBag;
+};

package/dist-types/ts3.4/prepareRequest.d.ts

@@ -0,0 +1,5 @@
+import { HttpRequest as IHttpRequest } from "@smithy/types";
+/**
+ * @internal
+ */
+export declare const prepareRequest: (request: IHttpRequest) => IHttpRequest;

package/dist-types/ts3.4/signature-v4a-container.d.ts

@@ -0,0 +1,23 @@
+import { RequestSigner } from "@smithy/types";
+/**
+ * @public
+ */
+export type OptionalSigV4aSigner = {
+    /**
+     * This constructor is not typed so as not to require a type import
+     * from the signature-v4a package.
+     *
+     * The true type is SignatureV4a from @smithy/signature-v4a.
+     */
+    new (options: any): RequestSigner;
+};
+/**
+ * \@smithy/signature-v4a will install the constructor in this
+ * container if it's installed.
+ * This avoids a runtime-require being interpreted statically by bundlers.
+ *
+ * @public
+ */
+export declare const signatureV4aContainer: {
+    SignatureV4a: null | OptionalSigV4aSigner;
+};

package/dist-types/ts3.4/utilDate.d.ts

@@ -0,0 +1,2 @@
+export declare const iso8601: (time: number | string | Date) => string;
+export declare const toDate: (time: number | string | Date) => Date;

package/package.json

@@ -1,19 +1,17 @@
 {
   "name": "@smithy/signature-v4",
-  "version": "5.6.3",
+  "version": "5.6.5",
   "description": "A standalone implementation of the AWS Signature V4 request signing algorithm",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
   "types": "./dist-types/index.d.ts",
   "scripts": {
     "build": "concurrently 'yarn:build:types' 'yarn:build:es:cjs'",
-    "build:es:cjs": "premove dist-es && yarn g:tsc -p tsconfig.es.json && node ../../scripts/inline",
+    "build:es:cjs": "node ../../scripts/compilation/es_cjs.js",
     "build:types": "premove dist-types && yarn g:tsc -p tsconfig.types.json",
     "build:types:downlevel": "premove dist-types/ts3.4 && downlevel-dts dist-types dist-types/ts3.4",
     "clean": "premove dist-cjs dist-es dist-types",
     "extract:docs": "api-extractor run --local",
-    "format": "prettier --config ../../prettier.config.js --ignore-path ../../.prettierignore --write \"**/*.{ts,md,json}\"",
-    "lint": "eslint -c ../../.eslintrc.js \"src/**/*.ts\"",
     "stage-release": "premove .release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz",
     "test": "yarn g:vitest run",
     "test:watch": "yarn g:vitest watch"
@@ -25,8 +23,8 @@
   "license": "Apache-2.0",
   "sideEffects": false,
   "dependencies": {
-    "@smithy/core": "^3.29.2",
-    "@smithy/types": "^4.16.0",
+    "@smithy/core": "^3.29.4",
+    "@smithy/types": "^4.16.1",
     "tslib": "^2.6.2"
   },
   "devDependencies": {