@middy/service-discovery 2.5.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-2021 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,98 @@
+# Middy sts middleware
+
+<div align="center">
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
+</div>
+
+<div align="center">
+  <p><strong>STS middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
+</div>
+
+<div align="center">
+<p>
+  <a href="http://badge.fury.io/js/%40middy%2Fsts">
+    <img src="https://badge.fury.io/js/%40middy%2Fsts.svg" alt="npm version" style="max-width:100%;">
+  </a>
+  <a href="https://snyk.io/test/github/middyjs/middy">
+    <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
+  </a>
+  <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
+  <a href="https://gitter.im/middyjs/Lobby">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter"  style="max-width:100%;">
+  </a>
+</p>
+</div>
+
+Fetches STS credentials to be used when connecting to other AWS services.
+
+## Install
+
+To install this middleware you can use NPM:
+
+```bash
+npm install --save @middy/sts
+```
+
+
+## Options
+
+- `AwsClient` (object) (default `AWS.STS`): AWS.STS class constructor (e.g. that has been instrumented with AWS XRay). Must be from `aws-sdk` v2.
+- `awsClientOptions` (object) (optional): Options to pass to AWS.STS class constructor.
+- `awsClientCapture` (function) (optional): Enable XRay by passing `captureAWSClient` from `aws-xray-sdk` in.
+- `fetchData` (object) (required): Mapping of internal key name to API request parameters.
+- `disablePrefetch` (boolean) (default `false`): On cold start requests will trigger early if they can. Setting `awsClientAssumeRole` disables prefetch.
+- `cacheKey` (string) (default `sts`): 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.
+- `setToContext` (boolean) (default `false`): Store credentials to `request.context`.
+
+NOTES:
+- Lambda is required to have IAM permission for `sts:AssumeRole`
+- `setToContext` are included for legacy support and should be avoided for performance and security reasons. See main documentation for best practices.
+
+## Sample usage
+
+```javascript
+import middy from '@middy/core'
+import sts from '@middy/sts'
+
+const handler = middy((event, context) => {
+  const response = {
+    statusCode: 200,
+    headers: {},
+    body: JSON.stringify({ message: 'hello world' })
+  };
+
+  return response
+})
+
+handler
+  .use(sts({
+    fetchData: {
+      assumeRole: {
+        RoleArn: '...',
+        RoleSessionName:'' // optional
+      }
+    }
+  }))
+```
+
+
+## Middy documentation and examples
+
+For more documentation and examples, refers to the main [Middy monorepo on GitHub](https://github.com/middyjs/middy) or [Middy official website](https://middy.js.org).
+
+
+## Contributing
+
+Everyone is very welcome to contribute to this repository. Feel free to [raise issues](https://github.com/middyjs/middy/issues) or to [submit Pull Requests](https://github.com/middyjs/middy/pulls).
+
+
+## License
+
+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%;">
+</a>

package/index.d.ts

@@ -0,0 +1,13 @@
+import { STS } from 'aws-sdk'
+import middy from '@middy/core'
+import { Options as MiddyOptions } from '@middy/util'
+
+interface Options<S = STS>
+  extends Pick<MiddyOptions<S, STS.Types.ClientConfiguration>,
+  'AwsClient' | 'awsClientOptions' | 'awsClientCapture' |
+  'fetchData' | 'disablePrefetch' | 'cacheKey' | 'cacheExpiry' | 'setToContext'> {
+}
+
+declare function sts (options?: Options): middy.MiddlewareObj
+
+export default sts

package/index.js

@@ -0,0 +1,95 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _util = require("@middy/util");
+
+var _sts = _interopRequireDefault(require("aws-sdk/clients/sts.js"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// v2
+// import { STS } from '@aws-sdk/client-sts' // v3
+const defaults = {
+  AwsClient: _sts.default,
+  awsClientOptions: {},
+  // awsClientAssumeRole: undefined, // Not Applicable, as this is the middleware that defines the roles
+  awsClientCapture: undefined,
+  fetchData: {},
+  // { contextKey: {RoleArn, RoleSessionName} }
+  disablePrefetch: false,
+  cacheKey: 'sts',
+  cacheExpiry: -1,
+  setToContext: false
+};
+
+const stsMiddleware = (opts = {}) => {
+  const options = { ...defaults,
+    ...opts
+  };
+
+  const fetch = (request, cachedValues = {}) => {
+    const values = {};
+
+    for (const internalKey of Object.keys(options.fetchData)) {
+      var _assumeRoleOptions$Ro;
+
+      if (cachedValues[internalKey]) continue;
+      const assumeRoleOptions = options.fetchData[internalKey]; // Date cannot be used here to assign default session name, possibility of collision when > 1 role defined
+
+      (_assumeRoleOptions$Ro = assumeRoleOptions.RoleSessionName) !== null && _assumeRoleOptions$Ro !== void 0 ? _assumeRoleOptions$Ro : assumeRoleOptions.RoleSessionName = 'middy-sts-session-' + Math.ceil(Math.random() * 99999);
+      values[internalKey] = client.assumeRole(assumeRoleOptions).promise() // Required for aws-sdk v2
+      .then(resp => ({
+        accessKeyId: resp.Credentials.AccessKeyId,
+        secretAccessKey: resp.Credentials.SecretAccessKey,
+        sessionToken: resp.Credentials.SessionToken
+      })).catch(e => {
+        var _getCache$value;
+
+        const value = (_getCache$value = (0, _util.getCache)(options.cacheKey).value) !== null && _getCache$value !== void 0 ? _getCache$value : {};
+        value[internalKey] = undefined;
+        (0, _util.modifyCache)(options.cacheKey, value);
+        throw e;
+      });
+    }
+
+    return values;
+  };
+
+  let prefetch, client;
+
+  if ((0, _util.canPrefetch)(options)) {
+    client = (0, _util.createPrefetchClient)(options);
+    prefetch = (0, _util.processCache)(options, fetch);
+  }
+
+  const stsMiddlewareBefore = async request => {
+    var _prefetch;
+
+    if (!client) {
+      client = await (0, _util.createClient)(options, request);
+    }
+
+    const {
+      value
+    } = (_prefetch = prefetch) !== null && _prefetch !== void 0 ? _prefetch : (0, _util.processCache)(options, fetch, request);
+    Object.assign(request.internal, value);
+
+    if (options.setToContext) {
+      const data = await (0, _util.getInternal)(Object.keys(options.fetchData), request);
+      if (options.setToContext) Object.assign(request.context, data);
+    }
+
+    prefetch = null;
+  };
+
+  return {
+    before: stsMiddlewareBefore
+  };
+};
+
+var _default = stsMiddleware;
+exports.default = _default;

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@middy/service-discovery",
+  "version": "2.5.5",
+  "description": "STS (Security Token Service) credentials middleware for the middy framework",
+  "type": "module",
+  "engines": {
+    "node": ">=14"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": "./index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "test": "npm run test:unit",
+    "test:unit": "ava"
+  },
+  "license": "MIT",
+  "keywords": [
+    "Lambda",
+    "Middleware",
+    "Serverless",
+    "Framework",
+    "AWS",
+    "AWS Lambda",
+    "Middy",
+    "STS",
+    "Security Token Service",
+    "Credentials"
+  ],
+  "author": {
+    "name": "Middy contributors",
+    "url": "https://github.com/middyjs/middy/graphs/contributors"
+  },
+  "repository": {
+    "type": "git",
+    "url": "github:middyjs/middy",
+    "directory": "packages/sts"
+  },
+  "bugs": {
+    "url": "https://github.com/middyjs/middy/issues"
+  },
+  "homepage": "https://github.com/middyjs/middy#readme",
+  "dependencies": {
+    "@middy/util": "^3.0.0-alpha.2"
+  },
+  "devDependencies": {
+    "@middy/core": "^3.0.0-alpha.2",
+    "aws-sdk": "^2.939.0",
+    "aws-xray-sdk": "^3.3.3"
+  },
+  "gitHead": "b84840ec8afd289f6decfd0d645be4899051792d"
+}