aws_assume_role 1.1.0-universal-openbsd

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 420cf974134d7d1b411c635a6ef7f8e4c72f59f2cfdd3511b92848f37bda8f3d
+  data.tar.gz: ef8bc6d0bafcb2be4379c5fdfd1ba0591b6542421b29e19fcb38a7a3e1c84db5
+SHA512:
+  metadata.gz: 41d7bfa4f96f337782668a8eaa3e9c67d89f9450578934f80cb8396a00316c10cbc1d2534157e24372906a9ccd48b355196a7973b13b9dbf627797e1a8ca3278
+  data.tar.gz: f38e7e1b303b7fcfe8f8a7cb82ddb43d3c89f9ee7bb41adbf758ec1ec8c17a08452055a9686e9d9b43ac596b38165b294139de93e1efc7509e943a14f5de2846

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+*.swp
+vendor/
+pkg/
+Gemfile.lock
+spec/reports/
+tags
+*.gem
+coverage

data/.rubocop.yml

@@ -0,0 +1,57 @@
+---
+AllCops:
+    TargetRubyVersion: 2.2
+    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
+
+Layout/IndentationWidth:
+    Width: 4
+
+Layout/IndentHeredoc:
+    Enabled: false
+
+Style/TrailingCommaInArguments:
+    EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
+    EnforcedStyleForMultiline: comma
+
+Style/ClassAndModuleChildren:
+    Enabled: false
+
+Style/Documentation:
+    Enabled: false
+
+Naming/VariableName:
+    Enabled: false
+
+Style/StringLiterals:
+    EnforcedStyle: double_quotes
+
+Style/MethodMissing:
+    Enabled: false
+
+Style/TrivialAccessors:
+    Enabled: false
+
+Metrics/LineLength:
+  Max: 140

data/.ruby-version

@@ -0,0 +1 @@
+2.3.5

data/.simplecov

