acts_as_encryptable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd3645c421c930f061027f4e925adc58d428dd16
+  data.tar.gz: d6a945aa8b5f0073b4557d0c722dcc9977896301
+SHA512:
+  metadata.gz: 140516b6ee840faa1eed51774fa839d6d0226486bc8c43eacf1bfdf61548e558f588be0cbb1865c6748ffaa4d5f1ab25aa8311d25cf5ea87531301f19644a6fe
+  data.tar.gz: d0b0268d67e53084a3b9fc0b5933c58968ce9c0e96765b6de8ca329ed50330f35b172cc46215e9a37a6df9ed75b84cb2f26bc6da81d2686d4f5c4d4bf1630faa

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel P. Clark
+
+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,80 @@
+# ActsAsEncryptable
+
+This gem add support for ActiveSupports existing message encryption feature
+and allows you to set any ActiveRecord model as an encrypted field.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_encryptable'
+```
+
+And create an initializer file `config/initializers/acts_as_encryptable.rb`
+
+```ruby
+ActiveRecord::Base.extend ActsAsEncryptable
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_encryptable
+
+## Usage
+
+Adding encryption to any column is as easy as writing a few lines.
+
+```ruby
+class Email < ActiveRecord::Base
+  acts_as_encryptable :raw_body, :the_key, :the_salt
+
+  private
+  def the_key
+    "example key" # Some consistent/secure way to derive the key
+  end
+
+  def the_salt
+    "example salt" # Some consistent/secure way to derive the salt
+  end
+end
+```
+
+If you're encrypting multiple fields you may choose to use to alter what keys
+and salts are used per column but this will add a performance hit for the extra
+encryption startup time.
+
+If you want to perform additional work on record data that you want to encrypt
+write a method alias after the `acts_as_encryptable` decleration and have your
+new method call it.  `acts_as_encryptable` should always be written before any
+method aliasing.
+
+```ruby
+# Example
+alias_method :renamed_method, :current_example
+
+def current_example
+  renamed_method.do_something
+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/danielpclark/acts_as_encryptable.
+
+
+## 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,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 => :spec

data/acts_as_encryptable.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_encryptable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_encryptable"
+  spec.version       = ActsAsEncryptable::VERSION
+  spec.authors       = ["Daniel P. Clark"]
+  spec.email         = ["6ftdan@gmail.com"]
+
+  spec.summary       = %q{Adds simple record encryption for Rails.}
+  spec.description   = %q{Extends Rails existing encryption methods and adds simple record encryption.}
+  spec.homepage      = "https://github.com/danielpclark/acts_as_encryptable"
+  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_runtime_dependency 'activesupport', '>= 4.1'
+
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency 'activerecord', '~> 4.1'
+  spec.add_development_dependency 'activesupport', '~> 4.1'
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 11.1"
+  spec.add_development_dependency "minitest", "~> 5.8.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.1"
+  spec.add_development_dependency "color_pound_spec_reporter", "~> 0.0.5"
+end

data/bin/console

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

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/acts_as_encryptable/version.rb

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

data/lib/acts_as_encryptable.rb

@@ -0,0 +1,33 @@
+require "acts_as_encryptable/version"
+
+module ActsAsEncryptable
+  def acts_as_encryptable column_name, key, salt
+    send :define_method, column_name do
+      encryptor = "@encryptor_#{key}_#{salt}"
+
+      instance_variable_set(
+        encryptor,
+        ActiveSupport::MessageEncryptor.new(
+          ActiveSupport::KeyGenerator.new(send key).generate_key(send salt)
+        )
+      ) unless instance_variable_defined? encryptor
+
+      encryptor = instance_variable_get(encryptor)
+      encryptor.decrypt_and_verify(read_attribute column_name)
+    end
+
+    send :define_method, "#{column_name}=".to_sym do |value|
+      encryptor = "@encryptor_#{key}_#{salt}"
+
+      instance_variable_set(
+        encryptor,
+        ActiveSupport::MessageEncryptor.new(
+          ActiveSupport::KeyGenerator.new(send key).generate_key(send salt)
+        )
+      ) unless instance_variable_defined? encryptor
+
+      encryptor = instance_variable_get(encryptor)
+      write_attribute column_name, encryptor.encrypt_and_sign(value)
+    end
+  end
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_encryptable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel P. Clark
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.0
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: color_pound_spec_reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+description: Extends Rails existing encryption methods and adds simple record encryption.
+email:
+- 6ftdan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_encryptable.gemspec
+- bin/console
+- bin/setup
+- lib/acts_as_encryptable.rb
+- lib/acts_as_encryptable/version.rb
+homepage: https://github.com/danielpclark/acts_as_encryptable
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Adds simple record encryption for Rails.
+test_files: []