fizx-aws-keychain-util 0.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27ea92631c903ab8bea76497923363e481dc0fb2
+  data.tar.gz: a73afa0e9a6a2db23ce668cfcad199b796a3bbe9
+SHA512:
+  metadata.gz: 1d61a6d2e2d65be497ea5f1d5a2227bce85791db4aa26f5a10254f402d747b11098dbf131e8e0712084349d5e38579fa015b309030590bfc5529cc25da446277
+  data.tar.gz: 28a1ab76661c941f4c64c89ef0f90658e6aac27ba9387fdedc221c347abdadbc265765afa745ac6f0fb8cfd53a90e977ecd88d595d6cd2a60fc4d98f22544546

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Zach Wily
+
+MIT License
+
+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,106 @@
+# AWS Keychain Util
+
+This gem provides a small command line utility that helps
+manage AWS credentials in an OS X keychain, keeping them out
+of your dotfiles.
+
+This will create a keychain for you which automatically locks
+after 5 minutes and on sleep, for some extra security for your
+precious AWS secrets.
+
+Once you've added your credentials, you can start a shell with
+the credentials in the environment.
+
+## Installation
+
+To install:
+
+    gem install aws-keychain-util
+
+## Usage
+
+To create your keychain:
+
+    $ aws-creds init
+
+Here you can choose a name for your new keychain, or use the
+default 'aws'.
+
+To add an item to your aws keychain:
+
+    $ aws-creds add
+
+This will prompt for a friendly name, the access key id,
+and the secret access key. This also prompts for an optional
+MFA arn, which is necessary if you're going to use multifactor
+auth with AWS.
+
+To list items in the keychain:
+
+    $ aws-creds ls
+
+To show some saved credentials:
+
+    $ aws-creds cat <name>
+
+To start a shell with `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
+set in the environment:
+
+    $ aws-creds shell <name>
+
+To emit the (bourne shell style) environment variable exports that 
+you can source into your shell:
+
+    $ aws-creds env <name>
+
+To always load the given environment in your shell, add the following to
+your .bashrc or .zshrc
+
+    source `aws-creds env <name>`
+
+To automatically grab AWS credentials from your keychain when using
+the aws-sdk gem, add the following code:
+
+    AWS.config(:credential_provider => AwsKeychainUtil::CredentialProvider.new('<name>', 'keychain name'))
+
+## AWS Multi-Factor Authentication (MFA) 
+
+To increase AWS security, it's possible to use MFA (multi-factor) authentication with the amazon APIs. 
+Managing temporary credentials is a serious challenge, as by definition the credentials expire after a
+fixed period of time.
+
+You then need to associate a multifactor authentication device with the IAM user. 
+[Amazon Directions for MFA Setup](http://docs.aws.amazon.com/IAM/latest/UserGuide/GenerateMFAConfig.html)
+
+Configuring MFA into your IAM policies for API access is a complex process, the 
+documentation for which is [Here](http://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html#ExampleMFAforResource).
+
+In order to do a multifactor authentication, you need to run:
+
+    $ aws-creds mfa <name> <code>
+
+Where `<code>` is the numeric code on your multifactor auth device. Then you just need to either open a
+fresh shell for the `<name>` key or re-source your environment.
+
+The tool also tracks mfa expiration, and automatically removes expired tokens when you open a new shell 
+or source your env.
+
+
+## Security
+
+Unfortunately, when Keychain whitelists either the `aws-creds` script
+or a ruby application that uses the CredentialProvider for aws-sdk,
+it whitelists `ruby` as a whole. This means *any* ruby script will
+be able to access your AWS credentials. We recommend that you either
+do not whitelist your script at all (don't click "Always Allow"), or
+use a dedicated keychain with an auto-lock interval of less than five
+minutes. Keychains created with `aws-creds` will automatically be
+configured to auto-lock at 5 minutes.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/aws-creds

@@ -0,0 +1,209 @@
+#!/usr/bin/env ruby
+
+if $0 == "bin/aws-creds"
+  $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)) + "/../lib")
+end
+
+require 'rubygems'
+require 'highline'
+require 'keychain'
+require 'json'
+require 'aws-keychain-util'
+require 'aws'
+
+def ask(question)
+  HighLine.new.ask(question)
+end
+
+def ask_secure(question)
+  HighLine.new.ask(question) { |q| q.echo = '*' }
+end
+
+def load_keychain
+  keychain = AwsKeychainUtil.load_keychain
+  if keychain && keychain.lock_interval > 300
+    $stderr.puts "Your keychain is *not* set to lock automatically in under five minutes. This could be dangerous."
+    if !File.exist? AwsKeychainUtil::PREFS_FILE
+      $stderr.puts "You should probably run `#{$0} init` to create a new, secure keychain."
+    end
+  end
+  keychain
+end
+
+def get_item(name)
+  load_keychain.generic_passwords.where(:label => name).first
+end
+
+def get_name_from_args_for_command(command)
+  if ARGV.length < 1
+    puts "Usage: #{$0} #{command} <name>"
+    exit 1
+  end
+  ARGV.shift
+end
+
+def get_item_from_args_for_command(command)
+  name = get_name_from_args_for_command(command)
+  item_mfa = get_item("#{name} mfa")
+  item_token = get_item("#{name} token")
+  if item_mfa
+    if item_mfa.attributes[:comment]
+      expires_at = Time.at(item_mfa.attributes[:comment].to_i)
+      if expires_at < Time.now
+          puts "# Removing expired STS credentials"
+          item_token.delete
+          item_token = nil
+          item_mfa.delete
+          item_mfa = nil
+      end
+    end
+  end
+  if item_mfa and item_token
+    puts "# Using temporary STS credentials"
+    return item_mfa, item_token
+  end
+
+  item = get_item(name)
+  unless item
+    puts "Could not find item with name #{name}"
+    exit 1
+  end
+  return item, nil
+end
+
+command = ARGV.shift
+
+case command
+when 'init'
+  if File.exist? AwsKeychainUtil::PREFS_FILE
+    puts "#{AwsKeychainUtil::PREFS_FILE} already exists. Please remove it to run init again."
+    exit 1
+  end
+
+  name = ask("Name for AWS keychain (default: 'aws'): ")
+  name = "aws" if name == ""
+
+  puts "The OS will now ask you for a password to protect your keychain. Choose wisely."
+  keychain = Keychain.create(name)
+  keychain.lock_interval = 300
+  keychain.lock_on_sleep = true
+
+  $prefs = { 'aws_keychain_name' => name }
+  File.new(AwsKeychainUtil::PREFS_FILE, "w").write JSON.dump($prefs)
+
+  puts "Your AWS keychain has been created and configured to auto-lock after"
+  puts "5 minutes, and when sleeping. You can change those options in"
+  puts "Keychain Access."
+  puts
+  puts "You can now add accounts to the keychain with:"
+  puts "    #{$0} add"
+
+when 'ls'
+  keychain = load_keychain
+  keychain.generic_passwords.all.sort {|a,b|
+    a.attributes[:label] <=> b.attributes[:label]
+  }.each do |item|
+    puts "  #{item.attributes[:label]}"
+  end
+
+when 'add'
+  keychain = load_keychain
+  name     =        ask("      account name: ")
+  account  =        ask("     access key id: ")
+  password = ask_secure(" secret_access_key: ")
+  arn      =        ask("           mfa arn: ")
+
+  item = keychain.generic_passwords.create(
+    :label => name,
+    :account => account,
+    :password => password,
+    :comment => arn
+  )
+
+when 'cat'
+  item, token = get_item_from_args_for_command('cat')
+  puts "AWS_ACCESS_KEY_ID=#{item.attributes[:account]}"
+  puts "AWS_SECRET_ACCESS_KEY=#{item.password}"
+  if token
+    puts "AWS_SECURITY_TOKEN=#{token.password}"
+  end
+
+when 'rm'
+  item, token = get_item_from_args_for_command('rm')
+  item.delete
+
+when 'mfa'
+  keychain = load_keychain
+  item_name = ARGV.shift
+  code = ARGV.shift
+  if not item_name or not code
+    puts "Usage: aws-creds mfa <item-name> <mfa-code>"
+    exit(1)
+  end
+
+  sts_item = get_item("#{item_name} mfa")
+  sts_token = get_item("#{item_name} token")
+  if sts_item
+    puts "Removing existing STS credentials"
+    sts_item.delete
+    sts_token.delete if sts_token
+  end
+  
+  item, token = get_item(item_name)
+  sts = AWS::STS.new(:access_key_id => item.attributes[:account], :secret_access_key => item.password)
+  begin
+    response = sts.new_session(:duration => (60 * 60 * 12), :serial_number => item.attributes[:comment], :token_code => code)
+    temp_item = keychain.generic_passwords.create(:label => "#{item_name} mfa",
+                                                  :account => response.credentials[:access_key_id], 
+                                                  :password=> response.credentials[:secret_access_key], 
+                                                  :comment => response.expires_at.to_i.to_s)
+    temp_token = keychain.generic_passwords.create(:label => "#{item_name} token",
+                                                  :account => "#{response.credentials[:access_key_id]}_token", 
+                                                  :password=> response.credentials[:session_token], 
+                                                  :comment => response.expires_at.to_i.to_s)
+
+    puts "MultiFactorAuthentication succeeded, expiration is #{response.expires_at}"
+  rescue AWS::STS::Errors::AccessDenied => e
+    puts e.to_s
+  end
+
+when 'env'
+  item, token = get_item_from_args_for_command('shell')
+  puts "export AWS_ACCESS_KEY_ID=\"#{item.attributes[:account]}\""
+  puts "export AWS_ACCESS_KEY=\"#{item.attributes[:account]}\""
+  puts "export AWS_SECRET_ACCESS_KEY=\"#{item.password}\""
+  puts "export AWS_SECRET_KEY=\"#{item.password}\""
+  puts "export RPROMPT=\"(aws #{item.attributes[:label]})\""
+  puts "export AWS_CREDS_NAME=\"#{item.attributes[:label]}\""
+  if token
+    puts "export AWS_SECURITY_TOKEN=\"#{token.password}\""
+  end
+
+when 'shell'
+  if ENV['AWS_CREDS_NAME']
+    puts "Already in aws-creds shell (AWS_CREDS_NAME is #{ENV['AWS_CREDS_NAME']})"
+    exit 1
+  end
+
+  item, token = get_item_from_args_for_command('shell')
+  aws_env = {}
+  aws_env['AWS_ACCESS_KEY_ID'] = aws_env['AWS_ACCESS_KEY'] = item.attributes[:account]
+  aws_env['AWS_SECRET_ACCESS_KEY'] = aws_env['AWS_SECRET_KEY'] = item.password
+  aws_env['AWS_CREDS_NAME'] = item.attributes[:label]
+  if token
+    aws_env['AWS_SECURITY_TOKEN'] = token.password
+  end
+
+  if ARGV.empty?
+    aws_env['RPROMPT'] = "(aws #{item.attributes[:label]})" # zsh only
+
+    exec(aws_env, ENV['SHELL'])
+  else
+    exec(aws_env, *ARGV)
+  end
+
+else
+  puts "Usage: #{$0} <command> <arguments>"
+  puts "  Commands: init, ls, add, cat, env, mfa, rm, shell"
+end
+

