mongoid-kms 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 152ab9efb3d3ff2f8b71da1554c5777c3755314c
+  data.tar.gz: d81114ff55dd6e86c452a9373b50a335ce0fb322
+SHA512:
+  metadata.gz: 9186bceab9122577c6333488bee6980acfbb18b1640476b061e01b4a7e593bc7630a8c00ac68ab1319e7635bfd934ec7db8d5b46f62ad7b616337ad8f9a3dc20
+  data.tar.gz: 5bd3f7ceb2b21d1db72847cc5883958f901a3d26d5762473f0fbdb603eb5908e85a1ef4464c10d74c9e2bf9371989d1974566947625ede1d29b7164a24e2490b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,43 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "ostruct"
+
+  # Generic Ruby apps
+  rspec = OpenStruct.new
+  rspec.spec = ->(m) { "spec/#{m}_spec.rb" }
+  rspec.spec_dir = "spec"
+  rspec.spec_helper = "spec/spec_helper.rb"
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| rspec.spec.("lib/#{m[1]}") }
+  watch(rspec.spec_helper)      { rspec.spec_dir }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Winslett
+
+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,52 @@
+# Mongoid::Kms
+
+Easily encrypt your datas using AWS's KSM.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid-kms'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-kms
+
+## Usage
+
+Environmental variables to include:
+
+```
+AWS_ACCESS_KEY_ID # an IAM access key
+AWS_SECRET_ACCESS_KEY # an IAM access secret
+```
+
+Somewhere before your run your application, you will need to add this:
+
+```ruby
+Mongoid::Kms.configure({region: "us-east-1", key: "your aws kms key id i.e <02342-234-232-234-234>"})
+```
+
+When defining yoru classes, `include Mongoid::Kms`, and use the
+`secure_field` to define your fields with a required `:context`.
+Context must return a hash.
+
+```ruby
+class MyClass
+  include Mongoid::Document
+  include Mongoid::Kms
+
+  secure_field :secure, type: String, context: lambda { |d| {name: d.name} }
+  field :unsecure
+
+  def name
+    @name ||= "me-#{Time.now.to_i}"
+  end
+end
+```

data/Rakefile

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

data/circle.yml

@@ -0,0 +1,6 @@
+machine:
+  ruby:
+    version: 2.0.0
+dependencies:
+  pre:
+    - gem update bundler

data/lib/mongoid/kms.rb

@@ -0,0 +1,81 @@
+require 'active_support/concern'
+require 'aws-sdk'
+require "mongoid/kms/version"
+
+module Mongoid
+  module Kms
+    extend ActiveSupport::Concern
+
+    @configuration = {}
+    @kms = nil
+
+    def self.configure(args)
+      @configuration = args
+    end
+
+    def self.configuration
+      @configuration || {}
+    end
+
+    def self.kms
+      @kms ||= Aws::KMS::Client.new(region: self.region)
+    end
+
+    def self.region
+      configuration[:region]
+    end
+
+    def self.key
+      configuration[:key]
+    end
+
+    module ClassMethods
+      def encrypt_field(field_name, value)
+        Mongoid::Kms.kms.encrypt({
+          key_id: Mongoid::Kms.key,
+          plaintext: value,
+          encryption_context: kms_context(field_name)
+        })[:ciphertext_blob].force_encoding('UTF-8')
+      end
+
+      def decrypt_field(field_name, data)
+        Mongoid::Kms.kms.decrypt({
+          ciphertext_blob: data,
+          encryption_context: kms_context(field_name)
+        })[:plaintext]
+      end
+
+      def kms_context(field_name)
+        c = @ksm_field_map[field_name.to_s][:context]
+        c = c.call(self) if c.is_a?(Proc)
+        c
+      end
+
+      def ksm_type(field_name)
+        @ksm_field_map[field_name.to_s][:type]
+      end
+
+      def secure_field(field_name, args)
+        encrypted_field_name = "kms_secure_#{field_name}"
+
+        @ksm_field_map ||= {}
+        @ksm_field_map[field_name.to_s] = {context: args.delete(:context), type: args.delete(:type)}
+
+        field encrypted_field_name, args.merge(type: BSON::Binary)
+
+        define_method(field_name) do
+          instance_variable_get("@#{field_name}") || begin
+          v = self.class.decrypt_field(field_name, send("kms_secure_#{field_name}"))
+            instance_variable_set("@#{field_name}", v)
+            v
+          end
+        end
+
+        define_method("#{field_name}=") do |value|
+          instance_variable_set("@#{field_name}", value)
+          self.send("#{encrypted_field_name}=", self.class.encrypt_field(field_name, value))
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/kms/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+module Kms
+VERSION = "0.0.8"
+end
+end

data/mongoid-kms.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid/kms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-kms"
+  spec.version       = Mongoid::Kms::VERSION
+  spec.authors       = ["Chris Winslett"]
+  spec.email         = ["chris@mongohq.com"]
+  spec.summary       = %q{Easy plugin for Mongoid + AWS KMS for security}
+  spec.description   = %q{Need to encrypt your datas?  Use AWS's KMS for data encryption.}
+  spec.homepage      = "https://github.com/compose/mongoid-kms"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mongoid"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "aws-sdk", "> 2.0.9.pre"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "byebug"
+
+end

data/spec/lib/mongoid/kms_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Mongoid::Kms do
+
+  it "encrypts the secure fields" do
+    o = MyClass.new(secure: "batman", unsecure: "robin")
+    o.save!
+
+    expect(o.secure).to eq("batman")
+    expect(o.kms_secure_secure).to_not be_nil
+  end
+
+  it "descripts the secure fields" do
+    o = MyClass.new(secure: "batman", unsecure: "robin")
+    o.save!
+
+    o = MyClass.find(o.id)
+    expect(o.secure).to eq("batman")
+    expect(o.unsecure).to eq("robin")
+  end
+
+end

data/spec/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+    default:
+      database: mongoid
+      hosts:
+        - localhost:27017

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'mongoid'
+require 'byebug'
+
+require_relative '../lib/mongoid/kms'
+
+Mongoid.load!("spec/mongoid.yml", :test)
+
+class MyClass
+  include Mongoid::Document
+  include Mongoid::Kms
+
+  secure_field :secure, type: String, context: lambda { |d| {name: d.name} }
+  field :unsecure
+
+  def name
+    @name ||= "me-#{Time.now.to_i}"
+  end
+end
+
+Mongoid::Kms.configure({region: "us-east-1", key: ENV['AWS_KMS_KEY_ID']})

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-kms
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Chris Winslett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  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: activesupport
+  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: 2.0.9.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 2.0.9.pre
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: guard-bundler
+  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: byebug
+  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: Need to encrypt your datas?  Use AWS's KMS for data encryption.
+email:
+- chris@mongohq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- lib/mongoid/kms.rb
+- lib/mongoid/kms/version.rb
+- mongoid-kms.gemspec
+- spec/lib/mongoid/kms_spec.rb
+- spec/mongoid.yml
+- spec/spec_helper.rb
+homepage: https://github.com/compose/mongoid-kms
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Easy plugin for Mongoid + AWS KMS for security
+test_files:
+- spec/lib/mongoid/kms_spec.rb
+- spec/mongoid.yml
+- spec/spec_helper.rb