encrypted_strings 0.1.1 → 0.2.0

data/test/string_test.rb

@@ -6,7 +6,7 @@ class StringByDefaultTest < Test::Unit::TestCase
   end
   
   def test_should_use_sha
-    assert_instance_of PluginAWeek::EncryptedStrings::ShaEncryptor, @encrypted_string.encryptor
+    assert_instance_of PluginAWeek::EncryptedStrings::ShaCipher, @encrypted_string.cipher
   end
 end
 
@@ -16,21 +16,21 @@ class StringWithCustomOptionsTest < Test::Unit::TestCase
   end
   
   def test_should_use_sha
-    assert_instance_of PluginAWeek::EncryptedStrings::ShaEncryptor, @encrypted_string.encryptor
+    assert_instance_of PluginAWeek::EncryptedStrings::ShaCipher, @encrypted_string.cipher
   end
   
   def test_should_use_custom_options
-    assert_equal 'different_salt', @encrypted_string.encryptor.salt
+    assert_equal 'different_salt', @encrypted_string.cipher.salt
   end
 end
 
-class StringWithCustomEncryptor
+class StringWithCustomCipher
   def setup
     @encrypted_string = 'test'.encrypt(:symmetric, :password => 'key')
   end
   
-  def test_should_use_custom_encryptor
-    assert_instance_of PluginAWeek::EncryptedStrings::SymmetricEncryptor, @encrypted_string.encryptor
+  def test_should_use_custom_cipher
+    assert_instance_of PluginAWeek::EncryptedStrings::SymmetricCipher, @encrypted_string.cipher
   end
 end
 
@@ -43,8 +43,8 @@ class StringTest < Test::Unit::TestCase
     assert !@string.encrypted?
   end
   
-  def test_should_not_have_an_encryptor
-    assert_nil @string.encryptor
+  def test_should_not_have_a_cipher
+    assert_nil @string.cipher
   end
   
   def test_should_not_be_able_to_decrypt
@@ -72,8 +72,8 @@ class StringAfterBeingEncryptedAndReplacedTest < Test::Unit::TestCase
     assert !'test'.equals_without_encryption(@encrypted_string)
   end
   
-  def test_should_have_an_encryptor
-    assert_instance_of PluginAWeek::EncryptedStrings::ShaEncryptor, @encrypted_string.encryptor
+  def test_should_have_a_cipher
+    assert_instance_of PluginAWeek::EncryptedStrings::ShaCipher, @encrypted_string.cipher
   end
   
   def test_should_be_encrypted
@@ -91,8 +91,8 @@ class StringAfterBeingDecryptedTest < Test::Unit::TestCase
     assert !@decrypted_string.encrypted?
   end
   
-  def test_should_not_have_an_encryptor
-    assert_nil @decrypted_string.encryptor
+  def test_should_not_have_a_cipher
+    assert_nil @decrypted_string.cipher
   end
 end
 
@@ -103,15 +103,15 @@ class StringAfterBeingDecryptedAndReplacedTest < Test::Unit::TestCase
   end
   
   def test_should_not_be_the_original_value
-    assert !"MU6e/5LvhKA=\n".equals_without_encryption(@encrypted_string)
+    assert !"oTxJd67ElLY=\n".equals_without_encryption(@encrypted_string)
   end
   
   def test_should_be_the_decrypted_value
     assert 'test'.equals_without_encryption(@encrypted_string)
   end
   
-  def test_should_not_have_an_encryptor
-    assert_nil @encrypted_string.encryptor
+  def test_should_not_have_a_cipher
+    assert_nil @encrypted_string.cipher
   end
   
   def test_should_not_be_encrypted
@@ -119,7 +119,7 @@ class StringAfterBeingDecryptedAndReplacedTest < Test::Unit::TestCase
   end
 end
 
-class StringWithUndecryptableEncryptorTest < Test::Unit::TestCase
+class StringWithUndecryptableCipherTest < Test::Unit::TestCase
   def setup
     @encrypted_string = 'test'.encrypt(:sha)
   end
@@ -148,7 +148,7 @@ class StringWithUndecryptableEncryptorTest < Test::Unit::TestCase
     assert_equal encrypted_encrypted_string, @encrypted_string
   end
   
-  def test_should_be_able_to_check_equality_with_same_string_without_encryptor
+  def test_should_be_able_to_check_equality_with_same_string_without_cipher
     assert_equal @encrypted_string.to_s, @encrypted_string
     assert_equal @encrypted_string, @encrypted_string.to_s
   end
@@ -161,7 +161,7 @@ class StringWithUndecryptableEncryptorTest < Test::Unit::TestCase
   end
 end
 
