encrypted_strings 0.3.2 → 0.3.3

data/CHANGELOG.rdoc

@@ -1,5 +1,12 @@
 == master
 
+== 0.3.3 / 2010-03-07
+
+* Release gems via rake-gemcutter instead of rubyforge
+* Add support for customizing how the SHA value gets built
+* Allow methods or procs to be defined for dynamically generating SHA salts
+* Add support for customizing the SHA encryption algorithm
+
 == 0.3.2 / 2009-01-11
 
 * Use Array#pack/String#unpack instead of Base64 to be compatible with Ruby 1.9+

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2005 Rick Olson, 2006-2008 Aaron Pfeifer
+Copyright (c) 2005 Rick Olson, 2006-2010 Aaron Pfeifer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,13 +1,15 @@
+require 'rubygems'
+require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/gempackagetask'
-require 'rake/contrib/sshpublisher'
 
 spec = Gem::Specification.new do |s|
   s.name              = 'encrypted_strings'
-  s.version           = '0.3.2'
+  s.version           = '0.3.3'
   s.platform          = Gem::Platform::RUBY
-  s.summary           = 'Dead-simple string encryption/decryption syntax.'
+  s.summary           = 'Dead-simple string encryption/decryption syntax'
+  s.description       = s.summary
   
   s.files             = FileList['{lib,test}/**/*'] + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc)
   s.require_path      = 'lib'
@@ -49,23 +51,30 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = spec.name
   rdoc.template = '../rdoc_template.rb'
-  rdoc.options << '--line-numbers'
+  rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb')
 end
-  
+
+desc 'Generate a gemspec file.'
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end
+
 Rake::GemPackageTask.new(spec) do |p|
   p.gem_spec = spec
-  p.need_tar = true
-  p.need_zip = true
 end
 
 desc 'Publish the beta gem.'
 task :pgem => [:package] do
+  require 'rake/contrib/sshpublisher'
   Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{spec.name}-#{spec.version}.gem").upload
 end
 
 desc 'Publish the API documentation.'
 task :pdoc => [:rdoc] do
+  require 'rake/contrib/sshpublisher'
   Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
 end
 
@@ -74,15 +83,8 @@ task :publish => [:pgem, :pdoc, :release]
 
 desc 'Publish the release files to RubyForge.'
 task :release => [:gem, :package] do
-  require 'rubyforge'
-  
-  ruby_forge = RubyForge.new.configure
-  ruby_forge.login
+  require 'rake/gemcutter'
   
-  %w(gem tgz zip).each do |ext|
-    file = "pkg/#{spec.name}-#{spec.version}.#{ext}"
-    puts "Releasing #{File.basename(file)}..."
-    
-    ruby_forge.add_release(spec.rubyforge_project, spec.name, spec.version, file)
-  end
+  Rake::Gemcutter::Tasks.new(spec)
+  Rake::Task['gem:push'].invoke
 end

data/lib/encrypted_strings/sha_cipher.rb

@@ -9,6 +9,7 @@ module EncryptedStrings
   # algorithm must be specified.  You can define the default for this value
   # like so:
   # 
+  #   EncryptedStrings::ShaCipher.default_algorithm = 'sha512'
   #   EncryptedStrings::ShaCipher.default_salt = 'secret'
   # 
   # If these configuration options are not passed in to #encrypt, then the
@@ -17,6 +18,25 @@ module EncryptedStrings
   #   password = 'shhhh'
   #   password.encrypt(:sha, :salt => 'secret')  # => "ae645b35bb5dfea6c9133ac872e6adfa92a3c2bd"
   # 
+  # === Customizations
+  # 
+  # In addition to customizing the algorithm, you can further tweak how values
+  # get encrypted by defining dynamic salts and how to build the value that
+  # actually gets hashed.
+  # 
+  # For example:
+  # 
+  #   password = 'shhhh'
+  #   password.encrypt(:sha,
+  #     :salt => lambda {Time.now.to_s},
+  #     :builder => lambda {|data, salt| "#{data}|#{salt}"}
+  #   )
+  # 
+  # The above example will generate a salt based on the current time and then
+  # use a custom builder for determining how the salt and data get concatenated
+  # to determine the value that gets hashed.  This is particularly useful for
+  # providing compatibility with legacy systems.
+  # 
   # == Decrypting
   # 
   # SHA-encrypted strings cannot be decrypted.  The only way to determine
@@ -28,28 +48,55 @@ module EncryptedStrings
   #   password == input                                   # => true
   class ShaCipher < Cipher
     class << self
+      # The default algorithm to use for encryption.  Default is SHA1.
+      attr_accessor :default_algorithm
+      
       # The default salt value to use during encryption
       attr_accessor :default_salt
