TEST_CODEOWNERS/rails
3
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Missing documentation about hash algorithm option for MessageVerifier [ci skip]

Browse Source
This commit is contained in:
Mehmet Emin İNAÇ 2016-02-17 23:48:04 +02:00
parent d50fbe952f
commit 1caf8f6fef
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
activesupport/lib/active_support/message_verifier.rb
View File

@ -24,6 +24,12 @@ module ActiveSupport
# hash upon initialization: # hash upon initialization:
# #
# @verifier = ActiveSupport::MessageVerifier.new('s3Krit', serializer: YAML) # @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 MessageVerifier
class InvalidSignature < StandardError; end class InvalidSignature < StandardError; end