@smithy/experimental-identity-and-auth 0.0.1 → 0.0.2

package/dist-cjs/SigV4Signer.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SigV4Signer = void 0;
+const signature_v4_1 = require("@smithy/signature-v4");
+class SigV4Signer {
+    async sign(httpRequest, identity, signingProperties) {
+        const clonedRequest = httpRequest.clone();
+        const signer = new signature_v4_1.SignatureV4({
+            applyChecksum: signingProperties.applyChecksum !== undefined ? signingProperties.applyChecksum : true,
+            credentials: identity,
+            region: signingProperties.region,
+            service: signingProperties.name,
+            sha256: signingProperties.sha256,
+            uriEscapePath: signingProperties.uriEscapePath !== undefined ? signingProperties.uriEscapePath : true,
+        });
+        return signer.sign(clonedRequest, {
+            signingDate: new Date(),
+            signableHeaders: signingProperties.signableHeaders,
+            unsignableHeaders: signingProperties.unsignableHeaders,
+            signingRegion: signingProperties.signingRegion,
+            signingService: signingProperties.signingService,
+        });
+    }
+}
+exports.SigV4Signer = SigV4Signer;

package/dist-cjs/apiKeyIdentity.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/httpApiKeyAuth.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpApiKeyAuthSigner = exports.HttpApiKeyAuthLocation = void 0;
+var HttpApiKeyAuthLocation;
+(function (HttpApiKeyAuthLocation) {
+    HttpApiKeyAuthLocation["HEADER"] = "header";
+    HttpApiKeyAuthLocation["QUERY"] = "query";
+})(HttpApiKeyAuthLocation = exports.HttpApiKeyAuthLocation || (exports.HttpApiKeyAuthLocation = {}));
+class HttpApiKeyAuthSigner {
+    async sign(httpRequest, identity, signingProperties) {
+        if (!signingProperties) {
+            throw new Error("request could not be signed with `apiKey` since the `name` and `in` signer properties are missing");
+        }
+        if (!signingProperties.name) {
+            throw new Error("request could not be signed with `apiKey` since the `name` signer property is missing");
+        }
+        if (!signingProperties.in) {
+            throw new Error("request could not be signed with `apiKey` since the `in` signer property is missing");
+        }
+        const clonedRequest = httpRequest.clone();
+        if (signingProperties.in === HttpApiKeyAuthLocation.QUERY) {
+            clonedRequest.query[signingProperties.name] = identity.apiKey;
+        }
+        else if (signingProperties.in === HttpApiKeyAuthLocation.HEADER) {
+            clonedRequest.headers[signingProperties.name] = signingProperties.scheme
+                ? `$${signingProperties.scheme} $${identity.apiKey}`
+                : identity.apiKey;
+        }
+        else {
+            throw new Error("request can only be signed with `apiKey` locations `query` or `header`, " +
+                "but found: `" +
+                signingProperties.in +
+                "`");
+        }
+        return clonedRequest;
+    }
+}
+exports.HttpApiKeyAuthSigner = HttpApiKeyAuthSigner;

package/dist-cjs/httpBearerAuth.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpBearerAuthSigner = void 0;
+class HttpBearerAuthSigner {
+    async sign(httpRequest, identity, signingProperties) {
+        const clonedRequest = httpRequest.clone();
+        clonedRequest.headers["Authorization"] = `Bearer ${identity.token}`;
+        return clonedRequest;
+    }
+}
+exports.HttpBearerAuthSigner = HttpBearerAuthSigner;

package/dist-cjs/index.js

@@ -4,4 +4,9 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./IdentityProviderConfiguration"), exports);
 tslib_1.__exportStar(require("./HttpAuthScheme"), exports);
 tslib_1.__exportStar(require("./HttpSigner"), exports);
+tslib_1.__exportStar(require("./SigV4Signer"), exports);
+tslib_1.__exportStar(require("./apiKeyIdentity"), exports);
+tslib_1.__exportStar(require("./httpApiKeyAuth"), exports);
+tslib_1.__exportStar(require("./httpBearerAuth"), exports);
 tslib_1.__exportStar(require("./noAuth"), exports);
+tslib_1.__exportStar(require("./tokenIdentity"), exports);

package/dist-cjs/tokenIdentity.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-es/SigV4Signer.js

