Skip to content

ENG-2404: Update CSP headers to include docs pages #7235

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
tvandort wants to merge 4 commits into
base: main
Choose a base branch
from
+107 −3
Open

ENG-2404: Update CSP headers to include docs pages #7235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dd42051
Update CSP configuration to include docs.
tvandort Jan 15, 2026
a3cc309
Remove colon.
tvandort Jan 15, 2026
a8ebd68
Add changelog.
tvandort Jan 15, 2026
c10fc5f
Update changelog.
tvandort Jan 16, 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
7 changes: 7 additions & 0 deletions changelog/7235-add-docs-csp-headers.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Copy this file and rename it (e.g., pr-number.yaml or feature-name.yaml)
# Fill in the required fields and delete this comment block

type: Fixed # One of: Added, Changed, Developer Experience, Deprecated, Docs, Fixed, Removed, Security
description: Adds CSP headers for docs pages
pr: 7235 # PR number
labels: [] # Optional: ["high-risk", "db-migration"]
65 changes: 62 additions & 3 deletions src/fides/api/util/security_headers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,58 @@ class HeaderRule:
headers: list[HeaderDefinition]


# used for both swagger and redocs packages
jsdelivr_domain = "cdn.jsdelivr.net"
fast_api_domain = "fastapi.tiangolo.com"
redocly_cdn_domain = "cdn.redoc.ly"
google_fonts_domain = "fonts.googleapis.com"
gstatic_fonts_domain = "fonts.gstatic.com"

recommended_csp_header_value_for_swagger = re.sub(
r"\s{2,}",
" ",
f"""
default-src 'self';
script-src 'self' {jsdelivr_domain} 'unsafe-inline' ;
style-src 'self' {jsdelivr_domain} 'unsafe-inline' ;
connect-src 'self';
img-src 'self' {fast_api_domain} blob: data:;
font-src 'self';
object-src 'none';
base-uri 'self';
form-action 'self';
frame-ancestors 'self';
upgrade-insecure-requests;
""",
).strip()


recommended_csp_header_value_for_redoc = re.sub(
r"\s{2,}",
" ",
f"""
default-src 'self';
script-src 'self' {jsdelivr_domain} 'unsafe-inline' blob:;
style-src 'self' {jsdelivr_domain} {gstatic_fonts_domain} {google_fonts_domain} 'unsafe-inline' ;
connect-src 'self';
img-src 'self' {fast_api_domain} {redocly_cdn_domain} blob: data:;
font-src 'self' {gstatic_fonts_domain} {google_fonts_domain};
object-src 'none';
base-uri 'self';
form-action 'self';
frame-ancestors 'self';
upgrade-insecure-requests;
worker-src blob:;
""",
).strip()

recommended_csp_header_value = re.sub(
r"\s{2,}",
" ",
"""
default-src 'self';
script-src 'self' 'unsafe-inline';
style-src 'self' 'unsafe-inline';
script-src 'self' 'unsafe-inline' ;
style-src 'self' 'unsafe-inline' ;
connect-src 'self';
img-src 'self' blob: data:;
font-src 'self';
Expand All @@ -50,7 +95,7 @@ class HeaderRule:
],
),
HeaderRule(
matcher=re.compile(r"^/((?!api|health).*)"),
matcher=re.compile(r"^/((?!api|health|docs|redoc).*)"),
headers=[
(
"Content-Security-Policy",
Expand All @@ -59,6 +104,20 @@ class HeaderRule:
("X-Frame-Options", "SAMEORIGIN"),
],
),
HeaderRule(
matcher=re.compile(r"/docs.*"),
headers=[
("Content-Security-Policy", recommended_csp_header_value_for_swagger),
("X-Frame-Options", "SAMEORIGIN"),
],
),
HeaderRule(
matcher=re.compile(r"/redoc.*"),
headers=[
("Content-Security-Policy", recommended_csp_header_value_for_redoc),
("X-Frame-Options", "SAMEORIGIN"),
],
),
]


Expand Down
38 changes: 38 additions & 0 deletions tests/api/util/test_security_headers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
apply_headers_to_response,
get_applicable_header_rules,
is_exact_match,
recommended_csp_header_value_for_swagger,
recommended_csp_header_value_for_redoc,
recommended_csp_header_value,
recommended_headers,
)
Expand Down Expand Up @@ -103,6 +105,42 @@ def test_apply_headers_to_response(self):
("X-Frame-Options", "SAMEORIGIN"),
],
),
(
"/docs",
[
(
"X-Content-Type-Options",
"nosniff",
),
(
"Strict-Transport-Security",
"max-age=31536000",
),
(
"Content-Security-Policy",
recommended_csp_header_value_for_swagger,
),
("X-Frame-Options", "SAMEORIGIN"),
],
),
(
"/redoc",
[
(
"X-Content-Type-Options",
"nosniff",
),
(
"Strict-Transport-Security",
"max-age=31536000",
),
(
"Content-Security-Policy",
recommended_csp_header_value_for_redoc,
),
("X-Frame-Options", "SAMEORIGIN"),
],
),
],
)
def test_recommended_headers_api_route(self, path, expected):
Expand Down
Loading