Files
zed/crates/context_server/src/oauth.rs
T
Jonathon Anderson 19e458b78a context_server: Include requested scopes in OAuth DCR flow (#63370)
# Objective

Fixes https://github.com/zed-industries/zed/issues/63363

The OAuth DCR flow would register an OAuth app with default (unset)
`scope`. This was incompatible with some MCP servers, including GitLab's
Orbit MCP server, which require OAuth scope(s) that are not part of the
default assigned to DCR apps.

## Solution

The OAuth DCR request now registers with the same set of `scope`
selected for the entire flow, matching the authorization prompt used
later. If the server advertises/requests no particular scopes for
authentication, this field is elided to request a default set of scopes
decided by the server.

## Testing

- Successfully logged in via OAuth to the GitLab.com Orbit MCP server
([ref](https://docs.gitlab.com/orbit/remote/access/mcp/#connect-your-mcp-client))
and MCP server
([ref](https://docs.gitlab.com/user/model_context_protocol/mcp_server/#connect-a-client-to-the-gitlab-mcp-server))
on Linux
- Unit tests confirm `scopes` are preserved in the DCR request body

## Self-Review Checklist:

- [x] I've reviewed my own diff for quality, security, and reliability
- [x] Unsafe blocks (if any) have justifying comments
- [x] The content adheres to Zed's UI standards
([UX/UI](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist)
and
[icon](https://github.com/zed-industries/zed/blob/main/crates/icons/README.md)
guidelines)
- [x] Tests cover the new/changed behavior
- [x] Performance impact has been considered and is acceptable

---

Release Notes:

- Fixed OAuth authentication failure with MCP servers that require
non-default scopes to access MCP endpoints

Signed-off-by: Jonathon Anderson <anderson.jonathonm@gmail.com>
2026-08-29 22:33:39 +00:00

2897 lines
104 KiB
Rust

//! OAuth 2.0 authentication for MCP servers using the Authorization Code +
//! PKCE flow, per the MCP spec's OAuth profile.
//!
//! The flow is split into two phases:
//!
//! 1. **Discovery** ([`discover`]) fetches Protected Resource Metadata and
//! Authorization Server Metadata. This can happen early (e.g. on a 401
//! during server startup) because it doesn't need the redirect URI yet.
//!
//! 2. **Client registration** ([`resolve_client_registration`]) is separate
//! because DCR requires the actual loopback redirect URI, which includes an
//! ephemeral port that only exists once the callback server has started.
//!
//! After authentication, the full state is captured in [`OAuthSession`] which
//! is persisted to the keychain. On next startup, the stored session feeds
//! directly into [`McpOAuthTokenProvider`], giving a refresh-capable provider
//! without requiring another browser flow.
use anyhow::{Context as _, Result, anyhow, bail};
use async_trait::async_trait;
use base64::Engine as _;
use futures::AsyncReadExt as _;
use futures::FutureExt as _;
use futures::channel::mpsc;
use futures::future::BoxFuture;
use http_client::{AsyncBody, HttpClient, Request};
use parking_lot::Mutex as SyncMutex;
use rand::Rng as _;
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use std::sync::Arc;
use std::time::{Duration, SystemTime};
use url::Url;
/// The CIMD URL where Zed's OAuth client metadata document is hosted.
pub const CIMD_URL: &str = "https://zed.dev/oauth/client-metadata.json";
/// Validate that a URL is safe to use as an OAuth endpoint.
///
/// OAuth endpoints carry sensitive material (authorization codes, PKCE
/// verifiers, tokens) and must use TLS. Plain HTTP is only permitted for
/// loopback addresses, per RFC 8252 Section 8.3.
fn require_https_or_loopback(url: &Url) -> Result<()> {
if url.scheme() == "https" {
return Ok(());
}
if url.scheme() == "http" {
if let Some(host) = url.host() {
match host {
url::Host::Ipv4(ip) if ip.is_loopback() => return Ok(()),
url::Host::Ipv6(ip) if ip.is_loopback() => return Ok(()),
url::Host::Domain(d) if d.eq_ignore_ascii_case("localhost") => return Ok(()),
_ => {}
}
}
}
bail!(
"OAuth endpoint must use HTTPS (got {}://{})",
url.scheme(),
url.host_str().unwrap_or("?")
)
}
/// Validate that a URL is safe to use as an OAuth endpoint, including SSRF
/// protections against private/reserved IP ranges.
///
/// This wraps [`require_https_or_loopback`] and adds IP-range checks to prevent
/// an attacker-controlled MCP server from directing Zed to fetch internal
/// network resources via metadata URLs.
///
/// **Known limitation:** Domain-name URLs that resolve to private IPs are *not*
/// blocked here — full mitigation requires resolver-level validation (e.g. a
/// custom `Resolve` implementation). This function only blocks IP-literal URLs.
fn validate_oauth_url(url: &Url) -> Result<()> {
require_https_or_loopback(url)?;
if let Some(host) = url.host() {
match host {
url::Host::Ipv4(ip) => {
// Loopback is already allowed by require_https_or_loopback.
if ip.is_private() || ip.is_link_local() || ip.is_broadcast() || ip.is_unspecified()
{
bail!(
"OAuth endpoint must not point to private/reserved IP: {}",
ip
);
}
}
url::Host::Ipv6(ip) => {
// Check for IPv4-mapped IPv6 addresses (::ffff:a.b.c.d) which
// could bypass the IPv4 checks above.
if let Some(mapped_v4) = ip.to_ipv4_mapped() {
if mapped_v4.is_private()
|| mapped_v4.is_link_local()
|| mapped_v4.is_broadcast()
|| mapped_v4.is_unspecified()
{
bail!(
"OAuth endpoint must not point to private/reserved IP: ::ffff:{}",
mapped_v4
);
}
}
if ip.is_unspecified() || ip.is_multicast() {
bail!(
"OAuth endpoint must not point to reserved IPv6 address: {}",
ip
);
}
// IPv6 Unique Local Addresses (fc00::/7). is_unique_local() is
// nightly-only, so check the prefix manually.
if (ip.segments()[0] & 0xfe00) == 0xfc00 {
bail!(
"OAuth endpoint must not point to IPv6 unique-local address: {}",
ip
);
}
}
url::Host::Domain(_) => {
// Domain-based SSRF prevention requires resolver-level checks.
// See known limitation in the doc comment above.
}
}
}
Ok(())
}
/// Parsed from the MCP server's WWW-Authenticate header or well-known endpoint
/// per RFC 9728 (OAuth 2.0 Protected Resource Metadata).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ProtectedResourceMetadata {
pub resource: Url,
pub authorization_servers: Vec<Url>,
pub scopes_supported: Option<Vec<String>>,
}
/// Parsed from the authorization server's .well-known endpoint
/// per RFC 8414 (OAuth 2.0 Authorization Server Metadata).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AuthServerMetadata {
pub issuer: Url,
pub authorization_endpoint: Url,
pub token_endpoint: Url,
pub registration_endpoint: Option<Url>,
pub scopes_supported: Option<Vec<String>>,
pub grant_types_supported: Option<Vec<String>>,
pub code_challenge_methods_supported: Option<Vec<String>>,
pub client_id_metadata_document_supported: bool,
}
/// The result of client registration — either CIMD or DCR.
#[derive(Clone, Serialize, Deserialize)]
pub struct OAuthClientRegistration {
pub client_id: String,
/// Only present for DCR-minted registrations.
pub client_secret: Option<String>,
}
impl std::fmt::Debug for OAuthClientRegistration {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("OAuthClientRegistration")
.field("client_id", &self.client_id)
.field(
"client_secret",
&self.client_secret.as_ref().map(|_| "[redacted]"),
)
.finish()
}
}
/// Access and refresh tokens obtained from the token endpoint.
#[derive(Clone, Serialize, Deserialize)]
pub struct OAuthTokens {
pub access_token: String,
pub refresh_token: Option<String>,
pub expires_at: Option<SystemTime>,
}
impl std::fmt::Debug for OAuthTokens {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("OAuthTokens")
.field("access_token", &"[redacted]")
.field(
"refresh_token",
&self.refresh_token.as_ref().map(|_| "[redacted]"),
)
.field("expires_at", &self.expires_at)
.finish()
}
}
/// Everything discovered before the browser flow starts. Client registration is
/// resolved separately, once the real redirect URI is known.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct OAuthDiscovery {
pub resource_metadata: ProtectedResourceMetadata,
pub auth_server_metadata: AuthServerMetadata,
pub scopes: Vec<String>,
}
/// The persisted OAuth session for a context server.
///
/// Stored in the keychain so startup can restore a refresh-capable provider
/// without another browser flow. Deliberately excludes the full discovery
/// metadata to keep the serialized size well within keychain item limits.
#[derive(Clone, Serialize, Deserialize)]
pub struct OAuthSession {
pub token_endpoint: Url,
pub resource: Url,
pub client_registration: OAuthClientRegistration,
pub tokens: OAuthTokens,
}
impl std::fmt::Debug for OAuthSession {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("OAuthSession")
.field("token_endpoint", &self.token_endpoint)
.field("resource", &self.resource)
.field("client_registration", &self.client_registration)
.field("tokens", &self.tokens)
.finish()
}
}
/// Error codes defined by RFC 6750 Section 3.1 for Bearer token authentication.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum BearerError {
/// The request is missing a required parameter, includes an unsupported
/// parameter or parameter value, or is otherwise malformed.
InvalidRequest,
/// The access token provided is expired, revoked, malformed, or invalid.
InvalidToken,
/// The request requires higher privileges than provided by the access token.
InsufficientScope,
/// An unrecognized error code (extension or future spec addition).
Other,
}
impl BearerError {
fn parse(value: &str) -> Self {
match value {
"invalid_request" => BearerError::InvalidRequest,
"invalid_token" => BearerError::InvalidToken,
"insufficient_scope" => BearerError::InsufficientScope,
_ => BearerError::Other,
}
}
}
/// Fields extracted from a `WWW-Authenticate: Bearer` header.
///
/// Per RFC 9728 Section 5.1, MCP servers include `resource_metadata` to point
/// at the Protected Resource Metadata document. The optional `scope` parameter
/// (RFC 6750 Section 3) indicates scopes required for the request.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WwwAuthenticate {
pub resource_metadata: Option<Url>,
pub scope: Option<Vec<String>>,
/// The parsed `error` parameter per RFC 6750 Section 3.1.
pub error: Option<BearerError>,
pub error_description: Option<String>,
}
/// Parse a `WWW-Authenticate` header value.
///
/// Expects the `Bearer` scheme followed by comma-separated `key="value"` pairs.
/// Per RFC 6750 and RFC 9728, the relevant parameters are:
/// - `resource_metadata` — URL of the Protected Resource Metadata document
/// - `scope` — space-separated list of required scopes
/// - `error` — error code (e.g. "insufficient_scope")
/// - `error_description` — human-readable error description
pub fn parse_www_authenticate(header: &str) -> Result<WwwAuthenticate> {
let header = header.trim();
let params_str = if header.len() >= 6 && header[..6].eq_ignore_ascii_case("bearer") {
header[6..].trim()
} else {
bail!("WWW-Authenticate header does not use Bearer scheme");
};
if params_str.is_empty() {
return Ok(WwwAuthenticate {
resource_metadata: None,
scope: None,
error: None,
error_description: None,
});
}
let params = parse_auth_params(params_str);
let resource_metadata = params
.get("resource_metadata")
.map(|v| Url::parse(v))
.transpose()
.map_err(|e| anyhow!("invalid resource_metadata URL: {}", e))?;
let scope = params
.get("scope")
.map(|v| v.split_whitespace().map(String::from).collect());
let error = params.get("error").map(|v| BearerError::parse(v));
let error_description = params.get("error_description").cloned();
Ok(WwwAuthenticate {
resource_metadata,
scope,
error,
error_description,
})
}
/// Parse comma-separated `key="value"` or `key=token` parameters from an
/// auth-param list (RFC 7235 Section 2.1).
fn parse_auth_params(input: &str) -> collections::HashMap<String, String> {
let mut params = collections::HashMap::default();
let mut remaining = input.trim();
while !remaining.is_empty() {
// Skip leading whitespace and commas.
remaining = remaining.trim_start_matches(|c: char| c == ',' || c.is_whitespace());
if remaining.is_empty() {
break;
}
// Find the key (everything before '=').
let eq_pos = match remaining.find('=') {
Some(pos) => pos,
None => break,
};
let key = remaining[..eq_pos].trim().to_lowercase();
remaining = &remaining[eq_pos + 1..];
remaining = remaining.trim_start();
// Parse the value: either quoted or unquoted (token).
let value;
if remaining.starts_with('"') {
// Quoted string: find the closing quote, handling escaped chars.
remaining = &remaining[1..]; // skip opening quote
let mut val = String::new();
let mut chars = remaining.char_indices();
loop {
match chars.next() {
Some((_, '\\')) => {
// Escaped character — take the next char literally.
if let Some((_, c)) = chars.next() {
val.push(c);
}
}
Some((i, '"')) => {
remaining = &remaining[i + 1..];
break;
}
Some((_, c)) => val.push(c),
None => {
remaining = "";
break;
}
}
}
value = val;
} else {
// Unquoted token: read until comma or whitespace.
let end = remaining
.find(|c: char| c == ',' || c.is_whitespace())
.unwrap_or(remaining.len());
value = remaining[..end].to_string();
remaining = &remaining[end..];
}
if !key.is_empty() {
params.insert(key, value);
}
}
params
}
/// Construct the well-known Protected Resource Metadata URIs for a given MCP
/// server URL, per RFC 9728 Section 3.
///
/// Returns URIs in priority order:
/// 1. Path-specific: `https://<host>/.well-known/oauth-protected-resource/<path>`
/// 2. Root: `https://<host>/.well-known/oauth-protected-resource`
pub fn protected_resource_metadata_urls(server_url: &Url) -> Vec<Url> {
let mut urls = Vec::new();
let base = format!("{}://{}", server_url.scheme(), server_url.authority());
let path = server_url.path().trim_start_matches('/');
if !path.is_empty() {
if let Ok(url) = Url::parse(&format!(
"{}/.well-known/oauth-protected-resource/{}",
base, path
)) {
urls.push(url);
}
}
if let Ok(url) = Url::parse(&format!("{}/.well-known/oauth-protected-resource", base)) {
urls.push(url);
}
urls
}
/// Construct the well-known Authorization Server Metadata URIs for a given
/// issuer URL, per RFC 8414 Section 3.1 and Section 5 (OIDC compat).
///
/// Returns URIs in priority order, which differs depending on whether the
/// issuer URL has a path component.
pub fn auth_server_metadata_urls(issuer: &Url) -> Vec<Url> {
let mut urls = Vec::new();
let base = format!("{}://{}", issuer.scheme(), issuer.authority());
let path = issuer.path().trim_matches('/');
if !path.is_empty() {
// Issuer with path: try path-inserted variants first.
if let Ok(url) = Url::parse(&format!(
"{}/.well-known/oauth-authorization-server/{}",
base, path
)) {
urls.push(url);
}
if let Ok(url) = Url::parse(&format!(
"{}/.well-known/openid-configuration/{}",
base, path
)) {
urls.push(url);
}
if let Ok(url) = Url::parse(&format!(
"{}/{}/.well-known/openid-configuration",
base, path
)) {
urls.push(url);
}
} else {
// No path: standard well-known locations.
if let Ok(url) = Url::parse(&format!("{}/.well-known/oauth-authorization-server", base)) {
urls.push(url);
}
if let Ok(url) = Url::parse(&format!("{}/.well-known/openid-configuration", base)) {
urls.push(url);
}
}
urls
}
// -- Canonical server URI (RFC 8707) -----------------------------------------
/// Derive the canonical resource URI for an MCP server URL, suitable for the
/// `resource` parameter in authorization and token requests per RFC 8707.
///
/// Lowercases the scheme and host, preserves the path (without trailing slash),
/// strips fragments and query strings.
pub fn canonical_server_uri(server_url: &Url) -> String {
let mut uri = format!(
"{}://{}",
server_url.scheme().to_ascii_lowercase(),
server_url.host_str().unwrap_or("").to_ascii_lowercase(),
);
if let Some(port) = server_url.port() {
uri.push_str(&format!(":{}", port));
}
let path = server_url.path();
if path != "/" {
uri.push_str(path.trim_end_matches('/'));
}
uri
}
// -- Scope selection ---------------------------------------------------------
/// Select scopes following the MCP spec's Scope Selection Strategy:
/// 1. Use `scope` from the `WWW-Authenticate` challenge if present.
/// 2. Fall back to `scopes_supported` from Protected Resource Metadata.
/// 3. Return empty if neither is available.
pub fn select_scopes(
www_authenticate: &WwwAuthenticate,
resource_metadata: &ProtectedResourceMetadata,
) -> Vec<String> {
if let Some(ref scopes) = www_authenticate.scope {
if !scopes.is_empty() {
return scopes.clone();
}
}
resource_metadata
.scopes_supported
.clone()
.unwrap_or_default()
}
// -- Client registration strategy --------------------------------------------
/// The registration approach to use, determined from auth server metadata.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum ClientRegistrationStrategy {
/// The auth server supports CIMD. Use the CIMD URL as client_id directly.
Cimd { client_id: String },
/// The auth server has a registration endpoint. Caller must POST to it.
Dcr { registration_endpoint: Url },
/// No supported registration mechanism.
Unavailable,
}
/// Determine how to register with the authorization server, following the
/// spec's recommended priority: CIMD first, DCR fallback.
pub fn determine_registration_strategy(
auth_server_metadata: &AuthServerMetadata,
) -> ClientRegistrationStrategy {
if auth_server_metadata.client_id_metadata_document_supported {
ClientRegistrationStrategy::Cimd {
client_id: CIMD_URL.to_string(),
}
} else if let Some(ref endpoint) = auth_server_metadata.registration_endpoint {
ClientRegistrationStrategy::Dcr {
registration_endpoint: endpoint.clone(),
}
} else {
ClientRegistrationStrategy::Unavailable
}
}
// -- PKCE (RFC 7636) ---------------------------------------------------------
/// A PKCE code verifier and its S256 challenge.
#[derive(Clone)]
pub struct PkceChallenge {
pub verifier: String,
pub challenge: String,
}
impl std::fmt::Debug for PkceChallenge {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("PkceChallenge")
.field("verifier", &"[redacted]")
.field("challenge", &self.challenge)
.finish()
}
}
/// Generate a PKCE code verifier and S256 challenge per RFC 7636.
///
/// The verifier is 43 base64url characters derived from 32 random bytes.
/// The challenge is `BASE64URL(SHA256(verifier))`.
pub fn generate_pkce_challenge() -> PkceChallenge {
let mut random_bytes = [0u8; 32];
rand::rng().fill(&mut random_bytes);
let engine = base64::engine::general_purpose::URL_SAFE_NO_PAD;
let verifier = engine.encode(&random_bytes);
let digest = Sha256::digest(verifier.as_bytes());
let challenge = engine.encode(digest);
PkceChallenge {
verifier,
challenge,
}
}
// -- Authorization URL construction ------------------------------------------
/// Build the authorization URL for the OAuth Authorization Code + PKCE flow.
pub fn build_authorization_url(
auth_server_metadata: &AuthServerMetadata,
client_id: &str,
redirect_uri: &str,
scopes: &[String],
resource: &str,
pkce: &PkceChallenge,
state: &str,
) -> Url {
let mut url = auth_server_metadata.authorization_endpoint.clone();
{
let mut query = url.query_pairs_mut();
query.append_pair("response_type", "code");
query.append_pair("client_id", client_id);
query.append_pair("redirect_uri", redirect_uri);
if !scopes.is_empty() {
query.append_pair("scope", &scopes.join(" "));
}
query.append_pair("resource", resource);
query.append_pair("code_challenge", &pkce.challenge);
query.append_pair("code_challenge_method", "S256");
query.append_pair("state", state);
}
url
}
// -- Token endpoint request bodies -------------------------------------------
/// The JSON body returned by the token endpoint on success.
#[derive(Deserialize)]
pub struct TokenResponse {
pub access_token: String,
#[serde(default)]
pub refresh_token: Option<String>,
#[serde(default)]
pub expires_in: Option<u64>,
#[serde(default)]
pub token_type: Option<String>,
}
impl std::fmt::Debug for TokenResponse {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("TokenResponse")
.field("access_token", &"[redacted]")
.field(
"refresh_token",
&self.refresh_token.as_ref().map(|_| "[redacted]"),
)
.field("expires_in", &self.expires_in)
.field("token_type", &self.token_type)
.finish()
}
}
impl TokenResponse {
/// Convert into `OAuthTokens`, computing `expires_at` from `expires_in`.
pub fn into_tokens(self) -> OAuthTokens {
let expires_at = self
.expires_in
.map(|secs| SystemTime::now() + Duration::from_secs(secs));
OAuthTokens {
access_token: self.access_token,
refresh_token: self.refresh_token,
expires_at,
}
}
}
/// An OAuth token error response (RFC 6749 Section 5.2).
#[derive(Debug, Deserialize, PartialEq)]
pub struct OAuthTokenError {
pub error: String,
#[serde(default)]
pub error_description: Option<String>,
}
impl std::fmt::Display for OAuthTokenError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "OAuth token error: {}", self.error)?;
if let Some(description) = &self.error_description {
write!(f, " ({description})")?;
}
Ok(())
}
}
impl std::error::Error for OAuthTokenError {}
/// Build the form-encoded body for an authorization code token exchange.
pub fn token_exchange_params(
code: &str,
client_id: &str,
redirect_uri: &str,
code_verifier: &str,
resource: &str,
client_secret: Option<&str>,
) -> Vec<(&'static str, String)> {
let mut params = vec![
("grant_type", "authorization_code".to_string()),
("code", code.to_string()),
("redirect_uri", redirect_uri.to_string()),
("client_id", client_id.to_string()),
("code_verifier", code_verifier.to_string()),
("resource", resource.to_string()),
];
if let Some(secret) = client_secret {
params.push(("client_secret", secret.to_string()));
}
params
}
/// Build the form-encoded body for a token refresh request.
pub fn token_refresh_params(
refresh_token: &str,
client_id: &str,
resource: &str,
client_secret: Option<&str>,
) -> Vec<(&'static str, String)> {
let mut params = vec![
("grant_type", "refresh_token".to_string()),
("refresh_token", refresh_token.to_string()),
("client_id", client_id.to_string()),
("resource", resource.to_string()),
];
if let Some(secret) = client_secret {
params.push(("client_secret", secret.to_string()));
}
params
}
// -- DCR request body (RFC 7591) ---------------------------------------------
/// Build the JSON body for a Dynamic Client Registration request.
///
/// The `redirect_uri` should be the actual loopback URI with the ephemeral
/// port (e.g. `http://127.0.0.1:12345/callback`). Some auth servers do strict
/// redirect URI matching even for loopback addresses, so we register the
/// exact URI we intend to use.
/// The grant types Zed can use. Intersected with the server's
/// `grant_types_supported` to build the DCR request.
const SUPPORTED_GRANT_TYPES: &[&str] = &["authorization_code", "refresh_token"];
pub fn dcr_registration_body(
redirect_uri: &str,
server_grant_types: Option<&[String]>,
scopes: &[String],
) -> serde_json::Value {
// Use the intersection of what we support and what the server advertises.
// When the server doesn't advertise grant_types_supported, send all of
// ours — the server will reject what it doesn't like.
let grant_types: Vec<&str> = match server_grant_types {
Some(server) => SUPPORTED_GRANT_TYPES
.iter()
.copied()
.filter(|gt| server.iter().any(|s| s == *gt))
.collect(),
None => SUPPORTED_GRANT_TYPES.to_vec(),
};
let mut body = serde_json::json!({
"client_name": "Zed",
"redirect_uris": [redirect_uri],
"grant_types": grant_types,
"response_types": ["code"],
"token_endpoint_auth_method": "none"
});
// Use the scopes the server requests or advertises for this registration.
// When the server doesn't request/advertise any scopes on the initial challenge,
// leave the field out so the server selects a default set of scopes to include.
if !scopes.is_empty() {
body["scope"] = serde_json::Value::String(scopes.join(" "));
}
body
}
// -- Discovery (async, hits real endpoints) ----------------------------------
/// Fetch Protected Resource Metadata from the MCP server.
///
/// Tries the `resource_metadata` URL from the `WWW-Authenticate` header first,
/// then falls back to well-known URIs constructed from `server_url`.
pub async fn fetch_protected_resource_metadata(
http_client: &Arc<dyn HttpClient>,
server_url: &Url,
www_authenticate: &WwwAuthenticate,
) -> Result<ProtectedResourceMetadata> {
let candidate_urls = match &www_authenticate.resource_metadata {
Some(url) if url.origin() == server_url.origin() => {
// Try the header-provided URL first (per MCP spec: "use the resource
// metadata URL from the parsed WWW-Authenticate headers when present"),
// then fall back to RFC 9728 well-known URIs in case the header URL is
// wrong (e.g. a buggy server that doubles the path component).
let mut urls = vec![url.clone()];
for fallback in protected_resource_metadata_urls(server_url) {
if !urls.contains(&fallback) {
urls.push(fallback);
}
}
urls
}
Some(url) => {
log::warn!(
"Ignoring cross-origin resource_metadata URL {} \
(server origin: {})",
url,
server_url.origin().unicode_serialization()
);
protected_resource_metadata_urls(server_url)
}
None => protected_resource_metadata_urls(server_url),
};
for url in &candidate_urls {
match fetch_json::<ProtectedResourceMetadataResponse>(http_client, url).await {
Ok(response) => {
if response.authorization_servers.is_empty() {
bail!(
"Protected Resource Metadata at {} has no authorization_servers",
url
);
}
return Ok(ProtectedResourceMetadata {
resource: response.resource.unwrap_or_else(|| server_url.clone()),
authorization_servers: response.authorization_servers,
scopes_supported: response.scopes_supported,
});
}
Err(err) => {
log::debug!(
"Failed to fetch Protected Resource Metadata from {}: {}",
url,
err
);
}
}
}
bail!(
"Could not fetch Protected Resource Metadata for {}",
server_url
)
}
/// Fetch Authorization Server Metadata, trying RFC 8414 and OIDC Discovery
/// endpoints in the priority order specified by the MCP spec.
pub async fn fetch_auth_server_metadata(
http_client: &Arc<dyn HttpClient>,
issuer: &Url,
) -> Result<AuthServerMetadata> {
let candidate_urls = auth_server_metadata_urls(issuer);
for url in &candidate_urls {
match fetch_json::<AuthServerMetadataResponse>(http_client, url).await {
Ok(response) => {
let reported_issuer = response.issuer.unwrap_or_else(|| issuer.clone());
if reported_issuer != *issuer {
bail!(
"Auth server metadata issuer mismatch: expected {}, got {}",
issuer,
reported_issuer
);
}
return Ok(AuthServerMetadata {
issuer: reported_issuer,
grant_types_supported: response.grant_types_supported,
authorization_endpoint: response
.authorization_endpoint
.ok_or_else(|| anyhow!("missing authorization_endpoint"))?,
token_endpoint: response
.token_endpoint
.ok_or_else(|| anyhow!("missing token_endpoint"))?,
registration_endpoint: response.registration_endpoint,
scopes_supported: response.scopes_supported,
code_challenge_methods_supported: response.code_challenge_methods_supported,
client_id_metadata_document_supported: response
.client_id_metadata_document_supported
.unwrap_or(false),
});
}
Err(err) => {
log::debug!("Failed to fetch Auth Server Metadata from {}: {}", url, err);
}
}
}
bail!(
"Could not fetch Authorization Server Metadata for {}",
issuer
)
}
/// Run the full discovery flow: fetch resource metadata, then auth server
/// metadata, then select scopes. Client registration is resolved separately,
/// once the real redirect URI is known.
pub async fn discover(
http_client: &Arc<dyn HttpClient>,
server_url: &Url,
www_authenticate: &WwwAuthenticate,
) -> Result<OAuthDiscovery> {
let resource_metadata =
fetch_protected_resource_metadata(http_client, server_url, www_authenticate).await?;
let auth_server_url = resource_metadata
.authorization_servers
.first()
.ok_or_else(|| anyhow!("no authorization servers in resource metadata"))?;
let auth_server_metadata = fetch_auth_server_metadata(http_client, auth_server_url).await?;
// Verify PKCE S256 support (spec requirement).
match &auth_server_metadata.code_challenge_methods_supported {
Some(methods) if methods.iter().any(|m| m == "S256") => {}
Some(_) => bail!("authorization server does not support S256 PKCE"),
None => bail!("authorization server does not advertise code_challenge_methods_supported"),
}
let scopes = select_scopes(www_authenticate, &resource_metadata);
Ok(OAuthDiscovery {
resource_metadata,
auth_server_metadata,
scopes,
})
}
/// Resolve the OAuth client registration for an authorization flow.
///
/// CIMD uses the static client metadata document directly. For DCR, a fresh
/// registration is performed each time because the loopback redirect URI
/// includes an ephemeral port that changes every flow.
pub async fn resolve_client_registration(
http_client: &Arc<dyn HttpClient>,
discovery: &OAuthDiscovery,
redirect_uri: &str,
) -> Result<OAuthClientRegistration> {
match determine_registration_strategy(&discovery.auth_server_metadata) {
ClientRegistrationStrategy::Cimd { client_id } => Ok(OAuthClientRegistration {
client_id,
client_secret: None,
}),
ClientRegistrationStrategy::Dcr {
registration_endpoint,
} => {
perform_dcr(
http_client,
&registration_endpoint,
redirect_uri,
discovery
.auth_server_metadata
.grant_types_supported
.as_deref(),
&discovery.scopes,
)
.await
}
ClientRegistrationStrategy::Unavailable => {
bail!("authorization server supports neither CIMD nor DCR")
}
}
}
// -- Dynamic Client Registration (RFC 7591) ----------------------------------
/// Perform Dynamic Client Registration with the authorization server.
pub async fn perform_dcr(
http_client: &Arc<dyn HttpClient>,
registration_endpoint: &Url,
redirect_uri: &str,
server_grant_types: Option<&[String]>,
scopes: &[String],
) -> Result<OAuthClientRegistration> {
validate_oauth_url(registration_endpoint)?;
let body = dcr_registration_body(redirect_uri, server_grant_types, scopes);
let body_bytes = serde_json::to_vec(&body)?;
let request = Request::builder()
.method(http_client::http::Method::POST)
.uri(registration_endpoint.as_str())
.header("Content-Type", "application/json")
.header("Accept", "application/json")
.body(AsyncBody::from(body_bytes))?;
let mut response = http_client.send(request).await?;
if !response.status().is_success() {
let mut error_body = String::new();
response.body_mut().read_to_string(&mut error_body).await?;
bail!(
"DCR failed with status {}: {}",
response.status(),
error_body
);
}
let mut response_body = String::new();
response
.body_mut()
.read_to_string(&mut response_body)
.await?;
let dcr_response: DcrResponse =
serde_json::from_str(&response_body).context("failed to parse DCR response")?;
Ok(OAuthClientRegistration {
client_id: dcr_response.client_id,
client_secret: dcr_response.client_secret,
})
}
// -- Token exchange and refresh (async) --------------------------------------
/// Exchange an authorization code for tokens at the token endpoint.
pub async fn exchange_code(
http_client: &Arc<dyn HttpClient>,
auth_server_metadata: &AuthServerMetadata,
code: &str,
client_id: &str,
redirect_uri: &str,
code_verifier: &str,
resource: &str,
client_secret: Option<&str>,
) -> Result<OAuthTokens> {
let params = token_exchange_params(
code,
client_id,
redirect_uri,
code_verifier,
resource,
client_secret,
);
post_token_request(http_client, &auth_server_metadata.token_endpoint, &params).await
}
/// Refresh tokens using a refresh token.
pub async fn refresh_tokens(
http_client: &Arc<dyn HttpClient>,
token_endpoint: &Url,
refresh_token: &str,
client_id: &str,
resource: &str,
client_secret: Option<&str>,
) -> Result<OAuthTokens> {
let params = token_refresh_params(refresh_token, client_id, resource, client_secret);
post_token_request(http_client, token_endpoint, &params).await
}
/// POST form-encoded parameters to a token endpoint and parse the response.
async fn post_token_request(
http_client: &Arc<dyn HttpClient>,
token_endpoint: &Url,
params: &[(&str, String)],
) -> Result<OAuthTokens> {
validate_oauth_url(token_endpoint)?;
let body = url::form_urlencoded::Serializer::new(String::new())
.extend_pairs(params.iter().map(|(k, v)| (*k, v.as_str())))
.finish();
let request = Request::builder()
.method(http_client::http::Method::POST)
.uri(token_endpoint.as_str())
.header("Content-Type", "application/x-www-form-urlencoded")
.header("Accept", "application/json")
.body(AsyncBody::from(body.into_bytes()))?;
let mut response = http_client.send(request).await?;
if !response.status().is_success() {
let mut error_body = String::new();
response.body_mut().read_to_string(&mut error_body).await?;
let status = response.status();
// Try to parse as an OAuth error response (RFC 6749 Section 5.2).
if let Ok(token_error) = serde_json::from_str::<OAuthTokenError>(&error_body) {
return Err(token_error.into());
}
bail!("token request failed with status {status}: {error_body}");
}
let mut response_body = String::new();
response
.body_mut()
.read_to_string(&mut response_body)
.await?;
let token_response: TokenResponse =
serde_json::from_str(&response_body).context("failed to parse token response")?;
Ok(token_response.into_tokens())
}
// -- Loopback HTTP callback server -------------------------------------------
/// An OAuth authorization callback received via the loopback HTTP server.
pub struct OAuthCallback {
pub code: String,
pub state: String,
}
impl std::fmt::Debug for OAuthCallback {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("OAuthCallback")
.field("code", &"[redacted]")
.field("state", &"[redacted]")
.finish()
}
}
impl OAuthCallback {
/// Parse the query string from a callback URL like
/// `http://127.0.0.1:<port>/callback?code=...&state=...`.
pub fn parse_query(query: &str) -> Result<Self> {
let params = oauth_callback_server::OAuthCallbackParams::parse_query(query)?;
Ok(Self {
code: params.code,
state: params.state,
})
}
}
/// Start a loopback HTTP server to receive the OAuth authorization callback.
///
/// Binds to an ephemeral loopback port for each flow.
///
/// Returns `(redirect_uri, callback_future)`. The caller should use the
/// redirect URI in the authorization request, open the browser, then await
/// the future to receive the callback.
///
/// The server accepts exactly one request on `/callback`, validates that it
/// contains `code` and `state` query parameters, responds with a minimal
/// HTML page telling the user they can close the tab, and shuts down.
///
/// The callback server shuts down when the returned future is dropped (e.g.
/// because the authentication task was cancelled), or after a timeout.
pub fn start_callback_server() -> Result<(String, BoxFuture<'static, Result<OAuthCallback>>)> {
let (redirect_uri, rx) = oauth_callback_server::start_oauth_callback_server()?;
let future = async move {
match rx.await {
Ok(Ok(params)) => Ok(OAuthCallback {
code: params.code,
state: params.state,
}),
Ok(Err(e)) => Err(e),
Err(_) => Err(anyhow!(
"OAuth callback server was shut down before receiving a response"
)),
}
}
.boxed();
Ok((redirect_uri, future))
}
// -- JSON fetch helper -------------------------------------------------------
async fn fetch_json<T: serde::de::DeserializeOwned>(
http_client: &Arc<dyn HttpClient>,
url: &Url,
) -> Result<T> {
validate_oauth_url(url)?;
let request = Request::builder()
.method(http_client::http::Method::GET)
.uri(url.as_str())
.header("Accept", "application/json")
.body(AsyncBody::default())?;
let mut response = http_client.send(request).await?;
if !response.status().is_success() {
bail!("HTTP {} fetching {}", response.status(), url);
}
let mut body = String::new();
response.body_mut().read_to_string(&mut body).await?;
serde_json::from_str(&body).with_context(|| format!("failed to parse JSON from {}", url))
}
// -- Serde response types for discovery --------------------------------------
#[derive(Debug, Deserialize)]
struct ProtectedResourceMetadataResponse {
#[serde(default)]
resource: Option<Url>,
#[serde(default)]
authorization_servers: Vec<Url>,
#[serde(default)]
scopes_supported: Option<Vec<String>>,
}
#[derive(Debug, Deserialize)]
struct AuthServerMetadataResponse {
#[serde(default)]
issuer: Option<Url>,
#[serde(default)]
authorization_endpoint: Option<Url>,
#[serde(default)]
token_endpoint: Option<Url>,
#[serde(default)]
registration_endpoint: Option<Url>,
#[serde(default)]
scopes_supported: Option<Vec<String>>,
#[serde(default)]
grant_types_supported: Option<Vec<String>>,
#[serde(default)]
code_challenge_methods_supported: Option<Vec<String>>,
#[serde(default)]
client_id_metadata_document_supported: Option<bool>,
}
#[derive(Debug, Deserialize)]
struct DcrResponse {
client_id: String,
#[serde(default)]
client_secret: Option<String>,
}
/// Provides OAuth tokens to the HTTP transport layer.
///
/// The transport calls `access_token()` before each request. On a 401 response
/// it calls `try_refresh()` and retries once if the refresh succeeds.
#[async_trait]
pub trait OAuthTokenProvider: Send + Sync {
/// Returns the current access token, if one is available.
fn access_token(&self) -> Option<String>;
/// Attempts to refresh the access token. Returns `true` if a new token was
/// obtained and the request should be retried.
async fn try_refresh(&self) -> Result<bool>;
}
/// Concrete `OAuthTokenProvider` backed by a full persisted OAuth session and
/// an HTTP client for token refresh. The same provider type is used both after
/// an interactive authentication flow and when restoring a saved session from
/// the keychain on startup.
pub struct McpOAuthTokenProvider {
session: SyncMutex<OAuthSession>,
http_client: Arc<dyn HttpClient>,
token_refresh_tx: Option<mpsc::UnboundedSender<OAuthSession>>,
}
impl McpOAuthTokenProvider {
pub fn new(
session: OAuthSession,
http_client: Arc<dyn HttpClient>,
token_refresh_tx: Option<mpsc::UnboundedSender<OAuthSession>>,
) -> Self {
Self {
session: SyncMutex::new(session),
http_client,
token_refresh_tx,
}
}
fn access_token_is_expired(tokens: &OAuthTokens) -> bool {
tokens.expires_at.is_some_and(|expires_at| {
SystemTime::now()
.checked_add(Duration::from_secs(30))
.is_some_and(|now_with_buffer| expires_at <= now_with_buffer)
})
}
}
#[async_trait]
impl OAuthTokenProvider for McpOAuthTokenProvider {
fn access_token(&self) -> Option<String> {
let session = self.session.lock();
if Self::access_token_is_expired(&session.tokens) {
return None;
}
Some(session.tokens.access_token.clone())
}
async fn try_refresh(&self) -> Result<bool> {
let (refresh_token, token_endpoint, resource, client_id, client_secret) = {
let session = self.session.lock();
match session.tokens.refresh_token.clone() {
Some(refresh_token) => (
refresh_token,
session.token_endpoint.clone(),
session.resource.clone(),
session.client_registration.client_id.clone(),
session.client_registration.client_secret.clone(),
),
None => return Ok(false),
}
};
let resource_str = canonical_server_uri(&resource);
match refresh_tokens(
&self.http_client,
&token_endpoint,
&refresh_token,
&client_id,
&resource_str,
client_secret.as_deref(),
)
.await
{
Ok(mut new_tokens) => {
if new_tokens.refresh_token.is_none() {
new_tokens.refresh_token = Some(refresh_token);
}
{
let mut session = self.session.lock();
session.tokens = new_tokens;
if let Some(ref tx) = self.token_refresh_tx {
tx.unbounded_send(session.clone()).ok();
}
}
Ok(true)
}
Err(err) => {
log::warn!("OAuth token refresh failed: {}", err);
Ok(false)
}
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use http_client::Response;
// -- require_https_or_loopback tests ------------------------------------
#[test]
fn test_require_https_or_loopback_accepts_https() {
let url = Url::parse("https://auth.example.com/token").unwrap();
assert!(require_https_or_loopback(&url).is_ok());
}
#[test]
fn test_require_https_or_loopback_rejects_http_remote() {
let url = Url::parse("http://auth.example.com/token").unwrap();
assert!(require_https_or_loopback(&url).is_err());
}
#[test]
fn test_require_https_or_loopback_accepts_http_127_0_0_1() {
let url = Url::parse("http://127.0.0.1:8080/callback").unwrap();
assert!(require_https_or_loopback(&url).is_ok());
}
#[test]
fn test_require_https_or_loopback_accepts_http_ipv6_loopback() {
let url = Url::parse("http://[::1]:8080/callback").unwrap();
assert!(require_https_or_loopback(&url).is_ok());
}
#[test]
fn test_require_https_or_loopback_accepts_http_localhost() {
let url = Url::parse("http://localhost:8080/callback").unwrap();
assert!(require_https_or_loopback(&url).is_ok());
}
#[test]
fn test_require_https_or_loopback_accepts_http_localhost_case_insensitive() {
let url = Url::parse("http://LOCALHOST:8080/callback").unwrap();
assert!(require_https_or_loopback(&url).is_ok());
}
#[test]
fn test_require_https_or_loopback_rejects_http_non_loopback_ip() {
let url = Url::parse("http://192.168.1.1:8080/token").unwrap();
assert!(require_https_or_loopback(&url).is_err());
}
#[test]
fn test_require_https_or_loopback_rejects_ftp() {
let url = Url::parse("ftp://auth.example.com/token").unwrap();
assert!(require_https_or_loopback(&url).is_err());
}
// -- validate_oauth_url (SSRF) tests ------------------------------------
#[test]
fn test_validate_oauth_url_accepts_https_public() {
let url = Url::parse("https://auth.example.com/token").unwrap();
assert!(validate_oauth_url(&url).is_ok());
}
#[test]
fn test_validate_oauth_url_rejects_private_ipv4_10() {
let url = Url::parse("https://10.0.0.1/token").unwrap();
assert!(validate_oauth_url(&url).is_err());
}
#[test]
fn test_validate_oauth_url_rejects_private_ipv4_172() {
let url = Url::parse("https://172.16.0.1/token").unwrap();
assert!(validate_oauth_url(&url).is_err());
}
#[test]
fn test_validate_oauth_url_rejects_private_ipv4_192() {
let url = Url::parse("https://192.168.1.1/token").unwrap();
assert!(validate_oauth_url(&url).is_err());
}
#[test]
fn test_validate_oauth_url_rejects_link_local() {
let url = Url::parse("https://169.254.169.254/latest/meta-data/").unwrap();
assert!(validate_oauth_url(&url).is_err());
}
#[test]
fn test_validate_oauth_url_rejects_ipv6_ula() {
let url = Url::parse("https://[fd12:3456:789a::1]/token").unwrap();
assert!(validate_oauth_url(&url).is_err());
}
#[test]
fn test_validate_oauth_url_rejects_ipv6_unspecified() {
let url = Url::parse("https://[::]/token").unwrap();
assert!(validate_oauth_url(&url).is_err());
}
#[test]
fn test_validate_oauth_url_rejects_ipv4_mapped_ipv6_private() {
let url = Url::parse("https://[::ffff:10.0.0.1]/token").unwrap();
assert!(validate_oauth_url(&url).is_err());
}
#[test]
fn test_validate_oauth_url_rejects_ipv4_mapped_ipv6_link_local() {
let url = Url::parse("https://[::ffff:169.254.169.254]/token").unwrap();
assert!(validate_oauth_url(&url).is_err());
}
#[test]
fn test_validate_oauth_url_allows_http_loopback() {
// Loopback is permitted (it's our callback server).
let url = Url::parse("http://127.0.0.1:8080/callback").unwrap();
assert!(validate_oauth_url(&url).is_ok());
}
#[test]
fn test_validate_oauth_url_allows_https_public_ip() {
let url = Url::parse("https://93.184.216.34/token").unwrap();
assert!(validate_oauth_url(&url).is_ok());
}
// -- parse_www_authenticate tests ----------------------------------------
#[test]
fn test_parse_www_authenticate_with_resource_metadata_and_scope() {
let header = r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource", scope="files:read user:profile""#;
let result = parse_www_authenticate(header).unwrap();
assert_eq!(
result.resource_metadata.as_ref().map(|u| u.as_str()),
Some("https://mcp.example.com/.well-known/oauth-protected-resource")
);
assert_eq!(
result.scope,
Some(vec!["files:read".to_string(), "user:profile".to_string()])
);
assert_eq!(result.error, None);
}
#[test]
fn test_parse_www_authenticate_resource_metadata_only() {
let header = r#"Bearer resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource""#;
let result = parse_www_authenticate(header).unwrap();
assert_eq!(
result.resource_metadata.as_ref().map(|u| u.as_str()),
Some("https://mcp.example.com/.well-known/oauth-protected-resource")
);
assert_eq!(result.scope, None);
}
#[test]
fn test_parse_www_authenticate_bare_bearer() {
let result = parse_www_authenticate("Bearer").unwrap();
assert_eq!(result.resource_metadata, None);
assert_eq!(result.scope, None);
}
#[test]
fn test_parse_www_authenticate_with_error() {
let header = r#"Bearer error="insufficient_scope", scope="files:read files:write", resource_metadata="https://mcp.example.com/.well-known/oauth-protected-resource", error_description="Additional file write permission required""#;
let result = parse_www_authenticate(header).unwrap();
assert_eq!(result.error, Some(BearerError::InsufficientScope));
assert_eq!(
result.error_description.as_deref(),
Some("Additional file write permission required")
);
assert_eq!(
result.scope,
Some(vec!["files:read".to_string(), "files:write".to_string()])
);
assert!(result.resource_metadata.is_some());
}
#[test]
fn test_parse_www_authenticate_invalid_token_error() {
let header =
r#"Bearer error="invalid_token", error_description="The access token expired""#;
let result = parse_www_authenticate(header).unwrap();
assert_eq!(result.error, Some(BearerError::InvalidToken));
}
#[test]
fn test_parse_www_authenticate_invalid_request_error() {
let header = r#"Bearer error="invalid_request""#;
let result = parse_www_authenticate(header).unwrap();
assert_eq!(result.error, Some(BearerError::InvalidRequest));
}
#[test]
fn test_parse_www_authenticate_unknown_error() {
let header = r#"Bearer error="some_future_error""#;
let result = parse_www_authenticate(header).unwrap();
assert_eq!(result.error, Some(BearerError::Other));
}
#[test]
fn test_parse_www_authenticate_rejects_non_bearer() {
let result = parse_www_authenticate("Basic realm=\"example\"");
assert!(result.is_err());
}
#[test]
fn test_parse_www_authenticate_case_insensitive_scheme() {
let header = r#"bearer resource_metadata="https://example.com/.well-known/oauth-protected-resource""#;
let result = parse_www_authenticate(header).unwrap();
assert!(result.resource_metadata.is_some());
}
#[test]
fn test_parse_www_authenticate_multiline_style() {
// Some servers emit the header spread across multiple lines joined by
// whitespace, as shown in the spec examples.
let header = "Bearer resource_metadata=\"https://mcp.example.com/.well-known/oauth-protected-resource\",\n scope=\"files:read\"";
let result = parse_www_authenticate(header).unwrap();
assert!(result.resource_metadata.is_some());
assert_eq!(result.scope, Some(vec!["files:read".to_string()]));
}
#[test]
fn test_protected_resource_metadata_urls_with_path() {
let server_url = Url::parse("https://api.example.com/v1/mcp").unwrap();
let urls = protected_resource_metadata_urls(&server_url);
assert_eq!(urls.len(), 2);
assert_eq!(
urls[0].as_str(),
"https://api.example.com/.well-known/oauth-protected-resource/v1/mcp"
);
assert_eq!(
urls[1].as_str(),
"https://api.example.com/.well-known/oauth-protected-resource"
);
}
#[test]
fn test_protected_resource_metadata_urls_without_path() {
let server_url = Url::parse("https://mcp.example.com").unwrap();
let urls = protected_resource_metadata_urls(&server_url);
assert_eq!(urls.len(), 1);
assert_eq!(
urls[0].as_str(),
"https://mcp.example.com/.well-known/oauth-protected-resource"
);
}
#[test]
fn test_auth_server_metadata_urls_with_path() {
let issuer = Url::parse("https://auth.example.com/tenant1").unwrap();
let urls = auth_server_metadata_urls(&issuer);
assert_eq!(urls.len(), 3);
assert_eq!(
urls[0].as_str(),
"https://auth.example.com/.well-known/oauth-authorization-server/tenant1"
);
assert_eq!(
urls[1].as_str(),
"https://auth.example.com/.well-known/openid-configuration/tenant1"
);
assert_eq!(
urls[2].as_str(),
"https://auth.example.com/tenant1/.well-known/openid-configuration"
);
}
#[test]
fn test_auth_server_metadata_urls_without_path() {
let issuer = Url::parse("https://auth.example.com").unwrap();
let urls = auth_server_metadata_urls(&issuer);
assert_eq!(urls.len(), 2);
assert_eq!(
urls[0].as_str(),
"https://auth.example.com/.well-known/oauth-authorization-server"
);
assert_eq!(
urls[1].as_str(),
"https://auth.example.com/.well-known/openid-configuration"
);
}
// -- Canonical server URI tests ------------------------------------------
#[test]
fn test_canonical_server_uri_simple() {
let url = Url::parse("https://mcp.example.com").unwrap();
assert_eq!(canonical_server_uri(&url), "https://mcp.example.com");
}
#[test]
fn test_canonical_server_uri_with_path() {
let url = Url::parse("https://mcp.example.com/v1/mcp").unwrap();
assert_eq!(canonical_server_uri(&url), "https://mcp.example.com/v1/mcp");
}
#[test]
fn test_canonical_server_uri_strips_trailing_slash() {
let url = Url::parse("https://mcp.example.com/").unwrap();
assert_eq!(canonical_server_uri(&url), "https://mcp.example.com");
}
#[test]
fn test_canonical_server_uri_preserves_port() {
let url = Url::parse("https://mcp.example.com:8443").unwrap();
assert_eq!(canonical_server_uri(&url), "https://mcp.example.com:8443");
}
#[test]
fn test_canonical_server_uri_lowercases() {
let url = Url::parse("HTTPS://MCP.Example.COM/Server/MCP").unwrap();
assert_eq!(
canonical_server_uri(&url),
"https://mcp.example.com/Server/MCP"
);
}
// -- Scope selection tests -----------------------------------------------
#[test]
fn test_select_scopes_prefers_www_authenticate() {
let www_auth = WwwAuthenticate {
resource_metadata: None,
scope: Some(vec!["files:read".into()]),
error: None,
error_description: None,
};
let resource_meta = ProtectedResourceMetadata {
resource: Url::parse("https://example.com").unwrap(),
authorization_servers: vec![],
scopes_supported: Some(vec!["files:read".into(), "files:write".into()]),
};
assert_eq!(select_scopes(&www_auth, &resource_meta), vec!["files:read"]);
}
#[test]
fn test_select_scopes_falls_back_to_resource_metadata() {
let www_auth = WwwAuthenticate {
resource_metadata: None,
scope: None,
error: None,
error_description: None,
};
let resource_meta = ProtectedResourceMetadata {
resource: Url::parse("https://example.com").unwrap(),
authorization_servers: vec![],
scopes_supported: Some(vec!["admin".into()]),
};
assert_eq!(select_scopes(&www_auth, &resource_meta), vec!["admin"]);
}
#[test]
fn test_select_scopes_empty_when_nothing_available() {
let www_auth = WwwAuthenticate {
resource_metadata: None,
scope: None,
error: None,
error_description: None,
};
let resource_meta = ProtectedResourceMetadata {
resource: Url::parse("https://example.com").unwrap(),
authorization_servers: vec![],
scopes_supported: None,
};
assert!(select_scopes(&www_auth, &resource_meta).is_empty());
}
// -- Client registration strategy tests ----------------------------------
#[test]
fn test_registration_strategy_prefers_cimd() {
let metadata = AuthServerMetadata {
issuer: Url::parse("https://auth.example.com").unwrap(),
authorization_endpoint: Url::parse("https://auth.example.com/authorize").unwrap(),
token_endpoint: Url::parse("https://auth.example.com/token").unwrap(),
registration_endpoint: Some(Url::parse("https://auth.example.com/register").unwrap()),
scopes_supported: None,
code_challenge_methods_supported: Some(vec!["S256".into()]),
client_id_metadata_document_supported: true,
grant_types_supported: None,
};
assert_eq!(
determine_registration_strategy(&metadata),
ClientRegistrationStrategy::Cimd {
client_id: CIMD_URL.to_string(),
}
);
}
#[test]
fn test_registration_strategy_falls_back_to_dcr() {
let reg_endpoint = Url::parse("https://auth.example.com/register").unwrap();
let metadata = AuthServerMetadata {
issuer: Url::parse("https://auth.example.com").unwrap(),
authorization_endpoint: Url::parse("https://auth.example.com/authorize").unwrap(),
token_endpoint: Url::parse("https://auth.example.com/token").unwrap(),
registration_endpoint: Some(reg_endpoint.clone()),
scopes_supported: None,
code_challenge_methods_supported: Some(vec!["S256".into()]),
client_id_metadata_document_supported: false,
grant_types_supported: None,
};
assert_eq!(
determine_registration_strategy(&metadata),
ClientRegistrationStrategy::Dcr {
registration_endpoint: reg_endpoint,
}
);
}
#[test]
fn test_registration_strategy_unavailable() {
let metadata = AuthServerMetadata {
issuer: Url::parse("https://auth.example.com").unwrap(),
authorization_endpoint: Url::parse("https://auth.example.com/authorize").unwrap(),
token_endpoint: Url::parse("https://auth.example.com/token").unwrap(),
registration_endpoint: None,
scopes_supported: None,
code_challenge_methods_supported: Some(vec!["S256".into()]),
client_id_metadata_document_supported: false,
grant_types_supported: None,
};
assert_eq!(
determine_registration_strategy(&metadata),
ClientRegistrationStrategy::Unavailable,
);
}
// -- PKCE tests ----------------------------------------------------------
#[test]
fn test_pkce_challenge_verifier_length() {
let pkce = generate_pkce_challenge();
// 32 random bytes → 43 base64url chars (no padding).
assert_eq!(pkce.verifier.len(), 43);
}
#[test]
fn test_pkce_challenge_is_valid_base64url() {
let pkce = generate_pkce_challenge();
for c in pkce.verifier.chars().chain(pkce.challenge.chars()) {
assert!(
c.is_ascii_alphanumeric() || c == '-' || c == '_',
"invalid base64url character: {}",
c
);
}
}
#[test]
fn test_pkce_challenge_is_s256_of_verifier() {
let pkce = generate_pkce_challenge();
let engine = base64::engine::general_purpose::URL_SAFE_NO_PAD;
let expected_digest = Sha256::digest(pkce.verifier.as_bytes());
let expected_challenge = engine.encode(expected_digest);
assert_eq!(pkce.challenge, expected_challenge);
}
#[test]
fn test_pkce_challenges_are_unique() {
let a = generate_pkce_challenge();
let b = generate_pkce_challenge();
assert_ne!(a.verifier, b.verifier);
}
// -- Authorization URL tests ---------------------------------------------
#[test]
fn test_build_authorization_url() {
let metadata = AuthServerMetadata {
issuer: Url::parse("https://auth.example.com").unwrap(),
authorization_endpoint: Url::parse("https://auth.example.com/authorize").unwrap(),
token_endpoint: Url::parse("https://auth.example.com/token").unwrap(),
registration_endpoint: None,
scopes_supported: None,
code_challenge_methods_supported: Some(vec!["S256".into()]),
client_id_metadata_document_supported: true,
grant_types_supported: None,
};
let pkce = PkceChallenge {
verifier: "test_verifier".into(),
challenge: "test_challenge".into(),
};
let url = build_authorization_url(
&metadata,
"https://zed.dev/oauth/client-metadata.json",
"http://127.0.0.1:12345/callback",
&["files:read".into(), "files:write".into()],
"https://mcp.example.com",
&pkce,
"random_state_123",
);
let pairs: std::collections::HashMap<_, _> = url.query_pairs().collect();
assert_eq!(pairs.get("response_type").unwrap(), "code");
assert_eq!(
pairs.get("client_id").unwrap(),
"https://zed.dev/oauth/client-metadata.json"
);
assert_eq!(
pairs.get("redirect_uri").unwrap(),
"http://127.0.0.1:12345/callback"
);
assert_eq!(pairs.get("scope").unwrap(), "files:read files:write");
assert_eq!(pairs.get("resource").unwrap(), "https://mcp.example.com");
assert_eq!(pairs.get("code_challenge").unwrap(), "test_challenge");
assert_eq!(pairs.get("code_challenge_method").unwrap(), "S256");
assert_eq!(pairs.get("state").unwrap(), "random_state_123");
}
#[test]
fn test_build_authorization_url_omits_empty_scope() {
let metadata = AuthServerMetadata {
issuer: Url::parse("https://auth.example.com").unwrap(),
authorization_endpoint: Url::parse("https://auth.example.com/authorize").unwrap(),
token_endpoint: Url::parse("https://auth.example.com/token").unwrap(),
registration_endpoint: None,
scopes_supported: None,
code_challenge_methods_supported: Some(vec!["S256".into()]),
client_id_metadata_document_supported: false,
grant_types_supported: None,
};
let pkce = PkceChallenge {
verifier: "v".into(),
challenge: "c".into(),
};
let url = build_authorization_url(
&metadata,
"client_123",
"http://127.0.0.1:9999/callback",
&[],
"https://mcp.example.com",
&pkce,
"state",
);
let pairs: std::collections::HashMap<_, _> = url.query_pairs().collect();
assert!(!pairs.contains_key("scope"));
}
// -- Token exchange / refresh param tests --------------------------------
#[test]
fn test_token_exchange_params() {
let params = token_exchange_params(
"auth_code_abc",
"client_xyz",
"http://127.0.0.1:5555/callback",
"verifier_123",
"https://mcp.example.com",
None,
);
let map: std::collections::HashMap<&str, &str> =
params.iter().map(|(k, v)| (*k, v.as_str())).collect();
assert_eq!(map["grant_type"], "authorization_code");
assert_eq!(map["code"], "auth_code_abc");
assert_eq!(map["redirect_uri"], "http://127.0.0.1:5555/callback");
assert_eq!(map["client_id"], "client_xyz");
assert_eq!(map["code_verifier"], "verifier_123");
assert_eq!(map["resource"], "https://mcp.example.com");
}
#[test]
fn test_token_refresh_params() {
let params = token_refresh_params(
"refresh_token_abc",
"client_xyz",
"https://mcp.example.com",
None,
);
let map: std::collections::HashMap<&str, &str> =
params.iter().map(|(k, v)| (*k, v.as_str())).collect();
assert_eq!(map["grant_type"], "refresh_token");
assert_eq!(map["refresh_token"], "refresh_token_abc");
assert_eq!(map["client_id"], "client_xyz");
assert_eq!(map["resource"], "https://mcp.example.com");
}
// -- Token response tests ------------------------------------------------
#[test]
fn test_token_response_into_tokens_with_expiry() {
let response: TokenResponse = serde_json::from_str(
r#"{"access_token": "at_123", "refresh_token": "rt_456", "expires_in": 3600, "token_type": "Bearer"}"#,
)
.unwrap();
let tokens = response.into_tokens();
assert_eq!(tokens.access_token, "at_123");
assert_eq!(tokens.refresh_token.as_deref(), Some("rt_456"));
assert!(tokens.expires_at.is_some());
}
#[test]
fn test_token_response_into_tokens_minimal() {
let response: TokenResponse =
serde_json::from_str(r#"{"access_token": "at_789"}"#).unwrap();
let tokens = response.into_tokens();
assert_eq!(tokens.access_token, "at_789");
assert_eq!(tokens.refresh_token, None);
assert_eq!(tokens.expires_at, None);
}
// -- DCR body test -------------------------------------------------------
#[test]
fn test_dcr_registration_body_without_server_metadata() {
// When server metadata is unavailable, include all supported grant types.
let body = dcr_registration_body("http://127.0.0.1:12345/callback", None, &[]);
assert_eq!(body["client_name"], "Zed");
assert_eq!(body["redirect_uris"][0], "http://127.0.0.1:12345/callback");
assert_eq!(body["grant_types"][0], "authorization_code");
assert_eq!(body["grant_types"][1], "refresh_token");
assert_eq!(body["response_types"][0], "code");
assert_eq!(body["token_endpoint_auth_method"], "none");
assert!(body.get("scope").is_none());
}
#[test]
fn test_dcr_registration_body_mirrors_server_grant_types() {
// When the server only supports authorization_code, omit refresh_token.
let server_types = vec!["authorization_code".to_string()];
let body =
dcr_registration_body("http://127.0.0.1:12345/callback", Some(&server_types), &[]);
assert_eq!(body["grant_types"][0], "authorization_code");
assert!(body["grant_types"].as_array().unwrap().len() == 1);
// When the server supports both, include both.
let server_types = vec![
"authorization_code".to_string(),
"refresh_token".to_string(),
];
let body =
dcr_registration_body("http://127.0.0.1:12345/callback", Some(&server_types), &[]);
assert_eq!(body["grant_types"][0], "authorization_code");
assert_eq!(body["grant_types"][1], "refresh_token");
}
#[test]
fn test_dcr_registration_body_mirrors_server_scopes() {
// When the server requests certain scopes, include those in the request
let scopes = vec!["mcp".to_string(), "read_api".to_string()];
let body = dcr_registration_body("http://127.0.0.1:12345/callback", None, &scopes);
assert_eq!(body["scope"], "mcp read_api");
}
// -- Test helpers for async/HTTP tests -----------------------------------
fn make_fake_http_client(
handler: impl Fn(
http_client::Request<AsyncBody>,
) -> std::pin::Pin<
Box<dyn std::future::Future<Output = anyhow::Result<Response<AsyncBody>>> + Send>,
> + Send
+ Sync
+ 'static,
) -> Arc<dyn HttpClient> {
http_client::FakeHttpClient::create(handler) as Arc<dyn HttpClient>
}
fn json_response(status: u16, body: &str) -> anyhow::Result<Response<AsyncBody>> {
Ok(Response::builder()
.status(status)
.header("Content-Type", "application/json")
.body(AsyncBody::from(body.as_bytes().to_vec()))
.unwrap())
}
// -- Discovery integration tests -----------------------------------------
#[test]
fn test_fetch_protected_resource_metadata() {
gpui::block_on(async {
let client = make_fake_http_client(|req| {
Box::pin(async move {
let uri = req.uri().to_string();
if uri.contains(".well-known/oauth-protected-resource") {
json_response(
200,
r#"{
"resource": "https://mcp.example.com",
"authorization_servers": ["https://auth.example.com"],
"scopes_supported": ["read", "write"]
}"#,
)
} else {
json_response(404, "{}")
}
})
});
let server_url = Url::parse("https://mcp.example.com").unwrap();
let www_auth = WwwAuthenticate {
resource_metadata: None,
scope: None,
error: None,
error_description: None,
};
let metadata = fetch_protected_resource_metadata(&client, &server_url, &www_auth)
.await
.unwrap();
assert_eq!(metadata.resource.as_str(), "https://mcp.example.com/");
assert_eq!(metadata.authorization_servers.len(), 1);
assert_eq!(
metadata.authorization_servers[0].as_str(),
"https://auth.example.com/"
);
assert_eq!(
metadata.scopes_supported,
Some(vec!["read".to_string(), "write".to_string()])
);
});
}
#[test]
fn test_fetch_protected_resource_metadata_prefers_www_authenticate_url() {
gpui::block_on(async {
let client = make_fake_http_client(|req| {
Box::pin(async move {
let uri = req.uri().to_string();
if uri == "https://mcp.example.com/custom-resource-metadata" {
json_response(
200,
r#"{
"resource": "https://mcp.example.com",
"authorization_servers": ["https://auth.example.com"]
}"#,
)
} else {
json_response(500, r#"{"error": "should not be called"}"#)
}
})
});
let server_url = Url::parse("https://mcp.example.com").unwrap();
let www_auth = WwwAuthenticate {
resource_metadata: Some(
Url::parse("https://mcp.example.com/custom-resource-metadata").unwrap(),
),
scope: None,
error: None,
error_description: None,
};
let metadata = fetch_protected_resource_metadata(&client, &server_url, &www_auth)
.await
.unwrap();
assert_eq!(metadata.authorization_servers.len(), 1);
});
}
#[test]
fn test_fetch_protected_resource_metadata_falls_back_when_header_url_fails() {
// Reproduces the Pydantic Logfire case: the server's WWW-Authenticate
// header contains a resource_metadata URL with a doubled path (e.g.
// /mcp/mcp), which returns HTML instead of JSON. The client should
// fall back to the RFC 9728 well-known URL, which works correctly.
gpui::block_on(async {
let client = make_fake_http_client(|req| {
Box::pin(async move {
let uri = req.uri().to_string();
if uri
== "https://mcp.example.com/.well-known/oauth-protected-resource/api/mcp/mcp"
{
// Buggy header URL returns HTML (like a SPA catch-all).
Ok(Response::builder()
.status(200)
.header("Content-Type", "text/html")
.body(AsyncBody::from(b"<!doctype html><html></html>".to_vec()))
.unwrap())
} else if uri
== "https://mcp.example.com/.well-known/oauth-protected-resource/api/mcp"
{
// Correct well-known URL returns valid metadata.
json_response(
200,
r#"{
"resource": "https://mcp.example.com/api/mcp",
"authorization_servers": ["https://auth.example.com"]
}"#,
)
} else {
json_response(404, "{}")
}
})
});
let server_url = Url::parse("https://mcp.example.com/api/mcp").unwrap();
let www_auth = WwwAuthenticate {
resource_metadata: Some(
// Buggy URL with doubled path component.
Url::parse(
"https://mcp.example.com/.well-known/oauth-protected-resource/api/mcp/mcp",
)
.unwrap(),
),
scope: None,
error: None,
error_description: None,
};
let metadata = fetch_protected_resource_metadata(&client, &server_url, &www_auth)
.await
.unwrap();
assert_eq!(
metadata.resource.as_str(),
"https://mcp.example.com/api/mcp"
);
assert_eq!(
metadata.authorization_servers[0].as_str(),
"https://auth.example.com/"
);
});
}
#[test]
fn test_fetch_protected_resource_metadata_rejects_cross_origin_url() {
gpui::block_on(async {
let client = make_fake_http_client(|req| {
Box::pin(async move {
let uri = req.uri().to_string();
// The cross-origin URL should NOT be fetched; only the
// well-known fallback at the server's own origin should be.
if uri.contains("attacker.example.com") {
panic!("should not fetch cross-origin resource_metadata URL");
} else if uri.contains(".well-known/oauth-protected-resource") {
json_response(
200,
r#"{
"resource": "https://mcp.example.com",
"authorization_servers": ["https://auth.example.com"]
}"#,
)
} else {
json_response(404, "{}")
}
})
});
let server_url = Url::parse("https://mcp.example.com").unwrap();
let www_auth = WwwAuthenticate {
resource_metadata: Some(
Url::parse("https://attacker.example.com/fake-metadata").unwrap(),
),
scope: None,
error: None,
error_description: None,
};
let metadata = fetch_protected_resource_metadata(&client, &server_url, &www_auth)
.await
.unwrap();
// Should have used the fallback well-known URL, not the attacker's.
assert_eq!(metadata.resource.as_str(), "https://mcp.example.com/");
});
}
#[test]
fn test_fetch_auth_server_metadata() {
gpui::block_on(async {
let client = make_fake_http_client(|req| {
Box::pin(async move {
let uri = req.uri().to_string();
if uri.contains(".well-known/oauth-authorization-server") {
json_response(
200,
r#"{
"issuer": "https://auth.example.com",
"authorization_endpoint": "https://auth.example.com/authorize",
"token_endpoint": "https://auth.example.com/token",
"registration_endpoint": "https://auth.example.com/register",
"code_challenge_methods_supported": ["S256"],
"client_id_metadata_document_supported": true
}"#,
)
} else {
json_response(404, "{}")
}
})
});
let issuer = Url::parse("https://auth.example.com").unwrap();
let metadata = fetch_auth_server_metadata(&client, &issuer).await.unwrap();
assert_eq!(metadata.issuer.as_str(), "https://auth.example.com/");
assert_eq!(
metadata.authorization_endpoint.as_str(),
"https://auth.example.com/authorize"
);
assert_eq!(
metadata.token_endpoint.as_str(),
"https://auth.example.com/token"
);
assert!(metadata.registration_endpoint.is_some());
assert!(metadata.client_id_metadata_document_supported);
assert_eq!(
metadata.code_challenge_methods_supported,
Some(vec!["S256".to_string()])
);
});
}
#[test]
fn test_fetch_auth_server_metadata_falls_back_to_oidc() {
gpui::block_on(async {
let client = make_fake_http_client(|req| {
Box::pin(async move {
let uri = req.uri().to_string();
if uri.contains("openid-configuration") {
json_response(
200,
r#"{
"issuer": "https://auth.example.com",
"authorization_endpoint": "https://auth.example.com/authorize",
"token_endpoint": "https://auth.example.com/token",
"code_challenge_methods_supported": ["S256"]
}"#,
)
} else {
json_response(404, "{}")
}
})
});
let issuer = Url::parse("https://auth.example.com").unwrap();
let metadata = fetch_auth_server_metadata(&client, &issuer).await.unwrap();
assert_eq!(
metadata.authorization_endpoint.as_str(),
"https://auth.example.com/authorize"
);
assert!(!metadata.client_id_metadata_document_supported);
});
}
#[test]
fn test_fetch_auth_server_metadata_rejects_issuer_mismatch() {
gpui::block_on(async {
let client = make_fake_http_client(|req| {
Box::pin(async move {
let uri = req.uri().to_string();
if uri.contains(".well-known/oauth-authorization-server") {
// Response claims to be a different issuer.
json_response(
200,
r#"{
"issuer": "https://evil.example.com",
"authorization_endpoint": "https://evil.example.com/authorize",
"token_endpoint": "https://evil.example.com/token",
"code_challenge_methods_supported": ["S256"]
}"#,
)
} else {
json_response(404, "{}")
}
})
});
let issuer = Url::parse("https://auth.example.com").unwrap();
let result = fetch_auth_server_metadata(&client, &issuer).await;
assert!(result.is_err());
let err_msg = result.unwrap_err().to_string();
assert!(
err_msg.contains("issuer mismatch"),
"unexpected error: {}",
err_msg
);
});
}
// -- Full discover integration tests -------------------------------------
#[test]
fn test_full_discover_with_cimd() {
gpui::block_on(async {
let client = make_fake_http_client(|req| {
Box::pin(async move {
let uri = req.uri().to_string();
if uri.contains("oauth-protected-resource") {
json_response(
200,
r#"{
"resource": "https://mcp.example.com",
"authorization_servers": ["https://auth.example.com"],
"scopes_supported": ["mcp:read"]
}"#,
)
} else if uri.contains("oauth-authorization-server") {
json_response(
200,
r#"{
"issuer": "https://auth.example.com",
"authorization_endpoint": "https://auth.example.com/authorize",
"token_endpoint": "https://auth.example.com/token",
"code_challenge_methods_supported": ["S256"],
"client_id_metadata_document_supported": true
}"#,
)
} else {
json_response(404, "{}")
}
})
});
let server_url = Url::parse("https://mcp.example.com").unwrap();
let www_auth = WwwAuthenticate {
resource_metadata: None,
scope: None,
error: None,
error_description: None,
};
let discovery = discover(&client, &server_url, &www_auth).await.unwrap();
let registration =
resolve_client_registration(&client, &discovery, "http://127.0.0.1:12345/callback")
.await
.unwrap();
assert_eq!(registration.client_id, CIMD_URL);
assert_eq!(registration.client_secret, None);
assert_eq!(discovery.scopes, vec!["mcp:read"]);
});
}
#[test]
fn test_full_discover_with_dcr_fallback() {
gpui::block_on(async {
let client = make_fake_http_client(|req| {
Box::pin(async move {
let uri = req.uri().to_string();
if uri.contains("oauth-protected-resource") {
json_response(
200,
r#"{
"resource": "https://mcp.example.com",
"authorization_servers": ["https://auth.example.com"]
}"#,
)
} else if uri.contains("oauth-authorization-server") {
json_response(
200,
r#"{
"issuer": "https://auth.example.com",
"authorization_endpoint": "https://auth.example.com/authorize",
"token_endpoint": "https://auth.example.com/token",
"registration_endpoint": "https://auth.example.com/register",
"code_challenge_methods_supported": ["S256"],
"client_id_metadata_document_supported": false
}"#,
)
} else if uri.contains("/register") {
json_response(
201,
r#"{
"client_id": "dcr-minted-id-123",
"client_secret": "dcr-secret-456"
}"#,
)
} else {
json_response(404, "{}")
}
})
});
let server_url = Url::parse("https://mcp.example.com").unwrap();
let www_auth = WwwAuthenticate {
resource_metadata: None,
scope: Some(vec!["files:read".into()]),
error: None,
error_description: None,
};
let discovery = discover(&client, &server_url, &www_auth).await.unwrap();
let registration =
resolve_client_registration(&client, &discovery, "http://127.0.0.1:9999/callback")
.await
.unwrap();
assert_eq!(registration.client_id, "dcr-minted-id-123");
assert_eq!(
registration.client_secret.as_deref(),
Some("dcr-secret-456")
);
assert_eq!(discovery.scopes, vec!["files:read"]);
});
}
#[test]
fn test_discover_fails_without_pkce_support() {
gpui::block_on(async {
let client = make_fake_http_client(|req| {
Box::pin(async move {
let uri = req.uri().to_string();
if uri.contains("oauth-protected-resource") {
json_response(
200,
r#"{
"resource": "https://mcp.example.com",
"authorization_servers": ["https://auth.example.com"]
}"#,
)
} else if uri.contains("oauth-authorization-server") {
json_response(
200,
r#"{
"issuer": "https://auth.example.com",
"authorization_endpoint": "https://auth.example.com/authorize",
"token_endpoint": "https://auth.example.com/token"
}"#,
)
} else {
json_response(404, "{}")
}
})
});
let server_url = Url::parse("https://mcp.example.com").unwrap();
let www_auth = WwwAuthenticate {
resource_metadata: None,
scope: None,
error: None,
error_description: None,
};
let result = discover(&client, &server_url, &www_auth).await;
assert!(result.is_err());
let err_msg = result.unwrap_err().to_string();
assert!(
err_msg.contains("code_challenge_methods_supported"),
"unexpected error: {}",
err_msg
);
});
}
// -- Token exchange integration tests ------------------------------------
#[test]
fn test_exchange_code_success() {
gpui::block_on(async {
let client = make_fake_http_client(|req| {
Box::pin(async move {
let uri = req.uri().to_string();
if uri.contains("/token") {
json_response(
200,
r#"{
"access_token": "new_access_token",
"refresh_token": "new_refresh_token",
"expires_in": 3600,
"token_type": "Bearer"
}"#,
)
} else {
json_response(404, "{}")
}
})
});
let metadata = AuthServerMetadata {
issuer: Url::parse("https://auth.example.com").unwrap(),
authorization_endpoint: Url::parse("https://auth.example.com/authorize").unwrap(),
token_endpoint: Url::parse("https://auth.example.com/token").unwrap(),
registration_endpoint: None,
scopes_supported: None,
code_challenge_methods_supported: Some(vec!["S256".into()]),
client_id_metadata_document_supported: true,
grant_types_supported: None,
};
let tokens = exchange_code(
&client,
&metadata,
"auth_code_123",
CIMD_URL,
"http://127.0.0.1:9999/callback",
"verifier_abc",
"https://mcp.example.com",
None,
)
.await
.unwrap();
assert_eq!(tokens.access_token, "new_access_token");
assert_eq!(tokens.refresh_token.as_deref(), Some("new_refresh_token"));
assert!(tokens.expires_at.is_some());
});
}
#[test]
fn test_refresh_tokens_success() {
gpui::block_on(async {
let client = make_fake_http_client(|req| {
Box::pin(async move {
let uri = req.uri().to_string();
if uri.contains("/token") {
json_response(
200,
r#"{
"access_token": "refreshed_token",
"expires_in": 1800,
"token_type": "Bearer"
}"#,
)
} else {
json_response(404, "{}")
}
})
});
let token_endpoint = Url::parse("https://auth.example.com/token").unwrap();
let tokens = refresh_tokens(
&client,
&token_endpoint,
"old_refresh_token",
CIMD_URL,
"https://mcp.example.com",
None,
)
.await
.unwrap();
assert_eq!(tokens.access_token, "refreshed_token");
assert_eq!(tokens.refresh_token, None);
assert!(tokens.expires_at.is_some());
});
}
#[test]
fn test_exchange_code_failure() {
gpui::block_on(async {
let client = make_fake_http_client(|_req| {
Box::pin(async move { json_response(400, r#"{"error": "invalid_grant"}"#) })
});
let metadata = AuthServerMetadata {
issuer: Url::parse("https://auth.example.com").unwrap(),
authorization_endpoint: Url::parse("https://auth.example.com/authorize").unwrap(),
token_endpoint: Url::parse("https://auth.example.com/token").unwrap(),
registration_endpoint: None,
scopes_supported: None,
code_challenge_methods_supported: Some(vec!["S256".into()]),
client_id_metadata_document_supported: true,
grant_types_supported: None,
};
let result = exchange_code(
&client,
&metadata,
"bad_code",
"client",
"http://127.0.0.1:1/callback",
"verifier",
"https://mcp.example.com",
None,
)
.await;
let err = result.unwrap_err();
let token_error = err
.downcast_ref::<OAuthTokenError>()
.expect("expected OAuthTokenError");
assert_eq!(
*token_error,
OAuthTokenError {
error: "invalid_grant".into(),
error_description: None,
}
);
});
}
// -- DCR integration tests -----------------------------------------------
#[test]
fn test_perform_dcr() {
gpui::block_on(async {
let client = make_fake_http_client(|_req| {
Box::pin(async move {
json_response(
201,
r#"{
"client_id": "dynamic-client-001",
"client_secret": "dynamic-secret-001"
}"#,
)
})
});
let endpoint = Url::parse("https://auth.example.com/register").unwrap();
let registration = perform_dcr(
&client,
&endpoint,
"http://127.0.0.1:9999/callback",
None,
&[],
)
.await
.unwrap();
assert_eq!(registration.client_id, "dynamic-client-001");
assert_eq!(
registration.client_secret.as_deref(),
Some("dynamic-secret-001")
);
});
}
#[test]
fn test_perform_dcr_failure() {
gpui::block_on(async {
let client = make_fake_http_client(|_req| {
Box::pin(
async move { json_response(403, r#"{"error": "registration_not_allowed"}"#) },
)
});
let endpoint = Url::parse("https://auth.example.com/register").unwrap();
let result = perform_dcr(
&client,
&endpoint,
"http://127.0.0.1:9999/callback",
None,
&[],
)
.await;
assert!(result.is_err());
assert!(result.unwrap_err().to_string().contains("403"));
});
}
// -- OAuthCallback parse tests -------------------------------------------
#[test]
fn test_oauth_callback_parse_query() {
let callback = OAuthCallback::parse_query("code=test_auth_code&state=test_state").unwrap();
assert_eq!(callback.code, "test_auth_code");
assert_eq!(callback.state, "test_state");
}
#[test]
fn test_oauth_callback_parse_query_reversed_order() {
let callback = OAuthCallback::parse_query("state=test_state&code=test_auth_code").unwrap();
assert_eq!(callback.code, "test_auth_code");
assert_eq!(callback.state, "test_state");
}
#[test]
fn test_oauth_callback_parse_query_with_extra_params() {
let callback =
OAuthCallback::parse_query("code=test_auth_code&state=test_state&extra=ignored")
.unwrap();
assert_eq!(callback.code, "test_auth_code");
assert_eq!(callback.state, "test_state");
}
#[test]
fn test_oauth_callback_parse_query_missing_code() {
let result = OAuthCallback::parse_query("state=test_state");
assert!(result.is_err());
assert!(result.unwrap_err().to_string().contains("code"));
}
#[test]
fn test_oauth_callback_parse_query_missing_state() {
let result = OAuthCallback::parse_query("code=test_auth_code");
assert!(result.is_err());
assert!(result.unwrap_err().to_string().contains("state"));
}
#[test]
fn test_oauth_callback_parse_query_empty_code() {
let result = OAuthCallback::parse_query("code=&state=test_state");
assert!(result.is_err());
}
#[test]
fn test_oauth_callback_parse_query_empty_state() {
let result = OAuthCallback::parse_query("code=test_auth_code&state=");
assert!(result.is_err());
}
#[test]
fn test_oauth_callback_parse_query_url_encoded_values() {
let callback = OAuthCallback::parse_query("code=abc%20def&state=test%3Dstate").unwrap();
assert_eq!(callback.code, "abc def");
assert_eq!(callback.state, "test=state");
}
#[test]
fn test_oauth_callback_parse_query_error_response() {
let result = OAuthCallback::parse_query(
"error=access_denied&error_description=User%20denied%20access&state=abc",
);
assert!(result.is_err());
let err_msg = result.unwrap_err().to_string();
assert!(
err_msg.contains("access_denied"),
"unexpected error: {}",
err_msg
);
assert!(
err_msg.contains("User denied access"),
"unexpected error: {}",
err_msg
);
}
#[test]
fn test_oauth_callback_parse_query_error_without_description() {
let result = OAuthCallback::parse_query("error=server_error&state=abc");
assert!(result.is_err());
let err_msg = result.unwrap_err().to_string();
assert!(
err_msg.contains("server_error"),
"unexpected error: {}",
err_msg
);
assert!(
err_msg.contains("no description"),
"unexpected error: {}",
err_msg
);
}
// -- McpOAuthTokenProvider tests -----------------------------------------
fn make_test_session(
access_token: &str,
refresh_token: Option<&str>,
expires_at: Option<SystemTime>,
) -> OAuthSession {
OAuthSession {
token_endpoint: Url::parse("https://auth.example.com/token").unwrap(),
resource: Url::parse("https://mcp.example.com").unwrap(),
client_registration: OAuthClientRegistration {
client_id: "test-client".into(),
client_secret: None,
},
tokens: OAuthTokens {
access_token: access_token.into(),
refresh_token: refresh_token.map(String::from),
expires_at,
},
}
}
#[test]
fn test_mcp_oauth_provider_returns_none_when_token_expired() {
let expired = SystemTime::now() - Duration::from_secs(60);
let session = make_test_session("stale-token", Some("rt"), Some(expired));
let provider = McpOAuthTokenProvider::new(
session,
make_fake_http_client(|_| Box::pin(async { unreachable!() })),
None,
);
assert_eq!(provider.access_token(), None);
}
#[test]
fn test_mcp_oauth_provider_returns_token_when_not_expired() {
let far_future = SystemTime::now() + Duration::from_secs(3600);
let session = make_test_session("valid-token", Some("rt"), Some(far_future));
let provider = McpOAuthTokenProvider::new(
session,
make_fake_http_client(|_| Box::pin(async { unreachable!() })),
None,
);
assert_eq!(provider.access_token().as_deref(), Some("valid-token"));
}
#[test]
fn test_mcp_oauth_provider_returns_token_when_no_expiry() {
let session = make_test_session("no-expiry-token", Some("rt"), None);
let provider = McpOAuthTokenProvider::new(
session,
make_fake_http_client(|_| Box::pin(async { unreachable!() })),
None,
);
assert_eq!(provider.access_token().as_deref(), Some("no-expiry-token"));
}
#[test]
fn test_mcp_oauth_provider_refresh_without_refresh_token_returns_false() {
gpui::block_on(async {
let session = make_test_session("token", None, None);
let provider = McpOAuthTokenProvider::new(
session,
make_fake_http_client(|_| {
Box::pin(async { unreachable!("no HTTP call expected") })
}),
None,
);
let refreshed = provider.try_refresh().await.unwrap();
assert!(!refreshed);
});
}
#[test]
fn test_mcp_oauth_provider_refresh_updates_session_and_notifies_channel() {
gpui::block_on(async {
let session = make_test_session("old-access", Some("my-refresh-token"), None);
let (tx, mut rx) = futures::channel::mpsc::unbounded();
let http_client = make_fake_http_client(|_req| {
Box::pin(async {
json_response(
200,
r#"{
"access_token": "new-access",
"refresh_token": "new-refresh",
"expires_in": 1800
}"#,
)
})
});
let provider = McpOAuthTokenProvider::new(session, http_client, Some(tx));
let refreshed = provider.try_refresh().await.unwrap();
assert!(refreshed);
assert_eq!(provider.access_token().as_deref(), Some("new-access"));
let notified_session = rx.try_recv().expect("channel should have a session");
assert_eq!(notified_session.tokens.access_token, "new-access");
assert_eq!(
notified_session.tokens.refresh_token.as_deref(),
Some("new-refresh")
);
});
}
#[test]
fn test_mcp_oauth_provider_refresh_preserves_old_refresh_token_when_server_omits_it() {
gpui::block_on(async {
let session = make_test_session("old-access", Some("original-refresh"), None);
let (tx, mut rx) = futures::channel::mpsc::unbounded();
let http_client = make_fake_http_client(|_req| {
Box::pin(async {
json_response(
200,
r#"{
"access_token": "new-access",
"expires_in": 900
}"#,
)
})
});
let provider = McpOAuthTokenProvider::new(session, http_client, Some(tx));
let refreshed = provider.try_refresh().await.unwrap();
assert!(refreshed);
let notified_session = rx.try_recv().expect("channel should have a session");
assert_eq!(notified_session.tokens.access_token, "new-access");
assert_eq!(
notified_session.tokens.refresh_token.as_deref(),
Some("original-refresh"),
);
});
}
#[test]
fn test_mcp_oauth_provider_refresh_returns_false_on_http_error() {
gpui::block_on(async {
let session = make_test_session("old-access", Some("my-refresh"), None);
let http_client = make_fake_http_client(|_req| {
Box::pin(async { json_response(401, r#"{"error": "invalid_grant"}"#) })
});
let provider = McpOAuthTokenProvider::new(session, http_client, None);
let refreshed = provider.try_refresh().await.unwrap();
assert!(!refreshed);
// The old token should still be in place.
assert_eq!(provider.access_token().as_deref(), Some("old-access"));
});
}
}