ejson_wrapper 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4da8151cb31c1a65a18b01e0e16833567bccd5d44c5bd31a9a0bd03e51b363ff
+  data.tar.gz: 297da1cbce75a75deb42110631903c342f372fb28beee2da8ace8863cefa7bcc
+SHA512:
+  metadata.gz: 444befc48197ce281f1ff2e1887375fb50aded70e4d39d84dca4749137f7a8755b0b8b2686cd2888d1395b1b2ceda7389f0ee6380071ad7c99e3471fe1e39eef
+  data.tar.gz: 0131ad60f86e89efa9872b310aa10557047af9e74099d1c928a20a17c832150ff4ad5ad616f7c1616abe3fcfccbeaa4e7b4ec879b28e491ddc2089118ff7d9be

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ejson_wrapper.gemspec
+gemspec

data/README.md

@@ -0,0 +1,80 @@
+# EjsonWrapper
+
+Wraps the EJSON go program to safely execute it and parse the resulting JSON.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ejson_wrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ejson_wrapper
+
+## Usage
+
+### Decrypting EJSON files
+
+From Ruby:
+
+```
+# Private key is in /opt/ejson/keys
+EJSONWrapper.decrypt('myfile.ejson')
+=> { :my_api_key => 'secret' }
+
+# Private key is in /alternate/key/dir
+EJSONWrapper.decrypt('myfile.ejson', key_dir: 'alternate/key/dir')
+=> { :my_api_key => 'secret' }
+
+# Private key is in memory
+EJSONWrapper.decrypt('myfile.ejson', private_key: 'be8597abaa68bbfa23193624b1ed5e2cd6b9a8015e722138b23ecd3c90239b2d')
+=> { :my_api_key => 'secret' }
+
+# Private key is stored inside the ejson file itself as _private_key_enc (encrypted with KMS & Base64 encoded)
+EJSONWrapper.decrypt('myfile.ejson', use_kms: true, region: 'ap-southeast-2')
+=> { :my_api_key => 'secret' }
+```
+
+Command line:
+
+```
+# decrypt all
+$ ejson_wrapper decrypt --file file.ejson --region us-east-1
+{
+  "datadog_api_token": "[datadog_api_token]"
+}
+
+# decrypt & extract a specific secret
+$ ejson_wrapper decrypt --file file.ejson --region us-east-1 --secret datadog_api_token
+[datadog_api_token]
+```
+
+### Generating EJSON files
+
+```
+$ ejson_wrapper generate --region ap-southeast-2 --kms-key-id [key_id] --file file.ejson
+Generated EJSON file file.ejson
+
+$ cat file.ejson
+{
+  "_public_key": "[public_key]",
+  "_private_key_enc":"[encrypted_private_key]"
+}
+```
+
+## 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/envato/ejson_wrapper.

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 "ejson_wrapper"
+
+# 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(__FILE__)

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/ejson_wrapper.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ejson_wrapper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ejson_wrapper"
+  spec.version       = EjsonWrapper::VERSION
+  spec.authors       = ["Steve Hodgkiss"]
+  spec.email         = ["steve@hodgkiss.me"]
+
+  spec.summary       = %q{Invoke EJSON from Ruby}
+  spec.description   = %q{Invoke EJSON from Ruby}
+  spec.homepage      = "https://github.com/envato/ejson_wrapper"
+
+  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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ejson"
+  spec.add_dependency "aws-sdk-kms"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/exe/ejson_wrapper

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ejson_wrapper"
+
+require 'optparse'
+
+options = {
+  region: nil,
+  kms_key_id: nil
+}
+option_parser = OptionParser.new do |opts|
+  opts.banner = 'Usage: ejson_wrapper generate [options]'
+
+  opts.on('--region R', String, 'AWS Region') do |v|
+    options[:region] = v
+  end
+
+  opts.on('--kms-key-id K', String, 'KMS Key ID') do |v|
+    options[:kms_key_id] = v
+  end
+
+  opts.on('--file F', String, 'EJSON file to read or write') do |v|
+    options[:file] = v
+  end
+
+  opts.on('--secret S', String, 'Secret to extract') do |v|
+    options[:secret] = v
+  end
+end
+
+command = ARGV[0]
+
+option_parser.parse!
+
+if options[:region].nil?
+  STDERR.puts "Missing --region option"
+  STDERR.puts option_parser
+  exit 1
+end
+
+if options[:file].nil?
+  STDERR.puts "Missing --file option"
+  STDERR.puts option_parser
+  exit 1
+end
+
+case command
+when 'generate'
+  if options[:kms_key_id].nil?
+    STDERR.puts "Missing --kms-key-id option"
+    STDERR.puts option_parser
+    exit 1
+  end
+
+  EJSONWrapper.generate(region: options[:region],
+                        kms_key_id: options[:kms_key_id],
+                        file: options[:file])
+when 'decrypt'
+  decrypted_secrets = EJSONWrapper.decrypt(options[:file], use_kms: true, region: options[:region])
+  if options[:secret]
+    secret = options[:secret].to_sym
+    unless decrypted_secrets.key?(secret)
+      STDERR.puts "Secret not found"
+      exit 1
+    end
+    puts decrypted_secrets.fetch(secret)
+  else
+    puts JSON.pretty_generate(decrypted_secrets)
+  end
+else
+  STDERR.puts option_parser.banner
+  exit 1
+end

data/lib/ejson_wrapper/decrypt_ejson_file.rb

