aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source/4_1_release_notes.md
diff options
context:
space:
mode:
authorXavier Noria <fxn@hashref.com>2013-12-19 20:01:24 +0100
committerXavier Noria <fxn@hashref.com>2013-12-19 20:01:24 +0100
commit87fc20a4aa4e0eddce0c418d73690b4e51ca47bd (patch)
tree20a1eb27250e5944f896d8ecdfebb039abe2b346 /guides/source/4_1_release_notes.md
parentd0829f46db6721015ded0955bbdf55309fff266c (diff)
downloadrails-87fc20a4aa4e0eddce0c418d73690b4e51ca47bd.tar.gz
rails-87fc20a4aa4e0eddce0c418d73690b4e51ca47bd.tar.bz2
rails-87fc20a4aa4e0eddce0c418d73690b4e51ca47bd.zip
revises the release notes about message verifiers (second take) [ci skip]
Diffstat (limited to 'guides/source/4_1_release_notes.md')
-rw-r--r--guides/source/4_1_release_notes.md19
1 files changed, 11 insertions, 8 deletions
diff --git a/guides/source/4_1_release_notes.md b/guides/source/4_1_release_notes.md
index 40ab1a1d33..1ff9ae4aa8 100644
--- a/guides/source/4_1_release_notes.md
+++ b/guides/source/4_1_release_notes.md
@@ -181,18 +181,21 @@ See its
[documentation](http://api.rubyonrails.org/v4.1.0/classes/ActiveRecord/Enum.html)
for a detailed write up.
-### Application Message Verifier
+### Message Verifiers
-The application message verifier can be used to generate and verify signed
-messages in the application. This can be useful for remember-me tokens and
-friends:
+Message verifiers can be used to generate and verify signed messages. This can
+be useful to safely transport sensitive data like remember-me tokens and
+friends.
+
+The method `Rails.application.message_verifier` returns a new message verifier
+that signs messages with a key derived from secret_key_base and the given
+message verifier name:
```ruby
-signed_message = Rails.application.message_verifier('salt').generate('my sensible data')
-Rails.application.message_verifier('salt').verify(signed_message)
-# => 'my sensible data'
+signed_token = Rails.application.message_verifier(:remember_me).generate(token)
+Rails.application.message_verifier(:remember_me).verify(signed_token) # => token
-Rails.application.message_verifier('salt').verify(tampered_message)
+Rails.application.message_verifier(:remember_me).verify(tampered_token)
# raises ActiveSupport::MessageVerifier::InvalidSignature
```