+      
+      # The default algorithm to use for building the value that gets hashed.
+      # Default is lambda {|data, salt| "#{data}#{salt}"}.
+      attr_accessor :default_builder
     end
     
     # Set defaults
+    @default_algorithm = 'SHA1'
     @default_salt = 'salt'
+    @default_builder = lambda {|data, salt| "#{data}#{salt}"}
+    
+    # The algorithm to use for encryption/decryption
+    attr_accessor :algorithm
     
     # The salt value to use for encryption
     attr_accessor :salt
     
+    # The function to use to build the value that gets hashed
+    attr_accessor :builder
+    
     # Creates a new cipher that uses an SHA encryption strategy.
     # 
     # Configuration options:
-    # * <tt>:salt</tt> - Random bytes used as one of the inputs for generating
-    #   the encrypted string
+    # * <tt>:algorithm</tt> - The hashing algorithm to use for generating the
+    #   encrypted string
+    # * <tt>:salt</tt> - Specifies a method, proc or string to call to determine
+    #   the random bytes used as one of the inputs for generating the encrypted
+    #   string
+    # * <tt>:builder</tt> - Specifies a method or proc to call to determine the
+    #   actual value that gets hashed.  This takes two arguments: the data and
+    #   the salt for the encryption.
     def initialize(options = {})
-      invalid_options = options.keys - [:salt]
+      invalid_options = options.keys - [:algorithm, :salt, :builder]
       raise ArgumentError, "Unknown key(s): #{invalid_options.join(", ")}" unless invalid_options.empty?
       
-      options = {:salt => ShaCipher.default_salt}.merge(options)
+      options = {
+        :algorithm => ShaCipher.default_algorithm,
+        :salt => ShaCipher.default_salt,
+        :builder => ShaCipher.default_builder
+      }.merge(options)
       
-      self.salt = options[:salt].to_s
+      self.algorithm = options[:algorithm].upcase
+      self.salt = salt_value(options[:salt])
+      self.builder = options[:builder]
       
       super()
     end
@@ -61,7 +108,33 @@ module EncryptedStrings
     
     # Returns the encrypted value of the data
     def encrypt(data)
-      Digest::SHA1.hexdigest(data + salt)
+      Digest::const_get(algorithm.upcase).hexdigest(build(data, salt))
     end
+    
+    private
+      # Evaluates one of several different types of methods to determine the
+      # value of the salt.  Methods can be one of the following types:
+      # * Method / Proc
+      # * String
+      # * Object that responds to :salt
+      def salt_value(value)
+        if value.is_a?(Proc)
+          value.call
+        elsif value.respond_to?(:salt)
+          value.salt
+        else
+          value.to_s
+        end
+      end
+      
+      # Builds the value to hash based on the data being encrypted and the salt
+      # being used to seed the encryption algorithm
+      def build(data, salt)
+        if builder.is_a?(Proc)
+          builder.call(data, salt)
+        else
+          builder.send(:build, data, salt)
+        end
+      end
   end
 end

data/test/sha_cipher_test.rb

@@ -16,20 +16,28 @@ end
 
 class ShaCipherWithCustomDefaultsTest < Test::Unit::TestCase
   def setup
+    @original_default_algorithm = EncryptedStrings::ShaCipher.default_algorithm
     @original_default_salt = EncryptedStrings::ShaCipher.default_salt
+    
+    EncryptedStrings::ShaCipher.default_algorithm = 'sha512'
     EncryptedStrings::ShaCipher.default_salt = 'custom_salt'
     @sha_cipher = EncryptedStrings::ShaCipher.new
   end
   
+  def test_should_use_custom_default_algorithm
+    assert_equal 'SHA512', @sha_cipher.algorithm
+  end
+  
   def test_should_use_custom_default_salt
     assert_equal 'custom_salt', @sha_cipher.salt
   end
   
-  def test_should_encrypt_using_custom_default_salt
-    assert_equal '280f3c516070b09aa3eb755378509c725a9c6561', @sha_cipher.encrypt('test')
+  def test_should_encrypt_using_custom_default_configuration
+    assert_equal '22e38b0da46ab455cdb61375c58f66a7160227fe58727042087a59419258184b72ee0e4198110b951778dc76ace4402a377cdc31bb04195bce75196fe7684218', @sha_cipher.encrypt('test')
   end
   
   def teardown
+    EncryptedStrings::ShaCipher.default_algorithm = @original_default_algorithm
     EncryptedStrings::ShaCipher.default_salt = @original_default_salt
   end
 end
@@ -56,7 +64,11 @@ end
 
 class ShaCipherWithCustomOptionsTest < Test::Unit::TestCase
   def setup
-    @sha_cipher = EncryptedStrings::ShaCipher.new(:salt => 'different salt')
+    @sha_cipher = EncryptedStrings::ShaCipher.new(:algorithm => 'sha512', :salt => 'different salt')
+  end
+  
+  def test_should_use_custom_algorithm
+    assert_equal 'SHA512', @sha_cipher.algorithm
   end
   
   def test_should_use_custom_salt
@@ -64,7 +76,7 @@ class ShaCipherWithCustomOptionsTest < Test::Unit::TestCase
   end
   
   def test_should_encrypt_using_custom_salt
-    assert_equal '18e3256d71529db8fa65b2eef24a69ddad7070f3', @sha_cipher.encrypt('test')
+    assert_equal 'c0b0d80d279a471d9ad53cdab4a667612ecfbc0a685f502ea7a586acf107a549d17a2e5f515c2fdfe6d90a772072e4e8b0bf3de7b9c51a9c95c43b91d129f7e1', @sha_cipher.encrypt('test')
   end
 end
 
@@ -80,3 +92,61 @@ class ShaCipherWithNonStringSaltTest < Test::Unit::TestCase
     assert_equal @time.to_s, @sha_cipher.salt
   end
 end
+
+class ShaCipherWithProcSaltTest < Test::Unit::TestCase
+  def setup
+    @sha_cipher = EncryptedStrings::ShaCipher.new(:salt => lambda {|*args| @args = args; 'val'})
+  end
+  
+  def test_should_call_proc_without_arguments
+    assert_equal [], @args
+  end
+  
+  def test_should_use_return_value_from_proc
+    assert_equal 'val', @sha_cipher.salt
+  end
+end
+
+class ShaCipherWithObjectSaltTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+    class << @object
+      def salt
+        'val'
+      end
+    end
+    
+    @sha_cipher = EncryptedStrings::ShaCipher.new(:salt => @object)
+  end
+  
+  def test_should_use_salt_method
+    assert_equal 'val', @sha_cipher.salt
+  end
+end
+
+class ShaCipherWithProcBuilderTest < Test::Unit::TestCase
+  def setup
+    @sha_cipher = EncryptedStrings::ShaCipher.new(:builder => lambda {|data, salt| "#{data}|#{salt}"})
+  end
+  
+  def test_should_encrypt_based_on_custom_builder
+    assert_equal EncryptedStrings::ShaCipher.new.encrypt('test|'), @sha_cipher.encrypt('test')
+  end
+end
+
+class ShaCipherWithObjectBuilderTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+    class << @object
+      def build(data, salt)
+        "#{data}|#{salt}"
+      end
+    end
+    
+    @sha_cipher = EncryptedStrings::ShaCipher.new(:builder => @object)
+  end
+  
+  def test_should_encrypt_based_on_custom_builder
+    assert_equal EncryptedStrings::ShaCipher.new.encrypt('test|'), @sha_cipher.encrypt('test')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: encrypted_strings
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-11 00:00:00 -05:00
+date: 2010-03-07 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: 
+description: Dead-simple string encryption/decryption syntax
 email: aaron@pluginaweek.org
 executables: []
 
@@ -22,24 +22,21 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/encrypted_strings
-- lib/encrypted_strings/cipher.rb
+- lib/encrypted_strings.rb
 - lib/encrypted_strings/sha_cipher.rb
-- lib/encrypted_strings/extensions
-- lib/encrypted_strings/extensions/string.rb
-- lib/encrypted_strings/symmetric_cipher.rb
 - lib/encrypted_strings/asymmetric_cipher.rb
-- lib/encrypted_strings.rb
+- lib/encrypted_strings/symmetric_cipher.rb
+- lib/encrypted_strings/cipher.rb
+- lib/encrypted_strings/extensions/string.rb
 - test/test_helper.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/string_test.rb
+- test/keys/private
 - test/cipher_test.rb
+- test/string_test.rb
+- test/sha_cipher_test.rb
+- test/symmetric_cipher_test.rb
+- test/asymmetric_cipher_test.rb
 - CHANGELOG.rdoc
 - init.rb
 - LICENSE
@@ -47,6 +44,8 @@ files:
 - README.rdoc
 has_rdoc: true
 homepage: http://www.pluginaweek.org
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -67,13 +66,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: pluginaweek
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
-summary: Dead-simple string encryption/decryption syntax.
+specification_version: 3
+summary: Dead-simple string encryption/decryption syntax
 test_files: 
+- test/cipher_test.rb
+- test/string_test.rb
+- test/sha_cipher_test.rb
 - test/symmetric_cipher_test.rb
 - test/asymmetric_cipher_test.rb
-- test/sha_cipher_test.rb
-- test/string_test.rb
-- test/cipher_test.rb