federator

README

federator

A utility to federate into an AWS account using AWS Security Token Service and then get a link to go directly into the console.

Usage

Installation

The easiest way to install this tool is to grab the built binary from the releases, put it somewhere that is in your path, run a quick chmod +x <path_to_federator> and you'll be good to go.

The other way to get this tool is to pull down the repository and run make. This will put a file called federator in the bin folder in the root of the project directory.

Running

The federator tool has two modes, link and creds. These take the form of subcommands. The link subcommand gives you a link to sign into the AWS Console and the creds subcommand just gives you temporary credentials with the right commands to import it into a shell instance. There is also a JSON output mode so that it can be machine readable or piped into something like jq.

federator <subcommand> <options>

The arguments that each subcommand can take are listed below with the subcommands that they are compatible with.

Parameter	Subcommand	Defaults	Description
--role-arn	link, creds	--	The ARN of the role to assume
--external-id	link, creds	""	The external ID, if necessary, to be provided
--json	link, creds	false	Whether to print out the results in JSON or plain text
--issuer	link	https://aws.amazon.com	The link where the user will be taken when the session has expired
--destination	link	https://console.aws.amazon.com/console/home	The link that the user will be redirected to after login

Development

Installation

Once the code is cloned, you're going to need to run a preliminary make build so that all the dependencies come down and a build runs. Once that is done, an executable in ./bin will be added.

Running

The one requirement for running this tool is having installed and fully configured AWS CLI. Being able to run aws sts get-caller-identity successfully wil tell you that it is installed and configured properly.

The executable in bin has the right permissions, so running ./bin/federator will let you run it in development.

Contributing

Contributions to this project are welcome and encouraged. This project uses the standard golang tooling, go-fmt, and go modules. There is a make target for tests and one for generating coverage. Make sure to run these commands before creating a pull request.