-class StringWithDecryptableEncryptorTest < Test::Unit::TestCase
+class StringWithDecryptableCipherTest < Test::Unit::TestCase
   def setup
     @encrypted_string = 'test'.encrypt(:symmetric, :password => 'secret')
   end
@@ -186,7 +186,7 @@ class StringWithDecryptableEncryptorTest < Test::Unit::TestCase
     assert_equal encrypted_encrypted_string, @encrypted_string
   end
   
-  def test_should_be_able_to_check_equality_with_same_string_without_encryptor
+  def test_should_be_able_to_check_equality_with_same_string_without_cipher
     assert_equal @encrypted_string.to_s, @encrypted_string
     assert_equal @encrypted_string, @encrypted_string.to_s
   end
@@ -201,15 +201,15 @@ end
 
 class StringPreviouslyEncryptedTest < Test::Unit::TestCase
   def setup
-    @encrypted_string = "MU6e/5LvhKA=\n"
+    @encrypted_string = "oTxJd67ElLY=\n"
   end
   
   def test_should_not_be_encrypted
     assert !@encrypted_string.encrypted?
   end
   
-  def test_should_not_have_an_encryptor
-    assert_nil @encrypted_string.encryptor
+  def test_should_not_have_a_cipher
+    assert_nil @encrypted_string.cipher
   end
   
   def test_should_not_be_able_to_decrypt

data/test/symmetric_cipher_test.rb

@@ -0,0 +1,99 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class NoPasswordErrorTest < Test::Unit::TestCase
+  def test_should_exist
+    assert_not_nil PluginAWeek::EncryptedStrings::NoPasswordError
+  end
+end
+
+class SymmetricCipherByDefaultTest < Test::Unit::TestCase
+  def setup
+    @symmetric_cipher = PluginAWeek::EncryptedStrings::SymmetricCipher.new(:password => 'secret')
+  end
+  
+  def test_should_use_default_algorithm
+    assert_equal 'DES-EDE3-CBC', @symmetric_cipher.algorithm
+  end
+  
+  def test_should_raise_exception
+    assert_raise(PluginAWeek::EncryptedStrings::NoPasswordError) {PluginAWeek::EncryptedStrings::SymmetricCipher.new}
+  end
+  
+  def test_should_encrypt_using_default_configuration
+    assert_equal "oTxJd67ElLY=\n", @symmetric_cipher.encrypt('test')
+  end
+  
+  def test_should_decrypt_encrypted_string_using_default_configuration
+    assert_equal 'test', @symmetric_cipher.decrypt("oTxJd67ElLY=\n")
+  end
+end
+
+class SymmetricCipherWithCustomDefaultsTest < Test::Unit::TestCase
+  def setup
+    @original_default_algorithm = PluginAWeek::EncryptedStrings::SymmetricCipher.default_algorithm
+    @original_default_password = PluginAWeek::EncryptedStrings::SymmetricCipher.default_password
+    
+    PluginAWeek::EncryptedStrings::SymmetricCipher.default_algorithm = 'DES-EDE3-CFB'
+    PluginAWeek::EncryptedStrings::SymmetricCipher.default_password = 'secret'
+    @symmetric_cipher = PluginAWeek::EncryptedStrings::SymmetricCipher.new
+  end
+  
+  def test_should_use_custom_default_algorithm
+    assert_equal 'DES-EDE3-CFB', @symmetric_cipher.algorithm
+  end
+  
+  def test_should_use_custom_default_password
+    assert_equal 'secret', @symmetric_cipher.password
+  end
+  
+  def test_should_encrypt_using_custom_default_configuration
+    assert_equal "QWz/eQ==\n", @symmetric_cipher.encrypt('test')
+  end
+  
+  def test_should_decrypt_encrypted_string_using_custom_default_configuration
+    assert_equal 'test', @symmetric_cipher.decrypt("QWz/eQ==\n")
+  end
+  
+  def teardown
+    PluginAWeek::EncryptedStrings::SymmetricCipher.default_algorithm = @original_default_algorithm
+    PluginAWeek::EncryptedStrings::SymmetricCipher.default_password = @original_default_password
+  end
+end
+
+class SymmetricCipherWithInvalidOptionsTest < Test::Unit::TestCase
+  def test_should_throw_an_exception
+    assert_raise(ArgumentError) {PluginAWeek::EncryptedStrings::SymmetricCipher.new(:invalid => true)}
+  end
+end
+
+class SymmetricCipherTest < Test::Unit::TestCase
+  def setup
+    @symmetric_cipher = PluginAWeek::EncryptedStrings::SymmetricCipher.new(:password => 'secret')
+  end
+  
+  def test_should_be_able_to_decrypt
+    assert @symmetric_cipher.can_decrypt?
+  end
+end
+
+class SymmetricCipherWithCustomOptionsTest < Test::Unit::TestCase
+  def setup
+    @symmetric_cipher = PluginAWeek::EncryptedStrings::SymmetricCipher.new(:algorithm => 'DES-EDE3-CFB', :password => 'secret')
+  end
+  
+  def test_should_use_custom_algorithm
+    assert_equal 'DES-EDE3-CFB', @symmetric_cipher.algorithm
+  end
+  
+  def test_should_use_custom_password
+    assert_equal 'secret', @symmetric_cipher.password
+  end
+  
+  def test_should_encrypt_using_custom_options
+    assert_equal "QWz/eQ==\n", @symmetric_cipher.encrypt('test')
+  end
+  
+  def test_should_decrypt_using_custom_options
+    assert_equal 'test', @symmetric_cipher.decrypt("QWz/eQ==\n")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: encrypted_strings
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -23,30 +23,23 @@ extra_rdoc_files: []
 
 files: 
 - lib/encrypted_strings
