aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib/active_support/message_verifier.rb
diff options
context:
space:
mode:
authorMehmet Emin İNAÇ <mehmetemininac@gmail.com>2016-02-17 23:48:04 +0200
committerMehmet Emin İNAÇ <mehmetemininac@gmail.com>2016-02-18 14:42:48 +0200
commit1caf8f6fef292a3f2961a26af94e24a86f76ef50 (patch)
tree7de5b7c422a2ac8a387fa7b30c00c6748609574f /activesupport/lib/active_support/message_verifier.rb
parentd50fbe952fa066de6e0de15a7da95402c3497d54 (diff)
downloadrails-1caf8f6fef292a3f2961a26af94e24a86f76ef50.tar.gz
rails-1caf8f6fef292a3f2961a26af94e24a86f76ef50.tar.bz2
rails-1caf8f6fef292a3f2961a26af94e24a86f76ef50.zip
Missing documentation about hash algorithm option for MessageVerifier [ci skip]
Diffstat (limited to 'activesupport/lib/active_support/message_verifier.rb')
-rw-r--r--activesupport/lib/active_support/message_verifier.rb6
1 files changed, 6 insertions, 0 deletions
diff --git a/activesupport/lib/active_support/message_verifier.rb b/activesupport/lib/active_support/message_verifier.rb
index 854029bf83..4c3deffe6e 100644
--- a/activesupport/lib/active_support/message_verifier.rb
+++ b/activesupport/lib/active_support/message_verifier.rb
@@ -24,6 +24,12 @@ module ActiveSupport
# hash upon initialization:
#
# @verifier = ActiveSupport::MessageVerifier.new('s3Krit', serializer: YAML)
+ #
+ # +MessageVerifier+ creates HMAC signatures using SHA1 hash algorithm by default.
+ # If you want to use a different hash algorithm, you can change it by providing
+ # `:digest` key as an option while initializing the verifier:
+ #
+ # @verifier = ActiveSupport::MessageVerifier.new('s3Krit', digest: 'SHA256')
class MessageVerifier
class InvalidSignature < StandardError; end