Skip to content

Latest commit

 

History

History
100 lines (82 loc) · 4.72 KB

README.md

File metadata and controls

100 lines (82 loc) · 4.72 KB
Raw

aws-one-punch



One command to grant all command prompts AWS access with IAM role credentials in OSX for AWS SSO users

Background

When working in organizations where AWS SSO is used to manage the AWS accounts, we can obtain the IAM temporary credentials in the user portal to access cloud resources from command lines. The pain point is the manual work (generate credentials, copy paste and execute in the command prompt, or to update the local credentials file) needs to be done every time when the temporary credentials are expired, and it will become worse when there are multiple command prompts opened which is quite common when working with Microservices whose resources are maintained through CloudFormation or equivalent.

Solution

AWS-one-punch retrieves the AWS SSO bearer token stored in Chrome cookie after the authentication process to interact with AWS SSO APIs to provide below functionalities:

  • List all assigned AWS accounts
  • List all assigned AWS IAM role in an AWS account
  • Grant all command promopts AWS access with temporary credentails from an IAM role

Prerequisites

  • AWS CLI needs to be installed and configured.
  • Chrome is used for AWS SSO.

Note: for simplicity, the default profile will be used for one punch access.

Setup

  1. install via Homebrew
  brew install gaarazhu/aws-one-punch/aws-one-punch
  1. set the AWS user portal in ~/.bash_profile or equivalent and reload it with source ~/.bash_profile
   export AWS_CONSOLE_DOMAIN="garyz.awsapps.com"
  1. run
$ aws-one-punch
NAME:
  aws-one-punch - one command to grant all command prompts AWS access with IAM role credentials in OSX for AWS SSO users.

USAGE:
  aws-one-punch [global options] command [command options] [arguments...]

VERSION:
  2.0.0

COMMANDS:
  list-accounts, ls-a  List all assigned AWS accounts
  list-roles, ls-r     List all assigned AWS IAM role in an AWS account
  access, a            Grant all command promopts AWS access with temporary credentails from an IAM role
  help, h              Shows a list of commands or help for one command

GLOBAL OPTIONS:
  --help, -h     show help (default: false)
  --version, -v  print the version (default: false)

Usage

  1. List all assigned AWS accounts
$ aws-one-punch list-accounts
AccountId: ins-sd4312, accountName: 20890663 (MRP IaaS Prod)
AccountId: ins-2ssfds, accountName: 79300001 (Sandbox 1)
AccountId: ins-3sadfa, accountName: 69127290 (MRP IaaS Non-Prod)
AccountId: ins-siki23, accountName: 58868209 (Data Analytics)
AccountId: ins-14oasn, accountName: 66060440 (Shared Services)
  1. List all assigned AWS IAM role in an AWS account
$ aws-one-punch list-roles --account-id ins-3sadfa
RoleName: DigitalDeveloperNonprodAccess
  1. Grant all command promopts AWS access with temporary credentails from an IAM role
$ aws-one-punch access --account-name 69127290 --role-name DigitalDeveloperNonprodAccess
AWS access granted with account 69127290 and IAM role DigitalDeveloperNonprodAccess

Note:

  1. if you see this error, please open the user portal to finish SSO authentication first.
2021/11/10 22:04:14 Warning: no AWS SSO token found, please finish the SSO authentication in the user portal first: https://gzhu.awsapps.com/start/#/. If you have already done this, please wait for aws-one-punch to execute the command.
  1. If above error message is still showing up after the SSO authentication, please don't panic as aws-one-punch will retry the operation until the token is available in the Cookie due to the fact that there is a delay up to 30 seconds caused by Chrome's persistence implementation with SQLitePersistentCookieStore.

Simplification

For furthur simplification, we can create an alias for above access command, or have it managed through pet.

Contribution

Your contributions are always welcome!

License

This work is licensed under MIT.