mydrive-aws-mfa 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6818eb4557e8103bf23574833e74ae03f5ff732a
+  data.tar.gz: 569087a1cc328f298ad6c8fd3f575b68a717135b
+SHA512:
+  metadata.gz: eccbac3e8b5987af89b0022aca505c907c08986f5812b160887e9ca1e9067a57fa4f07358f20c54718f852062dc549634f73b0cc7abf347a1417fa52d558810e
+  data.tar.gz: 5d3dc00f06ba04b546d1fcdb9e67d9573e7255655eb9479efc2b3562967ac613a9bcd57b7f00d872dfb34699fdc3251470e3f72f7f62a30819b1174918cf6b9f

data/LICENSE

@@ -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,57 @@
+# AWS-MFA
+
+## Introduction
+
+This is a fork of the original AWS MFA gem found [here](https://github.com/lonelyplanet/aws-mfa/). The original repository is for a stand-alone shell script.
+
+`mydrive-aws-mfa` can be inserted into a ruby application to prepare the environment for that single instance to interact with AWS SDK tools. It retrieves temporary credentials for assuming an AWS role, by first obtaining an MFA token from the user.
+
+It uses [AWS STS](http://docs.aws.amazon.com/cli/latest/reference/sts/index.html) to get temporary credentials. This is necessary if you have [MFA](https://aws.amazon.com/iam/details/mfa/) enabled on your account. The variables it sets are:
+
+* AWS_SECRET_ACCESS_KEY
+* AWS_ACCESS_KEY_ID
+* AWS_SESSION_TOKEN
+* AWS_SECURITY_TOKEN
+
+## Prerequisites
+
+Before using `mydrive-aws-mfa`, you must have the [AWS CLI](https://aws.amazon.com/cli/) installed (through whatever [method](http://docs.aws.amazon.com/cli/latest/userguide/installing.html) you choose) and configured (through `aws configure`).
+
+## Installation
+
+First, add the Gem into a project's Gemfile:
+ `gem "mydrive-aws-mfa"`
+Second, add the following to a script or any code that will be ran once upon execution:
+ ```
+ require "aws_mfa_client"
+
+ AwsMfaClient.new.execute
+ ```
+The gem will require the user to input their MFA token if it hasn't been ran in a while, so it is best to place the `AwsMfaClient` such that it will be ran once upon initial execution of the program.
+
+## Usage
+
+Upon running `AwsMfaClient.new.execute`, the gem will prompt the user for the 6-digit token from their MFA device. This will retrieve AWS MFA credentials that are valid for one hour and cache them. These credentials are loaded into the environment for duration of that program.
+
+Within the following hour, any program using the gem can be executed without requiring the user to input their MFA token and will instead retrieve the credentials from the cache.
+
+If user's AWS configuration is set up for different profiles, the user can change the AWS role they assume by passing in the profile as the `AWS_PROFILE` environment variable. By default, the role specified by the `default` profile will be assumed.
+
+For example, given a program `bin/fake_program` containing `AwsMfaClient.new.execute`, running `AWS_PROFILE=production bin/fake_program` will assume the role specified by the `production` profile. Instead, running `bin/fake_program` will assume the role specified by the `default` profile.
+
+Each profile has it's own cache, so supplying a different `AWS_PROFILE` will prompt the user for the 6-digit token again.
+
+## Release Process
+
+Maintainers should use the standard process below when releasing a new version. The text can be copied into a GitHub issue or PR to serve as a checklist.
+
+```
+- [ ] test the gem locally
+  - [ ] test using the existing suite
+  - [ ] test any changes in this release
+- [ ] update `s.version` in `mydrive-aws-mfa.gemspec`
+- [ ] build the gem locally: `gem build mydrive-aws-mfa.gemspec`
+- [ ] publish to rubygems: `gem push mydrive-aws-mfa-x.x.x.gem`
+- [ ] create a release on GitHub https://github.com/mydrive/mydrive-aws-mfa/releases
+  - [ ] create a tag for the release
+```

data/lib/aws_mfa.rb

@@ -0,0 +1,78 @@
+require 'aws-sdk-core/ini_parser'
+require 'fileutils'
+require 'json'
+require_relative 'aws_mfa/credentials_loader'
+require_relative 'aws_mfa/errors'
+require_relative 'aws_mfa/profile_config'
+require_relative 'aws_mfa/shell_command'
+
+class AwsMfa
+  ARN_CONFIG_FILE_PATH = ".aws/config"
+  MYDRIVE_CREDENTIALS_FILE_PATH = '.mydrive-aws'
+
+  def initialize
+    verify_aws_installed
+    @aws_config_file = find_aws_config_file
+    @mydrive_credentials_cache_dir = set_mydrive_credentials_cache_dir
+  end
+
+  def execute
+    profile = ENV['AWS_PROFILE'] || 'default'
+    profile_config = load_profile_config(profile)
+    credentials = load_credentials(profile_config)
+    unset_environment
+    export_credentials(credentials)
+  end
+
+  private
+
+  attr_reader :aws_config_file, :mydrive_credentials_cache_dir
+
+  def verify_aws_installed
+    unless AwsMfa::ShellCommand.new("which aws").call.success?
+      raise Errors::CommandNotFound, "Could not find the aws command"
+    end
+  end
+
+  def find_aws_config_file
+    aws_config_file = File.join(ENV['HOME'], ARN_CONFIG_FILE_PATH)
+    unless File.readable?(aws_config_file)
+      raise Errors::ConfigurationNotFound, 'Aws configuration not found. You must run `aws configure`'
+    end
+
+    aws_config_file
+  end
+
+  def set_mydrive_credentials_cache_dir
+    credential_directory = File.join(ENV['HOME'], MYDRIVE_CREDENTIALS_FILE_PATH)
+    FileUtils.mkdir_p(credential_directory) unless File.directory?(credential_directory)
+    credential_directory
+  end
+
+  def load_profile_config(profile)
+    aws_config = Aws::IniParser.ini_parse(File.read(aws_config_file))
+    if profile_config = aws_config[profile]
+      AwsMfa::ProfileConfig.new(profile_config, profile)
+    else
+      raise Errors::Error, "MFA serial number not found for profile '#{profile}'"
+    end
+  end
+
+  def load_credentials(profile_config)
+    CredentialsLoader.new(mydrive_credentials_cache_dir).load_credentials(profile_config)
+  end
+
+  def unset_environment
+    ENV.delete('AWS_SECRET_ACCESS_KEY')
+    ENV.delete('AWS_ACCESS_KEY_ID')
+    ENV.delete('AWS_SESSION_TOKEN')
+    ENV.delete('AWS_SECURITY_TOKEN')
+  end
+
+  def export_credentials(credentials)
+    ENV['AWS_SECRET_ACCESS_KEY'] = credentials['SecretAccessKey']
+    ENV['AWS_ACCESS_KEY_ID'] = credentials['AccessKeyId']
+    ENV['AWS_SESSION_TOKEN'] = credentials['SessionToken']
+    ENV['AWS_SECURITY_TOKEN'] = credentials['SessionToken']
+  end
+end

data/lib/aws_mfa/credentials_loader.rb

@@ -0,0 +1,67 @@
+require_relative 'errors'
+require_relative 'shell_command'
+
+class AwsMfa
+  class CredentialsLoader
+    MFA_EXPIRATION_PERIOD_IN_SECONDS = 3600
+
+    def initialize(mydrive_credentials_cache_dir)
+      @mydrive_credentials_cache_dir = mydrive_credentials_cache_dir
+    end
+
+    def load_credentials(profile_config)
+      credentials_file = File.join(mydrive_credentials_cache_dir, build_credentials_file_name(profile_config))
+
+      if File.readable?(credentials_file) && token_not_expired?(credentials_file)
+        credentials = File.read(credentials_file)
+      else
+        credentials = load_credentials_from_aws(profile_config)
+        write_credentials_to_file(credentials_file, credentials)
+      end
+
+      JSON.parse(credentials).fetch('Credentials')
+    end
+
+    private
+
+    attr_reader :mydrive_credentials_cache_dir
+
+    def build_credentials_file_name(profile_config)
+      source_profile = profile_config.source_profile || profile_config.profile
+      "#{source_profile}_#{profile_config.profile}_mfa_credentials"
+    end
+
+    def token_not_expired?(credentials_file)
+      mtime = File.stat(credentials_file).mtime
+      Time.new - mtime < MFA_EXPIRATION_PERIOD_IN_SECONDS
+    end
+
+    def load_credentials_from_aws(profile_config)
+      token_code = request_code_from_user
+      credentials_command = build_credentials_command(profile_config, token_code)
+      result = AwsMfa::ShellCommand.new(credentials_command).call
+      if result.success?
+        result.output
+      else
+        raise Errors::InvalidCode, 'There was a problem validating the MFA code with AWS'
+      end
+    end
+
+    def write_credentials_to_file(credentials_file, credentials)
+      File.open(credentials_file, 'w') { |file| file.write(credentials) }
+    end
+
+    def request_code_from_user
+      puts 'Enter the 6-digit code from your MFA device:'
+      code = $stdin.gets.chomp
+      raise Errors::InvalidCode, 'That is an invalid MFA code' unless code =~ /^\d{6}$/
+      code
+    end
+
+    def build_credentials_command(profile_config, token_code)
+      "aws --profile #{profile_config.source_profile} --region eu-west-1 --output json sts assume-role " \
+      "--role-arn #{profile_config.role_arn} --role-session-name aws-mfa-session " \
+      "--serial-number #{profile_config.mfa_serial} --token-code #{token_code}"
+    end
+  end
+end

data/lib/aws_mfa/errors.rb

@@ -0,0 +1,10 @@
+class AwsMfa
+  class Errors
+
+    class Error < StandardError; end
+    class ConfigurationNotFound < Error; end
+    class CommandNotFound < Error; end
+    class InvalidCode < Error; end
+
+  end
+end

data/lib/aws_mfa/profile_config.rb

@@ -0,0 +1,12 @@
+class AwsMfa
+  class ProfileConfig
+    attr_reader :mfa_serial, :profile, :role_arn, :source_profile
+
+    def initialize(profile_config, profile)
+      @mfa_serial = profile_config["mfa_serial"]
+      @profile = profile
+      @role_arn = profile_config["role_arn"]
+      @source_profile = profile_config["source_profile"]
+    end
+  end
+end

data/lib/aws_mfa/shell_command.rb

@@ -0,0 +1,16 @@
+require_relative 'shell_command_result'
+
+class AwsMfa
+  class ShellCommand
+    attr_reader :command
+
+    def initialize(command)
+      @command = command
+    end
+
+    def call
+      output = `#{command}`
+      ShellCommandResult.new(output, $?)
+    end
+  end
+end

data/lib/aws_mfa/shell_command_result.rb

@@ -0,0 +1,18 @@
+class AwsMfa
+  class ShellCommandResult
+    attr_reader :output
+
+    def initialize(command_output, process_status)
+      @output = command_output
+      @process_status = process_status
+    end
+
+    def success?
+      process_status.success?
+    end
+
+    private
+
+    attr_reader :process_status
+  end
+end

data/lib/aws_mfa_client.rb

@@ -0,0 +1,13 @@
+require_relative 'aws_mfa'
+
+class AwsMfaClient
+  def execute
+    return if running_on_aws_ec2_instance?
+    AwsMfa.new.execute
+  end
+
+  def running_on_aws_ec2_instance?
+    File.file?("/sys/hypervisor/uuid") &&
+      File.read("/sys/hypervisor/uuid")[0..2] == "ec2"
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: mydrive-aws-mfa
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- MyDrive Solutions Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A client to run AWS commands with MFA that can be added into a Ruby project
+email: support@mydrivesolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/aws_mfa.rb
+- lib/aws_mfa/credentials_loader.rb
+- lib/aws_mfa/errors.rb
+- lib/aws_mfa/profile_config.rb
+- lib/aws_mfa/shell_command.rb
+- lib/aws_mfa/shell_command_result.rb
+- lib/aws_mfa_client.rb
+homepage: http://www.github.com/mydrive/mydrive-aws-mfa
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- aws-cli
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Run AWS commands with MFA (MyDrive fork)
+test_files: []