aws_session_token 0.3.0

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.markdown

@@ -0,0 +1,81 @@
+[![Gem Version](https://badge.fury.io/rb/aws_session_token.svg)](https://badge.fury.io/rb/aws_session_token)
+[![Build Status](https://travis-ci.org/bstopp/aws_session_token.svg?branch=master)](https://travis-ci.org/bstopp/aws_session_token)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b3c10a834e5a1498783d/maintainability)](https://codeclimate.com/github/bstopp/aws_session_token/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/b3c10a834e5a1498783d/test_coverage)](https://codeclimate.com/github/bstopp/aws_session_token/test_coverage)
+
+# AWS Session Token
+
+This is a utility gem to help users create a temporary Session token. This is useful when accounts have Multi Factor Authentication enabled, and some actions require MFA authentication.
+
+## Installation
+
+Run standard gem installation.
+
+```sh
+$ gem install aws_session_token
+```
+
+## Compatibility
+
+AWS Session Token is compatible with:
+
+* Ruby 2.3+
+
+## Usage
+
+```
+Usage: aws_session_token [options]
+
+    -f, --file FILE                  Specify a custom credentials file.
+    -u, --user USER                  Specify the AWS User name for passing to API.
+    -p, --profile PROFILE            Specify the AWS credentials profile to use. Also sets user, if user is not provided.
+    -s, --session SESSION_PROFILE    Specify the name of the profile used to store the session credentials.
+    -d, --duration DURATION          Specify the duration the of the token in seconds. (Default 3600)
+    -t, --token TOKEN                Specify the OTP Token to use for creating the session credentials.
+
+Common options:
+    -h, --help                       Show this message.
+    -v, --version                    Show version.
+
+```
+
+### File
+Specifies the AWS Credentials file that will be used to both find the source Profile, and where to write the Session token data.
+
+### User
+Specify the AWS User associated with the account. This is necessary if the profile's name is different than the one in AWS (or if you're using the _default_ profile).
+
+This may also be required if AWS Policies prevent the user associated with the credentials from listing all MFA Devices associated with the AWS Account.
+
+### Profile
+Used to specify the AWS Profile in the credentials file for authenticating & generating a new session token. Default: `default`.
+
+### Session
+Provide the name of the profile to create with the session token credentials. Default: `session_profile`
+
+### Duration
+The lifespan of the session token, in seconds. Default: `3600` (1 hour).
+
+### Token
+The token from the MFA Device. Can be provided via CLI; if not specified, user will be prompted. 
+
+
+## Contributing to aws_session_token
+
+-   Check out the latest master to make sure the feature hasn't been
+    implemented or the bug hasn't been fixed yet.
+-   Check out the issue tracker to make sure someone already hasn't
+    requested it and/or contributed it.
+-   Fork the project.
+-   Start a feature/bugfix branch.
+-   Commit and push until you are happy with your contribution.
+-   Make sure to add tests for it. This is important so I don't break it
+    in a future version unintentionally.
+-   Please try not to mess with the Rakefile, version, or history. If
+    you want to have your own version, or is otherwise necessary, that
+    is fine, but please isolate to its own commit so I can cherry-pick
+    around it.
+
+## Copyright
+
+Copyright (c) 2018 Bryan Stopp. See [LICENSE](LICENSE) for further details.

data/Rakefile

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+require 'rake/clean'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'rake'
+
+require 'semver'
+def s_version
+  SemVer.find.format '%M.%m.%p%s'
+end
+
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'aws_session_token'
+  gem.homepage = 'http://github.com/bstopp/aws_session_token'
+  gem.license = 'Apache-2.0'
+  gem.summary = 'Create & Store AWS Session Tokens'
+  gem.description = <<~DESC
+    Tool to wrap AWS API to create and store Session tokens so that other commands/tools (e.g. Terraform) can function as necessary.
+  DESC
+  gem.email = 'bryan.stopp@gmail.com'
+  gem.authors = ['Bryan Stopp']
+  gem.version = s_version
+  gem.required_ruby_version = '>= 2.3'
+
+  # dependencies defined in Gemfile
+end
+CLOBBER.include('aws_session_token.gemspec')
+CLOBBER.include('pkg')
+
+Juwelier::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Code coverage detail'
+task :simplecov do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
+CLOBBER.include('coverage')
+
+task :headers do
+  require 'rubygems'
+  require 'copyright_header'
+
+  description = <<~DESC
+    Tool to wrap AWS API to create and store
+    Session tokens so that other commands/tools (e.g. Terraform) can function as necessary.
+  DESC
+
+  args = {
+    license: 'ASL2',
+    copyright_software: 'AWS Session Token Gem',
+    copyright_software_description: description,
+    copyright_holders: ['Bryan Stopp <bryan.stopp@gmail.com>'],
+    copyright_years: ['2018'],
+    syntax: './config/syntax.yaml',
+    add_path: 'lib:bin:spec',
+    output_dir: '.'
+  }
+
+  command_line = CopyrightHeader::CommandLine.new(args)
+  command_line.execute
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/aws_session_token

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'aws_session_token'
+
+cli = AwsSessionToken::CLI.new
+cli.run

data/config/syntax.yaml

@@ -0,0 +1,7 @@
+ruby:
+  ext: ['.rb', '.rake']
+  after: ['^#!', '^#.*encoding:', '^#.*frozen_string_literal:']
+  comment:
+    open:   '\n#\n'
+    close:  '#\n'
+    prefix: '# '

data/lib/aws_session_token.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+#
+# AWS Session Token Gem - Tool to wrap AWS API to create and store Session tokens
+# so that other commands/tools (e.g. Terraform) can function as necessary.
+#
+# Copyright 2018 Bryan Stopp <bryan.stopp@gmail.com>
+#
+# 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.
+#
+
+require 'aws-sdk-core'
+require 'aws-sdk-iam'
+require 'semver'
+require 'highline'
+
+require_relative 'aws_session_token/cli'
+require_relative 'aws_session_token/credentials_file'
+require_relative 'aws_session_token/options'

data/lib/aws_session_token/cli.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+#
+# AWS Session Token Gem - Tool to wrap AWS API to create and store Session tokens
+# so that other commands/tools (e.g. Terraform) can function as necessary.
+#
+# Copyright 2018 Bryan Stopp <bryan.stopp@gmail.com>
+#
+# 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.
+#
+
+module AwsSessionToken
+
+  # Execute the process for getting & updating the session token.
+  class CLI
+    attr_accessor :options
+
+    def initialize
+      @options = Options.new
+      @creds_file = CredentialsFile.new
+    end
+
+    def run
+      @options.parse(ARGV)
+      validate_creds_file
+      set_aws_creds
+      mfa = mfa_device
+      token = @options.token || token_prompt
+      creds = session_token(mfa, token)
+      @creds_file.write(@options.credentials_file, @options.session_profile, creds)
+    end
+
+    def validate_creds_file
+      return if File.exist?(@options.credentials_file) && File.writable?(@options.credentials_file)
+      unless File.exist?(@options.credentials_file)
+        raise(
+          ArgumentError, "Specified credentials file is missing: #{@options.credentials_file}"
+        )
+      end
+      raise(
+        ArgumentError,
+        "Specified credentials file cannot be modified by current user: #{@options.credentials_file}"
+      )
+    end
+
+    def set_aws_creds
+      credentials = Aws::SharedCredentials.new(path: @options.credentials_file, profile_name: @options.profile)
+      Aws.config.update(credentials: credentials)
+    rescue Aws::Errors::NoSuchProfileError
+      warn "\nSpecified AWS Profile doesn't exist: #{@options.profile}"
+      exit 1
+    end
+
+    def mfa_device
+      iam_client = Aws::IAM::Client.new
+      params = { max_items: 1 }
+      params[:user_name] = @options.user if @options.user
+      response = iam_client.list_mfa_devices(params)
+      list = response.mfa_devices
+      return list[0].serial_number unless list.nil? || list.empty?
+      warn "\nSpecified profile/user doesn't have MFA device."
+      warn "\nScript execution unnecessary."
+      exit
+    end
+
+    def token_prompt
+      cli = HighLine.new
+      cli.ask "Specify the OTP Token for the profile #{@options.profile}:"
+    end
+
+    def session_token(mfa_device, otp)
+      @sts_client = Aws::STS::Client.new
+      resp = @sts_client.get_session_token(
+        duration_seconds: @options.duration,
+        serial_number: mfa_device,
+        token_code: otp
+      )
+      resp.credentials
+    end
+
+  end
+end