Skip to content

fix(cli): Redact onboarding run tokens from telemetry #2116

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
Abdkhan14 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(cli): Redact onboarding run tokens from telemetry #2116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31bb551
fix(cli): Redact onboarding run tokens from telemetry
Abdkhan14 Nov 9, 2026
983e14f
ref(cli): Explain why run tokens match on the field name
Abdkhan14 Nov 9, 2026
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
6 changes: 5 additions & 1 deletion packages/cli/src/lib/credential-redaction.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ const SENTRY_CREDENTIAL = new RegExp(
String.raw`\bsntry[suc]_[A-Za-z0-9._~+/=-]+(?:(?:\r\n|(?! )[\s\x00-\x1f\x7f-\x9f]|${ESCAPED_CONTROL})[ \t]*[A-Za-z0-9._~+/=-]+)*`,
"gi",
);
// Onboarding run tokens grant write access to a run's progress. They have no
// prefix to match on, so match the field name instead.
const RUN_TOKEN = /(\brun_?token\\*["']?\s*[=:]\s*\\*["']?)[A-Za-z0-9]+/gi;
Comment thread
evanpurkhiser marked this conversation as resolved.
Resolved

/**
* Use the runtime's final delimiter because an invalid token can contain quotes.
Expand Down Expand Up @@ -87,5 +90,6 @@ export function redactCredentialText(text: string): string {
: `${quote}[REDACTED]${quote}`,
)
.replace(BEARER_CREDENTIAL, "Bearer [REDACTED]")
.replace(SENTRY_CREDENTIAL, "[REDACTED]");
.replace(SENTRY_CREDENTIAL, "[REDACTED]")
.replace(RUN_TOKEN, "$1[REDACTED]");
}
13 changes: 13 additions & 0 deletions packages/cli/test/lib/credential-redaction.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,19 @@ describe("credential redaction", () => {
expect(redactCredentialText(message)).toBe(message);
});

test.each([
[
"runToken=SYNTHETIC0,stage=connect_agent",
"runToken=[REDACTED],stage=connect_agent",
],
['{"runToken":"SYNTHETIC0"}', '{"runToken":"[REDACTED]"}'],
])("redacts onboarding run tokens: %s", (input, expected) => {
expect(redactCredentialText(input)).toBe(expected);
expect(
JSON.parse(redactCredentialText(JSON.stringify({ message: input }))),
).toEqual({ message: expected });
});

test.each([
"sntrys_SYNTHETIC_PAYLOAD\n_SYNTHETIC_SECRET",
"sntryu_SYNTHETIC_PAYLOAD\r\n_SYNTHETIC_SECRET",
Expand Down
Loading