Skip to content

fix(channel): redact GitHub App tokens from run error replies #87

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
RaphaelFakhri wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(channel): redact GitHub App tokens from run error replies #87

Show file tree
Hide file tree
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
12 changes: 12 additions & 0 deletions app/channel-helpers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,4 +154,16 @@ describe("userFacingRunError", () => {
expect(text).not.toContain("ghp_LIVESECRET99");
expect(text).toContain("ghp_[redacted]");
});

it.each(["ghs", "ghu", "ghr"])(
"redacts a %s_ GitHub App token from the reason",
(prefix) => {
const secret = `${prefix}_LIVESECRET99`;
const text = userFacingRunError(
new Error(`git push failed for https://x-access-token:${secret}@github.com/o/r`),
);
expect(text).not.toContain(secret);
expect(text).toContain(`${prefix}_[redacted]`);
},
);
});
4 changes: 3 additions & 1 deletion app/channel-helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@ export function reportRecoverableError(
});
}

const TOKEN_RE = /(ghp|github_pat|gho)_[A-Za-z0-9_]+/g;
// Same families as `agent/coding/sandbox.py`. GitHub App auth mints `ghs_`
// installation tokens, so the narrower pattern let those through to Slack.
const TOKEN_RE = /(ghp|github_pat|gho|ghs|ghu|ghr)_[A-Za-z0-9_]+/g;

function errorText(error: unknown): string {
if (error instanceof AggregateError) {
Expand Down