Use RestRequestFilter.getFilteredRequest to declare sensitive API params #5710
+51
−17
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
Signed-off-by: Craig Perkins <[email protected]>
Signed-off-by: Craig Perkins <[email protected]>
Signed-off-by: Craig Perkins <[email protected]>
Signed-off-by: Craig Perkins <[email protected]>
cwperks
requested review from
DarshitChanpura,
RyanL1997,
derek-ho,
nibix,
peternied,
reta,
shikharj05 and
willyborankin
as code owners
cwperks
changed the title
Signed-off-by: Craig Perkins <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5710 +/- ##
==========================================
- Coverage 72.93% 72.91% -0.03%
==========================================
Files 420 420
Lines 26269 26277 +8
Branches 3974 3976 +2
==========================================
Hits 19159 19159
- Misses 5192 5200 +8
Partials 1918 1918
🚀 New features to boost your workflow:
|
|
|
||
| RestRequest filteredRequest = getFilteredRequest(request); | ||
|
|
||
| RestRequest auditLogRequest = (request.method() != Method.PATCH) ? filteredRequest : request; |
There was a problem hiding this comment.
Would you mind adding a brief comment on why PATCH is skipped?
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.
Description
This PR enhances the audit log redaction functionality to use an existing extension point in core that is not utilized. Core has an extension point called RestRequestFilter that can be used to filter sensitive values from a request payload (for example password in some reindex REST Apis). I am raising this PR to wire up this extension point.
See opensearch-project/OpenSearch@9005e9f#diff-b30aa63ce9a55b210cf60a1c2a0d0070156e13379ae6ffef45707686e31ae0c6
The benefit of this extension point is that other plugins can leverage it to declare api params as sensitive and filtered in cases where the request body may be used.
Bug fix
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.