A wrapper for executing a command with AWS CLI v2 and SSO
Project description
aws2-wrap
This is a simple script to make it easier to use AWS Single Sign On credentials with tools that don't understand the sso
entries in an AWS profile.
The script provides the following capabilities:
- Run a command using AWS SSO credentials
- Generate a temporary profile in the $AWS_CONFIG_FILE and $AWS_SHARED_CREDENTIALS_FILE file
- Exporting the AWS SSO credentials
- Use the credentials via .aws/config
- Assume a role via AWS SSO
Please note that the script is called aws2-wrap
to show that it works with AWS CLI v2, even though the CLI tool is no longer called aws2
.
Install using pip
https://pypi.org/project/aws2-wrap
pip3 install aws2-wrap==1.2.2
Run a command using AWS SSO credentials
aws2-wrap [--profile <awsprofilename>] [--exec] <command>
Note that if you are using --exec
and <command>
contains spaces, it must be surrounded with double-quotation marks.
You can also specify the profile to be used via AWS_PROFILE which then allows the same profile to be used by subsequent tools and commands.
Examples:
aws2-wrap --profile MySSOProfile terraform plan
aws2-wrap --profile MySSOProfile --exec "terraform plan"
AWS_PROFILE=MySSOProfile aws2-wrap terraform plan
If you are having problems with the use of quotes in the command, you may find one of the other methods works better for you.
Generate a temporary profile in the $AWS_CONFIG_FILE and $AWS_SHARED_CREDENTIALS_FILE file
There are some utilities which work better with the configuration files rather than the environment variables. For example, if you need to access more than one profile at a time.
aws2-wrap --generate --profile $AWS_PROFILE --credentialsfile $AWS_SHARED_CREDENTIALS_FILE --configfile $AWS_CONFIG_FILE --outprofile $DESTINATION_PROFILE
Export the AWS SSO credentials
There may be circumstances when it is easier/better to set the appropriate environment variables so that they can be re-used by any aws
command.
Since the script cannot directly set the environment variables in the calling shell process, it is necessary to use the following syntax:
eval "$(aws2-wrap [--profile <awsprofilename>] --export)"
For example:
eval "$(aws2-wrap --profile MySSOProfile --export)"
If you are using PowerShell, the equivalent command is:
aws2-wrap --profile MySSOProfile --export | invoke-expression
Use the credentials via .aws/config
If you are using a tool that works with normal AWS credentials but doesn't understand the new AWS SSO credentials, another option is to add a profile to .aws/config
that calls the aws2-wrap
script.
For example, add the following block to .aws/config
:
[profile Wrapped]
credential_process = aws2-wrap --process --profile <awsprofilename>
then, after authentication, you can run any command that uses AWS credentials by specifying the "Wrapped" profile:
aws sso login --profile <awsprofilename>
export AWS_PROFILE=Wrapped
export AWS_SDK_LOAD_CONFIG=1
terraform plan
Note that because the profile is being specified via AWS_PROFILE
, it is sometimes necessary (as shown above) to set AWS_SDK_LOAD_CONFIG
in order to get tools like terraform
to successfully retrieve the credentials.
Assume a role via AWS SSO
Your .aws/config
file can look like this:
[default]
sso_start_url = xxxxxxxxxxxx
sso_region = us-west-2
sso_account_id = xxxxxxxxxxxx
sso_role_name = SSORoleName
[profile account1]
role_arn = arn:aws:iam::xxxxxxxxxxxx:role/role-to-be-assumed
source_profile = default
region = ap-northeast-1
allowing you to then run:
aws2-wrap --profile account1 <command>
and <command>
will be run under role-to-be-assumed
.
Credits
Thanks to @sodul, @damian-bisignano, @flyinprogrammer, @abeluck, @topu, @bigwheel, @krabbit, @jscook2345, @hieki, @blazdivjak, @fukushun1994, @johann8384, @ppezoldt, @atwoodjw, @lummish, @life36-vinny and @lukemassa for their contributions.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws2_wrap-1.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d81f58381ddf3ba16092bc83e5f4ceecf77e4cd6d4ba7ae871852faa85c6643 |
|
MD5 | ed8c0ee1c3bf074741e558efc8894fcb |
|
BLAKE2b-256 | 409463c4c3627414ed0d8a2eafadc4e5680757e4884f6d99b9304109bccc5025 |