fix(node): Redact URL authority only in breadcrumbs and spans #7740
Conversation
This file contains 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
3 tasks
Lms24
commented
Apr 4, 2023
| @@ -48,7 +48,8 @@ export function extractUrl(requestOptions: RequestOptions): string { | |||
| !requestOptions.port || requestOptions.port === 80 || requestOptions.port === 443 ? '' : `:${requestOptions.port}`; | |||
| // do not include search or hash in span descriptions, per https://develop.sentry.dev/sdk/data-handling/#structuring-data | |||
| const path = requestOptions.pathname || '/'; | |||
| const authority = requestOptions.auth ? `${requestOptions.auth}@` : ''; | |||
| // // always filter authority, see https://develop.sentry.dev/sdk/data-handling/#structuring-data | |||
| const authority = requestOptions.auth ? '[Filtered]:[Filtered]@' : ''; | |||
There was a problem hiding this comment.
This always adds a [Filtered] for both, username and password, even if only one of the two is present. We can refactor this to only set the respective one but I'd argue it's safer from a PII/user identification view to just always show [Filtered]:[Filtered]@.
There was a problem hiding this comment.
After discussing this internally, we went with a more fine-grained redaction (see these test cases). We can likely reuse this function on the browser side later on
lforst
reviewed
Apr 5, 2023
lforst
approved these changes
Apr 5, 2023
Co-authored-by: Luca Forstner <luca.forstner@sentry.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In #7667 we missed that our
urlToOptionshelper function is actually called to normalize request options that are then passed to the actual http client. Meaning, we shouldn't have redacted the authority in this function but at a later time when we extract the sanitized version (extractUrl). This PR changes the redaction location accordingly and hence fixes requests with authority not being sent properly.closes #7724