This command-line tool allows you to acquire AWS temporary (STS) credentials using Google Apps as a federated (Single Sign-On, or SSO) provider.
You'll first have to set up Google Apps as a SAML identity provider (IdP) for AWS. There are tasks to be performed on both the Google Apps and the Amazon sides; these references should help you with those configurations:
- How to Set Up Federated Single Sign-On to AWS Using Google Apps
- Using Google Apps SAML SSO to do one-click login to AWS
If you need a fairly simple way to assign users to roles in AWS accounts, we have another tool called Google AWS Federator that might help you.
You will need to know Google's assigned Identity Provider ID, and the ID that they assign to the SAML service provider.
Once you've set up the SAML SSO relationship between Google and AWS, you
can find the SP ID by drilling into the Google Apps console, under
Apps > SAML Apps > Settings for AWS SSO -- the URL will include a
component that looks like
that number is
You can find the
GOOGLE_IDP_ID, again from the admin console, via
Security > Set up single sign-on (SSO) -- the
SSO URL includes a
where the last bit (after the
=) is the IDP ID.
You can install quite easily via
pip, if you want to have it on your
# For basic installation localhost$ sudo pip install aws-google-auth # For installation with U2F support localhost$ sudo pip install aws-google-auth[u2f]
Note If using ZSH you will need to quote the install, as below:
localhost$ sudo pip install "aws-google-auth[u2f]"
If you don't want to have the tool installed on your local system, or if you prefer to isolate changes, there is a Dockerfile provided, which you can build with:
# Perform local build localhost$ cd ..../aws-google-auth && docker build -t aws-google-auth . # Use the Docker Hub version localhost$ docker pull cevoaustralia/aws-google-auth
If you want to develop the AWS-Google-Auth tool itself, we thank you! In order to help you get rolling, you'll want to install locally with pip. Of course, you can use your own regular workflow, with tools like virtualenv.
# Install (without U2F support) pip install -e . # Install (with U2F support) pip install -e .[u2f]
$ aws-google-auth -h usage: aws-google-auth [-h] [-u USERNAME] [-I IDP_ID] [-S SP_ID] [-R REGION] [-d DURATION] [-p PROFILE] [-D] [-q] [--no-cache] [--print-creds] [--resolve-aliases] [--save-failure-html] [-a | -r ROLE_ARN] [-k] [-V] Acquire temporary AWS credentials via Google SSO optional arguments: -h, --help show this help message and exit -u USERNAME, --username USERNAME Google Apps username ($GOOGLE_USERNAME) -I IDP_ID, --idp-id IDP_ID Google SSO IDP identifier ($GOOGLE_IDP_ID) -S SP_ID, --sp-id SP_ID Google SSO SP identifier ($GOOGLE_SP_ID) -R REGION, --region REGION AWS region endpoint ($AWS_DEFAULT_REGION) -d DURATION, --duration DURATION Credential duration ($DURATION) -p PROFILE, --profile PROFILE AWS profile (defaults to value of $AWS_PROFILE, then falls back to 'sts') -D, --disable-u2f Disable U2F functionality. -q, --quiet Quiet output --no-cache Do not cache the SAML Assertion. --print-creds Print Credentials. --resolve-aliases Resolve AWS account aliases. --save-failure-html Write HTML failure responses to file for troubleshooting. -a, --ask-role Set true to always pick the role -r ROLE_ARN, --role-arn ROLE_ARN The ARN of the role to assume -k, --keyring Use keyring for storing the password. -V, --version show program's version number and exit
Note that if you want longer than the default 3600 seconds (1 hour) duration, you must also modify the IAM Role to permit this. See the AWS documentation for more information.
- You will be prompted to supply each parameter
Note You can skip prompts by either passing parameters to the command, or setting the specified Environment variables.
- Set environment variables for
GOOGLE_SP_ID(see above under "Important Data" for how to find the last two; the first one is usually your email address)
- For Docker:
docker run -it -e GOOGLE_USERNAME -e GOOGLE_IDP_ID -e GOOGLE_SP_ID cevoaustralia/aws-google-auth
You'll be prompted for your password. If you've set up an MFA token for your Google account, you'll also be prompted for the current token value.
If you have more than one role available to you, you'll be prompted to choose the role from a list; otherwise, if your credentials are correct, you'll just see the AWS keys printed on stdout.
If you have a U2F security key added to your Google account, you won't be able to use this via Docker; the Docker container will not be able to access any devices connected to the host ports. You will likely see the following error during runtime: "RuntimeWarning: U2F Device Not Found".
Feeding password from stdin
To enhance usability when using third party tools for managing passwords (aka password manager) you can feed data in
When receiving data from
aws-google-auth disables the interactive prompt and uses
Before #82, all interactive prompts could be fed from
stdin already apart from the
Google Password: prompt.
$ password-manager show password | aws-google-auth
Google Password: MFA token:
Credentials Expiration: ...
Note: this feature is intended for password manager integration, not for passing passwords from command line. Please use interactive prompt if you need to pass the password manually, as this provide enhanced security avoid password leakage to shell history.
Storage of profile credentials
Through the use of AWS profiles, using the
--profile flag, the
aws-google-auth utility will store the supplied username, IDP and SP details in your
When re-authenticating using the same profile, the values will be remembered to speed up the re-authentication process. This enables an approach that enables you to enter your username, IPD and SP values once and then after only need to re-enter your password (and MFA if enabled).
Creating an alias as below can be a quick and easy way to re-authenticate with a simple command shortcut.
alias aws-development='unset AWS_PROFILE; aws-google-auth -I $GOOGLE_IDP_ID -S $GOOGLE_SP_ID -u $USERNAME -p aws-dev ; export AWS_PROFILE=aws-dev'
Or, if you've alredy established a profile with valid cached values:
alias aws-development='unset AWS_PROFILE; aws-google-auth -p aws-dev ; export AWS_PROFILE=aws-dev'
Notes on Authentication
Google supports a number of 2-factor authentication schemes. Each of these
results in a slightly different "next" URL, if they're enabled, during
Google controls the preference ordering of these schemes in the case that you have multiple ones defined.
The varying 2-factor schemes and their representative URL fragments handled by this tool are:
|No second factor||(none)|
This work is inspired by keyme -- their digging into the guts of how Google SAML auth works is what's enabled it.
The attribute management and credential injection into AWS configuration files was heavily borrowed from aws-adfs <https://github.com/venth/aws-adfs>