method
verified
Ruby on Rails latest stable (v7.1.3.2)
-
0 notes -
Class: ActiveSupport::MessageVerifier
- 1.0.0
- 1.1.6
- 1.2.6
- 2.0.3
- 2.1.0
- 2.2.1
- 2.3.8
- 3.0.0
- 3.0.9
- 3.1.0
- 3.2.1
- 3.2.8
- 3.2.13
- 4.0.2
- 4.1.8
- 4.2.1
- 4.2.7
- 4.2.9
- 5.0.0.1 (0)
- 5.1.7 (0)
- 5.2.3 (0)
- 6.0.0 (0)
- 6.1.3.1 (0)
- 6.1.7.7 (0)
- 7.0.0 (0)
- 7.1.3.2 (38)
- 7.1.3.4 (0)
- What's this?
verified(message, **options)
public
Decodes the signed message using the MessageVerifier's secret.
verifier = ActiveSupport::MessageVerifier.new("secret") signed_message = verifier.generate("signed message") verifier.verified(signed_message) # => "signed message"
Returns nil if the message was not signed with the same secret.
other_verifier = ActiveSupport::MessageVerifier.new("different_secret") other_verifier.verified(signed_message) # => nil
Returns nil if the message is not Base64-encoded.
invalid_message = "f--46a0120593880c733a53b6dad75b42ddc1c8996d" verifier.verified(invalid_message) # => nil
Raises any error raised while decoding the signed message.
incompatible_message = "test--dad7b06c94abba8d46a15fafaef56c327665d5ff" verifier.verified(incompatible_message) # => TypeError: incompatible marshal file format
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