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
|
from __future__ import annotations
import django
from django.conf import settings
from django.test.utils import override_settings
from html5lib.constants import E
from html5lib.html5parser import HTMLParser
from debug_toolbar.store import get_store
from debug_toolbar.toolbar import DebugToolbar
from debug_toolbar.utils import get_csp_nonce
from .base import IntegrationTestCase
MIDDLEWARE_CSP_LIB_BEFORE = settings.MIDDLEWARE.copy()
MIDDLEWARE_CSP_LIB_BEFORE.insert(
MIDDLEWARE_CSP_LIB_BEFORE.index("debug_toolbar.middleware.DebugToolbarMiddleware"),
"csp.middleware.CSPMiddleware",
)
MIDDLEWARE_CSP_LIB_LAST = settings.MIDDLEWARE + ["csp.middleware.CSPMiddleware"]
VALID_MIDDLEWARE_VARIATIONS = [MIDDLEWARE_CSP_LIB_BEFORE, MIDDLEWARE_CSP_LIB_LAST]
django_has_builtin_csp_support = django.VERSION >= (6, 0)
if django_has_builtin_csp_support:
MIDDLEWARE_CSP_BUILTIN_BEFORE = settings.MIDDLEWARE.copy()
MIDDLEWARE_CSP_BUILTIN_BEFORE.insert(
MIDDLEWARE_CSP_BUILTIN_BEFORE.index(
"debug_toolbar.middleware.DebugToolbarMiddleware"
),
"django.middleware.csp.ContentSecurityPolicyMiddleware",
)
MIDDLEWARE_CSP_BUILTIN_LAST = settings.MIDDLEWARE + [
"django.middleware.csp.ContentSecurityPolicyMiddleware"
]
VALID_MIDDLEWARE_VARIATIONS += [
MIDDLEWARE_CSP_BUILTIN_BEFORE,
MIDDLEWARE_CSP_BUILTIN_LAST,
]
def get_namespaces(element):
"""
Return the default `xmlns`. See
https://docs.python.org/3/library/xml.etree.elementtree.html#parsing-xml-with-namespaces
"""
if not element.tag.startswith("{"):
return {}
return {"": element.tag[1:].split("}", maxsplit=1)[0]}
@override_settings(DEBUG=True)
class CspRenderingTestCase(IntegrationTestCase):
"""Testing if `csp-nonce` renders."""
def setUp(self):
super().setUp()
self.parser = HTMLParser()
def _fail_if_missing(self, root, path, namespaces, nonce):
"""
Search elements, fail if a `nonce` attribute is missing on them.
"""
elements = root.findall(path=path, namespaces=namespaces)
for item in elements:
if item.attrib.get("nonce") != nonce:
raise self.failureException(f"{item} has no nonce attribute.")
def _fail_if_found(self, root, path, namespaces):
"""
Search elements, fail if a `nonce` attribute is found on them.
"""
elements = root.findall(path=path, namespaces=namespaces)
for item in elements:
if "nonce" in item.attrib:
raise self.failureException(f"{item} has a nonce attribute.")
def _fail_on_invalid_html(self, content, parser):
"""Fail if the passed HTML is invalid."""
if parser.errors:
default_msg = ["Content is invalid HTML:"]
lines = content.split(b"\n")
for position, error_code, data_vars in parser.errors:
default_msg.append(f" {E[error_code]}" % data_vars)
default_msg.append(f" {lines[position[0] - 1]!r}")
msg = self._formatMessage(None, "\n".join(default_msg))
raise self.failureException(msg)
def test_exists(self):
"""A `nonce` should exist when using the `CSPMiddleware`."""
for middleware in VALID_MIDDLEWARE_VARIATIONS:
with self.settings(MIDDLEWARE=middleware):
response = self.client.get(path="/csp_view/")
self.assertEqual(response.status_code, 200)
html_root = self.parser.parse(stream=response.content)
self._fail_on_invalid_html(content=response.content, parser=self.parser)
self.assertContains(response, "djDebug")
namespaces = get_namespaces(element=html_root)
nonce = get_csp_nonce(response.context["request"])
assert nonce is not None
self._fail_if_missing(
root=html_root, path=".//link", namespaces=namespaces, nonce=nonce
)
self._fail_if_missing(
root=html_root, path=".//script", namespaces=namespaces, nonce=nonce
)
# def test_does_not_exist_nonce_wasnt_used(self):
# """
# A `nonce` should not exist even when using the `CSPMiddleware`
# if the view didn't access the request's CSP nonce.
# """
# for middleware in VALID_MIDDLEWARE_VARIATIONS:
# with self.settings(MIDDLEWARE=middleware):
# response = self.client.get(path="/regular/basic/")
# self.assertEqual(response.status_code, 200)
# html_root = self.parser.parse(stream=response.content)
# self._fail_on_invalid_html(content=response.content, parser=self.parser)
# self.assertContains(response, "djDebug")
# namespaces = get_namespaces(element=html_root)
# self._fail_if_found(
# root=html_root, path=".//link", namespaces=namespaces
# )
# self._fail_if_found(
# root=html_root, path=".//script", namespaces=namespaces
# )
@override_settings(
DEBUG_TOOLBAR_CONFIG={"DISABLE_PANELS": set()},
)
def test_redirects_exists(self):
for middleware in VALID_MIDDLEWARE_VARIATIONS:
with self.settings(MIDDLEWARE=middleware):
response = self.client.get(path="/csp_view/")
self.assertEqual(response.status_code, 200)
html_root = self.parser.parse(stream=response.content)
self._fail_on_invalid_html(content=response.content, parser=self.parser)
self.assertContains(response, "djDebug")
namespaces = get_namespaces(element=html_root)
context = response.context
nonce = str(context["toolbar"].csp_nonce)
self._fail_if_missing(
root=html_root, path=".//link", namespaces=namespaces, nonce=nonce
)
self._fail_if_missing(
root=html_root, path=".//script", namespaces=namespaces, nonce=nonce
)
def test_panel_content_nonce_exists(self):
store = get_store()
for middleware in VALID_MIDDLEWARE_VARIATIONS:
with self.settings(MIDDLEWARE=middleware):
response = self.client.get(path="/csp_view/")
self.assertEqual(response.status_code, 200)
request_ids = list(store.request_ids())
toolbar = DebugToolbar.fetch(request_ids[-1])
panels_to_check = ["HistoryPanel", "TimerPanel"]
for panel in panels_to_check:
content = toolbar.get_panel_by_id(panel).content
html_root = self.parser.parse(stream=content)
namespaces = get_namespaces(element=html_root)
nonce = str(toolbar.csp_nonce)
self._fail_if_missing(
root=html_root,
path=".//link",
namespaces=namespaces,
nonce=nonce,
)
self._fail_if_missing(
root=html_root,
path=".//script",
namespaces=namespaces,
nonce=nonce,
)
def test_missing(self):
"""A `nonce` should not exist when not using the `CSPMiddleware`."""
response = self.client.get(path="/regular/basic/")
self.assertEqual(response.status_code, 200)
html_root = self.parser.parse(stream=response.content)
self._fail_on_invalid_html(content=response.content, parser=self.parser)
self.assertContains(response, "djDebug")
namespaces = get_namespaces(element=html_root)
self._fail_if_found(root=html_root, path=".//link", namespaces=namespaces)
self._fail_if_found(root=html_root, path=".//script", namespaces=namespaces)
|
