secret_garden 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ce8d3fe0db1ee091033726364760e4b63fc0c45
+  data.tar.gz: 0c0d3395947f0ed502084b2941bf152ca5ac0664
+SHA512:
+  metadata.gz: 057a3570da5517e556252a3d973a44044d008f09f86ce481e3476bbee6373d51f813d605527b2455b21148bfa265f995a80de8ebc73202b9db6f75b0591e19dd
+  data.tar.gz: fb9a1a045ab7c5e33837e49c98c21baeecba137f141b6b9c3f95335547de141e2e46aebaae420595e5ceaf88e93bc3f46e33dd4b1a6b9c87b4644f1c643ff4fd

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,63 @@
+# SecretGarden
+
+You have a [12 factor app](http://12factor.net/). You want to [configure it
+using environment variables](http://12factor.net/config). But you don't want the
+world to know your secrets. Or, better yet, you want your secrets to have
+limited-time access.
+
+What you really want is a way to be able to configure your app via the
+envornment, but fall back to a secret storage service like
+[vault](https://www.vaultproject.io/)!
+
+This gem does just that.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'secret_garden'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install secret_garden
+
+## Usage
+
+First, define a `Secretfile` for your project that maps environment variable
+names to secret key paths in your vault:
+
+```
+# Secretfile
+AWS_ACCESS_KEY_ID     secrets/services/aws:id
+AWS_ACCESS_KEY_SECRET secrets/services/aws:secret
+```
+
+In your app, instead of always consulting `ENV['AWS_ACCESS_KEY_ID]`, you can use
+SecretGarden:
+
+``` ruby
+# In future we will move each backend out to a gem, so that you don't need to
+# download a million gems like you do with Fog.
+require 'secret_garden/vault'
+
+SecretGarden.add_backend :vault
+
+s3 = AWS::S3.new access_key_id: SecretGarden.fetch('AWS_ACCESS_KEY_ID')
+```
+
+## 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/dkastner/secret_garden.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "secret_garden"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/secret_garden.rb

@@ -0,0 +1,44 @@
+require "secret_garden/version"
+
+require 'secret_garden/env'
+require 'secret_garden/map'
+
+module SecretGarden
+
+  class SecretNotDefined < StandardError; end
+
+  def self.add_backend(val)
+    klass = SecretGarden.const_get(val.to_s.capitalize)
+    @backends = backends + [klass.new(map)]
+    nil
+  end
+
+  def self.backends
+    @backends ||= [Env.new(map)]
+  end
+
+  def self.fetch(name)
+    backends.inject(nil) do |value, backend|
+      value ||= backend.fetch_and_cache(name)
+    end
+  end
+
+  def self.map
+    @map ||= SecretGarden::Map.new root: secret_file_path, env: env
+  end
+
+  def self.secret_file_path=(val)
+    @secret_file_path = val
+  end
+  def self.secret_file_path
+    @secret_file_path ||= Dir.pwd
+  end
+
+  def self.env=(val)
+    @env = val
+  end
+  def self.env
+    @env ||= 'development'  # sane default?
+  end
+
+end

data/lib/secret_garden/backend.rb

@@ -0,0 +1,25 @@
+require 'secret_garden'
+
+module SecretGarden
+
+  class Backend
+
+    attr_accessor :map, :cache
+
+    def initialize(map)
+      self.map = map
+      self.cache = {}
+    end
+
+    def fetch_and_cache(name)
+      unless map.defined?(name)
+        raise SecretGarden::SecretNotDefined,
+          "There is no secret #{name.inspect} defined in #{map.secretfile_path}"
+      end
+      secret = map[name]
+      self.cache[name] ||= fetch(secret)
+    end
+
+  end
+
+end

data/lib/secret_garden/env.rb

@@ -0,0 +1,13 @@
+require 'secret_garden/backend'
+
+module SecretGarden
+
+  class Env < Backend
+
+    def fetch(secret)
+      ENV[secret.name]
+    end
+
+  end
+
+end

data/lib/secret_garden/map.rb

@@ -0,0 +1,45 @@
+require 'secret_garden/secret'
+
+module SecretGarden
+
+  class Map
+
+    attr_accessor :root
+
+    def initialize(root: Dir.pwd, env: nil)
+      self.root = root
+    end
+
+    def defined?(name)
+      entries.key?(name)
+    end
+
+    def [](name)
+      entries[name]
+    end
+
+    def secretfile_path
+      @secretfile_path ||= File.join(root, 'Secretfile')
+    end
+
+    def entries
+      @entries ||= File.readlines(secretfile_path).
+        map(&:strip).
+        reject { |l| l =~ /^#/ }.
+        map do |l|
+          name, path, property = parse_secret l
+          Secret.new name, path, property
+        end.
+        inject({}) do |hsh, secret|
+          hsh.merge secret.name => secret
+        end
+    end
+
+    def parse_secret(line)
+      name, path, property = line.scan(/([^\s]+)\s+([^:]+)(:.*)?/).first
+      path.gsub! /@ENV@/, SecretGarden.env
+      [name, path, property.to_s[1..-1]]
+    end
+  end
+
+end

data/lib/secret_garden/secret.rb

@@ -0,0 +1,15 @@
+module SecretGarden
+
+  class Secret
+
+    attr_accessor :name, :path, :property
+
+    def initialize(name, path, property)
+      self.name = name
+      self.path = path
+      self.property = property
+    end
+
+  end
+
+end

data/lib/secret_garden/vault.rb

@@ -0,0 +1,32 @@
+require 'vault'
+
+require 'secret_garden/backend'
+
+module SecretGarden
+
+  class Vault < Backend
+
+    class SecretNotDefined < StandardError; end
+    class PropertyNotDefined < StandardError; end
+
+    def fetch(secret)
+      unless vault_secret = fetch_from_vault(secret.path)
+        raise SecretNotDefined,
+          "Vault does not have secret at #{secret.path.inspect}"
+      end
+
+      unless value = vault_secret.data[secret.property.to_sym]
+        raise PropertyNotDefined,
+          "Vault does not have secret at #{secret.path}:#{secret.property}"
+      end
+
+      value
+    end
+
+    def fetch_from_vault(path)
+      ::Vault.logical.read path
+    end
+
+  end
+
+end

data/lib/secret_garden/version.rb

@@ -0,0 +1,3 @@
+module SecretGarden
+  VERSION = "0.0.1"
+end

data/secret_garden.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'secret_garden/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "secret_garden"
+  spec.version       = SecretGarden::VERSION
+  spec.authors       = ["Derek Kastner"]
+  spec.email         = ["dkastner@gmail.com"]
+
+  spec.summary       = %q{Access your 12-factor app secrets securely}
+  spec.description   = %q{Provide secrets either via ENV or fall back to secure backends like vault}
+  spec.homepage      = "http://github.com/dkastner/secret_garden"
+
+  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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vault"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: secret_garden
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Derek Kastner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vault
+  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'
+description: Provide secrets either via ENV or fall back to secure backends like vault
+email:
+- dkastner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/secret_garden.rb
+- lib/secret_garden/backend.rb
+- lib/secret_garden/env.rb
+- lib/secret_garden/map.rb
+- lib/secret_garden/secret.rb
+- lib/secret_garden/vault.rb
+- lib/secret_garden/version.rb
+- secret_garden.gemspec
+homepage: http://github.com/dkastner/secret_garden
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Access your 12-factor app secrets securely
+test_files: []