the_encryptor 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Pham
+
+MIT License
+
+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,48 @@
+# Encryptor
+
+Encrypt sensitive data on your ActiveRecord models or plain ol' Ruby objects using AES.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'encryptor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install encryptor
+
+## Usage
+
+Add this line within the class definition to any object, ActiveRecord model or not, you want to encrypt sensitive data:
+
+    $ include Encryptor
+
+For any attribute you want to encrypt, add the line:
+
+    $ encrypted :attribute_name
+
+This assumes you have two other attributes named encrypted_#{attribute_name} and #{attribute_name}_key.
+
+It will then create #{attribute_name} and #{attribute_name}= methods that will transparently decrypt and encrypt the attribute.
+
+Optionally, you can have two arguments that override the default name of the encrypted attribute and attribute key, like so:
+
+    $ encrypted :attribute_name, :optional_encrypted_attribute_name, :optional_attribute_key
+
+## TODO
+
+* Tests, tests, tests
+* Refactor out usage of AES into a strategy
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/encryptor.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'encryptor/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'the_encryptor'
+  gem.version       = Encryptor::VERSION
+  gem.authors       = ['David Pham']
+  gem.email         = ['hello@khoi.co']
+  gem.summary       = %q{Declaratively encrypt sensitive data}
+  gem.description   = %q{Encrypt sensitive data on your ActiveRecord models or plain ol' Ruby objects}
+  gem.homepage      = 'http://khoi.co'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'aes', '~> 0.5.0'
+end

data/lib/encryptor/version.rb

@@ -0,0 +1,3 @@
+module Encryptor
+  VERSION = '0.0.1'
+end

data/lib/encryptor.rb

@@ -0,0 +1,75 @@
+require 'encryptor/version'
+
+require 'active_support/concern'
+require 'aes'
+
+module Encryptor
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # Preconditions
+    # => attribute_name - symbol, it is the name of the virtual attribute you want to create
+    # => (optional) encrypted_attribute_name - symbol, it is the name of the encrypted attribute
+    # => (optional) key_name - symbol, it is the name of the key
+    # Postconditions
+    # => #{attribute_name} instance method is created and handles decryption
+    # => #{attribute_name}= instance method is created and handles encryption
+    def encrypted(attribute_name, encrypted_attribute_name = nil, key_name = nil)
+      encrypted_attribute_name = encrypted_attribute_name.present? ? encrypted_attribute_name : "encrypted_#{attribute_name}"
+      key_name = key_name.present? ? key_name : "#{attribute_name}_key"
+
+      class_eval do
+        define_method :"#{attribute_name}" do
+          decrypt(self.send(encrypted_attribute_name), self.send(key_name))
+        end
+
+        define_method :"#{attribute_name}=" do |value_to_encrypt|
+          encrypted_parts = encrypt(value_to_encrypt)
+
+          key = encrypted_parts[:key]
+          encrypted_attribute = encrypted_parts[:encrypted_attribute]
+
+          self.send("#{key_name}=", key)
+
+          self.send("#{encrypted_attribute_name}=", encrypted_attribute)
+        end
+      end
+    end
+  end
+
+  # Preconditions
+  # => encrypted_attribute - string, it is the encrypted value
+  # => key, string, it is the key
+  # Postconditions
+  # => If both encrypted_attribute and key are present
+  #      * Returns decrypted value - string
+  # => Else
+  #      * Returns nil
+  def decrypt(encrypted_attribute, key)
+    if encrypted_attribute.present? and key.present?
+      AES.decrypt(encrypted_attribute, key)
+    end
+  end
+
+  # Preconditions
+  # => attribute - string, it is the unencrypted value
+  # Postconditions
+  # => If attribute is present
+  #      * Returns a hash with the following keys:
+  #        - key - string
+  #        - encrypted_attribute - string
+  # => Else
+  #      * Returns a hash with the same keys as above but with nil values
+  def encrypt(attribute)
+    if attribute.present?
+      key = AES.key
+
+      encrypted_attribute = AES.encrypt(attribute, key)
+    end
+
+    {
+      key: key,
+      encrypted_attribute: encrypted_attribute
+    }
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: the_encryptor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Pham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aes
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Encrypt sensitive data on your ActiveRecord models or plain ol' Ruby
+  objects
+email:
+- hello@khoi.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- encryptor.gemspec
+- lib/encryptor.rb
+- lib/encryptor/version.rb
+homepage: http://khoi.co
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Declaratively encrypt sensitive data
+test_files: []
+has_rdoc: