stsauth 1.1.1

CLI tool for fetching AWS tokens.

stsauth

Creates a temporary AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY that can be used with command-line tools such as awscli, ansible, terraform and more.

This method of authentication is preferred because it eliminates the need for long-lived access keys and forces every user to use their own credentials when connecting to AWS Services.

• Installation
  • Using Pip
  • Using Docker
  • Configuration
• Usage
  • stsauth
  • stsauth authenticate
  • stsauth profiles
  • stsauth assume-role
• Warning
• Troubleshooting
• Credits

Installation

Using pip

# Uninstall if a version of `stsauth` already exists
$ pip uninstall stsauth

# Install the current release
$ pip install stsauth

# Install a specific version
$ pip install stsauth==0.1.0 # Get the latest from: https://pypi.org/project/stsauth/#history

# Upgrade an existing installation
$ pip install stsauth --upgrade

Using docker

docker pull cshamrick/stsauth:latest

Add the following alias to your ~/.bash_profile, ~/.bashrc, or ~/.zshrc:

alias stsauth='docker run --rm -it -v ~/.aws:/root/.aws -e AWS_PROFILE=$AWS_PROFILE -e AWS_DEFAULT_REGION=$AWS_DEFAULT_REGION cshamrick/stsauth:latest'

Configuration

• A valid AWS CLI configuration is required. For more information about the AWS CLI, see AWS CLI for more information.

• Sample ~/.aws/credentials file:

  [default]
  output = json
  region = us-east-1
  idpentryurl = https://<fqdn>/adfs/ls/idpinitiatedsignon.aspx?LoginToRP=urn:amazon:webservices
  domain = MYADDOMAIN
  okta_org = my-organization
  okta_shared_secret = 16CHARLONGSTRING
  aws_access_key_id = awsaccesskeyidstringexample
  aws_secret_access_key = awssecretaccesskeystringexample
  

Usage

stsauth cli

$ stsauth --help
Usage: stsauth [OPTIONS] COMMAND [ARGS]...

  Tools for managing AWS credentials through an ADFS portal.

Options:
  -v, --verbosity LVL  Either CRITICAL, ERROR, WARNING, INFO or DEBUG
  --version            Show the version and exit.
  --help               Show this message and exit.

Commands:
  assume-role   Used to assume another AWS IAM Role.
  authenticate  Authenticate to and fetch credentials for AWS through an...
  profiles      Lists the profile details from the credentialsfile or a...

stsauth authenticate

$ stsauth authenticate --help
Usage: stsauth authenticate [OPTIONS]

  Authenticate to and fetch credentials for AWS through an ADFS portal

Options:
  -u, --username TEXT             IdP endpoint username.
  -p, --password TEXT             Program will prompt for input if not
                                  provided.

  -i, --idpentryurl TEXT          The initial url that starts the
                                  authentication process.

  -d, --domain TEXT               The active directory domain.
  -c, --credentialsfile TEXT      Path to AWS credentials file.
  -l, --profile TEXT              Name of config profile.
  -r, --region TEXT               The AWS region to use. ex: us-east-1
  -k, --okta-org TEXT             The Okta organization to use. ex: my-
                                  organization

  -s, --okta-shared-secret TEXT   Okta Shared Secret for TOTP Authentication.
                                  WARNING! Please use push notifications if at
                                  all possible. Unless you are aware of what
                                  you are doing, this method could potentially
                                  expose your Shared Secret. Proceed with
                                  caution and use a tool like `pass` to
                                  securely store your secrets.

  -t, --vip-access-security-code TEXT
                                  VIP Access security code.
  -b, --browser                   If set, will attempt to open the console in
                                  your default browser.To enable opening the
                                  console in an incognito window, set
                                  `browser_path`in your config file `default`
                                  section to your browser executable.

  -o, --output [json|text|table]
  -e, --duration NUM              The duration in seconds of the requested session.
                                  [default: 3600]

  -f, --force                     Auto-accept confirmation prompts.
  --help                          Show this message and exit.

$ stsauth authenticate
Username: username
Password:

Please choose the role you would like to assume:
Account: account-name-0 (000000000000)
[0]: ADFS-Role-One
[1]: ADFS-Role-Two

