[Security] Redact cookies in sanitized headers output#7539
[Security] Redact cookies in sanitized headers output#7539gonzaloriestra wants to merge 1 commit into
Conversation
The `sanitizedHeadersOutput` function in `packages/cli-kit/src/private/node/api/headers.ts` is used to remove sensitive information from headers before outputting them (e.g., in debug logs). Previously, it only redacted headers containing 'token', 'authorization', or 'subject_token'. This change adds 'cookie' to the list of redacted keywords to ensure that sensitive session data in `Cookie` and `Set-Cookie` headers is also protected from accidental leakage in logs. A regression test has been added to `packages/cli-kit/src/private/node/api/headers.test.ts` to verify the fix.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
WHY are these changes introduced?
To improve the security posture of the Shopify CLI by ensuring that sensitive session identifiers (Cookies) are sanitized and not leaked in debug logs or error reports.
WHAT is this pull request doing?
This PR adds 'cookie' to the list of keywords used by the
sanitizedHeadersOutputfunction in@shopify/cli-kitto redact sensitive headers. This ensures that bothCookieandSet-Cookieheaders are removed from sanitized outputs.How to test your changes?
Run the following command to verify the header sanitization logic:
pnpm --filter @shopify/cli-kit vitest run src/private/node/api/headers.test.tsDuplicate check
git log --grep="\[Security\]" --oneline(asghis unavailable) and manually searched for similar PRs in the history.sanitizedHeadersOutput.Checklist
pnpm changeset add(Note: This is a security enhancement to internal logging/debugging, marked as non-user-facing bump wise if applicable, but changeset can be added if needed. Following Sentinel boundaries of small fixes.)PR created automatically by Jules for task 8609410605481335748 started by @gonzaloriestra