From db040cdf8ba832123bae68764189bbcb569d473a Mon Sep 17 00:00:00 2001 From: Willem van Bergen Date: Thu, 15 Sep 2011 13:15:21 -0400 Subject: Implement API suggestions of pull request. --- activesupport/lib/active_support/message_encryptor.rb | 11 +++++------ activesupport/lib/active_support/message_verifier.rb | 11 +++++------ activesupport/test/message_encryptor_test.rb | 15 ++++++++++++--- activesupport/test/message_verifier_test.rb | 15 ++++++++++++--- 4 files changed, 34 insertions(+), 18 deletions(-) diff --git a/activesupport/lib/active_support/message_encryptor.rb b/activesupport/lib/active_support/message_encryptor.rb index 05d6790075..66e121be26 100644 --- a/activesupport/lib/active_support/message_encryptor.rb +++ b/activesupport/lib/active_support/message_encryptor.rb @@ -13,13 +13,12 @@ module ActiveSupport class InvalidMessage < StandardError; end OpenSSLCipherError = OpenSSL::Cipher.const_defined?(:CipherError) ? OpenSSL::Cipher::CipherError : OpenSSL::CipherError - attr_accessor :serializer, :deserializer + attr_accessor :serializer - def initialize(secret, cipher = 'aes-256-cbc') + def initialize(secret, cipher = 'aes-256-cbc', serializer = Marshal) @secret = secret @cipher = cipher - @serializer = lambda { |value| Marshal.dump(value) } - @deserializer = lambda { |value| Marshal.load(value) } + @serializer = serializer end def encrypt(value) @@ -31,7 +30,7 @@ module ActiveSupport cipher.key = @secret cipher.iv = iv - encrypted_data = cipher.update(serializer.call(value)) + encrypted_data = cipher.update(serializer.dump(value)) encrypted_data << cipher.final [encrypted_data, iv].map {|v| ActiveSupport::Base64.encode64s(v)}.join("--") @@ -48,7 +47,7 @@ module ActiveSupport decrypted_data = cipher.update(encrypted_data) decrypted_data << cipher.final - deserializer.call(decrypted_data) + serializer.load(decrypted_data) rescue OpenSSLCipherError, TypeError raise InvalidMessage end diff --git a/activesupport/lib/active_support/message_verifier.rb b/activesupport/lib/active_support/message_verifier.rb index e38e242cfe..b3a087a596 100644 --- a/activesupport/lib/active_support/message_verifier.rb +++ b/activesupport/lib/active_support/message_verifier.rb @@ -21,13 +21,12 @@ module ActiveSupport class MessageVerifier class InvalidSignature < StandardError; end - attr_accessor :serializer, :deserializer + attr_accessor :serializer - def initialize(secret, digest = 'SHA1') + def initialize(secret, digest = 'SHA1', serializer = Marshal) @secret = secret @digest = digest - @serializer = lambda { |value| Marshal.dump(value) } - @deserializer = lambda { |value| Marshal.load(value) } + @serializer = serializer end def verify(signed_message) @@ -35,14 +34,14 @@ module ActiveSupport data, digest = signed_message.split("--") if data.present? && digest.present? && secure_compare(digest, generate_digest(data)) - deserializer.call(ActiveSupport::Base64.decode64(data)) + serializer.load(ActiveSupport::Base64.decode64(data)) else raise InvalidSignature end end def generate(value) - data = ActiveSupport::Base64.encode64s(serializer.call(value)) + data = ActiveSupport::Base64.encode64s(serializer.dump(value)) "#{data}--#{generate_digest(data)}" end diff --git a/activesupport/test/message_encryptor_test.rb b/activesupport/test/message_encryptor_test.rb index 95e64fe6d1..9c89512b42 100644 --- a/activesupport/test/message_encryptor_test.rb +++ b/activesupport/test/message_encryptor_test.rb @@ -11,6 +11,17 @@ require 'active_support/time' require 'active_support/json' class MessageEncryptorTest < Test::Unit::TestCase + + class JSONSerializer + def dump(value) + ActiveSupport::JSON.encode(value) + end + + def load(value) + ActiveSupport::JSON.decode(value) + end + end + def setup @encryptor = ActiveSupport::MessageEncryptor.new(SecureRandom.hex(64)) @data = { :some => "data", :now => Time.local(2010) } @@ -41,9 +52,7 @@ class MessageEncryptorTest < Test::Unit::TestCase end def test_alternative_serialization_method - @encryptor.serializer = lambda { |value| ActiveSupport::JSON.encode(value) } - @encryptor.deserializer = lambda { |value| ActiveSupport::JSON.decode(value) } - + @encryptor.serializer = JSONSerializer.new message = @encryptor.encrypt_and_sign({ :foo => 123, 'bar' => Time.utc(2010) }) assert_equal @encryptor.decrypt_and_verify(message), { "foo" => 123, "bar" => "2010-01-01T00:00:00Z" } end diff --git a/activesupport/test/message_verifier_test.rb b/activesupport/test/message_verifier_test.rb index 224e38a52a..10a1738786 100644 --- a/activesupport/test/message_verifier_test.rb +++ b/activesupport/test/message_verifier_test.rb @@ -11,6 +11,17 @@ require 'active_support/time' require 'active_support/json' class MessageVerifierTest < Test::Unit::TestCase + + class JSONSerializer + def dump(value) + ActiveSupport::JSON.encode(value) + end + + def load(value) + ActiveSupport::JSON.decode(value) + end + end + def setup @verifier = ActiveSupport::MessageVerifier.new("Hey, I'm a secret!") @data = { :some => "data", :now => Time.local(2010) } @@ -34,9 +45,7 @@ class MessageVerifierTest < Test::Unit::TestCase end def test_alternative_serialization_method - @verifier.serializer = lambda { |value| ActiveSupport::JSON.encode(value) } - @verifier.deserializer = lambda { |value| ActiveSupport::JSON.decode(value) } - + @verifier.serializer = JSONSerializer.new message = @verifier.generate({ :foo => 123, 'bar' => Time.utc(2010) }) assert_equal @verifier.verify(message), { "foo" => 123, "bar" => "2010-01-01T00:00:00Z" } end -- cgit v1.2.3 From 2d30d4cb888e2da7c1f0a8828b467d2e21c90cfa Mon Sep 17 00:00:00 2001 From: Willem van Bergen Date: Thu, 15 Sep 2011 13:23:08 -0400 Subject: Add some documentation for the new serializer property of MessageVerifier and MessageEncryptor. --- activesupport/lib/active_support/message_verifier.rb | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/activesupport/lib/active_support/message_verifier.rb b/activesupport/lib/active_support/message_verifier.rb index b3a087a596..0181070479 100644 --- a/activesupport/lib/active_support/message_verifier.rb +++ b/activesupport/lib/active_support/message_verifier.rb @@ -18,6 +18,11 @@ module ActiveSupport # self.current_user = User.find(id) # end # + # By default it uses Marshal to serialize the message. If you want to use another + # serialization method, you can set the serializer attribute to something that responds + # to dump and load, e.g.: + # + # @verifier.serializer = YAML class MessageVerifier class InvalidSignature < StandardError; end -- cgit v1.2.3