action_encrypt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99186586bdc0a439f72fded1d9a8794934e4fa0097199a87246b4f772614d3f3
+  data.tar.gz: 6c8a351353df7358a06b3c526fdceb1f32f1861a3f6f164a3d3affd8091f1c1f
+SHA512:
+  metadata.gz: 565df08df3127620e009755c16163d7628142d93e607f2917ccb6ade143c4b646a56768d705efc24bbf2ddbd962c172d145ae2b77c6be69514b28dd464e67b90
+  data.tar.gz: 4b8e048b55ab3a59cd87e6499ee9e6f0db1ff56d1b22c5445670a52559b3ddd0340042812a5299060aa9705e3c1639397c34baa5f5f0cdceaebbc0f1177c3959

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 David Van Der Beek
+
+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,46 @@
+# ActionEncrypt
+Add encrypted fields to ActiveRecord models easily
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_encrypt'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Install migrations:
+```bash
+$ rails action_encrypt:install:migrations
+```
+
+Add a key_encryption_key to your Rails encrypted credentials file. Generate
+one using `SecureRandom.hex(32)`
+```yml
+key_encryption_key: <<key>>
+```
+
+Create a Data Encryption Key
+```bash
+$ ActionEncrypt::DataEncryptionKey.generate!(primary: true)
+```
+
+Add an encrypted field to your models
+```ruby
+class User < ApplicationRecord
+  has_encrypted :ssn
+end
+```
+
+Now you can use user.ssn as you would any other attribute, but it will be stored
+securely in the action_encrypt_encrypted_fields table.
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActionEncrypt'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/models/action_encrypt/application_record.rb

@@ -0,0 +1,5 @@
+module ActionEncrypt
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/action_encrypt/data_encryption_key.rb

@@ -0,0 +1,23 @@
+module ActionEncrypt
+  class DataEncryptionKey < ApplicationRecord
+    attr_encrypted :key, key: :encryption_key
+
+    scope :primary, -> { find_by(primary: true) }
+    scope :unused, -> { where.not(primary: true, id: EncryptedField.pluck(:data_encryption_key_id).uniq) }
+
+    def self.generate!(attrs={})
+      create!(attrs.merge(key: SecureRandom.hex(32)))
+    end
+
+    def encryption_key
+      [Rails.application.credentials.key_encryption_key].pack("H*")
+    end
+
+    def promote!
+      transaction do
+        DataEncryptionKey.primary.update_attributes!(primary: false)
+        update_attributes!(primary: true)
+      end
+    end
+  end
+end

data/app/models/action_encrypt/encrypted_field.rb

@@ -0,0 +1,17 @@
+module ActionEncrypt
+  class EncryptedField < ApplicationRecord
+    belongs_to :record, polymorphic: true
+    belongs_to :data_encryption_key
+
+    attr_encrypted :blob, key: :encryption_key
+
+    def encryption_key
+      self.data_encryption_key ||= DataEncryptionKey.primary
+      [data_encryption_key.key].pack("H*")
+    end
+
+    def reencrypt!(new_key)
+      update_attributes!(data_encryption_key: new_key, blob: blob)
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+ActionEncrypt::Engine.routes.draw do
+end

data/db/migrate/20190404115831_create_action_encrypt_encrypted_fields.rb

@@ -0,0 +1,17 @@
+class CreateActionEncryptEncryptedFields < ActiveRecord::Migration[5.2]
+  def change
+    enable_extension 'pgcrypto'
+
+    create_table :action_encrypt_encrypted_fields, id: :uuid do |t|
+      t.string :encrypted_blob
+      t.string :encrypted_blob_iv
+      t.string :name, null: false
+      t.uuid :record_id
+      t.string :record_type
+
+      t.timestamps
+
+      t.index [:record_type, :record_id, :name], name: "index_action_encrypt_fields_uniqueness", unique: true
+    end
+  end
+end

