fix(pii): Validate PII regexes for byte-mode compilation#5920
Draft
sentry[bot] wants to merge 1 commit intomasterfrom
Draft
fix(pii): Validate PII regexes for byte-mode compilation#5920sentry[bot] wants to merge 1 commit intomasterfrom
sentry[bot] wants to merge 1 commit intomasterfrom
Conversation
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
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.
This PR addresses an issue where PII scrubbing regexes containing Unicode character ranges (e.g., Korean Hangul) would pass initial configuration validation but fail at runtime during byte-level attachment scrubbing.
The root cause was that
relay-pii/src/attachments.rs:apply_regex_to_utf8_bytesrecompiles regexes withunicode(false)for byte-mode matching, which does not support Unicode character ranges. However, the PII configuration validation inrelay-cabi/src/processing.rs:relay_validate_pii_config(viaCompiledPiiConfig::force_compile()) only checked for standard (unicode-enabled) regex compilation.To fix this, the
force_compile()method inrelay-pii/src/compiledconfig.rshas been enhanced. It now performs an additional validation step for user-definedPatternandRedactPairregexes: it attempts to compile them usingregex::bytes::RegexBuilder::new(...).unicode(false).build(). If this byte-mode compilation fails, aPiiConfigError::RegexErroris returned, causing the PII configuration to be rejected at validation time. This prevents invalid PII configurations from being accepted and deployed, thereby eliminating runtime errors.Additionally, a comment in
relay-pii/src/attachments.rshas been updated to reflect this improved validation, acknowledging that byte-mode compilation errors for user-defined patterns should now be caught earlier.Legal Boilerplate
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
Fixes RELAY-5Y