@middy/sts 3.0.0-alpha.3 → 3.0.0-alpha.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -15
- package/index.js +2 -80
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,26 +1,36 @@
|
|
|
1
|
-
# Middy sts middleware
|
|
2
|
-
|
|
3
|
-
<div align="center">
|
|
4
|
-
<img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
|
|
5
|
-
</div>
|
|
6
|
-
|
|
7
1
|
<div align="center">
|
|
2
|
+
<h1>Middy sts middleware</h1>
|
|
3
|
+
<img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
|
|
8
4
|
<p><strong>STS middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
|
|
9
|
-
</div>
|
|
10
|
-
|
|
11
|
-
<div align="center">
|
|
12
5
|
<p>
|
|
13
|
-
<a href="
|
|
6
|
+
<a href="https://www.npmjs.com/package/@middy/sts?activeTab=versions">
|
|
14
7
|
<img src="https://badge.fury.io/js/%40middy%2Fsts.svg" alt="npm version" style="max-width:100%;">
|
|
15
8
|
</a>
|
|
9
|
+
<a href="https://packagephobia.com/result?p=@middy/sts">
|
|
10
|
+
<img src="https://packagephobia.com/badge?p=@middy/sts" alt="npm install size" style="max-width:100%;">
|
|
11
|
+
</a>
|
|
12
|
+
<a href="https://github.com/middyjs/middy/actions">
|
|
13
|
+
<img src="https://github.com/middyjs/middy/workflows/Tests/badge.svg" alt="GitHub Actions test status badge" style="max-width:100%;">
|
|
14
|
+
</a>
|
|
15
|
+
<br/>
|
|
16
|
+
<a href="https://standardjs.com/">
|
|
17
|
+
<img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style" style="max-width:100%;">
|
|
18
|
+
</a>
|
|
16
19
|
<a href="https://snyk.io/test/github/middyjs/middy">
|
|
17
20
|
<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%;">
|
|
18
21
|
</a>
|
|
19
|
-
<a href="https://
|
|
20
|
-
<img src="https://img.shields.io/
|
|
22
|
+
<a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
|
|
23
|
+
<img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
|
|
24
|
+
</a>
|
|
25
|
+
<a href="https://bestpractices.coreinfrastructure.org/projects/5280">
|
|
26
|
+
<img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices" style="max-width:100%;">
|
|
21
27
|
</a>
|
|
28
|
+
<br/>
|
|
22
29
|
<a href="https://gitter.im/middyjs/Lobby">
|
|
23
|
-
<img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter"
|
|
30
|
+
<img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
|
|
31
|
+
</a>
|
|
32
|
+
<a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
|
|
33
|
+
<img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
|
|
24
34
|
</a>
|
|
25
35
|
</p>
|
|
26
36
|
</div>
|
|
@@ -39,8 +49,8 @@ npm install --save @middy/sts
|
|
|
39
49
|
## Options
|
|
40
50
|
|
|
41
51
|
- `AwsClient` (object) (default `AWS.STS`): AWS.STS class constructor (e.g. that has been instrumented with AWS XRay). Must be from `aws-sdk` v2.
|
|
42
|
-
- `awsClientOptions` (object) (
|
|
43
|
-
- `awsClientCapture` (function) (
|
|
52
|
+
- `awsClientOptions` (object) (default `undefined`): Options to pass to AWS.STS class constructor.
|
|
53
|
+
- `awsClientCapture` (function) (default `undefined`): Enable XRay by passing `captureAWSClient` from `aws-xray-sdk` in.
|
|
44
54
|
- `fetchData` (object) (required): Mapping of internal key name to API request parameters.
|
|
45
55
|
- `disablePrefetch` (boolean) (default `false`): On cold start requests will trigger early if they can. Setting `awsClientAssumeRole` disables prefetch.
|
|
46
56
|
- `cacheKey` (string) (default `sts`): Cache key for the fetched data responses. Must be unique across all middleware.
|
package/index.js
CHANGED
|
@@ -1,81 +1,3 @@
|
|
|
1
|
-
import {
|
|
2
|
-
canPrefetch,
|
|
3
|
-
createPrefetchClient,
|
|
4
|
-
createClient,
|
|
5
|
-
getCache,
|
|
6
|
-
getInternal,
|
|
7
|
-
processCache,
|
|
8
|
-
modifyCache
|
|
9
|
-
} from '@middy/util'
|
|
10
|
-
import STS from 'aws-sdk/clients/sts.js' // v2
|
|
11
|
-
// import { STS } from '@aws-sdk/client-sts' // v3
|
|
1
|
+
import{canPrefetch,createPrefetchClient,createClient,getCache,getInternal,processCache,modifyCache}from'@middy/util';import STS from'aws-sdk/clients/sts.js';var _assumeRoleOptions;const defaults={AwsClient:STS,awsClientOptions:{},awsClientCapture:undefined,fetchData:{},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)){if(cachedValues[internalKey])continue;const assumeRoleOptions=options.fetchData[internalKey];(_assumeRoleOptions=assumeRoleOptions).RoleSessionName??(_assumeRoleOptions.RoleSessionName='middy-sts-session-'+Math.ceil(Math.random()*99999));values[internalKey]=client.assumeRole(assumeRoleOptions).promise().then(resp=>({accessKeyId:resp.Credentials.AccessKeyId,secretAccessKey:resp.Credentials.SecretAccessKey,sessionToken:resp.Credentials.SessionToken})).catch(e=>{const value=getCache(options.cacheKey).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 stsMiddlewareBefore=async request=>{if(!client){client=await createClient(options,request)}const{value}=prefetch??processCache(options,fetch,request);Object.assign(request.internal,value);if(options.setToContext){const data=await getInternal(Object.keys(options.fetchData),request);if(options.setToContext)Object.assign(request.context,data)}prefetch=null};return{before:stsMiddlewareBefore}};export default stsMiddleware
|
|
12
2
|
|
|
13
|
-
|
|
14
|
-
AwsClient: STS,
|
|
15
|
-
awsClientOptions: {},
|
|
16
|
-
// awsClientAssumeRole: undefined, // Not Applicable, as this is the middleware that defines the roles
|
|
17
|
-
awsClientCapture: undefined,
|
|
18
|
-
fetchData: {}, // { contextKey: {RoleArn, RoleSessionName} }
|
|
19
|
-
disablePrefetch: false,
|
|
20
|
-
cacheKey: 'sts',
|
|
21
|
-
cacheExpiry: -1,
|
|
22
|
-
setToContext: false
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
const stsMiddleware = (opts = {}) => {
|
|
26
|
-
const options = { ...defaults, ...opts }
|
|
27
|
-
|
|
28
|
-
const fetch = (request, cachedValues = {}) => {
|
|
29
|
-
const values = {}
|
|
30
|
-
|
|
31
|
-
for (const internalKey of Object.keys(options.fetchData)) {
|
|
32
|
-
if (cachedValues[internalKey]) continue
|
|
33
|
-
const assumeRoleOptions = options.fetchData[internalKey]
|
|
34
|
-
// Date cannot be used here to assign default session name, possibility of collision when > 1 role defined
|
|
35
|
-
assumeRoleOptions.RoleSessionName ??= 'middy-sts-session-' + Math.ceil(Math.random() * 99999)
|
|
36
|
-
values[internalKey] = client
|
|
37
|
-
.assumeRole(assumeRoleOptions)
|
|
38
|
-
.promise() // Required for aws-sdk v2
|
|
39
|
-
.then((resp) => ({
|
|
40
|
-
accessKeyId: resp.Credentials.AccessKeyId,
|
|
41
|
-
secretAccessKey: resp.Credentials.SecretAccessKey,
|
|
42
|
-
sessionToken: resp.Credentials.SessionToken
|
|
43
|
-
}))
|
|
44
|
-
.catch((e) => {
|
|
45
|
-
const value = getCache(options.cacheKey).value ?? {}
|
|
46
|
-
value[internalKey] = undefined
|
|
47
|
-
modifyCache(options.cacheKey, value)
|
|
48
|
-
throw e
|
|
49
|
-
})
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
return values
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
let prefetch, client
|
|
56
|
-
if (canPrefetch(options)) {
|
|
57
|
-
client = createPrefetchClient(options)
|
|
58
|
-
prefetch = processCache(options, fetch)
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
const stsMiddlewareBefore = async (request) => {
|
|
62
|
-
if (!client) {
|
|
63
|
-
client = await createClient(options, request)
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
const { value } = prefetch ?? processCache(options, fetch, request)
|
|
67
|
-
|
|
68
|
-
Object.assign(request.internal, value)
|
|
69
|
-
|
|
70
|
-
if (options.setToContext) {
|
|
71
|
-
const data = await getInternal(Object.keys(options.fetchData), request)
|
|
72
|
-
if (options.setToContext) Object.assign(request.context, data)
|
|
73
|
-
}
|
|
74
|
-
prefetch = null
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
return {
|
|
78
|
-
before: stsMiddlewareBefore
|
|
79
|
-
}
|
|
80
|
-
}
|
|
81
|
-
export default stsMiddleware
|
|
3
|
+
//# sourceMappingURL=index.js.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@middy/sts",
|
|
3
|
-
"version": "3.0.0-alpha.
|
|
3
|
+
"version": "3.0.0-alpha.7",
|
|
4
4
|
"description": "STS (Security Token Service) credentials middleware for the middy framework",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"engines": {
|
|
@@ -48,12 +48,12 @@
|
|
|
48
48
|
},
|
|
49
49
|
"homepage": "https://github.com/middyjs/middy#readme",
|
|
50
50
|
"dependencies": {
|
|
51
|
-
"@middy/util": "^3.0.0-alpha.
|
|
51
|
+
"@middy/util": "^3.0.0-alpha.7"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
|
-
"@middy/core": "^3.0.0-alpha.
|
|
54
|
+
"@middy/core": "^3.0.0-alpha.7",
|
|
55
55
|
"aws-sdk": "^2.939.0",
|
|
56
56
|
"aws-xray-sdk": "^3.3.3"
|
|
57
57
|
},
|
|
58
|
-
"gitHead": "
|
|
58
|
+
"gitHead": "5cef39ebe49c201f97d71bb0680004de4b82cb91"
|
|
59
59
|
}
|