Merge pull request #6952 from NZKoz/key_generator

Add ActiveSupport::KeyGenerator as a simple wrapper around PBKDF2

3 files changed, 56 insertions, 0 deletions

diff --git a/activesupport/lib/active_support.rb b/activesupport/lib/active_support.rb
index 41d77ab6c1..4e397ea110 100644
--- a/activesupport/lib/active_support.rb
+++ b/activesupport/lib/active_support.rb
@@ -48,6 +48,7 @@ module ActiveSupport
     autoload :Gzip
     autoload :Inflector
     autoload :JSON
+    autoload :KeyGenerator
     autoload :MessageEncryptor
     autoload :MessageVerifier
     autoload :Multibyte
diff --git a/activesupport/lib/active_support/key_generator.rb b/activesupport/lib/active_support/key_generator.rb
new file mode 100644
index 0000000000..04d170f801
--- /dev/null
+++ b/activesupport/lib/active_support/key_generator.rb
@@ -0,0 +1,23 @@
+require 'openssl'
+
+module ActiveSupport
+  # KeyGenerator is a simple wrapper around OpenSSL's implementation of PBKDF2
+  # It can be used to derive a number of keys for various purposes from a given secret.
+  # This lets rails applications have a single secure secret, but avoid reusing that
+  # key in multiple incompatible contexts.
+  class KeyGenerator
+    def initialize(secret, options = {})
+      @secret = secret
+      # The default iterations are higher than required for our key derivation uses
+      # on the off chance someone uses this for password storage
+      @iterations = options[:iterations] || 2**16
+    end
+
+    # Returns a derived key suitable for use.  The default key_size is chosen
+    # to be compatible with the default settings of ActiveSupport::MessageVerifier.
+    # i.e. OpenSSL::Digest::SHA1#block_length
+    def generate_key(salt, key_size=64)
+      OpenSSL::PKCS5.pbkdf2_hmac_sha1(@secret, salt, @iterations, key_size)
+    end
+  end
+end
diff --git a/activesupport/test/key_generator_test.rb b/activesupport/test/key_generator_test.rb
new file mode 100644
index 0000000000..525082d313
--- /dev/null
+++ b/activesupport/test/key_generator_test.rb
@@ -0,0 +1,32 @@
+require 'abstract_unit'
+
+begin
+  require 'openssl'
+  OpenSSL::PKCS5
+rescue LoadError, NameError
+  $stderr.puts "Skipping KeyGenerator test: broken OpenSSL install"
+else
+
+require 'active_support/time'
+require 'active_support/json'
+
+class KeyGeneratorTest < ActiveSupport::TestCase
+  def setup
+    @secret    = SecureRandom.hex(64)
+    @generator = ActiveSupport::KeyGenerator.new(@secret, :iterations=>2)
+  end
+
+  test "Generating a key of the default length" do
+    derived_key = @generator.generate_key("some_salt")
+    assert_kind_of String, derived_key
+    assert_equal OpenSSL::Digest::SHA1.new.block_length, derived_key.length, "Should have generated a key of the default size"
+  end
+
+  test "Generating a key of an alternative length" do
+    derived_key = @generator.generate_key("some_salt", 32)
+    assert_kind_of String, derived_key
+    assert_equal 32, derived_key.length, "Should have generated a key of the right size"
+  end
+end
+
+end