@bitblit/ratchet-aws 6.1.222-alpha → 6.1.225-alpha

package/License.txt

@@ -0,0 +1,13 @@
+Copyright 2018-2024 Christopher Weiss
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/lib/environment/model/ratchet-environment-database-config.d.ts

@@ -0,0 +1,9 @@
+import { RatchetEnvironmentDynamicProperty } from "./ratchet-environment-dynamic-property.ts";
+export interface RatchetEnvironmentDatabaseConfig {
+    label: string;
+    host?: string;
+    username?: string;
+    password?: string;
+    databaseName?: string;
+    meta?: RatchetEnvironmentDynamicProperty[];
+}

package/lib/environment/model/ratchet-environment-database-config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ratchet-environment-database-config.js.map

package/lib/environment/model/ratchet-environment-database-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ratchet-environment-database-config.js","sourceRoot":"","sources":["../../../src/environment/model/ratchet-environment-database-config.ts"],"names":[],"mappings":""}

package/lib/environment/model/ratchet-environment-dynamic-property.d.ts

@@ -0,0 +1,4 @@
+export interface RatchetEnvironmentDynamicProperty {
+    k: string;
+    v: string;
+}

package/lib/environment/model/ratchet-environment-dynamic-property.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ratchet-environment-dynamic-property.js.map

package/lib/environment/model/ratchet-environment-dynamic-property.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ratchet-environment-dynamic-property.js","sourceRoot":"","sources":["../../../src/environment/model/ratchet-environment-dynamic-property.ts"],"names":[],"mappings":""}

package/lib/environment/model/ratchet-environment-third-party-config.d.ts

@@ -0,0 +1,5 @@
+import { RatchetEnvironmentDynamicProperty } from "./ratchet-environment-dynamic-property.ts";
+export interface RatchetEnvironmentThirdPartyConfig {
+    label: string;
+    data: RatchetEnvironmentDynamicProperty[];
+}

package/lib/environment/model/ratchet-environment-third-party-config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ratchet-environment-third-party-config.js.map

package/lib/environment/model/ratchet-environment-third-party-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ratchet-environment-third-party-config.js","sourceRoot":"","sources":["../../../src/environment/model/ratchet-environment-third-party-config.ts"],"names":[],"mappings":""}

package/lib/environment/model/ratchet-environment.d.ts

@@ -0,0 +1,8 @@
+import { RatchetEnvironmentDynamicProperty } from "./ratchet-environment-dynamic-property.ts";
+import { RatchetEnvironmentThirdPartyConfig } from "./ratchet-environment-third-party-config.ts";
+export interface RatchetEnvironment {
+    encryptionKey?: string;
+    historicalDecryptionKeys?: string[];
+    database?: RatchetEnvironmentDynamicProperty[];
+    thirdParty?: RatchetEnvironmentThirdPartyConfig[];
+}

package/lib/environment/model/ratchet-environment.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ratchet-environment.js.map

package/lib/environment/model/ratchet-environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ratchet-environment.js","sourceRoot":"","sources":["../../../src/environment/model/ratchet-environment.ts"],"names":[],"mappings":""}

package/lib/secrets-manager/impl/secrets-manager-environment-service-provider.d.ts

@@ -0,0 +1,12 @@
+import { EnvironmentServiceProvider } from "../../environment/environment-service-provider.ts";
+import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
+export declare class SecretsManagerEnvironmentServiceProvider<T> implements EnvironmentServiceProvider<T> {
+    private cfg;
+    private secretsManagerRatchet;
+    constructor(cfg: SecretsManagerEnvironmentServiceProviderConfig);
+    fetchConfig(name: string): Promise<T>;
+}
+export interface SecretsManagerEnvironmentServiceProviderConfig {
+    smOverride?: SecretsManagerClient;
+    region?: string;
+}

package/lib/secrets-manager/impl/secrets-manager-environment-service-provider.js

@@ -0,0 +1,21 @@
+import { RequireRatchet } from "@bitblit/ratchet-common/lang/require-ratchet";
+import { Logger } from "@bitblit/ratchet-common/logger/logger";
+import { SecretsManagerRatchet } from "../secrets-manager-ratchet.js";
+import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
+export class SecretsManagerEnvironmentServiceProvider {
+    cfg;
+    secretsManagerRatchet;
+    constructor(cfg) {
+        this.cfg = cfg;
+        RequireRatchet.notNullOrUndefined(cfg);
+        RequireRatchet.true(!!cfg.smOverride || !!cfg.region, 'You must set either region or smOverride');
+        const client = cfg.smOverride || new SecretsManagerClient({ region: cfg.region });
+        this.secretsManagerRatchet = new SecretsManagerRatchet(client);
+    }
+    async fetchConfig(name) {
+        Logger.silly('SecretsManagerEnvironmentServiceProvider fetch for %s', name);
+        const rval = await this.secretsManagerRatchet.fetchAndParseSecret(name);
+        return rval;
+    }
+}
+//# sourceMappingURL=secrets-manager-environment-service-provider.js.map

