-
-
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
base: master
Are you sure you want to change the base?
Changes from 1 commit
93abbcf
40b6461
0a6327d
a1645ee
fa41ef3
7885c84
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,11 +13,22 @@ 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: | ||
| Handling sensitive data in the SDK regardless of the `send_default_pii` setting: | ||
|
|
||
| - HTTP Headers: The keys of known sensitive headers (such as `Authorization` or `Cookie`) are added, while their values must be replaced with `"[Filtered]"`. | ||
|
|
||
| <Expandable title="List of sensitive HTTP headers"> | ||
|
||
|
|
||
| The SDK performs a **partial, case-insensitive match** against the following headers to determine if they are sensitive: | ||
|
|
||
| `['auth', 'token', 'secret', 'cookie', '-user', 'password', 'key', 'jwt', 'bearer', 'sso', 'saml']` | ||
|
||
|
|
||
| </Expandable> | ||
|
|
||
| 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. | ||
| - _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. | ||
| - On desktop applications | ||
|
|
||
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.