secret_broker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a88e6fe8ce430e2375d0fcc0f7ec8a55ccd48650
+  data.tar.gz: ee181f5988ea46130f21f696200209de8f3552e0
+SHA512:
+  metadata.gz: c655a8b8b0d310f62529a5f346385d693abbf135bdef934cb2ea455b0adc26eeecf7cb42f46d11bc211089b53b67dc8099296e8d1ff2a3a56b4dae722c62ec06
+  data.tar.gz: b3a77cd6702ef76662e0f7d1e0508db021696dff6ea48ef0b01554928854d22391854be7c029b8b5e52dbbfaa28e22f9bac43fb6616058ec229fc6969358c2a5

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,99 @@
+# SecretBroker
+
+See the usage section for more details
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'secret_broker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install secret_broker
+
+After installing the gem you can run the installation rake task which sets up
+staging and production ejson files with public keys. Command:
+
+    $ bundle exec rake secret_broker:install_secrets
+
+## Working with Secrets/Usage
+
+### Overview
+
+We use EJSON to store secrets for remote environments in the git repo.
+EJSON encrypts secrets so they
+are not stored in plaintext. EJSON files are stored in
+`config/secrets/environment.ejson`. EJSON is only used in remote environments.
+Secrets from EJSON are decrypted when the app boots.
+
+### Accessing Secrets in the Application
+
+All application secrets should come from `Rails.application.secrets.secret_key`
+which is loaded from `config/secrets/yml`. Since
+`Rails.application.secrets.secret_key` is cumbersome to write, you can also
+write `Secrets.secret_key`.
+
+### Modifying Secrets
+
+### Local Environment
+
+Open up `config/secrets.yml` and change the secret you want to change.
+
+#### Remote Environment
+
+Open up the EJSON file for the environment you want to change the secret for.
+Find the key for the secret you want to change. Replace the encrypted value
+with the plaintext value. Run `ejson encrypt environment.ejson`. Then add and
+commit the file.
+
+Example scenario: I want to change the production database password.
+
+Open `config/secrets/production.ejson`. It looks like:
+```
+{
+  "_public_key": "some_value",
+  "some_secret_key: "ENCRYPTED_VALUE",
+  "database_password": "ENCRYPTED_OLD_PASSWORD",
+  "some_other_secret_key: "ENCRYPTED_VALUE"
+}
+```
+
+Modify the file with the new password. It looks like:
+```
+{
+  "_public_key": "some_value",
+  "some_secret_key: "ENCRYPTED_VALUE",
+  "database_password": "new_plaintext_pa$$w0rd",
+  "some_other_secret_key: "ENCRYPTED_VALUE"
+}
+```
+
+Run `ejson encrypt production.ejson`. It looks like:
+```
+{
+  "_public_key": "some_value",
+  "some_secret_key: "ENCRYPTED_VALUE",
+  "database_password": "ENCRYPTED_NEW_PASSWORD",
+  "some_other_secret_key: "ENCRYPTED_VALUE"
+}
+```
+
+Run `git add config/secrets/production.ejson && git commit -m "Updated
+production database password`.
+
+### References
+
+[EJSON gem on Github](https://github.com/Shopify/ejson)
+
+## 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).

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_broker"
+
+# 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_broker.rb

@@ -0,0 +1,49 @@
+require 'secret_broker/dummy_secrets_hash'
+require 'secret_broker/ejson_secrets_file'
+require 'secret_broker/railtie'
+require 'secret_broker/version'
+require 'active_support/core_ext/hash/indifferent_access'
+
+
+# SecretBroker class for accessing secrets stored using ejson.
+#
+# Usage:
+#
+# Secrets.environment.fetch :key
+#
+# Example (running in production):
+#
+# Secrets.production.database_password
+# => 'pa$$w0rd'
+#
+# Secrets.staging.database_password
+# => 'SECRET VALUE REQUESTED FOR database_password AN ENVIRONMENT OTHER THAN THE CURRENT ENVIRONMENT'
+#
+class SecretBroker
+  class << self
+
+    def current_environment_secrets
+      @current_environment_secrets ||= HashWithIndifferentAccess.new(ejson_secrets_file.to_h)
+    end
+
+    def current_environment
+      Rails.env
+    end
+
+    def ejson_secrets_file
+      EJsonSecretsFile.new(current_environment)
+    end
+
+    REMOTE_ENVIRONMENTS = [:staging, :production].freeze
+
+    REMOTE_ENVIRONMENTS.each do |environment_name|
+      define_method environment_name do
+        if environment_name.to_s == current_environment
+          current_environment_secrets
+        else
+          DummySecretsHash.new
+        end
+      end
+    end
+  end
+end

data/lib/secret_broker/dummy_secrets_hash.rb

@@ -0,0 +1,7 @@
+class SecretBroker
+  class DummySecretsHash
+    def fetch(key)
+      "SECRET VALUE FOR #{key} REQUESTED FOR AN ENVIRONMENT OTHER THAN THE CURRENT ENVIRONMENT"
+    end
+  end
+end

data/lib/secret_broker/ejson_secrets_file.rb

@@ -0,0 +1,31 @@
+require 'json'
+require 'open3'
+
+class SecretBroker
+  class EJsonSecretsFile
+    def initialize(env)
+      @env = env
+    end
+
+    def to_h
+      return {} unless file_path.file?
+
+      stdout_str, stderr_str, status = Open3.capture3 "ejson decrypt #{file_path.to_path}"
+      fail "ejson decrypt did not run successfully. stderr: #{stderr_str}" unless status.success?
+
+      JSON.parse stdout_str
+    end
+
+    private
+
+    attr_reader :env
+
+    def config_path
+      Rails.root.join 'config', 'secrets'
+    end
+
+    def file_path
+      config_path.join "#{env}.ejson"
+    end
+  end
+end

data/lib/secret_broker/railtie.rb

@@ -0,0 +1,6 @@
+class SecretBrokerRailtie < Rails::Railtie
+  rake_tasks do
+    load File.expand_path("../../tasks/secret_broker.tasks", __FILE__)
+  end
+end
+

data/lib/secret_broker/version.rb

@@ -0,0 +1,3 @@
+class SecretBroker
+  VERSION = "0.1.0"
+end

data/lib/tasks/secret_broker.tasks

@@ -0,0 +1,24 @@
+namespace :secret_broker do
+  desc 'Install secrets directory'
+  task install_secrets: :environment do
+    config_dir = Rails.root.join 'config', 'secrets'
+    config_dir.mkdir unless config_dir.directory?
+
+    staging_string = <<EOS
+{
+  "_public_key": "TODO: Enter public key."
+}
+EOS
+
+    File.write(config_dir.join('staging.ejson'), staging_string)
+
+    production_string = <<EOS
+
+{
+  "_public_key": "TODO: Enter public key."
+}
+EOS
+
+    File.write(config_dir.join('production.ejson'), production_string)
+  end
+end

data/secret_broker.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'secret_broker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "secret_broker"
+  spec.version       = SecretBroker::VERSION
+  spec.authors       = ["Derek Schneider"]
+  spec.email         = ["schneidermd1993@gmail.com"]
+  spec.summary       = %q{Secret Broker}
+  spec.description   = %q{Secret Broker}
+  spec.homepage      = "https://github.com/schneiderderek/secret_broker"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "rails", [">= 4.0.0", "< 6.0.0"]
+  spec.add_runtime_dependency "ejson"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: secret_broker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Derek Schneider
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: ejson
+  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: Secret Broker
+email:
+- schneidermd1993@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/secret_broker.rb
+- lib/secret_broker/dummy_secrets_hash.rb
+- lib/secret_broker/ejson_secrets_file.rb
+- lib/secret_broker/railtie.rb
+- lib/secret_broker/version.rb
+- lib/tasks/secret_broker.tasks
+- secret_broker.gemspec
+homepage: https://github.com/schneiderderek/secret_broker
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Secret Broker
+test_files: []