@@ -0,0 +1,46 @@
+require 'open3'
+
+module EJSONWrapper
+  DecryptionFailed = Class.new(StandardError)
+
+  class DecryptEJSONFile
+    def self.call(file_path, **args)
+      new.call(file_path, **args)
+    end
+
+    def call(file_path, key_dir: nil, private_key: nil)
+      decrypted_json = invoke_decrypt(file_path, key_dir: key_dir, private_key: private_key)
+      parse_json(decrypted_json)
+    end
+
+    private
+
+    def invoke_decrypt(file_path, key_dir:, private_key:)
+      command = ['ejson', 'decrypt']
+      options = {}
+      if private_key
+        options[:stdin_data] = private_key
+        command << '--key-from-stdin'
+      end
+      command << file_path.to_s
+      stdout, status = Open3.capture2(ejson_env(key_dir), *command, options)
+      raise DecryptionFailed, stdout unless status.success?
+      stdout
+    end
+
+    def ejson_env(key_dir)
+      {
+        'EJSON_KEYDIR' => key_dir
+      }.select { |_, v| !v.nil? }
+    end
+
+    def parse_json(decrypted_json)
+      JSON.parse(decrypted_json, symbolize_names: true).tap do |secrets|
+        secrets.delete(:_public_key)
+        secrets.delete(:_private_key_enc)
+      end.freeze
+    rescue JSON::ParserError
+      raise DecryptionFailed, "Failed to parse JSON output from EJSON"
+    end
+  end
+end

data/lib/ejson_wrapper/decrypt_private_key_with_kms.rb

@@ -0,0 +1,28 @@
+require 'aws-sdk-kms'
+require 'base64'
+
+module EJSONWrapper
+  PrivateKeyNotFound = Class.new(StandardError)
+
+  class DecryptPrivateKeyWithKMS
+    def self.call(*args)
+      new.call(*args)
+    end
+
+    KEY = '_private_key_enc'
+
+    def call(ejson_file_path, region:)
+      ejson_hash = JSON.parse(File.read(ejson_file_path))
+      encrypted_private_key = ejson_hash.fetch(KEY) do
+        raise PrivateKeyNotFound, "Private key was not found in ejson file under key #{key}"
+      end
+      decrypt(Base64.decode64(encrypted_private_key), region: region)
+    end
+
+    private
+
+    def decrypt(ciphertext_blob, region:)
+      Aws::KMS::Client.new(region: region).decrypt(ciphertext_blob: ciphertext_blob).plaintext
+    end
+  end
+end

data/lib/ejson_wrapper/generate.rb

@@ -0,0 +1,46 @@
+require 'open3'
+require 'aws-sdk-kms'
+
+module EJSONWrapper
+  KeygenFailed = Class.new(StandardError)
+
+  class Generate
+    def call(region:, kms_key_id:, file:)
+      public_key, private_key = *keygen
+      encrypted_private_key = encrypt_with_kms_key(region, kms_key_id, private_key)
+      ejson_file = JSON.pretty_generate(
+        '_public_key' => public_key,
+        '_private_key_enc' => encrypted_private_key
+      )
+      File.write(file, ejson_file)
+      puts "Generated EJSON file #{file}"
+    end
+
+    private
+
+    def keygen
+      output = invoke_ejson_keygen
+      extract_keys(output)
+    end
+
+    def invoke_ejson_keygen
+      stdout, status = Open3.capture2e('ejson', 'keygen')
+      raise KeygenFailed, stdout unless status.success?
+      stdout
+    end
+
+    def extract_keys(output)
+      lines = output.split("\n")
+      [lines[1], lines[3]]
+    end
+
+    def encrypt_with_kms_key(region, key_id, plaintext)
+      client = Aws::KMS::Client.new(region: region)
+      response = client.encrypt(
+        key_id: key_id,
+        plaintext: plaintext
+      )
+      Base64.encode64(response.ciphertext_blob).strip
+    end
+  end
+end

data/lib/ejson_wrapper/version.rb

@@ -0,0 +1,3 @@
+module EjsonWrapper
+  VERSION = "0.3.1"
+end

data/lib/ejson_wrapper.rb

@@ -0,0 +1,17 @@
+require "ejson_wrapper/version"
+require "ejson_wrapper/decrypt_private_key_with_kms"
+require "ejson_wrapper/decrypt_ejson_file"
+require "ejson_wrapper/generate"
+
+module EJSONWrapper
+  def self.decrypt(file_path, key_dir: nil, private_key: nil, use_kms: false, region: nil)
+    if use_kms
+      private_key = DecryptPrivateKeyWithKMS.call(file_path, region: region)
+    end
+    DecryptEJSONFile.call(file_path, key_dir: key_dir, private_key: private_key)
+  end
+
+  def self.generate(**args)
+    Generate.new.call(**args)
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: ejson_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Steve Hodgkiss
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-06 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-kms
+  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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: pry
+  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: Invoke EJSON from Ruby
+email:
+- steve@hodgkiss.me
+executables:
+- ejson_wrapper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ejson_wrapper.gemspec
+- exe/ejson_wrapper
+- lib/ejson_wrapper.rb
+- lib/ejson_wrapper/decrypt_ejson_file.rb
+- lib/ejson_wrapper/decrypt_private_key_with_kms.rb
+- lib/ejson_wrapper/generate.rb
+- lib/ejson_wrapper/version.rb
+homepage: https://github.com/envato/ejson_wrapper
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Invoke EJSON from Ruby
+test_files: []