package/lib/secrets-manager/impl/secrets-manager-environment-service-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secrets-manager-environment-service-provider.js","sourceRoot":"","sources":["../../../src/secrets-manager/impl/secrets-manager-environment-service-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,8CAA8C,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,uCAAuC,CAAC;AAE/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAMvE,MAAM,OAAO,wCAAwC;IAGzC,GAAG;IAFL,qBAAqB,CAAuB;IACpD,YACU,GAAmD;mBAAnD,GAAG;QAEX,cAAc,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACvC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,EAAE,0CAA0C,CAAC,CAAC;QAClG,MAAM,MAAM,GAA0B,GAAG,CAAC,UAAU,IAAI,IAAI,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QACzG,IAAI,CAAC,qBAAqB,GAAG,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,IAAY;QACnC,MAAM,CAAC,KAAK,CAAC,uDAAuD,EAAE,IAAI,CAAC,CAAC;QAC5E,MAAM,IAAI,GAAM,MAAM,IAAI,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC;IACd,CAAC;CACF"}

package/lib/secrets-manager/secrets-manager-ratchet.d.ts

@@ -0,0 +1,7 @@
+import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
+export declare class SecretsManagerRatchet {
+    private sm;
+    constructor(sm: SecretsManagerClient);
+    fetchSecret(secretName: string, defaultValue?: string): Promise<string>;
+    fetchAndParseSecret<T>(secretName: string, defaultValue?: T): Promise<T>;
+}

package/lib/secrets-manager/secrets-manager-ratchet.js

@@ -0,0 +1,54 @@
+import { RequireRatchet } from "@bitblit/ratchet-common/lang/require-ratchet";
+import { GetSecretValueCommand, ResourceNotFoundException } from '@aws-sdk/client-secrets-manager';
+import { Logger } from '@bitblit/ratchet-common/logger/logger';
+export class SecretsManagerRatchet {
+    sm;
+    constructor(sm) {
+        this.sm = sm;
+        RequireRatchet.notNullOrUndefined(this.sm, 'sm');
+    }
+    async fetchSecret(secretName, defaultValue) {
+        Logger.info('Fetching secret %s', secretName);
+        let rval = null;
+        try {
+            const command = new GetSecretValueCommand({ SecretId: secretName });
+            const response = await this.sm.send(command);
+            if (response.SecretString) {
+                rval = response.SecretString;
+            }
+            else if (response.SecretBinary) {
+                const buff = Buffer.from(response.SecretBinary, 'base64');
+                rval = buff.toString('ascii');
+            }
+        }
+        catch (err) {
+            if (err instanceof ResourceNotFoundException) {
+                if (defaultValue !== null && defaultValue !== undefined) {
+                    rval = defaultValue;
+                }
+                else {
+                    throw new Error('Secret has no value and no default set for ' + secretName, err);
+                }
+            }
+            else {
+                Logger.error('Failed to retrieve secret: %s : %s', secretName, err, err);
+                throw err;
+            }
+        }
+        return rval;
+    }
+    async fetchAndParseSecret(secretName, defaultValue) {
+        Logger.info('Fetching secret %s', secretName);
+        const asString = await this.fetchSecret(secretName, undefined);
+        let rval = null;
+        if (asString) {
+            rval = JSON.parse(asString);
+        }
+        rval = rval ?? defaultValue;
+        if (!rval) {
+            throw new Error('Secret has no value and no default set');
+        }
+        return rval;
+    }
+}
+//# sourceMappingURL=secrets-manager-ratchet.js.map