@@ -0,0 +1,22 @@
+require 'coveralls'
+Coveralls.wear_merged!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+])
+
+SimpleCov.start do
+
+  project_name 'AWS Assume Role'
+
+  add_filter '/spec/'
+  add_filter 'lib/aws_assume_role/vendored'
+
+  %w(aws_assume_role).each do |group_name|
+    add_group(group_name, "/#{group_name}/lib")
+  end
+
+  merge_timeout 60 * 15 # 15 minutes
+
+end

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+sudo: false
+script: bundle exec rake
+jobs:
+  include:
+    - stage: test
+      rvm: 2.2
+      script: bundle exec rake
+    - rvm: 2.3
+      script: bundle exec rake
+    - stage: deploy
+      rvm: 2.3
+      script: bundle exec rake setup_credentials && chmod 0600 /home/travis/.gem/credentials && bundle exec rake publish
+      secure: "VQtFNu/kHZdKrmURVx4cPgW4uo+7klWQkMA9fJVYvyQzYoELmo/Q5L/75AE8mzNzXHTsRfRu/ggA5vlyHtXpQguz0Tz/pZ0pi24HKIkFFYzmXL4xb2depLTLu2DBFOZUPhshyIEJ9rVhT4sE2E7TOZErhJ1od5NQFAn1I17NyF3qStiORpjptSeU12OReNrlx0kquiZjyYklxO1M3ybzWHLmxVYNRjabqjkm0YB2NrTTFraeivixpRLSolsbzxRBxZwT7UOv/zbEcp9RGZDHxtxcD71rq8KaCXWzscErrcCiJtzrnHUHjAULFFkCPD+rCSbJJkydjxFjg3lVJbf5JulZYr4VzWLimjLUZv4HeeN+bvtwrPKCOe0KxRnsAr4kieX16MO/5ehkNHzjFyiSfkVGWK0uoWGNE9MdCwHLo+o+cz3XoKMQFZhmSheuxKKibr0m9PedynQQdg7bc3kB3UaYurrDs5ldb8e97BnZJrTaTD3/8vaWv30MFuZ+Nw/Hi2uEP7nIZoZfz2D8S6a83YLAC7YAfnf/1lMCU2mfBSLg6L8H26h5bmOUfg10ZNiJDW0g0WqbjbI0xUcMjHd5qdPYP1bH4qtXAdDp9I09NHpteEo42P58milj7n7qWAx+TiRnQR0/jBJL+dXGwYRfoXuzI+4QDy8sq20Cvi34RPU="
+
+stages:
+  - name: test
+  - name: deploy
+    if: tag =~ ^v
+notifications:
+  slack:
+    secure: RmJmJSSDI8qdIpM2KKYoXX2mpcL85YZ9r9gF4rauZH9TuqnYOPP3kQ5iYJsE0VUTuZpuvQ8Axoux5IQr+IDK7kMrmrI0iaZp1dAR9tGK+aLF73sprOmQEou6HIoDs97UQhOWlsAUR8max/7WYdJYJ1o78dqavfFtOy0VcHCkUMRf+WxcKzz+8MunsocIYi0HXuz5vC3RAZCOaK2h8epXzmnWq0ke8YeTmddpDWC85wzeDNjA9T1j5WD+y6gC9F0vyaqVqDCsCXlbRKZl7a1TU9QGDVyBzowoGsWmTpFR80v4CKofAn6nnMRqblwATOS1jMT+HC+Yku29qFzXPugYa2KAUSQaYQiOe+TE5IDa2Exe/57ZQCOq4ve8gKSE9aQXh4Riq3u8qccM+UeoQdcwgXQIciTeWjqi4LQro6Dbyrv8XrUbxdG0VPsWmf49jbWgq6PPAJqdcbXr9eGb+81uJ2REa1vhDYZu4T3JHv4erd5QlyYWzeBJ/LMQav/C5mnMF43jg8DzZ2g0BZBao/reO9xcZre/ka8eOus9Ll1i+8PCxmFZMx2KDPC9i5R7bXL/CwPBjzFInmvHM0cgKjxrRSY6xMWSPyBbgdsKJl2qag74K5xG+2VPlMcVx0ikTKVjsja5iPlOYKhflGAfCKvpzPcd2QoEWg8jZYqZtO9Nj+M=
+    on_success: change
+    on_failure: change

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+## 1.1.0
+* Publish separate gems for Linux, BSD and MacOS (@randomvariable)
+
+## 1.0.6
+* Determine gem dependencies for OS X & Linux at install time (@randomvariable)
+
+## 1.0.5
+* Escape run commands properly (@mrprimate)
+
+## 1.0.4
+* Ensure ~/.aws exists before saving configuration
+
+## 1.0.3
+* Fix setting environment variable throwing string frozen error (@timbirk)
+
+## 1.0.2
+* Display credential prompts on stderr to allow shell eval to work (@timbirk)
+
+## 1.0.1
+* Fix setting environment variable throwing string frozen error (@mrprimate)
+* Fix incompatibility with version 0.4 of dry-struct (@tomhaynes)
+
+## 1.0.0
+* Fix deprecation warnings for dry-types
+* Minimum Ruby version is now 2.2
+
+## 0.2.2
+* Add Yubikey OATH support to the default chain provider (@randomvariable)
+
+## 0.2.1
+* Loosen requirement on highline to improve compatibility with Puppet tools (@randomvariable)
+
+## 0.2.0
+
+* Add support for Yubikey as a source for MFA (@davbo)
+* Remove expired credentials before writing new STS credentials (@davbo)
+
+## 0.1.2
+
+* Become compatible with Ruby 2.1 (@randomvariable)
+* Added test suite from AWS SDK for Ruby (@randomvariable)
+
+## 0.1.1
+
+* Fix logging on Ruby 2.2 (@randomvariable)
+
+## 0.1.0
+
+* Complete rewrite with SDK compatible API layer (@randomvariable)
+
+## 0.0.3
+
+* Store master credentials in OS credential store. (@mrprimate)
+
+## 0.0.2
+
+* Add CLI (@mrprimate)
+
+## 0.0.1
+
+* Initial release (@jtopper)

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+    gem "coveralls", require: false
+    gem "rake"
+end
+
+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

data/LICENSE.md

@@ -0,0 +1,201 @@
+                                 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