Account: account-name-1 (000000000001)
[2]: ADFS-Role-One

Account: account-name-2 (000000000002)
[3]: ADFS-Role-One
[4]: ADFS-Role-Two

Selection: 2

Requesting credentials for role: arn:aws:iam::000000000001:role/ADFS-Role-One

------------------------------------------------------------
Your new access key pair has been generated with the following details:
------------------------------------------------------------
File Path: /Users/username/.aws/credentials
Profile: 000000000001-ADFS-Role-One
Expiration Date: 2018-06-27 16:29:01+00:00
------------------------------------------------------------
To use this credential, call the AWS CLI with the --profile option:
e.g. aws --profile 000000000001-ADFS-Role-One ec2 describe-instances
Or provided as an environment variable:
export AWS_PROFILE=000000000001-ADFS-Role-One
--------------------------------------------------------------

stsauth profiles

$ stsauth profiles --help
Usage: stsauth profiles [OPTIONS] [PROFILE]

  Lists the profile details from the credentialsfile or a specified profile.

  Args:     credentialsfile: The file containing the profile details.
  profile: (Optional) A specific profile to print details for.

Options:
  -c, --credentialsfile TEXT  Path to AWS credentials file.
  -q, --query TEXT            Value to query from the profile.
  --help                      Show this message and exit.

$ stsauth profiles
Account     Profile                      Expire Date         Status
----------- ---------------------------- ------------------- -------
None        default                      No Expiry Set       active
None        saml                         2018-06-25 16:32:20 expired
Account-One 000000000000-ADFS-Role-One   2018-06-25 16:36:27 expired
Account-Two 000000000000-ADFS-Role-Two   2018-06-25 16:47:51 expired
Account-One 000000000001-ADFS-Role-One   2018-06-27 10:04:46 active
Account-One 000000000002-ADFS-Role-One   2018-06-27 11:23:23 active
Account-Two 000000000002-ADFS-Role-Two   2018-06-27 11:28:22 active
Account-Two 000000000002-Assume-Role-One 2018-06-27 11:30:24 active

stsauth assume-role

$ stsauth assume-role --help
Usage: stsauth assume-role [OPTIONS] ROLE_ARN

  Used to assume another AWS IAM Role.

Options:
  -l, --profile TEXT          The AWS Profile to assume the role-arn from.
                              Uses AWS_PROFILE environment if available.

  --role-session-name TEXT    Specify if a custom session name is required.
                              Otherwise a generated value will be used.

  -c, --credentialsfile TEXT  Path to AWS credentials file.  [default:
                              ~/.aws/credentials]

  --help                      Show this message and exit.

# Export (or provide at CLI) an AWS_PROFILE with valid, unexpired credententials
$ export AWS_PROFILE=000000000002-ADFS-Role-Two

$ stsauth assume-role arn:aws:iam::000000000002:role/Assume-Role-One

------------------------------------------------------------
Your new access key pair has been generated with the following details:
------------------------------------------------------------
File Path: /Users/username/.aws/credentials
Profile: 000000000002-Assume-Role-One
Expiration Date: 2018-06-27 11:30:24+00:00
------------------------------------------------------------
To use this credential, call the AWS CLI with the --profile option:
e.g. aws --profile 000000000002-Assume-Role-One ec2 describe-instances
Or provided as an environment variable:
export AWS_PROFILE=000000000002-Assume-Role-One
--------------------------------------------------------------

Warning

It is strongly recommended to use Okta Push Notifications for MFA if at all possible. Storing your Shared Secret or passing it in through the command-line comes with the risk of exposing the Shared Secret to unintended persons. If compromised, the security of MFA is lost. Please proceed with caution and an understanding of the risks associated. If you believe your Shared Secret has been compromised, please revoke it immediately.

Troubleshooting

An error occurs when authenticating

An error occurred (AccessDenied) when calling the AssumeRoleWithSAML operation: Access denied

You likely have lost permission. Please try to sign in via AWS Console.

Credits

This project is based largely on Enabling Federation to AWS Using Windows Active Directory, ADFS, and SAML 2.0