assume-rolers

assume-rolers is a tool to use a temporary AWS credentials. Currently, assume-rolers supports Linux and macOS only.

You can extend the tool by developing WebAssembly/WASI plugins!

Installation

No pre-built binaries are available so far. Please build this tool from the source.

$ cargo install assume-rolers

or

$ git clone https://github.com/yoshihitoh/assume-rolers
$ cd assume-rolers
$ cargo build --release

If you're planning to use this tool frequently, please copy the binary to a directory included in PATH.

$ cp ./target/release/assume-rolers ~/.local/bin/

How to use

Interactive mode

You can select a profile on the terminal. If the role you selected requires MFA, you can also set a token code on the terminal.

$ assume-rolers

Specifying the profile

You can pass a profile as a command line argument. If the role you selected requires MFA, you can set a token code via -t or --token flag.

$ assume-rolers <PROFILE_NAME> [-t <TOKEN>]

Deactivate the session

assume-rolers creates a new shell session, so you can deactivate it by exit command.

Outputs

assume-rolers will export the following parameters.

name	op	comment
AWS_PROFILE	unset	-
AWS_REGION	set	-
AWS_DEFAULT_REGION	set	-
AWS_ACCESS_KEY_ID	set	-
AWS_SECRET_ACCESS_KEY	set	-
AWS_SESSION_TOKEN	set	-
AWS_SESSION_EXPIRATION	set	expiration datetime in RFC 3339 format. e.g. "2022-11-20T12:01:36+00:00"
ASSUME_ROLERS_PROFILE	set	assumed profile name. you can use this variable for the shell prompt.

Credentials

assume-rolers depends on rusoto's DefaultCredentialsProvider backed by ChainProvider. So assume-rolers will look credentials in this order.

1. Environment variables: AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
2. credential_process command in the AWS config file, usually located at ~/.aws/config.
3. AWS credentials file. Usually located at ~/.aws/credentials.
4. IAM instance profile. Will only work if running on an EC2 instance with an instance profile/role.

quoted from Rusoto's document.

Plugins

Builtin plugins

You can use a builtin plugins with -c option.

name	note
export	show commands to export environment variable.
federation	show a federation url to sign-in to the AWS Management Console.

For example, you can use export plugin with the following command.

$ assume-rolers <PROFILE> -t <TOKEN> -p export

Write your own plugin

You can write your own plugin. The plugin must be built for wasm32-wasi target. See assume-rolers-export plugin as an example.

You can use the wasm/wasi plugin by specifying the path to the .wasm file. For example, you can use assume-rolers-export.wasm plugin with the following command.

$ assume-rolers <PROFILE> -t <TOKEN> -p ./plugins/assume-rolers-export.wasm

Shell completion

Currently, assume-rolers supports fish shell only.

try the following command to enable shell completion.

$ cp ./shell-completions/assume-rolers.fish ~/.config/fish/functions/