Skip to content

Latest commit

 

History

History
143 lines (112 loc) · 4.04 KB

README.md

File metadata and controls

143 lines (112 loc) · 4.04 KB
Raw

This tool will request and set temporary credentials in your shell environment variables for a given role.

Installation

Download the appropriate latest released pre-build binary[1.0.0]:

Configuration

Main configuration file

  • Location: ~/.assume-role.properties
  • Available properties:
    • mfa.secret: MFA secret(optional;default: user prompt for MFA token;available options: configure MFA token generator)
    • duration: duration of session in hours(optional;default: 1)
    • format: the format of the output commands(optional;default: auto resolvable per OS;available options: powershell|bash|fish)

AWS profile configuration file

  • Location: ~/.aws/config
  • Example:

~/.aws/config:

[profile usermgt]
region = us-east-1

[profile stage]
# Stage AWS Account.
region = us-east-1
role_arn = arn:aws:iam::1234:role/SuperUser
source_profile = usermgt

[profile prod]
# Production AWS Account.
region = us-east-1
role_arn = arn:aws:iam::9012:role/SuperUser
mfa_serial = arn:aws:iam::5678:mfa/eric-holmes
source_profile = usermgt

~/.aws/credentials:

[usermgt]
aws_access_key_id = AKIMYFAKEEXAMPLE
aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/MYxFAKEYEXAMPLEKEY

Reference: https://docs.aws.amazon.com/cli/latest/userguide/cli-roles.html

In this example, we have three AWS Account profiles:

  • usermgt
  • stage
  • prod

Each member of the org has their own IAM user and access/secret key for the usermgt AWS Account. The keys are stored in the ~/.aws/credentials file.

The stage and prod AWS Accounts have an IAM role named SuperUser. The assume-role tool helps a user authenticate (using their keys) and then assume the privilege of the SuperUser role, even across AWS accounts!

Usage

Perform an action as the given IAM role:

$ assume-role stage aws iam get-user

The assume-role tool sets AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN environment variables and then executes the command provided.

If the role requires MFA, you will be asked for the token first or you can configure MFA secret and use auto token generation logic:

$ assume-role prod aws iam get-user
MFA code: 123456

If no command is provided, assume-role will output the temporary security credentials:

$ assume-role prod
export AWS_ACCESS_KEY_ID="ASIAI....UOCA"
export AWS_SECRET_ACCESS_KEY="DuH...G1d"
export AWS_SESSION_TOKEN="AQ...1BQ=="
export AWS_SECURITY_TOKEN="AQ...1BQ=="
export ASSUMED_ROLE="prod"
# Run this to configure your shell:
# eval $(assume-role prod)

Or windows PowerShell:

$env:AWS_ACCESS_KEY_ID="ASIAI....UOCA"
$env:AWS_SECRET_ACCESS_KEY="DuH...G1d"
$env:AWS_SESSION_TOKEN="AQ...1BQ=="
$env:AWS_SECURITY_TOKEN="AQ...1BQ=="
$env:ASSUMED_ROLE="prod"
# Run this to configure your shell:
# assume-role.exe prod | Invoke-Expression

If you use eval $(assume-role) frequently, you may want to create a alias for it:

  • zsh
alias assume-role='function(){eval $(command assume-role $@);}'
  • bash
function assume-role { eval $( $(which assume-role) $@); }

Advanced usage

Configure auto session creation on new bash shell

  1. Add the following lines to ~/.bashrc file:
eval-assume-role() {
    unset \
    ASSUMED_ROLE \
    AWS_ACCESS_KEY_ID \
    AWS_SECRET_ACCESS_KEY \
    AWS_SECURITY_TOKEN \
    AWS_SESSION_TOKEN
    eval $(assume-role $1)
}

read -p "Enter the AWS account for a new session: " arg1
if [[ $arg1 != '' ]]; then
    eval-assume-role $arg1
fi
  1. If you're a MacOs user make sure to include this line to /etc/bashrc:
if [ -f ~/.bashrc ]; then . ~/.bashrc; fi
  1. Manual usage of eval-assume-role: eval-assume-role <profile>