attr_encrypted-magicless 1.3.42

data/test/attr_encrypted_test.rb

@@ -0,0 +1,339 @@
+# encoding: UTF-8
+require File.expand_path('../test_helper', __FILE__)
+
+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
+  include AttrEncrypted
+
+  self.attr_encrypted_options[:key] = Proc.new { |user| SECRET_KEY } # default key
+  self.attr_encrypted_options[:mode] = :per_attribute_iv_and_salt
+
+  attr_encrypted :email, :without_encoding, :key => SECRET_KEY
+  attr_encrypted :password, :prefix => 'crypted_', :suffix => '_test'
+  attr_encrypted :ssn, :key => :secret_key, :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_custom_encoding, :key => SECRET_KEY, :encode => 'm'
+  attr_encrypted :with_marshaling, :key => SECRET_KEY, :marshal => true
+  attr_encrypted :with_true_if, :key => SECRET_KEY, :if => true
+  attr_encrypted :with_false_if, :key => SECRET_KEY, :if => false
+  attr_encrypted :with_true_unless, :key => SECRET_KEY, :unless => true
+  attr_encrypted :with_false_unless, :key => SECRET_KEY, :unless => false
+  attr_encrypted :with_if_changed, :key => SECRET_KEY, :if => :should_encrypt
+
+  attr_encryptor :aliased, :key => SECRET_KEY
+
+  attr_accessor :salt
+  attr_accessor :should_encrypt
+
+  def initialize
+    self.salt = Time.now.to_i.to_s
+    self.should_encrypt = true
+  end
+
+  def secret_key
+    SECRET_KEY
+  end
+end
+
+class Admin < User
+  attr_encrypted :testing
+end
+
+class SomeOtherClass
+  include AttrEncrypted
+
+  def self.call(object)
+    object.class
+  end
+end
+
+class CryptedObject
+  include AttrEncrypted
+end
+
+class AttrEncryptedTest < Minitest::Test
+
+  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_not_use_the_same_attribute_name_for_two_attributes_in_the_same_line
+    refute_equal User.encrypted_attributes[:email][:attribute], User.encrypted_attributes[:without_encoding][:attribute]
+  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_not_encrypt_empty_string
+    assert_equal '', User.encrypt_email('')
+  end
+
+  def test_should_encrypt_email
+    refute_nil User.encrypt_email('test@example.com')
+    refute_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'
+    refute_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_not_decrypt_empty_string
+    assert_equal '', User.decrypt_email('')
+  end
+
+  def test_should_decrypt_email
+    encrypted_email = User.encrypt_email('test@example.com')
+    refute_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').first)
+  end
+
+  def test_should_encrypt_with_custom_encoding
+    assert_equal User.encrypt_with_encoding('test'), [User.encrypt_without_encoding('test')].pack('m')
+  end
+
+  def test_should_decrypt_with_custom_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').first)
+  end
+
+  def test_should_encrypt_with_marshaling
+    @user = User.new
+    @user.with_marshaling = [1, 2, 3]
+    refute_nil @user.encrypted_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'
+    refute_nil @user.ssn_encrypted
+    encrypted =  Encryptor.encrypt(:value => 'testing', :key => SECRET_KEY, :iv => @user.ssn_encrypted_iv.unpack("m").first, :salt => @user.ssn_encrypted_salt )
+    assert_equal encrypted, @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'
+    refute_nil @user.crypted_password_test
+    encrypted = Encryptor.encrypt(:value => 'testing', :key => SECRET_KEY, :iv => @user.crypted_password_test_iv.unpack("m").first, :salt =>  @user.crypted_password_test_salt)
+    assert_equal encrypted, @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'
+    refute_nil @user.crypted_password_test
+    encrypted = Encryptor.encrypt(:value => 'testing', :key => SECRET_KEY, :iv => @user.crypted_password_test_iv.unpack("m").first, :salt => @user.crypted_password_test_salt)
+    assert_equal encrypted, @user.crypted_password_test
+  end
+
+  def test_should_inherit_encrypted_attributes
+    assert_equal [User.encrypted_attributes.keys, :testing].flatten.collect { |key| key.to_s }.sort, Admin.encrypted_attributes.keys.collect { |key| key.to_s }.sort
+  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
+
+  def test_should_evaluate_a_symbol_option
+    assert_equal CryptedObject, CryptedObject.new.send(:evaluate_attr_encrypted_option, :class)
+  end
+
+  def test_should_evaluate_a_proc_option
+    assert_equal CryptedObject, CryptedObject.new.send(:evaluate_attr_encrypted_option, proc { |object| object.class })
+  end
+
+  def test_should_evaluate_a_lambda_option
+    assert_equal CryptedObject, CryptedObject.new.send(:evaluate_attr_encrypted_option, lambda { |object| object.class })
+  end
+
+  def test_should_evaluate_a_method_option
+    assert_equal CryptedObject, CryptedObject.new.send(:evaluate_attr_encrypted_option, SomeOtherClass.method(:call))
+  end
+
+  def test_should_return_a_string_option
+    assert_equal 'CryptedObject', CryptedObject.new.send(:evaluate_attr_encrypted_option, 'CryptedObject')
+  end
+
+  def test_should_encrypt_with_true_if
+    @user = User.new
+    assert_nil @user.encrypted_with_true_if
+    @user.with_true_if = 'testing'
+    refute_nil @user.encrypted_with_true_if
+    encrypted = Encryptor.encrypt(:value => 'testing', :key => SECRET_KEY, :iv => @user.encrypted_with_true_if_iv.unpack("m").first, :salt => @user.encrypted_with_true_if_salt)
+    assert_equal encrypted, @user.encrypted_with_true_if
+  end
+
+  def test_should_not_encrypt_with_false_if
+    @user = User.new
+    assert_nil @user.encrypted_with_false_if
+    @user.with_false_if = 'testing'
+    refute_nil @user.encrypted_with_false_if
+    assert_equal 'testing', @user.encrypted_with_false_if
+  end
+
+  def test_should_encrypt_with_false_unless
+    @user = User.new
+    assert_nil @user.encrypted_with_false_unless
+    @user.with_false_unless = 'testing'
+    refute_nil @user.encrypted_with_false_unless
+    encrypted = Encryptor.encrypt(:value => 'testing', :key => SECRET_KEY, :iv => @user.encrypted_with_false_unless_iv.unpack("m").first, :salt => @user.encrypted_with_false_unless_salt)
+    assert_equal encrypted,  @user.encrypted_with_false_unless
+  end
+
+  def test_should_not_encrypt_with_true_unless
+    @user = User.new
+    assert_nil @user.encrypted_with_true_unless
+    @user.with_true_unless = 'testing'
+    refute_nil @user.encrypted_with_true_unless
+    assert_equal 'testing', @user.encrypted_with_true_unless
+  end
+
+  def test_should_work_with_aliased_attr_encryptor
+    assert User.encrypted_attributes.include?(:aliased)
+  end
+
+  def test_should_always_reset_options
+    @user = User.new
+    @user.with_if_changed = "encrypt_stuff"
+    @user.stubs(:instance_variable_get).returns(nil)
+    @user.stubs(:instance_variable_set).raises("BadStuff")
+    assert_raises RuntimeError do
+      @user.with_if_changed
+    end
+
+    @user = User.new
+    @user.should_encrypt = false
+    @user.with_if_changed = "not_encrypted_stuff"
+    assert_equal "not_encrypted_stuff", @user.with_if_changed
+    assert_equal "not_encrypted_stuff", @user.encrypted_with_if_changed
+  end
+
+  def test_should_cast_values_as_strings_before_encrypting
+    string_encrypted_email = User.encrypt_email('3')
+    assert_equal string_encrypted_email, User.encrypt_email(3)
+    assert_equal '3', User.decrypt_email(string_encrypted_email)
+  end
+
+  def test_should_create_query_accessor
+    @user = User.new
+    assert !@user.email?
+    @user.email = ''
+    assert !@user.email?
+    @user.email = 'test@example.com'
+    assert @user.email?
+  end
+
+  def test_should_vary_iv_per_attribute
+    @user = User.new
+    @user.email = 'email@example.com'
+    @user.password = 'p455w0rd'
+    refute_equal @user.encrypted_email_iv, @user.crypted_password_test_iv
+  end
+
+  def test_should_vary_iv_per_instance
+    @user1 = User.new
+    @user1.email = 'email@example.com'
+    @user2 = User.new
+    @user2.email = 'email@example.com'
+    refute_equal @user1.encrypted_email_iv, @user2.encrypted_email_iv
+  end
+
+  def test_should_vary_salt_per_attribute
+    @user = User.new
+    @user.email = 'email@example.com'
+    @user.password = 'p455w0rd'
+    refute_equal @user.encrypted_email_salt, @user.crypted_password_test_salt
+  end
+
+  def test_should_vary_salt_per_instance
+    @user1 = User.new
+    @user1.email = 'email@example.com'
+    @user2 = User.new
+    @user2.email = 'email@example.com'
+    refute_equal @user1.encrypted_email_salt, @user2.encrypted_email_salt
+  end
+
+  def test_should_decrypt_second_record
+    @user1 = User.new
+    @user1.email = 'test@example.com'
+
+    @user2 = User.new
+    @user2.email = 'test@example.com'
+
+    assert_equal 'test@example.com', @user1.decrypt(:email, @user1.encrypted_email)
+  end
+end

