Skip to content

Add a Content-Security-Policy in Report-Only mode (refs #3041) #3042

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

Open
tonghuaroot wants to merge 2 commits into
base: main
Choose a base branch
from
+44 −0
Open

Add a Content-Security-Policy in Report-Only mode (refs #3041) #3042

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69eef9e
Add a Content-Security-Policy in Report-Only mode
tonghuaroot Jul 2, 2026
8b9dd0b
Add Django 6.0 removal note and a Report-Only header test
tonghuaroot Jul 28, 2026
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
22 changes: 22 additions & 0 deletions pydotorg/settings/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@
MIDDLEWARE = [
"django.contrib.sessions.middleware.SessionMiddleware",
"django.middleware.common.CommonMiddleware",
"csp.middleware.CSPMiddleware",
"django.middleware.csrf.CsrfViewMiddleware",
"pydotorg.middleware.AdminNoCaching",
"pydotorg.middleware.GlobalSurrogateKey",
Expand Down Expand Up @@ -297,6 +298,27 @@
X_FRAME_OPTIONS = "SAMEORIGIN"
SILENCED_SYSTEM_CHECKS = ["security.W019"]

### Content Security Policy, via django-csp

# Django 6.0 ships built-in CSP support; drop django-csp and this setting
# and use the framework's own CSP once we upgrade.
# Report-Only first: collect violations and tune the allowlist before
# enforcing. Rollout tracked in #3041.
CONTENT_SECURITY_POLICY_REPORT_ONLY = {

@sethmlarson sethmlarson Jul 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a test case that checks which HTTP header is emitted? Want to make sure Content-Security-Policy-Report-Only is emitted, not Content-Security-Policy so we don't break everyone on rollout.

@tonghuaroot tonghuaroot Jul 28, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a test that checks the Report-Only header is set and the enforcing one is not. Runs green.

"DIRECTIVES": {
"default-src": ["'self'"],
"script-src": ["'self'"],
"style-src": ["'self'"],
"img-src": ["'self'", "data:"],
"font-src": ["'self'"],
"connect-src": ["'self'"],
"frame-ancestors": ["'self'"],
"base-uri": ["'self'"],
"object-src": ["'none'"],
"form-action": ["'self'"],
},
}

### django-rest-framework

REST_FRAMEWORK = {
Expand Down
6 changes: 6 additions & 0 deletions pydotorg/tests/test_middleware.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ def test_admin_caching(self):
self.assertTrue(response.has_header("Cache-Control"))
self.assertEqual(response["Cache-Control"], "private")

def test_csp_report_only_header(self):
"""CSP ships in Report-Only mode; the enforcing header must not be set."""
response = self.client.get("/admin/")
self.assertTrue(response.has_header("Content-Security-Policy-Report-Only"))
self.assertFalse(response.has_header("Content-Security-Policy"))

def test_redirects(self):
"""
More of a sanity check just in case some other middleware interferes.
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ version = "0.1.0"
requires-python = ">=3.14"
dependencies = [
"dj-database-url==0.5.0",
"django-csp==4.0",
"django-pipeline==4.1.0",
"django-sitetree==1.18.0",
"django-apptemplates==1.5",
Expand Down
15 changes: 15 additions & 0 deletions uv.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.