Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 12 additions & 4 deletions sentry_sdk/scrubber.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
"sessionid",
# wsgi
"x_csrftoken",
"x_forwarded_for",
"set_cookie",
"cookie",
"authorization",
Expand Down Expand Up @@ -60,6 +59,10 @@
]


def _normalize_key(key: str) -> str:
return key.lower().replace("-", "_")


class EventScrubber:
def __init__(
self,
Expand All @@ -84,7 +87,10 @@ def __init__(
)
self.denylist += pii_denylist

self.denylist = [x.lower() for x in self.denylist]
# Header keys reach the scrubber hyphenated ("X-Api-Key"), while several
# entries use WSGI environ spelling ("x_api_key"), so compare both sides
# with hyphens and underscores folded together.
self.denylist = [_normalize_key(x) for x in self.denylist]
self.recursive = recursive

def scrub_list(self, lst: object) -> None:
Expand Down Expand Up @@ -114,8 +120,10 @@ def scrub_dict(self, d: object) -> None:
for k, v in d.items():
# The cast is needed because mypy is not smart enough to figure out that k must be a
# string after the isinstance check.
if isinstance(k, str) and k.lower() in self.denylist:
d[k] = AnnotatedValue.substituted_because_contains_sensitive_data()
if isinstance(k, str) and _normalize_key(k) in self.denylist:
# Keep a value that was already removed and annotated earlier.
if not isinstance(v, AnnotatedValue):
d[k] = AnnotatedValue.substituted_because_contains_sensitive_data()
elif self.recursive:
self.scrub_dict(v) # no-op unless v is a dict
self.scrub_list(v) # no-op unless v is a list
Expand Down
42 changes: 42 additions & 0 deletions tests/test_scrubber.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import logging
import sys

import pytest

from sentry_sdk import capture_event, capture_exception, start_span, start_transaction
from sentry_sdk.scrubber import EventScrubber
from sentry_sdk.utils import event_from_exception
Expand Down Expand Up @@ -336,3 +338,43 @@ def test_recursive_scrubber_does_not_override_original(sentry_init, capture_even
(frame,) = frames
assert data["csrf"] == "secret"
assert frame["vars"]["data"]["csrf"] == "[Filtered]"


@pytest.mark.parametrize("send_default_pii", [False, True])
def test_hyphenated_header_scrubbing(sentry_init, capture_events, send_default_pii):
"""Header keys are hyphenated, while denylist entries such as x_csrftoken
and x_api_key use underscores. Both spellings must match."""
sentry_init(send_default_pii=send_default_pii)
events = capture_events()

capture_event(
{
"request": {
"headers": {
"X-Csrftoken": "secret",
"x-api-key": "secret",
"Set-Cookie": "secret",
"Origin": "google.com",
},
}
}
)

(event,) = events
assert event["request"]["headers"] == {
"X-Csrftoken": "[Filtered]",
"x-api-key": "[Filtered]",
"Set-Cookie": "[Filtered]",
"Origin": "google.com",
}


def test_custom_denylist_matches_either_spelling(sentry_init, capture_events):
sentry_init(event_scrubber=EventScrubber(denylist=["x-custom-token"]))
events = capture_events()

capture_event({"extra": {"x_custom_token": "secret", "X-Custom-Token": "secret"}})

(event,) = events
assert event["extra"]["x_custom_token"] == "[Filtered]"
assert event["extra"]["X-Custom-Token"] == "[Filtered]"