omnivault 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d05e1845311fc4dc9cd6d93558626016bfb0d45
+  data.tar.gz: 075296794303a383d635149e4663b79570c6f476
+SHA512:
+  metadata.gz: d4f62d3924e3235a558c8892bcbb0b618244eae0fb86c86c93a88d8c9b31846cfd90ce5a00e083421bb0ac9dc39f5535e570da66347968f7552f247a8bf4c926
+  data.tar.gz: 2f203420cc8d7d8db006de6347ebcfe9fa834a89ea28afb083dcf91d09ed81c46d142ca9fbe79dd602a98125cb15d23e497f6ddf35813626f233ef8e164b1343

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/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - "2.1"
+  - 2.0.0
+  - jruby

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Aptible, Inc.
+
+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,70 @@
+# Omnivault
+
+[![Gem Version](https://badge.fury.io/rb/omnivault.png)](https://rubygems.org/gems/omnivault)
+[![Build Status](https://travis-ci.org/aptible/omnivault.png?branch=master)](https://travis-ci.org/aptible/omnivault)
+[![Dependency Status](https://gemnasium.com/aptible/omnivault.png)](https://gemnasium.com/aptible/omnivault)
+
+A Ruby library to abstract keychain functionality for storing and retrieiving arbitrary secrets from a variety of password vaults.
+
+Omnivault supports simple key-value secret retrieval with the following password vaults:
+
+* Apple OS X Keychain
+* pws (a CLI-based vault)
+
+Additionally, it supports automatic credential setup for the following libraries:
+
+* AWS Ruby SDK (`aws-sdk-v1`, `aws-sdk`)
+
+## Installation
+
+Add the following line to your application's Gemfile.
+
+    gem 'omnivault'
+
+And then run `bundle install`.
+
+## Usage
+
+To initialize the the Omnivault, run:
+
+```ruby
+omnivault = Omnivault.autodetect
+```
+
+This will determine an appropriate provider using the following logic:
+
+* If the ENV variable `VAULT` is set, it will use that provider, i.e.,
+  - Apple Keychain for `VAULT=apple`
+  - PWS for `VAULT=pws`
+* If no ENV variable is set, it will try to use Apple Keychain first, and fall back to PWS if not on Apple OS X.
+
+Then, to use Omnivault, you can:
+
+```ruby
+omnivault.store('foo', 'bar')
+omnivault.entries
+# => { "foo" => "bar" }
+omnivault.fetch("foo")
+# => "bar"
+```
+
+## TODO
+
+* Add support for 1Password keychains.
+* Write RSpec unit tests.
+* Remove dependence on AWS-specific gems directly
+
+## Contributing
+
+1. Fork the project.
+1. Commit your changes, with specs.
+1. Ensure that your code passes specs (`rake spec`) and meets Aptible's Ruby style guide (`rake rubocop`).
+1. Create a new pull request on GitHub.
+
+## Copyright and License
+
+MIT License, see [LICENSE](LICENSE.md) for details.
+
+Copyright (c) 2015 [Aptible](https://www.aptible.com), Frank Macreery, and contributors.
+
+[<img src="https://s.gravatar.com/avatar/f7790b867ae619ae0496460aa28c5861?s=60" style="border-radius: 50%;" alt="@fancyremarker" />](https://github.com/fancyremarker)

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+
+require 'aptible/tasks'
+Aptible::Tasks.load_tasks

data/lib/omnivault.rb

@@ -0,0 +1,11 @@
+require 'omnivault/version'
+
+require_relative 'omnivault/abstract_vault'
+require_relative 'omnivault/apple_keychain'
+require_relative 'omnivault/pws'
+
+module Omnivault
+  def self.autodetect
+    Omnivault::AbstractVault.from_env || Omnivault::AbstractVault.for_platform
+  end
+end

data/lib/omnivault/abstract_vault.rb

@@ -0,0 +1,18 @@
+module Omnivault
+  class AbstractVault
+    def self.from_env
+      case ENV['VAULT']
+      when 'apple', 'AppleKeychain'
+        AppleKeychain.new
+      when 'pws', 'PWS'
+        PWS.new
+      end
+    end
+
+    def self.for_platform
+      AppleKeychain.new
+    rescue LoadError
+      PWS.new
+    end
+  end
+end

data/lib/omnivault/apple_keychain.rb

@@ -0,0 +1,48 @@
+module Omnivault
+  class AppleKeychain < AbstractVault
+    def initialize
+      # Need to require within initializer, to avoid LoadError on
+      # non-Apple platforms
+      require 'keychain'
+      require 'aws-keychain-util/credential_provider'
+    end
+
+    def entries
+      keychain = open_or_create_keychain
+      Hash[keychain.generic_passwords.all.map do |item|
+        [item.label, item.password]
+      end]
+    end
+
+    def fetch(key)
+      entries[key]
+    end
+
+    def store(key, value)
+      keychain = open_or_create_keychain
+      if (entry = keychain.generic_passwords.where(label: key).all.first)
+        entry.password = value
+      else
+        keychain.generic_passwords.create(
+          service: key,
+          label: key,
+          password: value
+        )
+      end
+    end
+
+    def configure_aws!
+      provider = ::AwsKeychainUtil::CredentialProvider.new('default', 'aws')
+      AWS.config(credential_provider: provider)
+    end
+
+    private
+
+    def open_or_create_keychain(name = 'aptible-cookbook')
+      keychain = Keychain.open("#{name}.keychain")
+      return keychain if keychain.exists?
+
+      Keychain.create("#{name}.keychain")
+    end
+  end
+end

data/lib/omnivault/pws.rb

@@ -0,0 +1,27 @@
+require 'aws/pws'
+require 'aws/pws/credential_provider'
+
+module Omnivault
+  class PWS < AbstractVault
+    attr_accessor :client
+
+    def entries
+      @client ||= AWS::PWS::Client.new
+      Hash[@client.raw_data.map { |k, v| [k, v[:password]] }]
+    end
+
+    def fetch(key)
+      entries[key]
+    end
+
+    def store(key, value)
+      @client ||= AWS::PWS::Client.new
+      @client.cli.add(key, value)
+    end
+
+    def configure_aws!
+      provider = AWS::PWS::CredentialProvider.new
+      AWS.config(credential_provider: provider)
+    end
+  end
+end

data/lib/omnivault/version.rb

@@ -0,0 +1,3 @@
+module Omnivault
+  VERSION = '0.1.0'
+end

data/omnivault.gemspec

@@ -0,0 +1,29 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'English'
+require 'omnivault/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omnivault'
+  spec.version       = Omnivault::VERSION
+  spec.authors       = ['Frank Macreery']
+  spec.email         = ['frank@macreery.com']
+  spec.description   = 'Abstract password vault for multiple providers'
+  spec.summary       = 'Abstract password vault for multiple providers'
+  spec.homepage      = 'https://github.com/aptible/omnivault'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'aws-keychain-util'
+  spec.add_dependency 'aws-pws'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'aptible-tasks'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+# Load shared spec files
+Dir["#{File.dirname(__FILE__)}/shared/**/*.rb"].each do |file|
+  require file
+end
+
+# Require library up front
+require 'omnivault'

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: omnivault
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frank Macreery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-keychain-util
+  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-pws
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: aptible-tasks
+  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: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Abstract password vault for multiple providers
+email:
+- frank@macreery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/omnivault.rb
+- lib/omnivault/abstract_vault.rb
+- lib/omnivault/apple_keychain.rb
+- lib/omnivault/pws.rb
+- lib/omnivault/version.rb
+- omnivault.gemspec
+- spec/spec_helper.rb
+homepage: https://github.com/aptible/omnivault
+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: Abstract password vault for multiple providers
+test_files:
+- spec/spec_helper.rb