aws_assume_role 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55cb1bdbca27ae7dfaf53948e1ad746a66afcc25
-  data.tar.gz: 43b7ce33d786b7ebfabbedb921b2c9b3a5f28cf1
+  metadata.gz: 044bfb046234522a01fe4c334e9ba5c9d66a876b
+  data.tar.gz: cec5203ee0ab08fb4a8327e50acfdef5bca0caf7
 SHA512:
-  metadata.gz: ee94a33205511ab48a1c1f0e458ef98a20267b496cc556fd5cc35d87dbb4311d0d305374839348966e5b981ca29dee5ab0848ffa344215f5e20abc4ae864c815
-  data.tar.gz: 636303eb8f232061473a6d3de6a5809cc8eea20f3579c2f0eef8cd2e4964e08c569cce83c7b2fe05014c0980e76926038c67a998d7a10fc0201c5194b8ccd194
+  metadata.gz: 7dc82bd2a95bc854c7578389d36693bb1d4a5b3cbe677376172bc6043543495605bb069c230ece0c40b7221903ce46e553761e4a2afed991dbc34ff97589f3f9
+  data.tar.gz: b238ee97ccc78c24a68b58fa75190892550653a777119507ea8534a2d199b9f9f9f3c88b615a57e764783d0c7cf9e4b9fef995888af893d8e61b70d4cc0a06e3

data/.gitignore

@@ -4,3 +4,4 @@ vendor/
 pkg/
 Gemfile.lock
 spec/reports/
+tags

data/.rubocop.yml

@@ -1,37 +1,57 @@
 ---
+#require: rubocop-rspec
 AllCops:
     DisplayCopNames: true
+    Exclude:
+    - 'lib/aws_assume_role/vendored/**/*.rb'
 
 Metrics/MethodLength:
     Enabled: false
 
+Metrics/AbcSize:
+    Enabled: false
+
+Metrics/BlockLength:
+    Enabled: false
+
+Metrics/ClassLength:
+    Enabled: false
+
+Metrics/CyclomaticComplexity:
+    Enabled: false
+
+Metrics/PerceivedComplexity:
+    Enabled: false
+
 Style/IndentationWidth:
     Width: 4
 
+RSpec/ExampleLength:
+    Enabled: false
+
 Style/TrailingCommaInArguments:
     EnforcedStyleForMultiline: comma
 
 Style/TrailingCommaInLiteral:
     EnforcedStyleForMultiline: comma
 
-Style/EmptyLinesAroundModuleBody:
-    EnforcedStyle: empty_lines
-
-Style/EmptyLinesAroundClassBody:
-    EnforcedStyle: empty_lines
-
-Style/EmptyLinesAroundMethodBody:
+Style/ClassAndModuleChildren:
     Enabled: false
 
-Style/EmptyLinesAroundBlockBody:
+Style/Documentation:
     Enabled: false
 
-Metrics/ClassLength:
+Style/VariableName:
     Enabled: false
 
-Metrics/AbcSize:
+Style/StringLiterals:
+    EnforcedStyle: double_quotes
+
+Style/MethodMissing:
     Enabled: false
 
-Metrics/PerceivedComplexity:
+Style/TrivialAccessors:
     Enabled: false
 
+Metrics/LineLength:
+  Max: 140

data/Gemfile

@@ -1,18 +1,12 @@
 # frozen_string_literal: true
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-case Gem::Platform.local.os
-when 'linux'
-    gem 'gir_ffi-gnome_keyring', '~> 0.0.3'
-when 'darwin'
-    gem 'ruby-keychain', '~> 0.3.2'
+group :development do
+    gem "pry", "~> 0.10"
+    gem "pry-byebug"
+    gem "pry-rescue", "~> 1.4"
+    gem "pry-stack_explorer", "~> 0.4"
+    gem "pry-state"
 end
-
-# Development dependencies - didn't seem to get installed when
-# referenced in the gemspec, find out why.
-gem 'bundler'
-gem 'rake'
-gem 'rspec'
-gem 'rubocop', require: false

data/LICENSE.md

@@ -1,19 +1,201 @@
-The MIT License (MIT)
-Copyright (c) 2016 The Scale Factory Limited
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,205 +1,236 @@
-# aws-assume-role
+aws-assume-role
+---------------
 
