encrypt_column 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 181ee10189a3bafd2eff6e34027ed0e9d306188e
+  data.tar.gz: af2b55e36335468a8fcb822c6eab00b0d50b8fd1
+SHA512:
+  metadata.gz: d7c4639ddc4fdd40cc6e8b6aa6d7a91a71854aef372ba108e5ff4a32d5c85ed54cf8f567338d28193e0336c9fb79e3d70e9c152f9c46467de9ae68b9c02b061d
+  data.tar.gz: d95a83fae55a881a65645b8a40674f28a989ea4cc7488fe5b81d670a85c961298e55e637335760d92ff2777edb7705d3656016557e993c363dcbb4851083e835

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/.rubocop.yml

@@ -0,0 +1,49 @@
+# Run rubocop --auto-gen-config to generate a to-do file with a list of issues
+#
+
+AllCops:
+  TargetRubyVersion: 2.2
+  Include:
+    - Rakefile
+    - config.ru
+    - lib/**/*
+  Exclude:
+    - db/schema.rb
+    - db/**/*
+    - files/**/*
+    - test/**/*
+    - spec/**/*
+    - tmp/**/*
+    - bin/**/*
+    - !ruby/regexp /old_and_unused\.rb$/
+    - lib/templates/erb/scaffold/_form.html.erb
+    - scripts/interactive/**/*
+  # By default, the rails cops are not run. Override in project or home
+  # directory .rubocop.yml files, or by giving the -R/--rails option.
+  # RunRailsCops: true
+
+# Disable documentation checking until a class needs to be documented
+Documentation:
+  Enabled: false
+
+Style/IndentationWidth:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Max: 100
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 18
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 9

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dan Herman
+
+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 @@
+# EncryptColumn
+
+Encrypt any column with an optional hash (using searchable: true) or conditionally (if: Proc)
+also has a failsafe (failsafe: true) feature to write to different db column in
+the database, i.e. `<name>_ciphertext`. This prevents users from accidentally
+commenting out the encrypt declaration and writing plaintext to the database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'encrypt_column'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install encrypt_column
+
+## Usage
+
+Add the following to the top of your model file
+```ruby
+  include EncryptColumn
+```
+
+The gem uses the ENCRYPTION_KEY environment variable for encryption setup:
+```
+  ENV['ENCRYPTION_KEY'] = 'your_encryption_key_goes_here'
+```
+and optionally a HASH_SALT if the searchable option is used.
+```
+  ENV['HASH_SALT'] = 'some_salt'
+```
+
+Then specify the column to be encrypted as so (i.e. encrypt ssn column):
+```ruby
+  encrypt :ssn
+```
+
+To add a `<Model>.with_<field_name>(<field_value>)` search method (using a hash column named `<column_name>_hash` or `ssn_hash`)
+```ruby
+  encrypt :ssn, searchable: true
+
+Usage like so:
+
+  SecureTable.with_ssn('123456789')
+```
+
+To use a failsafe column name to prevent accidental removal of encryption specify "failsafe: true". This will store the data in a column name `<column_name>_ciphertext` (i.e. `ssn_ciphertext`) but allow for read/write access by the original column name.
+```ruby
+  encrypt :ssn, failsafe: true
+```
+
+To conditionally encrypt a column you can specify an if statement like so:
+```ruby
+  encrypt :card_number,  if: -> (x) { x.card_type == 'credit' }
+```
+
+Use all the options combined, like so:
+```ruby
+  encrypt :card_number, searchable: true, failsafe: true, if -> (x) { x.card_type == 'credit' }
+```
+
+
+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/danlherman/encrypt_column.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'encrypt_column'
+require 'pry'
+
+Pry.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/encrypt_column.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'encrypt_column/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "encrypt_column"
+  spec.version       = EncryptColumn::VERSION
+  spec.authors       = ["Dan Herman"]
+  spec.email         = ["dherman@intratechs.com"]
+
+  spec.summary       = %q{Easily encrypt columns in your app conditionally and with hashed values for searching}
+  spec.homepage      = "https://github.com/danlherman/encrypt_column"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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_development_dependency "sqlite3"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rubocop"
+
+  spec.add_dependency "bcrypt", "~> 3.1"
+  spec.add_dependency "activerecord"
+  spec.add_dependency "activesupport"
+end

