From f20f331c0081484b33f8f117299c58982b4332aa Mon Sep 17 00:00:00 2001 From: Li Jiajia Date: Fri, 17 Jul 2026 01:40:00 -0400 Subject: [PATCH 1/6] feat(rest): introduce AuthManager/AuthSession and migrate OAuth2 --- crates/catalog/rest/public-api.txt | 43 ++ crates/catalog/rest/src/auth/mod.rs | 159 ++++++ crates/catalog/rest/src/auth/oauth2.rs | 353 +++++++++++++ crates/catalog/rest/src/catalog.rs | 689 +++++++++++++++++++++---- crates/catalog/rest/src/client.rs | 251 +++------ crates/catalog/rest/src/lib.rs | 2 + 6 files changed, 1225 insertions(+), 272 deletions(-) create mode 100644 crates/catalog/rest/src/auth/mod.rs create mode 100644 crates/catalog/rest/src/auth/oauth2.rs diff --git a/crates/catalog/rest/public-api.txt b/crates/catalog/rest/public-api.txt index 776b11c40a..98725d33e6 100644 --- a/crates/catalog/rest/public-api.txt +++ b/crates/catalog/rest/public-api.txt @@ -1,4 +1,11 @@ pub mod iceberg_catalog_rest +pub struct iceberg_catalog_rest::AuthRequest<'a> +impl<'a> iceberg_catalog_rest::AuthRequest<'a> +pub fn iceberg_catalog_rest::AuthRequest<'a>::body(&self) -> core::option::Option<&[u8]> +pub fn iceberg_catalog_rest::AuthRequest<'a>::headers(&self) -> &http::header::map::HeaderMap +pub fn iceberg_catalog_rest::AuthRequest<'a>::headers_mut(&mut self) -> &mut http::header::map::HeaderMap +pub fn iceberg_catalog_rest::AuthRequest<'a>::method(&self) -> &http::method::Method +pub fn iceberg_catalog_rest::AuthRequest<'a>::url_str(&self) -> &str pub struct iceberg_catalog_rest::CommitTableRequest pub iceberg_catalog_rest::CommitTableRequest::identifier: core::option::Option pub iceberg_catalog_rest::CommitTableRequest::requirements: alloc::vec::Vec @@ -175,6 +182,25 @@ impl serde_core::ser::Serialize for iceberg_catalog_rest::NamespaceResponse pub fn iceberg_catalog_rest::NamespaceResponse::serialize<__S>(&self, __serializer: __S) -> core::result::Result<<__S as serde_core::ser::Serializer>::Ok, <__S as serde_core::ser::Serializer>::Error> where __S: serde_core::ser::Serializer impl<'de> serde_core::de::Deserialize<'de> for iceberg_catalog_rest::NamespaceResponse pub fn iceberg_catalog_rest::NamespaceResponse::deserialize<__D>(__deserializer: __D) -> core::result::Result::Error> where __D: serde_core::de::Deserializer<'de> +pub struct iceberg_catalog_rest::NoopAuthManager +impl core::fmt::Debug for iceberg_catalog_rest::NoopAuthManager +pub fn iceberg_catalog_rest::NoopAuthManager::fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result +impl iceberg_catalog_rest::AuthManager for iceberg_catalog_rest::NoopAuthManager +pub fn iceberg_catalog_rest::NoopAuthManager::catalog_session<'life0, 'life1, 'async_trait>(&'life0 self, _props: &'life1 std::collections::hash::map::HashMap) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait +pub fn iceberg_catalog_rest::NoopAuthManager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait +pub struct iceberg_catalog_rest::OAuth2Manager +impl iceberg_catalog_rest::OAuth2Manager +pub fn iceberg_catalog_rest::OAuth2Manager::new(token_endpoint: impl core::convert::Into) -> Self +pub fn iceberg_catalog_rest::OAuth2Manager::with_client(self, client: reqwest::async_impl::client::Client) -> Self +pub fn iceberg_catalog_rest::OAuth2Manager::with_credential(self, client_id: core::option::Option, client_secret: alloc::string::String) -> Self +pub fn iceberg_catalog_rest::OAuth2Manager::with_extra_headers(self, headers: http::header::map::HeaderMap) -> Self +pub fn iceberg_catalog_rest::OAuth2Manager::with_extra_oauth_params(self, params: std::collections::hash::map::HashMap) -> Self +pub fn iceberg_catalog_rest::OAuth2Manager::with_token(self, token: impl core::convert::Into) -> Self +impl core::fmt::Debug for iceberg_catalog_rest::OAuth2Manager +pub fn iceberg_catalog_rest::OAuth2Manager::fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result +impl iceberg_catalog_rest::AuthManager for iceberg_catalog_rest::OAuth2Manager +pub fn iceberg_catalog_rest::OAuth2Manager::catalog_session<'life0, 'life1, 'async_trait>(&'life0 self, props: &'life1 std::collections::hash::map::HashMap) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait +pub fn iceberg_catalog_rest::OAuth2Manager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait pub struct iceberg_catalog_rest::RegisterTableRequest pub iceberg_catalog_rest::RegisterTableRequest::metadata_location: alloc::string::String pub iceberg_catalog_rest::RegisterTableRequest::name: alloc::string::String @@ -230,6 +256,7 @@ pub fn iceberg_catalog_rest::RestCatalog::update_namespace<'life0, 'life1, 'asyn pub fn iceberg_catalog_rest::RestCatalog::update_table<'life0, 'async_trait>(&'life0 self, commit: iceberg::catalog::TableCommit) -> core::pin::Pin> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait pub struct iceberg_catalog_rest::RestCatalogBuilder impl iceberg_catalog_rest::RestCatalogBuilder +pub fn iceberg_catalog_rest::RestCatalogBuilder::with_auth_manager(self, auth_manager: alloc::sync::Arc) -> Self pub fn iceberg_catalog_rest::RestCatalogBuilder::with_client(self, client: reqwest::async_impl::client::Client) -> Self impl core::default::Default for iceberg_catalog_rest::RestCatalogBuilder pub fn iceberg_catalog_rest::RestCatalogBuilder::default() -> Self @@ -287,6 +314,22 @@ impl serde_core::ser::Serialize for iceberg_catalog_rest::UpdateNamespacePropert pub fn iceberg_catalog_rest::UpdateNamespacePropertiesResponse::serialize<__S>(&self, __serializer: __S) -> core::result::Result<<__S as serde_core::ser::Serializer>::Ok, <__S as serde_core::ser::Serializer>::Error> where __S: serde_core::ser::Serializer impl<'de> serde_core::de::Deserialize<'de> for iceberg_catalog_rest::UpdateNamespacePropertiesResponse pub fn iceberg_catalog_rest::UpdateNamespacePropertiesResponse::deserialize<__D>(__deserializer: __D) -> core::result::Result::Error> where __D: serde_core::de::Deserializer<'de> +pub const iceberg_catalog_rest::AUTH_TYPE_NONE: &str +pub const iceberg_catalog_rest::AUTH_TYPE_OAUTH2: &str +pub const iceberg_catalog_rest::REST_CATALOG_PROP_AUTH_TYPE: &str pub const iceberg_catalog_rest::REST_CATALOG_PROP_DISABLE_HEADER_REDACTION: &str pub const iceberg_catalog_rest::REST_CATALOG_PROP_URI: &str pub const iceberg_catalog_rest::REST_CATALOG_PROP_WAREHOUSE: &str +pub trait iceberg_catalog_rest::AuthManager: core::fmt::Debug + core::marker::Send + core::marker::Sync +pub fn iceberg_catalog_rest::AuthManager::catalog_session<'life0, 'life1, 'async_trait>(&'life0 self, props: &'life1 std::collections::hash::map::HashMap) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait +pub fn iceberg_catalog_rest::AuthManager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait +impl iceberg_catalog_rest::AuthManager for iceberg_catalog_rest::NoopAuthManager +pub fn iceberg_catalog_rest::NoopAuthManager::catalog_session<'life0, 'life1, 'async_trait>(&'life0 self, _props: &'life1 std::collections::hash::map::HashMap) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait +pub fn iceberg_catalog_rest::NoopAuthManager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait +impl iceberg_catalog_rest::AuthManager for iceberg_catalog_rest::OAuth2Manager +pub fn iceberg_catalog_rest::OAuth2Manager::catalog_session<'life0, 'life1, 'async_trait>(&'life0 self, props: &'life1 std::collections::hash::map::HashMap) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait +pub fn iceberg_catalog_rest::OAuth2Manager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait +pub trait iceberg_catalog_rest::AuthSession: core::fmt::Debug + core::marker::Send + core::marker::Sync +pub fn iceberg_catalog_rest::AuthSession::authenticate<'life0, 'life1, 'life2, 'async_trait>(&'life0 self, request: &'life1 mut iceberg_catalog_rest::AuthRequest<'life2>) -> core::pin::Pin> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait +pub fn iceberg_catalog_rest::AuthSession::invalidate<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait +pub fn iceberg_catalog_rest::AuthSession::refresh<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait diff --git a/crates/catalog/rest/src/auth/mod.rs b/crates/catalog/rest/src/auth/mod.rs new file mode 100644 index 0000000000..05602b9756 --- /dev/null +++ b/crates/catalog/rest/src/auth/mod.rs @@ -0,0 +1,159 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +//! Pluggable authentication for the REST catalog, mirroring Iceberg Java's +//! `AuthManager`/`AuthSession` API. + +mod oauth2; + +use std::collections::HashMap; +use std::fmt::Debug; +use std::sync::Arc; + +use async_trait::async_trait; +use http::{HeaderMap, Method}; +use iceberg::Result; +pub use oauth2::OAuth2Manager; +use reqwest::Request; + +/// `rest.auth.type` value disabling authentication. +pub const AUTH_TYPE_NONE: &str = "none"; +/// `rest.auth.type` value selecting OAuth2 token authentication. +pub const AUTH_TYPE_OAUTH2: &str = "oauth2"; + +/// Creates the [`AuthSession`]s used to authenticate REST catalog requests. +/// +/// A manager is created once per catalog, either from the `rest.auth.type` +/// property or injected through `RestCatalogBuilder::with_auth_manager`, and +/// lives for the lifetime of the catalog. +#[async_trait] +pub trait AuthManager: Debug + Send + Sync { + /// Session used for the initial `/v1/config` handshake, built from the + /// user-supplied configuration. + async fn init_session(&self) -> Result>; + + /// Session used for all subsequent catalog requests, given the properties + /// merged from the user configuration and the server's config response. + /// + /// Implementations may carry state (e.g. a cached token) over from the + /// init session. + async fn catalog_session( + &self, + props: &HashMap, + ) -> Result>; +} + +/// An outgoing REST request being authenticated by an [`AuthSession`]. +/// +/// Wraps the request so authentication implementations depend only on the +/// stable `http` crate and standard types, not on the concrete HTTP client the +/// REST catalog uses internally. +pub struct AuthRequest<'a> { + inner: &'a mut Request, +} + +impl<'a> AuthRequest<'a> { + pub(crate) fn new(inner: &'a mut Request) -> Self { + Self { inner } + } + + /// The request method. + pub fn method(&self) -> &Method { + self.inner.method() + } + + /// The request URL, as a string (scheme, host, path and query). + pub fn url_str(&self) -> &str { + self.inner.url().as_str() + } + + /// The request headers. + pub fn headers(&self) -> &HeaderMap { + self.inner.headers() + } + + /// The mutable request headers, e.g. to add an `Authorization` header. + pub fn headers_mut(&mut self) -> &mut HeaderMap { + self.inner.headers_mut() + } + + /// The in-memory request body, or `None` for an empty or streaming body. + pub fn body(&self) -> Option<&[u8]> { + self.inner.body().and_then(|body| body.as_bytes()) + } +} + +/// Authenticates outgoing REST catalog requests. +#[async_trait] +pub trait AuthSession: Debug + Send + Sync { + /// Applies authentication to the request (adds headers, signs, ...). + async fn authenticate(&self, request: &mut AuthRequest<'_>) -> Result<()>; + + /// Drops any cached credentials so the next request re-authenticates. + /// + /// Exists to back the pre-existing [`RestCatalog::invalidate_token`] API + /// and has no counterpart in Java's `AuthSession`. Implementations are + /// expected to manage credential lifetime inside [`Self::authenticate`]; + /// this is not part of the intended extension surface, and the default + /// no-op is fine for most managers. + /// + /// [`RestCatalog::invalidate_token`]: crate::RestCatalog::invalidate_token + async fn invalidate(&self) -> Result<()> { + Ok(()) + } + + /// Proactively refreshes cached credentials (e.g. re-exchanges an OAuth2 + /// client credential for a new token), leaving them intact on failure. + /// + /// Like [`Self::invalidate`], this backs the pre-existing + /// [`RestCatalog::regenerate_token`] API rather than being part of the + /// intended extension surface. + /// + /// [`RestCatalog::regenerate_token`]: crate::RestCatalog::regenerate_token + async fn refresh(&self) -> Result<()> { + Ok(()) + } +} + +/// [`AuthManager`] that performs no authentication. +#[derive(Debug)] +pub struct NoopAuthManager; + +/// [`AuthSession`] that performs no authentication. +#[derive(Debug)] +struct NoopSession; + +#[async_trait] +impl AuthManager for NoopAuthManager { + async fn init_session(&self) -> Result> { + Ok(Arc::new(NoopSession)) + } + + async fn catalog_session( + &self, + _props: &HashMap, + ) -> Result> { + Ok(Arc::new(NoopSession)) + } +} + +#[async_trait] +impl AuthSession for NoopSession { + async fn authenticate(&self, _request: &mut AuthRequest<'_>) -> Result<()> { + Ok(()) + } +} diff --git a/crates/catalog/rest/src/auth/oauth2.rs b/crates/catalog/rest/src/auth/oauth2.rs new file mode 100644 index 0000000000..7177f0ff66 --- /dev/null +++ b/crates/catalog/rest/src/auth/oauth2.rs @@ -0,0 +1,353 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +use std::collections::HashMap; +use std::fmt::{Debug, Formatter}; +use std::sync::Arc; + +use async_trait::async_trait; +use http::StatusCode; +use iceberg::{Error, ErrorKind, Result}; +use reqwest::header::HeaderMap; +use reqwest::{Client, Method}; +use tokio::sync::Mutex; + +use super::{AuthManager, AuthRequest, AuthSession}; +use crate::catalog::{ + REST_CATALOG_PROP_URI, RestCatalogConfig, credential_from_props, default_token_endpoint, + explicit_headers_from_props, +}; +use crate::types::{ErrorResponse, TokenResponse}; + +/// Per-phase OAuth2 parameters (init vs. post-handshake catalog phase). +#[derive(Clone)] +struct OAuth2Params { + extra_headers: HeaderMap, + token_endpoint: String, + credential: Option<(Option, String)>, + extra_oauth_params: HashMap, +} + +/// [`AuthManager`] implementing the OAuth2 client-credentials flow used by +/// Iceberg REST catalogs. +/// +/// A configured `token` is used directly; otherwise `credential` is exchanged +/// for a token at the token endpoint and cached. The cached token is shared +/// across sessions so it survives the config handshake. +pub struct OAuth2Manager { + client: Client, + token: Arc>>, + init_params: OAuth2Params, + /// True when the token endpoint was derived from the catalog URI (not + /// explicitly configured): it is then recomputed from the merged URI in + /// [`Self::catalog_session`], since `/v1/config` may override the URI. + endpoint_is_default: bool, +} + +impl OAuth2Manager { + /// Creates a manager exchanging credentials at `token_endpoint`, with no + /// token or credential configured. Combine with the `with_*` methods: + /// + /// ```rust,ignore + /// let manager = OAuth2Manager::new("https://auth.example.com/v1/oauth/tokens") + /// .with_credential(Some("client-id".into()), "client-secret".into()); + /// ``` + pub fn new(token_endpoint: impl Into) -> Self { + Self { + client: Client::default(), + token: Arc::new(Mutex::new(None)), + init_params: OAuth2Params { + extra_headers: HeaderMap::new(), + token_endpoint: token_endpoint.into(), + credential: None, + // Same default as the configuration path (and the + // pre-AuthManager client): the Iceberg catalog scope. + extra_oauth_params: HashMap::from([("scope".to_string(), "catalog".to_string())]), + }, + endpoint_is_default: false, + } + } + + /// Sets a bearer token used directly (takes precedence over `credential`). + pub fn with_token(mut self, token: impl Into) -> Self { + self.token = Arc::new(Mutex::new(Some(token.into()))); + self + } + + /// Sets the client credential exchanged for a token at the token endpoint. + pub fn with_credential(mut self, client_id: Option, client_secret: String) -> Self { + self.init_params.credential = Some((client_id, client_secret)); + self + } + + /// Sets the HTTP client used for token requests. + pub fn with_client(mut self, client: Client) -> Self { + self.client = client; + self + } + + /// Sets extra headers sent with token requests. + pub fn with_extra_headers(mut self, headers: HeaderMap) -> Self { + self.init_params.extra_headers = headers; + self + } + + /// Adds extra OAuth2 form parameters (e.g. `scope`, `audience`), merged + /// onto the defaults: provide a `scope` entry to replace the default + /// `catalog` scope. + pub fn with_extra_oauth_params(mut self, params: HashMap) -> Self { + self.init_params.extra_oauth_params.extend(params); + self + } + + pub(crate) fn from_config(cfg: &RestCatalogConfig) -> Result { + Ok(Self { + client: cfg.client(), + token: Arc::new(Mutex::new(cfg.token())), + init_params: OAuth2Params { + extra_headers: cfg.extra_headers()?, + token_endpoint: cfg.get_token_endpoint(), + credential: cfg.credential(), + extra_oauth_params: cfg.extra_oauth_params(), + }, + endpoint_is_default: cfg.explicit_oauth2_server_uri().is_none(), + }) + } +} + +impl Debug for OAuth2Manager { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + f.debug_struct("OAuth2Manager") + .field("token_endpoint", &self.init_params.token_endpoint) + .finish_non_exhaustive() + } +} + +#[async_trait] +impl AuthManager for OAuth2Manager { + async fn init_session(&self) -> Result> { + Ok(Arc::new(OAuth2Session { + client: self.client.clone(), + token: self.token.clone(), + params: self.init_params.clone(), + })) + } + + async fn catalog_session( + &self, + props: &HashMap, + ) -> Result> { + // The server config may carry a new token (or restate the user's). + if let Some(token) = props.get("token") { + *self.token.lock().await = Some(token.clone()); + } + + // Explicit property overrides are merged ONTO the manager's configured + // options: an injected manager keeps its token endpoint, extra headers + // and OAuth params unless a property explicitly overrides them. + let mut extra_headers = self.init_params.extra_headers.clone(); + extra_headers.extend(explicit_headers_from_props(props)?); + + let mut extra_oauth_params = self.init_params.extra_oauth_params.clone(); + for key in ["scope", "audience", "resource"] { + if let Some(value) = props.get(key) { + extra_oauth_params.insert(key.to_string(), value.to_string()); + } + } + + let token_endpoint = match props.get("oauth2-server-uri") { + Some(uri) if !uri.is_empty() => uri.clone(), + // The built-in manager's default endpoint follows the merged + // catalog URI (a `/v1/config` override may have changed it); + // injected managers keep their explicitly configured endpoint. + _ if self.endpoint_is_default => props + .get(REST_CATALOG_PROP_URI) + .map(|uri| default_token_endpoint(uri)) + .unwrap_or_else(|| self.init_params.token_endpoint.clone()), + _ => self.init_params.token_endpoint.clone(), + }; + + Ok(Arc::new(OAuth2Session { + client: self.client.clone(), + token: self.token.clone(), + params: OAuth2Params { + extra_headers, + token_endpoint, + credential: credential_from_props(props) + .or_else(|| self.init_params.credential.clone()), + extra_oauth_params, + }, + })) + } +} + +/// [`AuthSession`] adding a `Authorization: Bearer ` header. +struct OAuth2Session { + client: Client, + /// Cached bearer token, shared with the owning [`OAuth2Manager`]. + token: Arc>>, + params: OAuth2Params, +} + +impl Debug for OAuth2Session { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + f.debug_struct("OAuth2Session") + .field("token_endpoint", &self.params.token_endpoint) + .finish_non_exhaustive() + } +} + +impl OAuth2Session { + async fn exchange_credential_for_token(&self) -> Result { + // Credential must exist here. + let (client_id, client_secret) = self.params.credential.as_ref().ok_or_else(|| { + Error::new( + ErrorKind::DataInvalid, + "Credential must be provided for authentication", + ) + })?; + + let mut params = HashMap::with_capacity(4); + params.insert("grant_type", "client_credentials"); + if let Some(client_id) = client_id { + params.insert("client_id", client_id); + } + params.insert("client_secret", client_secret); + params.extend( + self.params + .extra_oauth_params + .iter() + .map(|(k, v)| (k.as_str(), v.as_str())), + ); + + let mut auth_req = self + .client + .request(Method::POST, &self.params.token_endpoint) + .headers(self.params.extra_headers.clone()) + .form(¶ms) + .build()?; + // extra headers add content-type application/json header it's necessary to override it with proper type + // note that form call doesn't add content-type header if already present + auth_req.headers_mut().insert( + http::header::CONTENT_TYPE, + http::HeaderValue::from_static("application/x-www-form-urlencoded"), + ); + let auth_url = auth_req.url().clone(); + let auth_resp = self.client.execute(auth_req).await?; + + let auth_res: TokenResponse = if auth_resp.status() == StatusCode::OK { + let text = auth_resp + .bytes() + .await + .map_err(|err| err.with_url(auth_url.clone()))?; + Ok(serde_json::from_slice(&text).map_err(|e| { + Error::new( + ErrorKind::Unexpected, + "Failed to parse response from rest catalog server!", + ) + .with_context("operation", "auth") + .with_context("url", auth_url.to_string()) + .with_context("json", String::from_utf8_lossy(&text)) + .with_source(e) + })?) + } else { + let code = auth_resp.status(); + let text = auth_resp + .bytes() + .await + .map_err(|err| err.with_url(auth_url.clone()))?; + let e: ErrorResponse = serde_json::from_slice(&text).map_err(|e| { + Error::new(ErrorKind::Unexpected, "Received unexpected response") + .with_context("code", code.to_string()) + .with_context("operation", "auth") + .with_context("url", auth_url.to_string()) + .with_context("json", String::from_utf8_lossy(&text)) + .with_source(e) + })?; + Err(Error::from(e)) + }?; + Ok(auth_res.access_token) + } +} + +#[async_trait] +impl AuthSession for OAuth2Session { + /// Adds a bearer token to the authorization header. + /// + /// Three modes: + /// + /// 1. **No authentication** - Skip when both `credential` and `token` are missing. + /// 2. **Token authentication** - Use the provided `token` directly. + /// 3. **OAuth authentication** - Exchange `credential` for a token, cache it, then use it. + /// + /// When both `credential` and `token` are present, `token` takes precedence. + /// + /// # TODO: Support automatic token refreshing. + async fn authenticate(&self, req: &mut AuthRequest<'_>) -> Result<()> { + // Clone the token from lock without holding the lock for entire function. + let token = self.token.lock().await.clone(); + + if self.params.credential.is_none() && token.is_none() { + return Ok(()); + } + + // Either use the provided token or exchange credential for token, cache and use that + let token = match token { + Some(token) => token, + None => { + let token = self.exchange_credential_for_token().await?; + // Update token so that we use it for next request instead of + // exchanging credential for token from the server again + *self.token.lock().await = Some(token.clone()); + token + } + }; + + // Insert token in request. + req.headers_mut().insert( + http::header::AUTHORIZATION, + format!("Bearer {token}").parse().map_err(|e| { + Error::new( + ErrorKind::DataInvalid, + "Invalid token received from catalog server!", + ) + .with_source(e) + })?, + ); + + Ok(()) + } + + /// Invalidate the current token without generating a new one. On the next + /// request, the session will attempt to generate a new token. + async fn invalidate(&self) -> Result<()> { + *self.token.lock().await = None; + Ok(()) + } + + /// Invalidate the current token and set a new one. Generates a new token + /// before invalidating the current one, meaning the old token will be used + /// until this function acquires the lock and overwrites the token. + /// + /// If credential is invalid, or the request fails, this method will return + /// an error and leave the current token unchanged. + async fn refresh(&self) -> Result<()> { + let new_token = self.exchange_credential_for_token().await?; + *self.token.lock().await = Some(new_token); + Ok(()) + } +} diff --git a/crates/catalog/rest/src/catalog.rs b/crates/catalog/rest/src/catalog.rs index 8642b32d22..26c48c24be 100644 --- a/crates/catalog/rest/src/catalog.rs +++ b/crates/catalog/rest/src/catalog.rs @@ -20,7 +20,7 @@ use std::collections::{HashMap, HashSet}; use std::future::Future; use std::str::FromStr; -use std::sync::Arc; +use std::sync::{Arc, OnceLock}; use async_trait::async_trait; use iceberg::encryption::kms::{KeyManagementClient, KmsClientFactory}; @@ -38,6 +38,7 @@ use reqwest::{Client, Method, StatusCode, Url}; use tokio::sync::OnceCell; use typed_builder::TypedBuilder; +use crate::auth::{AUTH_TYPE_NONE, AUTH_TYPE_OAUTH2, AuthManager, NoopAuthManager, OAuth2Manager}; use crate::client::{ HttpClient, deserialize_catalog_response, deserialize_unexpected_catalog_error, }; @@ -54,6 +55,8 @@ pub const REST_CATALOG_PROP_URI: &str = "uri"; pub const REST_CATALOG_PROP_WAREHOUSE: &str = "warehouse"; /// Disable header redaction in error logs (defaults to false for security) pub const REST_CATALOG_PROP_DISABLE_HEADER_REDACTION: &str = "disable-header-redaction"; +/// Authentication scheme: `none` or `oauth2` (default). +pub const REST_CATALOG_PROP_AUTH_TYPE: &str = "rest.auth.type"; const ICEBERG_REST_SPEC_VERSION: &str = "0.14.1"; const CARGO_PKG_VERSION: &str = env!("CARGO_PKG_VERSION"); @@ -77,6 +80,8 @@ impl Default for RestCatalogBuilder { warehouse: None, props: HashMap::new(), client: None, + default_client: Arc::new(OnceLock::new()), + auth_manager: None, }, storage_factory: None, kms_client_factory: None, @@ -161,6 +166,12 @@ impl RestCatalogBuilder { self.config.client = Some(client); self } + + /// Injects a custom auth manager, overriding the `rest.auth.type` configuration. + pub fn with_auth_manager(mut self, auth_manager: Arc) -> Self { + self.config.auth_manager = Some(auth_manager); + self + } } /// Rest catalog configuration. @@ -179,6 +190,15 @@ pub(crate) struct RestCatalogConfig { #[builder(default)] client: Option, + + /// Lazily-created default HTTP client, shared through clones of this + /// config so OAuth and catalog traffic reuse one connection pool + /// (matching the single-client behavior before the AuthManager refactor). + #[builder(default)] + default_client: Arc>, + + #[builder(default)] + auth_manager: Option>, } impl RestCatalogConfig { @@ -195,11 +215,13 @@ impl RestCatalogConfig { } pub(crate) fn get_token_endpoint(&self) -> String { - if let Some(oauth2_uri) = self.props.get("oauth2-server-uri") { - oauth2_uri.to_string() - } else { - [&self.uri, PATH_V1, "oauth", "tokens"].join("/") - } + self.explicit_oauth2_server_uri() + .unwrap_or_else(|| default_token_endpoint(&self.uri)) + } + + /// The `oauth2-server-uri` property, only when explicitly configured. + pub(crate) fn explicit_oauth2_server_uri(&self) -> Option { + self.props.get("oauth2-server-uri").cloned() } fn namespaces_endpoint(&self) -> String { @@ -231,9 +253,13 @@ impl RestCatalogConfig { ]) } - /// Get the client from the config. - pub(crate) fn client(&self) -> Option { - self.client.clone() + /// The HTTP client: the configured one, or a lazily-created default that + /// is shared across every user of this config (and its clones), so token + /// and catalog requests keep sharing one connection pool. + pub(crate) fn client(&self) -> Client { + self.client + .clone() + .unwrap_or_else(|| self.default_client.get_or_init(Client::default).clone()) } /// Get the token from the config. @@ -245,89 +271,32 @@ impl RestCatalogConfig { /// Get the credentials from the config. The client can use these credentials to fetch a new /// token. - /// - /// ## Output - /// - /// - `None`: No credential is set. - /// - `Some(None, client_secret)`: No client_id is set, use client_secret directly. - /// - `Some(Some(client_id), client_secret)`: Both client_id and client_secret are set. pub(crate) fn credential(&self) -> Option<(Option, String)> { - let cred = self.props.get("credential")?; - - match cred.split_once(':') { - Some((client_id, client_secret)) => { - Some((Some(client_id.to_string()), client_secret.to_string())) - } - None => Some((None, cred.to_string())), - } + credential_from_props(&self.props) } - /// Get the extra headers from config, which includes: - /// - /// - `content-type` - /// - `x-client-version` - /// - `user-agent` - /// - All headers specified by `header.xxx` in props. + /// Get the extra headers from config, see [`extra_headers_from_props`]. pub(crate) fn extra_headers(&self) -> Result { - let mut headers = HeaderMap::from_iter([ - ( - header::CONTENT_TYPE, - HeaderValue::from_static("application/json"), - ), - ( - HeaderName::from_static("x-client-version"), - HeaderValue::from_static(ICEBERG_REST_SPEC_VERSION), - ), - ( - header::USER_AGENT, - HeaderValue::from_str(&format!("iceberg-rs/{CARGO_PKG_VERSION}")).unwrap(), - ), - ]); - - for (key, value) in self - .props - .iter() - .filter_map(|(k, v)| k.strip_prefix("header.").map(|k| (k, v))) - { - headers.insert( - HeaderName::from_str(key).map_err(|e| { - Error::new( - ErrorKind::DataInvalid, - format!("Invalid header name: {key}"), - ) - .with_source(e) - })?, - HeaderValue::from_str(value).map_err(|e| { - Error::new( - ErrorKind::DataInvalid, - format!("Invalid header value: {value}"), - ) - .with_source(e) - })?, - ); - } - - Ok(headers) + extra_headers_from_props(&self.props) } /// Get the optional OAuth headers from the config. pub(crate) fn extra_oauth_params(&self) -> HashMap { - let mut params = HashMap::new(); - - if let Some(scope) = self.props.get("scope") { - params.insert("scope".to_string(), scope.to_string()); - } else { - params.insert("scope".to_string(), "catalog".to_string()); - } - - let optional_params = ["audience", "resource"]; - for param_name in optional_params { - if let Some(value) = self.props.get(param_name) { - params.insert(param_name.to_string(), value.to_string()); - } - } + oauth_params_from_props(&self.props) + } - params + /// The properties handed to [`AuthManager::catalog_session`], with the + /// resolved token endpoint made explicit. + pub(crate) fn auth_props(&self) -> HashMap { + // `oauth2-server-uri` stays absent unless explicitly configured, so an + // injected manager keeps its own token endpoint instead of having a + // synthesized `/v1/oauth/tokens` forced onto it (posting a + // client secret to the wrong host). The resolved catalog `uri` (which + // a `/v1/config` override may have changed) IS passed, so the built-in + // manager can recompute its default endpoint from it. + let mut props = self.props.clone(); + props.insert(REST_CATALOG_PROP_URI.to_string(), self.uri.clone()); + props } /// Check if header redaction is disabled in error logs. @@ -341,6 +310,32 @@ impl RestCatalogConfig { .unwrap_or(false) } + /// The configured auth scheme: explicit `rest.auth.type` or the default + /// `oauth2` (which behaves as no auth when neither `token` nor + /// `credential` is set). + fn auth_type(&self) -> String { + self.props + .get(REST_CATALOG_PROP_AUTH_TYPE) + .cloned() + .unwrap_or_else(|| AUTH_TYPE_OAUTH2.to_string()) + } + + /// Resolves the auth manager: a `with_auth_manager` override wins, + /// otherwise one is built from the `rest.auth.type` configuration. + pub(crate) fn resolve_auth_manager(&self) -> Result> { + if let Some(auth_manager) = &self.auth_manager { + return Ok(auth_manager.clone()); + } + match self.auth_type().as_str() { + AUTH_TYPE_NONE => Ok(Arc::new(NoopAuthManager)), + AUTH_TYPE_OAUTH2 => Ok(Arc::new(OAuth2Manager::from_config(self)?)), + other => Err(Error::new( + ErrorKind::DataInvalid, + format!("unknown '{REST_CATALOG_PROP_AUTH_TYPE}': {other}"), + )), + } + } + /// Merge the `RestCatalogConfig` with the a [`CatalogConfig`] (fetched from the REST server). pub(crate) fn merge_with_config(mut self, mut config: CatalogConfig) -> Self { if let Some(uri) = config.overrides.remove("uri") { @@ -349,6 +344,13 @@ impl RestCatalogConfig { let mut props = config.defaults; props.extend(self.props); + // The client-side warehouse was moved off the props by the builder; + // restore it between defaults and overrides so managers receive the + // resolved value via `auth_props` with the standard precedence + // (server default < client < server override). + if let Some(warehouse) = &self.warehouse { + props.insert(REST_CATALOG_PROP_WAREHOUSE.to_string(), warehouse.clone()); + } props.extend(config.overrides); self.props = props; @@ -356,6 +358,106 @@ impl RestCatalogConfig { } } +/// Parses the `credential` property. +/// +/// ## Output +/// +/// - `None`: No credential is set. +/// - `Some(None, client_secret)`: No client_id is set, use client_secret directly. +/// - `Some(Some(client_id), client_secret)`: Both client_id and client_secret are set. +pub(crate) fn credential_from_props( + props: &HashMap, +) -> Option<(Option, String)> { + let cred = props.get("credential")?; + + match cred.split_once(':') { + Some((client_id, client_secret)) => { + Some((Some(client_id.to_string()), client_secret.to_string())) + } + None => Some((None, cred.to_string())), + } +} + +/// The extra headers added to each request, which include: +/// +/// - `content-type` +/// - `x-client-version` +/// - `user-agent` +/// - All headers specified by `header.xxx` in props. +pub(crate) fn extra_headers_from_props(props: &HashMap) -> Result { + let mut headers = HeaderMap::from_iter([ + ( + header::CONTENT_TYPE, + HeaderValue::from_static("application/json"), + ), + ( + HeaderName::from_static("x-client-version"), + HeaderValue::from_static(ICEBERG_REST_SPEC_VERSION), + ), + ( + header::USER_AGENT, + HeaderValue::from_str(&format!("iceberg-rs/{CARGO_PKG_VERSION}")).unwrap(), + ), + ]); + + headers.extend(explicit_headers_from_props(props)?); + + Ok(headers) +} + +/// The default OAuth2 token endpoint for a catalog `uri`. +pub(crate) fn default_token_endpoint(uri: &str) -> String { + [uri, PATH_V1, "oauth", "tokens"].join("/") +} + +/// Only the headers explicitly configured via `header.xxx` props (no defaults). +pub(crate) fn explicit_headers_from_props(props: &HashMap) -> Result { + let mut headers = HeaderMap::new(); + for (key, value) in props + .iter() + .filter_map(|(k, v)| k.strip_prefix("header.").map(|k| (k, v))) + { + headers.insert( + HeaderName::from_str(key).map_err(|e| { + Error::new( + ErrorKind::DataInvalid, + format!("Invalid header name: {key}"), + ) + .with_source(e) + })?, + HeaderValue::from_str(value).map_err(|e| { + Error::new( + ErrorKind::DataInvalid, + format!("Invalid header value: {value}"), + ) + .with_source(e) + })?, + ); + } + + Ok(headers) +} + +/// The optional OAuth parameters added to each authentication request. +pub(crate) fn oauth_params_from_props(props: &HashMap) -> HashMap { + let mut params = HashMap::new(); + + if let Some(scope) = props.get("scope") { + params.insert("scope".to_string(), scope.to_string()); + } else { + params.insert("scope".to_string(), "catalog".to_string()); + } + + let optional_params = ["audience", "resource"]; + for param_name in optional_params { + if let Some(value) = props.get(param_name) { + params.insert(param_name.to_string(), value.to_string()); + } + } + + params +} + #[derive(Debug)] struct RestContext { client: HttpClient, @@ -432,7 +534,7 @@ impl RestCatalog { async fn context(&self) -> Result<&RestContext> { self.ctx .get_or_try_init(|| async { - let client = HttpClient::new(&self.user_config)?; + let client = HttpClient::new(&self.user_config).await?; let catalog_config = RestCatalog::load_config(&client, &self.user_config).await?; // Use the advertised endpoints as-is, falling back to // `DEFAULT_ENDPOINTS` when absent or empty. @@ -443,7 +545,7 @@ impl RestCatalog { _ => crate::endpoint::DEFAULT_ENDPOINTS.clone(), }; let config = self.user_config.clone().merge_with_config(catalog_config); - let client = client.update_with(&config)?; + let client = client.update_with(&config).await?; Ok(RestContext { config, @@ -549,7 +651,7 @@ impl RestCatalog { /// Invalidate the current token without generating a new one. On the next request, the client /// will attempt to generate a new token. pub async fn invalidate_token(&self) -> Result<()> { - self.context().await?.client.invalidate_token().await + self.context().await?.client.session().invalidate().await } /// Invalidate the current token and set a new one. Generates a new token before invalidating @@ -559,7 +661,7 @@ impl RestCatalog { /// If credential is invalid, or the request fails, this method will return an error and leave /// the current token unchanged. pub async fn regenerate_token(&self) -> Result<()> { - self.context().await?.client.regenerate_token().await + self.context().await?.client.session().refresh().await } } @@ -1465,9 +1567,18 @@ mod tests { let oauth_mock = create_oauth_mock_with_path(&mut server, "/v1/oauth/tokens", "ey000000000001", 200) .await; + // The next request re-exchanges the credential and sends the new token. + let ns_mock = server + .mock("GET", "/v1/namespaces") + .match_header("authorization", "Bearer ey000000000001") + .with_body(r#"{"namespaces": []}"#) + .create_async() + .await; catalog.invalidate_token().await.unwrap(); - let token = catalog.context().await.unwrap().client.token().await; + catalog.list_namespaces(None).await.unwrap(); oauth_mock.assert_async().await; + ns_mock.assert_async().await; + let token = catalog.context().await.unwrap().client.token().await; assert_eq!(token, Some("ey000000000001".to_string())); } @@ -1499,8 +1610,10 @@ mod tests { create_oauth_mock_with_path(&mut server, "/v1/oauth/tokens", "ey000000000001", 500) .await; catalog.invalidate_token().await.unwrap(); - let token = catalog.context().await.unwrap().client.token().await; + // The failed re-exchange surfaces as an error and no token is cached. + assert!(catalog.list_namespaces(None).await.is_err()); oauth_mock.assert_async().await; + let token = catalog.context().await.unwrap().client.token().await; assert_eq!(token, None); } @@ -1765,6 +1878,404 @@ mod tests { list_ns_mock.assert_async().await; } + #[tokio::test] + async fn test_auth_type_none_disables_auth() { + // An explicit `rest.auth.type=none` wins over a configured token. + let props = HashMap::from([ + (REST_CATALOG_PROP_AUTH_TYPE.to_string(), "none".to_string()), + ("token".to_string(), "some-oauth-token".to_string()), + ]); + let config = RestCatalogConfig::builder() + .uri("http://localhost".to_string()) + .props(props) + .build(); + + let session = config + .resolve_auth_manager() + .unwrap() + .init_session() + .await + .unwrap(); + let mut req = Client::new() + .get("https://rest.example.com/v1/config") + .build() + .unwrap(); + session + .authenticate(&mut crate::auth::AuthRequest::new(&mut req)) + .await + .unwrap(); + assert!(req.headers().get("authorization").is_none()); + } + + #[tokio::test] + async fn test_header_prop_overrides_token_on_the_wire() { + // Pre-AuthManager behavior, preserved: extra headers are applied after + // authentication, so a user-configured `header.authorization` wins + // over a configured token. + let mut server = Server::new_async().await; + let config_mock = create_config_mock(&mut server).await; + let list_ns_mock = server + .mock("GET", "/v1/namespaces") + .match_header("authorization", "Basic xyz") + .with_body(r#"{"namespaces": []}"#) + .create_async() + .await; + + let props = HashMap::from([ + ("token".to_string(), "some-oauth-token".to_string()), + ("header.authorization".to_string(), "Basic xyz".to_string()), + ]); + let catalog = RestCatalog::new( + RestCatalogConfig::builder() + .uri(server.url()) + .props(props) + .build(), + Some(Arc::new(LocalFsStorageFactory)), + Runtime::current(), + None, + ); + + catalog.list_namespaces(None).await.unwrap(); + config_mock.assert_async().await; + list_ns_mock.assert_async().await; + } + + #[tokio::test] + async fn test_builtin_oauth_endpoint_follows_uri_override() { + // When `/v1/config` overrides `uri` (and no explicit `oauth2-server-uri` + // is set), the built-in manager's default token endpoint must follow + // the merged URI: a refresh after the handshake posts to the new host. + let mut bootstrap = Server::new_async().await; + let mut overridden = Server::new_async().await; + + let config_mock = bootstrap + .mock("GET", "/v1/config") + .with_status(200) + .with_body(format!( + r#"{{"overrides": {{"uri": "{}"}}, "defaults": {{}}}}"#, + overridden.url() + )) + .create_async() + .await; + // Handshake exchange still uses the bootstrap-derived default. + let bootstrap_oauth_mock = + create_oauth_mock_with_path(&mut bootstrap, "/v1/oauth/tokens", "tok-boot", 200).await; + // The refresh must follow the overridden URI. + let overridden_oauth_mock = + create_oauth_mock_with_path(&mut overridden, "/v1/oauth/tokens", "tok-new", 200).await; + + let props = HashMap::from([("credential".to_string(), "client1:secret1".to_string())]); + let catalog = RestCatalog::new( + RestCatalogConfig::builder() + .uri(bootstrap.url()) + .props(props) + .build(), + Some(Arc::new(LocalFsStorageFactory)), + Runtime::current(), + None, + ); + + catalog.context().await.unwrap(); + catalog.regenerate_token().await.unwrap(); + + config_mock.assert_async().await; + bootstrap_oauth_mock.assert_async().await; + overridden_oauth_mock.assert_async().await; + let token = catalog.context().await.unwrap().client.token().await; + assert_eq!(token, Some("tok-new".to_string())); + } + + #[tokio::test] + async fn test_injected_oauth_manager_keeps_endpoint_and_options() { + // An injected OAuth2Manager must keep its own token endpoint, extra + // headers and OAuth params across the config handshake: only explicit + // properties may override them, never synthesized defaults. + let mut server = Server::new_async().await; + let config_mock = create_config_mock(&mut server).await; + + // The catalog-host default endpoint must never see the credential. + let default_endpoint_mock = server + .mock("POST", "/v1/oauth/tokens") + .expect(0) + .create_async() + .await; + // Both exchanges (handshake + regenerate) hit the injected endpoint, + // carrying the injected header and OAuth param. + let custom_endpoint_mock = server + .mock("POST", "/custom/oauth/tokens") + .match_header("x-tenant", "t1") + // The default catalog scope must survive alongside the injected + // audience (with_extra_oauth_params merges onto the defaults). + .match_body(mockito::Matcher::AllOf(vec![ + mockito::Matcher::Regex("scope=catalog".to_string()), + mockito::Matcher::Regex("audience=aud-1".to_string()), + ])) + .with_status(200) + .with_body( + r#"{ + "access_token": "ey000000000000", + "token_type": "Bearer", + "issued_token_type": "urn:ietf:params:oauth:token-type:access_token", + "expires_in": 86400 + }"#, + ) + .expect(2) + .create_async() + .await; + + let manager = OAuth2Manager::new(format!("{}/custom/oauth/tokens", server.url())) + .with_credential(Some("client1".to_string()), "secret1".to_string()) + .with_extra_headers(HeaderMap::from_iter([( + HeaderName::from_static("x-tenant"), + HeaderValue::from_static("t1"), + )])) + .with_extra_oauth_params(HashMap::from([( + "audience".to_string(), + "aud-1".to_string(), + )])); + let catalog = RestCatalog::new( + RestCatalogConfig::builder() + .uri(server.url()) + .auth_manager(Some(Arc::new(manager))) + .build(), + Some(Arc::new(LocalFsStorageFactory)), + Runtime::current(), + None, + ); + + // Handshake performs the first exchange; regenerate the second — both + // must use the injected endpoint/options. + catalog.context().await.unwrap(); + catalog.regenerate_token().await.unwrap(); + + config_mock.assert_async().await; + custom_endpoint_mock.assert_async().await; + default_endpoint_mock.assert_async().await; + } + + #[tokio::test] + async fn test_catalog_session_receives_resolved_warehouse() { + use tokio::sync::Mutex as AsyncMutex; + + use crate::auth::AuthSession; + + // A custom manager must receive the resolved warehouse in the props + // handed to `catalog_session`, with the standard precedence: + // server default < client-side warehouse < server override. + #[derive(Debug)] + struct PlainSession; + #[async_trait] + impl AuthSession for PlainSession { + async fn authenticate( + &self, + _request: &mut crate::auth::AuthRequest<'_>, + ) -> Result<()> { + Ok(()) + } + } + + #[derive(Debug)] + struct CapturingManager(Arc>>>); + #[async_trait] + impl AuthManager for CapturingManager { + async fn init_session(&self) -> Result> { + Ok(Arc::new(PlainSession)) + } + async fn catalog_session( + &self, + props: &HashMap, + ) -> Result> { + *self.0.lock().await = Some(props.clone()); + Ok(Arc::new(PlainSession)) + } + } + + // Client warehouse wins over a server default. + let mut server = Server::new_async().await; + let config_mock = server + .mock("GET", "/v1/config") + .match_query(mockito::Matcher::UrlEncoded( + "warehouse".to_string(), + "client-wh".to_string(), + )) + .with_status(200) + .with_body(r#"{"defaults": {"warehouse": "default-wh"}, "overrides": {}}"#) + .create_async() + .await; + let captured = Arc::new(AsyncMutex::new(None)); + let catalog = RestCatalog::new( + RestCatalogConfig::builder() + .uri(server.url()) + .warehouse("client-wh".to_string()) + .auth_manager(Some(Arc::new(CapturingManager(captured.clone())))) + .build(), + Some(Arc::new(LocalFsStorageFactory)), + Runtime::current(), + None, + ); + catalog.context().await.unwrap(); + config_mock.assert_async().await; + let props = captured.lock().await.clone().unwrap(); + assert_eq!( + props.get("warehouse").map(String::as_str), + Some("client-wh") + ); + + // A server override wins over the client warehouse. + let mut server = Server::new_async().await; + let config_mock = server + .mock("GET", "/v1/config") + .match_query(mockito::Matcher::UrlEncoded( + "warehouse".to_string(), + "client-wh".to_string(), + )) + .with_status(200) + .with_body(r#"{"defaults": {}, "overrides": {"warehouse": "override-wh"}}"#) + .create_async() + .await; + let captured = Arc::new(AsyncMutex::new(None)); + let catalog = RestCatalog::new( + RestCatalogConfig::builder() + .uri(server.url()) + .warehouse("client-wh".to_string()) + .auth_manager(Some(Arc::new(CapturingManager(captured.clone())))) + .build(), + Some(Arc::new(LocalFsStorageFactory)), + Runtime::current(), + None, + ); + catalog.context().await.unwrap(); + config_mock.assert_async().await; + let props = captured.lock().await.clone().unwrap(); + assert_eq!( + props.get("warehouse").map(String::as_str), + Some("override-wh") + ); + } + + #[tokio::test] + async fn test_init_session_dropped_before_catalog_session() { + use std::sync::atomic::{AtomicBool, Ordering}; + + use crate::auth::AuthSession; + + // A manager whose init session guards a one-shot resource (released on + // drop) must see it released before `catalog_session` is invoked. + #[derive(Debug)] + struct GuardSession(Arc); + impl Drop for GuardSession { + fn drop(&mut self) { + self.0.store(true, Ordering::SeqCst); + } + } + #[async_trait] + impl AuthSession for GuardSession { + async fn authenticate( + &self, + _request: &mut crate::auth::AuthRequest<'_>, + ) -> Result<()> { + Ok(()) + } + } + + #[derive(Debug)] + struct PlainSession; + #[async_trait] + impl AuthSession for PlainSession { + async fn authenticate( + &self, + _request: &mut crate::auth::AuthRequest<'_>, + ) -> Result<()> { + Ok(()) + } + } + + #[derive(Debug)] + struct GuardManager(Arc); + #[async_trait] + impl AuthManager for GuardManager { + async fn init_session(&self) -> Result> { + Ok(Arc::new(GuardSession(self.0.clone()))) + } + async fn catalog_session( + &self, + _props: &HashMap, + ) -> Result> { + if !self.0.load(Ordering::SeqCst) { + return Err(Error::new( + ErrorKind::Unexpected, + "init session must be dropped before catalog_session", + )); + } + Ok(Arc::new(PlainSession)) + } + } + + let mut server = Server::new_async().await; + let config_mock = create_config_mock(&mut server).await; + + let dropped = Arc::new(AtomicBool::new(false)); + let catalog = RestCatalog::new( + RestCatalogConfig::builder() + .uri(server.url()) + .auth_manager(Some(Arc::new(GuardManager(dropped.clone())))) + .build(), + Some(Arc::new(LocalFsStorageFactory)), + Runtime::current(), + None, + ); + + catalog.context().await.unwrap(); + config_mock.assert_async().await; + assert!(dropped.load(Ordering::SeqCst)); + } + + #[test] + fn test_unknown_auth_type_is_rejected() { + let props = HashMap::from([( + REST_CATALOG_PROP_AUTH_TYPE.to_string(), + "kerberos".to_string(), + )]); + let config = RestCatalogConfig::builder() + .uri("http://localhost".to_string()) + .props(props) + .build(); + + let err = config.resolve_auth_manager().unwrap_err(); + assert!(err.message().contains(REST_CATALOG_PROP_AUTH_TYPE)); + } + + #[test] + fn test_with_auth_manager_overrides_config() { + // A custom auth manager takes precedence over `rest.auth.type`. + #[derive(Debug)] + struct StubAuthManager; + #[async_trait] + impl AuthManager for StubAuthManager { + async fn init_session(&self) -> Result> { + unimplemented!() + } + async fn catalog_session( + &self, + _props: &HashMap, + ) -> Result> { + unimplemented!() + } + } + + let config = RestCatalogConfig::builder() + .uri("http://localhost".to_string()) + .props(HashMap::from([( + REST_CATALOG_PROP_AUTH_TYPE.to_string(), + "kerberos".to_string(), + )])) + .auth_manager(Some(Arc::new(StubAuthManager))) + .build(); + + // The unknown auth type is never consulted. + assert!(config.resolve_auth_manager().is_ok()); + } + #[tokio::test] async fn test_list_namespace_with_pagination() { let mut server = Server::new_async().await; diff --git a/crates/catalog/rest/src/client.rs b/crates/catalog/rest/src/client.rs index 07dc0620da..0b9300ac75 100644 --- a/crates/catalog/rest/src/client.rs +++ b/crates/catalog/rest/src/client.rs @@ -17,34 +17,27 @@ use std::collections::HashMap; use std::fmt::{Debug, Formatter}; +use std::sync::Arc; -use http::StatusCode; use iceberg::{Error, ErrorKind, Result}; use reqwest::header::HeaderMap; use reqwest::{Client, IntoUrl, Method, Request, RequestBuilder, Response}; use serde::de::DeserializeOwned; -use tokio::sync::Mutex; use crate::RestCatalogConfig; -use crate::types::{ErrorResponse, TokenResponse}; +use crate::auth::{AuthManager, AuthRequest, AuthSession}; pub(crate) struct HttpClient { client: Client, - /// The token to be used for authentication. - /// - /// It's possible to fetch the token from the server while needed. - token: Mutex>, - /// The token endpoint to be used for authentication. - token_endpoint: String, - /// The credential to be used for authentication. - credential: Option<(Option, String)>, /// Extra headers to be added to each request. extra_headers: HeaderMap, - /// Extra oauth parameters to be added to each authentication request. - extra_oauth_params: HashMap, /// Whether to disable header redaction in error logs (defaults to false for security). disable_header_redaction: bool, + /// The auth manager living for the lifetime of the catalog. + auth_manager: Arc, + /// The session authenticating requests in the current phase. + session: Arc, } impl Debug for HttpClient { @@ -58,16 +51,15 @@ impl Debug for HttpClient { impl HttpClient { /// Create a new http client. - pub fn new(cfg: &RestCatalogConfig) -> Result { - let extra_headers = cfg.extra_headers()?; + pub async fn new(cfg: &RestCatalogConfig) -> Result { + let auth_manager = cfg.resolve_auth_manager()?; + let session = auth_manager.init_session().await?; Ok(HttpClient { - client: cfg.client().unwrap_or_default(), - token: Mutex::new(cfg.token()), - token_endpoint: cfg.get_token_endpoint(), - credential: cfg.credential(), - extra_headers, - extra_oauth_params: cfg.extra_oauth_params(), + client: cfg.client(), + extra_headers: cfg.extra_headers()?, disable_header_redaction: cfg.disable_header_redaction(), + auth_manager, + session, }) } @@ -75,172 +67,66 @@ impl HttpClient { /// /// If cfg carries new value, we will use cfg instead. /// Otherwise, we will keep the old value. - pub fn update_with(self, cfg: &RestCatalogConfig) -> Result { + /// + /// The auth manager is kept; it derives a new session from the merged + /// properties (carrying over state such as a cached token). + pub async fn update_with(self, cfg: &RestCatalogConfig) -> Result { + let HttpClient { + // The same client comes back from `cfg.client()` below: the config + // clone shares the lazily-created default (or the user's client). + client: _, + extra_headers: current_headers, + disable_header_redaction: _, + auth_manager, + session: init_session, + } = self; + // Release the init-phase session before deriving the catalog session, + // so a manager whose init session guards a one-shot resource (released + // on drop) can build its catalog session without deadlocking. + drop(init_session); + let extra_headers = (!cfg.extra_headers()?.is_empty()) .then(|| cfg.extra_headers()) .transpose()? - .unwrap_or(self.extra_headers); + .unwrap_or(current_headers); + let session = auth_manager.catalog_session(&cfg.auth_props()).await?; Ok(HttpClient { - client: cfg.client().unwrap_or(self.client), - token: Mutex::new(cfg.token().or_else(|| self.token.into_inner())), - token_endpoint: if !cfg.get_token_endpoint().is_empty() { - cfg.get_token_endpoint() - } else { - self.token_endpoint - }, - credential: cfg.credential().or(self.credential), + client: cfg.client(), extra_headers, - extra_oauth_params: if !cfg.extra_oauth_params().is_empty() { - cfg.extra_oauth_params() - } else { - self.extra_oauth_params - }, disable_header_redaction: cfg.disable_header_redaction(), + auth_manager, + session, }) } - /// This API is testing only to assert the token. - #[cfg(test)] - pub(crate) async fn token(&self) -> Option { - let mut req = self - .request(Method::GET, &self.token_endpoint) - .build() - .unwrap(); - self.authenticate(&mut req).await.ok(); - self.token.lock().await.clone() - } - - async fn exchange_credential_for_token(&self) -> Result { - // Credential must exist here. - let (client_id, client_secret) = self.credential.as_ref().ok_or_else(|| { - Error::new( - ErrorKind::DataInvalid, - "Credential must be provided for authentication", - ) - })?; - - let mut params = HashMap::with_capacity(4); - params.insert("grant_type", "client_credentials"); - if let Some(client_id) = client_id { - params.insert("client_id", client_id); - } - params.insert("client_secret", client_secret); - params.extend( - self.extra_oauth_params - .iter() - .map(|(k, v)| (k.as_str(), v.as_str())), - ); - - let mut auth_req = self - .request(Method::POST, &self.token_endpoint) - .form(¶ms) - .build()?; - // extra headers add content-type application/json header it's necessary to override it with proper type - // note that form call doesn't add content-type header if already present - auth_req.headers_mut().insert( - http::header::CONTENT_TYPE, - http::HeaderValue::from_static("application/x-www-form-urlencoded"), - ); - let auth_url = auth_req.url().clone(); - let auth_resp = self.client.execute(auth_req).await?; - - let auth_res: TokenResponse = if auth_resp.status() == StatusCode::OK { - let text = auth_resp - .bytes() - .await - .map_err(|err| err.with_url(auth_url.clone()))?; - Ok(serde_json::from_slice(&text).map_err(|e| { - Error::new( - ErrorKind::Unexpected, - "Failed to parse response from rest catalog server!", - ) - .with_context("operation", "auth") - .with_context("url", auth_url.to_string()) - .with_context("json", String::from_utf8_lossy(&text)) - .with_source(e) - })?) - } else { - let code = auth_resp.status(); - let text = auth_resp - .bytes() - .await - .map_err(|err| err.with_url(auth_url.clone()))?; - let e: ErrorResponse = serde_json::from_slice(&text).map_err(|e| { - Error::new(ErrorKind::Unexpected, "Received unexpected response") - .with_context("code", code.to_string()) - .with_context("operation", "auth") - .with_context("url", auth_url.to_string()) - .with_context("json", String::from_utf8_lossy(&text)) - .with_source(e) - })?; - Err(Error::from(e)) - }?; - Ok(auth_res.access_token) - } - - /// Invalidate the current token without generating a new one. On the next request, the client - /// will attempt to generate a new token. - pub(crate) async fn invalidate_token(&self) -> Result<()> { - *self.token.lock().await = None; - Ok(()) - } - - /// Invalidate the current token and set a new one. Generates a new token before invalidating - /// the current token, meaning the old token will be used until this function acquires the lock - /// and overwrites the token. - /// - /// If credential is invalid, or the request fails, this method will return an error and leave - /// the current token unchanged. - pub(crate) async fn regenerate_token(&self) -> Result<()> { - let new_token = self.exchange_credential_for_token().await?; - *self.token.lock().await = Some(new_token.clone()); - Ok(()) + /// The session authenticating requests in the current phase. + pub(crate) fn session(&self) -> &Arc { + &self.session } - /// Authenticates the request by adding a bearer token to the authorization header. - /// - /// This method supports three authentication modes: - /// - /// 1. **No authentication** - Skip authentication when both `credential` and `token` are missing. - /// 2. **Token authentication** - Use the provided `token` directly for authentication. - /// 3. **OAuth authentication** - Exchange `credential` for a token, cache it, then use it for authentication. - /// - /// When both `credential` and `token` are present, `token` takes precedence. + /// Testing only: the bearer token the current session would attach. /// - /// # TODO: Support automatic token refreshing. - async fn authenticate(&self, req: &mut Request) -> Result<()> { - // Clone the token from lock without holding the lock for entire function. - let token = self.token.lock().await.clone(); - - if self.credential.is_none() && token.is_none() { - return Ok(()); - } - - // Either use the provided token or exchange credential for token, cache and use that - let token = match token { - Some(token) => token, - None => { - let token = self.exchange_credential_for_token().await?; - // Update token so that we use it for next request instead of - // exchanging credential for token from the server again - *self.token.lock().await = Some(token.clone()); - token - } - }; - - // Insert token in request. - req.headers_mut().insert( - http::header::AUTHORIZATION, - format!("Bearer {token}").parse().map_err(|e| { - Error::new( - ErrorKind::DataInvalid, - "Invalid token received from catalog server!", - ) - .with_source(e) - })?, - ); - - Ok(()) + /// Authenticates a throwaway request (never sent — `authenticate` only + /// mutates it) and reads the header back, so this works for any + /// [`AuthSession`] without the trait carrying a test-only method. + #[cfg(test)] + pub(crate) async fn token(&self) -> Option { + let mut request = self + .client + .request(Method::GET, "http://localhost/token-probe") + .build() + .ok()?; + self.session + .authenticate(&mut AuthRequest::new(&mut request)) + .await + .ok()?; + request + .headers() + .get(reqwest::header::AUTHORIZATION)? + .to_str() + .ok()? + .strip_prefix("Bearer ") + .map(str::to_string) } #[inline] @@ -250,17 +136,16 @@ impl HttpClient { .headers(self.extra_headers.clone()) } - /// Executes the given `Request` and returns a `Response`. - pub async fn execute(&self, mut request: Request) -> Result { - request.headers_mut().extend(self.extra_headers.clone()); - Ok(self.client.execute(request).await?) - } - // Queries the Iceberg REST catalog after authentication with the given `Request` and // returns a `Response`. pub async fn query_catalog(&self, mut request: Request) -> Result { - self.authenticate(&mut request).await?; - self.execute(request).await + // Authenticate first, then apply extra headers, so a configured + // `header.authorization` keeps overriding a token (unchanged behavior). + self.session + .authenticate(&mut AuthRequest::new(&mut request)) + .await?; + request.headers_mut().extend(self.extra_headers.clone()); + Ok(self.client.execute(request).await?) } /// Returns whether header redaction is disabled for this client. diff --git a/crates/catalog/rest/src/lib.rs b/crates/catalog/rest/src/lib.rs index 383728401f..663ea65f26 100644 --- a/crates/catalog/rest/src/lib.rs +++ b/crates/catalog/rest/src/lib.rs @@ -51,11 +51,13 @@ #![deny(missing_docs)] +mod auth; mod catalog; mod client; mod endpoint; mod types; +pub use auth::*; pub use catalog::*; pub use endpoint::Endpoint; pub use types::*; From 645a72f33af74816da865c1d343b650e6e5eeff0 Mon Sep 17 00:00:00 2001 From: Li Jiajia Date: Sat, 25 Jul 2026 11:06:45 -0400 Subject: [PATCH 2/6] docs(rest): tighten auth comments --- crates/catalog/rest/src/auth/mod.rs | 11 +++-------- crates/catalog/rest/src/auth/oauth2.rs | 13 +++++-------- crates/catalog/rest/src/catalog.rs | 13 ++++--------- crates/catalog/rest/src/client.rs | 14 ++++++-------- 4 files changed, 18 insertions(+), 33 deletions(-) diff --git a/crates/catalog/rest/src/auth/mod.rs b/crates/catalog/rest/src/auth/mod.rs index 05602b9756..39c801d268 100644 --- a/crates/catalog/rest/src/auth/mod.rs +++ b/crates/catalog/rest/src/auth/mod.rs @@ -105,11 +105,8 @@ pub trait AuthSession: Debug + Send + Sync { /// Drops any cached credentials so the next request re-authenticates. /// - /// Exists to back the pre-existing [`RestCatalog::invalidate_token`] API - /// and has no counterpart in Java's `AuthSession`. Implementations are - /// expected to manage credential lifetime inside [`Self::authenticate`]; - /// this is not part of the intended extension surface, and the default - /// no-op is fine for most managers. + /// Backs the existing [`RestCatalog::invalidate_token`] API; not part of + /// the intended extension surface, and the default no-op is usually fine. /// /// [`RestCatalog::invalidate_token`]: crate::RestCatalog::invalidate_token async fn invalidate(&self) -> Result<()> { @@ -119,9 +116,7 @@ pub trait AuthSession: Debug + Send + Sync { /// Proactively refreshes cached credentials (e.g. re-exchanges an OAuth2 /// client credential for a new token), leaving them intact on failure. /// - /// Like [`Self::invalidate`], this backs the pre-existing - /// [`RestCatalog::regenerate_token`] API rather than being part of the - /// intended extension surface. + /// Like [`Self::invalidate`], backs [`RestCatalog::regenerate_token`]. /// /// [`RestCatalog::regenerate_token`]: crate::RestCatalog::regenerate_token async fn refresh(&self) -> Result<()> { diff --git a/crates/catalog/rest/src/auth/oauth2.rs b/crates/catalog/rest/src/auth/oauth2.rs index 7177f0ff66..03100c4b24 100644 --- a/crates/catalog/rest/src/auth/oauth2.rs +++ b/crates/catalog/rest/src/auth/oauth2.rs @@ -74,8 +74,7 @@ impl OAuth2Manager { extra_headers: HeaderMap::new(), token_endpoint: token_endpoint.into(), credential: None, - // Same default as the configuration path (and the - // pre-AuthManager client): the Iceberg catalog scope. + // Same default as the configuration path: the catalog scope. extra_oauth_params: HashMap::from([("scope".to_string(), "catalog".to_string())]), }, endpoint_is_default: false, @@ -156,9 +155,8 @@ impl AuthManager for OAuth2Manager { *self.token.lock().await = Some(token.clone()); } - // Explicit property overrides are merged ONTO the manager's configured - // options: an injected manager keeps its token endpoint, extra headers - // and OAuth params unless a property explicitly overrides them. + // Explicit property overrides merge ONTO the manager's options, so an + // injected manager keeps whatever a property doesn't override. let mut extra_headers = self.init_params.extra_headers.clone(); extra_headers.extend(explicit_headers_from_props(props)?); @@ -171,9 +169,8 @@ impl AuthManager for OAuth2Manager { let token_endpoint = match props.get("oauth2-server-uri") { Some(uri) if !uri.is_empty() => uri.clone(), - // The built-in manager's default endpoint follows the merged - // catalog URI (a `/v1/config` override may have changed it); - // injected managers keep their explicitly configured endpoint. + // A default endpoint follows the merged catalog URI (which + // `/v1/config` may have overridden); explicit ones are kept. _ if self.endpoint_is_default => props .get(REST_CATALOG_PROP_URI) .map(|uri| default_token_endpoint(uri)) diff --git a/crates/catalog/rest/src/catalog.rs b/crates/catalog/rest/src/catalog.rs index 26c48c24be..fb0ed72bb7 100644 --- a/crates/catalog/rest/src/catalog.rs +++ b/crates/catalog/rest/src/catalog.rs @@ -289,11 +289,8 @@ impl RestCatalogConfig { /// resolved token endpoint made explicit. pub(crate) fn auth_props(&self) -> HashMap { // `oauth2-server-uri` stays absent unless explicitly configured, so an - // injected manager keeps its own token endpoint instead of having a - // synthesized `/v1/oauth/tokens` forced onto it (posting a - // client secret to the wrong host). The resolved catalog `uri` (which - // a `/v1/config` override may have changed) IS passed, so the built-in - // manager can recompute its default endpoint from it. + // injected manager keeps its own endpoint. The resolved `uri` IS passed + // so the built-in manager can recompute its default from it. let mut props = self.props.clone(); props.insert(REST_CATALOG_PROP_URI.to_string(), self.uri.clone()); props @@ -344,10 +341,8 @@ impl RestCatalogConfig { let mut props = config.defaults; props.extend(self.props); - // The client-side warehouse was moved off the props by the builder; - // restore it between defaults and overrides so managers receive the - // resolved value via `auth_props` with the standard precedence - // (server default < client < server override). + // The builder moved the client warehouse off the props; restore it + // between defaults and overrides (default < client < override). if let Some(warehouse) = &self.warehouse { props.insert(REST_CATALOG_PROP_WAREHOUSE.to_string(), warehouse.clone()); } diff --git a/crates/catalog/rest/src/client.rs b/crates/catalog/rest/src/client.rs index 0b9300ac75..2dc26cdb60 100644 --- a/crates/catalog/rest/src/client.rs +++ b/crates/catalog/rest/src/client.rs @@ -72,17 +72,15 @@ impl HttpClient { /// properties (carrying over state such as a cached token). pub async fn update_with(self, cfg: &RestCatalogConfig) -> Result { let HttpClient { - // The same client comes back from `cfg.client()` below: the config - // clone shares the lazily-created default (or the user's client). + // `cfg.client()` below returns this same shared client. client: _, extra_headers: current_headers, disable_header_redaction: _, auth_manager, session: init_session, } = self; - // Release the init-phase session before deriving the catalog session, - // so a manager whose init session guards a one-shot resource (released - // on drop) can build its catalog session without deadlocking. + // Release the init session first, so a manager whose init session + // guards a one-shot resource can build its catalog session. drop(init_session); let extra_headers = (!cfg.extra_headers()?.is_empty()) @@ -106,9 +104,9 @@ impl HttpClient { /// Testing only: the bearer token the current session would attach. /// - /// Authenticates a throwaway request (never sent — `authenticate` only - /// mutates it) and reads the header back, so this works for any - /// [`AuthSession`] without the trait carrying a test-only method. + /// Authenticates a throwaway request (never sent) and reads the header + /// back, so it works for any [`AuthSession`] without a test-only trait + /// method. #[cfg(test)] pub(crate) async fn token(&self) -> Option { let mut request = self From f5628eeae47c37118dbbfade7b38d9cc62326287 Mon Sep 17 00:00:00 2001 From: Li Jiajia Date: Thu, 30 Jul 2026 00:16:26 -0400 Subject: [PATCH 3/6] fix(rest): address auth review feedback - hold the token lock across the OAuth2 exchange (single flight) - three-state AuthRequestBody: Empty/Buffered/Streaming; pub AuthRequest::new - zeroize OAuth2 secrets via a redacting SensitiveString - split the OAuth2 session into static-token and client-credentials types - init_session returns Box; catalog_session stays Arc --- Cargo.lock | 3 + crates/catalog/rest/Cargo.toml | 5 + crates/catalog/rest/public-api.txt | 28 +++- crates/catalog/rest/src/auth/mod.rs | 177 +++++++++++++++++++-- crates/catalog/rest/src/auth/oauth2.rs | 209 +++++++++++++++---------- crates/catalog/rest/src/catalog.rs | 179 +++++++++++++++++++-- crates/catalog/rest/src/client.rs | 61 ++++++-- 7 files changed, 541 insertions(+), 121 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 87b228a871..1762aeb6d2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -3883,7 +3883,9 @@ name = "iceberg-catalog-rest" version = "0.10.0" dependencies = [ "async-trait", + "bytes", "chrono", + "futures", "http 1.4.2", "iceberg", "iceberg_test_utils", @@ -3896,6 +3898,7 @@ dependencies = [ "tokio", "typed-builder", "uuid", + "zeroize", ] [[package]] diff --git a/crates/catalog/rest/Cargo.toml b/crates/catalog/rest/Cargo.toml index 247709efd4..1541fe8200 100644 --- a/crates/catalog/rest/Cargo.toml +++ b/crates/catalog/rest/Cargo.toml @@ -36,6 +36,7 @@ http = { workspace = true } iceberg = { workspace = true } itertools = { workspace = true } reqwest = { workspace = true } +zeroize = { workspace = true } serde = { workspace = true } serde_derive = { workspace = true } serde_json = { workspace = true } @@ -44,8 +45,12 @@ typed-builder = { workspace = true } uuid = { workspace = true, features = ["v4"] } [dev-dependencies] +bytes = { workspace = true } +futures = { workspace = true } iceberg_test_utils = { path = "../../test_utils", features = ["tests"] } mockito = { workspace = true } +# `stream` lets tests build a streaming body to exercise AuthRequestBody::Streaming. +reqwest = { workspace = true, features = ["stream"] } tokio = { workspace = true } [lints] diff --git a/crates/catalog/rest/public-api.txt b/crates/catalog/rest/public-api.txt index 98725d33e6..e0beecd24a 100644 --- a/crates/catalog/rest/public-api.txt +++ b/crates/catalog/rest/public-api.txt @@ -1,10 +1,26 @@ pub mod iceberg_catalog_rest +pub enum iceberg_catalog_rest::AuthRequestBody<'a> +pub iceberg_catalog_rest::AuthRequestBody::Buffered(&'a [u8]) +pub iceberg_catalog_rest::AuthRequestBody::Empty +pub iceberg_catalog_rest::AuthRequestBody::Streaming +impl<'a> iceberg_catalog_rest::AuthRequestBody<'a> +pub fn iceberg_catalog_rest::AuthRequestBody<'a>::as_bytes(&self) -> core::option::Option<&'a [u8]> +impl<'a> core::clone::Clone for iceberg_catalog_rest::AuthRequestBody<'a> +pub fn iceberg_catalog_rest::AuthRequestBody<'a>::clone(&self) -> iceberg_catalog_rest::AuthRequestBody<'a> +impl<'a> core::cmp::Eq for iceberg_catalog_rest::AuthRequestBody<'a> +impl<'a> core::cmp::PartialEq for iceberg_catalog_rest::AuthRequestBody<'a> +pub fn iceberg_catalog_rest::AuthRequestBody<'a>::eq(&self, other: &iceberg_catalog_rest::AuthRequestBody<'a>) -> bool +impl<'a> core::fmt::Debug for iceberg_catalog_rest::AuthRequestBody<'a> +pub fn iceberg_catalog_rest::AuthRequestBody<'a>::fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result +impl<'a> core::marker::Copy for iceberg_catalog_rest::AuthRequestBody<'a> +impl<'a> core::marker::StructuralPartialEq for iceberg_catalog_rest::AuthRequestBody<'a> pub struct iceberg_catalog_rest::AuthRequest<'a> impl<'a> iceberg_catalog_rest::AuthRequest<'a> -pub fn iceberg_catalog_rest::AuthRequest<'a>::body(&self) -> core::option::Option<&[u8]> +pub fn iceberg_catalog_rest::AuthRequest<'a>::body(&self) -> iceberg_catalog_rest::AuthRequestBody<'_> pub fn iceberg_catalog_rest::AuthRequest<'a>::headers(&self) -> &http::header::map::HeaderMap pub fn iceberg_catalog_rest::AuthRequest<'a>::headers_mut(&mut self) -> &mut http::header::map::HeaderMap pub fn iceberg_catalog_rest::AuthRequest<'a>::method(&self) -> &http::method::Method +pub fn iceberg_catalog_rest::AuthRequest<'a>::new(inner: &'a mut reqwest::async_impl::request::Request) -> Self pub fn iceberg_catalog_rest::AuthRequest<'a>::url_str(&self) -> &str pub struct iceberg_catalog_rest::CommitTableRequest pub iceberg_catalog_rest::CommitTableRequest::identifier: core::option::Option @@ -187,7 +203,7 @@ impl core::fmt::Debug for iceberg_catalog_rest::NoopAuthManager pub fn iceberg_catalog_rest::NoopAuthManager::fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result impl iceberg_catalog_rest::AuthManager for iceberg_catalog_rest::NoopAuthManager pub fn iceberg_catalog_rest::NoopAuthManager::catalog_session<'life0, 'life1, 'async_trait>(&'life0 self, _props: &'life1 std::collections::hash::map::HashMap) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait -pub fn iceberg_catalog_rest::NoopAuthManager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait +pub fn iceberg_catalog_rest::NoopAuthManager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait pub struct iceberg_catalog_rest::OAuth2Manager impl iceberg_catalog_rest::OAuth2Manager pub fn iceberg_catalog_rest::OAuth2Manager::new(token_endpoint: impl core::convert::Into) -> Self @@ -200,7 +216,7 @@ impl core::fmt::Debug for iceberg_catalog_rest::OAuth2Manager pub fn iceberg_catalog_rest::OAuth2Manager::fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result impl iceberg_catalog_rest::AuthManager for iceberg_catalog_rest::OAuth2Manager pub fn iceberg_catalog_rest::OAuth2Manager::catalog_session<'life0, 'life1, 'async_trait>(&'life0 self, props: &'life1 std::collections::hash::map::HashMap) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait -pub fn iceberg_catalog_rest::OAuth2Manager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait +pub fn iceberg_catalog_rest::OAuth2Manager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait pub struct iceberg_catalog_rest::RegisterTableRequest pub iceberg_catalog_rest::RegisterTableRequest::metadata_location: alloc::string::String pub iceberg_catalog_rest::RegisterTableRequest::name: alloc::string::String @@ -322,13 +338,13 @@ pub const iceberg_catalog_rest::REST_CATALOG_PROP_URI: &str pub const iceberg_catalog_rest::REST_CATALOG_PROP_WAREHOUSE: &str pub trait iceberg_catalog_rest::AuthManager: core::fmt::Debug + core::marker::Send + core::marker::Sync pub fn iceberg_catalog_rest::AuthManager::catalog_session<'life0, 'life1, 'async_trait>(&'life0 self, props: &'life1 std::collections::hash::map::HashMap) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait -pub fn iceberg_catalog_rest::AuthManager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait +pub fn iceberg_catalog_rest::AuthManager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait impl iceberg_catalog_rest::AuthManager for iceberg_catalog_rest::NoopAuthManager pub fn iceberg_catalog_rest::NoopAuthManager::catalog_session<'life0, 'life1, 'async_trait>(&'life0 self, _props: &'life1 std::collections::hash::map::HashMap) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait -pub fn iceberg_catalog_rest::NoopAuthManager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait +pub fn iceberg_catalog_rest::NoopAuthManager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait impl iceberg_catalog_rest::AuthManager for iceberg_catalog_rest::OAuth2Manager pub fn iceberg_catalog_rest::OAuth2Manager::catalog_session<'life0, 'life1, 'async_trait>(&'life0 self, props: &'life1 std::collections::hash::map::HashMap) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait -pub fn iceberg_catalog_rest::OAuth2Manager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait +pub fn iceberg_catalog_rest::OAuth2Manager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait pub trait iceberg_catalog_rest::AuthSession: core::fmt::Debug + core::marker::Send + core::marker::Sync pub fn iceberg_catalog_rest::AuthSession::authenticate<'life0, 'life1, 'life2, 'async_trait>(&'life0 self, request: &'life1 mut iceberg_catalog_rest::AuthRequest<'life2>) -> core::pin::Pin> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait pub fn iceberg_catalog_rest::AuthSession::invalidate<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait diff --git a/crates/catalog/rest/src/auth/mod.rs b/crates/catalog/rest/src/auth/mod.rs index 39c801d268..fd2e9c7acb 100644 --- a/crates/catalog/rest/src/auth/mod.rs +++ b/crates/catalog/rest/src/auth/mod.rs @@ -44,13 +44,17 @@ pub const AUTH_TYPE_OAUTH2: &str = "oauth2"; pub trait AuthManager: Debug + Send + Sync { /// Session used for the initial `/v1/config` handshake, built from the /// user-supplied configuration. - async fn init_session(&self) -> Result>; + /// + /// Returns a [`Box`]: an init session is used once and released, unlike + /// the shared [`AuthManager::catalog_session`]. + async fn init_session(&self) -> Result>; /// Session used for all subsequent catalog requests, given the properties /// merged from the user configuration and the server's config response. /// - /// Implementations may carry state (e.g. a cached token) over from the - /// init session. + /// Returns an [`Arc`]: this session is shared by concurrent requests for + /// the rest of the catalog's lifetime. Implementations may carry state + /// (e.g. a cached token) over from the init session. async fn catalog_session( &self, props: &HashMap, @@ -67,7 +71,8 @@ pub struct AuthRequest<'a> { } impl<'a> AuthRequest<'a> { - pub(crate) fn new(inner: &'a mut Request) -> Self { + /// Wraps a request, e.g. to unit-test a custom [`AuthSession`]. + pub fn new(inner: &'a mut Request) -> Self { Self { inner } } @@ -91,9 +96,40 @@ impl<'a> AuthRequest<'a> { self.inner.headers_mut() } - /// The in-memory request body, or `None` for an empty or streaming body. - pub fn body(&self) -> Option<&[u8]> { - self.inner.body().and_then(|body| body.as_bytes()) + /// The request body, distinguishing an absent body from a streaming one: + /// signers can sign [`AuthRequestBody::Empty`] (empty-payload hash) and + /// [`AuthRequestBody::Buffered`], but not [`AuthRequestBody::Streaming`]. + pub fn body(&self) -> AuthRequestBody<'_> { + match self.inner.body() { + None => AuthRequestBody::Empty, + Some(body) => match body.as_bytes() { + Some(bytes) => AuthRequestBody::Buffered(bytes), + None => AuthRequestBody::Streaming, + }, + } + } +} + +/// The body of an [`AuthRequest`], as seen by authentication. +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum AuthRequestBody<'a> { + /// No body is set. + Empty, + /// An in-memory body. + Buffered(&'a [u8]), + /// A streaming body, whose bytes are not available for e.g. signing. + Streaming, +} + +impl<'a> AuthRequestBody<'a> { + /// The signable bytes: empty for [`Self::Empty`], the buffer for + /// [`Self::Buffered`], and `None` for [`Self::Streaming`]. + pub fn as_bytes(&self) -> Option<&'a [u8]> { + match self { + AuthRequestBody::Empty => Some(&[]), + AuthRequestBody::Buffered(bytes) => Some(bytes), + AuthRequestBody::Streaming => None, + } } } @@ -124,6 +160,32 @@ pub trait AuthSession: Debug + Send + Sync { } } +/// A secret string: `Debug` prints `[REDACTED]` and the memory is zeroized on +/// drop. String-shaped counterpart of the core crate's `SensitiveBytes`; note +/// that copies formatted into requests (form bodies, header values) are owned +/// by the HTTP stack and outlive this wrapper. +#[derive(Clone)] +pub(crate) struct SensitiveString(zeroize::Zeroizing); + +impl SensitiveString { + /// The wrapped secret. + pub(crate) fn expose(&self) -> &str { + &self.0 + } +} + +impl From for SensitiveString { + fn from(secret: String) -> Self { + Self(zeroize::Zeroizing::new(secret)) + } +} + +impl Debug for SensitiveString { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str("[REDACTED]") + } +} + /// [`AuthManager`] that performs no authentication. #[derive(Debug)] pub struct NoopAuthManager; @@ -134,8 +196,8 @@ struct NoopSession; #[async_trait] impl AuthManager for NoopAuthManager { - async fn init_session(&self) -> Result> { - Ok(Arc::new(NoopSession)) + async fn init_session(&self) -> Result> { + Ok(Box::new(NoopSession)) } async fn catalog_session( @@ -152,3 +214,100 @@ impl AuthSession for NoopSession { Ok(()) } } + +#[cfg(test)] +mod tests { + use reqwest::Client; + + use super::*; + + #[tokio::test] + async fn test_static_token_session_lifecycle() { + // Token-only config: attach as-is; refresh keeps erroring (no + // credential to exchange); after invalidate, no auth is sent. + let manager = OAuth2Manager::new("http://localhost/unused").with_token("tok-static"); + let session = manager.init_session().await.unwrap(); + let client = Client::new(); + + let mut req = client + .get("https://rest.example.com/v1/config") + .build() + .unwrap(); + session + .authenticate(&mut AuthRequest::new(&mut req)) + .await + .unwrap(); + assert_eq!( + req.headers().get("authorization").unwrap(), + "Bearer tok-static" + ); + + assert!(session.refresh().await.is_err()); + + session.invalidate().await.unwrap(); + let mut req = client + .get("https://rest.example.com/v1/config") + .build() + .unwrap(); + session + .authenticate(&mut AuthRequest::new(&mut req)) + .await + .unwrap(); + assert!(req.headers().get("authorization").is_none()); + } + + #[test] + fn test_sensitive_string_redacts_debug() { + let secret = SensitiveString::from("s3cret-value".to_string()); + assert_eq!(format!("{secret:?}"), "[REDACTED]"); + + // Containers can safely derive Debug around it. + #[derive(Debug)] + #[allow(dead_code)] + struct Holder { + secret: SensitiveString, + } + let rendered = format!("{:?}", Holder { secret }); + assert!(!rendered.contains("s3cret-value"), "leaked: {rendered}"); + assert!(rendered.contains("[REDACTED]")); + } + + #[test] + fn test_auth_request_body_states() { + let client = Client::new(); + + // No body at all. + let mut req = client + .get("https://rest.example.com/v1/config") + .build() + .unwrap(); + let auth_req = AuthRequest::new(&mut req); + let body = auth_req.body(); + assert_eq!(body, AuthRequestBody::Empty); + assert_eq!(body.as_bytes(), Some(&[] as &[u8])); + + // An in-memory body. + let mut req = client + .post("https://rest.example.com/v1/namespaces") + .body("{}") + .build() + .unwrap(); + let auth_req = AuthRequest::new(&mut req); + let body = auth_req.body(); + assert_eq!(body, AuthRequestBody::Buffered(b"{}")); + assert_eq!(body.as_bytes(), Some(b"{}" as &[u8])); + + // A streaming body: bytes are unavailable, so it must not sign as empty. + let mut req = client + .post("https://rest.example.com/v1/namespaces") + .body(reqwest::Body::wrap_stream(futures::stream::once(async { + Ok::<_, std::io::Error>(bytes::Bytes::from_static(b"chunk")) + }))) + .build() + .unwrap(); + let auth_req = AuthRequest::new(&mut req); + let body = auth_req.body(); + assert_eq!(body, AuthRequestBody::Streaming); + assert_eq!(body.as_bytes(), None); + } +} diff --git a/crates/catalog/rest/src/auth/oauth2.rs b/crates/catalog/rest/src/auth/oauth2.rs index 03100c4b24..4281ee3b62 100644 --- a/crates/catalog/rest/src/auth/oauth2.rs +++ b/crates/catalog/rest/src/auth/oauth2.rs @@ -26,7 +26,7 @@ use reqwest::header::HeaderMap; use reqwest::{Client, Method}; use tokio::sync::Mutex; -use super::{AuthManager, AuthRequest, AuthSession}; +use super::{AuthManager, AuthRequest, AuthSession, SensitiveString}; use crate::catalog::{ REST_CATALOG_PROP_URI, RestCatalogConfig, credential_from_props, default_token_endpoint, explicit_headers_from_props, @@ -38,7 +38,7 @@ use crate::types::{ErrorResponse, TokenResponse}; struct OAuth2Params { extra_headers: HeaderMap, token_endpoint: String, - credential: Option<(Option, String)>, + credential: Option<(Option, SensitiveString)>, extra_oauth_params: HashMap, } @@ -50,7 +50,7 @@ struct OAuth2Params { /// across sessions so it survives the config handshake. pub struct OAuth2Manager { client: Client, - token: Arc>>, + token: Arc>>, init_params: OAuth2Params, /// True when the token endpoint was derived from the catalog URI (not /// explicitly configured): it is then recomputed from the merged URI in @@ -83,13 +83,13 @@ impl OAuth2Manager { /// Sets a bearer token used directly (takes precedence over `credential`). pub fn with_token(mut self, token: impl Into) -> Self { - self.token = Arc::new(Mutex::new(Some(token.into()))); + self.token = Arc::new(Mutex::new(Some(SensitiveString::from(token.into())))); self } /// Sets the client credential exchanged for a token at the token endpoint. pub fn with_credential(mut self, client_id: Option, client_secret: String) -> Self { - self.init_params.credential = Some((client_id, client_secret)); + self.init_params.credential = Some((client_id, client_secret.into())); self } @@ -116,11 +116,11 @@ impl OAuth2Manager { pub(crate) fn from_config(cfg: &RestCatalogConfig) -> Result { Ok(Self { client: cfg.client(), - token: Arc::new(Mutex::new(cfg.token())), + token: Arc::new(Mutex::new(cfg.token().map(SensitiveString::from))), init_params: OAuth2Params { extra_headers: cfg.extra_headers()?, token_endpoint: cfg.get_token_endpoint(), - credential: cfg.credential(), + credential: cfg.credential().map(|(id, secret)| (id, secret.into())), extra_oauth_params: cfg.extra_oauth_params(), }, endpoint_is_default: cfg.explicit_oauth2_server_uri().is_none(), @@ -138,12 +138,8 @@ impl Debug for OAuth2Manager { #[async_trait] impl AuthManager for OAuth2Manager { - async fn init_session(&self) -> Result> { - Ok(Arc::new(OAuth2Session { - client: self.client.clone(), - token: self.token.clone(), - params: self.init_params.clone(), - })) + async fn init_session(&self) -> Result> { + Ok(self.build_session(self.init_params.clone())) } async fn catalog_session( @@ -152,7 +148,7 @@ impl AuthManager for OAuth2Manager { ) -> Result> { // The server config may carry a new token (or restate the user's). if let Some(token) = props.get("token") { - *self.token.lock().await = Some(token.clone()); + *self.token.lock().await = Some(SensitiveString::from(token.clone())); } // Explicit property overrides merge ONTO the manager's options, so an @@ -178,63 +174,136 @@ impl AuthManager for OAuth2Manager { _ => self.init_params.token_endpoint.clone(), }; - Ok(Arc::new(OAuth2Session { - client: self.client.clone(), - token: self.token.clone(), - params: OAuth2Params { + Ok(Arc::from( + self.build_session(OAuth2Params { extra_headers, token_endpoint, credential: credential_from_props(props) + .map(|(id, secret)| (id, secret.into())) .or_else(|| self.init_params.credential.clone()), extra_oauth_params, - }, - })) + }), + )) } } -/// [`AuthSession`] adding a `Authorization: Bearer ` header. -struct OAuth2Session { +impl OAuth2Manager { + /// Builds the session matching the configured mode: + /// + /// - a `credential` yields a [`ClientCredentialsSession`] (its token cache + /// pre-seeded when a `token` is also set, and the token then takes + /// precedence until invalidated); + /// - otherwise a [`StaticTokenSession`], which attaches the configured + /// token as-is — or nothing when none is set. + /// + /// Both share the manager's token cell, so a cached token survives the + /// config handshake and `invalidate` is observed by later sessions. + fn build_session(&self, params: OAuth2Params) -> Box { + match params.credential { + Some(credential) => Box::new(ClientCredentialsSession { + client: self.client.clone(), + token: self.token.clone(), + credential, + token_endpoint: params.token_endpoint, + extra_headers: params.extra_headers, + extra_oauth_params: params.extra_oauth_params, + }), + None => Box::new(StaticTokenSession { + token: self.token.clone(), + }), + } + } +} + +/// Attaches `token` as a `Authorization: Bearer ` header, marked +/// sensitive so `Debug`-formatted requests redact it. +fn attach_bearer(req: &mut AuthRequest<'_>, token: &SensitiveString) -> Result<()> { + let mut value: http::HeaderValue = + format!("Bearer {}", token.expose()).parse().map_err(|e| { + Error::new( + ErrorKind::DataInvalid, + "Invalid token received from catalog server!", + ) + .with_source(e) + })?; + value.set_sensitive(true); + req.headers_mut().insert(http::header::AUTHORIZATION, value); + Ok(()) +} + +/// [`AuthSession`] for a pre-configured bearer token: attaches it as-is and +/// cannot obtain a new one (there is no credential to exchange). +#[derive(Debug)] +struct StaticTokenSession { + /// Shared with the owning [`OAuth2Manager`]. + token: Arc>>, +} + +#[async_trait] +impl AuthSession for StaticTokenSession { + async fn authenticate(&self, req: &mut AuthRequest<'_>) -> Result<()> { + // After `invalidate` there is nothing to fall back to: no auth is sent. + match self.token.lock().await.clone() { + Some(token) => attach_bearer(req, &token), + None => Ok(()), + } + } + + async fn invalidate(&self) -> Result<()> { + *self.token.lock().await = None; + Ok(()) + } + + async fn refresh(&self) -> Result<()> { + Err(Error::new( + ErrorKind::DataInvalid, + "Credential must be provided for authentication", + )) + } +} + +/// [`AuthSession`] implementing the OAuth2 client-credentials flow: exchanges +/// the credential for a token at the token endpoint and caches it. +/// +/// # TODO: Support automatic token refreshing. +struct ClientCredentialsSession { client: Client, /// Cached bearer token, shared with the owning [`OAuth2Manager`]. - token: Arc>>, - params: OAuth2Params, + token: Arc>>, + credential: (Option, SensitiveString), + token_endpoint: String, + extra_headers: HeaderMap, + extra_oauth_params: HashMap, } -impl Debug for OAuth2Session { +impl Debug for ClientCredentialsSession { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { - f.debug_struct("OAuth2Session") - .field("token_endpoint", &self.params.token_endpoint) + f.debug_struct("ClientCredentialsSession") + .field("token_endpoint", &self.token_endpoint) .finish_non_exhaustive() } } -impl OAuth2Session { +impl ClientCredentialsSession { async fn exchange_credential_for_token(&self) -> Result { - // Credential must exist here. - let (client_id, client_secret) = self.params.credential.as_ref().ok_or_else(|| { - Error::new( - ErrorKind::DataInvalid, - "Credential must be provided for authentication", - ) - })?; + let (client_id, client_secret) = &self.credential; let mut params = HashMap::with_capacity(4); params.insert("grant_type", "client_credentials"); if let Some(client_id) = client_id { params.insert("client_id", client_id); } - params.insert("client_secret", client_secret); + params.insert("client_secret", client_secret.expose()); params.extend( - self.params - .extra_oauth_params + self.extra_oauth_params .iter() .map(|(k, v)| (k.as_str(), v.as_str())), ); let mut auth_req = self .client - .request(Method::POST, &self.params.token_endpoint) - .headers(self.params.extra_headers.clone()) + .request(Method::POST, &self.token_endpoint) + .headers(self.extra_headers.clone()) .form(¶ms) .build()?; // extra headers add content-type application/json header it's necessary to override it with proper type @@ -282,51 +351,27 @@ impl OAuth2Session { } #[async_trait] -impl AuthSession for OAuth2Session { - /// Adds a bearer token to the authorization header. - /// - /// Three modes: - /// - /// 1. **No authentication** - Skip when both `credential` and `token` are missing. - /// 2. **Token authentication** - Use the provided `token` directly. - /// 3. **OAuth authentication** - Exchange `credential` for a token, cache it, then use it. - /// - /// When both `credential` and `token` are present, `token` takes precedence. - /// - /// # TODO: Support automatic token refreshing. +impl AuthSession for ClientCredentialsSession { + /// Uses the cached token when present (a configured `token` takes + /// precedence over the credential until invalidated); otherwise exchanges + /// the credential for a token, caches it, then uses it. async fn authenticate(&self, req: &mut AuthRequest<'_>) -> Result<()> { - // Clone the token from lock without holding the lock for entire function. - let token = self.token.lock().await.clone(); - - if self.params.credential.is_none() && token.is_none() { - return Ok(()); - } - - // Either use the provided token or exchange credential for token, cache and use that - let token = match token { - Some(token) => token, - None => { - let token = self.exchange_credential_for_token().await?; - // Update token so that we use it for next request instead of - // exchanging credential for token from the server again - *self.token.lock().await = Some(token.clone()); - token + // The lock is held across the exchange: waiters reuse a successful + // result, and retry themselves after a failure. + let token = { + let mut token = self.token.lock().await; + match &*token { + Some(token) => token.clone(), + None => { + let new_token = + SensitiveString::from(self.exchange_credential_for_token().await?); + *token = Some(new_token.clone()); + new_token + } } }; - // Insert token in request. - req.headers_mut().insert( - http::header::AUTHORIZATION, - format!("Bearer {token}").parse().map_err(|e| { - Error::new( - ErrorKind::DataInvalid, - "Invalid token received from catalog server!", - ) - .with_source(e) - })?, - ); - - Ok(()) + attach_bearer(req, &token) } /// Invalidate the current token without generating a new one. On the next @@ -344,7 +389,7 @@ impl AuthSession for OAuth2Session { /// an error and leave the current token unchanged. async fn refresh(&self) -> Result<()> { let new_token = self.exchange_credential_for_token().await?; - *self.token.lock().await = Some(new_token); + *self.token.lock().await = Some(new_token.into()); Ok(()) } } diff --git a/crates/catalog/rest/src/catalog.rs b/crates/catalog/rest/src/catalog.rs index fb0ed72bb7..9495fc4b4f 100644 --- a/crates/catalog/rest/src/catalog.rs +++ b/crates/catalog/rest/src/catalog.rs @@ -53,7 +53,8 @@ use crate::types::{ pub const REST_CATALOG_PROP_URI: &str = "uri"; /// REST catalog warehouse location pub const REST_CATALOG_PROP_WAREHOUSE: &str = "warehouse"; -/// Disable header redaction in error logs (defaults to false for security) +/// Disable header redaction in error logs and `Debug` output (defaults to +/// false for security) pub const REST_CATALOG_PROP_DISABLE_HEADER_REDACTION: &str = "disable-header-redaction"; /// Authentication scheme: `none` or `oauth2` (default). pub const REST_CATALOG_PROP_AUTH_TYPE: &str = "rest.auth.type"; @@ -175,7 +176,7 @@ impl RestCatalogBuilder { } /// Rest catalog configuration. -#[derive(Clone, Debug, TypedBuilder)] +#[derive(Clone, TypedBuilder)] pub(crate) struct RestCatalogConfig { #[builder(default, setter(strip_option))] name: Option, @@ -201,6 +202,44 @@ pub(crate) struct RestCatalogConfig { auth_manager: Option>, } +/// Property keys whose values are secrets, or may embed them (headers, +/// connection strings, keys like `adls.account-key` or `s3.sse.key`). +fn is_sensitive_prop(key: &str) -> bool { + key.contains("token") + || key.contains("credential") + || key.contains("secret") + || key.contains("password") + || key.contains("key") + || key.contains("connection-string") + || key.starts_with("header.") +} + +/// Redacts secret property values: this config is printed by +/// [`RestCatalog`]'s derived `Debug`. +impl std::fmt::Debug for RestCatalogConfig { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let props: HashMap<&str, &str> = self + .props + .iter() + .map(|(key, value)| { + let value = if is_sensitive_prop(key) { + "[REDACTED]" + } else { + value.as_str() + }; + (key.as_str(), value) + }) + .collect(); + f.debug_struct("RestCatalogConfig") + .field("name", &self.name) + .field("uri", &self.uri) + .field("warehouse", &self.warehouse) + .field("props", &props) + .field("auth_manager", &self.auth_manager) + .finish_non_exhaustive() + } +} + impl RestCatalogConfig { fn url_prefixed(&self, parts: &[&str]) -> String { [&self.uri, PATH_V1] @@ -286,7 +325,7 @@ impl RestCatalogConfig { } /// The properties handed to [`AuthManager::catalog_session`], with the - /// resolved token endpoint made explicit. + /// resolved catalog `uri` made explicit. pub(crate) fn auth_props(&self) -> HashMap { // `oauth2-server-uri` stays absent unless explicitly configured, so an // injected manager keeps its own endpoint. The resolved `uri` IS passed @@ -423,7 +462,8 @@ pub(crate) fn explicit_headers_from_props(props: &HashMap) -> Re HeaderValue::from_str(value).map_err(|e| { Error::new( ErrorKind::DataInvalid, - format!("Invalid header value: {value}"), + // The value itself is omitted: it may be a secret. + format!("Invalid value for header: {key}"), ) .with_source(e) })?, @@ -645,6 +685,9 @@ impl RestCatalog { /// Invalidate the current token without generating a new one. On the next request, the client /// will attempt to generate a new token. + /// + /// Sessions that don't manage a token (e.g. with `rest.auth.type` `none`, + /// or a custom [`AuthManager`]) may treat this as a no-op. pub async fn invalidate_token(&self) -> Result<()> { self.context().await?.client.session().invalidate().await } @@ -655,6 +698,9 @@ impl RestCatalog { /// /// If credential is invalid, or the request fails, this method will return an error and leave /// the current token unchanged. + /// + /// Errors when the session has no credential to exchange (e.g. a static + /// token); a custom [`AuthManager`]'s session may treat this as a no-op. pub async fn regenerate_token(&self) -> Result<()> { self.context().await?.client.session().refresh().await } @@ -1980,6 +2026,92 @@ mod tests { assert_eq!(token, Some("tok-new".to_string())); } + #[tokio::test] + async fn test_concurrent_authenticate_single_token_exchange() { + // Concurrent requests that all find no cached token must trigger ONE + // credential exchange (the lock is held across it), not one each. + let mut server = Server::new_async().await; + // create_oauth_mock_with_path expects exactly 1 hit. + let oauth_mock = + create_oauth_mock_with_path(&mut server, "/v1/oauth/tokens", "tok-once", 200).await; + + let manager = OAuth2Manager::new(format!("{}/v1/oauth/tokens", server.url())) + .with_credential(Some("client1".to_string()), "secret1".to_string()); + let session: Arc = + Arc::from(manager.init_session().await.unwrap()); + + let client = Client::new(); + let attempts = (0..8).map(|_| { + let session = session.clone(); + let client = client.clone(); + async move { + let mut req = client + .get("https://rest.example.com/v1/config") + .build() + .unwrap(); + session + .authenticate(&mut crate::auth::AuthRequest::new(&mut req)) + .await + .unwrap(); + req.headers() + .get("authorization") + .unwrap() + .to_str() + .unwrap() + .to_string() + } + }); + let bearers = futures::future::join_all(attempts).await; + + oauth_mock.assert_async().await; + assert!(bearers.iter().all(|b| b == "Bearer tok-once")); + } + + #[tokio::test] + async fn test_seeded_token_with_credential_exchanges_once_after_invalidate() { + // The seeded token is attached without an exchange; after + // invalidate() the credential is exchanged exactly once. + let mut server = Server::new_async().await; + // create_oauth_mock_with_path expects exactly 1 hit. + let oauth_mock = + create_oauth_mock_with_path(&mut server, "/v1/oauth/tokens", "tok-new", 200).await; + + let manager = OAuth2Manager::new(format!("{}/v1/oauth/tokens", server.url())) + .with_token("tok-seed") + .with_credential(Some("client1".to_string()), "secret1".to_string()); + let session = manager.init_session().await.unwrap(); + + let client = Client::new(); + let mut req = client + .get("https://rest.example.com/v1/config") + .build() + .unwrap(); + session + .authenticate(&mut crate::auth::AuthRequest::new(&mut req)) + .await + .unwrap(); + assert_eq!( + req.headers().get("authorization").unwrap(), + "Bearer tok-seed" + ); + + session.invalidate().await.unwrap(); + let mut req = client + .get("https://rest.example.com/v1/config") + .build() + .unwrap(); + session + .authenticate(&mut crate::auth::AuthRequest::new(&mut req)) + .await + .unwrap(); + assert_eq!( + req.headers().get("authorization").unwrap(), + "Bearer tok-new" + ); + + oauth_mock.assert_async().await; + } + #[tokio::test] async fn test_injected_oauth_manager_keeps_endpoint_and_options() { // An injected OAuth2Manager must keep its own token endpoint, extra @@ -2073,8 +2205,8 @@ mod tests { struct CapturingManager(Arc>>>); #[async_trait] impl AuthManager for CapturingManager { - async fn init_session(&self) -> Result> { - Ok(Arc::new(PlainSession)) + async fn init_session(&self) -> Result> { + Ok(Box::new(PlainSession)) } async fn catalog_session( &self, @@ -2189,8 +2321,8 @@ mod tests { struct GuardManager(Arc); #[async_trait] impl AuthManager for GuardManager { - async fn init_session(&self) -> Result> { - Ok(Arc::new(GuardSession(self.0.clone()))) + async fn init_session(&self) -> Result> { + Ok(Box::new(GuardSession(self.0.clone()))) } async fn catalog_session( &self, @@ -2225,6 +2357,35 @@ mod tests { assert!(dropped.load(Ordering::SeqCst)); } + #[test] + fn test_config_debug_redacts_secrets() { + let config = RestCatalogConfig::builder() + .uri("http://localhost".to_string()) + .props(HashMap::from([ + ("token".to_string(), "tok-secret".to_string()), + ("credential".to_string(), "id:cred-secret".to_string()), + ("header.authorization".to_string(), "Basic xyz".to_string()), + ("adls.account-key".to_string(), "adls-secret".to_string()), + ("s3.sse.key".to_string(), "sse-secret".to_string()), + ( + "adls.connection-string".to_string(), + "cs-secret".to_string(), + ), + ("warehouse".to_string(), "wh1".to_string()), + ])) + .build(); + + let out = format!("{config:?}"); + assert!(!out.contains("tok-secret")); + assert!(!out.contains("cred-secret")); + assert!(!out.contains("Basic xyz")); + assert!(!out.contains("adls-secret")); + assert!(!out.contains("sse-secret")); + assert!(!out.contains("cs-secret")); + assert!(out.contains("[REDACTED]")); + assert!(out.contains("wh1")); + } + #[test] fn test_unknown_auth_type_is_rejected() { let props = HashMap::from([( @@ -2247,7 +2408,7 @@ mod tests { struct StubAuthManager; #[async_trait] impl AuthManager for StubAuthManager { - async fn init_session(&self) -> Result> { + async fn init_session(&self) -> Result> { unimplemented!() } async fn catalog_session( diff --git a/crates/catalog/rest/src/client.rs b/crates/catalog/rest/src/client.rs index 2dc26cdb60..9c84536f28 100644 --- a/crates/catalog/rest/src/client.rs +++ b/crates/catalog/rest/src/client.rs @@ -42,9 +42,14 @@ pub(crate) struct HttpClient { impl Debug for HttpClient { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + // The inner client is omitted: an injected one may carry secrets in + // its default headers. f.debug_struct("HttpClient") - .field("client", &self.client) - .field("extra_headers", &self.extra_headers) + .field( + // `header.*` values may hold secrets (e.g. `authorization`). + "extra_headers", + &format_headers_redacted(&self.extra_headers, self.disable_header_redaction), + ) .finish_non_exhaustive() } } @@ -53,7 +58,7 @@ impl HttpClient { /// Create a new http client. pub async fn new(cfg: &RestCatalogConfig) -> Result { let auth_manager = cfg.resolve_auth_manager()?; - let session = auth_manager.init_session().await?; + let session = Arc::from(auth_manager.init_session().await?); Ok(HttpClient { client: cfg.client(), extra_headers: cfg.extra_headers()?, @@ -170,20 +175,21 @@ pub(crate) async fn deserialize_catalog_response( }) } -/// Headers that contain sensitive information and should be excluded from logs. -const SENSITIVE_HEADERS: &[&str] = &[ - "authorization", - "proxy-authorization", - "set-cookie", - "cookie", - "x-api-key", - "x-auth-token", -]; - -/// Returns true if the header name is considered sensitive. +/// Returns true if the header may carry a secret (matched by substring, so +/// e.g. `x-client-secret` is covered along with `authorization`). fn is_sensitive_header(name: &str) -> bool { let name_lower = name.to_lowercase(); - SENSITIVE_HEADERS.iter().any(|h| name_lower == *h) + [ + "auth", + "token", + "secret", + "key", + "password", + "cookie", + "credential", + ] + .iter() + .any(|pattern| name_lower.contains(pattern)) } /// Redacts sensitive headers and returns a debug-formatted string. @@ -265,6 +271,31 @@ mod tests { assert!(result.contains("abc123")); } + #[tokio::test] + async fn test_http_client_debug_redacts_headers() { + let config = RestCatalogConfig::builder() + .uri("http://localhost".to_string()) + .props(HashMap::from([ + ("header.authorization".to_string(), "Basic xyz".to_string()), + ( + "header.x-client-secret".to_string(), + "shh-secret".to_string(), + ), + ( + "header.x-client-credential".to_string(), + "cred-value".to_string(), + ), + ])) + .build(); + let client = HttpClient::new(&config).await.unwrap(); + + let out = format!("{client:?}"); + assert!(!out.contains("Basic xyz")); + assert!(!out.contains("shh-secret")); + assert!(!out.contains("cred-value")); + assert!(out.contains("[REDACTED]")); + } + #[test] fn test_format_headers_redacted_filters_sensitive() { let mut headers = HeaderMap::new(); From 315127303db2e1c35ec21144c390d5b0cee8add8 Mon Sep 17 00:00:00 2001 From: Li Jiajia Date: Thu, 30 Jul 2026 03:07:34 -0400 Subject: [PATCH 4/6] chore: sort rest catalog dependencies for taplo --- crates/catalog/rest/Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/catalog/rest/Cargo.toml b/crates/catalog/rest/Cargo.toml index 1541fe8200..33ab6a770c 100644 --- a/crates/catalog/rest/Cargo.toml +++ b/crates/catalog/rest/Cargo.toml @@ -36,13 +36,13 @@ http = { workspace = true } iceberg = { workspace = true } itertools = { workspace = true } reqwest = { workspace = true } -zeroize = { workspace = true } serde = { workspace = true } serde_derive = { workspace = true } serde_json = { workspace = true } tokio = { workspace = true } typed-builder = { workspace = true } uuid = { workspace = true, features = ["v4"] } +zeroize = { workspace = true } [dev-dependencies] bytes = { workspace = true } From 5be5c5fd3429ac68f6b2178e50b9168493ca8aea Mon Sep 17 00:00:00 2001 From: Li Jiajia Date: Thu, 30 Jul 2026 22:54:31 -0400 Subject: [PATCH 5/6] refactor(rest): address committer review - unset rest.auth.type resolves to oauth2 only when a token, credential or oauth2-server-uri is configured, none otherwise - drop RestCatalog::invalidate_token/regenerate_token and AuthSession::invalidate/refresh (out-of-box refresh tracked separately) - hint at with_auth_manager for unknown auth types --- crates/catalog/rest/public-api.txt | 5 - crates/catalog/rest/src/auth/mod.rs | 41 +--- crates/catalog/rest/src/auth/oauth2.rs | 40 +--- crates/catalog/rest/src/catalog.rs | 304 +++++++------------------ crates/catalog/rest/src/client.rs | 1 + 5 files changed, 96 insertions(+), 295 deletions(-) diff --git a/crates/catalog/rest/public-api.txt b/crates/catalog/rest/public-api.txt index e0beecd24a..d39fa416ac 100644 --- a/crates/catalog/rest/public-api.txt +++ b/crates/catalog/rest/public-api.txt @@ -249,9 +249,6 @@ pub fn iceberg_catalog_rest::RenameTableRequest::serialize<__S>(&self, __seriali impl<'de> serde_core::de::Deserialize<'de> for iceberg_catalog_rest::RenameTableRequest pub fn iceberg_catalog_rest::RenameTableRequest::deserialize<__D>(__deserializer: __D) -> core::result::Result::Error> where __D: serde_core::de::Deserializer<'de> pub struct iceberg_catalog_rest::RestCatalog -impl iceberg_catalog_rest::RestCatalog -pub async fn iceberg_catalog_rest::RestCatalog::invalidate_token(&self) -> iceberg::error::Result<()> -pub async fn iceberg_catalog_rest::RestCatalog::regenerate_token(&self) -> iceberg::error::Result<()> impl core::fmt::Debug for iceberg_catalog_rest::RestCatalog pub fn iceberg_catalog_rest::RestCatalog::fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result impl iceberg::catalog::Catalog for iceberg_catalog_rest::RestCatalog @@ -347,5 +344,3 @@ pub fn iceberg_catalog_rest::OAuth2Manager::catalog_session<'life0, 'life1, 'asy pub fn iceberg_catalog_rest::OAuth2Manager::init_session<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin>> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait pub trait iceberg_catalog_rest::AuthSession: core::fmt::Debug + core::marker::Send + core::marker::Sync pub fn iceberg_catalog_rest::AuthSession::authenticate<'life0, 'life1, 'life2, 'async_trait>(&'life0 self, request: &'life1 mut iceberg_catalog_rest::AuthRequest<'life2>) -> core::pin::Pin> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait -pub fn iceberg_catalog_rest::AuthSession::invalidate<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait -pub fn iceberg_catalog_rest::AuthSession::refresh<'life0, 'async_trait>(&'life0 self) -> core::pin::Pin> + core::marker::Send + 'async_trait)>> where Self: 'async_trait, 'life0: 'async_trait diff --git a/crates/catalog/rest/src/auth/mod.rs b/crates/catalog/rest/src/auth/mod.rs index fd2e9c7acb..9b06818a59 100644 --- a/crates/catalog/rest/src/auth/mod.rs +++ b/crates/catalog/rest/src/auth/mod.rs @@ -138,26 +138,6 @@ impl<'a> AuthRequestBody<'a> { pub trait AuthSession: Debug + Send + Sync { /// Applies authentication to the request (adds headers, signs, ...). async fn authenticate(&self, request: &mut AuthRequest<'_>) -> Result<()>; - - /// Drops any cached credentials so the next request re-authenticates. - /// - /// Backs the existing [`RestCatalog::invalidate_token`] API; not part of - /// the intended extension surface, and the default no-op is usually fine. - /// - /// [`RestCatalog::invalidate_token`]: crate::RestCatalog::invalidate_token - async fn invalidate(&self) -> Result<()> { - Ok(()) - } - - /// Proactively refreshes cached credentials (e.g. re-exchanges an OAuth2 - /// client credential for a new token), leaving them intact on failure. - /// - /// Like [`Self::invalidate`], backs [`RestCatalog::regenerate_token`]. - /// - /// [`RestCatalog::regenerate_token`]: crate::RestCatalog::regenerate_token - async fn refresh(&self) -> Result<()> { - Ok(()) - } } /// A secret string: `Debug` prints `[REDACTED]` and the memory is zeroized on @@ -222,14 +202,12 @@ mod tests { use super::*; #[tokio::test] - async fn test_static_token_session_lifecycle() { - // Token-only config: attach as-is; refresh keeps erroring (no - // credential to exchange); after invalidate, no auth is sent. + async fn test_static_token_session_attaches_token() { + // Token-only config: the token is attached as-is. let manager = OAuth2Manager::new("http://localhost/unused").with_token("tok-static"); let session = manager.init_session().await.unwrap(); - let client = Client::new(); - let mut req = client + let mut req = Client::new() .get("https://rest.example.com/v1/config") .build() .unwrap(); @@ -241,19 +219,6 @@ mod tests { req.headers().get("authorization").unwrap(), "Bearer tok-static" ); - - assert!(session.refresh().await.is_err()); - - session.invalidate().await.unwrap(); - let mut req = client - .get("https://rest.example.com/v1/config") - .build() - .unwrap(); - session - .authenticate(&mut AuthRequest::new(&mut req)) - .await - .unwrap(); - assert!(req.headers().get("authorization").is_none()); } #[test] diff --git a/crates/catalog/rest/src/auth/oauth2.rs b/crates/catalog/rest/src/auth/oauth2.rs index 4281ee3b62..45388f3739 100644 --- a/crates/catalog/rest/src/auth/oauth2.rs +++ b/crates/catalog/rest/src/auth/oauth2.rs @@ -192,12 +192,12 @@ impl OAuth2Manager { /// /// - a `credential` yields a [`ClientCredentialsSession`] (its token cache /// pre-seeded when a `token` is also set, and the token then takes - /// precedence until invalidated); + /// precedence over the credential); /// - otherwise a [`StaticTokenSession`], which attaches the configured /// token as-is — or nothing when none is set. /// /// Both share the manager's token cell, so a cached token survives the - /// config handshake and `invalidate` is observed by later sessions. + /// config handshake. fn build_session(&self, params: OAuth2Params) -> Box { match params.credential { Some(credential) => Box::new(ClientCredentialsSession { @@ -242,24 +242,11 @@ struct StaticTokenSession { #[async_trait] impl AuthSession for StaticTokenSession { async fn authenticate(&self, req: &mut AuthRequest<'_>) -> Result<()> { - // After `invalidate` there is nothing to fall back to: no auth is sent. match self.token.lock().await.clone() { Some(token) => attach_bearer(req, &token), None => Ok(()), } } - - async fn invalidate(&self) -> Result<()> { - *self.token.lock().await = None; - Ok(()) - } - - async fn refresh(&self) -> Result<()> { - Err(Error::new( - ErrorKind::DataInvalid, - "Credential must be provided for authentication", - )) - } } /// [`AuthSession`] implementing the OAuth2 client-credentials flow: exchanges @@ -353,8 +340,8 @@ impl ClientCredentialsSession { #[async_trait] impl AuthSession for ClientCredentialsSession { /// Uses the cached token when present (a configured `token` takes - /// precedence over the credential until invalidated); otherwise exchanges - /// the credential for a token, caches it, then uses it. + /// precedence over the credential); otherwise exchanges the credential + /// for a token, caches it, then uses it. async fn authenticate(&self, req: &mut AuthRequest<'_>) -> Result<()> { // The lock is held across the exchange: waiters reuse a successful // result, and retry themselves after a failure. @@ -373,23 +360,4 @@ impl AuthSession for ClientCredentialsSession { attach_bearer(req, &token) } - - /// Invalidate the current token without generating a new one. On the next - /// request, the session will attempt to generate a new token. - async fn invalidate(&self) -> Result<()> { - *self.token.lock().await = None; - Ok(()) - } - - /// Invalidate the current token and set a new one. Generates a new token - /// before invalidating the current one, meaning the old token will be used - /// until this function acquires the lock and overwrites the token. - /// - /// If credential is invalid, or the request fails, this method will return - /// an error and leave the current token unchanged. - async fn refresh(&self) -> Result<()> { - let new_token = self.exchange_credential_for_token().await?; - *self.token.lock().await = Some(new_token.into()); - Ok(()) - } } diff --git a/crates/catalog/rest/src/catalog.rs b/crates/catalog/rest/src/catalog.rs index 9495fc4b4f..7d3207f54a 100644 --- a/crates/catalog/rest/src/catalog.rs +++ b/crates/catalog/rest/src/catalog.rs @@ -56,7 +56,9 @@ pub const REST_CATALOG_PROP_WAREHOUSE: &str = "warehouse"; /// Disable header redaction in error logs and `Debug` output (defaults to /// false for security) pub const REST_CATALOG_PROP_DISABLE_HEADER_REDACTION: &str = "disable-header-redaction"; -/// Authentication scheme: `none` or `oauth2` (default). +/// Authentication scheme: `none` or `oauth2`. When unset, `oauth2` is used +/// if a `token`, `credential` or `oauth2-server-uri` is configured, `none` +/// otherwise. pub const REST_CATALOG_PROP_AUTH_TYPE: &str = "rest.auth.type"; const ICEBERG_REST_SPEC_VERSION: &str = "0.14.1"; @@ -346,14 +348,24 @@ impl RestCatalogConfig { .unwrap_or(false) } - /// The configured auth scheme: explicit `rest.auth.type` or the default - /// `oauth2` (which behaves as no auth when neither `token` nor - /// `credential` is set). + /// The configured auth scheme: explicit `rest.auth.type` when set; + /// otherwise `oauth2` when a `token`, `credential` or `oauth2-server-uri` + /// is configured (preserving pre-`rest.auth.type` setups), `none` when + /// none is. fn auth_type(&self) -> String { self.props .get(REST_CATALOG_PROP_AUTH_TYPE) .cloned() - .unwrap_or_else(|| AUTH_TYPE_OAUTH2.to_string()) + .unwrap_or_else(|| { + if self.token().is_some() + || self.credential().is_some() + || self.explicit_oauth2_server_uri().is_some() + { + AUTH_TYPE_OAUTH2.to_string() + } else { + AUTH_TYPE_NONE.to_string() + } + }) } /// Resolves the auth manager: a `with_auth_manager` override wins, @@ -367,7 +379,11 @@ impl RestCatalogConfig { AUTH_TYPE_OAUTH2 => Ok(Arc::new(OAuth2Manager::from_config(self)?)), other => Err(Error::new( ErrorKind::DataInvalid, - format!("unknown '{REST_CATALOG_PROP_AUTH_TYPE}': {other}"), + format!( + "unknown '{REST_CATALOG_PROP_AUTH_TYPE}': {other}; use \ + `RestCatalogBuilder::with_auth_manager` to inject a \ + custom auth manager" + ), )), } } @@ -682,28 +698,6 @@ impl RestCatalog { Ok(file_io) } - - /// Invalidate the current token without generating a new one. On the next request, the client - /// will attempt to generate a new token. - /// - /// Sessions that don't manage a token (e.g. with `rest.auth.type` `none`, - /// or a custom [`AuthManager`]) may treat this as a no-op. - pub async fn invalidate_token(&self) -> Result<()> { - self.context().await?.client.session().invalidate().await - } - - /// Invalidate the current token and set a new one. Generates a new token before invalidating - /// the current token, meaning the old token will be used until this function acquires the lock - /// and overwrites the token. - /// - /// If credential is invalid, or the request fails, this method will return an error and leave - /// the current token unchanged. - /// - /// Errors when the session has no credential to exchange (e.g. a static - /// token); a custom [`AuthManager`]'s session may treat this as a no-op. - pub async fn regenerate_token(&self) -> Result<()> { - self.context().await?.client.session().refresh().await - } } /// All requests and expected responses are derived from the REST catalog API spec: @@ -1581,152 +1575,6 @@ mod tests { assert_eq!(token, Some("ey000000000000".to_string())); } - #[tokio::test] - async fn test_invalidate_token() { - let mut server = Server::new_async().await; - let oauth_mock = create_oauth_mock(&mut server).await; - let config_mock = create_config_mock(&mut server).await; - - let mut props = HashMap::new(); - props.insert("credential".to_string(), "client1:secret1".to_string()); - - let catalog = RestCatalog::new( - RestCatalogConfig::builder() - .uri(server.url()) - .props(props) - .build(), - Some(Arc::new(LocalFsStorageFactory)), - Runtime::current(), - None, - ); - - let token = catalog.context().await.unwrap().client.token().await; - oauth_mock.assert_async().await; - config_mock.assert_async().await; - assert_eq!(token, Some("ey000000000000".to_string())); - - let oauth_mock = - create_oauth_mock_with_path(&mut server, "/v1/oauth/tokens", "ey000000000001", 200) - .await; - // The next request re-exchanges the credential and sends the new token. - let ns_mock = server - .mock("GET", "/v1/namespaces") - .match_header("authorization", "Bearer ey000000000001") - .with_body(r#"{"namespaces": []}"#) - .create_async() - .await; - catalog.invalidate_token().await.unwrap(); - catalog.list_namespaces(None).await.unwrap(); - oauth_mock.assert_async().await; - ns_mock.assert_async().await; - let token = catalog.context().await.unwrap().client.token().await; - assert_eq!(token, Some("ey000000000001".to_string())); - } - - #[tokio::test] - async fn test_invalidate_token_failing_request() { - let mut server = Server::new_async().await; - let oauth_mock = create_oauth_mock(&mut server).await; - let config_mock = create_config_mock(&mut server).await; - - let mut props = HashMap::new(); - props.insert("credential".to_string(), "client1:secret1".to_string()); - - let catalog = RestCatalog::new( - RestCatalogConfig::builder() - .uri(server.url()) - .props(props) - .build(), - Some(Arc::new(LocalFsStorageFactory)), - Runtime::current(), - None, - ); - - let token = catalog.context().await.unwrap().client.token().await; - oauth_mock.assert_async().await; - config_mock.assert_async().await; - assert_eq!(token, Some("ey000000000000".to_string())); - - let oauth_mock = - create_oauth_mock_with_path(&mut server, "/v1/oauth/tokens", "ey000000000001", 500) - .await; - catalog.invalidate_token().await.unwrap(); - // The failed re-exchange surfaces as an error and no token is cached. - assert!(catalog.list_namespaces(None).await.is_err()); - oauth_mock.assert_async().await; - let token = catalog.context().await.unwrap().client.token().await; - assert_eq!(token, None); - } - - #[tokio::test] - async fn test_regenerate_token() { - let mut server = Server::new_async().await; - let oauth_mock = create_oauth_mock(&mut server).await; - let config_mock = create_config_mock(&mut server).await; - - let mut props = HashMap::new(); - props.insert("credential".to_string(), "client1:secret1".to_string()); - - let catalog = RestCatalog::new( - RestCatalogConfig::builder() - .uri(server.url()) - .props(props) - .build(), - Some(Arc::new(LocalFsStorageFactory)), - Runtime::current(), - None, - ); - - let token = catalog.context().await.unwrap().client.token().await; - oauth_mock.assert_async().await; - config_mock.assert_async().await; - assert_eq!(token, Some("ey000000000000".to_string())); - - let oauth_mock = - create_oauth_mock_with_path(&mut server, "/v1/oauth/tokens", "ey000000000001", 200) - .await; - catalog.regenerate_token().await.unwrap(); - oauth_mock.assert_async().await; - let token = catalog.context().await.unwrap().client.token().await; - assert_eq!(token, Some("ey000000000001".to_string())); - } - - #[tokio::test] - async fn test_regenerate_token_failing_request() { - let mut server = Server::new_async().await; - let oauth_mock = create_oauth_mock(&mut server).await; - let config_mock = create_config_mock(&mut server).await; - - let mut props = HashMap::new(); - props.insert("credential".to_string(), "client1:secret1".to_string()); - - let catalog = RestCatalog::new( - RestCatalogConfig::builder() - .uri(server.url()) - .props(props) - .build(), - Some(Arc::new(LocalFsStorageFactory)), - Runtime::current(), - None, - ); - - let token = catalog.context().await.unwrap().client.token().await; - oauth_mock.assert_async().await; - config_mock.assert_async().await; - assert_eq!(token, Some("ey000000000000".to_string())); - - let oauth_mock = - create_oauth_mock_with_path(&mut server, "/v1/oauth/tokens", "ey000000000001", 500) - .await; - let invalidate_result = catalog.regenerate_token().await; - assert!(invalidate_result.is_err()); - oauth_mock.assert_async().await; - let token = catalog.context().await.unwrap().client.token().await; - - // original token is left intact - assert_eq!(token, Some("ey000000000000".to_string())); - } - #[tokio::test] async fn test_http_headers() { let server = Server::new_async().await; @@ -1985,9 +1833,9 @@ mod tests { async fn test_builtin_oauth_endpoint_follows_uri_override() { // When `/v1/config` overrides `uri` (and no explicit `oauth2-server-uri` // is set), the built-in manager's default token endpoint must follow - // the merged URI: a refresh after the handshake posts to the new host. + // the merged URI. let mut bootstrap = Server::new_async().await; - let mut overridden = Server::new_async().await; + let overridden = Server::new_async().await; let config_mock = bootstrap .mock("GET", "/v1/config") @@ -2001,9 +1849,6 @@ mod tests { // Handshake exchange still uses the bootstrap-derived default. let bootstrap_oauth_mock = create_oauth_mock_with_path(&mut bootstrap, "/v1/oauth/tokens", "tok-boot", 200).await; - // The refresh must follow the overridden URI. - let overridden_oauth_mock = - create_oauth_mock_with_path(&mut overridden, "/v1/oauth/tokens", "tok-new", 200).await; let props = HashMap::from([("credential".to_string(), "client1:secret1".to_string())]); let catalog = RestCatalog::new( @@ -2016,14 +1861,13 @@ mod tests { None, ); - catalog.context().await.unwrap(); - catalog.regenerate_token().await.unwrap(); - + let context = catalog.context().await.unwrap(); config_mock.assert_async().await; bootstrap_oauth_mock.assert_async().await; - overridden_oauth_mock.assert_async().await; - let token = catalog.context().await.unwrap().client.token().await; - assert_eq!(token, Some("tok-new".to_string())); + // The catalog session's endpoint follows the overridden URI (visible + // via the session's Debug, which prints its token endpoint). + let session_debug = format!("{:?}", context.client.session()); + assert!(session_debug.contains(&format!("{}/v1/oauth/tokens", overridden.url()))); } #[tokio::test] @@ -2068,21 +1912,22 @@ mod tests { } #[tokio::test] - async fn test_seeded_token_with_credential_exchanges_once_after_invalidate() { - // The seeded token is attached without an exchange; after - // invalidate() the credential is exchanged exactly once. + async fn test_seeded_token_takes_precedence_over_credential() { + // token + credential: the seeded token is attached without any + // credential exchange. let mut server = Server::new_async().await; - // create_oauth_mock_with_path expects exactly 1 hit. - let oauth_mock = - create_oauth_mock_with_path(&mut server, "/v1/oauth/tokens", "tok-new", 200).await; + let oauth_mock = server + .mock("POST", "/v1/oauth/tokens") + .expect(0) + .create_async() + .await; let manager = OAuth2Manager::new(format!("{}/v1/oauth/tokens", server.url())) .with_token("tok-seed") .with_credential(Some("client1".to_string()), "secret1".to_string()); let session = manager.init_session().await.unwrap(); - let client = Client::new(); - let mut req = client + let mut req = Client::new() .get("https://rest.example.com/v1/config") .build() .unwrap(); @@ -2095,20 +1940,6 @@ mod tests { "Bearer tok-seed" ); - session.invalidate().await.unwrap(); - let mut req = client - .get("https://rest.example.com/v1/config") - .build() - .unwrap(); - session - .authenticate(&mut crate::auth::AuthRequest::new(&mut req)) - .await - .unwrap(); - assert_eq!( - req.headers().get("authorization").unwrap(), - "Bearer tok-new" - ); - oauth_mock.assert_async().await; } @@ -2118,7 +1949,14 @@ mod tests { // headers and OAuth params across the config handshake: only explicit // properties may override them, never synthesized defaults. let mut server = Server::new_async().await; - let config_mock = create_config_mock(&mut server).await; + // The server vends the credential, so the exchange runs through the + // post-handshake catalog session (exercising its property merging). + let config_mock = server + .mock("GET", "/v1/config") + .with_status(200) + .with_body(r#"{"defaults": {"credential": "client1:secret1"}, "overrides": {}}"#) + .create_async() + .await; // The catalog-host default endpoint must never see the credential. let default_endpoint_mock = server @@ -2126,8 +1964,8 @@ mod tests { .expect(0) .create_async() .await; - // Both exchanges (handshake + regenerate) hit the injected endpoint, - // carrying the injected header and OAuth param. + // The exchange hits the injected endpoint, carrying the injected + // header and OAuth param. let custom_endpoint_mock = server .mock("POST", "/custom/oauth/tokens") .match_header("x-tenant", "t1") @@ -2146,12 +1984,16 @@ mod tests { "expires_in": 86400 }"#, ) - .expect(2) + .create_async() + .await; + let ns_mock = server + .mock("GET", "/v1/namespaces") + .match_header("authorization", "Bearer ey000000000000") + .with_body(r#"{"namespaces": []}"#) .create_async() .await; let manager = OAuth2Manager::new(format!("{}/custom/oauth/tokens", server.url())) - .with_credential(Some("client1".to_string()), "secret1".to_string()) .with_extra_headers(HeaderMap::from_iter([( HeaderName::from_static("x-tenant"), HeaderValue::from_static("t1"), @@ -2170,14 +2012,12 @@ mod tests { None, ); - // Handshake performs the first exchange; regenerate the second — both - // must use the injected endpoint/options. - catalog.context().await.unwrap(); - catalog.regenerate_token().await.unwrap(); + catalog.list_namespaces(None).await.unwrap(); config_mock.assert_async().await; custom_endpoint_mock.assert_async().await; default_endpoint_mock.assert_async().await; + ns_mock.assert_async().await; } #[tokio::test] @@ -2386,6 +2226,38 @@ mod tests { assert!(out.contains("wh1")); } + #[test] + fn test_auth_type_defaults() { + // Unset `rest.auth.type`: `oauth2` when any OAuth material is + // configured (existing setups keep working), `none` otherwise. + let bare = RestCatalogConfig::builder() + .uri("http://localhost".to_string()) + .build(); + assert!(format!("{:?}", bare.resolve_auth_manager().unwrap()).contains("NoopAuthManager")); + + let with_token = RestCatalogConfig::builder() + .uri("http://localhost".to_string()) + .props(HashMap::from([("token".to_string(), "tok".to_string())])) + .build(); + assert!( + format!("{:?}", with_token.resolve_auth_manager().unwrap()).contains("OAuth2Manager") + ); + + // An explicit OAuth endpoint is oauth2 intent too: the manager can + // still pick up a server-supplied token from `/v1/config`. + let with_endpoint = RestCatalogConfig::builder() + .uri("http://localhost".to_string()) + .props(HashMap::from([( + "oauth2-server-uri".to_string(), + "http://auth.example.com/tokens".to_string(), + )])) + .build(); + assert!( + format!("{:?}", with_endpoint.resolve_auth_manager().unwrap()) + .contains("OAuth2Manager") + ); + } + #[test] fn test_unknown_auth_type_is_rejected() { let props = HashMap::from([( diff --git a/crates/catalog/rest/src/client.rs b/crates/catalog/rest/src/client.rs index 9c84536f28..856ee5c6c9 100644 --- a/crates/catalog/rest/src/client.rs +++ b/crates/catalog/rest/src/client.rs @@ -103,6 +103,7 @@ impl HttpClient { } /// The session authenticating requests in the current phase. + #[cfg(test)] pub(crate) fn session(&self) -> &Arc { &self.session } From 4b2fa37f17deb728e0c6b9492e41f8a4778a52cd Mon Sep 17 00:00:00 2001 From: Li Jiajia Date: Fri, 31 Jul 2026 00:31:23 -0400 Subject: [PATCH 6/6] feat(rest): warn when inferring oauth2 from legacy auth properties --- Cargo.lock | 1 + crates/catalog/rest/Cargo.toml | 1 + crates/catalog/rest/src/catalog.rs | 11 ++++++++++- 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/Cargo.lock b/Cargo.lock index 1762aeb6d2..e6c1ddb1d5 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -3896,6 +3896,7 @@ dependencies = [ "serde_derive", "serde_json", "tokio", + "tracing", "typed-builder", "uuid", "zeroize", diff --git a/crates/catalog/rest/Cargo.toml b/crates/catalog/rest/Cargo.toml index 33ab6a770c..deafb46083 100644 --- a/crates/catalog/rest/Cargo.toml +++ b/crates/catalog/rest/Cargo.toml @@ -40,6 +40,7 @@ serde = { workspace = true } serde_derive = { workspace = true } serde_json = { workspace = true } tokio = { workspace = true } +tracing = { workspace = true } typed-builder = { workspace = true } uuid = { workspace = true, features = ["v4"] } zeroize = { workspace = true } diff --git a/crates/catalog/rest/src/catalog.rs b/crates/catalog/rest/src/catalog.rs index 7d3207f54a..7fb60afedd 100644 --- a/crates/catalog/rest/src/catalog.rs +++ b/crates/catalog/rest/src/catalog.rs @@ -374,7 +374,16 @@ impl RestCatalogConfig { if let Some(auth_manager) = &self.auth_manager { return Ok(auth_manager.clone()); } - match self.auth_type().as_str() { + let auth_type = self.auth_type(); + // Java parity (`AuthManagers`): make the inference visible so users + // configure the type explicitly. + if auth_type == AUTH_TYPE_OAUTH2 && !self.props.contains_key(REST_CATALOG_PROP_AUTH_TYPE) { + tracing::warn!( + "Inferring {REST_CATALOG_PROP_AUTH_TYPE}={AUTH_TYPE_OAUTH2} from the configured \ + OAuth properties; set it explicitly to avoid this warning" + ); + } + match auth_type.as_str() { AUTH_TYPE_NONE => Ok(Arc::new(NoopAuthManager)), AUTH_TYPE_OAUTH2 => Ok(Arc::new(OAuth2Manager::from_config(self)?)), other => Err(Error::new(