Skip to content

GH-182 Update docs to clarify when nonce will not be added to headers #185

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

Merged
merged 2 commits into from
Jun 28, 2022
Merged

GH-182 Update docs to clarify when nonce will not be added to headers #185

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4de4238
GH-182 Update docs to clarify when nonce will not be added to headers
DylanYoung May 26, 2022
3be7efd
Update docs/nonce.rst
pmac Jun 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/nonce.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
==============================
Using the generated CSP nonce
==============================
When ``CSP_INCLUDE_NONCE_IN`` is configured, the nonce value is returned in the CSP header. To actually make the browser do anything with this value, you will need to include it in the attributes of the tags that you wish to mark as safe.
When ``CSP_INCLUDE_NONCE_IN`` is configured, the nonce value is returned in the CSP headers **if it is used**, e.g. by evaluating the nonce in your template.
To actually make the browser do anything with this value, you will need to include it in the attributes of
the tags that you wish to mark as safe.


.. Note::
Expand Down Expand Up @@ -34,6 +36,10 @@ This value can be accessed directly on the request object in any view or templat

Assuming the ``CSP_INCLUDE_NONCE_IN`` list contains the ``script-src`` directive, this will result in the above script being allowed.

.. Note::

The nonce will only be added to the CSP headers if it is used.


``Context Processor``
=====================
Expand Down