-- lib/encrypted_strings/no_private_key_error.rb
-- lib/encrypted_strings/asymmetric_encryptor.rb
-- lib/encrypted_strings/sha_encryptor.rb
+- lib/encrypted_strings/cipher.rb
+- lib/encrypted_strings/sha_cipher.rb
 - lib/encrypted_strings/extensions
 - lib/encrypted_strings/extensions/string.rb
-- lib/encrypted_strings/encryptor.rb
-- lib/encrypted_strings/no_key_error.rb
-- lib/encrypted_strings/no_public_key_error.rb
-- lib/encrypted_strings/symmetric_encryptor.rb
+- lib/encrypted_strings/symmetric_cipher.rb
+- lib/encrypted_strings/asymmetric_cipher.rb
 - lib/encrypted_strings.rb
-- test/asymmetric_encryptor_test.rb
-- test/symmetric_encryptor_test.rb
 - test/test_helper.rb
-- test/no_key_error_test.rb
-- test/sha_encryptor_test.rb
-- test/no_private_key_error_test.rb
+- test/symmetric_cipher_test.rb
+- test/asymmetric_cipher_test.rb
+- test/sha_cipher_test.rb
 - test/keys
 - test/keys/encrypted_private
 - test/keys/private
 - test/keys/public
-- test/keys/pkcs5_encrypted_private
 - test/string_test.rb
-- test/no_public_key_error_test.rb
-- test/encryptor_test.rb
+- test/cipher_test.rb
 - CHANGELOG.rdoc
 - init.rb
 - LICENSE
@@ -79,11 +72,8 @@ signing_key:
 specification_version: 2
 summary: Dead-simple string encryption/decryption syntax.
 test_files: 
-- test/asymmetric_encryptor_test.rb
-- test/symmetric_encryptor_test.rb
-- test/no_key_error_test.rb
-- test/sha_encryptor_test.rb
-- test/no_private_key_error_test.rb
+- test/symmetric_cipher_test.rb
+- test/asymmetric_cipher_test.rb
+- test/sha_cipher_test.rb
 - test/string_test.rb
-- test/no_public_key_error_test.rb
-- test/encryptor_test.rb
+- test/cipher_test.rb

data/lib/encrypted_strings/no_key_error.rb

@@ -1,7 +0,0 @@
-module PluginAWeek #:nodoc:
-  module EncryptedStrings
-    # Indicates no key was specified
-    class NoKeyError < StandardError
-    end
-  end
-end

data/lib/encrypted_strings/no_private_key_error.rb

@@ -1,7 +0,0 @@
-module PluginAWeek #:nodoc:
-  module EncryptedStrings
-    # Indicates no private key was found
-    class NoPrivateKeyError < StandardError
-    end
-  end
-end

data/lib/encrypted_strings/no_public_key_error.rb

@@ -1,7 +0,0 @@
-module PluginAWeek #:nodoc:
-  module EncryptedStrings
-    # Indicates no public key was found
-    class NoPublicKeyError < StandardError
-    end
-  end
-end

data/lib/encrypted_strings/symmetric_encryptor.rb

@@ -1,134 +0,0 @@
-require 'encrypted_strings/no_key_error'
-
-module PluginAWeek #:nodoc:
-  module EncryptedStrings
-    # Symmetric encryption uses a password and a specific algorithm to encrypt
-    # the string.  As long as the password and algorithm are known, the string
-    # can be decrypted.
-    # 
-    # Source: http://support.microsoft.com/kb/246071
-    # 
-    # == Encrypting 
-    # 
-    # To encrypt a string using a symmetric algorithm, the type of algorithm and
-    # password *must* be specified.  You can define the defaults for these
-    # values like so:
-    # 
-    #   PluginAWeek::EncryptedStrings::SymmetricEncryptor.default_algorithm = 'des-ecb'
-    #   PluginAWeek::EncryptedStrings::SymmetricEncryptor.default_password = 'secret'
-    # 
-    # If these configuration options are not passed in to #encrypt, then the
-    # default values will be used.  You can override the default values like so:
-    # 
-    #   password = 'shhhh'
-    #   password.encrypt(:symmetric, :algorithm => 'des-ecb', :password => 'secret')  # => "sUG6tYSn0mI=\n"
-    # 
-    # An exception will be raised if no password is specified.
-    # 
-    # == Decrypting
-    # 
-    # To decrypt a string using an symmetric algorithm, the type of algorithm
-    # and password must also be specified.  Defaults for these values can be
-    # defined as show above.
-    # 
-    # If these configuration options are not passed in to #decrypt, then the
-    # default values will be used.  You can override the default values like so:
-    # 
-    #   password = "sUG6tYSn0mI=\n"
-    #   password.decrypt(:symmetric, :algorithm => 'des-ecb', :password => 'secret') # => "shhhh"
-    # 
-    # An exception will be raised if no password is specified.
-    class SymmetricEncryptor < Encryptor
-      class << self
-        # The default algorithm to use for encryption.  Default is DES-EDE3-CBC.
-        attr_accessor :default_algorithm
-        
-        # The default password to use for generating the key and initialization
-        # vector.  Default is nil.
-        attr_accessor :default_password
-        
-        # DEPRECATED
-        def default_key #:nodoc:
-          warn("#{self}.default_key is deprecated and will be removed from encrypted_attributes 0.2.0 (use default_password)")
-          @default_password
-        end
-        
-        # DEPRECATED
-        def default_key=(value) #:nodoc:
-          warn("#{self}.default_key= is deprecated and will be removed from encrypted_attributes 0.2.0 (use default_password=)")
-          @default_password = value
-        end
-      end
-      
-      # Set default values
-      @default_algorithm = 'DES-EDE3-CBC'
-      @default_password = nil
-      
-      # The algorithm to use for encryption/decryption
-      attr_accessor :algorithm
-      
-      # The password that generates the key/initialization vector for the
-      # algorithm
-      attr_accessor :password
-      
-      # Configuration options:
-      # * +algorithm+ - The algorithm to use
-      # * +password+ - The secret key to use for generating the key/initialization vector for the algorithm
-      # * +key+ - DEPRECATED. The secret key to use for generating the key/initialization vector for the algorithm
-      # * +pkcs5_compliant+ - Whether the generated key/iv should comply to the PKCS #5 standard. Default is false.
-      def initialize(options = {})
-        invalid_options = options.keys - [:algorithm, :password, :key, :pkcs5_compliant]
-        raise ArgumentError, "Unknown key(s): #{invalid_options.join(", ")}" unless invalid_options.empty?
-        
-        options = {
-          :algorithm => self.class.default_algorithm,
-          :password => self.class.default_password,
-          :pkcs5_compliant => false
-        }.merge(options)
-        
-        @pkcs5_compliant = options[:pkcs5_compliant]
-        warn('PKCS #5 non-compliancy is deprecated and will be removed from encrypted_attributes 0.2.0') if @pkcs5_compliant == false
-        
-        self.algorithm = options[:algorithm]
-        
-        self.password = options[:password] || options[:key]
-        warn(':key option is deprecated and will be removed from encrypted_attributes 0.2.0 (use :password)') if options[:key]
-        raise NoKeyError if password.nil?
-        
-        super()
-      end
-      
-      # Decrypts the current string using the current key and algorithm specified
-      def decrypt(data)
-        cipher = build_cipher(:decrypt)
-        cipher.update(Base64.decode64(data)) + cipher.final
-      end
-      
-      # Encrypts the current string using the current key and algorithm specified
-      def encrypt(data)
-        cipher = build_cipher(:encrypt)
-        Base64.encode64(cipher.update(data) + cipher.final)
-      end
-      
-      private
-        def build_cipher(type) #:nodoc:
-          cipher = OpenSSL::Cipher.new(algorithm)
-          cipher.send(type)
-          
-          if @pkcs5_compliant
-            # Use the default PKCS5 key/iv generator algorithm
-            cipher.pkcs5_keyivgen(password)
-          else
-            # To remain backwards-compatible, the deprecated #encrypt/#decrypt
-            # calls (which take a single argument, being the password) is replaced
-            # with pkcs5_keyivgen.  Internally, this uses "OpenSSL for Ruby rulez!"
-            # as the IV/salt.  This is also the case for the number of iterations.
-            cipher.pkcs5_keyivgen(password, 'OpenSSL ', 1)
-            cipher.iv = 'OpenSSL for Ruby rulez!'
-          end
-          
-          cipher
-        end
-    end
-  end
-end