Skip to content

Commit

Permalink
[ci skip] Correct defaults in documentation for ActionDispatch::SSL
Browse files Browse the repository at this point in the history
`config.ssl_options` permits configuring various options for the middleware. Default options for HSTS (specified with the `:hsts` key in the options hash) are specified in `.default_hsts_options`. The documentation did not make clear these defaults, and in one case was wrong.
  • Loading branch information
Tim Rogers committed Jul 6, 2016
1 parent 6038a54 commit 8a12c7c
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions actionpack/lib/action_dispatch/middleware/ssl.rb
Expand Up @@ -18,17 +18,18 @@ module ActionDispatch
# Enabled by default. Configure `config.ssl_options` with `hsts: false` to disable.
#
# Set `config.ssl_options` with `hsts: { … }` to configure HSTS:
# * `expires`: How long, in seconds, these settings will stick. Defaults to
# `180.days` (recommended). The minimum required to qualify for browser
# preload lists is `18.weeks`.
# * `expires`: How long, in seconds, these settings will stick. The minimum
# required to qualify for browser preload lists is `18.weeks`. Defaults to
# `180.days` (recommended).
# * `subdomains`: Set to `true` to tell the browser to apply these settings
# to all subdomains. This protects your cookies from interception by a
# vulnerable site on a subdomain. Defaults to `true`.
# vulnerable site on a subdomain. Defaults to `false`.
# * `preload`: Advertise that this site may be included in browsers'
# preloaded HSTS lists. HSTS protects your site on every visit *except the
# first visit* since it hasn't seen your HSTS header yet. To close this
# gap, browser vendors include a baked-in list of HSTS-enabled sites.
# Go to https://hstspreload.appspot.com to submit your site for inclusion.
# Defaults to `false`.
#
# To turn off HSTS, omitting the header is not enough. Browsers will remember the
# original HSTS directive until it expires. Instead, use the header to tell browsers to
Expand Down

0 comments on commit 8a12c7c

Please sign in to comment.