fix(error-handler): redact sensitive query params in the 404 echo path#132
Merged
Conversation
`notFound` returned `path: req.originalUrl` verbatim. An SDK bug that puts the authKey on the query string instead of the authKey header (`GET /v1/foo?authKey=...`) would 404 against an unmatched path and receive its own secret echoed back in the response body — at which point any upstream proxy logging responses, or the client's own error logger capturing 4xx bodies, would persist the secret far from where it was supposed to live. pino-http's request logger already routes `req.url` through `redactUrl` for exactly this reason. Use the same helper here so the 404 echo gets the same treatment. Pin behavior with a test asserting `?authKey=...` becomes `?authKey=<REDACTED>` in the echoed path while non-sensitive query params (`?q=ok`) are preserved. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Closes #131.
Summary
notFoundreturnedpath: req.originalUrlverbatim. An SDK bug that puts the authKey on the query string instead of theauthKeyheader (GET /v1/foo?authKey=…) would 404 against an unmatched path and receive its own secret echoed back in the response body — at which point any upstream proxy logging responses, or the client's own error logger capturing 4xx bodies, would persist the secret far from where it was supposed to live.pino-http's request logger already routesreq.urlthroughredactUrlfor exactly this reason. Use the same helper innotFoundso the 404 echo gets the same treatment.Test plan
npm run lint— cleannpm test— 491 passed (was 490 + new regression test), 15 skipped?authKey=…becomes?authKey=<REDACTED>in the echoed path while non-sensitive params (?q=ok) are preservedProudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/