chore(redact-url): add OAuth2 token names to the sensitive-param set#281
Merged
Merged
Conversation
The redact-url middleware strips a small allowlist of known-sensitive query parameter values before the URL hits the structured log. \`authkey\`, \`apikey\`, \`api_key\`, \`token\`, \`access_token\`, \`password\`, and \`secret\` were already covered. This API doesn't issue OAuth2 tokens itself, but operators sometimes front the service with an OAuth proxy whose redirect / error paths bounce a \`?refresh_token=...\` or \`?id_token=...\` through one of our URLs. Adding these and \`client_secret\` as defense-in-depth means a log line captured during that flow doesn't become the leak vector. The existing test in tests/unit/redact-url.test.js iterates over SENSITIVE_PARAM_NAMES and asserts each one redacts — so coverage extends automatically without a code change to the test file. 760 tests still pass. 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.
Summary
The redact-url middleware (used by the pino-http request serializer) strips known-sensitive query-parameter values before the URL hits the structured log. The existing set covered
authkey,apikey,api_key,token,access_token,password, andsecret.This API doesn't issue OAuth2 tokens itself, but operators sometimes front the service with an OAuth proxy whose redirect / error paths bounce a
?refresh_token=…or?id_token=…through one of our URLs. Adding these andclient_secretas defense in depth means a log line captured during that flow doesn't become the leak vector — even though we're not the original token issuer.Test plan
npm run lint && npm test— 760 passing.tests/unit/redact-url.test.jsiterates overSENSITIVE_PARAM_NAMESand asserts each one redacts, so coverage extends automatically.Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/