@smithy/signature-v4 5.3.12 → 5.3.13

package/dist-cjs/index.js

@@ -186,6 +186,19 @@ class HeaderFormatter {
         }
     }
 }
+var HEADER_VALUE_TYPE;
+(function (HEADER_VALUE_TYPE) {
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["boolTrue"] = 0] = "boolTrue";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["boolFalse"] = 1] = "boolFalse";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["byte"] = 2] = "byte";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["short"] = 3] = "short";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["integer"] = 4] = "integer";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["long"] = 5] = "long";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["byteArray"] = 6] = "byteArray";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["string"] = 7] = "string";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["timestamp"] = 8] = "timestamp";
+    HEADER_VALUE_TYPE[HEADER_VALUE_TYPE["uuid"] = 9] = "uuid";
+})(HEADER_VALUE_TYPE || (HEADER_VALUE_TYPE = {}));
 const UUID_PATTERN = /^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/;
 class Int64 {
     bytes;

package/package.json

@@ -1,21 +1,20 @@
 {
   "name": "@smithy/signature-v4",
-  "version": "5.3.12",
+  "version": "5.3.13",
   "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:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
-    "build:cjs": "node ../../scripts/inline signature-v4",
-    "build:es": "yarn g:tsc -p tsconfig.es.json",
+    "build": "concurrently 'yarn:build:types' 'yarn:build:es:cjs'",
+    "build:es:cjs": "yarn g:tsc -p tsconfig.es.json && node ../../scripts/inline signature-v4",
     "build:types": "yarn g:tsc -p tsconfig.types.json",
     "build:types:downlevel": "premove dist-types/ts3.4 && downlevel-dts dist-types dist-types/ts3.4",
-    "stage-release": "premove .release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz",
     "clean": "premove dist-cjs dist-es dist-types tsconfig.cjs.tsbuildinfo tsconfig.es.tsbuildinfo tsconfig.types.tsbuildinfo",
-    "lint": "eslint -c ../../.eslintrc.js \"src/**/*.ts\"",
-    "format": "prettier --config ../../prettier.config.js --ignore-path ../../.prettierignore --write \"**/*.{ts,md,json}\"",
     "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"
   },
@@ -27,10 +26,10 @@
   "sideEffects": false,
   "dependencies": {
     "@smithy/is-array-buffer": "^4.2.2",
-    "@smithy/protocol-http": "^5.3.12",
-    "@smithy/types": "^4.13.1",
+    "@smithy/protocol-http": "^5.3.13",
+    "@smithy/types": "^4.14.0",
     "@smithy/util-hex-encoding": "^4.2.2",
-    "@smithy/util-middleware": "^4.2.12",
+    "@smithy/util-middleware": "^4.2.13",
     "@smithy/util-uri-escape": "^4.2.2",
     "@smithy/util-utf8": "^4.2.2",
     "tslib": "^2.6.2"

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

@@ -1,24 +0,0 @@
-import { Int64 as IInt64, MessageHeaders } from "@smithy/types";
-/**
- * @internal
- * 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 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

@@ -1,21 +0,0 @@
-import { EventSigner, EventSigningArguments, FormattedEvent, HttpRequest, MessageSigner, RequestPresigner, RequestPresigningArguments, RequestSigner, RequestSigningArguments, SignableMessage, SignedMessage, SigningArguments, StringSigner } from "@smithy/types";
-import { SignatureV4CryptoInit, SignatureV4Init } from "./SignatureV4Base";
-import { SignatureV4Base } 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: SigningArguments): Promise<SignedMessage>;
-    sign(requestToSign: HttpRequest, options?: RequestSigningArguments): Promise<HttpRequest>;
-    private signEvent;
-    signMessage(signableMessage: SignableMessage, { signingDate, signingRegion, signingService }: SigningArguments): Promise<SignedMessage>;
-    private signString;
-    private signRequest;
-    private getSignature;
-    private getSigningKey;
-}

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

@@ -1,69 +0,0 @@
-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

@@ -1,43 +0,0 @@
-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

@@ -1,30 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

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

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

@@ -1,5 +0,0 @@
-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

@@ -1,4 +0,0 @@
-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

@@ -1,11 +0,0 @@
-export * from "./SignatureV4";
-export * from "./constants";
-export { getCanonicalHeaders } from "./getCanonicalHeaders";
-export { getCanonicalQuery } from "./getCanonicalQuery";
-export { getPayloadHash } from "./getPayloadHash";
-export { moveHeadersToQuery } from "./moveHeadersToQuery";
-export { prepareRequest } from "./prepareRequest";
-export * from "./credentialDerivation";
-export { SignatureV4Init, SignatureV4CryptoInit, SignatureV4Base } from "./SignatureV4Base";
-export { hasHeader } from "./headerUtil";
-export * from "./signature-v4a-container";

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

@@ -1,10 +0,0 @@
-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

@@ -1,5 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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;
-};
-/**
- * @public
- *
- * \@smithy/signature-v4a will install the constructor in this
- * container if it's installed.
- *
- * This avoids a runtime-require being interpreted statically by bundlers.
- */
-export declare const signatureV4aContainer: {
-    SignatureV4a: null | OptionalSigV4aSigner;
-};

package/dist-types/ts3.4/suite.fixture.d.ts

@@ -1,14 +0,0 @@
-import { HttpRequest } from "@smithy/types";
-export interface TestCase {
-    name: string;
-    request: HttpRequest;
-    authorization: string;
-}
-export declare const region = "us-east-1";
-export declare const service = "service";
-export declare const credentials: {
-    accessKeyId: string;
-    secretAccessKey: string;
-};
-export declare const signingDate: Date;
-export declare const requests: Array<TestCase>;

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

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