UNPKG

@bitkyc08/opencodex

Version:

Universal provider proxy for OpenAI Codex & Claude Code — use any LLM with Codex CLI/App/SDK and Claude Code

94 lines (87 loc) • 4.78 kB
/** * The read-only management surface a Remote Link Child may reach on its Home (#6957). * * Default deny: a path is readable only when it is listed here, the method is GET or HEAD, and * the query does not ask the Home to refresh upstream state. Everything else is refused on both * ends: the Child's listener and CLI refuse before sending, and the Home's link listener answers * 404 for any other path under the prefix. No route here returns a credential value; provider * and account projections report presence and masked identities only. * * A link read must not change the Home. The Home runs these reads passively * (`src/lib/passive-read.ts`): model discovery, which reaches provider upstreams and persists the * initial model selection of a pending provider, config writes and diagnostics do not run (#6959). * `tests/server/link-management-relay.test.ts` reads every path here and asserts that the Home * config and its upstreams are untouched. */ export const LINK_MANAGEMENT_PREFIX = "/v1/link-management"; /** The Home's OpenCodex-owned Codex settings a Child applies when it syncs. */ export const LINK_CODEX_SETTINGS_PATH = `${LINK_MANAGEMENT_PREFIX}/codex-settings`; export const LINK_ROUTE_INTENT_PATH = `${LINK_MANAGEMENT_PREFIX}/route-intent`; export const LINK_ROUTE_CATALOG_PATH = `${LINK_MANAGEMENT_PREFIX}/route-catalog`; export const LINK_MANAGEMENT_READ_PATHS: readonly string[] = [ "/api/system/health", "/api/startup-health", "/api/providers", "/api/settings", "/api/usage", "/api/effort-caps", "/api/injection-model", "/api/shadow-call-settings", "/api/sidecar-settings", "/api/v2", "/api/provider-quotas", "/api/quota-pool", "/api/fallback", "/api/codex-auth/active", "/api/codex-auth/accounts", "/api/oauth/accounts", "/api/providers/keys", "/api/oauth/providers", "/api/catalog", "/api/system/memory", "/api/provider-presets", "/api/provider-context-caps", ]; const READ_PATHS = new Set(LINK_MANAGEMENT_READ_PATHS); /** * Query keys that make a read trigger upstream work on the Home: forced refreshes and the * per-account quota probes `?quota=1` starts on the OAuth-account and key-pool reads. * `/api/models`, `/api/model-presets`, `/api/subagent-models` and `/api/subagent-model-fallback` * are absent for the same reason: they run live provider discovery and may persist initial model * selection. The preset preview exists only to decide a write a Child cannot make. */ const REFRESH_KEYS = ["refresh", "reload", "force", "quota"]; /** Is `method path?query` (a Home management path, without the link prefix) readable over the link? */ export function linkManagementReadAllowed(method: string, pathname: string, search: URLSearchParams | string = ""): boolean { const upper = method.toUpperCase(); if (upper !== "GET" && upper !== "HEAD") return false; if (!READ_PATHS.has(pathname)) return false; const query = typeof search === "string" ? new URLSearchParams(search) : search; return !REFRESH_KEYS.some(key => query.has(key)); } /** The Home management URL a prefixed link request names, or null when it names none. */ export function linkManagementTarget(url: URL): URL | null { if (!url.pathname.startsWith(`${LINK_MANAGEMENT_PREFIX}/api/`)) return null; const target = new URL(url.href); target.pathname = url.pathname.slice(LINK_MANAGEMENT_PREFIX.length); return target; } /** Home side: may the hub-link listener dispatch this request to the link management handler? */ export function linkManagementRouteAllowed(url: URL, req: Request): boolean { if (req.headers.has("upgrade")) return false; if (url.pathname === LINK_CODEX_SETTINGS_PATH || url.pathname === LINK_ROUTE_INTENT_PATH || url.pathname === LINK_ROUTE_CATALOG_PATH) return req.method === "GET" && url.search === ""; const target = linkManagementTarget(url); return target !== null && linkManagementReadAllowed(req.method, target.pathname, target.searchParams); } export function isLinkManagementPath(pathname: string): boolean { return pathname === LINK_MANAGEMENT_PREFIX || pathname.startsWith(`${LINK_MANAGEMENT_PREFIX}/`); } /** * The one refusal every management surface on a link Child uses: the dashboard relay, the CLI, * and the Child's listener. It names the Home and the link and never suggests a relay transport. * `homePhrase` is "Home <name>" or "its Home" when the Child does not know the Home's name. */ export function linkChildManagementRefusal(homePhrase: string, linkId: string, operation = "This management command"): string { return `This machine is a Remote Link Child managed by ${homePhrase} (link ${linkId}). ` + `${operation} runs on the Home, not on this Child: use the Home's dashboard or run the command there. No request was sent.`; }