1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
.. _configuration-chapter:
======================
Configuring django-csp
======================
Content-Security-Policy_ is a complicated header. There are many values
you may need to tweak here.
It's worth reading the latest CSP spec_ and making sure you understand it
before configuring django-csp.
.. note::
Many settings require a ``tuple`` or ``list``. You may get very strange
policies and even errors when mistakenly configuring them as a ``string``.
Policy Settings
===============
These settings affect the policy in the header. The defaults are in *italics*.
.. note::
Deprecated features of CSP in general have been moved to the bottom of this list.
.. warning::
The "special" source values of ``'self'``, ``'unsafe-inline'``,
``'unsafe-eval'``, ``'none'`` and hash-source (``'sha256-...'``) must be
quoted! e.g.: ``CSP_DEFAULT_SRC = ("'self'",)``. Without quotes they will
not work as intended.
``CSP_DEFAULT_SRC``
Set the ``default-src`` directive. A ``tuple`` or ``list`` of values,
e.g.: ``("'self'", 'cdn.example.net')``. *["'self'"]*
``CSP_SCRIPT_SRC``
Set the ``script-src`` directive. A ``tuple`` or ``list``. *None*
``CSP_SCRIPT_SRC_ATTR``
Set the ``script-src-attr`` directive. A ``tuple`` or ``list``. *None*
``CSP_SCRIPT_SRC_ELEM``
Set the ``script-src-elem`` directive. A ``tuple`` or ``list``. *None*
``CSP_IMG_SRC``
Set the ``img-src`` directive. A ``tuple`` or ``list``. *None*
``CSP_OBJECT_SRC``
Set the ``object-src`` directive. A ``tuple`` or ``list``. *None*
``CSP_MEDIA_SRC``
Set the ``media-src`` directive. A ``tuple`` or ``list``. *None*
``CSP_FRAME_SRC``
Set the ``frame-src`` directive. A ``tuple`` or ``list``. *None*
``CSP_FONT_SRC``
Set the ``font-src`` directive. A ``tuple`` or ``list``. *None*
``CSP_CONNECT_SRC``
Set the ``connect-src`` directive. A ``tuple`` or ``list``. *None*
``CSP_STYLE_SRC``
Set the ``style-src`` directive. A ``tuple`` or ``list``. *None*
``CSP_STYLE_SRC_ATTR``
Set the ``style-src-attr`` directive. A ``tuple`` or ``list``. *None*
``CSP_STYLE_SRC_ELEM``
Set the ``style-src-elem`` directive. A ``tuple`` or ``list``. *None*
``CSP_BASE_URI``
Set the ``base-uri`` directive. A ``tuple`` or ``list``. *None*
Note: This doesn't use ``default-src`` as a fall-back.
``CSP_CHILD_SRC``
Set the ``child-src`` directive. A ``tuple`` or ``list``. *None*
``CSP_FRAME_ANCESTORS``
Set the ``frame-ancestors`` directive. A ``tuple`` or ``list``. *None*
Note: This doesn't use ``default-src`` as a fall-back.
``CSP_NAVIGATE_TO``
Set the ``navigate-to`` directive. A ``tuple`` or ``list``. *None*
Note: This doesn't use ``default-src`` as a fall-back.
``CSP_FORM_ACTION``
Set the ``FORM_ACTION`` directive. A ``tuple`` or ``list``. *None*
Note: This doesn't use ``default-src`` as a fall-back.
``CSP_SANDBOX``
Set the ``sandbox`` directive. A ``tuple`` or ``list``. *None*
Note: This doesn't use ``default-src`` as a fall-back.
``CSP_REPORT_URI``
Set the ``report-uri`` directive. A ``tuple`` or ``list`` of URIs.
Each URI can be a full or relative URI. *None*
Note: This doesn't use ``default-src`` as a fall-back.
``CSP_REPORT_TO``
Set the ``report-to`` directive. A ``string`` describing a reporting
group. *None*
See Section 1.2: https://w3c.github.io/reporting/#group
Also `see this MDN note on <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/report-uri>`_ ``report-uri`` and ``report-to``.
``CSP_MANIFEST_SRC``
Set the ``manifest-src`` directive. A ``tuple`` or ``list``. *None*
``CSP_WORKER_SRC``
Set the ``worker-src`` directive. A ``tuple`` or ``list``. *None*
``CSP_REQUIRE_SRI_FOR``
Set the ``require-sri-for`` directive. A ``tuple`` or ``list``. *None*
Valid values: a ``list`` containing ``'script'``, ``'style'``, or both.
Spec: require-sri-for-known-tokens_
``CSP_UPGRADE_INSECURE_REQUESTS``
Include ``upgrade-insecure-requests`` directive. A ``boolean``. *False*
Spec: upgrade-insecure-requests_
``CSP_REQUIRE_TRUSTED_TYPES_FOR``
Include ``require-trusted-types-for`` directive.
A ``tuple`` or ``list``. *None*
Valid values: ``["'script'"]``
``CSP_TRUSTED_TYPES``
Include ``trusted-types`` directive.
A ``tuple`` or ``list``. *None*
Valid values: a ``list`` of allowed policy names that may include
``default`` and/or ``'allow-duplicates'``
``CSP_INCLUDE_NONCE_IN``
Include dynamically generated nonce in all listed directives.
A ``tuple`` or ``list``, e.g.: ``CSP_INCLUDE_NONCE_IN = ['script-src']``
will add ``'nonce-<b64-value>'`` to the ``script-src`` directive.
*['default-src']*
Note: The nonce value will only be generated if ``request.csp_nonce``
is accessed during the request/response cycle.
Deprecated CSP settings
-----------------------
The following settings are still configurable, but are considered deprecated
in terms of the latest implementation of the relevant spec.
``CSP_BLOCK_ALL_MIXED_CONTENT``
Include ``block-all-mixed-content`` directive. A ``boolean``. *False*
Related `note on MDN <block-all-mixed-content_mdn_>`_.
Spec: block-all-mixed-content_
``CSP_PLUGIN_TYPES``
Set the ``plugin-types`` directive. A ``tuple`` or ``list``. *None*
Note: This doesn't use ``default-src`` as a fall-back.
Related `note on MDN <plugin_types_mdn_>`_.
``CSP_PREFETCH_SRC``
Set the ``prefetch-src`` directive. A ``tuple`` or ``list``. *None*
Related `note on MDN <prefetch_src_mdn_>`_.
Changing the Policy
~~~~~~~~~~~~~~~~~~~
The policy can be changed on a per-view (or even per-request) basis. See
the :ref:`decorator documentation <decorator-chapter>` for more details.
Other Settings
==============
These settings control the behavior of django-csp. Defaults are in
*italics*.
``CSP_REPORT_ONLY``
Send "report-only" headers instead of real headers.
A ``boolean``. *False*
See the spec_ and the chapter on :ref:`reports <reports-chapter>` for
more info.
``CSP_EXCLUDE_URL_PREFIXES``
A ``tuple`` (*not* a ``list``) of URL prefixes. URLs beginning with any
of these will not get the CSP headers. *()*
.. warning::
Excluding any path on your site will eliminate the benefits of CSP
everywhere on your site. The typical browser security model for
JavaScript considers all paths alike. A Cross-Site Scripting flaw
on, e.g., ``excluded-page/`` can therefore be leveraged to access
everything on the same origin.
.. _Content-Security-Policy: https://www.w3.org/TR/CSP/
.. _Content-Security-Policy-L3: https://w3c.github.io/webappsec-csp/
.. _spec: Content-Security-Policy_
.. _require-sri-for-known-tokens: https://w3c.github.io/webappsec-subresource-integrity/#opt-in-require-sri-for
.. _upgrade-insecure-requests: https://w3c.github.io/webappsec-upgrade-insecure-requests/#delivery
.. _block-all-mixed-content: https://w3c.github.io/webappsec-mixed-content/
.. _block-all-mixed-content_mdn: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/block-all-mixed-content
.. _plugin_types_mdn: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/plugin-types
.. _prefetch_src_mdn: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/prefetch-src
|
