From 9a79201fd4645eaff99a403daa7ebc4b5d6c2c08 Mon Sep 17 00:00:00 2001
From: Benoit Tigeot <btigeot@octo.com>
Date: Tue, 14 Mar 2017 19:09:24 +0100
Subject: Add documentation about signature_key for MessageEncryptor.new [ci
 skip]

---
 activesupport/lib/active_support/message_encryptor.rb | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'activesupport/lib/active_support/message_encryptor.rb')

diff --git a/activesupport/lib/active_support/message_encryptor.rb b/activesupport/lib/active_support/message_encryptor.rb
index 0671469788..aaa12efca6 100644
--- a/activesupport/lib/active_support/message_encryptor.rb
+++ b/activesupport/lib/active_support/message_encryptor.rb
@@ -50,6 +50,11 @@ module ActiveSupport
     # key by using <tt>ActiveSupport::KeyGenerator</tt> or a similar key
     # derivation function.
     #
+    # First additional parameter is used as the signature key for +MessageVerifier+.
+    # This allows you to specify keys to encrypt and sign data.
+    #
+    #    ActiveSupport::MessageEncryptor.new('secret', 'signature_key')
+    #
     # Options:
     # * <tt>:cipher</tt>     - Cipher to use. Can be any cipher returned by
     #   <tt>OpenSSL::Cipher.ciphers</tt>. Default is 'aes-256-cbc'.
-- 
cgit v1.2.3