-This will get role credentials for you, managing 2FA devices, and set those
-credentials in environment variables then execute a provided command. It stores
-the fetched credentials in Gnome Keyring or OSX Keychain so they are not
-readable from disk.
+aws-assume-role is a utility intended for developer and operator environments
+who need to use 2FA and role assumption to access AWS services.
 
-### Why?
+aws-assume-role can store both AWS access keys and ephemeral session tokens in
+OS credential vaults - Keychain on OSX and Seahorse on Gnome.
 
-This keeps your credentials safe in the keystore, and they are set as
+Why?
+---
+
+This keeps your credentials safe in the keystore, and exist as
 environment variables for the duration and context of the executing command.
 This helps prevent credential leaking and theft, and means they aren't stored on
 disk as unencrypted files.
 
-It allows easy credential management and roll assumption with a 2FA/MFA device.
-
-For security and account management purposes we don't want to be managing users
-in multiple accounts, just centrally then allowing them to assume roles in
-other accounts.
+It allows easy credential management and role assumption with a 2FA/MFA device.
 
-###
+For more information on role assumption, see the AWS documentation.
 
-Assumptions:
+Requirements
+------------
+*   Ruby ≥ 2.1
+*   OS X KeyChain or GNOME Keyring
 
-- You have a parent/master account which you authenticate against with a 2FA
-  device.
-- You then assume a role in another account.
+Install
+-------
 
