proto_api_scrubber: Implement message-level restrictions. #42411
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
Implements the configuration and evaluation logic for message-level restrictions as per the design. When a message-level matcher evaluates to true, the filter now prevents further field-level scrubbing within that message instance by returning kExclude from CheckType. Note: Currently, this does not clear the existing fields of the message. Full message content erasure will require enhancements in the upstream proto-processing-lib. tests for this new feature. Signed-off-by: pranavrautgoogle <pranavraut@google.com>
adisuissa
reviewed
Dec 4, 2025
Contributor
adisuissa
left a comment
adisuissa
left a comment
There was a problem hiding this comment.
Thanks, overall LGTM.
It is unclear to me if this filter is ready to be used. If it is, then please update the release notes at: changelogs/current.yaml.
| } else { | ||
| // Preserve the field (i.e., kInclude) if there's a match and the matched action is not | ||
| // `envoy.extensions.filters.http.proto_api_scrubber.v3.RemoveFieldAction`. | ||
| ENVOY_LOG(warn, |
Contributor
There was a problem hiding this comment.
Is it possible to reject a wrong configuration (rather than handling edge cases during the dataplane runtime)?
| field_to_scrub, // {3} | ||
| matcher_proto.DebugString() // {4} Inject the Generic Matcher | ||
| ); | ||
| xds::type::matcher::v3::Matcher matcher_proto = buildMatcher(match_predicate); |
Contributor
There was a problem hiding this comment.
Thanks for cleaning this!
| "Error encountered while matching the field `{}`. This field would be preserved. " | ||
| "Error details: {}", | ||
| field_mask, match_result.status().message()); | ||
| field_mask, match_result.status().ToString()); |
Contributor
There was a problem hiding this comment.
OOC, why is this needed (I think most of the codebase just uses message())?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Commit Message: feat(proto_api_scrubber): add message-level restrictions
Additional Description:
This commit introduces the configuration and evaluation logic for message-level restrictions to the Proto API Scrubber, as outlined in the design document. The filter can now evaluate matcher rules defined against specific Protobuf message types.
When a message-level matcher evaluates to true for a given message type, FieldChecker::CheckType returns FieldCheckResults::kExclude. In the current version of the proto-processing-lib, this prevents the scrubber from descending into the fields of that message instance for any further field-level checks.
Known Limitation:
This implementation does not clear the fields of the message when the message-level rule matches and CheckType returns kExclude. The message remains intact, but its fields are not scrubbed. True message content clearing upon a message-level match will require enhancements in the upstream proto-processing-lib repository, which will be handled separately.
Risk Level:
Low. This adds new functionality and does not alter the existing field-level or method-level restriction behavior.
Testing:
Unit tests have been added in test/extensions/filters/http/proto_api_scrubber/scrubbing_util_lib/field_checker_test.cc to validate the behavior of FieldChecker::CheckType with different matcher outcomes.
Integration tests have been added in test/extensions/filters/http/proto_api_scrubber/integration_test.cc (e.g., ScrubMessageLevel_MatcherTrue, ScrubMessageLevel_HeaderMatch, MessageScrubPrecedence) to demonstrate the current end-to-end behavior of message-level restrictions, confirming that field traversal is halted but content is not cleared.
Docs Changes:
N/A (No documentation files were modified in this change).
Release Notes:
feat(proto_api_scrubber): Added support for message-level restrictions. Matchers can be configured against fully qualified message names. When a message-level matcher evaluates to true, field-level scrubbing is skipped for the fields within that message instance.
Platform Specific Features:
None.
[Optional Runtime guard:]
N/A
[Optional Fixes #Issue]
N/A
[Optional Fixes commit #PR or SHA]
N/A
[Optional Deprecated:]
N/A
[Optional API Considerations:]
N/A