mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-09-22 06:42:19 +03:00
* fix(codex): forward the caller client version upstream instead of pinning 0.144.1 The Codex provider reported a hardcoded client version (DEFAULT_CODEX_CLIENT_VERSION) to the ChatGPT backend. Newer gated models reject older clients, e.g.: The 'gpt-6-astra' model requires a newer version of Codex. so the pinned value silently rots on every CLI upgrade, and a user on the latest CLI is still refused. CodexExecutor.buildHeaders also dropped the clientHeaders/model/health arguments that the base class accepts (base.ts:509), so the caller User-Agent never reached the version resolution. - codexClient.ts: add getCodexClientVersionFromHeaders(), which reads the version the caller reports in its User-Agent (codex_cli_rs/<v>, codex_exec/<v>) or a version header, validated against SAFE_HEADER_TOKEN_PATTERN. getCodexUserAgent() now takes an optional version override. - codex.ts: forward clientHeaders/model/health to super.buildHeaders(), and use getCodexClientVersionFromHeaders(clientHeaders) ?? getCodexClientVersion(). Falls back to the existing env override / default when the caller sends nothing. * test(codex): cover getCodexClientVersionFromHeaders and clientHeaders-aware buildHeaders Adds unit coverage for the caller-version forwarding introduced in this PR: real Codex CLI User-Agent parsing, the generic version header, missing/empty headers, non-Codex User-Agent, and CRLF/oversized injection attempts safely returning null/falling back to the default version. Co-authored-by: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com> --------- Co-authored-by: Zeeshan Haque <zeeshan@moonscape.local> Co-authored-by: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com>
146 lines
5.0 KiB
TypeScript
146 lines
5.0 KiB
TypeScript
import {
|
|
CODEX_CLI_RS_ORIGINATOR,
|
|
DEFAULT_CODEX_CLIENT_VERSION,
|
|
getCodexCliRsHeaders as buildCodexCliRsHeaders,
|
|
} from "@/shared/constants/codexClient";
|
|
|
|
export {
|
|
DEFAULT_CODEX_CLIENT_VERSION,
|
|
CODEX_CLI_RS_ORIGINATOR,
|
|
} from "@/shared/constants/codexClient";
|
|
const DEFAULT_CODEX_USER_AGENT_PLATFORM = "Windows 10.0.26200";
|
|
const DEFAULT_CODEX_USER_AGENT_ARCH = "x64";
|
|
const CODEX_VERSION_OVERRIDE_ENV = "CODEX_CLIENT_VERSION";
|
|
const CODEX_USER_AGENT_OVERRIDE_ENV = "CODEX_USER_AGENT";
|
|
const SAFE_HEADER_TOKEN_PATTERN = /^[A-Za-z0-9][A-Za-z0-9._-]{0,31}$/;
|
|
const SAFE_HEADER_VALUE_PATTERN = /^[\x20-\x7E]{1,200}$/;
|
|
const SAFE_CODEX_SESSION_ID_PATTERN = /^[A-Za-z0-9._:-]{1,200}$/;
|
|
|
|
function getSafeEnvValue(name: string, pattern: RegExp): string | null {
|
|
const raw = process.env[name];
|
|
if (typeof raw !== "string") return null;
|
|
const normalized = raw.trim();
|
|
if (!normalized || !pattern.test(normalized)) {
|
|
return null;
|
|
}
|
|
return normalized;
|
|
}
|
|
|
|
export function getCodexClientVersion(): string {
|
|
return (
|
|
getSafeEnvValue(CODEX_VERSION_OVERRIDE_ENV, SAFE_HEADER_TOKEN_PATTERN) ||
|
|
DEFAULT_CODEX_CLIENT_VERSION
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Extract the Codex client version the CALLER actually reported, so OmniRoute
|
|
* forwards it upstream instead of substituting a pinned default. The official
|
|
* CLI sends it in User-Agent, e.g.
|
|
* codex_cli_rs/0.154.0 (Mac OS 26.6.2; arm64) ...
|
|
* codex_exec/0.154.0 (Mac OS 26.6.2; arm64) xterm-256color (codex_exec; 0.154.0)
|
|
* Some clients also send a `version` header.
|
|
*
|
|
* Why this matters: the ChatGPT backend gates newer models on the client
|
|
* version ("The 'gpt-6-astra' model requires a newer version of Codex").
|
|
* A pinned default silently rots every time the user upgrades their CLI.
|
|
*
|
|
* Returns null when the caller sent nothing usable, so callers can fall back
|
|
* to getCodexClientVersion().
|
|
*/
|
|
const CODEX_CLIENT_VERSION_IN_UA_PATTERN = /(?:codex[-_][A-Za-z0-9_]*|codex-cli)\/(\d+\.\d+\.\d+)/i;
|
|
|
|
export function getCodexClientVersionFromHeaders(
|
|
clientHeaders?: Record<string, string> | null
|
|
): string | null {
|
|
if (!clientHeaders) return null;
|
|
|
|
const pick = (name: string): string | null => {
|
|
const direct = clientHeaders[name];
|
|
if (typeof direct === "string" && direct.trim()) return direct.trim();
|
|
const lower = name.toLowerCase();
|
|
for (const [k, v] of Object.entries(clientHeaders)) {
|
|
if (k.toLowerCase() === lower && typeof v === "string" && v.trim()) {
|
|
return v.trim();
|
|
}
|
|
}
|
|
return null;
|
|
};
|
|
|
|
const fromVersionHeader = pick("version");
|
|
if (fromVersionHeader && SAFE_HEADER_TOKEN_PATTERN.test(fromVersionHeader)) {
|
|
return fromVersionHeader;
|
|
}
|
|
|
|
const userAgent = pick("user-agent");
|
|
if (!userAgent) return null;
|
|
|
|
const match = CODEX_CLIENT_VERSION_IN_UA_PATTERN.exec(userAgent);
|
|
if (!match) return null;
|
|
|
|
const version = match[1];
|
|
return SAFE_HEADER_TOKEN_PATTERN.test(version) ? version : null;
|
|
}
|
|
|
|
export function getCodexUserAgent(versionOverride?: string | null): string {
|
|
const override = getSafeEnvValue(CODEX_USER_AGENT_OVERRIDE_ENV, SAFE_HEADER_VALUE_PATTERN);
|
|
if (override) {
|
|
return override;
|
|
}
|
|
|
|
const version =
|
|
versionOverride && SAFE_HEADER_TOKEN_PATTERN.test(versionOverride)
|
|
? versionOverride
|
|
: getCodexClientVersion();
|
|
|
|
return `codex-cli/${version} (${DEFAULT_CODEX_USER_AGENT_PLATFORM}; ${DEFAULT_CODEX_USER_AGENT_ARCH})`;
|
|
}
|
|
|
|
export function getCodexDefaultHeaders(): Record<string, string> {
|
|
return {
|
|
Version: getCodexClientVersion(),
|
|
"Openai-Beta": "responses=experimental",
|
|
"X-Codex-Beta-Features": "responses_websockets",
|
|
"User-Agent": getCodexUserAgent(),
|
|
};
|
|
}
|
|
|
|
export function getCodexCliRsHeaders(): Record<string, string> {
|
|
return buildCodexCliRsHeaders(getCodexClientVersion());
|
|
}
|
|
|
|
/**
|
|
* Identity for the credential face (auth.openai.com: token exchange / refresh).
|
|
* The real Codex client sends only `originator` + `User-Agent` on that face
|
|
* (codex-rs login/default_client.rs default_headers()); the `Version` header
|
|
* gate exists only on the chatgpt.com/backend-api inference face, so it is
|
|
* deliberately omitted here. Mirrors sub2api v0.1.178
|
|
* ApplyCodexCanonicalAuthIdentity.
|
|
*/
|
|
export function getCodexAuthIdentityHeaders(): Record<string, string> {
|
|
return {
|
|
"User-Agent": getCodexUserAgent(),
|
|
originator: CODEX_CLI_RS_ORIGINATOR,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Canonical Codex CLI identity for server-initiated calls against the
|
|
* chatgpt.com/backend-api face that are not tied to one end-client request
|
|
* (usage / quota / models manifest / reset-credits). Same UA/version chain as
|
|
* inference so these calls do not show up upstream as anonymous half-identities.
|
|
*/
|
|
export function getCodexBackendIdentityHeaders(): Record<string, string> {
|
|
return {
|
|
"User-Agent": getCodexUserAgent(),
|
|
originator: CODEX_CLI_RS_ORIGINATOR,
|
|
Version: getCodexClientVersion(),
|
|
};
|
|
}
|
|
|
|
export function normalizeCodexSessionId(value: unknown): string | null {
|
|
if (typeof value !== "string") return null;
|
|
const normalized = value.trim();
|
|
return SAFE_CODEX_SESSION_ID_PATTERN.test(normalized) ? normalized : null;
|
|
}
|