data/test/compatibility_test.rb

@@ -0,0 +1,106 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../test_helper', __FILE__)
+
+# Test to ensure that existing representations in database do not break on
+# migrating to new versions of this gem. This ensures that future versions of
+# this gem will retain backwards compatibility with data generated by earlier
+# versions.
+class CompatibilityTest < Minitest::Test
+  class NonmarshallingPet < ActiveRecord::Base
+    PET_NICKNAME_SALT = Digest::SHA256.hexdigest('my-really-really-secret-pet-nickname-salt')
+    PET_NICKNAME_KEY = 'my-really-really-secret-pet-nickname-key'
+    PET_BIRTHDATE_SALT = Digest::SHA256.hexdigest('my-really-really-secret-pet-birthdate-salt')
+    PET_BIRTHDATE_KEY = 'my-really-really-secret-pet-birthdate-key'
+
+    self.attr_encrypted_options[:mode] = :per_attribute_iv_and_salt
+
+    attr_encrypted :nickname,
+      :key => proc { Encryptor.encrypt(:value => PET_NICKNAME_SALT, :key => PET_NICKNAME_KEY) }
+    attr_encrypted :birthdate,
+      :key => proc { Encryptor.encrypt(:value => PET_BIRTHDATE_SALT, :key => PET_BIRTHDATE_KEY) }
+  end
+
+  class MarshallingPet < ActiveRecord::Base
+    PET_NICKNAME_SALT = Digest::SHA256.hexdigest('my-really-really-secret-pet-nickname-salt')
+    PET_NICKNAME_KEY = 'my-really-really-secret-pet-nickname-key'
+    PET_BIRTHDATE_SALT = Digest::SHA256.hexdigest('my-really-really-secret-pet-birthdate-salt')
+    PET_BIRTHDATE_KEY = 'my-really-really-secret-pet-birthdate-key'
+
+    self.attr_encrypted_options[:mode] = :per_attribute_iv_and_salt
+
+    attr_encrypted :nickname,
+      :key => proc { Encryptor.encrypt(:value => PET_NICKNAME_SALT, :key => PET_NICKNAME_KEY) },
+      :marshal => true
+    attr_encrypted :birthdate,
+      :key => proc { Encryptor.encrypt(:value => PET_BIRTHDATE_SALT, :key => PET_BIRTHDATE_KEY) },
+      :marshal => true
+  end
+
+  def setup
+    ActiveRecord::Base.connection.tables.each { |table| ActiveRecord::Base.connection.drop_table(table) }
+    create_tables
+  end
+
+  def test_nonmarshalling_backwards_compatibility
+    pet = NonmarshallingPet.create!(
+      :name => 'Fido',
+      :encrypted_nickname => 'E4lJTxFG/EfkfPg5MpnriQ==',
+      :encrypted_nickname_iv => 'z4Q8deE4h7f6S8NNZcbPNg==',
+      :encrypted_nickname_salt => 'adcd833001a873db',
+      :encrypted_birthdate => '6uKEAiFVdJw+N5El+U6Gow==',
+      :encrypted_birthdate_iv => 'zxtc1XPssL4s2HwA69nORQ==',
+      :encrypted_birthdate_salt => '4f879270045eaad7'
+    )
+
+    assert_equal 'Fido', pet.name
+    assert_equal 'Fido the Dog', pet.nickname
+    assert_equal '2011-07-09', pet.birthdate
+  end
+
+  def test_marshalling_backwards_compatibility
+    pet = MarshallingPet.create!(
+      :name => 'Fido',
+      :encrypted_nickname => 'EsQScJYkPw80vVGvKWkE37Px99HHpXPFjoEPTNa4rbs=',
+      :encrypted_nickname_iv => 'fNq1OZcGvty4KfcvGTcFSw==',
+      :encrypted_nickname_salt => '733b459b7d34c217',
+      :encrypted_birthdate => '+VUlKQGfNWkOgCwI4hv+3qlGIwh9h6cJ/ranJlaxvU+xxQdL3H3cOzTcI2rkYkdR',
+      :encrypted_birthdate_iv => 'Ka+zF/SwEYZKwVa24lvFfA==',
+      :encrypted_birthdate_salt => 'd5e892d5bbd81566'
+    )
+
+    assert_equal 'Fido', pet.name
+    assert_equal 'Mummy\'s little helper', pet.nickname
+
+    assert_equal Date.new(2011, 7, 9), pet.birthdate
+  end
+
+  private
+
+  def create_tables
+    silence_stream(STDOUT) do
+      ActiveRecord::Schema.define(:version => 1) do
+        create_table :nonmarshalling_pets do |t|
+          t.string :name
+          t.string :encrypted_nickname
+          t.string :encrypted_nickname_iv
+          t.string :encrypted_nickname_salt
+          t.string :encrypted_birthdate
+          t.string :encrypted_birthdate_iv
+          t.string :encrypted_birthdate_salt
+        end
+        create_table :marshalling_pets do |t|
+          t.string :name
+          t.string :encrypted_nickname
+          t.string :encrypted_nickname_iv
+          t.string :encrypted_nickname_salt
+          t.string :encrypted_birthdate
+          t.string :encrypted_birthdate_iv
+          t.string :encrypted_birthdate_salt
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+

