summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Pope <nick.pope@flightdataservices.com>2018-06-25 14:21:21 +0100
committerTim Graham <timograham@gmail.com>2019-03-27 11:11:24 -0400
commitd7876fc9998452e867d9ef49cc7f5d37b5bce6e4 (patch)
tree8463c78fc4c2333d2a94b0ec6efd6bbc6bc06923 /docs
parentc04bd386d456af588be431fa7f0b69430d840892 (diff)
downloaddjango-d7876fc9998452e867d9ef49cc7f5d37b5bce6e4.tar.gz
[2.2.x] Updated spelling and RFCs in HttpOnly cookie flag docs.
Backport of 398afba084679f1055926f6f91bd33fe124a92c5 from master.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/request-response.txt10
-rw-r--r--docs/ref/settings.txt16
-rw-r--r--docs/releases/1.3.txt4
3 files changed, 13 insertions, 17 deletions
diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt
index 0c8067c66d..3ab17c08aa 100644
--- a/docs/ref/request-response.txt
+++ b/docs/ref/request-response.txt
@@ -804,11 +804,9 @@ Methods
* Use ``httponly=True`` if you want to prevent client-side
JavaScript from having access to the cookie.
- HTTPOnly_ is a flag included in a Set-Cookie HTTP response
- header. It is not part of the :rfc:`2109` standard for cookies,
- and it isn't honored consistently by all browsers. However,
- when it is honored, it can be a useful way to mitigate the
- risk of a client-side script from accessing the protected cookie
+ HttpOnly_ is a flag included in a Set-Cookie HTTP response header. It's
+ part of the :rfc:`6265` standard for cookies and can be a useful way to
+ mitigate the risk of a client-side script accessing the protected cookie
data.
* Use ``samesite='Strict'`` or ``samesite='Lax'`` to tell the browser not
to send this cookie when performing a cross-origin request. `SameSite`_
@@ -819,7 +817,7 @@ Methods
The ``samesite`` argument was added.
- .. _HTTPOnly: https://www.owasp.org/index.php/HTTPOnly
+ .. _HttpOnly: https://www.owasp.org/index.php/HttpOnly
.. _SameSite: https://www.owasp.org/index.php/SameSite
.. warning::
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index fa3cc160f7..5ad7846d6a 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -2999,22 +2999,20 @@ This setting also affects cookies set by :mod:`django.contrib.messages`.
Default: ``True``
-Whether to use ``HTTPOnly`` flag on the session cookie. If this is set to
-``True``, client-side JavaScript will not to be able to access the
-session cookie.
+Whether to use ``HttpOnly`` flag on the session cookie. If this is set to
+``True``, client-side JavaScript will not to be able to access the session
+cookie.
-HTTPOnly_ is a flag included in a Set-Cookie HTTP response header. It
-is not part of the :rfc:`2109` standard for cookies, and it isn't honored
-consistently by all browsers. However, when it is honored, it can be a
-useful way to mitigate the risk of a client side script accessing the
-protected cookie data.
+HttpOnly_ is a flag included in a Set-Cookie HTTP response header. It's part of
+the :rfc:`6265` standard for cookies and can be a useful way to mitigate the
+risk of a client-side script accessing the protected cookie data.
This makes it less trivial for an attacker to escalate a cross-site scripting
vulnerability into full hijacking of a user's session. There aren't many good
reasons for turning this off. Your code shouldn't read session cookies from
JavaScript.
-.. _HTTPOnly: https://www.owasp.org/index.php/HTTPOnly
+.. _HttpOnly: https://www.owasp.org/index.php/HttpOnly
.. setting:: SESSION_COOKIE_NAME
diff --git a/docs/releases/1.3.txt b/docs/releases/1.3.txt
index ec746418b0..7e02bcd0a5 100644
--- a/docs/releases/1.3.txt
+++ b/docs/releases/1.3.txt
@@ -293,7 +293,7 @@ requests. These include:
* Support for lookups spanning relations in admin's
:attr:`~django.contrib.admin.ModelAdmin.list_filter`.
-* Support for HTTPOnly_ cookies.
+* Support for HttpOnly_ cookies.
* :meth:`~django.core.mail.mail_admins()` and
:meth:`~django.core.mail.mail_managers()` now support easily attaching
@@ -315,7 +315,7 @@ requests. These include:
* Support for combining :class:`F expressions <django.db.models.F>`
with ``timedelta`` values when retrieving or updating database values.
-.. _HTTPOnly: https://www.owasp.org/index.php/HTTPOnly
+.. _HttpOnly: https://www.owasp.org/index.php/HttpOnly
.. _backwards-incompatible-changes-1.3: