Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.15 KB

README.md

File metadata and controls

51 lines (33 loc) · 2.15 KB
Raw

aws-simple-mfa

Build Status

Use AWS CLI with MFA enabled, but no Assume Role required.

Advantage

  1. Use AWS CLI plugin system, no extra command required.
  2. Reuse official cache mechanism from AWS CLI without touching your config file.
  3. Multiple profiles supported.

Installation

You can install the latest package from GitHub source:

$ pip install -U git+https://github.com/kenshin54/aws-simple-mfa.git

Getting Started

Before using aws-simple-mfa plugin, you need to configure awscli first.

$ aws configure set plugins.cli_legacy_plugin_path  ~/.local/lib/python3.10/site-packages
$ aws configure set plugins.simplemfa awssimplemfa

The above commands add the below section to your aws config file. You can also directly edit your ~/.aws/config with the following configuration:

[plugins]
cli_legacy_plugin_path = ~/.local/lib/python3.10/site-packages
simplemfa = awssimplemfa

Refer to the documentation for more details.

Enable MFA via AWS Console and add mfa_serial to your profile, finally it would look like below:

[profile test]
region = us-west-2
aws_access_key_id = akid
aws_secret_access_key = skid
mfa_serial = my_mfa_serial

If you want to use the temporary session in other scenarios such as project development, aws-simple-mfa will generate a tmp credential file for you. The default location is ~/.aws/simple_mfa_tmp_credentials, you can update the AWS_SHARED_CREDENTIALS_FILE and AWS_PROFILE environment variables accordingly. You can also customize the tmp credential file in your profile like this:

[profile test]
region = us-west-2
aws_access_key_id = akid
aws_secret_access_key = skid
mfa_serial = my_mfa_serial
tmp_credential_file = /my/preferred/path

That's it, Try any aws commands that protected by MFA, you will be prompted to enter one time password.