package/lib/secrets-manager/secrets-manager-ratchet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secrets-manager-ratchet.js","sourceRoot":"","sources":["../../src/secrets-manager/secrets-manager-ratchet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,8CAA8C,CAAC;AAC9E,OAAO,EAAE,qBAAqB,EAAE,yBAAyB,EAAwB,MAAM,iCAAiC,CAAC;AACzH,OAAO,EAAE,MAAM,EAAE,MAAM,uCAAuC,CAAC;AAE/D,MAAM,OAAO,qBAAqB;IAEtB,EAAE;IADZ,YACU,EAAwB;kBAAxB,EAAE;QAEV,cAAc,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,UAAkB,EAAG,YAAqB;QACjE,MAAM,CAAC,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC;QAC9C,IAAI,IAAI,GAAW,IAAI,CAAC;QACxB,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,qBAAqB,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;YACpE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE7C,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;gBAC1B,IAAI,GAAE,QAAQ,CAAC,YAAY,CAAC;YAC9B,CAAC;iBAAM,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;gBAEjC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAmB,EAAE,QAAQ,CAAC,CAAC;gBACjE,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,GAAG,YAAY,yBAAyB,EAAE,CAAC;gBAC7C,IAAI,YAAY,KAAG,IAAI,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;oBACtD,IAAI,GAAG,YAAY,CAAC;gBACtB,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CAAC,6CAA6C,GAAG,UAAU,EAAE,GAAG,CAAC,CAAC;gBACnF,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE,UAAU,EAAG,GAAG,EAAE,GAAG,CAAC,CAAC;gBAC1E,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAI,UAAkB,EAAG,YAAgB;QACvE,MAAM,CAAC,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAW,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QACvE,IAAI,IAAI,GAAM,IAAI,CAAC;QACnB,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC;QACD,IAAI,GAAG,IAAI,IAAI,YAAY,CAAC;QAC5B,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CAEF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitblit/ratchet-aws",
-  "version": "6.1.222-alpha",
+  "version": "6.1.225-alpha",
   "description": "Common tools for use with AWS browser and node",
   "sideEffects": false,
   "type": "module",
@@ -52,7 +52,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@bitblit/ratchet-common": "6.1.222-alpha"
+    "@bitblit/ratchet-common": "6.1.225-alpha"
   },
   "optionalDependencies": {
     "@aws-sdk/client-athena": "3.1095.0",
@@ -66,6 +66,7 @@
     "@aws-sdk/client-lambda": "3.1095.0",
     "@aws-sdk/client-route-53": "3.1095.0",
     "@aws-sdk/client-s3": "3.1095.0",
+    "@aws-sdk/client-secrets-manager": "3.1095.0",
     "@aws-sdk/client-ses": "3.1095.0",
     "@aws-sdk/client-sns": "3.1095.0",
     "@aws-sdk/client-ssm": "3.1095.0",
@@ -93,6 +94,7 @@
     "@aws-sdk/client-lambda": "^3.1095.0",
     "@aws-sdk/client-route-53": "^3.1095.0",
     "@aws-sdk/client-s3": "^3.1095.0",
+    "@aws-sdk/client-secrets-manager": "^3.1095.0",
     "@aws-sdk/client-ses": "^3.1095.0",
     "@aws-sdk/client-sns": "^3.1095.0",
     "@aws-sdk/client-ssm": "^3.1095.0",
@@ -103,7 +105,7 @@
     "@aws-sdk/s3-request-presigner": "^3.1095.0",
     "@aws-sdk/types": "^3.974.2",
     "@aws-sdk/util-dynamodb": "^3.996.2",
-    "@bitblit/ratchet-common": "6.1.222-alpha",
+    "@bitblit/ratchet-common": "6.1.225-alpha",
     "@smithy/types": "^4.14.2",
     "@smithy/abort-controller": "^4.3.3",
     "@smithy/smithy-client": "^4.14.14",
@@ -181,7 +183,7 @@
     }
   },
   "devDependencies": {
-    "@bitblit/ratchet-node-only": "6.1.222-alpha",
+    "@bitblit/ratchet-node-only": "6.1.225-alpha",
     "@types/aws-lambda": "8.10.162",
     "aws-sdk-client-mock": "4.1.0"
   },

package/src/environment/model/ratchet-environment-database-config.ts

@@ -0,0 +1,10 @@
+import { RatchetEnvironmentDynamicProperty } from "./ratchet-environment-dynamic-property.ts";
+
+export interface RatchetEnvironmentDatabaseConfig {
+  label: string;
+  host?: string;
+  username?: string;
+  password?: string;
+  databaseName?: string;
+  meta?: RatchetEnvironmentDynamicProperty[];
+}

package/src/environment/model/ratchet-environment-dynamic-property.ts

@@ -0,0 +1,4 @@
+export interface RatchetEnvironmentDynamicProperty {
+  k: string;
+  v: string;
+}

package/src/environment/model/ratchet-environment-third-party-config.ts

@@ -0,0 +1,6 @@
+import { RatchetEnvironmentDynamicProperty } from "./ratchet-environment-dynamic-property.ts";
+
+export interface RatchetEnvironmentThirdPartyConfig {
+  label: string;
+  data: RatchetEnvironmentDynamicProperty[];
+}

package/src/environment/model/ratchet-environment.ts

@@ -0,0 +1,9 @@
+import { RatchetEnvironmentDynamicProperty } from "./ratchet-environment-dynamic-property.ts";
+import { RatchetEnvironmentThirdPartyConfig } from "./ratchet-environment-third-party-config.ts";
+
+export interface RatchetEnvironment {
+  encryptionKey?: string;
+  historicalDecryptionKeys?: string[];
+  database?: RatchetEnvironmentDynamicProperty[];
+  thirdParty?: RatchetEnvironmentThirdPartyConfig[];
+}

package/src/secrets-manager/impl/secrets-manager-environment-service-provider.ts

@@ -0,0 +1,33 @@
+import { RequireRatchet } from "@bitblit/ratchet-common/lang/require-ratchet";
+import { Logger } from "@bitblit/ratchet-common/logger/logger";
+import { EnvironmentServiceProvider } from "../../environment/environment-service-provider.ts";
+import { SecretsManagerRatchet } from "../secrets-manager-ratchet.ts";
+import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
+
+/**
+ * Service for reading environmental variables
+ * Also hides the decryption detail from higher up services
+ */
+export class SecretsManagerEnvironmentServiceProvider<T> implements EnvironmentServiceProvider<T> {
+  private secretsManagerRatchet: SecretsManagerRatchet
+  public constructor(
+    private cfg: SecretsManagerEnvironmentServiceProviderConfig
+  ) {
+    RequireRatchet.notNullOrUndefined(cfg);
+    RequireRatchet.true(!!cfg.smOverride || !!cfg.region, 'You must set either region or smOverride');
+    const client: SecretsManagerClient  = cfg.smOverride || new SecretsManagerClient({ region: cfg.region });
+    this.secretsManagerRatchet = new SecretsManagerRatchet(client);
+  }
+
+  public async fetchConfig(name: string): Promise<T> {
+    Logger.silly('SecretsManagerEnvironmentServiceProvider fetch for %s', name);
+    const rval: T = await this.secretsManagerRatchet.fetchAndParseSecret(name);
+    return rval;
+  }
+}
+
+
+export interface SecretsManagerEnvironmentServiceProviderConfig {
+  smOverride?: SecretsManagerClient;
+  region?: string;
+}

package/src/secrets-manager/secrets-manager-ratchet.ts

@@ -0,0 +1,55 @@
+import { RequireRatchet } from "@bitblit/ratchet-common/lang/require-ratchet";
+import { GetSecretValueCommand, ResourceNotFoundException, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
+import { Logger } from '@bitblit/ratchet-common/logger/logger';
+
+export class SecretsManagerRatchet {
+  constructor(
+    private sm: SecretsManagerClient,
+  ) {
+    RequireRatchet.notNullOrUndefined(this.sm, 'sm');
+  }
+
+  public async fetchSecret(secretName: string , defaultValue?: string): Promise<string> {
+    Logger.info('Fetching secret %s', secretName);
+    let rval: string = null;
+    try {
+      const command = new GetSecretValueCommand({ SecretId: secretName });
+      const response = await this.sm.send(command);
+
+      if (response.SecretString) {
+        rval= response.SecretString; // JSON string or plain string
+      } else if (response.SecretBinary) {
+        // decode from base64 if stored as binary
+        const buff = Buffer.from(response.SecretBinary as any, 'base64');
+        rval = buff.toString('ascii');
+      }
+    } catch (err) {
+      if (err instanceof ResourceNotFoundException) {
+        if (defaultValue!==null && defaultValue !== undefined) {
+          rval = defaultValue;
+        } else {
+          throw new Error('Secret has no value and no default set for ' + secretName, err);
+        }
+      } else {
+        Logger.error('Failed to retrieve secret: %s : %s', secretName,  err, err);
+        throw err;
+      }
+    }
+    return rval;
+  }
+
+  public async fetchAndParseSecret<T>(secretName: string , defaultValue?: T): Promise<T> {
+    Logger.info('Fetching secret %s', secretName);
+    const asString: string = await this.fetchSecret(secretName, undefined);
+    let rval: T = null;
+    if (asString) {
+      rval = JSON.parse(asString);
+    }
+    rval = rval ?? defaultValue;
+    if (!rval) {
+      throw new Error('Secret has no value and no default set');
+    }
+    return rval;
+  }
+
+}