THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

testupload of the AWSKeyring
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Tristan Morgan 3cc37bca45
Version Bump and changelog.
2 years ago
exe Adding some sub-commands. 2 years ago
lib Version Bump and changelog. 2 years ago
spec Test creds against AWS API (optionally). 2 years ago
.gitignore missing tests. 2 years ago
.rspec Refactor items. 2 years ago
.rubocop.yml Adding Awsapi module 2 years ago
.travis.yml Validate Role input too. 2 years ago
CHANGELOG.md Version Bump and changelog. 2 years ago
CODE_OF_CONDUCT.md Sledgehammer disable of rubocop metrics. 2 years ago
Gemfile AWS Keyring, initial commit. 4 years ago
LICENSE.txt Added open AWS Console functionality 2 years ago
README.md Update README for new feature. 2 years ago
Rakefile Version Bump and changelog. 2 years ago
awskeyring.gemspec Adding Awsapi module 2 years ago

README.md

Awskeyring

  • Build Status
  • Gem Version
  • license MIT
  • All Downloads
  • Version Downloads
  • Documentation

Awskeyring is a small tool to manage AWS account keys in the macOS Keychain.

Motivation

The motivation of this application is to provide a local secure store of AWS credentials using specifically in the macOS Keychain, to have them easily accessed from the Terminal, and to provide useful functions like assuming roles and opening the AWS Console from the cli. For Enterprise environments there are better suited tools to use like HashiCorp Vault.

Quick start

First you need to initialise your keychain to hold your AWS credentials.

awskeyring initialise

Then add your keys to it.

awskeyring add personal-aws

Now your keys are stored safely in the macOS keychain. To print environment variables run...

awskeyring env personal-aws

Alternatively you can create a profile using the credential_process config variable. See the AWS CLI Config docs for more details on this config option.

[profile personal]
region = us-west-1
credential_process = awskeyring json personal-aws 

See below and in the wiki for more details on usage.

Installation

Install it with:

$ gem install awskeyring --user-install

Usage

The CLI is using Thor with help provided interactively.

Commands:
  awskeyring --version, -v               # Prints the version
  awskeyring add ACCOUNT                 # Adds an ACCOUNT to the keyring
  awskeyring add-role ROLE               # Adds a ROLE to the keyring
  awskeyring console ACCOUNT             # Open the AWS Console for the ACCOUNT
  awskeyring env ACCOUNT                 # Outputs bourne shell environment exports for an ACCOUNT
  awskeyring exec ACCOUNT command...     # Execute a COMMAND with the environment set for an ACCOUNT
  awskeyring help [COMMAND]              # Describe available commands or one specific command
  awskeyring initialise                  # Initialises a new KEYCHAIN
  awskeyring json ACCOUNT                # Outputs AWS CLI compatible JSON for an ACCOUNT
  awskeyring list                        # Prints a list of accounts in the keyring
  awskeyring list-role                   # Prints a list of roles in the keyring
  awskeyring remove ACCOUNT              # Removes an ACCOUNT from the keyring
  awskeyring remove-role ROLE            # Removes a ROLE from the keyring
  awskeyring remove-token ACCOUNT        # Removes a token for ACCOUNT from the keyring
  awskeyring rotate ACCOUNT              # Rotate access keys for an ACCOUNT
  awskeyring token ACCOUNT [ROLE] [MFA]  # Create an STS Token from a ROLE or an MFA code

and autocomplete that can be installed with:

$ complete -C /usr/local/bin/awskeyring awskeyring

To set your environment easily the following bash function helps:

awsenv() { eval "$(awskeyring env $1)"; }

Development

After checking out the repo, run bundle update to install dependencies. Then, run rake to run the tests. Run bundle exec awskeyring to use the gem in this directory, ignoring other installed copies of this gem.

To install this gem onto your local machine, run bundle exec rake install.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/vibrato/awskeyring. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.