mirror of
https://github.com/openai/codex.git
synced 2026-10-27 08:01:52 +00:00
Fixes [#8889](https://github.com/openai/codex/issues/8889). ## Summary - Discover and use advertised MCP OAuth `scopes_supported` when no explicit or configured scopes are present. - Apply the same scope precedence across `mcp add`, `mcp login`, skill dependency auto-login, and app-server MCP OAuth login. - Keep discovered scopes ephemeral and non-persistent. - Retry once without scopes for CLI and skill auto-login flows if the OAuth provider rejects discovered scopes. ## Motivation Some MCP servers advertise the scopes they expect clients to request during OAuth, but Codex was ignoring that metadata and typically starting OAuth with no scopes unless the user manually passed `--scopes` or configured `server.scopes`. That made compliant MCP servers harder to use out of the box and is the behavior described in [#8889](https://github.com/openai/codex/issues/8889). This change also brings our behavior in line with the MCP authorization spec's scope selection guidance: https://modelcontextprotocol.io/specification/2025-11-25/basic/authorization#scope-selection-strategy ## Behavior Scope selection now follows this order everywhere: 1. Explicit request scopes / CLI `--scopes` 2. Configured `server.scopes` 3. Discovered `scopes_supported` 4. Legacy empty-scope behavior Compatibility notes: - Existing working setups keep the same behavior because explicit and configured scopes still win. - Discovered scopes are never written back into config or token storage. - If discovery is missing, malformed, or empty, behavior falls back to the previous empty-scope path. - App-server login gets the same precedence rules, but does not add a transparent retry path in this change. ## Implementation - Extend streamable HTTP OAuth discovery to parse and normalize `scopes_supported`. - Add a shared MCP scope resolver in `core` so all login entrypoints use the same precedence rules. - Preserve provider callback errors from the OAuth flow so CLI/skill flows can safely distinguish provider rejections from other failures. - Reuse discovered scopes from the existing OAuth support check where possible instead of persisting new config.
289 lines
8.3 KiB
Rust
289 lines
8.3 KiB
Rust
use std::collections::HashMap;
|
|
|
|
use anyhow::Result;
|
|
use codex_protocol::protocol::McpAuthStatus;
|
|
use codex_rmcp_client::OAuthCredentialsStoreMode;
|
|
use codex_rmcp_client::OAuthProviderError;
|
|
use codex_rmcp_client::determine_streamable_http_auth_status;
|
|
use codex_rmcp_client::discover_streamable_http_oauth;
|
|
use futures::future::join_all;
|
|
use tracing::warn;
|
|
|
|
use crate::config::types::McpServerConfig;
|
|
use crate::config::types::McpServerTransportConfig;
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub struct McpOAuthLoginConfig {
|
|
pub url: String,
|
|
pub http_headers: Option<HashMap<String, String>>,
|
|
pub env_http_headers: Option<HashMap<String, String>>,
|
|
pub discovered_scopes: Option<Vec<String>>,
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
pub enum McpOAuthLoginSupport {
|
|
Supported(McpOAuthLoginConfig),
|
|
Unsupported,
|
|
Unknown(anyhow::Error),
|
|
}
|
|
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
|
pub enum McpOAuthScopesSource {
|
|
Explicit,
|
|
Configured,
|
|
Discovered,
|
|
Empty,
|
|
}
|
|
|
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
pub struct ResolvedMcpOAuthScopes {
|
|
pub scopes: Vec<String>,
|
|
pub source: McpOAuthScopesSource,
|
|
}
|
|
|
|
pub async fn oauth_login_support(transport: &McpServerTransportConfig) -> McpOAuthLoginSupport {
|
|
let McpServerTransportConfig::StreamableHttp {
|
|
url,
|
|
bearer_token_env_var,
|
|
http_headers,
|
|
env_http_headers,
|
|
} = transport
|
|
else {
|
|
return McpOAuthLoginSupport::Unsupported;
|
|
};
|
|
|
|
if bearer_token_env_var.is_some() {
|
|
return McpOAuthLoginSupport::Unsupported;
|
|
}
|
|
|
|
match discover_streamable_http_oauth(url, http_headers.clone(), env_http_headers.clone()).await
|
|
{
|
|
Ok(Some(discovery)) => McpOAuthLoginSupport::Supported(McpOAuthLoginConfig {
|
|
url: url.clone(),
|
|
http_headers: http_headers.clone(),
|
|
env_http_headers: env_http_headers.clone(),
|
|
discovered_scopes: discovery.scopes_supported,
|
|
}),
|
|
Ok(None) => McpOAuthLoginSupport::Unsupported,
|
|
Err(err) => McpOAuthLoginSupport::Unknown(err),
|
|
}
|
|
}
|
|
|
|
pub async fn discover_supported_scopes(
|
|
transport: &McpServerTransportConfig,
|
|
) -> Option<Vec<String>> {
|
|
match oauth_login_support(transport).await {
|
|
McpOAuthLoginSupport::Supported(config) => config.discovered_scopes,
|
|
McpOAuthLoginSupport::Unsupported | McpOAuthLoginSupport::Unknown(_) => None,
|
|
}
|
|
}
|
|
|
|
pub fn resolve_oauth_scopes(
|
|
explicit_scopes: Option<Vec<String>>,
|
|
configured_scopes: Option<Vec<String>>,
|
|
discovered_scopes: Option<Vec<String>>,
|
|
) -> ResolvedMcpOAuthScopes {
|
|
if let Some(scopes) = explicit_scopes {
|
|
return ResolvedMcpOAuthScopes {
|
|
scopes,
|
|
source: McpOAuthScopesSource::Explicit,
|
|
};
|
|
}
|
|
|
|
if let Some(scopes) = configured_scopes {
|
|
return ResolvedMcpOAuthScopes {
|
|
scopes,
|
|
source: McpOAuthScopesSource::Configured,
|
|
};
|
|
}
|
|
|
|
if let Some(scopes) = discovered_scopes
|
|
&& !scopes.is_empty()
|
|
{
|
|
return ResolvedMcpOAuthScopes {
|
|
scopes,
|
|
source: McpOAuthScopesSource::Discovered,
|
|
};
|
|
}
|
|
|
|
ResolvedMcpOAuthScopes {
|
|
scopes: Vec::new(),
|
|
source: McpOAuthScopesSource::Empty,
|
|
}
|
|
}
|
|
|
|
pub fn should_retry_without_scopes(scopes: &ResolvedMcpOAuthScopes, error: &anyhow::Error) -> bool {
|
|
scopes.source == McpOAuthScopesSource::Discovered
|
|
&& error.downcast_ref::<OAuthProviderError>().is_some()
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub struct McpAuthStatusEntry {
|
|
pub config: McpServerConfig,
|
|
pub auth_status: McpAuthStatus,
|
|
}
|
|
|
|
pub async fn compute_auth_statuses<'a, I>(
|
|
servers: I,
|
|
store_mode: OAuthCredentialsStoreMode,
|
|
) -> HashMap<String, McpAuthStatusEntry>
|
|
where
|
|
I: IntoIterator<Item = (&'a String, &'a McpServerConfig)>,
|
|
{
|
|
let futures = servers.into_iter().map(|(name, config)| {
|
|
let name = name.clone();
|
|
let config = config.clone();
|
|
async move {
|
|
let auth_status = match compute_auth_status(&name, &config, store_mode).await {
|
|
Ok(status) => status,
|
|
Err(error) => {
|
|
warn!("failed to determine auth status for MCP server `{name}`: {error:?}");
|
|
McpAuthStatus::Unsupported
|
|
}
|
|
};
|
|
let entry = McpAuthStatusEntry {
|
|
config,
|
|
auth_status,
|
|
};
|
|
(name, entry)
|
|
}
|
|
});
|
|
|
|
join_all(futures).await.into_iter().collect()
|
|
}
|
|
|
|
async fn compute_auth_status(
|
|
server_name: &str,
|
|
config: &McpServerConfig,
|
|
store_mode: OAuthCredentialsStoreMode,
|
|
) -> Result<McpAuthStatus> {
|
|
match &config.transport {
|
|
McpServerTransportConfig::Stdio { .. } => Ok(McpAuthStatus::Unsupported),
|
|
McpServerTransportConfig::StreamableHttp {
|
|
url,
|
|
bearer_token_env_var,
|
|
http_headers,
|
|
env_http_headers,
|
|
} => {
|
|
determine_streamable_http_auth_status(
|
|
server_name,
|
|
url,
|
|
bearer_token_env_var.as_deref(),
|
|
http_headers.clone(),
|
|
env_http_headers.clone(),
|
|
store_mode,
|
|
)
|
|
.await
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use anyhow::anyhow;
|
|
use pretty_assertions::assert_eq;
|
|
|
|
use super::McpOAuthScopesSource;
|
|
use super::OAuthProviderError;
|
|
use super::ResolvedMcpOAuthScopes;
|
|
use super::resolve_oauth_scopes;
|
|
use super::should_retry_without_scopes;
|
|
|
|
#[test]
|
|
fn resolve_oauth_scopes_prefers_explicit() {
|
|
let resolved = resolve_oauth_scopes(
|
|
Some(vec!["explicit".to_string()]),
|
|
Some(vec!["configured".to_string()]),
|
|
Some(vec!["discovered".to_string()]),
|
|
);
|
|
|
|
assert_eq!(
|
|
resolved,
|
|
ResolvedMcpOAuthScopes {
|
|
scopes: vec!["explicit".to_string()],
|
|
source: McpOAuthScopesSource::Explicit,
|
|
}
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn resolve_oauth_scopes_prefers_configured_over_discovered() {
|
|
let resolved = resolve_oauth_scopes(
|
|
None,
|
|
Some(vec!["configured".to_string()]),
|
|
Some(vec!["discovered".to_string()]),
|
|
);
|
|
|
|
assert_eq!(
|
|
resolved,
|
|
ResolvedMcpOAuthScopes {
|
|
scopes: vec!["configured".to_string()],
|
|
source: McpOAuthScopesSource::Configured,
|
|
}
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn resolve_oauth_scopes_uses_discovered_when_needed() {
|
|
let resolved = resolve_oauth_scopes(None, None, Some(vec!["discovered".to_string()]));
|
|
|
|
assert_eq!(
|
|
resolved,
|
|
ResolvedMcpOAuthScopes {
|
|
scopes: vec!["discovered".to_string()],
|
|
source: McpOAuthScopesSource::Discovered,
|
|
}
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn resolve_oauth_scopes_preserves_explicitly_empty_configured_scopes() {
|
|
let resolved = resolve_oauth_scopes(None, Some(Vec::new()), Some(vec!["ignored".into()]));
|
|
|
|
assert_eq!(
|
|
resolved,
|
|
ResolvedMcpOAuthScopes {
|
|
scopes: Vec::new(),
|
|
source: McpOAuthScopesSource::Configured,
|
|
}
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn resolve_oauth_scopes_falls_back_to_empty() {
|
|
let resolved = resolve_oauth_scopes(None, None, None);
|
|
|
|
assert_eq!(
|
|
resolved,
|
|
ResolvedMcpOAuthScopes {
|
|
scopes: Vec::new(),
|
|
source: McpOAuthScopesSource::Empty,
|
|
}
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn should_retry_without_scopes_only_for_discovered_provider_errors() {
|
|
let discovered = ResolvedMcpOAuthScopes {
|
|
scopes: vec!["scope".to_string()],
|
|
source: McpOAuthScopesSource::Discovered,
|
|
};
|
|
let provider_error = anyhow!(OAuthProviderError::new(
|
|
Some("invalid_scope".to_string()),
|
|
Some("scope rejected".to_string()),
|
|
));
|
|
|
|
assert!(should_retry_without_scopes(&discovered, &provider_error));
|
|
|
|
let configured = ResolvedMcpOAuthScopes {
|
|
scopes: vec!["scope".to_string()],
|
|
source: McpOAuthScopesSource::Configured,
|
|
};
|
|
assert!(!should_retry_without_scopes(&configured, &provider_error));
|
|
assert!(!should_retry_without_scopes(
|
|
&discovered,
|
|
&anyhow!("timed out waiting for OAuth callback"),
|
|
));
|
|
}
|
|
}
|