Skip to content

[Security] Redact cookies in sanitized headers output#7539

Draft
gonzaloriestra wants to merge 1 commit into
mainfrom
sentinel-redact-cookies-headers-sanitization-8609410605481335748
Draft

[Security] Redact cookies in sanitized headers output#7539
gonzaloriestra wants to merge 1 commit into
mainfrom
sentinel-redact-cookies-headers-sanitization-8609410605481335748

Conversation

@gonzaloriestra
Copy link
Copy Markdown
Contributor

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 sanitizedHeadersOutput function in @shopify/cli-kit to redact sensitive headers. This ensures that both Cookie and Set-Cookie headers 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.ts

Duplicate check

  • Ran: git log --grep="\[Security\]" --oneline (as gh is unavailable) and manually searched for similar PRs in the history.
  • Found no existing PR addressing cookie redaction in sanitizedHeadersOutput.

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes
  • I've considered analytics changes to measure impact
  • The change is user-facing — I've identified the correct bump type and added a changeset with 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

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.
@google-labs-jules
Copy link
Copy Markdown

👋 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 @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@github-actions github-actions Bot added the no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. label May 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. security

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant