https://github.com/kdico/auth-aws-profile
Make authenticating your AWS credentials with MFA easier by using a script provided in this repository. Developed using Python 3.9.6 and Poetry. The authentication process uses the V3 SDK for Python.
https://github.com/kdico/auth-aws-profile
aws aws-sts boto3 poetry python3
Last synced: 17 days ago
JSON representation
Make authenticating your AWS credentials with MFA easier by using a script provided in this repository. Developed using Python 3.9.6 and Poetry. The authentication process uses the V3 SDK for Python.
- Host: GitHub
- URL: https://github.com/kdico/auth-aws-profile
- Owner: kdico
- License: mit
- Created: 2021-11-30T03:52:33.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-08-31T09:31:48.000Z (9 months ago)
- Last Synced: 2025-03-06T01:02:19.760Z (3 months ago)
- Topics: aws, aws-sts, boto3, poetry, python3
- Language: Python
- Homepage:
- Size: 45.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# auth-aws-profile
Make authenticating your AWS credentials with MFA easier by using a script provided in this repository.
Developed using Python 3.12 and [Poetry](https://python-poetry.org/).
The authentication process uses the V3 SDK for Python.
## Requirements
* Python `^3.12`.
* An AWS credentials file, e.g. `~/.aws/credentials`, with one or more sections that contain the following keys.
* `aws_access_key_id`
* `aws_secret_access_key`
* `aws_session_token`
* An AWS configuration file, e.g. `~/.aws/config`, with one or more `[profile *]` sections.
* The `[profile *]` should reference a section from `~/.aws/credentials` using `source_profile = *` and must have the `role_arn` key as well.
## Example
Here's what the script expects your AWS configuration and credentials file to look like.
```
# ~/.aws/config
[default]
region =
output = yaml
[profile my-role]
role_arn = arn:aws:iam:::role/my-role
source_profile = mfa
```
```
# ~/.aws/credentials
[default]
aws_access_key_id = foo
aws_secret_access_key = bar
[mfa]
aws_access_key_id = foo
aws_secret_access_key = bar
aws_session_token = baz
```
The AWS CLI can still find `my-role` even if you move it to `~/.aws/credentials` as long as it's renamed to `[my-role]` instead of `[profile my-role]`.
However, this script requires `my-role` to be in `~/.aws/config` and must be passed to the script using the complete profile section name, e.g. `profile my-role`.
## Usage
Install the script from PyPi and verify the version.
```
pip install auth-aws-profile
auth-aws-profile --version
```
Here's a simple usage example based on the files mentioned in [Example](#example).
```
auth-aws-profile "profile my-role" "arn:aws:iam:::mfa/john.doe"
```
See the help documentation for details.
```
auth-aws-profile --help
```
## Development
### Installation
* At least Python 3.12 must be installed.
* [Poetry](https://python-poetry.org/) is installed. See [Installation](https://python-poetry.org/docs/#installation).
* Install the project with Poetry from the root using `poetry install`.
### Installation (Dev Containers)
* Docker must be installed.
* Install the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for VS Code or similar.