mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
Fixes #3206. ## The report `headroom wrap codex` / `init codex` write a provider block without `requires_openai_auth = true`. Codex then attaches **no `Authorization` header**, and every request through the proxy 401s: ``` unexpected status 401 Unauthorized: Missing bearer or basic authentication in header ``` Silently — `headroom doctor` reported green throughout. The reporter lost ~15h of scheduled Codex automation before bisecting it. ## Not the fix the issue suggested The issue proposes adding the line unconditionally. **That would re-break API-key users**, which is the regression `requires_openai_auth` was made conditional for in the first place (#406) — the flag forces Codex to demand an OpenAI OAuth login. All three writers (install provider-scope, `init codex`, `wrap codex`) *already* call `codex_uses_chatgpt_auth()` and emit the key when it returns True. **The bug is in the detection, not the writers.** ## Root cause `codex_uses_chatgpt_auth` recognised two shapes: 1. `auth_mode == "chatgpt"` 2. a top-level `tokens.account_id` Newer Codex can write an `auth.json` with **neither** — the account identity lives only in the `id_token` claims, under `https://api.openai.com/auth.chatgpt_account_id`. That config reads as API-key mode, the flag is omitted, and every request 401s. Verified against a real `auth.json`: the JWT claim carries the *same* account id as the top-level key, so it is a faithful signal for the shape that lacks it. ## Fix A third detection tier, consulted only when the first two are absent: | Shape | Before | After | |---|---|---| | `auth_mode = "chatgpt"` | True | True | | legacy `tokens.account_id` | True | True | | **only the `id_token` claim** | **False** ← the bug | **True** | | `auth_mode = "apikey"` + ChatGPT id_token | False | **False** (#406 stays closed) | | API key, no tokens | False | False | | id_token without the claim / malformed / blank id | False | False | The payload is **decoded, not verified**. It is a local file the user already owns, and the result only chooses which key we write into their own `config.toml` — nothing is authenticated or authorised on the strength of it. An API-key user has no ChatGPT id_token, so this cannot resurrect #406, and an explicit `auth_mode` still wins outright (pinned by test). ## Doctor stops reporting a false green This failure is invisible from every other signal — proxy up, provider block present. So the codex check now WARNs when the config is routed, the user is on ChatGPT auth, **and** the block lacks the flag, naming the re-run that repairs it. It only runs when the flag is already missing, and the keyring fallback it can reach is bounded by an existing 3s timeout, so `doctor` stays fast. API-key users are never nagged. ## Existing configs Self-healing — all three writers strip and regenerate the managed block on every run, so re-running `wrap`/`init` emits the key now that detection is correct. No separate migration needed. ## Testing 99 passing across the two suites. Confirmed **discriminating**: 3 of the new tests fail against unfixed source and pass after — - `test_chatgpt_auth_detected_from_id_token_claims_alone` - `test_provider_block_emits_requires_openai_auth_for_the_new_shape` - `TestCodexRouting::test_chatgpt_auth_without_requires_openai_auth_warns` plus explicit coverage for the #406 guard, malformed tokens, blank account ids, and the API-key-not-nagged case. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Tejas Chopra <tejas@Tejass-MacBook-Pro.local> Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
188 lines
6.7 KiB
Python
188 lines
6.7 KiB
Python
from __future__ import annotations
|
|
|
|
from pathlib import Path
|
|
|
|
from headroom.providers.codex.install import build_provider_section, codex_uses_chatgpt_auth
|
|
|
|
|
|
def test_codex_provider_section_omits_requires_openai_auth_by_default() -> None:
|
|
"""#406: the flag must default off (API-key users), and only on for OAuth.
|
|
|
|
Setting requires_openai_auth on a custom [model_providers.headroom] block
|
|
forces codex to demand OpenAI OAuth login for every headroom-routed request,
|
|
which breaks API-key users; so callers opt in explicitly for ChatGPT users.
|
|
"""
|
|
section = build_provider_section(port=8787, name="OpenAI via Headroom proxy")
|
|
|
|
assert 'name = "OpenAI via Headroom proxy"' in section
|
|
assert 'base_url = "http://127.0.0.1:8787/v1"' in section
|
|
assert "requires_openai_auth" not in section, (
|
|
f"requires_openai_auth must be absent by default; got:\n{section}"
|
|
)
|
|
assert "supports_websockets = true" in section
|
|
assert 'env_key = "OPENAI_API_KEY"' not in section
|
|
|
|
|
|
def test_codex_provider_section_emits_requires_openai_auth_when_flagged() -> None:
|
|
section = build_provider_section(
|
|
port=8787, name="OpenAI via Headroom proxy", requires_openai_auth=True
|
|
)
|
|
|
|
assert "requires_openai_auth = true" in section
|
|
|
|
|
|
def test_codex_uses_chatgpt_auth_true_for_chatgpt_mode(tmp_path: Path) -> None:
|
|
auth = tmp_path / "auth.json"
|
|
auth.write_text('{"auth_mode": "chatgpt"}', encoding="utf-8")
|
|
|
|
assert codex_uses_chatgpt_auth(auth) is True
|
|
|
|
|
|
def test_codex_uses_chatgpt_auth_true_for_account_id_without_mode(tmp_path: Path) -> None:
|
|
auth = tmp_path / "auth.json"
|
|
auth.write_text('{"tokens": {"account_id": "acct_1"}}', encoding="utf-8")
|
|
|
|
assert codex_uses_chatgpt_auth(auth) is True
|
|
|
|
|
|
def test_codex_uses_chatgpt_auth_false_for_api_key(tmp_path: Path) -> None:
|
|
auth = tmp_path / "auth.json"
|
|
auth.write_text('{"auth_mode": "apikey", "OPENAI_API_KEY": "sk-x"}', encoding="utf-8")
|
|
|
|
assert codex_uses_chatgpt_auth(auth) is False
|
|
|
|
|
|
def test_codex_uses_chatgpt_auth_false_for_missing_or_malformed(tmp_path: Path) -> None:
|
|
assert codex_uses_chatgpt_auth(tmp_path / "absent.json") is False
|
|
bad = tmp_path / "auth.json"
|
|
bad.write_text("not json", encoding="utf-8")
|
|
assert codex_uses_chatgpt_auth(bad) is False
|
|
|
|
|
|
def test_codex_uses_chatgpt_auth_false_for_non_dict_json(tmp_path: Path) -> None:
|
|
auth = tmp_path / "auth.json"
|
|
auth.write_text("[]", encoding="utf-8")
|
|
|
|
assert codex_uses_chatgpt_auth(auth) is False
|
|
|
|
|
|
def test_codex_uses_chatgpt_auth_false_for_empty_object(tmp_path: Path) -> None:
|
|
auth = tmp_path / "auth.json"
|
|
auth.write_text("{}", encoding="utf-8")
|
|
|
|
assert codex_uses_chatgpt_auth(auth) is False
|
|
|
|
|
|
def test_codex_provider_section_supports_custom_markers() -> None:
|
|
section = build_provider_section(
|
|
port=9100,
|
|
name="Headroom init proxy",
|
|
marker_start="# --- start ---",
|
|
marker_end="# --- end ---",
|
|
)
|
|
|
|
assert section.startswith("# --- start ---\n")
|
|
assert section.endswith("# --- end ---\n")
|
|
assert 'base_url = "http://127.0.0.1:9100/v1"' in section
|
|
assert 'env_key = "OPENAI_API_KEY"' not in section
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# ChatGPT-auth detection from the id_token claims (#3206)
|
|
#
|
|
# Newer Codex releases can write an auth.json with neither `auth_mode` nor a
|
|
# top-level `tokens.account_id`; the account identity lives only in the
|
|
# id_token claims. Those configs read as API-key mode, so requires_openai_auth
|
|
# is omitted, Codex attaches no Authorization header, and every request 401s
|
|
# with "Missing bearer" -- silently, with doctor reporting green.
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
def _unsigned_jwt(claims: dict[str, object]) -> str:
|
|
import base64
|
|
import json as _json
|
|
|
|
def seg(raw: bytes) -> str:
|
|
return base64.urlsafe_b64encode(raw).decode("ascii").rstrip("=")
|
|
|
|
header = seg(b'{"alg":"none"}')
|
|
payload = seg(_json.dumps(claims).encode("utf-8"))
|
|
return ".".join((header, payload, "sig"))
|
|
|
|
|
|
_CHATGPT_CLAIMS: dict[str, object] = {
|
|
"https://api.openai.com/auth": {
|
|
"chatgpt_account_id": "1a155430-5551-47f4-9c7b-aeab7983f24a",
|
|
"chatgpt_plan_type": "pro",
|
|
}
|
|
}
|
|
|
|
|
|
def _write_auth(tmp_path, document: dict[str, object]): # noqa: ANN001, ANN202
|
|
import json as _json
|
|
|
|
path = tmp_path / "auth.json"
|
|
path.write_text(_json.dumps(document), encoding="utf-8")
|
|
return path
|
|
|
|
|
|
def test_chatgpt_auth_detected_from_id_token_claims_alone(tmp_path) -> None:
|
|
"""The #3206 shape: no auth_mode, no tokens.account_id, only the JWT."""
|
|
path = _write_auth(tmp_path, {"tokens": {"id_token": _unsigned_jwt(_CHATGPT_CLAIMS)}})
|
|
|
|
assert codex_uses_chatgpt_auth(path) is True
|
|
|
|
|
|
def test_explicit_api_key_mode_still_wins_over_a_chatgpt_id_token(tmp_path) -> None:
|
|
"""Guards the #406 regression: API-key users must not get forced OAuth."""
|
|
path = _write_auth(
|
|
tmp_path,
|
|
{"auth_mode": "apikey", "tokens": {"id_token": _unsigned_jwt(_CHATGPT_CLAIMS)}},
|
|
)
|
|
|
|
assert codex_uses_chatgpt_auth(path) is False
|
|
|
|
|
|
def test_api_key_config_without_tokens_is_not_chatgpt(tmp_path) -> None:
|
|
path = _write_auth(tmp_path, {"OPENAI_API_KEY": "sk-test"})
|
|
|
|
assert codex_uses_chatgpt_auth(path) is False
|
|
|
|
|
|
def test_id_token_without_the_chatgpt_claim_is_not_chatgpt(tmp_path) -> None:
|
|
path = _write_auth(tmp_path, {"tokens": {"id_token": _unsigned_jwt({"sub": "user"})}})
|
|
|
|
assert codex_uses_chatgpt_auth(path) is False
|
|
|
|
|
|
def test_malformed_id_token_is_not_chatgpt(tmp_path) -> None:
|
|
for bogus in ("not-a-jwt", "a.b", "a.!!!not-base64!!!.c", ""):
|
|
path = _write_auth(tmp_path, {"tokens": {"id_token": bogus}})
|
|
assert codex_uses_chatgpt_auth(path) is False, bogus
|
|
|
|
|
|
def test_blank_chatgpt_account_id_is_not_chatgpt(tmp_path) -> None:
|
|
claims = {"https://api.openai.com/auth": {"chatgpt_account_id": " "}}
|
|
path = _write_auth(tmp_path, {"tokens": {"id_token": _unsigned_jwt(claims)}})
|
|
|
|
assert codex_uses_chatgpt_auth(path) is False
|
|
|
|
|
|
def test_legacy_account_id_still_detected(tmp_path) -> None:
|
|
path = _write_auth(tmp_path, {"tokens": {"account_id": "acct-123"}})
|
|
|
|
assert codex_uses_chatgpt_auth(path) is True
|
|
|
|
|
|
def test_provider_block_emits_requires_openai_auth_for_the_new_shape(tmp_path) -> None:
|
|
"""End of the chain: the JWT-only shape must produce the key Codex needs."""
|
|
path = _write_auth(tmp_path, {"tokens": {"id_token": _unsigned_jwt(_CHATGPT_CLAIMS)}})
|
|
|
|
block = build_provider_section(
|
|
port=8787,
|
|
name="Headroom",
|
|
include_markers=False,
|
|
requires_openai_auth=codex_uses_chatgpt_auth(path),
|
|
)
|
|
|
|
assert "requires_openai_auth = true" in block
|