mongoid-encrypted 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5dd7b9229405bb1c7e05ad6fc5e3dd1d6a148cc1
+  data.tar.gz: 4e79ef762eb6933bad10666ee04f107b8ad5b1f2
+SHA512:
+  metadata.gz: 05265b0b9b136771b18126129af459becee99d0ab96e7f97099d4324448829af08be53c2fa245cba7bf3952bfbd1bd49581029538bd17c9492c1aec23a2456fc
+  data.tar.gz: b295a03afed843a2baad824a6a3180823d9e9547f231bc99dd7d77235353fa6f11a68250f99b53fd8d2866d1aeb853ce5cfb452b0c97c6f3edd490b62987908c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mttdffy@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/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 mongoid-encrypted.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    mongoid-encrypted (0.1.0)
+      activesupport (>= 5.2.0)
+      mongoid (>= 6.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    bson (4.5.0)
+    concurrent-ruby (1.1.5)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    mongo (2.9.0)
+      bson (>= 4.4.2, < 5.0.0)
+    mongoid (7.0.4)
+      activemodel (>= 5.1, < 6.0.0)
+      mongo (>= 2.5.1, < 3.0.0)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  mongoid-encrypted!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Matt Duffy
+
+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,82 @@
+# Mongoid::Encrypted
+
+`mongoid-encrypted` provides simple encryption for mongoid fields utilizing the message encryption provided by Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid-encrypted'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-encrypted
+
+## Usage
+
+```ruby
+class SuperSecret
+  include Mongoid::Document
+  include Mongoid::Encrypted
+
+  field :access_code, type: String, encrypted: true
+end
+```
+
+### Configuration
+
+### Encryption Key
+
+To match Rails conventions, `mongoid-encrypted` is configured to look for the encryption key in either an environment variable, or a key file. Either of these can be configured as desired if you are not using Rails, or wish to have a separate key for encrypted Mongoid fields.
+
+```ruby
+# Default
+Mongoid::Encrypted.configuration.env_key #=> RAILS_MASTER_KEY
+Mongoid::Encrypted.configuration.key_path #=> config/master.key
+```
+
+The environment variable will take precedence over the key file. If you want to change either of these values, you can do so during initialization of the application.
+
+```ruby
+Mongoid::Encrypted.configure do |config|
+  config.env_key = 'MONGOID_ENCRYPTED_KEY'
+  config.key_path = 'config/db.key'
+end
+```
+
+### Rotations
+
+`Mongoid::Encrypted.configuration.rotations`
+
+`mongoid-encrypted` provides a mechanism to change keys or encryption while not losing data added with old values. Use this to add fallbacks to Workarea::Encryptor. See [the Rails guides on `ActiveSupport::MessageEncryptor`](https://edgeapi.rubyonrails.org/classes/ActiveSupport/MessageEncryptor.html) for info on options that can be passed to `#rotate`.
+
+```ruby
+Mongoid::Encrypted.configure do |config|
+  config.rotations << ['PREVIOUS_KEY'].pack("H*")
+  config.rotations << { cipher: 'aes-128-gcm' }
+end  
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/mongoid-encrypted. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mongoid::Encrypted project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mongoid-encrypted/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongoid/encrypted"
+
+# 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/lib/mongoid/encrypted.rb

@@ -0,0 +1,38 @@
+require "mongoid/encrypted/version"
+require 'mongoid'
+require 'active_support'
+
+require 'mongoid/fields/encrypted'
+require 'mongoid/encrypted/encryptor'
+
+module Mongoid
+  module Encrypted
+    extend ActiveSupport::Concern
+
+    cattr_accessor :configuration
+    self.configuration =
+      ActiveSupport::Configurable::Configuration.new(
+        cipher: 'aes-128-gcm',
+        env_key: 'RAILS_MASTER_KEY',
+        key_path: 'config/master.key',
+        rotations: []
+      )
+
+    def self.configure
+      yield configuration
+    end
+
+    module ClassMethods
+      protected
+
+      def field_for(name, options)
+        return super unless options[:encrypted]
+
+        opts = options.merge(klass: self)
+        type_mapping = Fields::TYPE_MAPPINGS[options[:type]]
+        opts[:type] = type_mapping || unmapped_type(options)
+        Fields::Encrypted.new(name, opts)
+      end
+    end
+  end
+end

data/lib/mongoid/encrypted/encryptor.rb

@@ -0,0 +1,62 @@
+module Mongoid
+  module Encrypted
+    class Encryptor
+      class MissingKeyError < RuntimeError
+        def initialize(key_path:, env_key:)
+          super \
+            "Missing encryption key to decrypt file with. " +
+            "Ask your team for your master key and write it to #{key_path} or put it in the ENV['#{env_key}']."
+        end
+      end
+
+      class << self
+        def encrypt(value)
+          instance.encrypt_and_sign(value)
+        end
+
+        def decrypt(value)
+          crypt = instance
+
+          if config.rotations.present?
+            config.rotations.each { |r| crypt.rotate *Array.wrap(r) }
+          end
+
+          crypt.decrypt_and_verify(value)
+        end
+
+        private
+
+        def instance
+          ActiveSupport::MessageEncryptor.new(
+            [ key ].pack("H*"),
+            cipher: config.cipher
+          )
+        end
+
+        def key
+          read_env_key || read_key_file || handle_missing_key
+        end
+
+        def read_env_key
+          ENV[config.env_key]
+        end
+
+        def read_key_file
+          Rails.root.join(config.key_path).binread.strip rescue nil
+        end
+
+        def handle_missing_key
+          raise(
+            MissingKeyError,
+            key_path: config.key_path,
+            env_key: config.env_key
+          )
+        end
+
+        def config
+          Encrypted.configuration
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/encrypted/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Encrypted
+    VERSION = "1.0.0"
+  end
+end

data/lib/mongoid/fields/encrypted.rb

@@ -0,0 +1,21 @@
+module Mongoid
+  module Fields
+    class Encrypted < Standard
+      def demongoize(object)
+        if object
+          type.demongoize(Mongoid::Encrypted::Encryptor.decrypt(object))
+        end
+      end
+
+      def encrypted?
+        true
+      end
+
+      def mongoize(object)
+        Mongoid::Encrypted::Encryptor.encrypt(object)
+      end
+    end
+  end
+
+  Fields.option(:encrypted) { |_model, _field, value| value }
+end

data/mongoid-encrypted.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mongoid/encrypted/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-encrypted"
+  spec.version       = Mongoid::Encrypted::VERSION
+  spec.authors       = ["Matt Duffy"]
+  spec.email         = ["mttdffy@gmail.com"]
+
+  spec.summary       = %q{Encrypt mongoid fields with Rails encryption.}
+  spec.homepage      = "https://github.com/workarea-commerce/mongoid-encrypted"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '>= 5.2.0'
+  spec.add_dependency 'mongoid', '>= 6.4.0'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-encrypted
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matt Duffy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- mttdffy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mongoid/encrypted.rb
+- lib/mongoid/encrypted/encryptor.rb
+- lib/mongoid/encrypted/version.rb
+- lib/mongoid/fields/encrypted.rb
+- mongoid-encrypted.gemspec
+homepage: https://github.com/workarea-commerce/mongoid-encrypted
+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.6.14.1
+signing_key: 
+specification_version: 4
+summary: Encrypt mongoid fields with Rails encryption.
+test_files: []