@@ -0,0 +1,21 @@
+import { SignatureV4 } from "@smithy/signature-v4";
+export class SigV4Signer {
+    async sign(httpRequest, identity, signingProperties) {
+        const clonedRequest = httpRequest.clone();
+        const signer = new SignatureV4({
+            applyChecksum: signingProperties.applyChecksum !== undefined ? signingProperties.applyChecksum : true,
+            credentials: identity,
+            region: signingProperties.region,
+            service: signingProperties.name,
+            sha256: signingProperties.sha256,
+            uriEscapePath: signingProperties.uriEscapePath !== undefined ? signingProperties.uriEscapePath : true,
+        });
+        return signer.sign(clonedRequest, {
+            signingDate: new Date(),
+            signableHeaders: signingProperties.signableHeaders,
+            unsignableHeaders: signingProperties.unsignableHeaders,
+            signingRegion: signingProperties.signingRegion,
+            signingService: signingProperties.signingService,
+        });
+    }
+}

package/dist-es/apiKeyIdentity.js

@@ -0,0 +1 @@
+export {};

package/dist-es/httpApiKeyAuth.js

@@ -0,0 +1,34 @@
+export var HttpApiKeyAuthLocation;
+(function (HttpApiKeyAuthLocation) {
+    HttpApiKeyAuthLocation["HEADER"] = "header";
+    HttpApiKeyAuthLocation["QUERY"] = "query";
+})(HttpApiKeyAuthLocation || (HttpApiKeyAuthLocation = {}));
+export class HttpApiKeyAuthSigner {
+    async sign(httpRequest, identity, signingProperties) {
+        if (!signingProperties) {
+            throw new Error("request could not be signed with `apiKey` since the `name` and `in` signer properties are missing");
+        }
+        if (!signingProperties.name) {
+            throw new Error("request could not be signed with `apiKey` since the `name` signer property is missing");
+        }
+        if (!signingProperties.in) {
+            throw new Error("request could not be signed with `apiKey` since the `in` signer property is missing");
+        }
+        const clonedRequest = httpRequest.clone();
+        if (signingProperties.in === HttpApiKeyAuthLocation.QUERY) {
+            clonedRequest.query[signingProperties.name] = identity.apiKey;
+        }
+        else if (signingProperties.in === HttpApiKeyAuthLocation.HEADER) {
+            clonedRequest.headers[signingProperties.name] = signingProperties.scheme
+                ? `$${signingProperties.scheme} $${identity.apiKey}`
+                : identity.apiKey;
+        }
+        else {
+            throw new Error("request can only be signed with `apiKey` locations `query` or `header`, " +
+                "but found: `" +
+                signingProperties.in +
+                "`");
+        }
+        return clonedRequest;
+    }
+}

package/dist-es/httpBearerAuth.js

@@ -0,0 +1,7 @@
+export class HttpBearerAuthSigner {
+    async sign(httpRequest, identity, signingProperties) {
+        const clonedRequest = httpRequest.clone();
+        clonedRequest.headers["Authorization"] = `Bearer ${identity.token}`;
+        return clonedRequest;
+    }
+}

package/dist-es/index.js

@@ -1,4 +1,9 @@
 export * from "./IdentityProviderConfiguration";
 export * from "./HttpAuthScheme";
 export * from "./HttpSigner";
+export * from "./SigV4Signer";
+export * from "./apiKeyIdentity";
+export * from "./httpApiKeyAuth";
+export * from "./httpBearerAuth";
 export * from "./noAuth";
+export * from "./tokenIdentity";

package/dist-es/tokenIdentity.js

@@ -0,0 +1 @@
+export {};

package/dist-types/SigV4Signer.d.ts

@@ -0,0 +1,9 @@
+import { HttpRequest } from "@smithy/protocol-http";
+import { AwsCredentialIdentity, HttpRequest as IHttpRequest } from "@smithy/types";
+import { HttpSigner } from "./HttpSigner";
+/**
+ * @internal
+ */
+export declare class SigV4Signer implements HttpSigner {
+    sign(httpRequest: HttpRequest, identity: AwsCredentialIdentity, signingProperties: Record<string, any>): Promise<IHttpRequest>;
+}

package/dist-types/apiKeyIdentity.d.ts

@@ -0,0 +1,11 @@
+import { Identity, IdentityProvider } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface ApiKeyIdentity extends Identity {
+    readonly apiKey: string;
+}
+/**
+ * @internal
+ */
+export type ApiKeyIdentityProvider = IdentityProvider<ApiKeyIdentity>;

package/dist-types/httpApiKeyAuth.d.ts

@@ -0,0 +1,17 @@
+import { HttpRequest } from "@smithy/protocol-http";
+import { HttpRequest as IHttpRequest } from "@smithy/types";
+import { ApiKeyIdentity } from "./apiKeyIdentity";
+import { HttpSigner } from "./HttpSigner";
+/**
+ * @internal
+ */
+export declare enum HttpApiKeyAuthLocation {
+    HEADER = "header",
+    QUERY = "query"
+}
+/**
+ * @internal
+ */
+export declare class HttpApiKeyAuthSigner implements HttpSigner {
+    sign(httpRequest: HttpRequest, identity: ApiKeyIdentity, signingProperties: Record<string, any>): Promise<IHttpRequest>;
+}

