fix(pii): Fix scrubbing user paths in minidump debug modules #4351
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
jjbayer
changed the title
jjbayer
commented
Dec 6, 2024
Comment on lines
+116
to
+125
| #[test] | ||
| fn supports_byte_mode() { | ||
| assert!(regex::bytes::RegexBuilder::new($name.as_str()) | ||
| .unicode(false) | ||
| .multi_line(false) | ||
| .dot_matches_new_line(true) | ||
| .build() | ||
| .is_ok()); | ||
| } | ||
| } |
There was a problem hiding this comment.
This makes sure the regex can also be used by minidump scrubbing. There are several open questions (see below), but this was the most conservative approach I could think of.
- Why does minidump scrubbing need
.unicode(false)?relay/relay-pii/src/attachments.rs
Lines 29 to 31 in b5b738f
- Could we automatically generate a non-unicode version of every regex, such that it does not have to be recompiled on the fly for every minidump?
There was a problem hiding this comment.
- I read the issue and I still don't understand why this is necessary, would be nice if we had a test for this...
- That'd be nice or if we didn't even need the special casing in the first place.
| }); | ||
| ) | ||
| ( | ||
| [^/\\\r\n]+ |
There was a problem hiding this comment.
This is the change that fixes the regex with unicode disabled, while still meeting the requirements of #2724:
relay/relay-pii/src/builtin.rs
Lines 1247 to 1248 in b5b738f
Dav1dde
approved these changes
Dec 6, 2024
Comment on lines
+116
to
+125
| #[test] | ||
| fn supports_byte_mode() { | ||
| assert!(regex::bytes::RegexBuilder::new($name.as_str()) | ||
| .unicode(false) | ||
| .multi_line(false) | ||
| .dot_matches_new_line(true) | ||
| .build() | ||
| .is_ok()); | ||
| } | ||
| } |
There was a problem hiding this comment.
- I read the issue and I still don't understand why this is necessary, would be nice if we had a test for this...
- That'd be nice or if we didn't even need the special casing in the first place.
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.
#2724 silently broke user path scrubbing in minidumps. The regression was not automatically flagged because minidump scrubbing ignores regexes that cannot be compiled with unicode disabled, regardless of whether they are user-defined regexes or builtin static ones.
This PR both fixes the regex and adds an automatic test to each PII regex, so we can catch similar problems in the future.