mirror of
https://github.com/openai/codex.git
synced 2026-05-26 22:15:13 +00:00
CXC-392 [With 401](https://openai.sentry.io/issues/7333870443/?project=4510195390611458&query=019ce8f8-560c-7f10-a00a-c59553740674&referrer=issue-stream) <img width="1909" height="555" alt="401 auth tags in Sentry" src="https://github.com/user-attachments/assets/412ea950-61c4-4780-9697-15c270971ee3" /> - auth_401_*: preserved facts from the latest unauthorized response snapshot - auth_*: latest auth-related facts from the latest request attempt - auth_recovery_*: unauthorized recovery state and follow-up result Without 401 <img width="1917" height="522" alt="happy-path auth tags in Sentry" src="https://github.com/user-attachments/assets/3381ed28-8022-43b0-b6c0-623a630e679f" /> ###### Summary - Add client-visible 401 diagnostics for auth attachment, upstream auth classification, and 401 request id / cf-ray correlation. - Record unauthorized recovery mode, phase, outcome, and retry/follow-up status without changing auth behavior. - Surface the highest-signal auth and recovery fields on uploaded client bug reports so they are usable in Sentry. - Preserve original unauthorized evidence under `auth_401_*` while keeping follow-up result tags separate. ###### Rationale (from spec findings) - The dominant bucket needed proof of whether the client attached auth before send or upstream still classified the request as missing auth. - Client uploads needed to show whether unauthorized recovery ran and what the client tried next. - Request id and cf-ray needed to be preserved on the unauthorized response so server-side correlation is immediate. - The bug-report path needed the same auth evidence as the request telemetry path, otherwise the observability would not be operationally useful. ###### Scope - Add auth 401 and unauthorized-recovery observability in `codex-rs/core`, `codex-rs/codex-api`, and `codex-rs/otel`, including feedback-tag surfacing. - Keep auth semantics, refresh behavior, retry behavior, endpoint classification, and geo-denial follow-up work out of this PR. ###### Trade-offs - This exports only safe auth evidence: header presence/name, upstream auth classification, request ids, and recovery state. It does not export token values or raw upstream bodies. - This keeps websocket connection reuse as a transport clue because it can help distinguish stale reused sessions from fresh reconnects. - Misroute/base-url classification and geo-denial are intentionally deferred to a separate follow-up PR so this review stays focused on the dominant auth 401 bucket. ###### Client follow-up - PR 2 will add misroute/provider and geo-denial observability plus the matching feedback-tag surfacing. - A separate host/app-server PR should log auth-decision inputs so pre-send host auth state can be correlated with client request evidence. - `device_id` remains intentionally separate until there is a safe existing source on the feedback upload path. ###### Testing - `cargo test -p codex-core refresh_available_models_sorts_by_priority` - `cargo test -p codex-core emit_feedback_request_tags_` - `cargo test -p codex-core emit_feedback_auth_recovery_tags_` - `cargo test -p codex-core auth_request_telemetry_context_tracks_attached_auth_and_retry_phase` - `cargo test -p codex-core extract_response_debug_context_decodes_identity_headers` - `cargo test -p codex-core identity_auth_details` - `cargo test -p codex-core telemetry_error_messages_preserve_non_http_details` - `cargo test -p codex-core --all-features --no-run` - `cargo test -p codex-otel otel_export_routing_policy_routes_api_request_auth_observability` - `cargo test -p codex-otel otel_export_routing_policy_routes_websocket_connect_auth_observability` - `cargo test -p codex-otel otel_export_routing_policy_routes_websocket_request_transport_observability`
1444 lines
50 KiB
Rust
1444 lines
50 KiB
Rust
mod storage;
|
||
|
||
use async_trait::async_trait;
|
||
use chrono::Utc;
|
||
use reqwest::StatusCode;
|
||
use serde::Deserialize;
|
||
use serde::Serialize;
|
||
#[cfg(test)]
|
||
use serial_test::serial;
|
||
use std::env;
|
||
use std::fmt::Debug;
|
||
use std::path::Path;
|
||
use std::path::PathBuf;
|
||
use std::sync::Arc;
|
||
use std::sync::Mutex;
|
||
use std::sync::RwLock;
|
||
|
||
use codex_app_server_protocol::AuthMode as ApiAuthMode;
|
||
use codex_otel::TelemetryAuthMode;
|
||
use codex_protocol::config_types::ForcedLoginMethod;
|
||
|
||
pub use crate::auth::storage::AuthCredentialsStoreMode;
|
||
pub use crate::auth::storage::AuthDotJson;
|
||
use crate::auth::storage::AuthStorageBackend;
|
||
use crate::auth::storage::create_auth_storage;
|
||
use crate::config::Config;
|
||
use crate::error::RefreshTokenFailedError;
|
||
use crate::error::RefreshTokenFailedReason;
|
||
use crate::token_data::KnownPlan as InternalKnownPlan;
|
||
use crate::token_data::PlanType as InternalPlanType;
|
||
use crate::token_data::TokenData;
|
||
use crate::token_data::parse_chatgpt_jwt_claims;
|
||
use crate::util::try_parse_error_message;
|
||
use codex_client::CodexHttpClient;
|
||
use codex_protocol::account::PlanType as AccountPlanType;
|
||
use serde_json::Value;
|
||
use thiserror::Error;
|
||
|
||
/// Account type for the current user.
|
||
///
|
||
/// This is used internally to determine the base URL for generating responses,
|
||
/// and to gate ChatGPT-only behaviors like rate limits and available models (as
|
||
/// opposed to API key-based auth).
|
||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||
pub enum AuthMode {
|
||
ApiKey,
|
||
Chatgpt,
|
||
}
|
||
|
||
impl From<AuthMode> for TelemetryAuthMode {
|
||
fn from(mode: AuthMode) -> Self {
|
||
match mode {
|
||
AuthMode::ApiKey => TelemetryAuthMode::ApiKey,
|
||
AuthMode::Chatgpt => TelemetryAuthMode::Chatgpt,
|
||
}
|
||
}
|
||
}
|
||
|
||
/// Authentication mechanism used by the current user.
|
||
#[derive(Debug, Clone)]
|
||
pub enum CodexAuth {
|
||
ApiKey(ApiKeyAuth),
|
||
Chatgpt(ChatgptAuth),
|
||
ChatgptAuthTokens(ChatgptAuthTokens),
|
||
}
|
||
|
||
#[derive(Debug, Clone)]
|
||
pub struct ApiKeyAuth {
|
||
api_key: String,
|
||
}
|
||
|
||
#[derive(Debug, Clone)]
|
||
pub struct ChatgptAuth {
|
||
state: ChatgptAuthState,
|
||
storage: Arc<dyn AuthStorageBackend>,
|
||
}
|
||
|
||
#[derive(Debug, Clone)]
|
||
pub struct ChatgptAuthTokens {
|
||
state: ChatgptAuthState,
|
||
}
|
||
|
||
#[derive(Debug, Clone)]
|
||
struct ChatgptAuthState {
|
||
auth_dot_json: Arc<Mutex<Option<AuthDotJson>>>,
|
||
client: CodexHttpClient,
|
||
}
|
||
|
||
impl PartialEq for CodexAuth {
|
||
fn eq(&self, other: &Self) -> bool {
|
||
self.api_auth_mode() == other.api_auth_mode()
|
||
}
|
||
}
|
||
|
||
// TODO(pakrym): use token exp field to check for expiration instead
|
||
const TOKEN_REFRESH_INTERVAL: i64 = 8;
|
||
|
||
const REFRESH_TOKEN_EXPIRED_MESSAGE: &str = "Your access token could not be refreshed because your refresh token has expired. Please log out and sign in again.";
|
||
const REFRESH_TOKEN_REUSED_MESSAGE: &str = "Your access token could not be refreshed because your refresh token was already used. Please log out and sign in again.";
|
||
const REFRESH_TOKEN_INVALIDATED_MESSAGE: &str = "Your access token could not be refreshed because your refresh token was revoked. Please log out and sign in again.";
|
||
const REFRESH_TOKEN_UNKNOWN_MESSAGE: &str =
|
||
"Your access token could not be refreshed. Please log out and sign in again.";
|
||
const REFRESH_TOKEN_ACCOUNT_MISMATCH_MESSAGE: &str = "Your access token could not be refreshed because you have since logged out or signed in to another account. Please sign in again.";
|
||
const REFRESH_TOKEN_URL: &str = "https://auth.openai.com/oauth/token";
|
||
pub const REFRESH_TOKEN_URL_OVERRIDE_ENV_VAR: &str = "CODEX_REFRESH_TOKEN_URL_OVERRIDE";
|
||
|
||
#[derive(Debug, Error)]
|
||
pub enum RefreshTokenError {
|
||
#[error("{0}")]
|
||
Permanent(#[from] RefreshTokenFailedError),
|
||
#[error(transparent)]
|
||
Transient(#[from] std::io::Error),
|
||
}
|
||
|
||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||
pub struct ExternalAuthTokens {
|
||
pub access_token: String,
|
||
pub chatgpt_account_id: String,
|
||
pub chatgpt_plan_type: Option<String>,
|
||
}
|
||
|
||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||
pub enum ExternalAuthRefreshReason {
|
||
Unauthorized,
|
||
}
|
||
|
||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||
pub struct ExternalAuthRefreshContext {
|
||
pub reason: ExternalAuthRefreshReason,
|
||
pub previous_account_id: Option<String>,
|
||
}
|
||
|
||
#[async_trait]
|
||
pub trait ExternalAuthRefresher: Send + Sync {
|
||
async fn refresh(
|
||
&self,
|
||
context: ExternalAuthRefreshContext,
|
||
) -> std::io::Result<ExternalAuthTokens>;
|
||
}
|
||
|
||
impl RefreshTokenError {
|
||
pub fn failed_reason(&self) -> Option<RefreshTokenFailedReason> {
|
||
match self {
|
||
Self::Permanent(error) => Some(error.reason),
|
||
Self::Transient(_) => None,
|
||
}
|
||
}
|
||
}
|
||
|
||
impl From<RefreshTokenError> for std::io::Error {
|
||
fn from(err: RefreshTokenError) -> Self {
|
||
match err {
|
||
RefreshTokenError::Permanent(failed) => std::io::Error::other(failed),
|
||
RefreshTokenError::Transient(inner) => inner,
|
||
}
|
||
}
|
||
}
|
||
|
||
impl CodexAuth {
|
||
fn from_auth_dot_json(
|
||
codex_home: &Path,
|
||
auth_dot_json: AuthDotJson,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
client: CodexHttpClient,
|
||
) -> std::io::Result<Self> {
|
||
let auth_mode = auth_dot_json.resolved_mode();
|
||
if auth_mode == ApiAuthMode::ApiKey {
|
||
let Some(api_key) = auth_dot_json.openai_api_key.as_deref() else {
|
||
return Err(std::io::Error::other("API key auth is missing a key."));
|
||
};
|
||
return Ok(CodexAuth::from_api_key_with_client(api_key, client));
|
||
}
|
||
|
||
let storage_mode = auth_dot_json.storage_mode(auth_credentials_store_mode);
|
||
let state = ChatgptAuthState {
|
||
auth_dot_json: Arc::new(Mutex::new(Some(auth_dot_json))),
|
||
client,
|
||
};
|
||
|
||
match auth_mode {
|
||
ApiAuthMode::Chatgpt => {
|
||
let storage = create_auth_storage(codex_home.to_path_buf(), storage_mode);
|
||
Ok(Self::Chatgpt(ChatgptAuth { state, storage }))
|
||
}
|
||
ApiAuthMode::ChatgptAuthTokens => {
|
||
Ok(Self::ChatgptAuthTokens(ChatgptAuthTokens { state }))
|
||
}
|
||
ApiAuthMode::ApiKey => unreachable!("api key mode is handled above"),
|
||
}
|
||
}
|
||
|
||
/// Loads the available auth information from auth storage.
|
||
pub fn from_auth_storage(
|
||
codex_home: &Path,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> std::io::Result<Option<Self>> {
|
||
load_auth(codex_home, false, auth_credentials_store_mode)
|
||
}
|
||
|
||
pub fn auth_mode(&self) -> AuthMode {
|
||
match self {
|
||
Self::ApiKey(_) => AuthMode::ApiKey,
|
||
Self::Chatgpt(_) | Self::ChatgptAuthTokens(_) => AuthMode::Chatgpt,
|
||
}
|
||
}
|
||
|
||
pub fn api_auth_mode(&self) -> ApiAuthMode {
|
||
match self {
|
||
Self::ApiKey(_) => ApiAuthMode::ApiKey,
|
||
Self::Chatgpt(_) => ApiAuthMode::Chatgpt,
|
||
Self::ChatgptAuthTokens(_) => ApiAuthMode::ChatgptAuthTokens,
|
||
}
|
||
}
|
||
|
||
pub fn is_api_key_auth(&self) -> bool {
|
||
self.auth_mode() == AuthMode::ApiKey
|
||
}
|
||
|
||
pub fn is_chatgpt_auth(&self) -> bool {
|
||
self.auth_mode() == AuthMode::Chatgpt
|
||
}
|
||
|
||
pub fn is_external_chatgpt_tokens(&self) -> bool {
|
||
matches!(self, Self::ChatgptAuthTokens(_))
|
||
}
|
||
|
||
/// Returns `None` if `auth_mode() != AuthMode::ApiKey`.
|
||
pub fn api_key(&self) -> Option<&str> {
|
||
match self {
|
||
Self::ApiKey(auth) => Some(auth.api_key.as_str()),
|
||
Self::Chatgpt(_) | Self::ChatgptAuthTokens(_) => None,
|
||
}
|
||
}
|
||
|
||
/// Returns `Err` if `is_chatgpt_auth()` is false.
|
||
pub fn get_token_data(&self) -> Result<TokenData, std::io::Error> {
|
||
let auth_dot_json: Option<AuthDotJson> = self.get_current_auth_json();
|
||
match auth_dot_json {
|
||
Some(AuthDotJson {
|
||
tokens: Some(tokens),
|
||
last_refresh: Some(_),
|
||
..
|
||
}) => Ok(tokens),
|
||
_ => Err(std::io::Error::other("Token data is not available.")),
|
||
}
|
||
}
|
||
|
||
/// Returns the token string used for bearer authentication.
|
||
pub fn get_token(&self) -> Result<String, std::io::Error> {
|
||
match self {
|
||
Self::ApiKey(auth) => Ok(auth.api_key.clone()),
|
||
Self::Chatgpt(_) | Self::ChatgptAuthTokens(_) => {
|
||
let access_token = self.get_token_data()?.access_token;
|
||
Ok(access_token)
|
||
}
|
||
}
|
||
}
|
||
|
||
/// Returns `None` if `is_chatgpt_auth()` is false.
|
||
pub fn get_account_id(&self) -> Option<String> {
|
||
self.get_current_token_data().and_then(|t| t.account_id)
|
||
}
|
||
|
||
/// Returns `None` if `is_chatgpt_auth()` is false.
|
||
pub fn get_account_email(&self) -> Option<String> {
|
||
self.get_current_token_data().and_then(|t| t.id_token.email)
|
||
}
|
||
|
||
/// Returns `None` if `is_chatgpt_auth()` is false.
|
||
pub fn get_chatgpt_user_id(&self) -> Option<String> {
|
||
self.get_current_token_data()
|
||
.and_then(|t| t.id_token.chatgpt_user_id)
|
||
}
|
||
|
||
/// Account-facing plan classification derived from the current token.
|
||
/// Returns a high-level `AccountPlanType` (e.g., Free/Plus/Pro/Team/…)
|
||
/// mapped from the ID token's internal plan value. Prefer this when you
|
||
/// need to make UI or product decisions based on the user's subscription.
|
||
/// When ChatGPT auth is active but the token omits the plan claim, report
|
||
/// `Unknown` instead of treating the account as invalid.
|
||
pub fn account_plan_type(&self) -> Option<AccountPlanType> {
|
||
let map_known = |kp: &InternalKnownPlan| match kp {
|
||
InternalKnownPlan::Free => AccountPlanType::Free,
|
||
InternalKnownPlan::Go => AccountPlanType::Go,
|
||
InternalKnownPlan::Plus => AccountPlanType::Plus,
|
||
InternalKnownPlan::Pro => AccountPlanType::Pro,
|
||
InternalKnownPlan::Team => AccountPlanType::Team,
|
||
InternalKnownPlan::Business => AccountPlanType::Business,
|
||
InternalKnownPlan::Enterprise => AccountPlanType::Enterprise,
|
||
InternalKnownPlan::Edu => AccountPlanType::Edu,
|
||
};
|
||
|
||
self.get_current_token_data().map(|t| {
|
||
t.id_token
|
||
.chatgpt_plan_type
|
||
.map(|pt| match pt {
|
||
InternalPlanType::Known(k) => map_known(&k),
|
||
InternalPlanType::Unknown(_) => AccountPlanType::Unknown,
|
||
})
|
||
.unwrap_or(AccountPlanType::Unknown)
|
||
})
|
||
}
|
||
|
||
/// Returns `None` if `is_chatgpt_auth()` is false.
|
||
fn get_current_auth_json(&self) -> Option<AuthDotJson> {
|
||
let state = match self {
|
||
Self::Chatgpt(auth) => &auth.state,
|
||
Self::ChatgptAuthTokens(auth) => &auth.state,
|
||
Self::ApiKey(_) => return None,
|
||
};
|
||
#[expect(clippy::unwrap_used)]
|
||
state.auth_dot_json.lock().unwrap().clone()
|
||
}
|
||
|
||
/// Returns `None` if `is_chatgpt_auth()` is false.
|
||
fn get_current_token_data(&self) -> Option<TokenData> {
|
||
self.get_current_auth_json().and_then(|t| t.tokens)
|
||
}
|
||
|
||
/// Consider this private to integration tests.
|
||
pub fn create_dummy_chatgpt_auth_for_testing() -> Self {
|
||
let auth_dot_json = AuthDotJson {
|
||
auth_mode: Some(ApiAuthMode::Chatgpt),
|
||
openai_api_key: None,
|
||
tokens: Some(TokenData {
|
||
id_token: Default::default(),
|
||
access_token: "Access Token".to_string(),
|
||
refresh_token: "test".to_string(),
|
||
account_id: Some("account_id".to_string()),
|
||
}),
|
||
last_refresh: Some(Utc::now()),
|
||
};
|
||
|
||
let client = crate::default_client::create_client();
|
||
let state = ChatgptAuthState {
|
||
auth_dot_json: Arc::new(Mutex::new(Some(auth_dot_json))),
|
||
client,
|
||
};
|
||
let storage = create_auth_storage(PathBuf::new(), AuthCredentialsStoreMode::File);
|
||
Self::Chatgpt(ChatgptAuth { state, storage })
|
||
}
|
||
|
||
fn from_api_key_with_client(api_key: &str, _client: CodexHttpClient) -> Self {
|
||
Self::ApiKey(ApiKeyAuth {
|
||
api_key: api_key.to_owned(),
|
||
})
|
||
}
|
||
|
||
pub fn from_api_key(api_key: &str) -> Self {
|
||
Self::from_api_key_with_client(api_key, crate::default_client::create_client())
|
||
}
|
||
}
|
||
|
||
impl ChatgptAuth {
|
||
fn current_auth_json(&self) -> Option<AuthDotJson> {
|
||
#[expect(clippy::unwrap_used)]
|
||
self.state.auth_dot_json.lock().unwrap().clone()
|
||
}
|
||
|
||
fn current_token_data(&self) -> Option<TokenData> {
|
||
self.current_auth_json().and_then(|auth| auth.tokens)
|
||
}
|
||
|
||
fn storage(&self) -> &Arc<dyn AuthStorageBackend> {
|
||
&self.storage
|
||
}
|
||
|
||
fn client(&self) -> &CodexHttpClient {
|
||
&self.state.client
|
||
}
|
||
}
|
||
|
||
pub const OPENAI_API_KEY_ENV_VAR: &str = "OPENAI_API_KEY";
|
||
pub const CODEX_API_KEY_ENV_VAR: &str = "CODEX_API_KEY";
|
||
|
||
pub fn read_openai_api_key_from_env() -> Option<String> {
|
||
env::var(OPENAI_API_KEY_ENV_VAR)
|
||
.ok()
|
||
.map(|value| value.trim().to_string())
|
||
.filter(|value| !value.is_empty())
|
||
}
|
||
|
||
pub fn read_codex_api_key_from_env() -> Option<String> {
|
||
env::var(CODEX_API_KEY_ENV_VAR)
|
||
.ok()
|
||
.map(|value| value.trim().to_string())
|
||
.filter(|value| !value.is_empty())
|
||
}
|
||
|
||
/// Delete the auth.json file inside `codex_home` if it exists. Returns `Ok(true)`
|
||
/// if a file was removed, `Ok(false)` if no auth file was present.
|
||
pub fn logout(
|
||
codex_home: &Path,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> std::io::Result<bool> {
|
||
let storage = create_auth_storage(codex_home.to_path_buf(), auth_credentials_store_mode);
|
||
storage.delete()
|
||
}
|
||
|
||
/// Writes an `auth.json` that contains only the API key.
|
||
pub fn login_with_api_key(
|
||
codex_home: &Path,
|
||
api_key: &str,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> std::io::Result<()> {
|
||
let auth_dot_json = AuthDotJson {
|
||
auth_mode: Some(ApiAuthMode::ApiKey),
|
||
openai_api_key: Some(api_key.to_string()),
|
||
tokens: None,
|
||
last_refresh: None,
|
||
};
|
||
save_auth(codex_home, &auth_dot_json, auth_credentials_store_mode)
|
||
}
|
||
|
||
/// Writes an in-memory auth payload for externally managed ChatGPT tokens.
|
||
pub fn login_with_chatgpt_auth_tokens(
|
||
codex_home: &Path,
|
||
access_token: &str,
|
||
chatgpt_account_id: &str,
|
||
chatgpt_plan_type: Option<&str>,
|
||
) -> std::io::Result<()> {
|
||
let auth_dot_json = AuthDotJson::from_external_access_token(
|
||
access_token,
|
||
chatgpt_account_id,
|
||
chatgpt_plan_type,
|
||
)?;
|
||
save_auth(
|
||
codex_home,
|
||
&auth_dot_json,
|
||
AuthCredentialsStoreMode::Ephemeral,
|
||
)
|
||
}
|
||
|
||
/// Persist the provided auth payload using the specified backend.
|
||
pub fn save_auth(
|
||
codex_home: &Path,
|
||
auth: &AuthDotJson,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> std::io::Result<()> {
|
||
let storage = create_auth_storage(codex_home.to_path_buf(), auth_credentials_store_mode);
|
||
storage.save(auth)
|
||
}
|
||
|
||
/// Load CLI auth data using the configured credential store backend.
|
||
/// Returns `None` when no credentials are stored. This function is
|
||
/// provided only for tests. Production code should not directly load
|
||
/// from the auth.json storage. It should use the AuthManager abstraction
|
||
/// instead.
|
||
pub fn load_auth_dot_json(
|
||
codex_home: &Path,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> std::io::Result<Option<AuthDotJson>> {
|
||
let storage = create_auth_storage(codex_home.to_path_buf(), auth_credentials_store_mode);
|
||
storage.load()
|
||
}
|
||
|
||
pub fn enforce_login_restrictions(config: &Config) -> std::io::Result<()> {
|
||
let Some(auth) = load_auth(
|
||
&config.codex_home,
|
||
true,
|
||
config.cli_auth_credentials_store_mode,
|
||
)?
|
||
else {
|
||
return Ok(());
|
||
};
|
||
|
||
if let Some(required_method) = config.forced_login_method {
|
||
let method_violation = match (required_method, auth.auth_mode()) {
|
||
(ForcedLoginMethod::Api, AuthMode::ApiKey) => None,
|
||
(ForcedLoginMethod::Chatgpt, AuthMode::Chatgpt) => None,
|
||
(ForcedLoginMethod::Api, AuthMode::Chatgpt) => Some(
|
||
"API key login is required, but ChatGPT is currently being used. Logging out."
|
||
.to_string(),
|
||
),
|
||
(ForcedLoginMethod::Chatgpt, AuthMode::ApiKey) => Some(
|
||
"ChatGPT login is required, but an API key is currently being used. Logging out."
|
||
.to_string(),
|
||
),
|
||
};
|
||
|
||
if let Some(message) = method_violation {
|
||
return logout_with_message(
|
||
&config.codex_home,
|
||
message,
|
||
config.cli_auth_credentials_store_mode,
|
||
);
|
||
}
|
||
}
|
||
|
||
if let Some(expected_account_id) = config.forced_chatgpt_workspace_id.as_deref() {
|
||
if !auth.is_chatgpt_auth() {
|
||
return Ok(());
|
||
}
|
||
|
||
let token_data = match auth.get_token_data() {
|
||
Ok(data) => data,
|
||
Err(err) => {
|
||
return logout_with_message(
|
||
&config.codex_home,
|
||
format!(
|
||
"Failed to load ChatGPT credentials while enforcing workspace restrictions: {err}. Logging out."
|
||
),
|
||
config.cli_auth_credentials_store_mode,
|
||
);
|
||
}
|
||
};
|
||
|
||
// workspace is the external identifier for account id.
|
||
let chatgpt_account_id = token_data.id_token.chatgpt_account_id.as_deref();
|
||
if chatgpt_account_id != Some(expected_account_id) {
|
||
let message = match chatgpt_account_id {
|
||
Some(actual) => format!(
|
||
"Login is restricted to workspace {expected_account_id}, but current credentials belong to {actual}. Logging out."
|
||
),
|
||
None => format!(
|
||
"Login is restricted to workspace {expected_account_id}, but current credentials lack a workspace identifier. Logging out."
|
||
),
|
||
};
|
||
return logout_with_message(
|
||
&config.codex_home,
|
||
message,
|
||
config.cli_auth_credentials_store_mode,
|
||
);
|
||
}
|
||
}
|
||
|
||
Ok(())
|
||
}
|
||
|
||
fn logout_with_message(
|
||
codex_home: &Path,
|
||
message: String,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> std::io::Result<()> {
|
||
// External auth tokens live in the ephemeral store, but persistent auth may still exist
|
||
// from earlier logins. Clear both so a forced logout truly removes all active auth.
|
||
let removal_result = logout_all_stores(codex_home, auth_credentials_store_mode);
|
||
let error_message = match removal_result {
|
||
Ok(_) => message,
|
||
Err(err) => format!("{message}. Failed to remove auth.json: {err}"),
|
||
};
|
||
Err(std::io::Error::other(error_message))
|
||
}
|
||
|
||
fn logout_all_stores(
|
||
codex_home: &Path,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> std::io::Result<bool> {
|
||
if auth_credentials_store_mode == AuthCredentialsStoreMode::Ephemeral {
|
||
return logout(codex_home, AuthCredentialsStoreMode::Ephemeral);
|
||
}
|
||
let removed_ephemeral = logout(codex_home, AuthCredentialsStoreMode::Ephemeral)?;
|
||
let removed_managed = logout(codex_home, auth_credentials_store_mode)?;
|
||
Ok(removed_ephemeral || removed_managed)
|
||
}
|
||
|
||
fn load_auth(
|
||
codex_home: &Path,
|
||
enable_codex_api_key_env: bool,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> std::io::Result<Option<CodexAuth>> {
|
||
let build_auth = |auth_dot_json: AuthDotJson, storage_mode| {
|
||
let client = crate::default_client::create_client();
|
||
CodexAuth::from_auth_dot_json(codex_home, auth_dot_json, storage_mode, client)
|
||
};
|
||
|
||
// API key via env var takes precedence over any other auth method.
|
||
if enable_codex_api_key_env && let Some(api_key) = read_codex_api_key_from_env() {
|
||
let client = crate::default_client::create_client();
|
||
return Ok(Some(CodexAuth::from_api_key_with_client(
|
||
api_key.as_str(),
|
||
client,
|
||
)));
|
||
}
|
||
|
||
// External ChatGPT auth tokens live in the in-memory (ephemeral) store. Always check this
|
||
// first so external auth takes precedence over any persisted credentials.
|
||
let ephemeral_storage = create_auth_storage(
|
||
codex_home.to_path_buf(),
|
||
AuthCredentialsStoreMode::Ephemeral,
|
||
);
|
||
if let Some(auth_dot_json) = ephemeral_storage.load()? {
|
||
let auth = build_auth(auth_dot_json, AuthCredentialsStoreMode::Ephemeral)?;
|
||
return Ok(Some(auth));
|
||
}
|
||
|
||
// If the caller explicitly requested ephemeral auth, there is no persisted fallback.
|
||
if auth_credentials_store_mode == AuthCredentialsStoreMode::Ephemeral {
|
||
return Ok(None);
|
||
}
|
||
|
||
// Fall back to the configured persistent store (file/keyring/auto) for managed auth.
|
||
let storage = create_auth_storage(codex_home.to_path_buf(), auth_credentials_store_mode);
|
||
let auth_dot_json = match storage.load()? {
|
||
Some(auth) => auth,
|
||
None => return Ok(None),
|
||
};
|
||
|
||
let auth = build_auth(auth_dot_json, auth_credentials_store_mode)?;
|
||
Ok(Some(auth))
|
||
}
|
||
|
||
// Persist refreshed tokens into auth storage and update last_refresh.
|
||
fn persist_tokens(
|
||
storage: &Arc<dyn AuthStorageBackend>,
|
||
id_token: Option<String>,
|
||
access_token: Option<String>,
|
||
refresh_token: Option<String>,
|
||
) -> std::io::Result<AuthDotJson> {
|
||
let mut auth_dot_json = storage
|
||
.load()?
|
||
.ok_or(std::io::Error::other("Token data is not available."))?;
|
||
|
||
let tokens = auth_dot_json.tokens.get_or_insert_with(TokenData::default);
|
||
if let Some(id_token) = id_token {
|
||
tokens.id_token = parse_chatgpt_jwt_claims(&id_token).map_err(std::io::Error::other)?;
|
||
}
|
||
if let Some(access_token) = access_token {
|
||
tokens.access_token = access_token;
|
||
}
|
||
if let Some(refresh_token) = refresh_token {
|
||
tokens.refresh_token = refresh_token;
|
||
}
|
||
auth_dot_json.last_refresh = Some(Utc::now());
|
||
storage.save(&auth_dot_json)?;
|
||
Ok(auth_dot_json)
|
||
}
|
||
|
||
// Requests refreshed ChatGPT OAuth tokens from the auth service using a refresh token.
|
||
// The caller is responsible for persisting any returned tokens.
|
||
async fn request_chatgpt_token_refresh(
|
||
refresh_token: String,
|
||
client: &CodexHttpClient,
|
||
) -> Result<RefreshResponse, RefreshTokenError> {
|
||
let refresh_request = RefreshRequest {
|
||
client_id: CLIENT_ID,
|
||
grant_type: "refresh_token",
|
||
refresh_token,
|
||
};
|
||
|
||
let endpoint = refresh_token_endpoint();
|
||
|
||
// Use shared client factory to include standard headers
|
||
let response = client
|
||
.post(endpoint.as_str())
|
||
.header("Content-Type", "application/json")
|
||
.json(&refresh_request)
|
||
.send()
|
||
.await
|
||
.map_err(|err| RefreshTokenError::Transient(std::io::Error::other(err)))?;
|
||
|
||
let status = response.status();
|
||
if status.is_success() {
|
||
let refresh_response = response
|
||
.json::<RefreshResponse>()
|
||
.await
|
||
.map_err(|err| RefreshTokenError::Transient(std::io::Error::other(err)))?;
|
||
Ok(refresh_response)
|
||
} else {
|
||
let body = response.text().await.unwrap_or_default();
|
||
tracing::error!("Failed to refresh token: {status}: {body}");
|
||
if status == StatusCode::UNAUTHORIZED {
|
||
let failed = classify_refresh_token_failure(&body);
|
||
Err(RefreshTokenError::Permanent(failed))
|
||
} else {
|
||
let message = try_parse_error_message(&body);
|
||
Err(RefreshTokenError::Transient(std::io::Error::other(
|
||
format!("Failed to refresh token: {status}: {message}"),
|
||
)))
|
||
}
|
||
}
|
||
}
|
||
|
||
fn classify_refresh_token_failure(body: &str) -> RefreshTokenFailedError {
|
||
let code = extract_refresh_token_error_code(body);
|
||
|
||
let normalized_code = code.as_deref().map(str::to_ascii_lowercase);
|
||
let reason = match normalized_code.as_deref() {
|
||
Some("refresh_token_expired") => RefreshTokenFailedReason::Expired,
|
||
Some("refresh_token_reused") => RefreshTokenFailedReason::Exhausted,
|
||
Some("refresh_token_invalidated") => RefreshTokenFailedReason::Revoked,
|
||
_ => RefreshTokenFailedReason::Other,
|
||
};
|
||
|
||
if reason == RefreshTokenFailedReason::Other {
|
||
tracing::warn!(
|
||
backend_code = normalized_code.as_deref(),
|
||
backend_body = body,
|
||
"Encountered unknown 401 response while refreshing token"
|
||
);
|
||
}
|
||
|
||
let message = match reason {
|
||
RefreshTokenFailedReason::Expired => REFRESH_TOKEN_EXPIRED_MESSAGE.to_string(),
|
||
RefreshTokenFailedReason::Exhausted => REFRESH_TOKEN_REUSED_MESSAGE.to_string(),
|
||
RefreshTokenFailedReason::Revoked => REFRESH_TOKEN_INVALIDATED_MESSAGE.to_string(),
|
||
RefreshTokenFailedReason::Other => REFRESH_TOKEN_UNKNOWN_MESSAGE.to_string(),
|
||
};
|
||
|
||
RefreshTokenFailedError::new(reason, message)
|
||
}
|
||
|
||
fn extract_refresh_token_error_code(body: &str) -> Option<String> {
|
||
if body.trim().is_empty() {
|
||
return None;
|
||
}
|
||
|
||
let Value::Object(map) = serde_json::from_str::<Value>(body).ok()? else {
|
||
return None;
|
||
};
|
||
|
||
if let Some(error_value) = map.get("error") {
|
||
match error_value {
|
||
Value::Object(obj) => {
|
||
if let Some(code) = obj.get("code").and_then(Value::as_str) {
|
||
return Some(code.to_string());
|
||
}
|
||
}
|
||
Value::String(code) => {
|
||
return Some(code.to_string());
|
||
}
|
||
_ => {}
|
||
}
|
||
}
|
||
|
||
map.get("code").and_then(Value::as_str).map(str::to_string)
|
||
}
|
||
|
||
#[derive(Serialize)]
|
||
struct RefreshRequest {
|
||
client_id: &'static str,
|
||
grant_type: &'static str,
|
||
refresh_token: String,
|
||
}
|
||
|
||
#[derive(Deserialize, Clone)]
|
||
struct RefreshResponse {
|
||
id_token: Option<String>,
|
||
access_token: Option<String>,
|
||
refresh_token: Option<String>,
|
||
}
|
||
|
||
// Shared constant for token refresh (client id used for oauth token refresh flow)
|
||
pub const CLIENT_ID: &str = "app_EMoamEEZ73f0CkXaXp7hrann";
|
||
|
||
fn refresh_token_endpoint() -> String {
|
||
std::env::var(REFRESH_TOKEN_URL_OVERRIDE_ENV_VAR)
|
||
.unwrap_or_else(|_| REFRESH_TOKEN_URL.to_string())
|
||
}
|
||
|
||
impl AuthDotJson {
|
||
fn from_external_tokens(external: &ExternalAuthTokens) -> std::io::Result<Self> {
|
||
let mut token_info =
|
||
parse_chatgpt_jwt_claims(&external.access_token).map_err(std::io::Error::other)?;
|
||
token_info.chatgpt_account_id = Some(external.chatgpt_account_id.clone());
|
||
token_info.chatgpt_plan_type = external
|
||
.chatgpt_plan_type
|
||
.as_deref()
|
||
.map(InternalPlanType::from_raw_value)
|
||
.or(token_info.chatgpt_plan_type)
|
||
.or(Some(InternalPlanType::Unknown("unknown".to_string())));
|
||
let tokens = TokenData {
|
||
id_token: token_info,
|
||
access_token: external.access_token.clone(),
|
||
refresh_token: String::new(),
|
||
account_id: Some(external.chatgpt_account_id.clone()),
|
||
};
|
||
|
||
Ok(Self {
|
||
auth_mode: Some(ApiAuthMode::ChatgptAuthTokens),
|
||
openai_api_key: None,
|
||
tokens: Some(tokens),
|
||
last_refresh: Some(Utc::now()),
|
||
})
|
||
}
|
||
|
||
fn from_external_access_token(
|
||
access_token: &str,
|
||
chatgpt_account_id: &str,
|
||
chatgpt_plan_type: Option<&str>,
|
||
) -> std::io::Result<Self> {
|
||
let external = ExternalAuthTokens {
|
||
access_token: access_token.to_string(),
|
||
chatgpt_account_id: chatgpt_account_id.to_string(),
|
||
chatgpt_plan_type: chatgpt_plan_type.map(str::to_string),
|
||
};
|
||
Self::from_external_tokens(&external)
|
||
}
|
||
|
||
fn resolved_mode(&self) -> ApiAuthMode {
|
||
if let Some(mode) = self.auth_mode {
|
||
return mode;
|
||
}
|
||
if self.openai_api_key.is_some() {
|
||
return ApiAuthMode::ApiKey;
|
||
}
|
||
ApiAuthMode::Chatgpt
|
||
}
|
||
|
||
fn storage_mode(
|
||
&self,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> AuthCredentialsStoreMode {
|
||
if self.resolved_mode() == ApiAuthMode::ChatgptAuthTokens {
|
||
AuthCredentialsStoreMode::Ephemeral
|
||
} else {
|
||
auth_credentials_store_mode
|
||
}
|
||
}
|
||
}
|
||
|
||
/// Internal cached auth state.
|
||
#[derive(Clone)]
|
||
struct CachedAuth {
|
||
auth: Option<CodexAuth>,
|
||
/// Callback used to refresh external auth by asking the parent app for new tokens.
|
||
external_refresher: Option<Arc<dyn ExternalAuthRefresher>>,
|
||
}
|
||
|
||
impl Debug for CachedAuth {
|
||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||
f.debug_struct("CachedAuth")
|
||
.field(
|
||
"auth_mode",
|
||
&self.auth.as_ref().map(CodexAuth::api_auth_mode),
|
||
)
|
||
.field(
|
||
"external_refresher",
|
||
&self.external_refresher.as_ref().map(|_| "present"),
|
||
)
|
||
.finish()
|
||
}
|
||
}
|
||
|
||
enum UnauthorizedRecoveryStep {
|
||
Reload,
|
||
RefreshToken,
|
||
ExternalRefresh,
|
||
Done,
|
||
}
|
||
|
||
enum ReloadOutcome {
|
||
/// Reload was performed and the cached auth changed
|
||
ReloadedChanged,
|
||
/// Reload was performed and the cached auth remained the same
|
||
ReloadedNoChange,
|
||
/// Reload was skipped (missing or mismatched account id)
|
||
Skipped,
|
||
}
|
||
|
||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||
enum UnauthorizedRecoveryMode {
|
||
Managed,
|
||
External,
|
||
}
|
||
|
||
// UnauthorizedRecovery is a state machine that handles an attempt to refresh the authentication when requests
|
||
// to API fail with 401 status code.
|
||
// The client calls next() every time it encounters a 401 error, one time per retry.
|
||
// For API key based authentication, we don't do anything and let the error bubble to the user.
|
||
//
|
||
// For ChatGPT based authentication, we:
|
||
// 1. Attempt to reload the auth data from disk. We only reload if the account id matches the one the current process is running as.
|
||
// 2. Attempt to refresh the token using OAuth token refresh flow.
|
||
// If after both steps the server still responds with 401 we let the error bubble to the user.
|
||
//
|
||
// For external ChatGPT auth tokens (chatgptAuthTokens), UnauthorizedRecovery does not touch disk or refresh
|
||
// tokens locally. Instead it calls the ExternalAuthRefresher (account/chatgptAuthTokens/refresh) to ask the
|
||
// parent app for new tokens, stores them in the ephemeral auth store, and retries once.
|
||
pub struct UnauthorizedRecovery {
|
||
manager: Arc<AuthManager>,
|
||
step: UnauthorizedRecoveryStep,
|
||
expected_account_id: Option<String>,
|
||
mode: UnauthorizedRecoveryMode,
|
||
}
|
||
|
||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||
pub struct UnauthorizedRecoveryStepResult {
|
||
auth_state_changed: Option<bool>,
|
||
}
|
||
|
||
impl UnauthorizedRecoveryStepResult {
|
||
pub fn auth_state_changed(&self) -> Option<bool> {
|
||
self.auth_state_changed
|
||
}
|
||
}
|
||
|
||
impl UnauthorizedRecovery {
|
||
fn new(manager: Arc<AuthManager>) -> Self {
|
||
let cached_auth = manager.auth_cached();
|
||
let expected_account_id = cached_auth.as_ref().and_then(CodexAuth::get_account_id);
|
||
let mode = if cached_auth
|
||
.as_ref()
|
||
.is_some_and(CodexAuth::is_external_chatgpt_tokens)
|
||
{
|
||
UnauthorizedRecoveryMode::External
|
||
} else {
|
||
UnauthorizedRecoveryMode::Managed
|
||
};
|
||
let step = match mode {
|
||
UnauthorizedRecoveryMode::Managed => UnauthorizedRecoveryStep::Reload,
|
||
UnauthorizedRecoveryMode::External => UnauthorizedRecoveryStep::ExternalRefresh,
|
||
};
|
||
Self {
|
||
manager,
|
||
step,
|
||
expected_account_id,
|
||
mode,
|
||
}
|
||
}
|
||
|
||
pub fn has_next(&self) -> bool {
|
||
if !self
|
||
.manager
|
||
.auth_cached()
|
||
.as_ref()
|
||
.is_some_and(CodexAuth::is_chatgpt_auth)
|
||
{
|
||
return false;
|
||
}
|
||
|
||
if self.mode == UnauthorizedRecoveryMode::External
|
||
&& !self.manager.has_external_auth_refresher()
|
||
{
|
||
return false;
|
||
}
|
||
|
||
!matches!(self.step, UnauthorizedRecoveryStep::Done)
|
||
}
|
||
|
||
pub fn unavailable_reason(&self) -> &'static str {
|
||
if !self
|
||
.manager
|
||
.auth_cached()
|
||
.as_ref()
|
||
.is_some_and(CodexAuth::is_chatgpt_auth)
|
||
{
|
||
return "not_chatgpt_auth";
|
||
}
|
||
|
||
if self.mode == UnauthorizedRecoveryMode::External
|
||
&& !self.manager.has_external_auth_refresher()
|
||
{
|
||
return "no_external_refresher";
|
||
}
|
||
|
||
if matches!(self.step, UnauthorizedRecoveryStep::Done) {
|
||
return "recovery_exhausted";
|
||
}
|
||
|
||
"ready"
|
||
}
|
||
|
||
pub fn mode_name(&self) -> &'static str {
|
||
match self.mode {
|
||
UnauthorizedRecoveryMode::Managed => "managed",
|
||
UnauthorizedRecoveryMode::External => "external",
|
||
}
|
||
}
|
||
|
||
pub fn step_name(&self) -> &'static str {
|
||
match self.step {
|
||
UnauthorizedRecoveryStep::Reload => "reload",
|
||
UnauthorizedRecoveryStep::RefreshToken => "refresh_token",
|
||
UnauthorizedRecoveryStep::ExternalRefresh => "external_refresh",
|
||
UnauthorizedRecoveryStep::Done => "done",
|
||
}
|
||
}
|
||
|
||
pub async fn next(&mut self) -> Result<UnauthorizedRecoveryStepResult, RefreshTokenError> {
|
||
if !self.has_next() {
|
||
return Err(RefreshTokenError::Permanent(RefreshTokenFailedError::new(
|
||
RefreshTokenFailedReason::Other,
|
||
"No more recovery steps available.",
|
||
)));
|
||
}
|
||
|
||
match self.step {
|
||
UnauthorizedRecoveryStep::Reload => {
|
||
match self
|
||
.manager
|
||
.reload_if_account_id_matches(self.expected_account_id.as_deref())
|
||
{
|
||
ReloadOutcome::ReloadedChanged => {
|
||
self.step = UnauthorizedRecoveryStep::RefreshToken;
|
||
return Ok(UnauthorizedRecoveryStepResult {
|
||
auth_state_changed: Some(true),
|
||
});
|
||
}
|
||
ReloadOutcome::ReloadedNoChange => {
|
||
self.step = UnauthorizedRecoveryStep::RefreshToken;
|
||
return Ok(UnauthorizedRecoveryStepResult {
|
||
auth_state_changed: Some(false),
|
||
});
|
||
}
|
||
ReloadOutcome::Skipped => {
|
||
self.step = UnauthorizedRecoveryStep::Done;
|
||
return Err(RefreshTokenError::Permanent(RefreshTokenFailedError::new(
|
||
RefreshTokenFailedReason::Other,
|
||
REFRESH_TOKEN_ACCOUNT_MISMATCH_MESSAGE.to_string(),
|
||
)));
|
||
}
|
||
}
|
||
}
|
||
UnauthorizedRecoveryStep::RefreshToken => {
|
||
self.manager.refresh_token_from_authority().await?;
|
||
self.step = UnauthorizedRecoveryStep::Done;
|
||
return Ok(UnauthorizedRecoveryStepResult {
|
||
auth_state_changed: Some(true),
|
||
});
|
||
}
|
||
UnauthorizedRecoveryStep::ExternalRefresh => {
|
||
self.manager
|
||
.refresh_external_auth(ExternalAuthRefreshReason::Unauthorized)
|
||
.await?;
|
||
self.step = UnauthorizedRecoveryStep::Done;
|
||
return Ok(UnauthorizedRecoveryStepResult {
|
||
auth_state_changed: Some(true),
|
||
});
|
||
}
|
||
UnauthorizedRecoveryStep::Done => {}
|
||
}
|
||
Ok(UnauthorizedRecoveryStepResult {
|
||
auth_state_changed: None,
|
||
})
|
||
}
|
||
}
|
||
|
||
/// Central manager providing a single source of truth for auth.json derived
|
||
/// authentication data. It loads once (or on preference change) and then
|
||
/// hands out cloned `CodexAuth` values so the rest of the program has a
|
||
/// consistent snapshot.
|
||
///
|
||
/// External modifications to `auth.json` will NOT be observed until
|
||
/// `reload()` is called explicitly. This matches the design goal of avoiding
|
||
/// different parts of the program seeing inconsistent auth data mid‑run.
|
||
#[derive(Debug)]
|
||
pub struct AuthManager {
|
||
codex_home: PathBuf,
|
||
inner: RwLock<CachedAuth>,
|
||
enable_codex_api_key_env: bool,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
forced_chatgpt_workspace_id: RwLock<Option<String>>,
|
||
}
|
||
|
||
impl AuthManager {
|
||
/// Create a new manager loading the initial auth using the provided
|
||
/// preferred auth method. Errors loading auth are swallowed; `auth()` will
|
||
/// simply return `None` in that case so callers can treat it as an
|
||
/// unauthenticated state.
|
||
pub fn new(
|
||
codex_home: PathBuf,
|
||
enable_codex_api_key_env: bool,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> Self {
|
||
let managed_auth = load_auth(
|
||
&codex_home,
|
||
enable_codex_api_key_env,
|
||
auth_credentials_store_mode,
|
||
)
|
||
.ok()
|
||
.flatten();
|
||
Self {
|
||
codex_home,
|
||
inner: RwLock::new(CachedAuth {
|
||
auth: managed_auth,
|
||
external_refresher: None,
|
||
}),
|
||
enable_codex_api_key_env,
|
||
auth_credentials_store_mode,
|
||
forced_chatgpt_workspace_id: RwLock::new(None),
|
||
}
|
||
}
|
||
|
||
/// Create an AuthManager with a specific CodexAuth, for testing only.
|
||
pub(crate) fn from_auth_for_testing(auth: CodexAuth) -> Arc<Self> {
|
||
let cached = CachedAuth {
|
||
auth: Some(auth),
|
||
external_refresher: None,
|
||
};
|
||
|
||
Arc::new(Self {
|
||
codex_home: PathBuf::from("non-existent"),
|
||
inner: RwLock::new(cached),
|
||
enable_codex_api_key_env: false,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode::File,
|
||
forced_chatgpt_workspace_id: RwLock::new(None),
|
||
})
|
||
}
|
||
|
||
/// Create an AuthManager with a specific CodexAuth and codex home, for testing only.
|
||
pub(crate) fn from_auth_for_testing_with_home(
|
||
auth: CodexAuth,
|
||
codex_home: PathBuf,
|
||
) -> Arc<Self> {
|
||
let cached = CachedAuth {
|
||
auth: Some(auth),
|
||
external_refresher: None,
|
||
};
|
||
Arc::new(Self {
|
||
codex_home,
|
||
inner: RwLock::new(cached),
|
||
enable_codex_api_key_env: false,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode::File,
|
||
forced_chatgpt_workspace_id: RwLock::new(None),
|
||
})
|
||
}
|
||
|
||
/// Current cached auth (clone) without attempting a refresh.
|
||
pub fn auth_cached(&self) -> Option<CodexAuth> {
|
||
self.inner.read().ok().and_then(|c| c.auth.clone())
|
||
}
|
||
|
||
/// Current cached auth (clone). May be `None` if not logged in or load failed.
|
||
/// Refreshes cached ChatGPT tokens if they are stale before returning.
|
||
pub async fn auth(&self) -> Option<CodexAuth> {
|
||
let auth = self.auth_cached()?;
|
||
if let Err(err) = self.refresh_if_stale(&auth).await {
|
||
tracing::error!("Failed to refresh token: {}", err);
|
||
return Some(auth);
|
||
}
|
||
self.auth_cached()
|
||
}
|
||
|
||
/// Force a reload of the auth information from auth.json. Returns
|
||
/// whether the auth value changed.
|
||
pub fn reload(&self) -> bool {
|
||
tracing::info!("Reloading auth");
|
||
let new_auth = self.load_auth_from_storage();
|
||
self.set_cached_auth(new_auth)
|
||
}
|
||
|
||
fn reload_if_account_id_matches(&self, expected_account_id: Option<&str>) -> ReloadOutcome {
|
||
let expected_account_id = match expected_account_id {
|
||
Some(account_id) => account_id,
|
||
None => {
|
||
tracing::info!("Skipping auth reload because no account id is available.");
|
||
return ReloadOutcome::Skipped;
|
||
}
|
||
};
|
||
|
||
let new_auth = self.load_auth_from_storage();
|
||
let new_account_id = new_auth.as_ref().and_then(CodexAuth::get_account_id);
|
||
|
||
if new_account_id.as_deref() != Some(expected_account_id) {
|
||
let found_account_id = new_account_id.as_deref().unwrap_or("unknown");
|
||
tracing::info!(
|
||
"Skipping auth reload due to account id mismatch (expected: {expected_account_id}, found: {found_account_id})"
|
||
);
|
||
return ReloadOutcome::Skipped;
|
||
}
|
||
|
||
tracing::info!("Reloading auth for account {expected_account_id}");
|
||
let cached_before_reload = self.auth_cached();
|
||
let auth_changed =
|
||
!Self::auths_equal_for_refresh(cached_before_reload.as_ref(), new_auth.as_ref());
|
||
self.set_cached_auth(new_auth);
|
||
if auth_changed {
|
||
ReloadOutcome::ReloadedChanged
|
||
} else {
|
||
ReloadOutcome::ReloadedNoChange
|
||
}
|
||
}
|
||
|
||
fn auths_equal_for_refresh(a: Option<&CodexAuth>, b: Option<&CodexAuth>) -> bool {
|
||
match (a, b) {
|
||
(None, None) => true,
|
||
(Some(a), Some(b)) => match (a.api_auth_mode(), b.api_auth_mode()) {
|
||
(ApiAuthMode::ApiKey, ApiAuthMode::ApiKey) => a.api_key() == b.api_key(),
|
||
(ApiAuthMode::Chatgpt, ApiAuthMode::Chatgpt)
|
||
| (ApiAuthMode::ChatgptAuthTokens, ApiAuthMode::ChatgptAuthTokens) => {
|
||
a.get_current_auth_json() == b.get_current_auth_json()
|
||
}
|
||
_ => false,
|
||
},
|
||
_ => false,
|
||
}
|
||
}
|
||
|
||
fn auths_equal(a: Option<&CodexAuth>, b: Option<&CodexAuth>) -> bool {
|
||
match (a, b) {
|
||
(None, None) => true,
|
||
(Some(a), Some(b)) => a == b,
|
||
_ => false,
|
||
}
|
||
}
|
||
|
||
fn load_auth_from_storage(&self) -> Option<CodexAuth> {
|
||
load_auth(
|
||
&self.codex_home,
|
||
self.enable_codex_api_key_env,
|
||
self.auth_credentials_store_mode,
|
||
)
|
||
.ok()
|
||
.flatten()
|
||
}
|
||
|
||
fn set_cached_auth(&self, new_auth: Option<CodexAuth>) -> bool {
|
||
if let Ok(mut guard) = self.inner.write() {
|
||
let previous = guard.auth.as_ref();
|
||
let changed = !AuthManager::auths_equal(previous, new_auth.as_ref());
|
||
tracing::info!("Reloaded auth, changed: {changed}");
|
||
guard.auth = new_auth;
|
||
changed
|
||
} else {
|
||
false
|
||
}
|
||
}
|
||
|
||
pub fn set_external_auth_refresher(&self, refresher: Arc<dyn ExternalAuthRefresher>) {
|
||
if let Ok(mut guard) = self.inner.write() {
|
||
guard.external_refresher = Some(refresher);
|
||
}
|
||
}
|
||
|
||
pub fn clear_external_auth_refresher(&self) {
|
||
if let Ok(mut guard) = self.inner.write() {
|
||
guard.external_refresher = None;
|
||
}
|
||
}
|
||
|
||
pub fn set_forced_chatgpt_workspace_id(&self, workspace_id: Option<String>) {
|
||
if let Ok(mut guard) = self.forced_chatgpt_workspace_id.write() {
|
||
*guard = workspace_id;
|
||
}
|
||
}
|
||
|
||
pub fn forced_chatgpt_workspace_id(&self) -> Option<String> {
|
||
self.forced_chatgpt_workspace_id
|
||
.read()
|
||
.ok()
|
||
.and_then(|guard| guard.clone())
|
||
}
|
||
|
||
pub fn has_external_auth_refresher(&self) -> bool {
|
||
self.inner
|
||
.read()
|
||
.ok()
|
||
.map(|guard| guard.external_refresher.is_some())
|
||
.unwrap_or(false)
|
||
}
|
||
|
||
pub fn is_external_auth_active(&self) -> bool {
|
||
self.auth_cached()
|
||
.as_ref()
|
||
.is_some_and(CodexAuth::is_external_chatgpt_tokens)
|
||
}
|
||
|
||
/// Convenience constructor returning an `Arc` wrapper.
|
||
pub fn shared(
|
||
codex_home: PathBuf,
|
||
enable_codex_api_key_env: bool,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> Arc<Self> {
|
||
Arc::new(Self::new(
|
||
codex_home,
|
||
enable_codex_api_key_env,
|
||
auth_credentials_store_mode,
|
||
))
|
||
}
|
||
|
||
pub fn unauthorized_recovery(self: &Arc<Self>) -> UnauthorizedRecovery {
|
||
UnauthorizedRecovery::new(Arc::clone(self))
|
||
}
|
||
|
||
/// Attempt to refresh the token by first performing a guarded reload. Auth
|
||
/// is reloaded from storage only when the account id matches the currently
|
||
/// cached account id. If the persisted token differs from the cached token, we
|
||
/// can assume that some other instance already refreshed it. If the persisted
|
||
/// token is the same as the cached, then ask the token authority to refresh.
|
||
pub async fn refresh_token(&self) -> Result<(), RefreshTokenError> {
|
||
let auth_before_reload = self.auth_cached();
|
||
let expected_account_id = auth_before_reload
|
||
.as_ref()
|
||
.and_then(CodexAuth::get_account_id);
|
||
|
||
match self.reload_if_account_id_matches(expected_account_id.as_deref()) {
|
||
ReloadOutcome::ReloadedChanged => {
|
||
tracing::info!("Skipping token refresh because auth changed after guarded reload.");
|
||
Ok(())
|
||
}
|
||
ReloadOutcome::ReloadedNoChange => self.refresh_token_from_authority().await,
|
||
ReloadOutcome::Skipped => {
|
||
Err(RefreshTokenError::Permanent(RefreshTokenFailedError::new(
|
||
RefreshTokenFailedReason::Other,
|
||
REFRESH_TOKEN_ACCOUNT_MISMATCH_MESSAGE.to_string(),
|
||
)))
|
||
}
|
||
}
|
||
}
|
||
|
||
/// Attempt to refresh the current auth token from the authority that issued
|
||
/// the token. On success, reloads the auth state from disk so other components
|
||
/// observe refreshed token. If the token refresh fails, returns the error to
|
||
/// the caller.
|
||
pub async fn refresh_token_from_authority(&self) -> Result<(), RefreshTokenError> {
|
||
tracing::info!("Refreshing token");
|
||
|
||
let auth = match self.auth_cached() {
|
||
Some(auth) => auth,
|
||
None => return Ok(()),
|
||
};
|
||
match auth {
|
||
CodexAuth::ChatgptAuthTokens(_) => {
|
||
self.refresh_external_auth(ExternalAuthRefreshReason::Unauthorized)
|
||
.await
|
||
}
|
||
CodexAuth::Chatgpt(chatgpt_auth) => {
|
||
let token_data = chatgpt_auth.current_token_data().ok_or_else(|| {
|
||
RefreshTokenError::Transient(std::io::Error::other(
|
||
"Token data is not available.",
|
||
))
|
||
})?;
|
||
self.refresh_and_persist_chatgpt_token(&chatgpt_auth, token_data.refresh_token)
|
||
.await?;
|
||
Ok(())
|
||
}
|
||
CodexAuth::ApiKey(_) => Ok(()),
|
||
}
|
||
}
|
||
|
||
/// Log out by deleting the on‑disk auth.json (if present). Returns Ok(true)
|
||
/// if a file was removed, Ok(false) if no auth file existed. On success,
|
||
/// reloads the in‑memory auth cache so callers immediately observe the
|
||
/// unauthenticated state.
|
||
pub fn logout(&self) -> std::io::Result<bool> {
|
||
let removed = logout_all_stores(&self.codex_home, self.auth_credentials_store_mode)?;
|
||
// Always reload to clear any cached auth (even if file absent).
|
||
self.reload();
|
||
Ok(removed)
|
||
}
|
||
|
||
pub fn get_api_auth_mode(&self) -> Option<ApiAuthMode> {
|
||
self.auth_cached().as_ref().map(CodexAuth::api_auth_mode)
|
||
}
|
||
|
||
pub fn auth_mode(&self) -> Option<AuthMode> {
|
||
self.auth_cached().as_ref().map(CodexAuth::auth_mode)
|
||
}
|
||
|
||
async fn refresh_if_stale(&self, auth: &CodexAuth) -> Result<bool, RefreshTokenError> {
|
||
let chatgpt_auth = match auth {
|
||
CodexAuth::Chatgpt(chatgpt_auth) => chatgpt_auth,
|
||
_ => return Ok(false),
|
||
};
|
||
|
||
let auth_dot_json = match chatgpt_auth.current_auth_json() {
|
||
Some(auth_dot_json) => auth_dot_json,
|
||
None => return Ok(false),
|
||
};
|
||
let tokens = match auth_dot_json.tokens {
|
||
Some(tokens) => tokens,
|
||
None => return Ok(false),
|
||
};
|
||
let last_refresh = match auth_dot_json.last_refresh {
|
||
Some(last_refresh) => last_refresh,
|
||
None => return Ok(false),
|
||
};
|
||
if last_refresh >= Utc::now() - chrono::Duration::days(TOKEN_REFRESH_INTERVAL) {
|
||
return Ok(false);
|
||
}
|
||
self.refresh_and_persist_chatgpt_token(chatgpt_auth, tokens.refresh_token)
|
||
.await?;
|
||
Ok(true)
|
||
}
|
||
|
||
async fn refresh_external_auth(
|
||
&self,
|
||
reason: ExternalAuthRefreshReason,
|
||
) -> Result<(), RefreshTokenError> {
|
||
let forced_chatgpt_workspace_id = self.forced_chatgpt_workspace_id();
|
||
let refresher = match self.inner.read() {
|
||
Ok(guard) => guard.external_refresher.clone(),
|
||
Err(_) => {
|
||
return Err(RefreshTokenError::Transient(std::io::Error::other(
|
||
"failed to read external auth state",
|
||
)));
|
||
}
|
||
};
|
||
|
||
let Some(refresher) = refresher else {
|
||
return Err(RefreshTokenError::Transient(std::io::Error::other(
|
||
"external auth refresher is not configured",
|
||
)));
|
||
};
|
||
|
||
let previous_account_id = self
|
||
.auth_cached()
|
||
.as_ref()
|
||
.and_then(CodexAuth::get_account_id);
|
||
let context = ExternalAuthRefreshContext {
|
||
reason,
|
||
previous_account_id,
|
||
};
|
||
|
||
let refreshed = refresher.refresh(context).await?;
|
||
if let Some(expected_workspace_id) = forced_chatgpt_workspace_id.as_deref()
|
||
&& refreshed.chatgpt_account_id != expected_workspace_id
|
||
{
|
||
return Err(RefreshTokenError::Transient(std::io::Error::other(
|
||
format!(
|
||
"external auth refresh returned workspace {:?}, expected {expected_workspace_id:?}",
|
||
refreshed.chatgpt_account_id,
|
||
),
|
||
)));
|
||
}
|
||
let auth_dot_json =
|
||
AuthDotJson::from_external_tokens(&refreshed).map_err(RefreshTokenError::Transient)?;
|
||
save_auth(
|
||
&self.codex_home,
|
||
&auth_dot_json,
|
||
AuthCredentialsStoreMode::Ephemeral,
|
||
)
|
||
.map_err(RefreshTokenError::Transient)?;
|
||
self.reload();
|
||
Ok(())
|
||
}
|
||
|
||
// Refreshes ChatGPT OAuth tokens, persists the updated auth state, and
|
||
// reloads the in-memory cache so callers immediately observe new tokens.
|
||
async fn refresh_and_persist_chatgpt_token(
|
||
&self,
|
||
auth: &ChatgptAuth,
|
||
refresh_token: String,
|
||
) -> Result<(), RefreshTokenError> {
|
||
let refresh_response = request_chatgpt_token_refresh(refresh_token, auth.client()).await?;
|
||
|
||
persist_tokens(
|
||
auth.storage(),
|
||
refresh_response.id_token,
|
||
refresh_response.access_token,
|
||
refresh_response.refresh_token,
|
||
)
|
||
.map_err(RefreshTokenError::from)?;
|
||
self.reload();
|
||
|
||
Ok(())
|
||
}
|
||
}
|
||
|
||
#[cfg(test)]
|
||
#[path = "auth_tests.rs"]
|
||
mod tests;
|