Fix secret removal which was also removing carriage returns and not supporting multiple URLs in single string #942
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
benoit74
force-pushed
the
fix_secret_removal
branch
from
2b75298 to
8382219
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #942 +/- ##
==========================================
+ Coverage 87.82% 87.84% +0.01%
==========================================
Files 93 93
Lines 5299 5307 +8
==========================================
+ Hits 4654 4662 +8
Misses 645 645 ☔ View full report in Codecov by Sentry. |
rgaudin
requested changes
Mar 12, 2024
benoit74
force-pushed
the
fix_secret_removal
branch
from
94c2ebe to
76d0296
Compare
- redact password which might be present in URL netloc - rename the function to remove_url_secrets since it does not remove only S3 secret - handle properly the reconstruction of URL query - prefer urlsplit and urlunsplit - instead of urlparse - since this is the future / we do not need to separate parameters from parts
… in query parameters
benoit74
force-pushed
the
fix_secret_removal
branch
from
76d0296 to
6effbe8
Compare
|
rgaudin
approved these changes
Mar 12, 2024
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.
Rationale
Fix #924 (and enabler for #936)
Changes
The logic to remove S3 secrets was not taking into account the fact that some dictionary keys (e.g. logs) might contain long strings with many S3 secrets to remove. It was also considering that the string is a URL, hence removing all carriage returns.
Logic has been fixed to take all this into account and properly continue to remove secrets.
Test cases have been supplemented with new test cases and assertion logic has be supplemented with a check of the whole response.
Password in network location is removed as well.
Secret replacement is now "--------" instead of "********" so that it is not replaced by url encoding / is part of the allowed chars in a URL/URI.