/aws-auth-helper

Set AWS environment variables from the credentials returned from a STS `assumeRole` on the command line for subsequent applications.

Primary LanguageJavaScript

AWS Auth Helper

This small application assists with retrieving temporary AWS environment variables from credentials that require 2-factor authentication and assuming an AWS IAM role.

This can be used for requiring a 2-factor authentication code to be entered before applications like Serverless and Apex deploy your Lambda applications.

The temporary credentials are sent to stdout and can be evaled to use them as environment variables in Bash commands.

# As part of your Node project
npm install aws-auth-helper --save

# package.json
...
    "scripts": {
        "deploy": "eval \"`aws-auth-helper` serverless deploy\""
    }
...

# Installed globally
npm install -g aws-auth-helper
eval "`aws-auth-helper [aws-profile-name]` npm run deploy"

The AWS profile is selected by from the first item that matches:

  1. passing a string after the aws-auth-helper command
  2. AWS_PROFILE environment variable
  3. default as the default

If you choose to use AWS_PROFILE make sure that you are passing the environment variable to the (sub)shell that calls aws-auth-helper.

For example:

export AWS_PROFILE && eval \"aws-auth-helper apex deploy\"

Requirements

You must have an AWS profile setup in your ~/.aws/credentials file similar to the following:

[default]
aws_access_key_id = ABCDEFG
aws_secret_access_key = abcdefg

You should also have a role based configuration that uses MFA in your ~/.aws/config file:

[profile default]
mfa_serial = arn:aws:iam::1234567890:mfa/username
output = json
region = us-east-1
role_arn = arn:aws:iam::1234567890:role/DesiredRoleName
source_profile = default