buzzsurfr / cloudkey

Manage your cloud access keys

☁️🔑 cloudkey

Manage your cloud access keys

Contents

• Install
• Overview
• Commands
  • list
  • rotate
  • version

Install

go install github.com/buzzsurfr/cloudkey

Overview

Cloudkey is a simple way to manage multiple access keys from different cloud providers.

Usage:
  cloudkey [command]

Available Commands:
  help        Help about any command
  list        Lists all cloud access keys
  rotate      Rotate the cloud access key
  version     Version will output the current build information

Global Flags:
      --cloud string    Cloud Provider (default "aws")
      --config string   config file (default is $HOME/.cloudkey.yaml)
      -h, --help        help for cloudkey

Use "cloudkey [command] --help" for more information about a command.

Commands

list

List pulls the credentials from environment variables and the credentials file and outputs them into a table. The "active" profile (which will be rotated by default or used with AWS CLI commands) will be in yellow text.

Usage:
  cloudkey list [flags]

Flags:
  -h, --help            help for list
  -o, --output string   Output format. Only supports 'wide'. (default "table")

Example Output:

CLOUD   NAME      ACCESS KEY ID          SOURCE
aws               AKIA************MPLE   EnvironmentVariable
aws     corp      AKIA************CORP   ConfigFile
aws     default   AKIA************G7UP   ConfigFile
aws     lab0      AKIA************FFKG   ConfigFile
aws     lab1      AKIA************YY42   ConfigFile

By default, the output type is table. You can change the output to wide and cloudkey will query AWS to get the account number and UserName associated with each key.

CLOUD   NAME      ACCOUNT        USERNAME       ACCESS KEY ID          SOURCE
aws               123456789012   myUser         AKIA************MPLE   EnvironmentVariable
aws     corp      234567890123   corpUser       AKIA************CORP   ConfigFile
aws     default   012345678901   defaultUser    AKIA************G7UP   ConfigFile
aws     lab0      987654321098   labUser0       AKIA************FFKG   ConfigFile
aws     lab1      987654321098   labUser1       AKIA************YY42   ConfigFile

rotate

Rotate uses the "active" access key (or the access key found with the --profile option) to request a new access key, applies the access key locally, then uses the new access key to remove the old access key.

Rotate will replace the access key in the same destination as the source, so environment variables are replaced or the config file (credentials file) is modified.

Usage:
  cloudkey rotate [flags]

Flags:
  -h, --help             help for rotate
  -p, --profile string   Profile to rotate

version

Version specifies the version, commit, and commit date in either JSON or YAML format.

Version will output the current build information

Usage:
  cloudkey version [flags]

Flags:
  -h, --help            help for version
  -o, --output string   Output format. One of 'yaml' or 'json'. (default "json")
  -s, --short           Print just the version number.

cloudkey's Issues

Add interfaces for mock testing

The AWS cloud section needs to have the API mocked for unit testing.

Ref: Mocking Out the AWS SDK for Go for Unit Testing

Progress bars for rotating key

https://github.com/vbauerster/mpb

implement one/many progress bars for rotating multiple keys
add option/flag to show/hide progress

Add logging and loglevels (`--debug` flag)

GoReleaser support

Switch to use GoReleaser for tags/releases (instead of manually)

Rotate all keys at once

Add concurrency to rotate and move to interfaced function for rotating keys

Add Examples

Add examples using Testable Examples in Go

Add testing for error conditions on getConfigPath under cloud/aws/profile_test.go