@@ -0,0 +1,303 @@
+aws-assume-role
+---------------
+[![Build Status](https://travis-ci.org/scalefactory/aws-assume-role.svg?branch=master)](https://travis-ci.org/scalefactory/aws-assume-role)
+[![Coverage Status](https://coveralls.io/repos/github/scalefactory/aws-assume-role/badge.svg?branch=master)](https://coveralls.io/github/scalefactory/aws-assume-role?branch=master)
+[![Code Climate](https://codeclimate.com/github/scalefactory/aws-assume-role/badges/gpa.svg)](https://codeclimate.com/github/scalefactory/aws-assume-role)
+[![Gem Version](https://badge.fury.io/rb/aws_assume_role.svg)](https://badge.fury.io/rb/aws_assume_role)
+
+aws-assume-role is a utility intended for developer and operator environments
+who need to use 2FA and role assumption to access AWS services.
+
+aws-assume-role can store both AWS access keys and ephemeral session tokens in
+OS credential vaults - Keychain on OSX and Keyring on Gnome.
+
+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 role assumption with a 2FA/MFA device.
+
+For more information on role assumption, see the [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html).
+
+Requirements
+------------
+*   Ruby ≥ 2.2
+*   macOS Keychain / GNOME Keyring
+*   At least one account with Amazon Web Services
+*   An IAM role configured in the target account
+*   An IAM user with rights to assume that role
+
+Install
+-------
+
+```sh
+gem install aws_assume_role
+```
+
+### Platform notes
+
+Gnome Keyring uses the [GirFFI](https://github.com/mvz/gir_ffi) bindings, which
+require introspection bindings as well as Gnone Keyring, by installing one of the following packages:
+
+``` sh
+# Debian/Ubuntu
+apt-get install gnome-keyring libgirepository1.0-dev libgnome-keyring-common libgnome-keyring-dev
+
+# Fedora
+dnf install gobject-introspection-devel
+
+# CentOS
+yum install gobject-introspection-devel
+```
+Setup
+-----
+
+You should already have an IAM user that you can log in to via AWS' console.
+If you do not already have an AWS access key and matching secret key for your
+own IAM user, use the AWS console to create that credential pair.
+
+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'
+```
+
+### 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:
+
+``` 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.
+
+More options are available in the application help.
+Use `> aws-assume-role --help ` for help at any time.
+
+Using MFA TOTP with a Yubikey
+-----------------------------
+
+[Yubikeys support TOTP](https://developers.yubico.com/OATH/) this offers some
+benefits over using a phone. One benefit is the TOTP token can be retrieved by
+an API call rather than a user reading the token from the device.
+
+This allows developers to call AWS through aws-assume-role, providing an MFA
+token without prompting for user input. To use this specify
+`--yubikey-oath-name` when calling configure role.
+
+``` 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 --yubikey-oath-name "Amazon Web Services:myuser@company_sso"
+```
+
+_Yubikey Support_: `aws-assume-role` uses the [smartcard gem](https://rubygems.org/gems/smartcard)
+to connect to the Yubikey, this itself depends upon some C libraries being installed. They provide
+[platform specific instructions](https://github.com/costan/smartcard/blob/master/BUILD#L19)
+for installing these libraries PC/SC.
+
+Testing a profile
+-----------------
+You can test a profile using
+```sh
+> aws-assume-role test -p company_sso
+Logged in as:
+    User: 9999999999
+    Account: arn:aws:iam::3333333333:user/username
+    ARN: AIDAIOSWINGTB
+
+```
+
+Running applications
+--------------------
+
+You can run another application using
+
+``` 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
+```
+
+Because we've enabled MFA, aws-assume-role will ask for your MFA token:
+```
+Please provide an MFA token
+000000
+```
+
+Listing available profiles
+--------------------------
+Configured profiles can be listed:
+```sh
+> aws-assume-role list
+company_sso
+company2_sso
+company3_sso
+```
+
+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.
+
+#### Bourne Shell and friends
+``` sh
+>  eval `./bin/aws-assume-role environment set -p company-dev`
+>  eval `./bin/aws-assume-role environment reset`
+```
+
+#### 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
+```
+
+#### PowerShell
+``` powershell
+> aws-assume-role environment set -s powershell -p company-dev | invoke-expression
+> aws-assume-role environment reset -s powershell | invoke-expression
+```
+
+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
+
+``` sh
+> aws-assume-role console -p company_sso
+```
+
+`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"
+
+AwsAssumeRole::DefaultProvider.new(options).resolve
+```
+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 role ⟶ assumption (look up source profile and check for 2FA)
+```
+
+Any of the above may get chained to do MFA or role assumption, or both,
+in the following order:
+
+```no-highlight
+second factor ⟶  ecs/instance profile
+```
+
+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:
+```
+require "aws_assume_role/core_ext/aws-sdk/credential_provider_chain"
+```
+
+Using any standard AWS SDK for Ruby v2 client will then use aws_assume_role for credential resolution.
+
+
+Please do not use this in production systems.
+
+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:
+
+*   `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.
+
+These are also available in Ruby as the `AwsAssumeRole.Config.backend_plugin` and
+`AwsAssumeRole.Config.backend_plugin` attributes.
+
+
+Development
+-----------
+
+Tests are conducted by Travis.
+
+You can run these locally using Rake:
+
+```shell
+bundle exec rake test
+```
+
+License
+-------
+
+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.
+
+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.