-This is easy to achieve in a web console, but you probably want to use tools
-like Terraform of AWS Cli. This makes using those tools easy, without having to
-constantly fetch and manage credentials for assumed roles, or provide
-users/access keys for each account.
-
-## Install
-
-`gem install aws_assume_role`
+```sh
+gem install aws_assume_role
+```
 
 ### Platform notes
 
 Gnome Keyring uses the [GirFFI](https://github.com/mvz/gir_ffi) bindings, which
-requires the introspection bindings to be installed (as well as gnome-keyring).
-`apt-get install gnome-keyring libgirepository1.0-dev` for Debian/Ubuntu.
+require introspection bindings as well as Gnone Keyring, by installing one of the following packages:
 
-## Config file
+``` sh
+# Debian/Ubuntu
+apt-get install gnome-keyring libgirepository1.0-dev
 
-Create a config file, the default is `~/.aws/assume.yaml`
-
-```yaml
----
-default:
-    set_environment: false
-    # credentials come from .aws/credentials default profile or environment
-
-scalefactory:
-    # if this profile is passed don't set the environment credentials
-    set_environment: false
-    # load credentials from sf_sso profile in .aws/credentials
-    profile: sf_sso
+# Fedora
+dnf install gobject-introspection-devel
 
+# CentOS
+yum install gobject-introspection-devel
+```
+Setup
+-----
+aws-assume-role works best if you also store permanent credentials in your keystore:
+
+``` sh
+> aws-assume-role configure
+Enter the profile name to save into configuration
+company-sso
+Enter the AWS region you would like to default to:
+eu-west-1
+Enter the AWS Access Key ID to use for this profile:
+1234567890010
+Enter the AWS Secret Access Key to use for this profile:
+abcdefghijklmnopqrstuvwzyx1
+Profile `company-sso` saved to '/home/growthsmith/.aws/config'
+```
 
-# These use the scalefactory profile above
-xx_mgmt:
-    parent: scalefactory
-    set_environment: true
-    type: assume_role
-    region: eu-west-1
-    role_arn: arn:aws:iam::123456789012:role/RoleNameHere
+### Configuring roles
+Now that you've set up permanent credentials in your OS credential store, you can now
+set up a role that you will assume in every day use:
 
-xx_test:
-    parent: scalefactory
-    set_environment: true
-    type: assume_role
-    role_arn: arn:aws:iam::123456789012:role/RoleNameHere
+``` sh
+> aws-assume-role configure role -p company-dev --source-profile company-sso  \
+--role-arn=arn:aws:iam::000000000001:role/ViewEC2 --role-session-name=growthsmith \
+--mfa-serial automatic
+```
+`--mfa-serial automatic` will look up your default attached multi-factor device, but you can specify a specific ARN.
 
-xx:
-    type: list
-    set_environment: true
-    list:
-     - name:       xx_test
-       env_prefix: TEST_
-     - name:       xx_mgmt
-       env_prefix: MGMT_
+More options are available in the application help.
+Use `> aws-assume-role --help ` for help at any time.
 
+Running applications
+--------------------
 
-# These use the default above
-yy_mgmt:
-   set_environment: true
-   type: assume_role
-   role_arn: arn:aws:iam::123456789012:role/RoleNameHere
+You can run another application using
 
-yy_test:
-   set_environment: true
-   type: assume_role
-   role_arn: arn:aws:iam::123456789012:role/RoleNameHere
+``` sh
+aws-assume-role run -p company-dev -- aws ec2 describe-instances --query \
+"Reservations[*].Instances[*].PrivateIpAddress" --output=text
+10.254.4.20
+10.254.4.15
+10.254.0.10
+10.254.4.5
+```
 
-xx:
-   type: list
-   set_environment: true
-   list:
-    - name:       xx_test
-      env_prefix: TEST_
-    - name:       xx_mgmt
-      env_prefix: MGMT_
+Because we've enabled MFA, aws-assume-role will ask for your MFA token:
+```
+Please provide an MFA token
+000000
+```
 
 
+Deleting a profile
+------------------
+If a set of credentials key needs revoking, or the profile isn't relevant anymore:
+``` sh
+> aws-assume-role delete -p company-sso
+Please type the name of the profile, i.e. company-sso , to continue deletion.
+company-sso
+Profile company-sso deleted
 ```
 
+Migrating AWS CLI profiles
+------------------
+It's better to revoke the existing keys and generate new ones. We try to overwrite the plaintext configuration
+file with random data, but this does not take care of ~/.aws/credentials and does not account for SSD wear
+levelling or copy-on-write snapshots.
+```
+aws-assume-role migrate -p company-sso
+Profile 'company-sso' migrated to keyring.
+```
 
+Exporting environment variables
+-------------------------------
+You can use a session token in your shell any supported application without using
+`aws-assume-role`.
 
+You can also remove environment variables after finishing using the reset command.
 
-## How to use?
-
-You need a key and secret for each `basic` role (a `parent`). You can set this
-in the environment variable or in the `~/.aws/credentials` file.
+#### Bourne Shell and friends
+``` sh
+>  eval `./bin/aws-assume-role environment set -p company-dev`
+>  eval `./bin/aws-assume-role environment reset`
+```
 
-It is recommended that you set this in the environment variable, the first time
-aws-assume-role runs it will place these values in the keystore so they are
-safe.
+#### fish
+``` fish
+> set creds (bin/aws-assume-role environment set -s fish -p company-dev); eval $creds; set -e creds
+> set creds (bin/aws-assume-role environment reset -s fish); eval $creds; set -e creds
+```
 
-### Add the basic/profile credentials to keystore
+#### PowerShell
+``` powershell
+> aws-assume-role environment set -s powershell -p company-dev | invoke-expression
+> aws-assume-role environment reset -s powershell | invoke-expression
+```
 
-You can add the credentials that the system will use to assume roles to the
-keystore. This is the recommended way of using `aws-assume-role`.
+Launch the AWS console
+---------------------
+Given that `aws-assume-role` has knowledge of your role ARNs via AWS CLI profiles, you can
+get to the AWS console for that role/account using
 
-To add(or update) credentials use:
+``` sh
+> aws-assume-role console -p company-sso
+```
 
-```shell
-$ aws-assume-role --profile scalefactory --add
-Enter your AWS_ACCESS_KEY_ID: 
-1234567890010
-Enter your AWS_SECRET_ACCESS_KEY: 
-abcdefghijklmnopqrstuvwzyx1
-Enter a AWS Region:
-eu-west-1
+`aws-assume-role` will first attempt to log in and get a federated UI link, and
+otherwise fall back to the "switch role" page.
 
+Using inside Ruby
+-----------------
+To get a set of credentials via the OS credential store, or using console-based MFA, use
+the following:
 ```
+require "aws_assume_role"
 
-### In Environment variable
-
+AwsAssumeRole::DefaultProvider.new(options).resolve
 ```
-export AWS_ACCESS_KEY_ID=1234567890010
-export AWS_SECRET_ACCESS_KEY=abcdefghijklmnopqrstuvwzyx1
-export AWS_DEFAULT_REGION=eu-west-1
+where options is a hash with the following symbol keys:
+*   `access_key_id`
+*   `secret_access_key`
+*   `session_token`
+*   `persist_session`
+*   `duration_seconds`
+*   `role_arn`
+*   `role_session_name`
+*   `serial_number`
+*   `source_profile`
+*   `region`
+
+`aws_assume_role` resolves credentials in almost the same way as the AWS SDK, i.e.:
+
+```no-highlight
+static credentials ⟶ environment variables ⟶ configured profiles
 ```
 
-Then run the `aws-assume-role` command.
+Any of the above may get chained to do MFA or role assumption, or both,
+in the following order:
 
-### in credentials file
+```no-highlight
+second factor ⟶ role assumption (look up source profile and check for 2FA) ⟶ ecs/instance profile
+```
 
-I have the following entry in `~/.aws/credentials`:
+These are the same as the AWS SDK equivalents whereever possible. The command line help will give an explanation of the rest.
 
+### Monkeypatching the AWS SDK
+You can also override the standard AWS SDK credential resolution system by including the following:
 ```
-[sf_sso]
-aws_access_key_id = 1234567890010
-aws_secret_access_key = abcdefghijklmnopqrstuvwzyx1
-region = eu-west-1
+require "aws_assume_role/core_ext/aws-sdk/credential_provider_chain"
 ```
 
-### Environment Variables Set
+Using any standard AWS SDK for Ruby v2 client will then use aws_assume_role for credential resolution.
 
-If `region` is defined for an `assume_role` type the environment variable
-`AWS_DEFAULT_REGION` will be set with that value, otherwise it will be left
-blank.
 
-`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_SESSION_TOKEN` will all
-be set.
+Please do not use this in production systems.
 
-If a type of `list` is called the environment variables will all be set with the
-provided prefix, e.g.
+Other keyring backends
+----------------------
+`aws-assume-role` uses the Keyring gem for secure secret storage. By default, this will use OS X keycain
+or GNOME Keyring. To load alternatives, set the following environment variables:
 
-```
-MGMT_AWS_ACCESS_KEY_ID=122343534535435435
-MGMT_AWS_DEFAULT_REGION=eu-west-1
-MGMT_AWS_SECRET_ACCESS_KEY=+4324234234235454353535353535
-MGMT_AWS_SESSION_TOKEN=F353453535345345345345345353534
-TEST_AWS_ACCESS_KEY_ID=53454353453453453534
-TEST_AWS_SECRET_ACCESS_KEY=3534534534534534534534
-TEST_AWS_SESSION_TOKEN=5435345353453
-```
+*   `AWS_ASSUME_ROLE_KEYRING_BACKEND`: Which backend to use, as the name of the Ruby class.
+*   `AWS_ASSUME_ROLE_KEYRING_PLUGIN` : Name of a gem to load.
 
-If you use the `-v` or `--verbose` flag it will print out any AWS environment
-variables set at the end of the action.
+These are also available in Ruby as the `AwsAssumeRole.Config.backend_plugin` and
+`AwsAssumeRole.Config.backend_plugin` attributes.
 
-### Calling another application
+License
+-------
 
-You can call another application by passing a bare double dash followed by the
-target command.
-
-```
-aws-assume-role --profile yy_mgmt -- aws ec2 describe-instances --query "Reservations[*].Instances[*].PrivateIpAddress" --output=text 
-10.254.4.20
-10.254.4.15
-10.254.0.10
-10.254.4.5
-```
+This library and program is distributed under the
+[Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
 
+```no-highlight
+Copyright 2017. The Scale Factory Ltd. All Rights Reserved.
+Portions Copyright 2013. Amazon Web Services, Inc. All Rights Reserved.
 
-## Deleting keystore values
+licensed under the apache license, version 2.0 (the "license");
+you may not use this file except in compliance with the license.
+you may obtain a copy of the license at
 
-Maybe you have a new keypair?
+    http://www.apache.org/licenses/license-2.0
 
-```
-aws-assume-role --profile yy_mgmt --delete
-aws-assume-role --profile scalefactory --delete
-```
+unless required by applicable law or agreed to in writing, software
+distributed under the license is distributed on an "as is" basis,
+without warranties or conditions of any kind, either express or implied.
+see the license for the specific language governing permissions and
+limitations under the license.