2017-07-09 12:06:36 +00:00
|
|
|
# frozen_string_literal: true
|
2017-07-10 13:39:13 +00:00
|
|
|
|
2021-07-30 09:12:42 +00:00
|
|
|
require "openssl"
|
2016-08-06 15:58:50 +00:00
|
|
|
require "base64"
|
2017-10-21 13:11:29 +00:00
|
|
|
require "active_support/core_ext/object/blank"
|
|
|
|
require "active_support/security_utils"
|
2023-02-07 19:51:28 +00:00
|
|
|
require "active_support/messages/codec"
|
2017-10-21 13:11:29 +00:00
|
|
|
require "active_support/messages/rotator"
|
2010-01-01 19:59:51 +00:00
|
|
|
|
2008-11-23 14:29:11 +00:00
|
|
|
module ActiveSupport
|
2023-04-23 13:48:37 +00:00
|
|
|
# = Active Support Message Verifier
|
|
|
|
#
|
2012-09-17 05:22:18 +00:00
|
|
|
# +MessageVerifier+ makes it easy to generate and verify messages which are
|
|
|
|
# signed to prevent tampering.
|
2010-08-14 05:13:00 +00:00
|
|
|
#
|
2023-06-23 01:49:30 +00:00
|
|
|
# In a \Rails application, you can use +Rails.application.message_verifier+
|
2022-02-04 16:03:25 +00:00
|
|
|
# to manage unique instances of verifiers for each use case.
|
|
|
|
# {Learn more}[link:classes/Rails/Application.html#method-i-message_verifier].
|
|
|
|
#
|
2012-09-17 05:22:18 +00:00
|
|
|
# This is useful for cases like remember-me tokens and auto-unsubscribe links
|
2012-12-05 06:11:54 +00:00
|
|
|
# where the session store isn't suitable or available.
|
2008-11-23 14:29:11 +00:00
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# First, generate a signed message:
|
|
|
|
# cookies[:remember_me] = Rails.application.message_verifier(:remember_me).generate([@user.id, 2.weeks.from_now])
|
2010-08-14 05:13:00 +00:00
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# Later verify that message:
|
2008-11-23 14:29:11 +00:00
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# id, time = Rails.application.message_verifier(:remember_me).verify(cookies[:remember_me])
|
|
|
|
# if time.future?
|
2008-11-23 14:29:11 +00:00
|
|
|
# self.current_user = User.find(id)
|
|
|
|
# end
|
2010-08-14 05:13:00 +00:00
|
|
|
#
|
2024-06-08 22:36:09 +00:00
|
|
|
# === Signing is not encryption
|
|
|
|
#
|
|
|
|
# The signed messages are not encrypted. The payload is merely encoded (Base64 by default) and can be decoded by
|
|
|
|
# anyone. The signature is just assuring that the message wasn't tampered with. For example:
|
|
|
|
#
|
|
|
|
# message = Rails.application.message_verifier('my_purpose').generate('never put secrets here')
|
|
|
|
# # => "BAhJIhtuZXZlciBwdXQgc2VjcmV0cyBoZXJlBjoGRVQ=--a0c1c0827919da5e949e989c971249355735e140"
|
|
|
|
# Base64.decode64(message.split("--").first) # no key needed
|
|
|
|
# # => 'never put secrets here'
|
|
|
|
#
|
|
|
|
# If you also need to encrypt the contents, you must use ActiveSupport::MessageEncryptor instead.
|
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# === Confine messages to a specific purpose
|
2017-07-22 14:31:53 +00:00
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# It's not recommended to use the same verifier for different purposes in your application.
|
|
|
|
# Doing so could allow a malicious actor to re-use a signed message to perform an unauthorized
|
|
|
|
# action.
|
|
|
|
# You can reduce this risk by confining signed messages to a specific +:purpose+.
|
2017-07-22 14:31:53 +00:00
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# token = @verifier.generate("signed message", purpose: :login)
|
2017-07-22 14:31:53 +00:00
|
|
|
#
|
|
|
|
# Then that same purpose must be passed when verifying to get the data back out:
|
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# @verifier.verified(token, purpose: :login) # => "signed message"
|
2017-07-22 14:31:53 +00:00
|
|
|
# @verifier.verified(token, purpose: :shipping) # => nil
|
|
|
|
# @verifier.verified(token) # => nil
|
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# @verifier.verify(token, purpose: :login) # => "signed message"
|
|
|
|
# @verifier.verify(token, purpose: :shipping) # => raises ActiveSupport::MessageVerifier::InvalidSignature
|
|
|
|
# @verifier.verify(token) # => raises ActiveSupport::MessageVerifier::InvalidSignature
|
2017-07-22 14:31:53 +00:00
|
|
|
#
|
|
|
|
# Likewise, if a message has no purpose it won't be returned when verifying with
|
|
|
|
# a specific purpose.
|
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# token = @verifier.generate("signed message")
|
|
|
|
# @verifier.verified(token, purpose: :redirect) # => nil
|
|
|
|
# @verifier.verified(token) # => "signed message"
|
2017-07-22 14:31:53 +00:00
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# @verifier.verify(token, purpose: :redirect) # => raises ActiveSupport::MessageVerifier::InvalidSignature
|
|
|
|
# @verifier.verify(token) # => "signed message"
|
2017-07-22 14:31:53 +00:00
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# === Expiring messages
|
2017-07-22 14:31:53 +00:00
|
|
|
#
|
|
|
|
# By default messages last forever and verifying one year from now will still
|
|
|
|
# return the original value. But messages can be set to expire at a given
|
|
|
|
# time with +:expires_in+ or +:expires_at+.
|
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# @verifier.generate("signed message", expires_in: 1.month)
|
|
|
|
# @verifier.generate("signed message", expires_at: Time.now.end_of_year)
|
2017-07-22 14:31:53 +00:00
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# Messages can then be verified and returned until expiry.
|
2017-07-22 14:31:53 +00:00
|
|
|
# Thereafter, the +verified+ method returns +nil+ while +verify+ raises
|
2023-05-24 21:56:17 +00:00
|
|
|
# +ActiveSupport::MessageVerifier::InvalidSignature+.
|
2017-09-23 21:16:21 +00:00
|
|
|
#
|
|
|
|
# === Rotating keys
|
|
|
|
#
|
2017-09-24 19:41:16 +00:00
|
|
|
# MessageVerifier also supports rotating out old configurations by falling
|
2021-05-14 11:10:29 +00:00
|
|
|
# back to a stack of verifiers. Call +rotate+ to build and add a verifier so
|
|
|
|
# either +verified+ or +verify+ will also try verifying with the fallback.
|
2017-09-24 19:41:16 +00:00
|
|
|
#
|
|
|
|
# By default any rotated verifiers use the values of the primary
|
|
|
|
# verifier unless specified otherwise.
|
|
|
|
#
|
|
|
|
# You'd give your verifier the new defaults:
|
|
|
|
#
|
|
|
|
# verifier = ActiveSupport::MessageVerifier.new(@secret, digest: "SHA512", serializer: JSON)
|
|
|
|
#
|
|
|
|
# Then gradually rotate the old values out by adding them as fallbacks. Any message
|
|
|
|
# generated with the old values will then work until the rotation is removed.
|
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# verifier.rotate(old_secret) # Fallback to an old secret instead of @secret.
|
|
|
|
# verifier.rotate(digest: "SHA256") # Fallback to an old digest instead of SHA512.
|
|
|
|
# verifier.rotate(serializer: Marshal) # Fallback to an old serializer instead of JSON.
|
2017-09-24 19:41:16 +00:00
|
|
|
#
|
|
|
|
# Though the above would most likely be combined into one rotation:
|
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# verifier.rotate(old_secret, digest: "SHA256", serializer: Marshal)
|
2023-02-07 19:51:28 +00:00
|
|
|
class MessageVerifier < Messages::Codec
|
Use throw for message error handling control flow
There are multiple points of failure when processing a message with
`MessageEncryptor` or `MessageVerifier`, and there several ways we might
want to handle those failures. For example, swallowing a failure with
`MessageVerifier#verified`, or raising a specific exception with
`MessageVerifier#verify`, or conditionally ignoring a failure when
rotations are configured.
Prior to this commit, the _internal_ logic of handling failures was
implemented using a mix of `nil` return values and raised exceptions.
This commit reimplements the internal logic using `throw` and a few
precisely targeted `rescue`s. This accomplishes several things:
* Allow rotation of serializers for `MessageVerifier`. Previously,
errors from a `MessageVerifier`'s initial serializer were never
rescued. Thus, the serializer could not be rotated:
```ruby
old_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: Marshal)
new_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: JSON)
new_verifier.rotate(serializer: Marshal)
message = old_verifier.generate("message")
new_verifier.verify(message)
# BEFORE:
# => raises JSON::ParserError
# AFTER:
# => "message"
```
* Allow rotation of serializers for `MessageEncryptor` when using a
non-standard initial serializer. Similar to `MessageVerifier`, the
serializer could not be rotated when the initial serializer raised an
error other than `TypeError` or `JSON::ParserError`, such as
`Psych::SyntaxError` or a custom error.
* Raise `MessageEncryptor::InvalidMessage` from `decrypt_and_verify`
regardless of cipher. Previously, when a `MessageEncryptor` was using
a non-AEAD cipher such as AES-256-CBC, a corrupt or tampered message
would raise `MessageVerifier::InvalidSignature` due to reliance on
`MessageVerifier` for verification. Now, the verification mechanism
is transparent to the user:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-gcm")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-cbc")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
```
* Support `nil` original value when using `MessageVerifier#verify`.
Previously, `MessageVerifier#verify` did not work with `nil` original
values, though both `MessageVerifier#verified` and
`MessageEncryptor#decrypt_and_verify` do:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32)
message = encryptor.encrypt_and_sign(nil)
encryptor.decrypt_and_verify(message)
# => nil
verifier = ActiveSupport::MessageVerifier.new("secret")
message = verifier.generate(nil)
verifier.verified(message)
# => nil
verifier.verify(message)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => nil
```
* Improve performance of verifying a message when it has expired and one
or more rotations have been configured:
```ruby
# frozen_string_literal: true
require "benchmark/ips"
require "active_support/all"
verifier = ActiveSupport::MessageVerifier.new("new secret")
verifier.rotate("old secret")
message = verifier.generate({ "data" => "x" * 100 }, expires_at: 1.day.ago)
Benchmark.ips do |x|
x.report("expired message") do
verifier.verified(message)
end
end
```
__Before__
```
Warming up --------------------------------------
expired message 1.442k i/100ms
Calculating -------------------------------------
expired message 14.403k (± 1.7%) i/s - 72.100k in 5.007382s
```
__After__
```
Warming up --------------------------------------
expired message 1.995k i/100ms
Calculating -------------------------------------
expired message 19.992k (± 2.0%) i/s - 101.745k in 5.091421s
```
Fixes #47185.
2023-02-07 19:56:59 +00:00
|
|
|
prepend Messages::Rotator
|
2017-09-23 21:16:21 +00:00
|
|
|
|
2008-11-23 14:29:11 +00:00
|
|
|
class InvalidSignature < StandardError; end
|
2010-08-14 05:13:00 +00:00
|
|
|
|
2021-07-30 09:12:42 +00:00
|
|
|
SEPARATOR = "--" # :nodoc:
|
|
|
|
SEPARATOR_LENGTH = SEPARATOR.length # :nodoc:
|
|
|
|
|
2023-04-05 14:15:43 +00:00
|
|
|
# Initialize a new MessageVerifier with a secret for the signature.
|
|
|
|
#
|
|
|
|
# ==== Options
|
|
|
|
#
|
|
|
|
# [+:digest+]
|
2023-04-16 23:00:00 +00:00
|
|
|
# Digest used for signing. The default is <tt>"SHA1"</tt>. See
|
|
|
|
# +OpenSSL::Digest+ for alternatives.
|
2023-04-05 14:15:43 +00:00
|
|
|
#
|
|
|
|
# [+:serializer+]
|
Unify Message{Encryptor,Verifier} serializer config
In #42843 and #42846, several config settings were added to control the
default serializer for `MessageEncryptor` and `MessageVerifier`, and to
provide a migration path from a default `Marshal` serializer to a
default `JSON` serializer:
* `config.active_support.default_message_encryptor_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.default_message_verifier_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.fallback_to_marshal_deserialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
* `config.active_support.use_marshal_serialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
This commit unifies those config settings into a single setting,
`config.active_support.message_serializer`, which supports `:marshal`,
`:json_allow_marshal`, and `:json` values. So, for example,
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = true
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json_allow_marshal
```
and
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json
```
This commit also replaces `ActiveSupport::JsonWithMarshalFallback` with
`ActiveSupport::Messages::SerializerWithFallback`, which implements a
generic mechanism for serializer fallback. The `:marshal` serializer
uses this mechanism too, so
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = true
```
becomes
```ruby
config.active_support.message_serializer = :marshal
```
Additionally, the logging behavior of `JsonWithMarshalFallback` has been
replaced with notifications which include the names of the intended and
actual serializers, as well as the serialized and deserialized message
data. This provides a more targeted means of tracking serializer
fallback events. It also allows the user to "silence" such events, if
desired, without an additional config setting.
All of these changes make it easier to add migration paths for new
serializers such as `ActiveSupport::MessagePack`.
2023-04-10 20:50:49 +00:00
|
|
|
# The serializer used to serialize message data. You can specify any
|
|
|
|
# object that responds to +dump+ and +load+, or you can choose from
|
|
|
|
# several preconfigured serializers: +:marshal+, +:json_allow_marshal+,
|
2023-04-16 20:57:55 +00:00
|
|
|
# +:json+, +:message_pack_allow_marshal+, +:message_pack+.
|
Unify Message{Encryptor,Verifier} serializer config
In #42843 and #42846, several config settings were added to control the
default serializer for `MessageEncryptor` and `MessageVerifier`, and to
provide a migration path from a default `Marshal` serializer to a
default `JSON` serializer:
* `config.active_support.default_message_encryptor_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.default_message_verifier_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.fallback_to_marshal_deserialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
* `config.active_support.use_marshal_serialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
This commit unifies those config settings into a single setting,
`config.active_support.message_serializer`, which supports `:marshal`,
`:json_allow_marshal`, and `:json` values. So, for example,
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = true
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json_allow_marshal
```
and
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json
```
This commit also replaces `ActiveSupport::JsonWithMarshalFallback` with
`ActiveSupport::Messages::SerializerWithFallback`, which implements a
generic mechanism for serializer fallback. The `:marshal` serializer
uses this mechanism too, so
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = true
```
becomes
```ruby
config.active_support.message_serializer = :marshal
```
Additionally, the logging behavior of `JsonWithMarshalFallback` has been
replaced with notifications which include the names of the intended and
actual serializers, as well as the serialized and deserialized message
data. This provides a more targeted means of tracking serializer
fallback events. It also allows the user to "silence" such events, if
desired, without an additional config setting.
All of these changes make it easier to add migration paths for new
serializers such as `ActiveSupport::MessagePack`.
2023-04-10 20:50:49 +00:00
|
|
|
#
|
|
|
|
# The preconfigured serializers include a fallback mechanism to support
|
|
|
|
# multiple deserialization formats. For example, the +:marshal+ serializer
|
2023-04-16 20:57:55 +00:00
|
|
|
# will serialize using +Marshal+, but can deserialize using +Marshal+,
|
|
|
|
# ActiveSupport::JSON, or ActiveSupport::MessagePack. This makes it easy
|
|
|
|
# to migrate between serializers.
|
Unify Message{Encryptor,Verifier} serializer config
In #42843 and #42846, several config settings were added to control the
default serializer for `MessageEncryptor` and `MessageVerifier`, and to
provide a migration path from a default `Marshal` serializer to a
default `JSON` serializer:
* `config.active_support.default_message_encryptor_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.default_message_verifier_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.fallback_to_marshal_deserialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
* `config.active_support.use_marshal_serialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
This commit unifies those config settings into a single setting,
`config.active_support.message_serializer`, which supports `:marshal`,
`:json_allow_marshal`, and `:json` values. So, for example,
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = true
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json_allow_marshal
```
and
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json
```
This commit also replaces `ActiveSupport::JsonWithMarshalFallback` with
`ActiveSupport::Messages::SerializerWithFallback`, which implements a
generic mechanism for serializer fallback. The `:marshal` serializer
uses this mechanism too, so
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = true
```
becomes
```ruby
config.active_support.message_serializer = :marshal
```
Additionally, the logging behavior of `JsonWithMarshalFallback` has been
replaced with notifications which include the names of the intended and
actual serializers, as well as the serialized and deserialized message
data. This provides a more targeted means of tracking serializer
fallback events. It also allows the user to "silence" such events, if
desired, without an additional config setting.
All of these changes make it easier to add migration paths for new
serializers such as `ActiveSupport::MessagePack`.
2023-04-10 20:50:49 +00:00
|
|
|
#
|
2023-04-16 20:57:55 +00:00
|
|
|
# The +:marshal+, +:json_allow_marshal+, and +:message_pack_allow_marshal+
|
|
|
|
# serializers support deserializing using +Marshal+, but the others do
|
|
|
|
# not. Beware that +Marshal+ is a potential vector for deserialization
|
|
|
|
# attacks in cases where a message signing secret has been leaked. <em>If
|
|
|
|
# possible, choose a serializer that does not support +Marshal+.</em>
|
|
|
|
#
|
|
|
|
# The +:message_pack+ and +:message_pack_allow_marshal+ serializers use
|
|
|
|
# ActiveSupport::MessagePack, which can roundtrip some Ruby types that are
|
|
|
|
# not supported by JSON, and may provide improved performance. However,
|
|
|
|
# these require the +msgpack+ gem.
|
Unify Message{Encryptor,Verifier} serializer config
In #42843 and #42846, several config settings were added to control the
default serializer for `MessageEncryptor` and `MessageVerifier`, and to
provide a migration path from a default `Marshal` serializer to a
default `JSON` serializer:
* `config.active_support.default_message_encryptor_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.default_message_verifier_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.fallback_to_marshal_deserialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
* `config.active_support.use_marshal_serialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
This commit unifies those config settings into a single setting,
`config.active_support.message_serializer`, which supports `:marshal`,
`:json_allow_marshal`, and `:json` values. So, for example,
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = true
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json_allow_marshal
```
and
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json
```
This commit also replaces `ActiveSupport::JsonWithMarshalFallback` with
`ActiveSupport::Messages::SerializerWithFallback`, which implements a
generic mechanism for serializer fallback. The `:marshal` serializer
uses this mechanism too, so
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = true
```
becomes
```ruby
config.active_support.message_serializer = :marshal
```
Additionally, the logging behavior of `JsonWithMarshalFallback` has been
replaced with notifications which include the names of the intended and
actual serializers, as well as the serialized and deserialized message
data. This provides a more targeted means of tracking serializer
fallback events. It also allows the user to "silence" such events, if
desired, without an additional config setting.
All of these changes make it easier to add migration paths for new
serializers such as `ActiveSupport::MessagePack`.
2023-04-10 20:50:49 +00:00
|
|
|
#
|
2023-05-05 21:33:40 +00:00
|
|
|
# When using \Rails, the default depends on +config.active_support.message_serializer+.
|
|
|
|
# Otherwise, the default is +:marshal+.
|
2023-04-05 14:15:43 +00:00
|
|
|
#
|
|
|
|
# [+:url_safe+]
|
|
|
|
# By default, MessageVerifier generates RFC 4648 compliant strings which are
|
|
|
|
# not URL-safe. In other words, they can contain "+" and "/". If you want to
|
|
|
|
# generate URL-safe strings (in compliance with "Base 64 Encoding with URL
|
|
|
|
# and Filename Safe Alphabet" in RFC 4648), you can pass +true+.
|
|
|
|
#
|
|
|
|
# [+:force_legacy_metadata_serializer+]
|
|
|
|
# Whether to use the legacy metadata serializer, which serializes the
|
|
|
|
# message first, then wraps it in an envelope which is also serialized. This
|
|
|
|
# was the default in \Rails 7.0 and below.
|
|
|
|
#
|
|
|
|
# If you don't pass a truthy value, the default is set using
|
|
|
|
# +config.active_support.use_message_serializer_for_metadata+.
|
Unify Message{Encryptor,Verifier} serializer config
In #42843 and #42846, several config settings were added to control the
default serializer for `MessageEncryptor` and `MessageVerifier`, and to
provide a migration path from a default `Marshal` serializer to a
default `JSON` serializer:
* `config.active_support.default_message_encryptor_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.default_message_verifier_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.fallback_to_marshal_deserialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
* `config.active_support.use_marshal_serialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
This commit unifies those config settings into a single setting,
`config.active_support.message_serializer`, which supports `:marshal`,
`:json_allow_marshal`, and `:json` values. So, for example,
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = true
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json_allow_marshal
```
and
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json
```
This commit also replaces `ActiveSupport::JsonWithMarshalFallback` with
`ActiveSupport::Messages::SerializerWithFallback`, which implements a
generic mechanism for serializer fallback. The `:marshal` serializer
uses this mechanism too, so
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = true
```
becomes
```ruby
config.active_support.message_serializer = :marshal
```
Additionally, the logging behavior of `JsonWithMarshalFallback` has been
replaced with notifications which include the names of the intended and
actual serializers, as well as the serialized and deserialized message
data. This provides a more targeted means of tracking serializer
fallback events. It also allows the user to "silence" such events, if
desired, without an additional config setting.
All of these changes make it easier to add migration paths for new
serializers such as `ActiveSupport::MessagePack`.
2023-04-10 20:50:49 +00:00
|
|
|
def initialize(secret, **options)
|
2016-08-06 15:58:50 +00:00
|
|
|
raise ArgumentError, "Secret should not be nil." unless secret
|
Unify Message{Encryptor,Verifier} serializer config
In #42843 and #42846, several config settings were added to control the
default serializer for `MessageEncryptor` and `MessageVerifier`, and to
provide a migration path from a default `Marshal` serializer to a
default `JSON` serializer:
* `config.active_support.default_message_encryptor_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.default_message_verifier_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.fallback_to_marshal_deserialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
* `config.active_support.use_marshal_serialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
This commit unifies those config settings into a single setting,
`config.active_support.message_serializer`, which supports `:marshal`,
`:json_allow_marshal`, and `:json` values. So, for example,
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = true
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json_allow_marshal
```
and
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json
```
This commit also replaces `ActiveSupport::JsonWithMarshalFallback` with
`ActiveSupport::Messages::SerializerWithFallback`, which implements a
generic mechanism for serializer fallback. The `:marshal` serializer
uses this mechanism too, so
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = true
```
becomes
```ruby
config.active_support.message_serializer = :marshal
```
Additionally, the logging behavior of `JsonWithMarshalFallback` has been
replaced with notifications which include the names of the intended and
actual serializers, as well as the serialized and deserialized message
data. This provides a more targeted means of tracking serializer
fallback events. It also allows the user to "silence" such events, if
desired, without an additional config setting.
All of these changes make it easier to add migration paths for new
serializers such as `ActiveSupport::MessagePack`.
2023-04-10 20:50:49 +00:00
|
|
|
super(**options)
|
2008-11-23 14:29:11 +00:00
|
|
|
@secret = secret
|
Unify Message{Encryptor,Verifier} serializer config
In #42843 and #42846, several config settings were added to control the
default serializer for `MessageEncryptor` and `MessageVerifier`, and to
provide a migration path from a default `Marshal` serializer to a
default `JSON` serializer:
* `config.active_support.default_message_encryptor_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.default_message_verifier_serializer`
* Supports `:marshal`, `:hybrid`, or `:json`.
* `config.active_support.fallback_to_marshal_deserialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
* `config.active_support.use_marshal_serialization`
* Affects `:hybrid` for both `MessageEncryptor` and `MessageVerifier`.
This commit unifies those config settings into a single setting,
`config.active_support.message_serializer`, which supports `:marshal`,
`:json_allow_marshal`, and `:json` values. So, for example,
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = true
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json_allow_marshal
```
and
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = false
```
becomes
```ruby
config.active_support.message_serializer = :json
```
This commit also replaces `ActiveSupport::JsonWithMarshalFallback` with
`ActiveSupport::Messages::SerializerWithFallback`, which implements a
generic mechanism for serializer fallback. The `:marshal` serializer
uses this mechanism too, so
```ruby
config.active_support.default_message_encryptor_serializer = :hybrid
config.active_support.default_message_verifier_serializer = :hybrid
config.active_support.fallback_to_marshal_deserialization = false
config.active_support.use_marshal_serialization = true
```
becomes
```ruby
config.active_support.message_serializer = :marshal
```
Additionally, the logging behavior of `JsonWithMarshalFallback` has been
replaced with notifications which include the names of the intended and
actual serializers, as well as the serialized and deserialized message
data. This provides a more targeted means of tracking serializer
fallback events. It also allows the user to "silence" such events, if
desired, without an additional config setting.
All of these changes make it easier to add migration paths for new
serializers such as `ActiveSupport::MessagePack`.
2023-04-10 20:50:49 +00:00
|
|
|
@digest = options[:digest]&.to_s || "SHA1"
|
2008-11-23 14:29:11 +00:00
|
|
|
end
|
2010-08-14 05:13:00 +00:00
|
|
|
|
2014-12-04 02:00:32 +00:00
|
|
|
# Checks if a signed message could have been generated by signing an object
|
|
|
|
# with the +MessageVerifier+'s secret.
|
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# verifier = ActiveSupport::MessageVerifier.new("secret")
|
|
|
|
# signed_message = verifier.generate("signed message")
|
2014-12-04 02:00:32 +00:00
|
|
|
# verifier.valid_message?(signed_message) # => true
|
|
|
|
#
|
|
|
|
# tampered_message = signed_message.chop # editing the message invalidates the signature
|
|
|
|
# verifier.valid_message?(tampered_message) # => false
|
2023-02-07 19:51:28 +00:00
|
|
|
def valid_message?(message)
|
Use throw for message error handling control flow
There are multiple points of failure when processing a message with
`MessageEncryptor` or `MessageVerifier`, and there several ways we might
want to handle those failures. For example, swallowing a failure with
`MessageVerifier#verified`, or raising a specific exception with
`MessageVerifier#verify`, or conditionally ignoring a failure when
rotations are configured.
Prior to this commit, the _internal_ logic of handling failures was
implemented using a mix of `nil` return values and raised exceptions.
This commit reimplements the internal logic using `throw` and a few
precisely targeted `rescue`s. This accomplishes several things:
* Allow rotation of serializers for `MessageVerifier`. Previously,
errors from a `MessageVerifier`'s initial serializer were never
rescued. Thus, the serializer could not be rotated:
```ruby
old_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: Marshal)
new_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: JSON)
new_verifier.rotate(serializer: Marshal)
message = old_verifier.generate("message")
new_verifier.verify(message)
# BEFORE:
# => raises JSON::ParserError
# AFTER:
# => "message"
```
* Allow rotation of serializers for `MessageEncryptor` when using a
non-standard initial serializer. Similar to `MessageVerifier`, the
serializer could not be rotated when the initial serializer raised an
error other than `TypeError` or `JSON::ParserError`, such as
`Psych::SyntaxError` or a custom error.
* Raise `MessageEncryptor::InvalidMessage` from `decrypt_and_verify`
regardless of cipher. Previously, when a `MessageEncryptor` was using
a non-AEAD cipher such as AES-256-CBC, a corrupt or tampered message
would raise `MessageVerifier::InvalidSignature` due to reliance on
`MessageVerifier` for verification. Now, the verification mechanism
is transparent to the user:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-gcm")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-cbc")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
```
* Support `nil` original value when using `MessageVerifier#verify`.
Previously, `MessageVerifier#verify` did not work with `nil` original
values, though both `MessageVerifier#verified` and
`MessageEncryptor#decrypt_and_verify` do:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32)
message = encryptor.encrypt_and_sign(nil)
encryptor.decrypt_and_verify(message)
# => nil
verifier = ActiveSupport::MessageVerifier.new("secret")
message = verifier.generate(nil)
verifier.verified(message)
# => nil
verifier.verify(message)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => nil
```
* Improve performance of verifying a message when it has expired and one
or more rotations have been configured:
```ruby
# frozen_string_literal: true
require "benchmark/ips"
require "active_support/all"
verifier = ActiveSupport::MessageVerifier.new("new secret")
verifier.rotate("old secret")
message = verifier.generate({ "data" => "x" * 100 }, expires_at: 1.day.ago)
Benchmark.ips do |x|
x.report("expired message") do
verifier.verified(message)
end
end
```
__Before__
```
Warming up --------------------------------------
expired message 1.442k i/100ms
Calculating -------------------------------------
expired message 14.403k (± 1.7%) i/s - 72.100k in 5.007382s
```
__After__
```
Warming up --------------------------------------
expired message 1.995k i/100ms
Calculating -------------------------------------
expired message 19.992k (± 2.0%) i/s - 101.745k in 5.091421s
```
Fixes #47185.
2023-02-07 19:56:59 +00:00
|
|
|
!!catch_and_ignore(:invalid_message_format) { extract_encoded(message) }
|
2014-11-21 23:52:22 +00:00
|
|
|
end
|
|
|
|
|
2014-12-04 02:00:32 +00:00
|
|
|
# Decodes the signed message using the +MessageVerifier+'s secret.
|
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# verifier = ActiveSupport::MessageVerifier.new("secret")
|
2014-12-04 02:00:32 +00:00
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# signed_message = verifier.generate("signed message")
|
|
|
|
# verifier.verified(signed_message) # => "signed message"
|
2014-12-04 02:00:32 +00:00
|
|
|
#
|
|
|
|
# Returns +nil+ if the message was not signed with the same secret.
|
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# other_verifier = ActiveSupport::MessageVerifier.new("different_secret")
|
2014-12-04 16:09:47 +00:00
|
|
|
# other_verifier.verified(signed_message) # => nil
|
2014-12-04 02:00:32 +00:00
|
|
|
#
|
|
|
|
# Returns +nil+ if the message is not Base64-encoded.
|
|
|
|
#
|
|
|
|
# invalid_message = "f--46a0120593880c733a53b6dad75b42ddc1c8996d"
|
2014-12-04 16:09:47 +00:00
|
|
|
# verifier.verified(invalid_message) # => nil
|
2014-12-04 02:00:32 +00:00
|
|
|
#
|
|
|
|
# Raises any error raised while decoding the signed message.
|
|
|
|
#
|
|
|
|
# incompatible_message = "test--dad7b06c94abba8d46a15fafaef56c327665d5ff"
|
2014-12-04 16:09:47 +00:00
|
|
|
# verifier.verified(incompatible_message) # => TypeError: incompatible marshal file format
|
2023-02-07 22:31:44 +00:00
|
|
|
#
|
|
|
|
# ==== Options
|
|
|
|
#
|
|
|
|
# [+:purpose+]
|
|
|
|
# The purpose that the message was generated with. If the purpose does not
|
|
|
|
# match, +verified+ will return +nil+.
|
|
|
|
#
|
|
|
|
# message = verifier.generate("hello", purpose: "greeting")
|
|
|
|
# verifier.verified(message, purpose: "greeting") # => "hello"
|
|
|
|
# verifier.verified(message, purpose: "chatting") # => nil
|
|
|
|
# verifier.verified(message) # => nil
|
|
|
|
#
|
|
|
|
# message = verifier.generate("bye")
|
|
|
|
# verifier.verified(message) # => "bye"
|
|
|
|
# verifier.verified(message, purpose: "greeting") # => nil
|
|
|
|
#
|
2023-02-07 19:51:28 +00:00
|
|
|
def verified(message, **options)
|
Use throw for message error handling control flow
There are multiple points of failure when processing a message with
`MessageEncryptor` or `MessageVerifier`, and there several ways we might
want to handle those failures. For example, swallowing a failure with
`MessageVerifier#verified`, or raising a specific exception with
`MessageVerifier#verify`, or conditionally ignoring a failure when
rotations are configured.
Prior to this commit, the _internal_ logic of handling failures was
implemented using a mix of `nil` return values and raised exceptions.
This commit reimplements the internal logic using `throw` and a few
precisely targeted `rescue`s. This accomplishes several things:
* Allow rotation of serializers for `MessageVerifier`. Previously,
errors from a `MessageVerifier`'s initial serializer were never
rescued. Thus, the serializer could not be rotated:
```ruby
old_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: Marshal)
new_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: JSON)
new_verifier.rotate(serializer: Marshal)
message = old_verifier.generate("message")
new_verifier.verify(message)
# BEFORE:
# => raises JSON::ParserError
# AFTER:
# => "message"
```
* Allow rotation of serializers for `MessageEncryptor` when using a
non-standard initial serializer. Similar to `MessageVerifier`, the
serializer could not be rotated when the initial serializer raised an
error other than `TypeError` or `JSON::ParserError`, such as
`Psych::SyntaxError` or a custom error.
* Raise `MessageEncryptor::InvalidMessage` from `decrypt_and_verify`
regardless of cipher. Previously, when a `MessageEncryptor` was using
a non-AEAD cipher such as AES-256-CBC, a corrupt or tampered message
would raise `MessageVerifier::InvalidSignature` due to reliance on
`MessageVerifier` for verification. Now, the verification mechanism
is transparent to the user:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-gcm")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-cbc")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
```
* Support `nil` original value when using `MessageVerifier#verify`.
Previously, `MessageVerifier#verify` did not work with `nil` original
values, though both `MessageVerifier#verified` and
`MessageEncryptor#decrypt_and_verify` do:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32)
message = encryptor.encrypt_and_sign(nil)
encryptor.decrypt_and_verify(message)
# => nil
verifier = ActiveSupport::MessageVerifier.new("secret")
message = verifier.generate(nil)
verifier.verified(message)
# => nil
verifier.verify(message)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => nil
```
* Improve performance of verifying a message when it has expired and one
or more rotations have been configured:
```ruby
# frozen_string_literal: true
require "benchmark/ips"
require "active_support/all"
verifier = ActiveSupport::MessageVerifier.new("new secret")
verifier.rotate("old secret")
message = verifier.generate({ "data" => "x" * 100 }, expires_at: 1.day.ago)
Benchmark.ips do |x|
x.report("expired message") do
verifier.verified(message)
end
end
```
__Before__
```
Warming up --------------------------------------
expired message 1.442k i/100ms
Calculating -------------------------------------
expired message 14.403k (± 1.7%) i/s - 72.100k in 5.007382s
```
__After__
```
Warming up --------------------------------------
expired message 1.995k i/100ms
Calculating -------------------------------------
expired message 19.992k (± 2.0%) i/s - 101.745k in 5.091421s
```
Fixes #47185.
2023-02-07 19:56:59 +00:00
|
|
|
catch_and_ignore :invalid_message_format do
|
|
|
|
catch_and_raise :invalid_message_serialization do
|
|
|
|
catch_and_ignore :invalid_message_content do
|
|
|
|
read_message(message, **options)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2008-11-23 14:29:11 +00:00
|
|
|
end
|
2014-12-02 15:10:18 +00:00
|
|
|
|
2014-12-04 02:00:32 +00:00
|
|
|
# Decodes the signed message using the +MessageVerifier+'s secret.
|
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# verifier = ActiveSupport::MessageVerifier.new("secret")
|
|
|
|
# signed_message = verifier.generate("signed message")
|
2014-12-04 02:00:32 +00:00
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# verifier.verify(signed_message) # => "signed message"
|
2014-12-04 02:00:32 +00:00
|
|
|
#
|
|
|
|
# Raises +InvalidSignature+ if the message was not signed with the same
|
|
|
|
# secret or was not Base64-encoded.
|
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# other_verifier = ActiveSupport::MessageVerifier.new("different_secret")
|
2014-12-09 23:23:15 +00:00
|
|
|
# other_verifier.verify(signed_message) # => ActiveSupport::MessageVerifier::InvalidSignature
|
2023-02-07 22:31:44 +00:00
|
|
|
#
|
|
|
|
# ==== Options
|
|
|
|
#
|
|
|
|
# [+:purpose+]
|
|
|
|
# The purpose that the message was generated with. If the purpose does not
|
|
|
|
# match, +verify+ will raise ActiveSupport::MessageVerifier::InvalidSignature.
|
|
|
|
#
|
|
|
|
# message = verifier.generate("hello", purpose: "greeting")
|
|
|
|
# verifier.verify(message, purpose: "greeting") # => "hello"
|
|
|
|
# verifier.verify(message, purpose: "chatting") # => raises InvalidSignature
|
|
|
|
# verifier.verify(message) # => raises InvalidSignature
|
|
|
|
#
|
|
|
|
# message = verifier.generate("bye")
|
|
|
|
# verifier.verify(message) # => "bye"
|
|
|
|
# verifier.verify(message, purpose: "greeting") # => raises InvalidSignature
|
|
|
|
#
|
Use throw for message error handling control flow
There are multiple points of failure when processing a message with
`MessageEncryptor` or `MessageVerifier`, and there several ways we might
want to handle those failures. For example, swallowing a failure with
`MessageVerifier#verified`, or raising a specific exception with
`MessageVerifier#verify`, or conditionally ignoring a failure when
rotations are configured.
Prior to this commit, the _internal_ logic of handling failures was
implemented using a mix of `nil` return values and raised exceptions.
This commit reimplements the internal logic using `throw` and a few
precisely targeted `rescue`s. This accomplishes several things:
* Allow rotation of serializers for `MessageVerifier`. Previously,
errors from a `MessageVerifier`'s initial serializer were never
rescued. Thus, the serializer could not be rotated:
```ruby
old_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: Marshal)
new_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: JSON)
new_verifier.rotate(serializer: Marshal)
message = old_verifier.generate("message")
new_verifier.verify(message)
# BEFORE:
# => raises JSON::ParserError
# AFTER:
# => "message"
```
* Allow rotation of serializers for `MessageEncryptor` when using a
non-standard initial serializer. Similar to `MessageVerifier`, the
serializer could not be rotated when the initial serializer raised an
error other than `TypeError` or `JSON::ParserError`, such as
`Psych::SyntaxError` or a custom error.
* Raise `MessageEncryptor::InvalidMessage` from `decrypt_and_verify`
regardless of cipher. Previously, when a `MessageEncryptor` was using
a non-AEAD cipher such as AES-256-CBC, a corrupt or tampered message
would raise `MessageVerifier::InvalidSignature` due to reliance on
`MessageVerifier` for verification. Now, the verification mechanism
is transparent to the user:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-gcm")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-cbc")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
```
* Support `nil` original value when using `MessageVerifier#verify`.
Previously, `MessageVerifier#verify` did not work with `nil` original
values, though both `MessageVerifier#verified` and
`MessageEncryptor#decrypt_and_verify` do:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32)
message = encryptor.encrypt_and_sign(nil)
encryptor.decrypt_and_verify(message)
# => nil
verifier = ActiveSupport::MessageVerifier.new("secret")
message = verifier.generate(nil)
verifier.verified(message)
# => nil
verifier.verify(message)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => nil
```
* Improve performance of verifying a message when it has expired and one
or more rotations have been configured:
```ruby
# frozen_string_literal: true
require "benchmark/ips"
require "active_support/all"
verifier = ActiveSupport::MessageVerifier.new("new secret")
verifier.rotate("old secret")
message = verifier.generate({ "data" => "x" * 100 }, expires_at: 1.day.ago)
Benchmark.ips do |x|
x.report("expired message") do
verifier.verified(message)
end
end
```
__Before__
```
Warming up --------------------------------------
expired message 1.442k i/100ms
Calculating -------------------------------------
expired message 14.403k (± 1.7%) i/s - 72.100k in 5.007382s
```
__After__
```
Warming up --------------------------------------
expired message 1.995k i/100ms
Calculating -------------------------------------
expired message 19.992k (± 2.0%) i/s - 101.745k in 5.091421s
```
Fixes #47185.
2023-02-07 19:56:59 +00:00
|
|
|
def verify(message, **options)
|
|
|
|
catch_and_raise :invalid_message_format, as: InvalidSignature do
|
|
|
|
catch_and_raise :invalid_message_serialization do
|
|
|
|
catch_and_raise :invalid_message_content, as: InvalidSignature do
|
|
|
|
read_message(message, **options)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2014-11-21 23:52:22 +00:00
|
|
|
end
|
2010-08-14 05:13:00 +00:00
|
|
|
|
2014-12-04 02:00:32 +00:00
|
|
|
# Generates a signed message for the provided value.
|
|
|
|
#
|
2019-07-10 15:39:26 +00:00
|
|
|
# The message is signed with the +MessageVerifier+'s secret.
|
|
|
|
# Returns Base64-encoded message joined with the generated signature.
|
2014-12-04 02:00:32 +00:00
|
|
|
#
|
2022-02-04 16:03:25 +00:00
|
|
|
# verifier = ActiveSupport::MessageVerifier.new("secret")
|
|
|
|
# verifier.generate("signed message") # => "BAhJIhNzaWduZWQgbWVzc2FnZQY6BkVU--f67d5f27c3ee0b8483cebf2103757455e947493b"
|
2023-02-07 22:31:44 +00:00
|
|
|
#
|
|
|
|
# ==== Options
|
|
|
|
#
|
|
|
|
# [+:expires_at+]
|
|
|
|
# The datetime at which the message expires. After this datetime,
|
|
|
|
# verification of the message will fail.
|
|
|
|
#
|
|
|
|
# message = verifier.generate("hello", expires_at: Time.now.tomorrow)
|
|
|
|
# verifier.verified(message) # => "hello"
|
|
|
|
# # 24 hours later...
|
|
|
|
# verifier.verified(message) # => nil
|
|
|
|
# verifier.verify(message) # => raises ActiveSupport::MessageVerifier::InvalidSignature
|
|
|
|
#
|
|
|
|
# [+:expires_in+]
|
|
|
|
# The duration for which the message is valid. After this duration has
|
|
|
|
# elapsed, verification of the message will fail.
|
|
|
|
#
|
|
|
|
# message = verifier.generate("hello", expires_in: 24.hours)
|
|
|
|
# verifier.verified(message) # => "hello"
|
|
|
|
# # 24 hours later...
|
|
|
|
# verifier.verified(message) # => nil
|
|
|
|
# verifier.verify(message) # => raises ActiveSupport::MessageVerifier::InvalidSignature
|
|
|
|
#
|
|
|
|
# [+:purpose+]
|
|
|
|
# The purpose of the message. If specified, the same purpose must be
|
|
|
|
# specified when verifying the message; otherwise, verification will fail.
|
|
|
|
# (See #verified and #verify.)
|
2023-02-07 19:51:28 +00:00
|
|
|
def generate(value, **options)
|
Use throw for message error handling control flow
There are multiple points of failure when processing a message with
`MessageEncryptor` or `MessageVerifier`, and there several ways we might
want to handle those failures. For example, swallowing a failure with
`MessageVerifier#verified`, or raising a specific exception with
`MessageVerifier#verify`, or conditionally ignoring a failure when
rotations are configured.
Prior to this commit, the _internal_ logic of handling failures was
implemented using a mix of `nil` return values and raised exceptions.
This commit reimplements the internal logic using `throw` and a few
precisely targeted `rescue`s. This accomplishes several things:
* Allow rotation of serializers for `MessageVerifier`. Previously,
errors from a `MessageVerifier`'s initial serializer were never
rescued. Thus, the serializer could not be rotated:
```ruby
old_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: Marshal)
new_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: JSON)
new_verifier.rotate(serializer: Marshal)
message = old_verifier.generate("message")
new_verifier.verify(message)
# BEFORE:
# => raises JSON::ParserError
# AFTER:
# => "message"
```
* Allow rotation of serializers for `MessageEncryptor` when using a
non-standard initial serializer. Similar to `MessageVerifier`, the
serializer could not be rotated when the initial serializer raised an
error other than `TypeError` or `JSON::ParserError`, such as
`Psych::SyntaxError` or a custom error.
* Raise `MessageEncryptor::InvalidMessage` from `decrypt_and_verify`
regardless of cipher. Previously, when a `MessageEncryptor` was using
a non-AEAD cipher such as AES-256-CBC, a corrupt or tampered message
would raise `MessageVerifier::InvalidSignature` due to reliance on
`MessageVerifier` for verification. Now, the verification mechanism
is transparent to the user:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-gcm")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-cbc")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
```
* Support `nil` original value when using `MessageVerifier#verify`.
Previously, `MessageVerifier#verify` did not work with `nil` original
values, though both `MessageVerifier#verified` and
`MessageEncryptor#decrypt_and_verify` do:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32)
message = encryptor.encrypt_and_sign(nil)
encryptor.decrypt_and_verify(message)
# => nil
verifier = ActiveSupport::MessageVerifier.new("secret")
message = verifier.generate(nil)
verifier.verified(message)
# => nil
verifier.verify(message)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => nil
```
* Improve performance of verifying a message when it has expired and one
or more rotations have been configured:
```ruby
# frozen_string_literal: true
require "benchmark/ips"
require "active_support/all"
verifier = ActiveSupport::MessageVerifier.new("new secret")
verifier.rotate("old secret")
message = verifier.generate({ "data" => "x" * 100 }, expires_at: 1.day.ago)
Benchmark.ips do |x|
x.report("expired message") do
verifier.verified(message)
end
end
```
__Before__
```
Warming up --------------------------------------
expired message 1.442k i/100ms
Calculating -------------------------------------
expired message 14.403k (± 1.7%) i/s - 72.100k in 5.007382s
```
__After__
```
Warming up --------------------------------------
expired message 1.995k i/100ms
Calculating -------------------------------------
expired message 19.992k (± 2.0%) i/s - 101.745k in 5.091421s
```
Fixes #47185.
2023-02-07 19:56:59 +00:00
|
|
|
create_message(value, **options)
|
|
|
|
end
|
|
|
|
|
|
|
|
def create_message(value, **options) # :nodoc:
|
2023-02-07 19:51:28 +00:00
|
|
|
sign_encoded(encode(serialize_with_metadata(value, **options)))
|
2008-11-23 14:29:11 +00:00
|
|
|
end
|
2010-08-14 05:13:00 +00:00
|
|
|
|
Use throw for message error handling control flow
There are multiple points of failure when processing a message with
`MessageEncryptor` or `MessageVerifier`, and there several ways we might
want to handle those failures. For example, swallowing a failure with
`MessageVerifier#verified`, or raising a specific exception with
`MessageVerifier#verify`, or conditionally ignoring a failure when
rotations are configured.
Prior to this commit, the _internal_ logic of handling failures was
implemented using a mix of `nil` return values and raised exceptions.
This commit reimplements the internal logic using `throw` and a few
precisely targeted `rescue`s. This accomplishes several things:
* Allow rotation of serializers for `MessageVerifier`. Previously,
errors from a `MessageVerifier`'s initial serializer were never
rescued. Thus, the serializer could not be rotated:
```ruby
old_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: Marshal)
new_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: JSON)
new_verifier.rotate(serializer: Marshal)
message = old_verifier.generate("message")
new_verifier.verify(message)
# BEFORE:
# => raises JSON::ParserError
# AFTER:
# => "message"
```
* Allow rotation of serializers for `MessageEncryptor` when using a
non-standard initial serializer. Similar to `MessageVerifier`, the
serializer could not be rotated when the initial serializer raised an
error other than `TypeError` or `JSON::ParserError`, such as
`Psych::SyntaxError` or a custom error.
* Raise `MessageEncryptor::InvalidMessage` from `decrypt_and_verify`
regardless of cipher. Previously, when a `MessageEncryptor` was using
a non-AEAD cipher such as AES-256-CBC, a corrupt or tampered message
would raise `MessageVerifier::InvalidSignature` due to reliance on
`MessageVerifier` for verification. Now, the verification mechanism
is transparent to the user:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-gcm")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-cbc")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
```
* Support `nil` original value when using `MessageVerifier#verify`.
Previously, `MessageVerifier#verify` did not work with `nil` original
values, though both `MessageVerifier#verified` and
`MessageEncryptor#decrypt_and_verify` do:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32)
message = encryptor.encrypt_and_sign(nil)
encryptor.decrypt_and_verify(message)
# => nil
verifier = ActiveSupport::MessageVerifier.new("secret")
message = verifier.generate(nil)
verifier.verified(message)
# => nil
verifier.verify(message)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => nil
```
* Improve performance of verifying a message when it has expired and one
or more rotations have been configured:
```ruby
# frozen_string_literal: true
require "benchmark/ips"
require "active_support/all"
verifier = ActiveSupport::MessageVerifier.new("new secret")
verifier.rotate("old secret")
message = verifier.generate({ "data" => "x" * 100 }, expires_at: 1.day.ago)
Benchmark.ips do |x|
x.report("expired message") do
verifier.verified(message)
end
end
```
__Before__
```
Warming up --------------------------------------
expired message 1.442k i/100ms
Calculating -------------------------------------
expired message 14.403k (± 1.7%) i/s - 72.100k in 5.007382s
```
__After__
```
Warming up --------------------------------------
expired message 1.995k i/100ms
Calculating -------------------------------------
expired message 19.992k (± 2.0%) i/s - 101.745k in 5.091421s
```
Fixes #47185.
2023-02-07 19:56:59 +00:00
|
|
|
def read_message(message, **options) # :nodoc:
|
|
|
|
deserialize_with_metadata(decode(extract_encoded(message)), **options)
|
|
|
|
end
|
|
|
|
|
2023-07-06 19:51:22 +00:00
|
|
|
def inspect # :nodoc:
|
|
|
|
"#<#{self.class.name}:#{'%#016x' % (object_id << 1)}>"
|
|
|
|
end
|
|
|
|
|
2008-11-23 14:29:11 +00:00
|
|
|
private
|
2023-02-07 19:51:28 +00:00
|
|
|
def sign_encoded(encoded)
|
|
|
|
digest = generate_digest(encoded)
|
|
|
|
encoded << SEPARATOR << digest
|
2014-11-12 22:48:44 +00:00
|
|
|
end
|
|
|
|
|
2023-02-07 19:51:28 +00:00
|
|
|
def extract_encoded(signed)
|
Use throw for message error handling control flow
There are multiple points of failure when processing a message with
`MessageEncryptor` or `MessageVerifier`, and there several ways we might
want to handle those failures. For example, swallowing a failure with
`MessageVerifier#verified`, or raising a specific exception with
`MessageVerifier#verify`, or conditionally ignoring a failure when
rotations are configured.
Prior to this commit, the _internal_ logic of handling failures was
implemented using a mix of `nil` return values and raised exceptions.
This commit reimplements the internal logic using `throw` and a few
precisely targeted `rescue`s. This accomplishes several things:
* Allow rotation of serializers for `MessageVerifier`. Previously,
errors from a `MessageVerifier`'s initial serializer were never
rescued. Thus, the serializer could not be rotated:
```ruby
old_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: Marshal)
new_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: JSON)
new_verifier.rotate(serializer: Marshal)
message = old_verifier.generate("message")
new_verifier.verify(message)
# BEFORE:
# => raises JSON::ParserError
# AFTER:
# => "message"
```
* Allow rotation of serializers for `MessageEncryptor` when using a
non-standard initial serializer. Similar to `MessageVerifier`, the
serializer could not be rotated when the initial serializer raised an
error other than `TypeError` or `JSON::ParserError`, such as
`Psych::SyntaxError` or a custom error.
* Raise `MessageEncryptor::InvalidMessage` from `decrypt_and_verify`
regardless of cipher. Previously, when a `MessageEncryptor` was using
a non-AEAD cipher such as AES-256-CBC, a corrupt or tampered message
would raise `MessageVerifier::InvalidSignature` due to reliance on
`MessageVerifier` for verification. Now, the verification mechanism
is transparent to the user:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-gcm")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-cbc")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
```
* Support `nil` original value when using `MessageVerifier#verify`.
Previously, `MessageVerifier#verify` did not work with `nil` original
values, though both `MessageVerifier#verified` and
`MessageEncryptor#decrypt_and_verify` do:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32)
message = encryptor.encrypt_and_sign(nil)
encryptor.decrypt_and_verify(message)
# => nil
verifier = ActiveSupport::MessageVerifier.new("secret")
message = verifier.generate(nil)
verifier.verified(message)
# => nil
verifier.verify(message)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => nil
```
* Improve performance of verifying a message when it has expired and one
or more rotations have been configured:
```ruby
# frozen_string_literal: true
require "benchmark/ips"
require "active_support/all"
verifier = ActiveSupport::MessageVerifier.new("new secret")
verifier.rotate("old secret")
message = verifier.generate({ "data" => "x" * 100 }, expires_at: 1.day.ago)
Benchmark.ips do |x|
x.report("expired message") do
verifier.verified(message)
end
end
```
__Before__
```
Warming up --------------------------------------
expired message 1.442k i/100ms
Calculating -------------------------------------
expired message 14.403k (± 1.7%) i/s - 72.100k in 5.007382s
```
__After__
```
Warming up --------------------------------------
expired message 1.995k i/100ms
Calculating -------------------------------------
expired message 19.992k (± 2.0%) i/s - 101.745k in 5.091421s
```
Fixes #47185.
2023-02-07 19:56:59 +00:00
|
|
|
if signed.nil? || !signed.valid_encoding?
|
|
|
|
throw :invalid_message_format, "invalid message string"
|
|
|
|
end
|
2023-02-07 19:51:28 +00:00
|
|
|
|
|
|
|
if separator_index = separator_index_for(signed)
|
|
|
|
encoded = signed[0, separator_index]
|
|
|
|
digest = signed[separator_index + SEPARATOR_LENGTH, digest_length_in_hex]
|
|
|
|
end
|
|
|
|
|
Use throw for message error handling control flow
There are multiple points of failure when processing a message with
`MessageEncryptor` or `MessageVerifier`, and there several ways we might
want to handle those failures. For example, swallowing a failure with
`MessageVerifier#verified`, or raising a specific exception with
`MessageVerifier#verify`, or conditionally ignoring a failure when
rotations are configured.
Prior to this commit, the _internal_ logic of handling failures was
implemented using a mix of `nil` return values and raised exceptions.
This commit reimplements the internal logic using `throw` and a few
precisely targeted `rescue`s. This accomplishes several things:
* Allow rotation of serializers for `MessageVerifier`. Previously,
errors from a `MessageVerifier`'s initial serializer were never
rescued. Thus, the serializer could not be rotated:
```ruby
old_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: Marshal)
new_verifier = ActiveSupport::MessageVerifier.new("secret", serializer: JSON)
new_verifier.rotate(serializer: Marshal)
message = old_verifier.generate("message")
new_verifier.verify(message)
# BEFORE:
# => raises JSON::ParserError
# AFTER:
# => "message"
```
* Allow rotation of serializers for `MessageEncryptor` when using a
non-standard initial serializer. Similar to `MessageVerifier`, the
serializer could not be rotated when the initial serializer raised an
error other than `TypeError` or `JSON::ParserError`, such as
`Psych::SyntaxError` or a custom error.
* Raise `MessageEncryptor::InvalidMessage` from `decrypt_and_verify`
regardless of cipher. Previously, when a `MessageEncryptor` was using
a non-AEAD cipher such as AES-256-CBC, a corrupt or tampered message
would raise `MessageVerifier::InvalidSignature` due to reliance on
`MessageVerifier` for verification. Now, the verification mechanism
is transparent to the user:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-gcm")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32, cipher: "aes-256-cbc")
message = encryptor.encrypt_and_sign("message")
encryptor.decrypt_and_verify(message.next)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => raises ActiveSupport::MessageEncryptor::InvalidMessage
```
* Support `nil` original value when using `MessageVerifier#verify`.
Previously, `MessageVerifier#verify` did not work with `nil` original
values, though both `MessageVerifier#verified` and
`MessageEncryptor#decrypt_and_verify` do:
```ruby
encryptor = ActiveSupport::MessageEncryptor.new("x" * 32)
message = encryptor.encrypt_and_sign(nil)
encryptor.decrypt_and_verify(message)
# => nil
verifier = ActiveSupport::MessageVerifier.new("secret")
message = verifier.generate(nil)
verifier.verified(message)
# => nil
verifier.verify(message)
# BEFORE:
# => raises ActiveSupport::MessageVerifier::InvalidSignature
# AFTER:
# => nil
```
* Improve performance of verifying a message when it has expired and one
or more rotations have been configured:
```ruby
# frozen_string_literal: true
require "benchmark/ips"
require "active_support/all"
verifier = ActiveSupport::MessageVerifier.new("new secret")
verifier.rotate("old secret")
message = verifier.generate({ "data" => "x" * 100 }, expires_at: 1.day.ago)
Benchmark.ips do |x|
x.report("expired message") do
verifier.verified(message)
end
end
```
__Before__
```
Warming up --------------------------------------
expired message 1.442k i/100ms
Calculating -------------------------------------
expired message 14.403k (± 1.7%) i/s - 72.100k in 5.007382s
```
__After__
```
Warming up --------------------------------------
expired message 1.995k i/100ms
Calculating -------------------------------------
expired message 19.992k (± 2.0%) i/s - 101.745k in 5.091421s
```
Fixes #47185.
2023-02-07 19:56:59 +00:00
|
|
|
unless digest_matches_data?(digest, encoded)
|
|
|
|
throw :invalid_message_format, "mismatched digest"
|
|
|
|
end
|
2023-02-07 19:51:28 +00:00
|
|
|
|
|
|
|
encoded
|
2014-11-12 22:48:44 +00:00
|
|
|
end
|
|
|
|
|
2008-11-23 14:29:11 +00:00
|
|
|
def generate_digest(data)
|
2021-07-30 09:12:42 +00:00
|
|
|
OpenSSL::HMAC.hexdigest(@digest, @secret, data)
|
|
|
|
end
|
|
|
|
|
|
|
|
def digest_length_in_hex
|
|
|
|
# In hexadecimal (AKA base16) it takes 4 bits to represent a character,
|
|
|
|
# hence we multiply the digest's length (in bytes) by 8 to get it in
|
|
|
|
# bits and divide by 4 to get its number of characters it hex. Well, 8
|
|
|
|
# divided by 4 is 2.
|
|
|
|
@digest_length_in_hex ||= OpenSSL::Digest.new(@digest).digest_length * 2
|
|
|
|
end
|
|
|
|
|
2021-09-01 21:28:33 +00:00
|
|
|
def separator_at?(signed_message, index)
|
|
|
|
signed_message[index, SEPARATOR_LENGTH] == SEPARATOR
|
|
|
|
end
|
|
|
|
|
2021-07-30 09:12:42 +00:00
|
|
|
def separator_index_for(signed_message)
|
|
|
|
index = signed_message.length - digest_length_in_hex - SEPARATOR_LENGTH
|
2023-02-07 19:51:28 +00:00
|
|
|
index unless index.negative? || !separator_at?(signed_message, index)
|
2021-07-30 09:12:42 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def digest_matches_data?(digest, data)
|
|
|
|
data.present? && digest.present? && ActiveSupport::SecurityUtils.secure_compare(digest, generate_digest(data))
|
2008-11-23 14:29:11 +00:00
|
|
|
end
|
|
|
|
end
|
2008-11-23 23:29:03 +00:00
|
|
|
end
|