data/lib/encrypt_column/decrypt.rb

@@ -0,0 +1,8 @@
+class Decrypt
+  def self.cipher(ciphertext)
+    raise 'Encryption Key Config Missing' unless ENV['encryption_key'].present?
+    ActiveSupport::MessageEncryptor.new(ENV['encryption_key']).decrypt_and_verify(ciphertext)
+  rescue ActiveSupport::MessageVerifier::InvalidSignature
+    return ciphertext
+  end
+end

data/lib/encrypt_column/encrypt.rb

@@ -0,0 +1,6 @@
+class Encrypt
+  def self.text(plaintext)
+    return raise 'Missing Encryption Key Config' if ENV['encryption_key'].nil?
+    ActiveSupport::MessageEncryptor.new(ENV['encryption_key']).encrypt_and_sign(plaintext)
+  end
+end

data/lib/encrypt_column/encrypt_column.rb

@@ -0,0 +1,33 @@
+module ClassMethods
+  # Encrypt any column with a hash (searchable: true) or conditionally(if: Proc)
+  # also has a failsafe (failsafe: true) feature to write to a different db column
+  # in the database, i.e. <name>_ciphertext. This prevents users from accidentally
+  # commenting out the encrypt declaration and reading/writing plaintext to the
+  # database.
+  def encrypt(name, options = {})
+    searchable = options[:searchable] || false
+    encrypt_cond = options[:if] || proc { true }
+    failsafe = options[:failsafe] || false
+    column = name
+    column = "#{name}_ciphertext" if failsafe
+    hash_column = "#{name}_hash"
+
+    # getter
+    define_method(name) do
+      return read_attribute(column) unless instance_eval(&encrypt_cond)
+      Decrypt.cipher(read_attribute(column))
+    end
+
+    # setter
+    define_method("#{name}=") do |value|
+      return write_attribute(column, value) unless instance_eval(&encrypt_cond)
+      write_attribute(column, Encrypt.text(value))
+      write_attribute(hash_column, Hashed.val(value)) if searchable
+    end
+
+    # search method when searchable specified
+    define_singleton_method("with_#{name}") do |value|
+      where(hash_column.to_sym => Hashed.val(value))
+    end if searchable
+  end
+end

data/lib/encrypt_column/hashed.rb

@@ -0,0 +1,9 @@
+require 'digest'
+
+class Hashed
+  def self.val(plaintext)
+    return nil if plaintext.nil?
+    return raise 'Missing Hash Salt Config' if ENV['hash_salt'].nil?
+    Digest::SHA2.hexdigest(ENV['hash_salt'] + plaintext.to_s)
+  end
+end

data/lib/encrypt_column/version.rb

@@ -0,0 +1,3 @@
+module EncryptColumn
+  VERSION = '0.1.0'.freeze
+end

data/lib/encrypt_column.rb

@@ -0,0 +1,7 @@
+module EncryptColumn
+  require 'encrypt_column/version'
+  require 'encrypt_column/encrypt_column'
+  require 'encrypt_column/encrypt'
+  require 'encrypt_column/decrypt'
+  require 'encrypt_column/hashed'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: encrypt_column
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Herman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-12 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: sqlite3
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+description: 
+email:
+- dherman@intratechs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- encrypt_column.gemspec
+- lib/encrypt_column.rb
+- lib/encrypt_column/decrypt.rb
+- lib/encrypt_column/encrypt.rb
+- lib/encrypt_column/encrypt_column.rb
+- lib/encrypt_column/hashed.rb
+- lib/encrypt_column/version.rb
+homepage: https://github.com/danlherman/encrypt_column
+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.6
+signing_key: 
+specification_version: 4
+summary: Easily encrypt columns in your app conditionally and with hashed values for
+  searching
+test_files: []