package/dist-types/httpBearerAuth.d.ts

@@ -0,0 +1,10 @@
+import { HttpRequest } from "@smithy/protocol-http";
+import { HttpRequest as IHttpRequest } from "@smithy/types";
+import { HttpSigner } from "./HttpSigner";
+import { TokenIdentity } from "./tokenIdentity";
+/**
+ * @internal
+ */
+export declare class HttpBearerAuthSigner implements HttpSigner {
+    sign(httpRequest: HttpRequest, identity: TokenIdentity, signingProperties: Record<string, any>): Promise<IHttpRequest>;
+}

package/dist-types/index.d.ts

@@ -1,4 +1,9 @@
 export * from "./IdentityProviderConfiguration";
 export * from "./HttpAuthScheme";
 export * from "./HttpSigner";
+export * from "./SigV4Signer";
+export * from "./apiKeyIdentity";
+export * from "./httpApiKeyAuth";
+export * from "./httpBearerAuth";
 export * from "./noAuth";
+export * from "./tokenIdentity";

package/dist-types/tokenIdentity.d.ts

@@ -0,0 +1,14 @@
+import { Identity, IdentityProvider } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface TokenIdentity extends Identity {
+    /**
+     * The literal token string
+     */
+    readonly token: string;
+}
+/**
+ * @internal
+ */
+export type TokenIdentityProvider = IdentityProvider<TokenIdentity>;

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

@@ -0,0 +1,9 @@
+import { HttpRequest } from "@smithy/protocol-http";
+import { AwsCredentialIdentity, HttpRequest as IHttpRequest } from "@smithy/types";
+import { HttpSigner } from "./HttpSigner";
+/**
+ * @internal
+ */
+export declare class SigV4Signer implements HttpSigner {
+    sign(httpRequest: HttpRequest, identity: AwsCredentialIdentity, signingProperties: Record<string, any>): Promise<IHttpRequest>;
+}

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

@@ -0,0 +1,11 @@
+import { Identity, IdentityProvider } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface ApiKeyIdentity extends Identity {
+    readonly apiKey: string;
+}
+/**
+ * @internal
+ */
+export type ApiKeyIdentityProvider = IdentityProvider<ApiKeyIdentity>;

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

@@ -0,0 +1,17 @@
+import { HttpRequest } from "@smithy/protocol-http";
+import { HttpRequest as IHttpRequest } from "@smithy/types";
+import { ApiKeyIdentity } from "./apiKeyIdentity";
+import { HttpSigner } from "./HttpSigner";
+/**
+ * @internal
+ */
+export declare enum HttpApiKeyAuthLocation {
+    HEADER = "header",
+    QUERY = "query"
+}
+/**
+ * @internal
+ */
+export declare class HttpApiKeyAuthSigner implements HttpSigner {
+    sign(httpRequest: HttpRequest, identity: ApiKeyIdentity, signingProperties: Record<string, any>): Promise<IHttpRequest>;
+}

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

@@ -0,0 +1,10 @@
+import { HttpRequest } from "@smithy/protocol-http";
+import { HttpRequest as IHttpRequest } from "@smithy/types";
+import { HttpSigner } from "./HttpSigner";
+import { TokenIdentity } from "./tokenIdentity";
+/**
+ * @internal
+ */
+export declare class HttpBearerAuthSigner implements HttpSigner {
+    sign(httpRequest: HttpRequest, identity: TokenIdentity, signingProperties: Record<string, any>): Promise<IHttpRequest>;
+}

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

@@ -1,4 +1,9 @@
 export * from "./IdentityProviderConfiguration";
 export * from "./HttpAuthScheme";
 export * from "./HttpSigner";
+export * from "./SigV4Signer";
+export * from "./apiKeyIdentity";
+export * from "./httpApiKeyAuth";
+export * from "./httpBearerAuth";
 export * from "./noAuth";
+export * from "./tokenIdentity";

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

@@ -0,0 +1,14 @@
+import { Identity, IdentityProvider } from "@smithy/types";
+/**
+ * @internal
+ */
+export interface TokenIdentity extends Identity {
+    /**
+     * The literal token string
+     */
+    readonly token: string;
+}
+/**
+ * @internal
+ */
+export type TokenIdentityProvider = IdentityProvider<TokenIdentity>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smithy/experimental-identity-and-auth",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -23,6 +23,8 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
+    "@smithy/protocol-http": "^2.0.5",
+    "@smithy/signature-v4": "^2.0.5",
     "@smithy/types": "^2.2.2",
     "tslib": "^2.5.0"
   },