blind_index 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e26dcb60e11724a65676d7f36d31cbcf7f261fb8
+  data.tar.gz: a1308e6c01819a59ef5e3c041b77cab2a93995c5
+SHA512:
+  metadata.gz: bfa731e6ad5e26ed636e13da6f2ec4a2c292e121c35a6a6abde027faaab80964931f035a6cdd4599df71d243884d883784bf66a8ed9a7cd770bb7cccfdb7beb7
+  data.tar.gz: 1a2e24f6e6fd38b1406c5b6585953b99de642850b5707ddd052dbf1732b14043c3ad962d9e874a8d2dbdc4a40e250e3634699be6e2d0e4608cfc59bac8930f41

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm: 2.4.2
+gemfile:
+  - Gemfile
+  - test/gemfiles/activerecord50.gemfile
+sudo: false
+before_install: gem install bundler
+script: bundle exec rake test
+notifications:
+  email:
+    on_success: never
+    on_failure: change

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2017 Andrew Kane
+
+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,124 @@
+# Blind Index
+
+Securely query encrypted database fields
+
+Designed for use with [attr_encrypted](https://github.com/attr-encrypted/attr_encrypted)
+
+## How It Works
+
+We use [this approach](https://www.sitepoint.com/how-to-search-on-securely-encrypted-database-fields/) described by Scott Arciszewski. To summarize, we compute a keyed hash of the sensitive data and store it in a column. To query, we apply the keyed hash function (PBKDF2-HMAC-SHA256) to the value we’re searching and then perform a database search. This results in performant queries for equality operations, while keeping the data secure from those without the key.
+
+## Getting Started
+
+Add these lines to your application’s Gemfile:
+
+```ruby
+gem 'attr_encrypted'
+gem 'blind_index'
+```
+
+Add columns for the encrypted data and the blind index
+
+```ruby
+# encrypted data
+add_column :users, :encrypted_email, :text
+add_column :users, :encrypted_email_iv, :text
+
+# blind index
+add_column :users, :encrypted_email_bidx, :text
+add_index :users, :encrypted_email_bidx
+```
+
+Generate one key for encryption and one key for hashing and set them in your environment ([dotenv](https://github.com/bkeepers/dotenv) is great for this). For development, you can use these:
+
+```sh
+EMAIL_ENCRYPTION_KEY=00000000000000000000000000000000
+EMAIL_BLIND_INDEX_KEY=99999999999999999999999999999999
+```
+
+And add to your model
+
+```ruby
+class User < ApplicationRecord
+  attr_encrypted :email, key: ENV["EMAIL_ENCRYPTION_KEY"]
+
+  blind_index :email, key: ENV["EMAIL_BLIND_INDEX_KEY"]
+end
+```
+
+And query away
+
+```ruby
+User.where(email: "test@example.org")
+```
+
+## Validations
+
+To prevent duplicates, use:
+
+```ruby
+class User < ApplicationRecord
+  validates :email, uniqueness: true
+end
+```
+
+We also recommend adding a unique index to the blind index column through a database migration.
+
+## Expressions
+
+You can apply expressions to attributes before indexing and searching. This gives you the the ability to perform case-insensitive searches and more.
+
+```ruby
+class User < ApplicationRecord
+  blind_index :email, expression: -> (v) { v.downcase } ...
+end
+```
+
+## Multiple Indexes
+
+You may want multiple blind indexes for an attribute. To do this, add another column:
+
+```ruby
+add_column :users, :encrypted_email_ci_bidx, :text
+add_index :users, :encrypted_email_ci_bidx
+```
+
+And update your model
+
+```ruby
+class User < ApplicationRecord
+  blind_index :email, ...
+  blind_index :email_ci, attribute: :email, expression: -> (v) { v.downcase } ...
+end
+```
+
+Search with:
+
+```ruby
+User.where(email_ci: "test@example.org")
+```
+
+## Key Stretching
+
+Key stretching increases the amount of time required to compute hashes, which slows down brute-force attacks. You can set the number of iterations with:
+
+```ruby
+class User < ApplicationRecord
+  blind_index :email, iterations: 1000000, ...
+end
+```
+
+The default is `10000`. Changing this value requires you to recompute the blind index.
+
+## History
+
+View the [changelog](https://github.com/ankane/blind_index/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/blind_index/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/blind_index/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,11 @@
+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"]
+  t.warning = false
+end
+
+task default: :test

data/bin/console

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

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "blind_index/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "blind_index"
+  spec.version       = BlindIndex::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+
+  spec.summary       = "Securely query encrypted database fields"
+  spec.homepage      = "https://github.com/ankane/blind_index"
+  spec.license       = "MIT"
+
+  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 "activesupport", ">= 5"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "attr_encrypted"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/blind_index/extensions.rb

@@ -0,0 +1,35 @@
+module BlindIndex
+  module Extensions
+    module TableMetadata
+      def resolve_column_aliases(hash)
+        new_hash = super
+        if has_blind_indexes?
+          hash.each do |key, _|
+            if (bi = klass.blind_indexes[key])
+              new_hash[bi[:bidx_attribute]] = BlindIndex.generate_bidx(new_hash.delete(key), bi)
+            end
+          end
+        end
+        new_hash
+      end
+
+      # memoize for performance
+      def has_blind_indexes?
+        unless defined?(@has_blind_indexes)
+          @has_blind_indexes = klass.respond_to?(:blind_indexes)
+        end
+        @has_blind_indexes
+      end
+    end
+
+    module UniquenessValidator
+      def build_relation(klass, table, attribute, value)
+        if klass.respond_to?(:blind_indexes) && (bi = klass.blind_indexes[attribute])
+          value = BlindIndex.generate_bidx(value, bi)
+          attribute = bi[:bidx_attribute]
+        end
+        super(klass, table, attribute, value)
+      end
+    end
+  end
+end

data/lib/blind_index/model.rb

@@ -0,0 +1,36 @@
+module BlindIndex
+  module Model
+    def blind_index(name, key: nil, iterations: nil, attribute: nil, expression: nil, bidx_attribute: nil)
+      iterations ||= 10000
+      attribute ||= name
+      bidx_attribute ||= :"encrypted_#{name}_bidx"
+
+      name = name.to_sym
+      attribute = attribute.to_sym
+      method_name = :"compute_#{name}_bidx"
+
+      class_eval do
+        class << self
+          def blind_indexes
+            @blind_indexes ||= {}
+          end unless respond_to?(:blind_indexes)
+        end
+
+        raise BlindIndex::Error, "Duplicate blind index: #{name}" if blind_indexes[name]
+
+        blind_indexes[name] = {
+          key: key,
+          iterations: iterations,
+          attribute: attribute,
+          expression: expression,
+          bidx_attribute: bidx_attribute
+        }
+
+        before_validation method_name, if: -> { changes.key?(attribute.to_s) }
+        define_method method_name do
+          self.send("#{bidx_attribute}=", BlindIndex.generate_bidx(send(attribute), self.class.blind_indexes[name]))
+        end
+      end
+    end
+  end
+end

data/lib/blind_index/version.rb

@@ -0,0 +1,3 @@
+module BlindIndex
+  VERSION = "0.1.0"
+end

data/lib/blind_index.rb

@@ -0,0 +1,33 @@
+# dependencies
+require "active_support"
+
+# modules
+require "blind_index/extensions"
+require "blind_index/model"
+require "blind_index/version"
+
+module BlindIndex
+  class Error; end
+
+  def self.generate_bidx(value, key:, iterations:, expression: nil, **options)
+    raise BlindIndex::Error, "Missing key for blind index" unless key
+
+    # apply expression
+    value = expression.call(value) if expression
+
+    # generate hash
+    digest = OpenSSL::Digest::SHA256.new
+    value = OpenSSL::PKCS5.pbkdf2_hmac(value.to_s, key, iterations, digest.digest_length, digest)
+
+    # encode
+    [value].pack("m")
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend BlindIndex::Model
+  ActiveRecord::TableMetadata.prepend(BlindIndex::Extensions::TableMetadata)
+  if ActiveRecord::VERSION::STRING.start_with?("5.0.")
+    ActiveRecord::Validations::UniquenessValidator.prepend(BlindIndex::Extensions::UniquenessValidator)
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: blind_index
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: 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: rake
+  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: minitest
+  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: attr_encrypted
+  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: activerecord
+  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: 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'
+description: 
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blind_index.gemspec
+- lib/blind_index.rb
+- lib/blind_index/extensions.rb
+- lib/blind_index/model.rb
+- lib/blind_index/version.rb
+homepage: https://github.com/ankane/blind_index
+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.13
+signing_key: 
+specification_version: 4
+summary: Securely query encrypted database fields
+test_files: []