data/fizx-aws-keychain-util.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "fizx-aws-keychain-util"
+  gem.version       = '0.0.9'
+  gem.authors       = ["Zach Wily"]
+  gem.email         = ["zach@zwily.com"]
+  gem.description   = %q{Helps manage a keychain of AWS credentials on OS X.}
+  gem.summary       = %q{Helps manage a keychain of AWS credentials on OS X.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('ruby-keychain')
+  gem.add_dependency('highline')
+  gem.add_dependency('aws-sdk')
+end

data/lib/aws-keychain-util/credential_provider.rb

@@ -0,0 +1,25 @@
+require 'aws-sdk'
+require 'keychain'
+require 'aws-keychain-util'
+
+module AwsKeychainUtil
+  class CredentialProvider
+    include AWS::Core::CredentialProviders::Provider
+
+    attr_reader :item, :keychain
+
+    def initialize(item = 'AWS', keychain = nil)
+      @item, @keychain = item, keychain
+    end
+
+    def get_credentials
+      keychain = @keychain ? Keychain.open(@keychain) : AwsKeychainUtil.load_keychain
+      item = keychain.generic_passwords.where(:label => @item).first
+      return {} unless item
+      {
+        access_key_id: item.attributes[:account],
+        secret_access_key: item.password
+      }
+    end
+  end
+end

data/lib/aws-keychain-util.rb

@@ -0,0 +1,13 @@
+module AwsKeychainUtil
+  PREFS_FILE = File.expand_path "~/.aws-keychain-util"
+
+  def self.load_keychain
+    keychain = if File.exist? PREFS_FILE
+      prefs = JSON.parse(File.read(PREFS_FILE))
+      Keychain.open(prefs['aws_keychain_name'])
+    else
+      Keychain.default
+    end
+    keychain
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: fizx-aws-keychain-util
+version: !ruby/object:Gem::Version
+  version: 0.0.9
+platform: ruby
+authors:
+- Zach Wily
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-keychain
+  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'
+- !ruby/object:Gem::Dependency
+  name: highline
+  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'
+- !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: Helps manage a keychain of AWS credentials on OS X.
+email:
+- zach@zwily.com
+executables:
+- aws-creds
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/aws-creds
+- fizx-aws-keychain-util.gemspec
+- lib/aws-keychain-util.rb
+- lib/aws-keychain-util/credential_provider.rb
+homepage: ''
+licenses: []
+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: Helps manage a keychain of AWS credentials on OS X.
+test_files: []
+has_rdoc: