Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Documentation For Duration Support & Expiry Meta Data Added to Signed / Encrypted Cookies #30407

Merged
merged 1 commit into from
Sep 4, 2017
Merged

Add Documentation For Duration Support & Expiry Meta Data Added to Signed / Encrypted Cookies #30407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions actionpack/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
* Cookies `:expires` option supports `ActiveSupport::Duration` object.

cookies[:user_name] = { value: "assain", expires: 1.hour }
cookies[:key] = { value: "a yummy cookie", expires: 6.months }

Pull Request: #30121

*Assain Jaleel*

* Enforce signed/encrypted cookie expiry server side.

Rails can thwart attacks by malicious clients that don't honor a cookie's expiry.

It does so by stashing the expiry within the written cookie and relying on the
signing/encrypting to vouch that it hasn't been tampered with. Then on a
server-side read, the expiry is verified and any expired cookie is discarded.

Pull Request: #30121

*Assain Jaleel*

* Make `take_failed_screenshot` work within engine.

Fixes #30405.
Expand Down
11 changes: 7 additions & 4 deletions actionpack/lib/action_dispatch/middleware/cookies.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,10 @@ def cookies_digest
# cookies[:lat_lon] = JSON.generate([47.68, -122.37])
#
# # Sets a cookie that expires in 1 hour.
# cookies[:login] = { value: "XJ-122", expires: 1.hour.from_now }
# cookies[:login] = { value: "XJ-122", expires: 1.hour }
#
# # Sets a cookie that expires at a specific time.
# cookies[:login] = { value: "XJ-122", expires: Time.utc(2020, 10, 15, 5) }
#
# # Sets a signed cookie, which prevents users from tampering with its value.
# # The cookie is signed by your app's `secrets.secret_key_base` value.
Expand All @@ -100,7 +103,7 @@ def cookies_digest
# cookies.permanent[:login] = "XJ-122"
#
# # You can also chain these methods:
# cookies.permanent.signed[:login] = "XJ-122"
# cookies.signed.permanent[:login] = "XJ-122"
#
Copy link
Contributor Author

@assain assain Aug 25, 2017 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kaspth Is it alright if I make this change? 😄

# Examples of reading:
#
Expand All @@ -118,7 +121,7 @@ def cookies_digest
#
# cookies[:name] = {
# value: 'a yummy cookie',
# expires: 1.year.from_now,
# expires: 1.year,
# domain: 'domain.com'
# }
#
Expand All @@ -144,7 +147,7 @@ def cookies_digest
# * <tt>:tld_length</tt> - When using <tt>:domain => :all</tt>, this option can be used to explicitly
# set the TLD length when using a short (<= 3 character) domain that is being interpreted as part of a TLD.
# For example, to share cookies between user1.lvh.me and user2.lvh.me, set <tt>:tld_length</tt> to 1.
# * <tt>:expires</tt> - The time at which this cookie expires, as a \Time object.
# * <tt>:expires</tt> - The time at which this cookie expires, as a \Time or ActiveSupport::Duration object.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this link to the duration class when the doc is generated?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the generated docs do indeed link to the duration class 😄

getimage 1

# * <tt>:secure</tt> - Whether this cookie is only transmitted to HTTPS servers.
# Default is +false+.
# * <tt>:httponly</tt> - Whether this cookie is accessible via scripting or
Expand Down