fix(github): canonicalize accepted API base URLs #430
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,7 +31,9 @@ type JwtPayload = { | |
| iss?: string; | ||
| aud?: string | string[]; | ||
| repository?: string; | ||
| repository_id?: string; | ||
| repository_owner?: string; | ||
| repository_owner_id?: string; | ||
| workflow_ref?: string; | ||
| workflow_sha?: string; | ||
| job_workflow_ref?: string; | ||
|
|
@@ -141,7 +143,14 @@ const errorHints: Record<ErrorCode, string> = { | |
| const trustedHeaderValuePattern = /^[A-Za-z0-9._:-]+$/; | ||
| const clientIdentifierPattern = /^[A-Za-z0-9.:%_,-]+$/; | ||
| const exactWorkflowSourceShaPattern = /^[0-9a-f]{40}$/; | ||
| const githubInstallationTokenExpiryPattern = /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.(\d{1,3}))?Z$/; | ||
| const expectedRepositoryOwnerId = "295022177"; | ||
| const expectedRepositoryIds = new Map<string, string>([ | ||
| ["ContextualWisdomLab/noema", "1285107801"], | ||
| ["ContextualWisdomLab/.github", "1274066402"], | ||
| ]); | ||
|
Comment on lines
+147
to
+151
There was a problem hiding this comment. 🔍 Hardcoded owner/repository IDs become mandatory 403 gates
Was this helpful? React with 👍 or 👎 to provide feedback. |
||
| const maxTrustedHeaderLength = 128; | ||
| const maxInstallationTokenLifetimeMs = 65 * 60_000; | ||
|
|
||
| function jsonResponse(body: StandardErrorResponse | StandardSuccessResponse<unknown>, status = 200): Response { | ||
| return new Response(JSON.stringify(body), { | ||
|
|
@@ -191,6 +200,18 @@ function valueType(value: unknown): string { | |
| return typeof value; | ||
| } | ||
|
|
||
| function canonicalGithubInstallationTokenExpiry(value: string, parsedMs: number): boolean { | ||
| const match = value.match(githubInstallationTokenExpiryPattern); | ||
| if (!match) return false; | ||
| const milliseconds = (match[7] ?? "").padEnd(3, "0"); | ||
| const normalized = `${match[1]}-${match[2]}-${match[3]}T${match[4]}:${match[5]}:${match[6]}.${milliseconds}Z`; | ||
| try { | ||
| return new Date(parsedMs).toISOString() === normalized; | ||
| } catch { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| function requestClientKey(request: Request, route: string): string { | ||
| const client = request.headers.get("cf-connecting-ip") | ||
| || request.headers.get("x-real-ip") | ||
|
|
@@ -425,6 +446,20 @@ async function verifyGithubOidcJwt(token: string, env: Env): Promise<JwtPayload> | |
| const audiences = Array.isArray(payload.aud) ? payload.aud : [payload.aud]; | ||
| if (!audiences.includes(env.ALLOWED_AUDIENCE)) throw new ApiError("ERR_AUTH_INVALID", 401, "OIDC audience is not allowed"); | ||
| if (payload.repository_owner !== env.ALLOWED_REPOSITORY_OWNER) throw new ApiError("ERR_REPO_NOT_ALLOWED", 403, "OIDC repository owner is not allowed"); | ||
| if ( | ||
| payload.repository_owner_id !== undefined | ||
| && payload.repository_owner_id !== expectedRepositoryOwnerId | ||
| ) { | ||
| throw new ApiError("ERR_REPO_NOT_ALLOWED", 403, "OIDC repository owner identity is not allowed"); | ||
| } | ||
| const expectedRepositoryId = payload.repository ? expectedRepositoryIds.get(payload.repository) : undefined; | ||
| if ( | ||
| expectedRepositoryId !== undefined | ||
| && payload.repository_id !== undefined | ||
| && payload.repository_id !== expectedRepositoryId | ||
| ) { | ||
| throw new ApiError("ERR_REPO_NOT_ALLOWED", 403, "OIDC repository identity is not allowed"); | ||
| } | ||
|
|
||
| const workflowRef = payload.job_workflow_ref || payload.workflow_ref || ""; | ||
| if (workflowRef !== env.ALLOWED_WORKFLOW_REF_PREFIX) { | ||
|
|
@@ -451,10 +486,19 @@ async function verifyGithubOidcJwt(token: string, env: Env): Promise<JwtPayload> | |
| { match_policy: "exact-ref-and-source-sha" }, | ||
| ); | ||
| } | ||
| if (payload.nbf !== undefined && (typeof payload.nbf !== "number" || !Number.isFinite(payload.nbf))) { | ||
| throw new ApiError("ERR_AUTH_INVALID", 401, "OIDC not-before claim is invalid"); | ||
| } | ||
| if (typeof payload.nbf === "number" && payload.nbf > now + 30) { | ||
| throw new ApiError("ERR_AUTH_INVALID", 401, "OIDC token is not valid yet"); | ||
| } | ||
| if (payload.iat !== undefined && (typeof payload.iat !== "number" || !Number.isFinite(payload.iat))) { | ||
| throw new ApiError("ERR_AUTH_INVALID", 401, "OIDC issued-at claim is invalid"); | ||
| } | ||
| if (typeof payload.iat === "number" && payload.iat > now + 30) { | ||
| throw new ApiError("ERR_AUTH_INVALID", 401, "OIDC token was issued in the future"); | ||
| } | ||
| if (typeof payload.exp !== "number" || !Number.isFinite(payload.exp) || payload.exp < now - 30) { | ||
| throw new ApiError("ERR_AUTH_INVALID", 401, "OIDC token is expired"); | ||
| } | ||
|
|
||
|
|
@@ -501,8 +545,8 @@ type GitHubJsonRequestInit = RequestInit & { | |
| headers: Record<string, string>; | ||
| }; | ||
|
|
||
| async function githubJson(path: string, init: GitHubJsonRequestInit, env: Env): Promise<Record<string, unknown>> { | ||
| const response = await fetch(new URL(path, env.GITHUB_API_BASE), { | ||
| ...init, | ||
| headers: { | ||
| accept: "application/vnd.github+json", | ||
|
|
@@ -520,11 +564,30 @@ async function githubJson(path: string, init: GitHubJsonRequestInit, env: Env): | |
| } | ||
| throw new ApiError("ERR_GITHUB_API", response.status >= 400 ? 400 : 500, "GitHub API request failed"); | ||
| } | ||
| let value: unknown; | ||
| try { | ||
| value = await response.json(); | ||
| } catch { | ||
| throw new ApiError("ERR_GITHUB_API", 502, "GitHub API returned malformed JSON"); | ||
| } | ||
| if (!value || typeof value !== "object" || Array.isArray(value)) { | ||
| throw new ApiError("ERR_GITHUB_API", 502, "GitHub API returned invalid JSON shape"); | ||
| } | ||
| return value as Record<string, unknown>; | ||
| } | ||
|
|
||
| async function resolveInstallationId(appJwt: string, repository: string, env: Env): Promise<string> { | ||
| if (env.GITHUB_APP_INSTALLATION_ID) { | ||
| const configuredInstallationId = env.GITHUB_APP_INSTALLATION_ID; | ||
| if (!/^[1-9]\d*$/.test(configuredInstallationId)) { | ||
| throw new ApiError("ERR_GITHUB_INSTALLATION", 500, "GitHub App installation id configuration is invalid"); | ||
| } | ||
| const numericInstallationId = Number(configuredInstallationId); | ||
| if (!Number.isSafeInteger(numericInstallationId) || String(numericInstallationId) !== configuredInstallationId) { | ||
| throw new ApiError("ERR_GITHUB_INSTALLATION", 500, "GitHub App installation id configuration is invalid"); | ||
| } | ||
| return configuredInstallationId; | ||
| } | ||
| const now = Date.now(); | ||
| const cacheKey = `${env.GITHUB_API_BASE}:${env.GITHUB_APP_ID}:${repository}`; | ||
| const cached = installationIdCache.get(cacheKey); | ||
|
|
@@ -538,7 +601,16 @@ async function resolveInstallationId(appJwt: string, repository: string, env: En | |
| const installation = await githubJson(`/repos/${repository}/installation`, { | ||
| headers: { authorization: `Bearer ${appJwt}` }, | ||
| }, env); | ||
| if (installation.id === undefined || installation.id === null) { | ||
| throw new ApiError("ERR_GITHUB_INSTALLATION", 500, "GitHub App installation id was not found"); | ||
| } | ||
| if ( | ||
| typeof installation.id !== "number" | ||
| || !Number.isSafeInteger(installation.id) | ||
| || installation.id <= 0 | ||
| ) { | ||
| throw new ApiError("ERR_GITHUB_API", 502, "GitHub API returned invalid installation response"); | ||
| } | ||
| const installationId = String(installation.id); | ||
| installationIdCache.set(cacheKey, { | ||
| value: installationId, | ||
|
|
@@ -555,21 +627,44 @@ async function createInstallationToken(repository: string, env: Env): Promise<In | |
| headers: { authorization: `Bearer ${appJwt}` }, | ||
| body: JSON.stringify({ repositories: [repository.split("/", 2)[1]], permissions: { pull_requests: "write", contents: "read", checks: "read" } }), | ||
| }, env); | ||
| if (token.token === undefined || token.token === null || token.token === "") { | ||
| throw new ApiError("ERR_GITHUB_INSTALLATION", 500, "GitHub installation token response was empty", { | ||
| field: "token", | ||
| reason: "required", | ||
| }); | ||
| } | ||
| if (typeof token.token !== "string") { | ||
| throw new ApiError("ERR_GITHUB_API", 502, "GitHub API returned invalid installation-token response"); | ||
| } | ||
| if (token.expires_at === undefined || token.expires_at === null || token.expires_at === "") { | ||
| throw new ApiError("ERR_GITHUB_INSTALLATION", 500, "GitHub installation token response did not include a valid expires_at", { | ||
| field: "expires_at", | ||
| reason: "must be a valid timestamp", | ||
| }); | ||
| } | ||
| if (typeof token.expires_at !== "string") { | ||
| throw new ApiError("ERR_GITHUB_API", 502, "GitHub API returned invalid installation-token response"); | ||
| } | ||
| const expiresAtMs = Date.parse(token.expires_at); | ||
| if (Number.isNaN(expiresAtMs)) { | ||
| throw new ApiError("ERR_GITHUB_INSTALLATION", 500, "GitHub installation token response did not include a valid expires_at", { | ||
| field: "expires_at", | ||
| reason: "must be a valid timestamp", | ||
| }); | ||
| } | ||
| if (!canonicalGithubInstallationTokenExpiry(token.expires_at, expiresAtMs)) { | ||
| throw new ApiError("ERR_GITHUB_API", 502, "GitHub API returned invalid installation-token expiry"); | ||
| } | ||
| const nowMs = Date.now(); | ||
| if (expiresAtMs <= nowMs) { | ||
| throw new ApiError("ERR_GITHUB_API", 502, "GitHub API returned expired installation-token response"); | ||
| } | ||
| if (expiresAtMs > nowMs + maxInstallationTokenLifetimeMs) { | ||
| throw new ApiError("ERR_GITHUB_API", 502, "GitHub API returned implausible installation-token expiry"); | ||
| } | ||
| return { | ||
| token: token.token, | ||
| expires_at: token.expires_at, | ||
| }; | ||
| } | ||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📝 Info: Bearer envelope now returns 400 instead of 401 for whitespace-only tokens
isBoundedOidcBearernow treats any value starting withBearer(then whitespace or end) as a JWT envelope that must match^Bearer\s+(\S+)$. Whitespace-only and embedded-whitespace Bearer values that previously reached the 401 missing-token path now fail closed with 400ERR_TOKEN_MALFORMED. The prefilter test was updated to match; any client depending on the old 401 sees a changed status and error code.(Refers to this code)
Was this helpful? React with 👍 or 👎 to provide feedback.