Skip to content

fix: redact sensitive headers in debug request/response logging #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iamMrGaurav wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: redact sensitive headers in debug request/response logging #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/lib/sdks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,18 @@ export class ClientSDK {
}
}

const SENSITIVE_HEADERS = new Set([
"authorization",
"cookie",
"set-cookie",
"x-api-key",
"proxy-authorization",
]);

function redactHeaderValue(name: string, value: string): string {
return SENSITIVE_HEADERS.has(name.toLowerCase()) ? "[REDACTED]" : value;
}

const jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/;
const jsonlLikeContentTypeRE =
/(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/;
Expand All @@ -317,7 +329,7 @@ async function logRequest(logger: Logger | undefined, req: Request) {

logger.group("Headers:");
for (const [k, v] of req.headers.entries()) {
logger.log(`${k}: ${v}`);
logger.log(`${k}: ${redactHeaderValue(k, v)}`);
}
logger.groupEnd();

Expand Down Expand Up @@ -363,7 +375,7 @@ async function logResponse(

logger.group("Headers:");
for (const [k, v] of res.headers.entries()) {
logger.log(`${k}: ${v}`);
logger.log(`${k}: ${redactHeaderValue(k, v)}`);
}
logger.groupEnd();

Expand Down