Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neilkuan/aws-sdk-js-assumed-role-mfa
Example for aws-sdk-js-v3 and aws-sdk-js-v2 use assume role with mfa.
https://github.com/neilkuan/aws-sdk-js-assumed-role-mfa
aws-sdk-js aws-sdk-js-v2 aws-sdk-js-v3 mfa
Last synced: 9 days ago
JSON representation
Example for aws-sdk-js-v3 and aws-sdk-js-v2 use assume role with mfa.
- Host: GitHub
- URL: https://github.com/neilkuan/aws-sdk-js-assumed-role-mfa
- Owner: neilkuan
- License: apache-2.0
- Created: 2023-09-09T04:04:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-09T04:10:51.000Z (about 1 year ago)
- Last Synced: 2024-10-07T10:10:51.607Z (30 days ago)
- Topics: aws-sdk-js, aws-sdk-js-v2, aws-sdk-js-v3, mfa
- Language: TypeScript
- Homepage:
- Size: 142 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Using the shared credentials file
> This provider is checked by default in the Node.js environment. To use the credentials file provider, simply add your access and secret keys to the ~/.aws/credentials file in the following format:
`~/.aws/credentials`
```ini
[default]
aws_access_key_id=foo
aws_secret_access_key=bar
```
`~/.aws/config`
```ini
[default]
region = us-east-1
output = json
[profile role-with-mfa]
role_arn = arn:aws:iam::123456789012:role/the-assumed-role
source_profile = default
mfa_serial = arn:aws:iam::123456789012:mfa/cli-user
```
## The `trust_relationships` of `the-assumed-role`
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::123456789012:root"
},
"Action": "sts:AssumeRole",
"Condition": {
"BoolIfExists": {
"aws:MultiFactorAuthPresent": [
"true"
]
}
}
}
]
}
```
## Example use AWS SDK V2 assumed role
[source code](./src/index-v2.ts)
Example output
```bash
pj run-sdk-v2
👾 run-sdk-v2 | AWS_SDK_LOAD_CONFIG=1 ts-node src/index-v2.ts
✅ AWSSDKV2...
Please input MFA code for arn:aws:iam::123456789012:mfa/cli-user: xxxxxx
arn:aws:sts::123456789012:assumed-role/the-assumed-role/aws-sdk-js-1694231277404
```
## Example use AWS SDK V3 assumed role
[source code](./src/index-v3.ts)
Example output
```bash
pj run-sdk-v3
👾 run-sdk-v3 | AWS_SDK_LOAD_CONFIG=1 ts-node src/index-v3.ts
✅ AWSSDKV3...
Please input MFA code for arn:aws:iam::123456789012:mfa/cli-user
Enter MFA code: xxxxxx
arn:aws:sts::123456789012:assumed-role/the-assumed-role/aws-sdk-js-1694231277404
```
## Ref:
- https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-credential-providers/#fromini
- https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SharedIniFileCredentials.html