data/test/legacy_active_record_test.rb

@@ -0,0 +1,94 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../test_helper', __FILE__)
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+
+def create_people_table
+  silence_stream(STDOUT) do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :legacy_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
+
+ActiveRecord::MissingAttributeError = ActiveModel::MissingAttributeError unless defined?(ActiveRecord::MissingAttributeError)
+
+class LegacyPerson < ActiveRecord::Base
+  attr_encrypted :email, :key => 'a secret key'
+  attr_encrypted :credentials, :key => Proc.new { |user| Encryptor.encrypt(:value => user.salt, :key => 'some private key') }, :marshal => true
+
+  ActiveSupport::Deprecation.silenced = true
+  def after_initialize; end
+  ActiveSupport::Deprecation.silenced = false
+
+  after_initialize :initialize_salt_and_credentials
+
+  protected
+
+    def initialize_salt_and_credentials
+      self.salt ||= Digest::SHA256.hexdigest((Time.now.to_i * rand(5)).to_s)
+      self.credentials ||= { :username => 'example', :password => 'test' }
+    rescue ActiveRecord::MissingAttributeError
+    end
+end
+
+class LegacyPersonWithValidation < LegacyPerson
+  validates_presence_of :email
+  validates_uniqueness_of :encrypted_email
+end
+
+class LegacyActiveRecordTest < Minitest::Test
+
+  def setup
+    ActiveRecord::Base.connection.tables.each { |table| ActiveRecord::Base.connection.drop_table(table) }
+    create_people_table
+  end
+
+  def test_should_decrypt_with_correct_encoding
+    if defined?(Encoding)
+      @person = LegacyPerson.create :email => 'test@example.com'
+      assert_equal 'UTF-8', LegacyPerson.first.email.encoding.name
+    end
+  end
+
+  def test_should_encrypt_email
+    @person = LegacyPerson.create :email => 'test@example.com'
+    refute_nil @person.encrypted_email
+    refute_equal @person.email, @person.encrypted_email
+    assert_equal @person.email, LegacyPerson.first.email
+  end
+
+  def test_should_marshal_and_encrypt_credentials
+    @person = LegacyPerson.create
+    refute_nil @person.encrypted_credentials
+    refute_equal @person.credentials, @person.encrypted_credentials
+    assert_equal @person.credentials, LegacyPerson.first.credentials
+  end
+
+  def test_should_encode_by_default
+    assert LegacyPerson.attr_encrypted_options[:encode]
+  end
+
+  def test_should_validate_presence_of_email
+    @person = LegacyPersonWithValidation.new
+    assert !@person.valid?
+    assert !@person.errors[:email].empty? || @person.errors.on(:email)
+  end
+
+  def test_should_validate_uniqueness_of_email
+    @person = LegacyPersonWithValidation.new :email => 'test@example.com'
+    assert @person.save
+    @person2 = LegacyPersonWithValidation.new :email => @person.email
+    assert !@person2.valid?
+    assert !@person2.errors[:encrypted_email].empty? || @person2.errors.on(:encrypted_email)
+  end
+
+end