instance method `signed`

Ruby on Rails 4.0.13

Since v4.0.13

Available in: v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

signed()

Returns a jar that’ll automatically generate a signed representation of cookie value and verify it when reading from the cookie again. This is useful for creating cookies with values that the user is not supposed to change. If a signed cookie was tampered with by the user (or a 3rd party), nil will be returned.

If config.secret_key_base and config.secret_token (deprecated) are both set, legacy cookies signed with the old key generator will be transparently upgraded.

This jar requires that you set a suitable secret for the verification on your app’s config.secret_key_base.

Example:

cookies.signed[:discount] = 45
# => Set-Cookie: discount=BAhpMg==--2c1c6906c90a3bc4fd54a51ffb41dffa4bf6b5f7; path=/

cookies.signed[:discount] # => 45

Source

# File actionpack/lib/action_dispatch/middleware/cookies.rb, line 131
      def signed
        @signed ||=
          if @options[:upgrade_legacy_signed_cookies]
            UpgradeLegacySignedCookieJar.new(self, @key_generator, @options)
          else
            SignedCookieJar.new(self, @key_generator, @options)
          end
      end

Defined in actionpack/lib/action_dispatch/middleware/cookies.rb line 131 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActionDispatch::Cookies::ChainedCookieJars

Signature