mirror of
https://github.com/openai/codex.git
synced 2026-11-02 19:43:24 +00:00
## Problem Users without Codex access can hit a confusing local login loop. In the denial case, the callback could fall through to generic behavior (including a plain "Missing authorization code" page) instead of clearly explaining that access was denied. <img width="842" height="464" alt="Screenshot 2026-02-19 at 11 43 45 PM" src="https://github.com/user-attachments/assets/f7a25e1d-e480-4ac2-b0ff-8bfe31003e66" /> <img width="842" height="464" alt="Screenshot 2026-02-19 at 11 44 53 PM" src="https://github.com/user-attachments/assets/8a4fe6e4-b27b-483c-9f0c-60164933221d" /> ## Scope This PR improves local login error clarity only. It does not change entitlement policy, RBAC rules, or who is allowed to use Codex. ## What Changed - The local OAuth callback handler now parses `error` and `error_description` on `/auth/callback` and exits the callback loop with a real failure. - Callback failures render a branded local Codex error page instead of a generic/plain page. - `access_denied` + `missing_codex_entitlement` is now mapped to an explicit user-facing message telling the user Codex is not enabled for their workspace and to contact their workspace administrator for access. - Unknown OAuth callback errors continue to use a generic error page while preserving the OAuth error code/details for debugging. - Added the login error page template to Bazel assets so the local binary can render it in Bazel builds. ## Non-goals - No TUI onboarding/toast changes in this PR. - No backend entitlement or policy changes. ## Tests - Added an end-to-end `codex-login` test for `access_denied` + `missing_codex_entitlement` and verified the page shows the actionable admin guidance. - Added an end-to-end `codex-login` test for a generic `access_denied` reason to verify we keep a generic fallback page/message.
879 lines
31 KiB
Rust
879 lines
31 KiB
Rust
//! Local OAuth callback server for CLI login.
|
||
//!
|
||
//! This module runs the short-lived localhost server used by interactive sign-in.
|
||
use std::io::Cursor;
|
||
use std::io::Read;
|
||
use std::io::Write;
|
||
use std::io::{self};
|
||
use std::net::SocketAddr;
|
||
use std::net::TcpStream;
|
||
use std::path::Path;
|
||
use std::path::PathBuf;
|
||
use std::sync::Arc;
|
||
use std::thread;
|
||
use std::time::Duration;
|
||
|
||
use crate::pkce::PkceCodes;
|
||
use crate::pkce::generate_pkce;
|
||
use base64::Engine;
|
||
use chrono::Utc;
|
||
use codex_app_server_protocol::AuthMode;
|
||
use codex_core::auth::AuthCredentialsStoreMode;
|
||
use codex_core::auth::AuthDotJson;
|
||
use codex_core::auth::save_auth;
|
||
use codex_core::default_client::originator;
|
||
use codex_core::token_data::TokenData;
|
||
use codex_core::token_data::parse_chatgpt_jwt_claims;
|
||
use rand::RngCore;
|
||
use serde_json::Value as JsonValue;
|
||
use tiny_http::Header;
|
||
use tiny_http::Request;
|
||
use tiny_http::Response;
|
||
use tiny_http::Server;
|
||
use tiny_http::StatusCode;
|
||
|
||
const DEFAULT_ISSUER: &str = "https://auth.openai.com";
|
||
const DEFAULT_PORT: u16 = 1455;
|
||
|
||
/// Options for launching the local login callback server.
|
||
#[derive(Debug, Clone)]
|
||
pub struct ServerOptions {
|
||
pub codex_home: PathBuf,
|
||
pub client_id: String,
|
||
pub issuer: String,
|
||
pub port: u16,
|
||
pub open_browser: bool,
|
||
pub force_state: Option<String>,
|
||
pub forced_chatgpt_workspace_id: Option<String>,
|
||
pub cli_auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
}
|
||
|
||
impl ServerOptions {
|
||
/// Creates a server configuration with the default issuer and port.
|
||
pub fn new(
|
||
codex_home: PathBuf,
|
||
client_id: String,
|
||
forced_chatgpt_workspace_id: Option<String>,
|
||
cli_auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> Self {
|
||
Self {
|
||
codex_home,
|
||
client_id,
|
||
issuer: DEFAULT_ISSUER.to_string(),
|
||
port: DEFAULT_PORT,
|
||
open_browser: true,
|
||
force_state: None,
|
||
forced_chatgpt_workspace_id,
|
||
cli_auth_credentials_store_mode,
|
||
}
|
||
}
|
||
}
|
||
|
||
/// Handle for a running login callback server.
|
||
pub struct LoginServer {
|
||
pub auth_url: String,
|
||
pub actual_port: u16,
|
||
server_handle: tokio::task::JoinHandle<io::Result<()>>,
|
||
shutdown_handle: ShutdownHandle,
|
||
}
|
||
|
||
impl LoginServer {
|
||
/// Waits for the login callback loop to finish.
|
||
pub async fn block_until_done(self) -> io::Result<()> {
|
||
self.server_handle
|
||
.await
|
||
.map_err(|err| io::Error::other(format!("login server thread panicked: {err:?}")))?
|
||
}
|
||
|
||
/// Requests shutdown of the callback server.
|
||
pub fn cancel(&self) {
|
||
self.shutdown_handle.shutdown();
|
||
}
|
||
|
||
/// Returns a cloneable cancel handle for the running server.
|
||
pub fn cancel_handle(&self) -> ShutdownHandle {
|
||
self.shutdown_handle.clone()
|
||
}
|
||
}
|
||
|
||
/// Handle used to signal the login server loop to exit.
|
||
#[derive(Clone, Debug)]
|
||
pub struct ShutdownHandle {
|
||
shutdown_notify: Arc<tokio::sync::Notify>,
|
||
}
|
||
|
||
impl ShutdownHandle {
|
||
/// Signals the login loop to terminate.
|
||
pub fn shutdown(&self) {
|
||
self.shutdown_notify.notify_waiters();
|
||
}
|
||
}
|
||
|
||
/// Starts a local callback server and returns the browser auth URL.
|
||
pub fn run_login_server(opts: ServerOptions) -> io::Result<LoginServer> {
|
||
let pkce = generate_pkce();
|
||
let state = opts.force_state.clone().unwrap_or_else(generate_state);
|
||
|
||
let server = bind_server(opts.port)?;
|
||
let actual_port = match server.server_addr().to_ip() {
|
||
Some(addr) => addr.port(),
|
||
None => {
|
||
return Err(io::Error::new(
|
||
io::ErrorKind::AddrInUse,
|
||
"Unable to determine the server port",
|
||
));
|
||
}
|
||
};
|
||
let server = Arc::new(server);
|
||
|
||
let redirect_uri = format!("http://localhost:{actual_port}/auth/callback");
|
||
let auth_url = build_authorize_url(
|
||
&opts.issuer,
|
||
&opts.client_id,
|
||
&redirect_uri,
|
||
&pkce,
|
||
&state,
|
||
opts.forced_chatgpt_workspace_id.as_deref(),
|
||
);
|
||
|
||
if opts.open_browser {
|
||
let _ = webbrowser::open(&auth_url);
|
||
}
|
||
|
||
// Map blocking reads from server.recv() to an async channel.
|
||
let (tx, mut rx) = tokio::sync::mpsc::channel::<Request>(16);
|
||
let _server_handle = {
|
||
let server = server.clone();
|
||
thread::spawn(move || -> io::Result<()> {
|
||
while let Ok(request) = server.recv() {
|
||
tx.blocking_send(request).map_err(|e| {
|
||
eprintln!("Failed to send request to channel: {e}");
|
||
io::Error::other("Failed to send request to channel")
|
||
})?;
|
||
}
|
||
Ok(())
|
||
})
|
||
};
|
||
|
||
let shutdown_notify = Arc::new(tokio::sync::Notify::new());
|
||
let server_handle = {
|
||
let shutdown_notify = shutdown_notify.clone();
|
||
let server = server;
|
||
tokio::spawn(async move {
|
||
let result = loop {
|
||
tokio::select! {
|
||
_ = shutdown_notify.notified() => {
|
||
break Err(io::Error::other("Login was not completed"));
|
||
}
|
||
maybe_req = rx.recv() => {
|
||
let Some(req) = maybe_req else {
|
||
break Err(io::Error::other("Login was not completed"));
|
||
};
|
||
|
||
let url_raw = req.url().to_string();
|
||
let response =
|
||
process_request(&url_raw, &opts, &redirect_uri, &pkce, actual_port, &state).await;
|
||
|
||
let exit_result = match response {
|
||
HandledRequest::Response(response) => {
|
||
let _ = tokio::task::spawn_blocking(move || req.respond(response)).await;
|
||
None
|
||
}
|
||
HandledRequest::ResponseAndExit {
|
||
headers,
|
||
body,
|
||
result,
|
||
} => {
|
||
let _ = tokio::task::spawn_blocking(move || {
|
||
send_response_with_disconnect(req, headers, body)
|
||
})
|
||
.await;
|
||
Some(result)
|
||
}
|
||
HandledRequest::RedirectWithHeader(header) => {
|
||
let redirect = Response::empty(302).with_header(header);
|
||
let _ = tokio::task::spawn_blocking(move || req.respond(redirect)).await;
|
||
None
|
||
}
|
||
};
|
||
|
||
if let Some(result) = exit_result {
|
||
break result;
|
||
}
|
||
}
|
||
}
|
||
};
|
||
|
||
// Ensure that the server is unblocked so the thread dedicated to
|
||
// running `server.recv()` in a loop exits cleanly.
|
||
server.unblock();
|
||
result
|
||
})
|
||
};
|
||
|
||
Ok(LoginServer {
|
||
auth_url,
|
||
actual_port,
|
||
server_handle,
|
||
shutdown_handle: ShutdownHandle { shutdown_notify },
|
||
})
|
||
}
|
||
|
||
/// Internal callback handling outcome.
|
||
enum HandledRequest {
|
||
Response(Response<Cursor<Vec<u8>>>),
|
||
RedirectWithHeader(Header),
|
||
ResponseAndExit {
|
||
headers: Vec<Header>,
|
||
body: Vec<u8>,
|
||
result: io::Result<()>,
|
||
},
|
||
}
|
||
|
||
async fn process_request(
|
||
url_raw: &str,
|
||
opts: &ServerOptions,
|
||
redirect_uri: &str,
|
||
pkce: &PkceCodes,
|
||
actual_port: u16,
|
||
state: &str,
|
||
) -> HandledRequest {
|
||
let parsed_url = match url::Url::parse(&format!("http://localhost{url_raw}")) {
|
||
Ok(u) => u,
|
||
Err(e) => {
|
||
eprintln!("URL parse error: {e}");
|
||
return HandledRequest::Response(
|
||
Response::from_string("Bad Request").with_status_code(400),
|
||
);
|
||
}
|
||
};
|
||
let path = parsed_url.path().to_string();
|
||
|
||
match path.as_str() {
|
||
"/auth/callback" => {
|
||
let params: std::collections::HashMap<String, String> =
|
||
parsed_url.query_pairs().into_owned().collect();
|
||
if params.get("state").map(String::as_str) != Some(state) {
|
||
return HandledRequest::Response(
|
||
Response::from_string("State mismatch").with_status_code(400),
|
||
);
|
||
}
|
||
if let Some(error_code) = params.get("error") {
|
||
let error_description = params.get("error_description").map(String::as_str);
|
||
let message = oauth_callback_error_message(error_code, error_description);
|
||
eprintln!("OAuth callback error: {message}");
|
||
return login_error_response(
|
||
&message,
|
||
io::ErrorKind::PermissionDenied,
|
||
Some(error_code),
|
||
error_description,
|
||
);
|
||
}
|
||
let code = match params.get("code") {
|
||
Some(c) if !c.is_empty() => c.clone(),
|
||
_ => {
|
||
return login_error_response(
|
||
"Missing authorization code. Sign-in could not be completed.",
|
||
io::ErrorKind::InvalidData,
|
||
Some("missing_authorization_code"),
|
||
None,
|
||
);
|
||
}
|
||
};
|
||
|
||
match exchange_code_for_tokens(&opts.issuer, &opts.client_id, redirect_uri, pkce, &code)
|
||
.await
|
||
{
|
||
Ok(tokens) => {
|
||
if let Err(message) = ensure_workspace_allowed(
|
||
opts.forced_chatgpt_workspace_id.as_deref(),
|
||
&tokens.id_token,
|
||
) {
|
||
eprintln!("Workspace restriction error: {message}");
|
||
return login_error_response(
|
||
&message,
|
||
io::ErrorKind::PermissionDenied,
|
||
Some("workspace_restriction"),
|
||
None,
|
||
);
|
||
}
|
||
// Obtain API key via token-exchange and persist
|
||
let api_key = obtain_api_key(&opts.issuer, &opts.client_id, &tokens.id_token)
|
||
.await
|
||
.ok();
|
||
if let Err(err) = persist_tokens_async(
|
||
&opts.codex_home,
|
||
api_key.clone(),
|
||
tokens.id_token.clone(),
|
||
tokens.access_token.clone(),
|
||
tokens.refresh_token.clone(),
|
||
opts.cli_auth_credentials_store_mode,
|
||
)
|
||
.await
|
||
{
|
||
eprintln!("Persist error: {err}");
|
||
return login_error_response(
|
||
"Sign-in completed but credentials could not be saved locally.",
|
||
io::ErrorKind::Other,
|
||
Some("persist_failed"),
|
||
Some(&err.to_string()),
|
||
);
|
||
}
|
||
|
||
let success_url = compose_success_url(
|
||
actual_port,
|
||
&opts.issuer,
|
||
&tokens.id_token,
|
||
&tokens.access_token,
|
||
);
|
||
match tiny_http::Header::from_bytes(&b"Location"[..], success_url.as_bytes()) {
|
||
Ok(header) => HandledRequest::RedirectWithHeader(header),
|
||
Err(_) => login_error_response(
|
||
"Sign-in completed but redirecting back to Codex failed.",
|
||
io::ErrorKind::Other,
|
||
Some("redirect_failed"),
|
||
None,
|
||
),
|
||
}
|
||
}
|
||
Err(err) => {
|
||
eprintln!("Token exchange error: {err}");
|
||
login_error_response(
|
||
&format!("Token exchange failed: {err}"),
|
||
io::ErrorKind::Other,
|
||
Some("token_exchange_failed"),
|
||
None,
|
||
)
|
||
}
|
||
}
|
||
}
|
||
"/success" => {
|
||
let body = include_str!("assets/success.html");
|
||
HandledRequest::ResponseAndExit {
|
||
headers: match Header::from_bytes(
|
||
&b"Content-Type"[..],
|
||
&b"text/html; charset=utf-8"[..],
|
||
) {
|
||
Ok(header) => vec![header],
|
||
Err(_) => Vec::new(),
|
||
},
|
||
body: body.as_bytes().to_vec(),
|
||
result: Ok(()),
|
||
}
|
||
}
|
||
"/cancel" => HandledRequest::ResponseAndExit {
|
||
headers: Vec::new(),
|
||
body: b"Login cancelled".to_vec(),
|
||
result: Err(io::Error::new(
|
||
io::ErrorKind::Interrupted,
|
||
"Login cancelled",
|
||
)),
|
||
},
|
||
_ => HandledRequest::Response(Response::from_string("Not Found").with_status_code(404)),
|
||
}
|
||
}
|
||
|
||
/// tiny_http filters `Connection` headers out of `Response` objects, so using
|
||
/// `req.respond` never informs the client (or the library) that a keep-alive
|
||
/// socket should be closed. That leaves the per-connection worker parked in a
|
||
/// loop waiting for more requests, which in turn causes the next login attempt
|
||
/// to hang on the old connection. This helper bypasses tiny_http’s response
|
||
/// machinery: it extracts the raw writer, prints the HTTP response manually,
|
||
/// and always appends `Connection: close`, ensuring the socket is closed from
|
||
/// the server side. Ideally, tiny_http would provide an API to control
|
||
/// server-side connection persistence, but it does not.
|
||
fn send_response_with_disconnect(
|
||
req: Request,
|
||
mut headers: Vec<Header>,
|
||
body: Vec<u8>,
|
||
) -> io::Result<()> {
|
||
let status = StatusCode(200);
|
||
let mut writer = req.into_writer();
|
||
let reason = status.default_reason_phrase();
|
||
write!(writer, "HTTP/1.1 {} {}\r\n", status.0, reason)?;
|
||
headers.retain(|h| !h.field.equiv("Connection"));
|
||
if let Ok(close_header) = Header::from_bytes(&b"Connection"[..], &b"close"[..]) {
|
||
headers.push(close_header);
|
||
}
|
||
|
||
let content_length_value = format!("{}", body.len());
|
||
if let Ok(content_length_header) =
|
||
Header::from_bytes(&b"Content-Length"[..], content_length_value.as_bytes())
|
||
{
|
||
headers.push(content_length_header);
|
||
}
|
||
|
||
for header in headers {
|
||
write!(
|
||
writer,
|
||
"{}: {}\r\n",
|
||
header.field.as_str(),
|
||
header.value.as_str()
|
||
)?;
|
||
}
|
||
|
||
writer.write_all(b"\r\n")?;
|
||
writer.write_all(&body)?;
|
||
writer.flush()
|
||
}
|
||
|
||
fn build_authorize_url(
|
||
issuer: &str,
|
||
client_id: &str,
|
||
redirect_uri: &str,
|
||
pkce: &PkceCodes,
|
||
state: &str,
|
||
forced_chatgpt_workspace_id: Option<&str>,
|
||
) -> String {
|
||
let mut query = vec![
|
||
("response_type".to_string(), "code".to_string()),
|
||
("client_id".to_string(), client_id.to_string()),
|
||
("redirect_uri".to_string(), redirect_uri.to_string()),
|
||
(
|
||
"scope".to_string(),
|
||
"openid profile email offline_access".to_string(),
|
||
),
|
||
(
|
||
"code_challenge".to_string(),
|
||
pkce.code_challenge.to_string(),
|
||
),
|
||
("code_challenge_method".to_string(), "S256".to_string()),
|
||
("id_token_add_organizations".to_string(), "true".to_string()),
|
||
("codex_cli_simplified_flow".to_string(), "true".to_string()),
|
||
("state".to_string(), state.to_string()),
|
||
(
|
||
"originator".to_string(),
|
||
originator().value.as_str().to_string(),
|
||
),
|
||
];
|
||
if let Some(workspace_id) = forced_chatgpt_workspace_id {
|
||
query.push(("allowed_workspace_id".to_string(), workspace_id.to_string()));
|
||
}
|
||
let qs = query
|
||
.into_iter()
|
||
.map(|(k, v)| format!("{k}={}", urlencoding::encode(&v)))
|
||
.collect::<Vec<_>>()
|
||
.join("&");
|
||
format!("{issuer}/oauth/authorize?{qs}")
|
||
}
|
||
|
||
fn generate_state() -> String {
|
||
let mut bytes = [0u8; 32];
|
||
rand::rng().fill_bytes(&mut bytes);
|
||
base64::engine::general_purpose::URL_SAFE_NO_PAD.encode(bytes)
|
||
}
|
||
|
||
fn send_cancel_request(port: u16) -> io::Result<()> {
|
||
let addr: SocketAddr = format!("127.0.0.1:{port}")
|
||
.parse()
|
||
.map_err(|err| io::Error::new(io::ErrorKind::InvalidInput, err))?;
|
||
let mut stream = TcpStream::connect_timeout(&addr, Duration::from_secs(2))?;
|
||
stream.set_read_timeout(Some(Duration::from_secs(2)))?;
|
||
stream.set_write_timeout(Some(Duration::from_secs(2)))?;
|
||
|
||
stream.write_all(b"GET /cancel HTTP/1.1\r\n")?;
|
||
stream.write_all(format!("Host: 127.0.0.1:{port}\r\n").as_bytes())?;
|
||
stream.write_all(b"Connection: close\r\n\r\n")?;
|
||
|
||
let mut buf = [0u8; 64];
|
||
let _ = stream.read(&mut buf);
|
||
Ok(())
|
||
}
|
||
|
||
fn bind_server(port: u16) -> io::Result<Server> {
|
||
let bind_address = format!("127.0.0.1:{port}");
|
||
let mut cancel_attempted = false;
|
||
let mut attempts = 0;
|
||
const MAX_ATTEMPTS: u32 = 10;
|
||
const RETRY_DELAY: Duration = Duration::from_millis(200);
|
||
|
||
loop {
|
||
match Server::http(&bind_address) {
|
||
Ok(server) => return Ok(server),
|
||
Err(err) => {
|
||
attempts += 1;
|
||
let is_addr_in_use = err
|
||
.downcast_ref::<io::Error>()
|
||
.map(|io_err| io_err.kind() == io::ErrorKind::AddrInUse)
|
||
.unwrap_or(false);
|
||
|
||
// If the address is in use, there is probably another instance of the login server
|
||
// running. Attempt to cancel it and retry.
|
||
if is_addr_in_use {
|
||
if !cancel_attempted {
|
||
cancel_attempted = true;
|
||
if let Err(cancel_err) = send_cancel_request(port) {
|
||
eprintln!("Failed to cancel previous login server: {cancel_err}");
|
||
}
|
||
}
|
||
|
||
thread::sleep(RETRY_DELAY);
|
||
|
||
if attempts >= MAX_ATTEMPTS {
|
||
return Err(io::Error::new(
|
||
io::ErrorKind::AddrInUse,
|
||
format!("Port {bind_address} is already in use"),
|
||
));
|
||
}
|
||
|
||
continue;
|
||
}
|
||
|
||
return Err(io::Error::other(err));
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
/// Tokens returned by the OAuth authorization-code exchange.
|
||
pub(crate) struct ExchangedTokens {
|
||
pub id_token: String,
|
||
pub access_token: String,
|
||
pub refresh_token: String,
|
||
}
|
||
|
||
/// Exchanges an authorization code for tokens.
|
||
pub(crate) async fn exchange_code_for_tokens(
|
||
issuer: &str,
|
||
client_id: &str,
|
||
redirect_uri: &str,
|
||
pkce: &PkceCodes,
|
||
code: &str,
|
||
) -> io::Result<ExchangedTokens> {
|
||
#[derive(serde::Deserialize)]
|
||
struct TokenResponse {
|
||
id_token: String,
|
||
access_token: String,
|
||
refresh_token: String,
|
||
}
|
||
|
||
let client = reqwest::Client::new();
|
||
let resp = client
|
||
.post(format!("{issuer}/oauth/token"))
|
||
.header("Content-Type", "application/x-www-form-urlencoded")
|
||
.body(format!(
|
||
"grant_type=authorization_code&code={}&redirect_uri={}&client_id={}&code_verifier={}",
|
||
urlencoding::encode(code),
|
||
urlencoding::encode(redirect_uri),
|
||
urlencoding::encode(client_id),
|
||
urlencoding::encode(&pkce.code_verifier)
|
||
))
|
||
.send()
|
||
.await
|
||
.map_err(io::Error::other)?;
|
||
|
||
let status = resp.status();
|
||
if !status.is_success() {
|
||
let body = resp.text().await.map_err(io::Error::other)?;
|
||
let detail = parse_token_endpoint_error(&body);
|
||
return Err(io::Error::other(format!(
|
||
"token endpoint returned status {status}: {detail}"
|
||
)));
|
||
}
|
||
|
||
let tokens: TokenResponse = resp.json().await.map_err(io::Error::other)?;
|
||
Ok(ExchangedTokens {
|
||
id_token: tokens.id_token,
|
||
access_token: tokens.access_token,
|
||
refresh_token: tokens.refresh_token,
|
||
})
|
||
}
|
||
|
||
/// Persists exchanged credentials using the configured local auth store.
|
||
pub(crate) async fn persist_tokens_async(
|
||
codex_home: &Path,
|
||
api_key: Option<String>,
|
||
id_token: String,
|
||
access_token: String,
|
||
refresh_token: String,
|
||
auth_credentials_store_mode: AuthCredentialsStoreMode,
|
||
) -> io::Result<()> {
|
||
// Reuse existing synchronous logic but run it off the async runtime.
|
||
let codex_home = codex_home.to_path_buf();
|
||
tokio::task::spawn_blocking(move || {
|
||
let mut tokens = TokenData {
|
||
id_token: parse_chatgpt_jwt_claims(&id_token).map_err(io::Error::other)?,
|
||
access_token,
|
||
refresh_token,
|
||
account_id: None,
|
||
};
|
||
if let Some(acc) = jwt_auth_claims(&id_token)
|
||
.get("chatgpt_account_id")
|
||
.and_then(|v| v.as_str())
|
||
{
|
||
tokens.account_id = Some(acc.to_string());
|
||
}
|
||
let auth = AuthDotJson {
|
||
auth_mode: Some(AuthMode::Chatgpt),
|
||
openai_api_key: api_key,
|
||
tokens: Some(tokens),
|
||
last_refresh: Some(Utc::now()),
|
||
};
|
||
save_auth(&codex_home, &auth, auth_credentials_store_mode)
|
||
})
|
||
.await
|
||
.map_err(|e| io::Error::other(format!("persist task failed: {e}")))?
|
||
}
|
||
|
||
fn compose_success_url(port: u16, issuer: &str, id_token: &str, access_token: &str) -> String {
|
||
let token_claims = jwt_auth_claims(id_token);
|
||
let access_claims = jwt_auth_claims(access_token);
|
||
|
||
let org_id = token_claims
|
||
.get("organization_id")
|
||
.and_then(|v| v.as_str())
|
||
.unwrap_or("");
|
||
let project_id = token_claims
|
||
.get("project_id")
|
||
.and_then(|v| v.as_str())
|
||
.unwrap_or("");
|
||
let completed_onboarding = token_claims
|
||
.get("completed_platform_onboarding")
|
||
.and_then(JsonValue::as_bool)
|
||
.unwrap_or(false);
|
||
let is_org_owner = token_claims
|
||
.get("is_org_owner")
|
||
.and_then(JsonValue::as_bool)
|
||
.unwrap_or(false);
|
||
let needs_setup = (!completed_onboarding) && is_org_owner;
|
||
let plan_type = access_claims
|
||
.get("chatgpt_plan_type")
|
||
.and_then(|v| v.as_str())
|
||
.unwrap_or("");
|
||
|
||
let platform_url = if issuer == DEFAULT_ISSUER {
|
||
"https://platform.openai.com"
|
||
} else {
|
||
"https://platform.api.openai.org"
|
||
};
|
||
|
||
let mut params = vec![
|
||
("id_token", id_token.to_string()),
|
||
("needs_setup", needs_setup.to_string()),
|
||
("org_id", org_id.to_string()),
|
||
("project_id", project_id.to_string()),
|
||
("plan_type", plan_type.to_string()),
|
||
("platform_url", platform_url.to_string()),
|
||
];
|
||
let qs = params
|
||
.drain(..)
|
||
.map(|(k, v)| format!("{}={}", k, urlencoding::encode(&v)))
|
||
.collect::<Vec<_>>()
|
||
.join("&");
|
||
format!("http://localhost:{port}/success?{qs}")
|
||
}
|
||
|
||
fn jwt_auth_claims(jwt: &str) -> serde_json::Map<String, serde_json::Value> {
|
||
let mut parts = jwt.split('.');
|
||
let (_h, payload_b64, _s) = match (parts.next(), parts.next(), parts.next()) {
|
||
(Some(h), Some(p), Some(s)) if !h.is_empty() && !p.is_empty() && !s.is_empty() => (h, p, s),
|
||
_ => {
|
||
eprintln!("Invalid JWT format while extracting claims");
|
||
return serde_json::Map::new();
|
||
}
|
||
};
|
||
match base64::engine::general_purpose::URL_SAFE_NO_PAD.decode(payload_b64) {
|
||
Ok(bytes) => match serde_json::from_slice::<serde_json::Value>(&bytes) {
|
||
Ok(mut v) => {
|
||
if let Some(obj) = v
|
||
.get_mut("https://api.openai.com/auth")
|
||
.and_then(|x| x.as_object_mut())
|
||
{
|
||
return obj.clone();
|
||
}
|
||
eprintln!("JWT payload missing expected 'https://api.openai.com/auth' object");
|
||
}
|
||
Err(e) => {
|
||
eprintln!("Failed to parse JWT JSON payload: {e}");
|
||
}
|
||
},
|
||
Err(e) => {
|
||
eprintln!("Failed to base64url-decode JWT payload: {e}");
|
||
}
|
||
}
|
||
serde_json::Map::new()
|
||
}
|
||
|
||
/// Validates the ID token against an optional workspace restriction.
|
||
pub(crate) fn ensure_workspace_allowed(
|
||
expected: Option<&str>,
|
||
id_token: &str,
|
||
) -> Result<(), String> {
|
||
let Some(expected) = expected else {
|
||
return Ok(());
|
||
};
|
||
|
||
let claims = jwt_auth_claims(id_token);
|
||
let Some(actual) = claims.get("chatgpt_account_id").and_then(JsonValue::as_str) else {
|
||
return Err("Login is restricted to a specific workspace, but the token did not include an chatgpt_account_id claim.".to_string());
|
||
};
|
||
|
||
if actual == expected {
|
||
Ok(())
|
||
} else {
|
||
Err(format!("Login is restricted to workspace id {expected}."))
|
||
}
|
||
}
|
||
|
||
/// Builds a terminal callback response for login failures.
|
||
fn login_error_response(
|
||
message: &str,
|
||
kind: io::ErrorKind,
|
||
error_code: Option<&str>,
|
||
error_description: Option<&str>,
|
||
) -> HandledRequest {
|
||
let mut headers = Vec::new();
|
||
if let Ok(header) = Header::from_bytes(&b"Content-Type"[..], &b"text/html; charset=utf-8"[..]) {
|
||
headers.push(header);
|
||
}
|
||
let body = render_login_error_page(message, error_code, error_description);
|
||
HandledRequest::ResponseAndExit {
|
||
headers,
|
||
body,
|
||
result: Err(io::Error::new(kind, message.to_string())),
|
||
}
|
||
}
|
||
|
||
/// Returns true when the OAuth callback represents a missing Codex entitlement.
|
||
fn is_missing_codex_entitlement_error(error_code: &str, error_description: Option<&str>) -> bool {
|
||
error_code == "access_denied"
|
||
&& error_description.is_some_and(|description| {
|
||
description
|
||
.to_ascii_lowercase()
|
||
.contains("missing_codex_entitlement")
|
||
})
|
||
}
|
||
|
||
/// Converts OAuth callback errors into a user-facing message.
|
||
fn oauth_callback_error_message(error_code: &str, error_description: Option<&str>) -> String {
|
||
if is_missing_codex_entitlement_error(error_code, error_description) {
|
||
return "Codex is not enabled for your workspace. Contact your workspace administrator to request access to Codex.".to_string();
|
||
}
|
||
|
||
if let Some(description) = error_description
|
||
&& !description.trim().is_empty()
|
||
{
|
||
return format!("Sign-in failed: {description}");
|
||
}
|
||
|
||
format!("Sign-in failed: {error_code}")
|
||
}
|
||
|
||
/// Extracts a readable error from token endpoint responses.
|
||
fn parse_token_endpoint_error(body: &str) -> String {
|
||
let trimmed = body.trim();
|
||
if trimmed.is_empty() {
|
||
return "unknown error".to_string();
|
||
}
|
||
|
||
let parsed = serde_json::from_str::<JsonValue>(trimmed).ok();
|
||
if let Some(json) = parsed {
|
||
if let Some(description) = json.get("error_description").and_then(JsonValue::as_str)
|
||
&& !description.trim().is_empty()
|
||
{
|
||
return description.to_string();
|
||
}
|
||
if let Some(error_obj) = json.get("error")
|
||
&& let Some(message) = error_obj.get("message").and_then(JsonValue::as_str)
|
||
&& !message.trim().is_empty()
|
||
{
|
||
return message.to_string();
|
||
}
|
||
if let Some(error_code) = json.get("error").and_then(JsonValue::as_str)
|
||
&& !error_code.trim().is_empty()
|
||
{
|
||
return error_code.to_string();
|
||
}
|
||
}
|
||
|
||
trimmed.to_string()
|
||
}
|
||
|
||
/// Renders the branded error page used by callback failures.
|
||
fn render_login_error_page(
|
||
message: &str,
|
||
error_code: Option<&str>,
|
||
error_description: Option<&str>,
|
||
) -> Vec<u8> {
|
||
let template = include_str!("assets/error.html");
|
||
let code = error_code.unwrap_or("unknown_error");
|
||
let (title, display_message, display_description, help_text) =
|
||
if is_missing_codex_entitlement_error(code, error_description) {
|
||
(
|
||
"You do not have access to Codex".to_string(),
|
||
"This account is not currently authorized to use Codex in this workspace."
|
||
.to_string(),
|
||
"Contact your workspace administrator to request access to Codex.".to_string(),
|
||
"Contact your workspace administrator to get access to Codex, then return to Codex and try again."
|
||
.to_string(),
|
||
)
|
||
} else {
|
||
(
|
||
"Sign-in could not be completed".to_string(),
|
||
message.to_string(),
|
||
error_description.unwrap_or(message).to_string(),
|
||
"Return to Codex to retry, switch accounts, or contact your workspace admin if access is restricted."
|
||
.to_string(),
|
||
)
|
||
};
|
||
template
|
||
.replace("__ERROR_TITLE__", &html_escape(&title))
|
||
.replace("__ERROR_MESSAGE__", &html_escape(&display_message))
|
||
.replace("__ERROR_CODE__", &html_escape(code))
|
||
.replace("__ERROR_DESCRIPTION__", &html_escape(&display_description))
|
||
.replace("__ERROR_HELP__", &html_escape(&help_text))
|
||
.into_bytes()
|
||
}
|
||
|
||
/// Escapes error strings before inserting them into HTML.
|
||
fn html_escape(input: &str) -> String {
|
||
let mut escaped = String::with_capacity(input.len());
|
||
for ch in input.chars() {
|
||
match ch {
|
||
'&' => escaped.push_str("&"),
|
||
'<' => escaped.push_str("<"),
|
||
'>' => escaped.push_str(">"),
|
||
'"' => escaped.push_str("""),
|
||
'\'' => escaped.push_str("'"),
|
||
_ => escaped.push(ch),
|
||
}
|
||
}
|
||
escaped
|
||
}
|
||
|
||
/// Exchanges an authenticated ID token for an API-key style access token.
|
||
pub(crate) async fn obtain_api_key(
|
||
issuer: &str,
|
||
client_id: &str,
|
||
id_token: &str,
|
||
) -> io::Result<String> {
|
||
// Token exchange for an API key access token
|
||
#[derive(serde::Deserialize)]
|
||
struct ExchangeResp {
|
||
access_token: String,
|
||
}
|
||
let client = reqwest::Client::new();
|
||
let resp = client
|
||
.post(format!("{issuer}/oauth/token"))
|
||
.header("Content-Type", "application/x-www-form-urlencoded")
|
||
.body(format!(
|
||
"grant_type={}&client_id={}&requested_token={}&subject_token={}&subject_token_type={}",
|
||
urlencoding::encode("urn:ietf:params:oauth:grant-type:token-exchange"),
|
||
urlencoding::encode(client_id),
|
||
urlencoding::encode("openai-api-key"),
|
||
urlencoding::encode(id_token),
|
||
urlencoding::encode("urn:ietf:params:oauth:token-type:id_token")
|
||
))
|
||
.send()
|
||
.await
|
||
.map_err(io::Error::other)?;
|
||
if !resp.status().is_success() {
|
||
return Err(io::Error::other(format!(
|
||
"api key exchange failed with status {}",
|
||
resp.status()
|
||
)));
|
||
}
|
||
let body: ExchangeResp = resp.json().await.map_err(io::Error::other)?;
|
||
Ok(body.access_token)
|
||
}
|