DerGut commented on code in PR #2838: URL: https://github.com/apache/iceberg-rust/pull/2838#discussion_r3758861476
########## crates/catalog/rest/src/auth/mod.rs: ########## @@ -0,0 +1,251 @@ +// 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::{Client, 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`. It +/// builds the sessions the catalog then keeps. +/// +/// Both methods are handed the catalog's HTTP client, which an implementation +/// may reuse for its own requests (e.g. a token exchange) so that they share +/// the catalog's connection pool. +#[async_trait] +pub trait AuthManager: Debug + Send + Sync { + /// Session used for the initial `/v1/config` handshake, given the + /// user-supplied properties. + /// + /// Returns a [`Box`]: an init session is used once and released, unlike + /// the shared [`AuthManager::catalog_session`]. + async fn init_session( + &self, + client: &Client, + props: &HashMap<String, String>, + ) -> Result<Box<dyn AuthSession>>; + + /// Session used for all subsequent catalog requests, given the properties + /// merged from the user configuration and the server's config response. + /// + /// 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, + client: &Client, + props: &HashMap<String, String>, + ) -> Result<Arc<dyn AuthSession>>; +} + +/// An outgoing REST request being authenticated by an [`AuthSession`]. +/// +/// Wraps the request so an [`AuthSession`] mutates it through the stable +/// `http` crate types rather than the concrete request type the REST catalog +/// uses internally. +pub struct HttpRequest<'a> { Review Comment: There's also the `client.rs`, we could merge the two into an `http.rs`. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