data/db/migrate/20190404121918_create_action_encrypt_data_encryption_keys.rb

@@ -0,0 +1,11 @@
+class CreateActionEncryptDataEncryptionKeys < ActiveRecord::Migration[5.2]
+  def change
+    create_table :action_encrypt_data_encryption_keys, id: :uuid do |t|
+      t.string :encrypted_key
+      t.string :encrypted_key_iv
+      t.boolean :primary
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20190404122056_add_data_encryption_key_to_action_encrypt_encrypted_fields.rb

@@ -0,0 +1,5 @@
+class AddDataEncryptionKeyToActionEncryptEncryptedFields < ActiveRecord::Migration[5.2]
+  def change
+    add_reference :action_encrypt_encrypted_fields, :data_encryption_key, type: :uuid, foreign_key: { to_table: :action_encrypt_data_encryption_keys }
+  end
+end

data/lib/action_encrypt/attribute.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ActionEncrypt
+  module Attribute
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def search_encrypted(name, opts = {})
+        blind_index :"#{name}", key: [Rails.application.credentials.blind_index_key].pack("H*")
+
+        before_validation :"compute_#{name}_bidx"
+
+        if opts[:unique] == true
+          validates :"#{name}", uniqueness: true, allow_nil: true
+        end
+      end
+
+      def has_encrypted(name)
+        class_eval <<-CODE, __FILE__, __LINE__ + 1
+          def #{name}
+            #{name}_encrypted_field.blob
+          end
+
+          def #{name}=(value)
+            #{name}_encrypted_field.blob = value
+          end
+
+          def #{name}_encrypted_field
+            super || build_#{name}_encrypted_field
+          end
+        CODE
+
+        has_one :"#{name}_encrypted_field", -> { where(name: name) },
+          class_name: "ActionEncrypt::EncryptedField",
+          as: :record,
+          inverse_of: :record,
+          autosave: true,
+          dependent: :destroy
+
+        scope :"with_#{name}_encrypted_field", -> { includes("#{name}_encrypted_field": :data_encryption_key) }
+      end
+    end
+  end
+end

data/lib/action_encrypt/engine.rb

@@ -0,0 +1,14 @@
+require "attr_encrypted"
+require "active_record/railtie"
+
+module ActionEncrypt
+  class Engine < ::Rails::Engine
+    isolate_namespace ActionEncrypt
+
+    initializer "action_text.attribute" do
+      ActiveSupport.on_load(:active_record) do
+        include ActionEncrypt::Attribute
+      end
+    end
+  end
+end

data/lib/action_encrypt/version.rb

@@ -0,0 +1,3 @@
+module ActionEncrypt
+  VERSION = '0.1.0'
+end

data/lib/action_encrypt.rb

@@ -0,0 +1,9 @@
+require "active_support"
+require "active_support/rails"
+require "action_encrypt/engine"
+
+module ActionEncrypt
+  extend ActiveSupport::Autoload
+
+  autoload :Attribute
+end

data/lib/tasks/action_encrypt_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :action_encrypt do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: action_encrypt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Van Der Beek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: attr_encrypted
+  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: blind_index
+  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: pg
+  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: 
+email:
+- earlynovrock@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/action_encrypt/application_record.rb
+- app/models/action_encrypt/data_encryption_key.rb
+- app/models/action_encrypt/encrypted_field.rb
+- config/routes.rb
+- db/migrate/20190404115831_create_action_encrypt_encrypted_fields.rb
+- db/migrate/20190404121918_create_action_encrypt_data_encryption_keys.rb
+- db/migrate/20190404122056_add_data_encryption_key_to_action_encrypt_encrypted_fields.rb
+- lib/action_encrypt.rb
+- lib/action_encrypt/attribute.rb
+- lib/action_encrypt/engine.rb
+- lib/action_encrypt/version.rb
+- lib/tasks/action_encrypt_tasks.rake
+homepage: 
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Easily add encrypted fields to your models.
+test_files: []