// Copyright 2024 RustFS Team // // Licensed 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 rustfs_policy::auth::UserIdentity; use std::net::IpAddr; #[cfg(test)] use std::net::Ipv4Addr; use std::sync::Arc; /// Protocol types #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub enum Protocol { Ftps, Swift, WebDav, Sftp, } /// Protocol principal representing an authenticated user #[derive(Debug, Clone)] pub struct ProtocolPrincipal { /// User identity from IAM system pub user_identity: Arc, } impl ProtocolPrincipal { pub fn new(user_identity: Arc) -> Self { Self { user_identity } } pub fn access_key(&self) -> &str { &self.user_identity.credentials.access_key } } /// Session context for protocol operations #[derive(Debug, Clone)] pub struct SessionContext { /// The protocol principal (authenticated user) pub principal: ProtocolPrincipal, /// The protocol type pub protocol: Protocol, /// The source IP address pub source_ip: IpAddr, } impl SessionContext { /// Create a new session context pub fn new(principal: ProtocolPrincipal, protocol: Protocol, source_ip: IpAddr) -> Self { Self { principal, protocol, source_ip, } } /// Get the access key for this session pub fn access_key(&self) -> &str { self.principal.access_key() } } /// Build a SessionContext suitable for driver-level unit tests. The /// principal has an empty access key and an empty secret key. Auth /// decisions in tests come from the gateway test override, not from /// these credentials. The fields are inspected only when a test /// specifically asserts on them. Callers pick the Protocol variant /// that matches the driver under test. #[cfg(test)] pub fn test_session(protocol: Protocol) -> SessionContext { let principal = ProtocolPrincipal::new(Arc::new(UserIdentity::default())); SessionContext::new(principal, protocol, IpAddr::V4(Ipv4Addr::LOCALHOST)) } #[cfg(test)] mod regression_prevention { use super::*; // Compile-time check that every Protocol variant is acknowledged here. // This is intentionally an exhaustive match with no wildcard arm: if a // variant is added without being named, or if any variant is removed, // this test file will fail to compile. #[test] fn protocol_variants_are_named() { fn _check(protocol: Protocol) { match protocol { Protocol::Ftps => {} Protocol::Swift => {} Protocol::WebDav => {} Protocol::Sftp => {} } } } #[test] fn test_session_carries_supplied_protocol() { assert_eq!(test_session(Protocol::Sftp).protocol, Protocol::Sftp); assert_eq!(test_session(Protocol::Ftps).protocol, Protocol::Ftps); } }