paperclip/.github/scripts/get-bot-token.mjs

155 lines
5.3 KiB
JavaScript

#!/usr/bin/env node
/**
* get-bot-token.mjs
* Generates a short-lived GitHub installation token.
*
* Generic callers set GITHUB_APP_ID and GITHUB_APP_PRIVATE_KEY. Existing
* commitperclip callers may continue to set COMMITPERCLIP_KEY.
* Prints the token to stdout.
*
* Also exports: generateJWT(privateKey), ghFetch(path, token, options)
* These are used by all other gate scripts.
*/
import { createSign } from 'node:crypto';
import { fileURLToPath } from 'node:url';
const COMMITPERCLIP_APP_ID = '3718661';
const OWNER_PATTERN = /^[a-zA-Z0-9_.-]+$/;
const REPO_PATTERN = /^[a-zA-Z0-9_.-]+\/[a-zA-Z0-9_.-]+$/;
export function generateJWT(privateKey, appId = COMMITPERCLIP_APP_ID) {
const now = Math.floor(Date.now() / 1000);
const payload = { iat: now - 10, exp: now + 60, iss: appId };
const header = Buffer.from(JSON.stringify({ alg: 'RS256', typ: 'JWT' })).toString('base64url');
const body = Buffer.from(JSON.stringify(payload)).toString('base64url');
const data = `${header}.${body}`;
const sig = createSign('RSA-SHA256').update(data).sign(privateKey, 'base64url');
return `${data}.${sig}`;
}
// Per-call timeout so a single slow/hung GitHub endpoint cannot eat the entire
// workflow budget. Overridable via options.timeoutMs for callers that need
// different bounds.
export const GH_FETCH_DEFAULT_TIMEOUT_MS = 15_000;
export async function ghFetch(path, token, options = {}) {
const { timeoutMs = GH_FETCH_DEFAULT_TIMEOUT_MS, signal: externalSignal, ...fetchOptions } = options;
const controller = new AbortController();
const timer = setTimeout(() => controller.abort(new Error(`ghFetch timeout after ${timeoutMs}ms: ${path}`)), timeoutMs);
const abortOnExternal = () => controller.abort(externalSignal?.reason);
if (externalSignal) {
if (externalSignal.aborted) abortOnExternal();
else externalSignal.addEventListener('abort', abortOnExternal, { once: true });
}
try {
const res = await fetch(`https://api.github.com${path}`, {
...fetchOptions,
signal: controller.signal,
headers: {
Authorization: `Bearer ${token}`,
Accept: 'application/vnd.github+json',
'X-GitHub-Api-Version': '2022-11-28',
...fetchOptions.headers,
},
});
const text = await res.text();
if (!res.ok) throw new Error(`GitHub API ${fetchOptions.method ?? 'GET'} ${path} → ${res.status}: ${text}`);
return JSON.parse(text);
} finally {
clearTimeout(timer);
if (externalSignal) externalSignal.removeEventListener('abort', abortOnExternal);
}
}
export async function resolveInstallationId(fetchInstallation, token, repo, owner, appName = 'GitHub App') {
if (repo) {
if (!REPO_PATTERN.test(repo)) {
throw new Error('ERROR: GH_REPO/GITHUB_REPOSITORY must be in owner/repo format.');
}
const installation = await fetchInstallation(`/repos/${repo}/installation`, token);
return installation.id;
}
const installations = await fetchInstallation('/app/installations', token);
if (!installations.length) {
throw new Error(`ERROR: No installations found for ${appName}.`);
}
if (owner) {
if (!OWNER_PATTERN.test(owner)) {
throw new Error('ERROR: GITHUB_REPOSITORY_OWNER must be a valid GitHub owner name.');
}
const match = installations.find(
installation => installation.account?.login?.toLowerCase() === owner.toLowerCase()
);
if (match) {
return match.id;
}
}
if (installations.length === 1) {
return installations[0].id;
}
throw new Error(
`ERROR: Multiple ${appName} installations found. Set GH_REPO or GITHUB_REPOSITORY so the correct installation can be selected.`
);
}
export function resolveAppCredentials(environment) {
const explicitAppId = environment.GITHUB_APP_ID;
const explicitPrivateKey = environment.GITHUB_APP_PRIVATE_KEY;
if (Boolean(explicitAppId) !== Boolean(explicitPrivateKey)) {
throw new Error('ERROR: GITHUB_APP_ID and GITHUB_APP_PRIVATE_KEY must be set together.');
}
if (explicitAppId && explicitPrivateKey) {
return {
appId: explicitAppId,
privateKey: explicitPrivateKey,
appName: environment.GITHUB_APP_NAME ?? 'GitHub App',
};
}
if (!environment.COMMITPERCLIP_KEY) {
throw new Error('ERROR: GITHUB_APP_PRIVATE_KEY or COMMITPERCLIP_KEY env var not set.');
}
return {
appId: COMMITPERCLIP_APP_ID,
privateKey: environment.COMMITPERCLIP_KEY,
appName: 'commitperclip',
};
}
async function main() {
const { appId, privateKey, appName } = resolveAppCredentials(process.env);
if (!/^\d+$/.test(appId)) {
console.error('ERROR: GITHUB_APP_ID must be a numeric GitHub App ID.');
process.exit(1);
}
const jwt = generateJWT(privateKey, appId);
const repo = process.env.GH_REPO ?? process.env.GITHUB_REPOSITORY;
const owner = process.env.GITHUB_REPOSITORY_OWNER ?? repo?.split('/')[0];
const installationId = await resolveInstallationId(ghFetch, jwt, repo, owner, appName);
const { token } = await ghFetch(
`/app/installations/${installationId}/access_tokens`,
jwt,
{ method: 'POST', headers: { 'Content-Type': 'application/json' } }
);
if (!token) {
console.error('ERROR: Failed to get installation token from GitHub API.');
process.exit(1);
}
process.stdout.write(token);
}
if (process.argv[1] === fileURLToPath(import.meta.url)) {
main().catch(e => { console.error(e.message); process.exit(1); });
}