-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs(sensitive-data): Overhaul docs around HTTP headers #15616
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.
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
s1gr1d
wants to merge
7
commits into
master
Choose a base branch
from
sig/sensitive-data
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
93abbcf
docs(sensitive-data): Overhaul docs around HTTP headers
s1gr1d 40b6461
review suggestions, cookie addition
s1gr1d 0a6327d
add set-cookie
s1gr1d a1645ee
add pwd
s1gr1d fa41ef3
Update develop-docs/sdk/expected-features/data-handling.mdx
s1gr1d 7885c84
make sentence more clear
s1gr1d 793d6df
clarify theme cookie
s1gr1d File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,13 +13,21 @@ In the event that API returns data considered PII, we guard that behind a flag c | |
| This is an option in the SDK called [_send-default-pii_](https://docs.sentry.io/platforms/python/configuration/options/#send-default-pii) | ||
| and is **disabled by default**. That means that data that is naturally sensitive is not sent by default. | ||
|
|
||
| Some examples of data guarded by this flag: | ||
| Certain sensitive data must never been sent by the SDK, regardless of any configuration: | ||
|
|
||
| - HTTP Headers: The keys of known sensitive headers are added, while their values must be replaced with `"[Filtered]"`. | ||
| - The SDK performs a **partial, case-insensitive match** against the following headers to determine if they are sensitive: `["auth", "token", "secret", "password", "passwd", "pwd", "key", "jwt", "bearer", "sso", "saml", "crsf", "xsrf", "credentials"]` | ||
|
|
||
| SDKs should only replace sensitive data with `"[Filtered]"` when the data is gathered automatically through instrumentation. | ||
| If a user explicitly provides data (for example, by setting a request object on the scope), the SDK must not modify it. | ||
cursor[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Some examples of data guarded by `send_default_pii: false`: | ||
|
|
||
| - When attaching data of HTTP requests and/or responses to events | ||
| - Request Body: "raw" HTTP bodies (bodies which cannot be parsed as JSON or formdata) are removed | ||
| - HTTP Headers: known sensitive headers such as `Authorization` or `Cookie` are removed too. | ||
| - Request Body: "raw" HTTP bodies (bodies which cannot be parsed as JSON or FormData) are removed | ||
| - HTTP Headers: header values, containing information about the user are replaced with `"[Filtered]"` | ||
| - _Note_ that if a user explicitly sets a request on the scope, nothing is stripped from that request. The above rules only apply to integrations that come with the SDK. | ||
| - User-specific information (e.g. the current user ID according to the used web-framework) is not sent at all. | ||
| - User-specific information (e.g. the current user ID according to the used web-framework) is not collected and therefore not sent at all. | ||
| - On desktop applications | ||
| - The username logged in the device is not included. This is often a person's name. | ||
| - The machine name is not included, for example `Bruno's laptop` | ||
|
|
@@ -33,6 +41,21 @@ Before sending events to Sentry, the SDKs should invokes callbacks. That allows | |
|
|
||
| - [`before-send` and `event-processors`](/sdk/miscellaneous/unified-api/#static-api) can be used to register a callback with custom logic to remove sensitive data. | ||
|
|
||
| ### Cookies | ||
|
|
||
| Since `Cookie` and `Set-Cookie` headers can contain a mix of sensitive and non-sensitive data, SDKs should parse the cookie header and filter values on a per-key basis, depending on the SDK setting and the sensitivity of the cookie value. | ||
| In case, the SDK cannot parse each cookie key-value pair, the entire cookie header must be replaced with `"[Filtered]"`. An unfiltered, raw cookie header value must never be sent. | ||
|
|
||
| This selective filtering prevents capturing sensitive data while retaining harmless contextual information for debugging. | ||
| For example, a sensitive session cookie's value is replaced with "[Filtered]", but a non-sensitive theme cookie can be sent as-is. | ||
|
||
|
|
||
| When attached as span attributes, the results should be as follows: | ||
|
|
||
| - `http.request.header.cookie.user_session: "[Filtered]"` | ||
| - `http.request.header.cookie.theme: "dark-mode"` | ||
| - `http.request.header.set_cookie.theme: "light-mode"` | ||
| - `http.request.header.cookie: "[Filtered]"` (Used as a fallback if the cookie header cannot be parsed) | ||
|
|
||
| ### Application State | ||
|
|
||
| App state can be critical to help developers reproduce bugs. For that reason, SDKs often collect app state and append to events through auto instrumentation. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Typo in sensitive header pattern list
The sensitive header pattern list contains
"crsf"instead of"csrf". This typo prevents SDKs from properly filtering Cross-Site Request Forgery headers during partial case-insensitive matching, potentially allowing sensitive CSRF tokens to be sent to Sentry unfiltered.