fix(config): redact URL secrets structurally via the url crate#305
Merged
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.
What
Replace the hand-rolled path-segment
redact_urlheuristic with a structural redactor built on theurlcrate. It blanks userinfo, query strings, fragments, and long API-key path segments before an RPC url reaches a log line.Why
Closes #44
The previous heuristic only split on
/and rewrote long path segments, so it leaked secrets that do not live in the path: a bare query flag (?token), a?key=secretquery value, and a#fragmentbearer token all sailed through untouched. Parsing withurl::Urland clearing each credential-bearing component closes those gaps, and an unparseable url now yields a<unparseable-url>placeholder rather than being logged verbatim.Credit to @jean-neiverth, who raised #44 (originally via #163).
Testing
cargo test -p nexum-runtime --lib redact(9 cases: userinfo, query value, bare?tokenflag,#fragment,@-in-path, long path segment ->KEY, clean url intact, unparseable -> placeholder).cargo clippy -p nexum-runtime --all-targets -- -D warnings,cargo fmt --all.AI Assistance
AI Assistance: Claude (Opus) used for extracting the redactor and its tests, and drafting this PR.