aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport
diff options
context:
space:
mode:
authorRafael França <rafaelmfranca@gmail.com>2017-03-15 11:32:23 -0400
committerGitHub <noreply@github.com>2017-03-15 11:32:23 -0400
commit401d3ad56c08f2d03f49b096e69be43e33e16838 (patch)
treeacb81a9c3fad2d6e6330e2506dd91cc0dcc62c79 /activesupport
parente79a991ccfdf3b7b56562be35b996e61d7395861 (diff)
parent9a79201fd4645eaff99a403daa7ebc4b5d6c2c08 (diff)
downloadrails-401d3ad56c08f2d03f49b096e69be43e33e16838.tar.gz
rails-401d3ad56c08f2d03f49b096e69be43e33e16838.tar.bz2
rails-401d3ad56c08f2d03f49b096e69be43e33e16838.zip
Merge pull request #28412 from benoittgt/add_doc_for_message_encryptor_new
Add documentation about signature_key for MessageEncryptor.new [ci skip]
Diffstat (limited to 'activesupport')
-rw-r--r--activesupport/lib/active_support/message_encryptor.rb5
1 files changed, 5 insertions, 0 deletions
diff --git a/activesupport/lib/active_support/message_encryptor.rb b/activesupport/lib/active_support/message_encryptor.rb
index 69109d2005..5546934874 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'.