mirror of
https://github.com/pchuan98/codex.git
synced 2026-07-01 00:31:56 +08:00
df7818c7d1
## Summary - add v2 personal access token support for `codex login --with-access-token` and `CODEX_ACCESS_TOKEN` - classify opaque `at-` tokens separately from legacy Agent Identity JWTs - hydrate required ChatGPT account metadata through AuthAPI `/v1/user-auth-credential/whoami` - use PATs directly as bearer tokens while preserving existing ChatGPT account surfaces - expose PAT-backed auth as the explicit `personalAccessToken` app-server auth mode ## Implementation PAT auth is intentionally small and stateless. Loading a PAT performs one AuthAPI metadata request, stores the hydrated metadata in the in-memory auth object, and redacts the secret from debug output. Legacy Agent Identity JWT handling remains unchanged. The shared access-token classifier lives in a private neutral module because it dispatches between both credential types. PAT hydration fails closed when AuthAPI omits any required metadata, including email. Hydrated metadata is intentionally not persisted: startup performs a live `whoami` preflight so revoked tokens or changed account metadata are not accepted from a stale cache. ## Workspace restriction scope This change intentionally does **not** apply `forced_chatgpt_workspace_id` to PAT authentication. The setting is a client-side config guardrail, not an authorization boundary, and PAT does not currently require workspace-ID parity. The PAT login and `CODEX_ACCESS_TOKEN` paths therefore validate through AuthAPI without threading workspace-restriction state through access-token loading. Existing workspace checks for non-PAT auth remain on their established paths. ## App-server compatibility The public app-server `AuthMode` is shared across v1 and v2, and PAT-backed auth reports `personalAccessToken` through both APIs. Following human review, this intentionally removes the temporary v1 compatibility mapping that reported PATs as `chatgpt`; the deprecated v1 API is kept in parity with v2 rather than maintaining a separate closed enum. Clients with exhaustive auth-mode handling in either API version must add the new case and should generally treat it as ChatGPT-backed unless they need PAT-specific behavior. The v1 auth-status response still omits the raw PAT when `includeToken` is requested because that response cannot carry the account metadata needed to reuse the credential safely. Persisted PAT auth also omits the new enum value so older Codex builds can deserialize `auth.json` and infer PAT auth from the credential field after a rollback. ## Validation Latest review-fix validation: - `CARGO_INCREMENTAL=0 just test -p codex-login` (126 passed) - `CARGO_INCREMENTAL=0 just test -p codex-cli` (263 passed) - `CARGO_INCREMENTAL=0 just test -p codex-cli stored_auth_validation_handles_personal_access_token` - `CARGO_INCREMENTAL=0 just test -p codex-app-server-protocol` (226 passed) - `CARGO_INCREMENTAL=0 just test -p codex-models-manager refresh_available_models_uses_remote_only_catalog_for_chatgpt_auth` - `CARGO_INCREMENTAL=0 just test -p codex-tui existing_non_oauth_chatgpt_login_counts_as_signed_in` - `CARGO_INCREMENTAL=0 just fix -p codex-login -p codex-app-server-protocol -p codex-models-manager -p codex-tui -p codex-cli` - `just fmt` - `git diff --check` The broader `codex-tui` suite previously compiled and ran 2,834 tests. Three unrelated environment-sensitive guardian/IDE-socket tests failed after retries; the PAT-relevant TUI coverage passed.
172 lines
5.3 KiB
Rust
172 lines
5.3 KiB
Rust
use std::path::Path;
|
|
|
|
use anyhow::Context;
|
|
use anyhow::Result;
|
|
use base64::Engine;
|
|
use base64::engine::general_purpose::URL_SAFE_NO_PAD;
|
|
use chrono::DateTime;
|
|
use chrono::Utc;
|
|
use codex_app_server_protocol::AuthMode;
|
|
use codex_config::types::AuthCredentialsStoreMode;
|
|
use codex_login::AuthDotJson;
|
|
use codex_login::save_auth;
|
|
use codex_login::token_data::TokenData;
|
|
use codex_login::token_data::parse_chatgpt_jwt_claims;
|
|
use serde_json::json;
|
|
|
|
/// Builder for writing a fake ChatGPT auth.json in tests.
|
|
#[derive(Debug, Clone)]
|
|
pub struct ChatGptAuthFixture {
|
|
access_token: String,
|
|
refresh_token: String,
|
|
account_id: Option<String>,
|
|
claims: ChatGptIdTokenClaims,
|
|
last_refresh: Option<Option<DateTime<Utc>>>,
|
|
}
|
|
|
|
impl ChatGptAuthFixture {
|
|
pub fn new(access_token: impl Into<String>) -> Self {
|
|
Self {
|
|
access_token: access_token.into(),
|
|
refresh_token: "refresh-token".to_string(),
|
|
account_id: None,
|
|
claims: ChatGptIdTokenClaims::default(),
|
|
last_refresh: None,
|
|
}
|
|
}
|
|
|
|
pub fn refresh_token(mut self, refresh_token: impl Into<String>) -> Self {
|
|
self.refresh_token = refresh_token.into();
|
|
self
|
|
}
|
|
|
|
pub fn account_id(mut self, account_id: impl Into<String>) -> Self {
|
|
self.account_id = Some(account_id.into());
|
|
self
|
|
}
|
|
|
|
pub fn plan_type(mut self, plan_type: impl Into<String>) -> Self {
|
|
self.claims.plan_type = Some(plan_type.into());
|
|
self
|
|
}
|
|
|
|
pub fn chatgpt_user_id(mut self, chatgpt_user_id: impl Into<String>) -> Self {
|
|
self.claims.chatgpt_user_id = Some(chatgpt_user_id.into());
|
|
self
|
|
}
|
|
|
|
pub fn chatgpt_account_id(mut self, chatgpt_account_id: impl Into<String>) -> Self {
|
|
self.claims.chatgpt_account_id = Some(chatgpt_account_id.into());
|
|
self
|
|
}
|
|
|
|
pub fn email(mut self, email: impl Into<String>) -> Self {
|
|
self.claims.email = Some(email.into());
|
|
self
|
|
}
|
|
|
|
pub fn last_refresh(mut self, last_refresh: Option<DateTime<Utc>>) -> Self {
|
|
self.last_refresh = Some(last_refresh);
|
|
self
|
|
}
|
|
|
|
pub fn claims(mut self, claims: ChatGptIdTokenClaims) -> Self {
|
|
self.claims = claims;
|
|
self
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Clone, Default)]
|
|
pub struct ChatGptIdTokenClaims {
|
|
pub email: Option<String>,
|
|
pub plan_type: Option<String>,
|
|
pub chatgpt_user_id: Option<String>,
|
|
pub chatgpt_account_id: Option<String>,
|
|
}
|
|
|
|
impl ChatGptIdTokenClaims {
|
|
pub fn new() -> Self {
|
|
Self::default()
|
|
}
|
|
|
|
pub fn email(mut self, email: impl Into<String>) -> Self {
|
|
self.email = Some(email.into());
|
|
self
|
|
}
|
|
|
|
pub fn plan_type(mut self, plan_type: impl Into<String>) -> Self {
|
|
self.plan_type = Some(plan_type.into());
|
|
self
|
|
}
|
|
|
|
pub fn chatgpt_user_id(mut self, chatgpt_user_id: impl Into<String>) -> Self {
|
|
self.chatgpt_user_id = Some(chatgpt_user_id.into());
|
|
self
|
|
}
|
|
|
|
pub fn chatgpt_account_id(mut self, chatgpt_account_id: impl Into<String>) -> Self {
|
|
self.chatgpt_account_id = Some(chatgpt_account_id.into());
|
|
self
|
|
}
|
|
}
|
|
|
|
pub fn encode_id_token(claims: &ChatGptIdTokenClaims) -> Result<String> {
|
|
let header = json!({ "alg": "none", "typ": "JWT" });
|
|
let mut payload = serde_json::Map::new();
|
|
if let Some(email) = &claims.email {
|
|
payload.insert("email".to_string(), json!(email));
|
|
}
|
|
let mut auth_payload = serde_json::Map::new();
|
|
if let Some(plan_type) = &claims.plan_type {
|
|
auth_payload.insert("chatgpt_plan_type".to_string(), json!(plan_type));
|
|
}
|
|
if let Some(chatgpt_user_id) = &claims.chatgpt_user_id {
|
|
auth_payload.insert("chatgpt_user_id".to_string(), json!(chatgpt_user_id));
|
|
}
|
|
if let Some(chatgpt_account_id) = &claims.chatgpt_account_id {
|
|
auth_payload.insert("chatgpt_account_id".to_string(), json!(chatgpt_account_id));
|
|
}
|
|
if !auth_payload.is_empty() {
|
|
payload.insert(
|
|
"https://api.openai.com/auth".to_string(),
|
|
serde_json::Value::Object(auth_payload),
|
|
);
|
|
}
|
|
let payload = serde_json::Value::Object(payload);
|
|
|
|
let header_b64 =
|
|
URL_SAFE_NO_PAD.encode(serde_json::to_vec(&header).context("serialize jwt header")?);
|
|
let payload_b64 =
|
|
URL_SAFE_NO_PAD.encode(serde_json::to_vec(&payload).context("serialize jwt payload")?);
|
|
let signature_b64 = URL_SAFE_NO_PAD.encode(b"signature");
|
|
Ok(format!("{header_b64}.{payload_b64}.{signature_b64}"))
|
|
}
|
|
|
|
pub fn write_chatgpt_auth(
|
|
codex_home: &Path,
|
|
fixture: ChatGptAuthFixture,
|
|
cli_auth_credentials_store_mode: AuthCredentialsStoreMode,
|
|
) -> Result<()> {
|
|
let id_token_raw = encode_id_token(&fixture.claims)?;
|
|
let id_token = parse_chatgpt_jwt_claims(&id_token_raw).context("parse id token")?;
|
|
let tokens = TokenData {
|
|
id_token,
|
|
access_token: fixture.access_token,
|
|
refresh_token: fixture.refresh_token,
|
|
account_id: fixture.account_id,
|
|
};
|
|
|
|
let last_refresh = fixture.last_refresh.unwrap_or_else(|| Some(Utc::now()));
|
|
|
|
let auth = AuthDotJson {
|
|
auth_mode: Some(AuthMode::Chatgpt),
|
|
openai_api_key: None,
|
|
tokens: Some(tokens),
|
|
last_refresh,
|
|
agent_identity: None,
|
|
personal_access_token: None,
|
|
};
|
|
|
|
save_auth(codex_home, &auth, cli_auth_credentials_store_mode).context("write auth.json")
|
|
}
|