shuber-attr_encrypted 1.0.0

data/CHANGELOG

@@ -0,0 +1,10 @@
+2009-01-08 - Sean Huber (shuber@huberry.com)
+  * Update comments and documentation
+  * Update README
+  * Add gemspec
+
+2009-01-07 - Sean Huber (shuber@huberry.com)
+  * Initial commit
+  * Add comments/documentation to the active record related logic
+  * Add more attr_encrypted tests
+  * Update tests and comments

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Sean Huber - shuber@huberry.com
+
+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.markdown

@@ -0,0 +1,278 @@
+attr\_encrypted
+===============
+
+Generates attr\_accessors that encrypt and decrypt attributes transparently
+
+
+Installation
+------------
+
+	gem install shuber-attr_encrypted --source http://gems.github.com
+
+
+Usage
+-----
+
+### Basic ###
+
+Encrypting attributes has never been easier:
+
+	class User
+	  attr_accessor :name
+	  attr_encrypted :ssn, :key => 'a secret key'
+	
+	  def load
+	    # loads the stored data
+	  end
+	
+	  def save
+	    # saves the :name and :encrypted_ssn attributes somewhere (e.g. filesystem, database, etc)
+	  end
+	end
+	
+	@user = User.new
+	@user.ssn = '123-45-6789'
+	@user.encrypted_ssn # returns the encrypted version of :ssn
+	@user.save
+	
+	@user = User.load
+	@user.ssn # decrypts :encrypted_ssn and returns '123-45-6789'
+
+
+### Specifying the encrypted attribute name ###
+
+By default, the encrypted attribute name is `encrypted_#{attribute}` (e.g. `attr_encrypted :email` would create an attribute named `encrypted_email`).
+You have a couple of options if you want to name your attribute something else.
+
+#### The `:attribute` option ####
+
+You can simply pass the name of the encrypted attribute as the `:attribute` option:
+
+	class User
+	  attr_encrypted :email, :key => 'a secret key', :attribute => 'email_encrypted'
+	end
+
+This would generate an attribute named `email_encrypted`
+
+
+#### The `:prefix` and `:suffix` options ####
+
+If you're planning on encrypting a few different attributes and you don't like the `encrypted_#{attribute}` naming convention then you can specify your own:
+
+	class User
+	  attr_encrypted :email, :credit_card, :ssn, :key => 'a secret key', :prefix => 'secret_', :suffix => '_crypted'
+	end
+
+This would generate the following attributes: `secret_email_crypted`, `secret_credit_card_crypted`, and `secret_ssn_crypted`.
+
+
+### Encryption keys ###
+
+Although a `:key` option may not be required (see custom encryptor below), it has a few special features
+
+#### Unique keys for each attribute ####
+
+You can specify unique keys for each attribute if you'd like:
+
+	class User
+	  attr_encrypted :email, :key => 'a secret key'
+	  attr_encrypted :ssn, :key => 'a different secret key'
+	end
+
+
+#### Symbols representing instance methods as keys ####
+
+If your class has an instance method that determines the encryption key to use, simply pass a symbol representing it like so:
+
+	class User
+	  attr_encrypted :email, :key => :encryption_key
+	
+	  def encryption_key
+	    # does some fancy logic and returns an encryption key
+	  end
+	end
+
+
+#### Procs as keys ####
+
+You can pass a proc object as the `:key` option as well:
+
+	class User
+	  attr_encrypted :email, :key => proc { |user| ... }
+	end
+
+
+### Custom encryptor ###
+
+The [Huberry::Encryptor](http://github.com/shuber/encryptor) class is used by default. You may use your own custom encryptor by specifying
+the `:encryptor`, `:encrypt_method`, and `:decrypt_method` options
+
+Lets suppose you'd like to use this custom encryptor class:
+
+	class SillyEncryptor
+	  def self.silly_encrypt(options)
+	    (options[:value] + options[:secret_key]).reverse
+	  end
+	
+	  def self.silly_decrypt(options)
+	    options[:value].reverse.gsub(/#{options[:secret_key]}$/, '')
+	  end
+	end
+
+Simply set up your class like so:
+
+	class User
+	  attr_encrypted :email, :secret_key => 'a secret key', :encryptor => SillyEncryptor, :encrypt_method => :silly_encrypt, :decrypt_method => :silly_decrypt
+	end
+
+Any options that you pass to `attr_encrypted` will be passed to the encryptor along with the `:value` option which contains the string to encrypt/decrypt.
+Notice it uses `:secret_key` instead of `:key`.
+
+
+### Custom algorithms ###
+
+The default [Huberry::Encryptor](http://github.com/shuber/encryptor) uses the standard ruby OpenSSL library. It's default algorithm is `aes-256-cbc`. You can
+modify this by passing the `:algorithm` option to the `attr_encrypted` call like so:
+
+	class User
+	  attr_encrypted :email, :key => 'a secret key', :algorithm => 'bf'
+	end
+
+Run `openssl list-cipher-commands` to view a list of algorithms supported on your platform. See [http://github.com/shuber/encryptor](http://github.com/shuber/encryptor) for more information.
+
+	aes-128-cbc
+	aes-128-ecb
+	aes-192-cbc
+	aes-192-ecb
+	aes-256-cbc
+	aes-256-ecb
+	base64
+	bf
+	bf-cbc
+	bf-cfb
+	bf-ecb
+	bf-ofb
+	cast
+	cast-cbc
+	cast5-cbc
+	cast5-cfb
+	cast5-ecb
+	cast5-ofb
+	des
+	des-cbc
+	des-cfb
+	des-ecb
+	des-ede
+	des-ede-cbc
+	des-ede-cfb
+	des-ede-ofb
+	des-ede3
+	des-ede3-cbc
+	des-ede3-cfb
+	des-ede3-ofb
+	des-ofb
+	des3
+	desx
+	idea
+	idea-cbc
+	idea-cfb
+	idea-ecb
+	idea-ofb
+	rc2
+	rc2-40-cbc
+	rc2-64-cbc
+	rc2-cbc
+	rc2-cfb
+	rc2-ecb
+	rc2-ofb
+	rc4
+	rc4-40
+
+
+### Default options ###
+
+Let's imagine that you have a few attributes that you want to encrypt with different keys, but you don't like the `encrypted_#{attribute}` naming convention.
+Instead of having to define your class like this:
+
+	class User
+	  attr_encrypted :email, :key => 'a secret key', :prefix => '', :suffix => '_crypted'
+	  attr_encrypted :ssn, :key => 'a different secret key', :prefix => '', :suffix => '_crypted'
+	  attr_encrypted :credit_card, :key => 'another secret key', :prefix => '', :suffix => '_crypted'
+	end
+
+You can simply define some default options like so:
+
+	class User
+	  attr_encrypted_options.merge!(:prefix => '', :suffix => '_crypted')
+	  attr_encrypted :email, :key => 'a secret key'
+	  attr_encrypted :ssn, :key => 'a different secret key'
+	  attr_encrypted :credit_card, :key => 'another secret key'
+	end
+
+This should help keep your classes clean and DRY.
+
+
+### Encoding ###
+
+You're probably going to be storing your encrypted attributes somehow (e.g. filesystem, database, etc) and may run into some issues trying to store a weird
+encrypted string. I've had this problem myself using MySQL. You can simply pass the `:encode` option to automatically base64 encode/decode when encrypting/decrypting.
+
+	class User
+	  attr_encrypted :email, :key => 'some secret key', :encode => true
+	end
+
+
+### Marshaling ###
+
+You may want to encrypt objects other than strings (e.g. hashes, arrays, etc). If this is the case, simply pass the `:marshal` option to automatically marshal
+when encrypting/decrypting.
+
+	class User
+	  attr_encrypted :credentials, :key => 'some secret key', :marshal => true
+	end
+
+
+### Encrypt/decrypt attribute methods ###
+
+If you use the same key to encrypt every record (per attribute) like this:
+
+	class User
+	  attr_encrypted :email, :key => 'a secret key'
+	end
+
+Then you'll have these two class methods available for each attribute: `User.encrypt_email(email_to_encrypt)` and `User.decrypt_email(email_to_decrypt)`. This can
+be useful when you're using ActiveRecord (see below).
+
+
+### ActiveRecord ###
+
+If you're using this gem with ActiveRecord, you get a few extra features:
+
+#### Default options ####
+
+For your convenience, the `:encode` and `:marshal` options are set to true by default since you'll be storing everything in a database.
+
+
+#### Dynamic find\_by\_ and scoped\_by\_ methods ####
+
+Let's say you'd like to encrypt your user's email addresses, but you also need a way for them to login. Simply set up your class like so:
+
+	class User < ActiveRecord::Base
+	  attr_encrypted :email, :key => 'a secret key'
+	  attr_encrypted :password, :key => 'some other secret key'
+	end
+
+You can now lookup and login users like so:
+
+	User.find_by_email_and_password('test@example.com', 'testing')
+
+The call to `find_by_email_and_password` is intercepted and modified to `find_by_encrypted_email_and_encrypted_password('ENCRYPTED EMAIL', 'ENCRYPTED PASSWORD')`.
+The dynamic scope methods like `scoped_by_email_and_password` work the same way.
+
+NOTE: This only works if all records are encrypted with the same encryption key (per attribute).
+
+
+Contact
+-------
+
+Problems, comments, and suggestions all welcome: [shuber@huberry.com](mailto:shuber@huberry.com)

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the attr_encrypted gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the attr_encrypted gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'attr_encrypted'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/attr_encrypted.rb

@@ -0,0 +1,10 @@
+require 'huberry/class'
+Class.send :include, Huberry::Class
+
+require 'huberry/object'
+Object.send :include, Huberry::Object
+
+if defined?(ActiveRecord)
+  require 'huberry/active_record'
+  ActiveRecord::Base.extend Huberry::ActiveRecord
+end

data/lib/huberry/active_record.rb

@@ -0,0 +1,47 @@
+module Huberry
+  module ActiveRecord
+    def self.extended(base)
+      base.eigenclass_eval { alias_method_chain :method_missing, :attr_encrypted }
+    end
+    
+    protected
+    
+      # Calls attr_encrypted with the options <tt>:encode</tt> and <tt>:marshal</tt> set to true
+      # unless they've already been specified
+      def attr_encrypted(*attrs)
+        options = { :encode => true, :marshal => true }.merge(attrs.last.is_a?(Hash) ? attrs.pop : {})
+        super *(attrs << options)
+      end
+    
+      # Allows you to use dynamic methods like <tt>find_by_email</tt> or <tt>scoped_by_email</tt> for 
+      # encrypted attributes
+      #
+      # NOTE: This only works when the <tt>:key</tt> option is specified as a string (see the README)
+      #
+      # This is useful for encrypting fields like email addresses. Your user's email addresses 
+      # are encrypted in the database, but you can still look up a user by email for logging in
+      #
+      # Example
+      #
+      #   class User < ActiveRecord::Base
+      #     attr_encrypted :email, :key => 'secret key'
+      #   end
+      #
+      #   User.find_by_email_and_password('test@example.com', 'testing')
+      #   # results in a call to
+      #   User.find_by_encrypted_email_and_password('the_encrypted_version_of_test@example.com', 'testing')
+      def method_missing_with_attr_encrypted(method, *args, &block)
+        if match = /^(find|scoped)_(all_by|by)_([_a-zA-Z]\w*)$/.match(method.to_s)
+          attribute_names = match.captures.last.split('_and_')
+          attribute_names.each_with_index do |attribute, index|
+            if attr_encrypted?(attribute)
+              args[index] = send("encrypt_#{attribute}", args[index])
+              attribute_names[index] = encrypted_attributes[attribute]
+            end
+          end
+          method = "#{match.captures[0]}_#{match.captures[1]}_#{attribute_names.join('_and_')}".to_sym
+        end
+        method_missing_without_attr_encrypted(method, *args, &block)
+      end
+  end
+end

data/lib/huberry/class.rb

@@ -0,0 +1,141 @@
+module Huberry
+  module Class
+    protected
+      # Generates attr_accessors that encrypt and decrypt attributes transparently
+      #
+      # Options (any other options you specify are passed to the encryptor's encrypt and decrypt methods)
+      #
+      #   :attribute      => The name of the referenced encrypted attribute. For example 
+      #                      <tt>attr_accessor :email, :attribute => :ee</tt> would generate an 
+      #                      attribute named 'ee' to store the encrypted email. This is useful when defining
+      #                      one attribute to encrypt at a time or when the :prefix and :suffix options
+      #                      aren't enough. Defaults to nil.
+      #
+      #   :prefix         => A prefix used to generate the name of the referenced encrypted attributes.
+      #                      For example <tt>attr_accessor :email, :password, :prefix => 'crypted_'</tt> would 
+      #                      generate attributes named 'crypted_email' and 'crypted_password' to store the 
+      #                      encrypted email and password. Defaults to 'encrypted_'.
+      #
+      #   :suffix         => A suffix used to generate the name of the referenced encrypted attributes.
+      #                      For example <tt>attr_accessor :email, :password, :prefix => '', :suffix => '_encrypted'</tt>  
+      #                      would generate attributes named 'email_encrypted' and 'password_encrypted' to store the 
+      #                      encrypted email. Defaults to ''.
+      #
+      #   :key            => The encryption key. This option may not be required if you're using a custom encryptor. If you pass 
+      #                      a symbol representing an instance method then the :key option will be replaced with the result of the 
+      #                      method before being passed to the encryptor. Proc objects are evaluated as well. Any other key types 
+      #                      will be passed directly to the encryptor.
+      #
+      #   :encode         => If set to true, attributes will be base64 encoded as well as encrypted. This is useful if you're
+      #                      planning on storing the encrypted attributes in a database. Defaults to false unless you're using
+      #                      it with ActiveRecord.
+      #
+      #   :marshal        => If set to true, attributes will be marshaled as well as encrypted. This is useful if you're planning
+      #                      on encrypting something other than a string. Defaults to false unless you're using it with ActiveRecord.
+      #
+      #   :encryptor      => The object to use for encrypting. Defaults to Huberry::Encryptor.
+      #
+      #   :encrypt_method => The encrypt method name to call on the <tt>:encryptor</tt> object. Defaults to :encrypt.
+      #
+      #   :decrypt_method => The decrypt method name to call on the <tt>:encryptor</tt> object. Defaults to :decrypt.
+      #
+      #
+      # You can specify your own default options
+      #
+      #   class User
+      #     # now all attributes will be encoded and marshaled by default
+      #     attr_encrypted_options.merge!(:encode => true, :marshal => true, :some_other_option => true)
+      #     attr_encrypted :configuration
+      #   end
+      #
+      #
+      # Example
+      #
+      #   class User
+      #     attr_encrypted :email, :credit_card, :key => 'some secret key'
+      #     attr_encrypted :configuration, :key => 'some other secret key', :marshal => true
+      #   end
+      #
+      #   @user = User.new
+      #   @user.encrypted_email # returns nil
+      #   @user.email = 'test@example.com'
+      #   @user.encrypted_email # returns the encrypted version of 'test@example.com'
+      #
+      #   @user.configuration = { :time_zone => 'UTC' }
+      #   @user.encrypted_configuration # returns the encrypted version of configuration
+      #
+      #   See README for more examples
+      def attr_encrypted(*attrs)
+        options = { 
+          :prefix => 'encrypted_', 
+          :suffix => '', 
+          :encryptor => Huberry::Encryptor, 
+          :encrypt_method => :encrypt,
+          :decrypt_method => :decrypt,
+          :encode => false, 
+          :marshal => false 
+        }.merge(attr_encrypted_options).merge(attrs.last.is_a?(Hash) ? attrs.pop : {})
+        
+        attrs.each do |attribute|
+          encrypted_attribute_name = options[:attribute].nil? ? options[:prefix].to_s + attribute.to_s + options[:suffix].to_s : options[:attribute].to_s
+          
+          encrypted_attributes[attribute.to_s] = encrypted_attribute_name
+          
+          attr_accessor encrypted_attribute_name.to_sym unless self.new.respond_to?(encrypted_attribute_name)
+          
+          define_class_method "encrypt_#{attribute}" do |value|
+            if value.nil?
+              encrypted_value = nil
+            else
+              value = Marshal.dump(value) if options[:marshal]
+              encrypted_value = options[:encryptor].send options[:encrypt_method], options.merge(:value => value)
+              encrypted_value = [encrypted_value].pack('m*') if options[:encode]
+            end
+            encrypted_value
+          end
+          
+          define_class_method "decrypt_#{attribute}" do |encrypted_value|
+            if encrypted_value.nil?
+              decrypted_value = nil
+            else
+              encrypted_value = encrypted_value.unpack('m*').to_s if options[:encode]
+              decrypted_value = options[:encryptor].send(options[:decrypt_method], options.merge(:value => encrypted_value))
+              decrypted_value = Marshal.load(decrypted_value) if options[:marshal]
+            end
+            decrypted_value
+          end
+          
+          define_method "#{attribute}" do
+            value = instance_variable_get("@#{attribute}")
+            encrypted_value = read_attribute(encrypted_attribute_name)
+            original_key = options[:key]
+            options[:key] = self.class.send :evaluate_attr_encrypted_key, options[:key], self
+            value = write_attribute(attribute, self.class.send("decrypt_#{attribute}".to_sym, encrypted_value)) if value.nil? && !encrypted_value.nil?
+            options[:key] = original_key
+            value
+          end
+          
+          define_method "#{attribute}=" do |value|
+            original_key = options[:key]
+            options[:key] = self.class.send :evaluate_attr_encrypted_key, options[:key], self
+            write_attribute(encrypted_attribute_name, self.class.send("encrypt_#{attribute}".to_sym, value))
+            options[:key] = original_key
+            instance_variable_set("@#{attribute}", value)
+          end
+        end
+      end
+      
+      # Evaluates encryption keys specified as symbols (representing instance methods) or procs
+      # If the key is not a symbol or proc then the original key is returned
+      def evaluate_attr_encrypted_key(key, object)
+        case key
+        when Symbol
+          object.send(key)
+        when Proc
+          key.call(object)
+        else
+          key
+        end
+      end
+  end
+end

data/lib/huberry/object.rb

@@ -0,0 +1,49 @@
+module Huberry
+  module Object
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        eattr_accessor :attr_encrypted_options, :encrypted_attributes
+        attr_encrypted_options = {}
+        encrypted_attributes = {}
+      end
+    end
+    
+    # Wraps instance_variable_get
+    #
+    # ActiveRecord overwrites this (if you're using it)
+    def read_attribute(attribute)
+      instance_variable_get("@#{attribute}")
+    end
+    
+    # Wraps instance_variable_set
+    #
+    # ActiveRecord overwrites this (if you're using it)
+    def write_attribute(attribute, value)
+      instance_variable_set("@#{attribute}", value)
+    end
+    
+    module ClassMethods
+      # Checks if an attribute has been configured to be encrypted
+      #
+      # Example
+      #
+      #   class User
+      #     attr_accessor :name
+      #     attr_encrypted :email
+      #   end
+      #
+      #   User.attr_encrypted?(:name) # false
+      #   User.attr_encrypted?(:email) # true
+      def attr_encrypted?(attribute)
+        encrypted_attributes.keys.include?(attribute.to_s)
+      end
+      
+      # Copies existing encrypted attributes and options to the derived class
+      def inherited(base)
+        base.attr_encrypted_options = self.attr_encrypted_options.nil? ? {} : self.attr_encrypted_options.dup
+        base.encrypted_attributes = self.encrypted_attributes.nil? ? {} : self.encrypted_attributes.dup
+      end
+    end
+  end
+end

data/test/active_record_test.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+
+def create_people_table
+  silence_stream(STDOUT) do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :people do |t|
+        t.string   :encrypted_email
+        t.string   :password
+        t.string   :encrypted_credentials
+        t.string   :salt
+      end
+    end
+  end
+end
+
+# The table needs to exist before defining the class
+create_people_table
+
+class Person < ActiveRecord::Base
+  attr_encrypted :email, :key => 'a secret key'
+  attr_encrypted :credentials, :key => Proc.new { |user| Huberry::Encryptor.encrypt(:value => user.salt, :key => 'some private key') }
+  
+  def after_initialize
+    self.salt ||= Digest::SHA256.hexdigest((Time.now.to_i * rand(5)).to_s)
+    self.credentials ||= { :username => 'example', :password => 'test' }
+  end
+end
+
+class ActiveRecordTest < Test::Unit::TestCase
+  
+  def setup
+    ActiveRecord::Base.connection.tables.each { |table| ActiveRecord::Base.connection.drop_table(table) }
+    create_people_table
+  end
+  
+  def test_should_encrypt_email
+    @person = Person.create :email => 'test@example.com'
+    assert_not_nil @person.encrypted_email
+    assert_not_equal @person.email, @person.encrypted_email
+    assert_equal @person.email, Person.find(:first).email
+  end
+  
+  def test_should_marshal_and_encrypt_credentials
+    @person = Person.create
+    assert_not_nil @person.encrypted_credentials
+    assert_not_equal @person.credentials, @person.encrypted_credentials
+    assert_equal @person.credentials, Person.find(:first).credentials
+  end
+  
+  def test_should_find_by_email
+    @person = Person.create(:email => 'test@example.com')
+    assert_equal @person, Person.find_by_email('test@example.com')
+  end
+  
+  def test_should_find_by_email_and_password
+    Person.create(:email => 'test@example.com', :password => 'invalid')
+    @person = Person.create(:email => 'test@example.com', :password => 'test')
+    assert_equal @person, Person.find_by_email_and_password('test@example.com', 'test')
+  end
+  
+  def test_should_scope_by_email
+    @person = Person.create(:email => 'test@example.com')
+    assert_equal @person, Person.scoped_by_email('test@example.com').find(:first) rescue NoMethodError
+  end
+  
+  def test_should_scope_by_email_and_password
+    Person.create(:email => 'test@example.com', :password => 'invalid')
+    @person = Person.create(:email => 'test@example.com', :password => 'test')
+    assert_equal @person, Person.scoped_by_email_and_password('test@example.com', 'test').find(:first) rescue NoMethodError
+  end
+  
+end

data/test/attr_encrypted_test.rb

@@ -0,0 +1,167 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class SillyEncryptor
+  def self.silly_encrypt(options)
+    (options[:value] + options[:some_arg]).reverse
+  end
+  
+  def self.silly_decrypt(options)
+    options[:value].reverse.gsub(/#{options[:some_arg]}$/, '')
+  end
+end
+
+class User
+  self.attr_encrypted_options[:key] = Proc.new { |user| user.class.to_s } # default key
+  
+  attr_encrypted :email, :without_encoding, :key => 'secret key'
+  attr_encrypted :password, :prefix => 'crypted_', :suffix => '_test'
+  attr_encrypted :ssn, :key => :salt, :attribute => 'ssn_encrypted'
+  attr_encrypted :credit_card, :encryptor => SillyEncryptor, :encrypt_method => :silly_encrypt, :decrypt_method => :silly_decrypt, :some_arg => 'test'
+  attr_encrypted :with_encoding, :key => 'secret key', :encode => true
+  attr_encrypted :with_marshaling, :key => 'secret key', :marshal => true
+  attr_accessor :salt
+  
+  def initialize
+    self.salt = Time.now.to_i.to_s
+  end
+end
+
+class Admin < User
+  attr_encrypted :testing
+end
+
+class SomeOtherClass
+end
+
+class AttrEncryptedTest < Test::Unit::TestCase
+  
+  def test_should_store_email_in_encrypted_attributes
+    assert User.encrypted_attributes.include?('email')
+  end
+  
+  def test_should_not_store_salt_in_encrypted_attributes
+    assert !User.encrypted_attributes.include?('salt')
+  end
+  
+  def test_attr_encrypted_should_return_true_for_email
+    assert User.attr_encrypted?('email')
+  end
+  
+  def test_attr_encrypted_should_return_false_for_salt
+    assert !User.attr_encrypted?('salt')
+  end
+  
+  def test_should_generate_an_encrypted_attribute
+    assert User.new.respond_to?(:encrypted_email)
+  end
+  
+  def test_should_generate_an_encrypted_attribute_with_a_prefix_and_suffix
+    assert User.new.respond_to?(:crypted_password_test)
+  end
+  
+  def test_should_generate_an_encrypted_attribute_with_the_attribute_option
+    assert User.new.respond_to?(:ssn_encrypted)
+  end
+  
+  def test_should_not_encrypt_nil_value
+    assert_nil User.encrypt_email(nil)
+  end
+  
+  def test_should_encrypt_email
+    assert_not_nil User.encrypt_email('test@example.com')
+    assert_not_equal 'test@example.com', User.encrypt_email('test@example.com')
+  end
+  
+  def test_should_encrypt_email_when_modifying_the_attr_writer
+    @user = User.new
+    assert_nil @user.encrypted_email
+    @user.email = 'test@example.com'
+    assert_not_nil @user.encrypted_email
+    assert_equal User.encrypt_email('test@example.com'), @user.encrypted_email
+  end
+  
+  def test_should_not_decrypt_nil_value
+    assert_nil User.decrypt_email(nil)
+  end
+  
+  def test_should_decrypt_email
+    encrypted_email = User.encrypt_email('test@example.com')
+    assert_not_equal 'test@test.com', encrypted_email
+    assert_equal 'test@example.com', User.decrypt_email(encrypted_email)
+  end
+  
+  def test_should_decrypt_email_when_reading
+    @user = User.new
+    assert_nil @user.email
+    @user.encrypted_email = User.encrypt_email('test@example.com')
+    assert_equal 'test@example.com', @user.email
+  end
+  
+  def test_should_encrypt_with_encoding
+    assert_equal User.encrypt_with_encoding('test'), [User.encrypt_without_encoding('test')].pack('m*')
+  end
+  
+  def test_should_decrypt_with_encoding
+    encrypted = User.encrypt_with_encoding('test')
+    assert_equal 'test', User.decrypt_with_encoding(encrypted)
+    assert_equal User.decrypt_with_encoding(encrypted), User.decrypt_without_encoding(encrypted.unpack('m*').to_s)
+  end
+  
+  def test_should_encrypt_with_marshaling
+    @user = User.new
+    @user.with_marshaling = [1, 2, 3]
+    assert_not_nil @user.encrypted_with_marshaling
+    assert_equal User.encrypt_with_marshaling([1, 2, 3]), @user.encrypted_with_marshaling
+  end
+  
+  def test_should_decrypt_with_marshaling
+    encrypted = User.encrypt_with_marshaling([1, 2, 3])
+    @user = User.new
+    assert_nil @user.with_marshaling
+    @user.encrypted_with_marshaling = encrypted
+    assert_equal [1, 2, 3], @user.with_marshaling
+  end
+  
+  def test_should_use_custom_encryptor_and_crypt_method_names_and_arguments
+    assert_equal SillyEncryptor.silly_encrypt(:value => 'testing', :some_arg => 'test'), User.encrypt_credit_card('testing')
+  end
+  
+  def test_should_evaluate_a_key_passed_as_a_symbol
+    @user = User.new
+    assert_nil @user.ssn_encrypted
+    @user.ssn = 'testing'
+    assert_not_nil @user.ssn_encrypted
+    assert_equal Huberry::Encryptor.encrypt(:value => 'testing', :key => @user.salt), @user.ssn_encrypted
+  end
+  
+  def test_should_evaluate_a_key_passed_as_a_proc
+    @user = User.new
+    assert_nil @user.crypted_password_test
+    @user.password = 'testing'
+    assert_not_nil @user.crypted_password_test
+    assert_equal Huberry::Encryptor.encrypt(:value => 'testing', :key => 'User'), @user.crypted_password_test
+  end
+  
+  def test_should_use_options_found_in_the_attr_encrypted_options_attribute
+    @user = User.new
+    assert_nil @user.crypted_password_test
+    @user.password = 'testing'
+    assert_not_nil @user.crypted_password_test
+    assert_equal Huberry::Encryptor.encrypt(:value => 'testing', :key => 'User'), @user.crypted_password_test
+  end
+  
+  def test_should_inherit_encrypted_attributes
+    assert_equal User.encrypted_attributes.merge('testing' => 'encrypted_testing'), Admin.encrypted_attributes
+  end
+  
+  def test_should_inherit_attr_encrypted_options
+    assert !User.attr_encrypted_options.empty?
+    assert_equal User.attr_encrypted_options, Admin.attr_encrypted_options
+  end
+  
+  def test_should_not_inherit_unrelated_attributes
+    assert SomeOtherClass.attr_encrypted_options.empty?
+    assert SomeOtherClass.encrypted_attributes.empty?
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'test/unit'
+require 'digest/sha2'
+
+require 'rubygems'
+gem 'shuber-eigenclass', '>= 1.0.1'
+gem 'shuber-encryptor'
+gem 'activerecord'
+
+require 'eigenclass'
+require 'encryptor'
+require 'active_record'
+
+require File.dirname(__FILE__) + '/../lib/attr_encrypted'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: shuber-attr_encrypted
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Sean Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shuber-eigenclass
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shuber-encryptor
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+description: Generates attr_accessors that encrypt and decrypt attributes transparently
+email: shuber@huberry.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- lib/attr_encrypted.rb
+- lib/huberry/active_record.rb
+- lib/huberry/class.rb
+- lib/huberry/object.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/shuber/attr_encrypted
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Generates attr_accessors that encrypt and decrypt attributes transparently
+test_files: 
+- test/active_record_test.rb
+- test/attr_encrypted_test.rb