@middy/secrets-manager 2.5.1 → 3.0.0-alpha.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2021 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
+Copyright (c) 2017-2022 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -53,13 +53,10 @@ npm install --save @middy/secrets-manager
 - `disablePrefetch` (boolean) (default `false`): On cold start requests will trigger early if they can. Setting `awsClientAssumeRole` disables prefetch.
 - `cacheKey` (string) (default `secrets-manager`): Cache key for the fetched data responses. Must be unique across all middleware.
 - `cacheExpiry` (number) (default `-1`): How long fetch data responses should be cached for. `-1`: cache forever, `0`: never cache, `n`: cache for n ms.
-- `setToEnv` (boolean) (default `false`): Store secrets to `process.env`. **Storing secrets in `process.env` is considered security bad practice**
 - `setToContext` (boolean) (default `false`): Store secrets to `request.context`.
 
 NOTES:
 - Lambda is required to have IAM permission for `secretsmanager:GetSecretValue`
-- `setToEnv` and `setToContext` are included for legacy support and should be avoided for performance and security reasons. See main documentation for best practices.
-- `setToEnv` can only assign secrets of type string
 
 ## Sample usage
 
@@ -99,7 +96,7 @@ Everyone is very welcome to contribute to this repository. Feel free to [raise i
 
 ## License
 
-Licensed under [MIT License](LICENSE). Copyright (c) 2017-2021 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2022 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
 
 <a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy?ref=badge_large">
   <img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status"  style="max-width:100%;">

package/index.d.ts

@@ -1,19 +1,8 @@
 import { SecretsManager } from 'aws-sdk'
-import { captureAWSClient } from 'aws-xray-sdk'
 import middy from '@middy/core'
+import { Options as MiddyOptions } from '@middy/util'
 
-interface Options<SM = SecretsManager> {
-  AwsClient?: new() => SM
-  awsClientOptions?: Partial<SecretsManager.Types.ClientConfiguration>
-  awsClientAssumeRole?: string
-  awsClientCapture?: typeof captureAWSClient
-  fetchData?: { [key: string]: string }
-  disablePrefetch?: boolean
-  cacheKey?: string
-  cacheExpiry?: number
-  setToEnv?: boolean
-  setToContext?: boolean
-}
+interface Options<SM = SecretsManager> extends MiddyOptions<SM, SecretsManager.Types.ClientConfiguration> {}
 
 declare function secretsManager (options?: Options): middy.MiddlewareObj
 

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@middy/secrets-manager",
-  "version": "2.5.1",
+  "version": "3.0.0-alpha.0",
   "description": "Secrets Manager middleware for the middy framework",
-  "type": "commonjs",
+  "type": "module",
   "engines": {
-    "node": ">=12"
+    "node": ">=14"
   },
   "engineStrict": true,
   "publishConfig": {
     "access": "public"
   },
-  "main": "index.js",
+  "exports": "./index.js",
   "types": "index.d.ts",
   "files": [
     "index.d.ts"
@@ -44,12 +44,12 @@
   },
   "homepage": "https://github.com/middyjs/middy#readme",
   "dependencies": {
-    "@middy/util": "^2.5.1"
+    "@middy/util": "^3.0.0-alpha.0"
   },
   "devDependencies": {
-    "@middy/core": "^2.5.1",
+    "@middy/core": "^3.0.0-alpha.0",
     "aws-sdk": "^2.939.0",
     "aws-xray-sdk": "^3.3.3"
   },
-  "gitHead": "df18e5eff7d73492a96a2ca4780a2eae45d1cedb"
+  "gitHead": "c533f62841c8a39d061d7b94f30ba178f002c8db"
 }

package/index.js

@@ -1,95 +0,0 @@
-"use strict";
-
-const {
-  canPrefetch,
-  createPrefetchClient,
-  createClient,
-  processCache,
-  getCache,
-  modifyCache,
-  jsonSafeParse,
-  getInternal
-} = require('@middy/util');
-
-const SecretsManager = require('aws-sdk/clients/secretsmanager'); // v2
-// const { SecretsManager } = require('@aws-sdk/client-secrets-manager')  // v3
-
-
-const defaults = {
-  AwsClient: SecretsManager,
-  awsClientOptions: {},
-  awsClientAssumeRole: undefined,
-  awsClientCapture: undefined,
-  fetchData: {},
-  // If more than 2, consider writing own using ListSecrets
-  disablePrefetch: false,
-  cacheKey: 'secrets-manager',
-  cacheExpiry: -1,
-  setToEnv: false,
-  // can return object when requesting db credentials, cannot set to process.env
-  setToContext: false
-};
-
-const secretsManagerMiddleware = (opts = {}) => {
-  const options = { ...defaults,
-    ...opts
-  };
-
-  const fetch = (request, cachedValues = {}) => {
-    const values = {}; // Multiple secrets can be requested in a single requests,
-    // however this is likely uncommon IRL, increases complexity to handle,
-    // and will require recursive promise resolution impacting performance.
-    // See https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SecretsManager.html#listSecrets-property
-
-    for (const internalKey of Object.keys(options.fetchData)) {
-      if (cachedValues[internalKey]) continue;
-      values[internalKey] = client.getSecretValue({
-        SecretId: options.fetchData[internalKey]
-      }).promise() // Required for aws-sdk v2
-      .then(resp => jsonSafeParse(resp.SecretString)).catch(e => {
-        var _getCache$value, _getCache;
-
-        const value = (_getCache$value = (_getCache = getCache(options.cacheKey)) === null || _getCache === void 0 ? void 0 : _getCache.value) !== null && _getCache$value !== void 0 ? _getCache$value : {};
-        value[internalKey] = undefined;
-        modifyCache(options.cacheKey, value);
-        throw e;
-      });
-    }
-
-    return values;
-  };
-
-  let prefetch, client;
-
-  if (canPrefetch(options)) {
-    client = createPrefetchClient(options);
-    prefetch = processCache(options, fetch);
-  }
-
-  const secretsManagerMiddlewareBefore = async request => {
-    var _prefetch;
-
-    if (!client) {
-      client = await createClient(options, request);
-    }
-
-    const {
-      value
-    } = (_prefetch = prefetch) !== null && _prefetch !== void 0 ? _prefetch : processCache(options, fetch, request);
-    Object.assign(request.internal, value);
-
-    if (options.setToContext || options.setToEnv) {
-      const data = await getInternal(Object.keys(options.fetchData), request);
-      if (options.setToEnv) Object.assign(process.env, data);
-      if (options.setToContext) Object.assign(request.context, data);
-    }
-
-    prefetch = null;
-  };
-
-  return {
-    before: secretsManagerMiddlewareBefore
-  };
-};
-
-module.exports = secretsManagerMiddleware;