awssume 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ca101e4a43eaaf9f72e5a037a5e82543863999f
+  data.tar.gz: a354b71f596d90fbd6d3aebd89478d948789a36e
+SHA512:
+  metadata.gz: 855e8bfd2e439072cfcae7a07df02ae4d30c98b3bb4256304f70a3cd4abfb19e9b11e7e719e8489105ece3436b9243156d2f212da395cbdb07c2d9d37a50c5d8
+  data.tar.gz: 98600f682087d09e543194fbf70fdbbb98337922e78b882596a1193de57b6c4ba0869aaa868343a10b39dac9737a765d20549e2977cebca510bce1553f55d5ab

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in awssume.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 reppard
+
+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.

data/README.md

@@ -0,0 +1,86 @@
+# Awssume
+
+Assume a role, do a thing.
+
+This is a gem for assuming an AWS IAM role and using the returned temporary
+credentials to do something such as run a deploy script or execute an aws cli
+command. This gem was created because of the need to assume a role using
+an instance profile on an EC2 instance and use the resulting credentials to
+do some work.  This functionality doesn't currently exist in some often used
+community tools.
+
+References:
+[AWS Cli Issue](https://github.com/aws/aws-cli/issues/1390)
+[Terraform Issue](https://github.com/hashicorp/terraform/issues/1275)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'awssume'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install awssume
+
+## Usage
+
+This gem has the potential to be used as a library in a project using Ruby.
+After a few things are implemented(such as a global configuration block) usage
+instructions for using as a library will be added.
+
+Currently the focus has been to use this gem as a command line tool.
+
+You can configure env vars to authenticate with AWS:
+
+```
+  $ export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
+  $ export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+  $ export AWS_DEFAULT_REGION=us-west-2
+```
+
+If AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY aren't set then other
+authentication options are checked(such as instance profiles).  This is
+functionality provided by the aws-sdk.
+
+```
+  $ AWS_ROLE_ARN=arn::aws::iam::123456789012:role/RoletoAssume \
+      awssume <command to execute>
+```
+```
+  $ AWS_ROLE_ARN=arn::aws::iam::123456789012:role/RoletoAssume \
+      awssume bundle exec rake component:deploy
+```
+```
+  $ AWS_ROLE_ARN=arn::aws::iam::123456789012:role/RoletoAssume \
+      awssume aws iam list-roles
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on
+GitHub at https://github.com/Manheim/awssume.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/awssume.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'awssume/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'awssume'
+  spec.version       = Awssume::VERSION
+  spec.authors       = ['reppard']
+  spec.email         = ['reppardwalker@gmail.com']
+
+  spec.summary       = 'Assume a role, do a thing.'
+  spec.description   = [
+    'This is a gem for assuming an AWS IAM role and using the returned',
+    'temporary credentials to do something such as run a deploy script',
+    'or execute an aws cli command.'
+  ].join(' ')
+  spec.homepage      = 'https://github.com/Manheim/awssume'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_runtime_dependency 'aws-sdk'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "awssume"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/awssume

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'awssume'
+Awssume.run

data/lib/awssume.rb

@@ -0,0 +1,22 @@
+require 'aws-sdk'
+require 'awssume/version'
+require 'awssume/command_decorator'
+require 'awssume/configuration'
+require 'awssume/adapter/aws_client'
+
+module Awssume
+  def self.run
+    config  = Awssume::Configuration.new
+    adapter = Awssume::Adapter::AwsClient.new(
+      region:            config.region,
+      role_arn:          config.role_arn,
+      role_session_name: config.role_session_name
+    )
+    aws_env = {
+      'AWS_REGION'         => config.region,
+      'AWS_DEFAULT_REGION' => config.region
+    }
+    creds_hash = adapter.assume
+    system(aws_env, Awssume::CommandDecorator.format_cmd(ARGV[0..-1], creds_hash))
+  end
+end

data/lib/awssume/adapter/aws_client.rb

@@ -0,0 +1,31 @@
+require 'aws-sdk'
+
+module Awssume
+  module Adapter
+    # This is aws sts client wrapper class
+    class AwsClient
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def assume
+        sts_client.assume_role(
+          role_arn: config[:role_arn],
+          role_session_name: role_session_name
+        ).credentials.to_h
+      end
+
+      def role_session_name
+        config[:role_session_name]
+      end
+
+      private
+
+      def sts_client
+        Aws::STS::Client.new(region: config[:region])
+      end
+    end
+  end
+end

data/lib/awssume/command_decorator.rb

@@ -0,0 +1,15 @@
+module Awssume
+  class CommandDecorator
+    class << self
+      def generate_var_string(var_hash)
+        var_hash.collect { |k,v| "AWS_#{k.upcase}='#{v}'" }.sort.join(' ')
+      end
+
+      def format_cmd(cmd, var_hash)
+        cmd = cmd.join(' ') if cmd.kind_of?(Array)
+
+        "#{generate_var_string(var_hash)} #{cmd}"
+      end
+    end
+  end
+end

data/lib/awssume/configuration.rb

@@ -0,0 +1,49 @@
+module Awssume
+  # A class for managing the properties needed for assuming a role
+  class Configuration
+    def self.default_session_name
+      "AwssumedSession#{Time.new.to_i}"
+    end
+
+    def self.defaults
+      {
+        region:            ENV['AWS_REGION'] || ENV['AWS_DEFAULT_REGION'],
+        role_arn:          ENV['AWS_ROLE_ARN'],
+        role_session_name: ENV['AWS_ROLE_SESSION_NAME'] || default_session_name
+      }
+    end
+
+    attr_accessor(*defaults.keys)
+
+    def initialize(opts = {})
+      attrs.each do |k, _|
+        attr_val = validate_attrs(attrs.merge(opts), k)
+        instance_variable_set("@#{k}", attr_val)
+      end
+    end
+
+    private
+
+    def validate_attrs(attrs, attr_key)
+      throwout_nils(attrs).fetch(attr_key) do
+        raise ArgumentError, missing_attr_error_msg(attr_key)
+      end
+    end
+
+    def missing_attr_error_msg(key)
+      [
+        "Missing '#{key}'",
+        'Args should be passed in or set in the env:',
+        "AWS_#{key.upcase}=value awssume"
+      ].join("\n")
+    end
+
+    def throwout_nils(attrs)
+      attrs.reject { |_, v| v.nil? }
+    end
+
+    def attrs
+      self.class.defaults
+    end
+  end
+end

data/lib/awssume/version.rb

@@ -0,0 +1,3 @@
+module Awssume
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: awssume
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- reppard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a gem for assuming an AWS IAM role and using the returned temporary
+  credentials to do something such as run a deploy script or execute an aws cli command.
+email:
+- reppardwalker@gmail.com
+executables:
+- awssume
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- awssume.gemspec
+- bin/console
+- bin/setup
+- exe/awssume
+- lib/awssume.rb
+- lib/awssume/adapter/aws_client.rb
+- lib/awssume/command_decorator.rb
+- lib/awssume/configuration.rb
+- lib/awssume/version.rb
+homepage: https://github.com/Manheim/awssume
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Assume a role, do a thing.
+test_files: []