From ccbd97b8362b52fa344621b0b844a1df97a37f7d Mon Sep 17 00:00:00 2001 From: selfhoster1312 Date: Sat, 19 Sep 2026 14:39:01 +0200 Subject: [PATCH] feat: Type-erase Database backend for simpler code --- Cargo.lock | 12 ++++++++++ Cargo.toml | 1 + src/db/common.rs | 12 +++++----- src/db/filesystem.rs | 29 ++++++++++-------------- src/db/interface.rs | 33 +++++++++++---------------- src/db/memory.rs | 52 ++++++++++++++++++------------------------- src/http/domain.rs | 8 +++---- src/http/home.rs | 4 ++-- src/http/login.rs | 12 +++++----- src/http/logout.rs | 5 ++--- src/http/mod.rs | 12 +++++----- src/http/session.rs | 10 ++++----- src/http/user.rs | 4 ++-- src/ldap/handler.rs | 8 +++---- src/ldap/op/bind.rs | 6 ++--- src/ldap/op/search.rs | 4 ++-- src/main.rs | 13 +++++------ 17 files changed, 108 insertions(+), 117 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 642d24c..bd10531 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -39,6 +39,17 @@ dependencies = [ "serde", ] +[[package]] +name = "async-trait" +version = "0.1.92" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82f6aeea286b8eb4dd3431a1be1b59d290ace00f5bfd8e2a159bc2a05e2c1667" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.4", +] + [[package]] name = "atomic-waker" version = "1.1.2" @@ -523,6 +534,7 @@ name = "llldap" version = "0.1.0" dependencies = [ "argh", + "async-trait", "axum", "axum-extra", "camino", diff --git a/Cargo.toml b/Cargo.toml index 2d31050..07c7928 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,6 +5,7 @@ edition = "2024" [dependencies] argh = "0.1.19" +async-trait = "0.1.92" axum = { version = "0.8.9", optional = true, features = ["macros"] } axum-extra = { version = "0.12.6", features = ["cookie"], optional = true } camino = { version = "1.2.5", features = ["serde1"] } diff --git a/src/db/common.rs b/src/db/common.rs index f7408c6..3a5f655 100644 --- a/src/db/common.rs +++ b/src/db/common.rs @@ -6,19 +6,19 @@ use crate::db::error::BoxedError; use crate::db::{DatabaseInterface, Domain, User, UserRef}; #[derive(Clone, Debug)] -pub struct Database { - pub inner: Arc>, +pub struct Database { + pub inner: Arc>>, } -impl Database { - pub fn new(db: D) -> Self { +impl Database { + pub fn new(db: impl DatabaseInterface) -> Self { Self { - inner: Arc::new(RwLock::new(db)), + inner: Arc::new(RwLock::new(Box::new(db))), } } } -impl Database { +impl Database { /// Return false if the user doesn't exist, or the password is wrong. /// /// TODO: should we return something else when the account doesn't exist? diff --git a/src/db/filesystem.rs b/src/db/filesystem.rs index 71fef14..2cdb435 100644 --- a/src/db/filesystem.rs +++ b/src/db/filesystem.rs @@ -45,7 +45,7 @@ pub struct FilesystemDatabase { } impl FilesystemDatabase { - pub async fn from_path(path: impl AsRef) -> Result, BoxedError> { + pub async fn from_path(path: impl AsRef) -> Result { let path = path.as_ref(); let s = tokio::fs::read(path) .await @@ -67,6 +67,7 @@ impl FilesystemDatabase { } } +#[async_trait::async_trait] impl DatabaseInterface for FilesystemDatabase { async fn create_domain( &mut self, @@ -84,15 +85,12 @@ impl DatabaseInterface for FilesystemDatabase { Ok(Ok(())) } - fn get_domain(&self, domain: &str) -> impl Future, BoxedError>> { - self.inner.get_domain(domain) + async fn get_domain(&self, domain: &str) -> Result, BoxedError> { + self.inner.get_domain(domain).await } - fn get_user( - &self, - req_user: &UserRef, - ) -> impl Future, BoxedError>> { - self.inner.get_user(req_user) + async fn get_user(&self, req_user: &UserRef) -> Result, BoxedError> { + self.inner.get_user(req_user).await } async fn create_user( @@ -128,18 +126,15 @@ impl DatabaseInterface for FilesystemDatabase { Ok(Ok(())) } - fn list_all_domains(&self) -> impl Future, BoxedError>> { - self.inner.list_all_domains() + async fn list_all_domains(&self) -> Result, BoxedError> { + self.inner.list_all_domains().await } - fn list_all_users(&self) -> impl Future, BoxedError>> { - self.inner.list_all_users() + async fn list_all_users(&self) -> Result, BoxedError> { + self.inner.list_all_users().await } - fn list_domain_users( - &self, - domain: Option, - ) -> impl Future, BoxedError>> { - self.inner.list_domain_users(domain) + async fn list_domain_users(&self, domain: Option) -> Result, BoxedError> { + self.inner.list_domain_users(domain).await } } diff --git a/src/db/interface.rs b/src/db/interface.rs index c434ec5..6115f39 100644 --- a/src/db/interface.rs +++ b/src/db/interface.rs @@ -1,7 +1,8 @@ use crate::db::error::{BoxedError, DomainCreationError, UserCreationError}; use crate::db::{Database, Domain, User, UserRef}; -impl DatabaseInterface for Database { +#[async_trait::async_trait] +impl DatabaseInterface for Database { async fn create_domain( &mut self, domain: &str, @@ -49,39 +50,31 @@ impl DatabaseInterface for Database { } } -pub trait DatabaseInterface: Clone + Send + Sync + 'static { - fn create_domain( +#[async_trait::async_trait] +pub trait DatabaseInterface: std::fmt::Debug + Send + Sync + 'static { + async fn create_domain( &mut self, domain: &str, - ) -> impl Future, BoxedError>> + Send; - fn get_domain( - &self, - domain: &str, - ) -> impl Future, BoxedError>> + Send; + ) -> Result, BoxedError>; + async fn get_domain(&self, domain: &str) -> Result, BoxedError>; - fn get_user( - &self, - user: &UserRef, - ) -> impl Future, BoxedError>> + Send; + async fn get_user(&self, user: &UserRef) -> Result, BoxedError>; async fn create_user( &mut self, user: User, ) -> Result, BoxedError>; - fn try_create_user( + async fn try_create_user( &mut self, new_user: User, current_user: &User, - ) -> impl Future, BoxedError>> + Send; + ) -> Result, BoxedError>; - fn list_all_domains(&self) -> impl Future, BoxedError>> + Send; + async fn list_all_domains(&self) -> Result, BoxedError>; #[expect(unused)] - fn list_all_users(&self) -> impl Future, BoxedError>> + Send; + async fn list_all_users(&self) -> Result, BoxedError>; /// List users on a specific domain. /// /// A `None` domain requested lists global service users. - fn list_domain_users( - &self, - domain: Option, - ) -> impl Future, BoxedError>> + Send; + async fn list_domain_users(&self, domain: Option) -> Result, BoxedError>; } diff --git a/src/db/memory.rs b/src/db/memory.rs index 4ef39e4..bae3c8e 100644 --- a/src/db/memory.rs +++ b/src/db/memory.rs @@ -1,7 +1,5 @@ use serde::{Deserialize, Serialize}; -use std::future::ready; - use crate::db::error::{BoxedError, DomainCreationError, UserCreationError}; use crate::db::{Database, DatabaseInterface, Domain, Group, Operation, User, UserRef}; @@ -14,52 +12,49 @@ pub struct MemoryDatabase { } impl MemoryDatabase { - pub fn new() -> Database { + #[allow(clippy::new_ret_no_self)] + pub fn new() -> Database { Database::new(Self::default()) } } +#[async_trait::async_trait] impl DatabaseInterface for MemoryDatabase { - fn create_domain( + async fn create_domain( &mut self, domain: &str, - ) -> impl Future, BoxedError>> { + ) -> Result, BoxedError> { if domain.is_empty() { - return ready(Ok(Err(DomainCreationError::InvalidDomain( - domain.to_string(), - )))); + return Ok(Err(DomainCreationError::InvalidDomain(domain.to_string()))); } if self.domains.iter().find(|d| d.name == domain).is_some() { - return ready(Ok(Err(DomainCreationError::DomainAlreadyExists( + return Ok(Err(DomainCreationError::DomainAlreadyExists( domain.to_string(), - )))); + ))); } self.domains.push(Domain { name: domain.to_string(), }); - ready(Ok(Ok(()))) + Ok(Ok(())) } - fn get_domain(&self, domain: &str) -> impl Future, BoxedError>> { + async fn get_domain(&self, domain: &str) -> Result, BoxedError> { let Some(domain) = self.domains.iter().find(|d| d.name == domain) else { - return ready(Ok(None)); + return Ok(None); }; - ready(Ok(Some(domain.clone()))) + Ok(Some(domain.clone())) } - fn get_user( - &self, - req_user: &UserRef, - ) -> impl Future, BoxedError>> { - ready(Ok(self + async fn get_user(&self, req_user: &UserRef) -> Result, BoxedError> { + Ok(self .users .iter() .find(|u| u.username == req_user.username && u.domain == req_user.domain) - .cloned())) + .cloned()) } async fn create_user( @@ -104,23 +99,20 @@ impl DatabaseInterface for MemoryDatabase { self.create_user(new_user).await } - fn list_all_domains(&self) -> impl Future, BoxedError>> { - ready(Ok(self.domains.clone())) + async fn list_all_domains(&self) -> Result, BoxedError> { + Ok(self.domains.clone()) } - fn list_all_users(&self) -> impl Future, BoxedError>> { - ready(Ok(self.users.clone())) + async fn list_all_users(&self) -> Result, BoxedError> { + Ok(self.users.clone()) } - fn list_domain_users( - &self, - domain: Option, - ) -> impl Future, BoxedError>> { - ready(Ok(self + async fn list_domain_users(&self, domain: Option) -> Result, BoxedError> { + Ok(self .users .iter() .filter(|u| u.domain == domain) .cloned() - .collect())) + .collect()) } } diff --git a/src/http/domain.rs b/src/http/domain.rs index 1acfdbb..4c05af0 100644 --- a/src/http/domain.rs +++ b/src/http/domain.rs @@ -7,8 +7,8 @@ use serde::Deserialize; use crate::db::{DatabaseInterface, Operation}; use crate::http::{HttpSession, HttpState}; -pub async fn get_domain( - State(state): State>, +pub async fn get_domain( + State(state): State, session: HttpSession, Path(domain): Path, ) -> Response { @@ -53,8 +53,8 @@ pub struct DomainCreationForm { domainname: String, } -pub async fn create_domain( - State(mut state): State>, +pub async fn create_domain( + State(mut state): State, session: HttpSession, Form(form): Form, ) -> Response { diff --git a/src/http/home.rs b/src/http/home.rs index febb6b0..32802b0 100644 --- a/src/http/home.rs +++ b/src/http/home.rs @@ -6,8 +6,8 @@ use minijinja::context; use crate::db::{DatabaseInterface, Operation}; use crate::http::{HttpSession, HttpState}; -pub async fn home( - State(state): State>, +pub async fn home( + State(state): State, // Only logged in users are allowed here session: HttpSession, ) -> Response { diff --git a/src/http/login.rs b/src/http/login.rs index 8b4a26d..578b5ff 100644 --- a/src/http/login.rs +++ b/src/http/login.rs @@ -20,8 +20,8 @@ pub enum LoginError { SessionInvalidated, } -pub async fn login_page( - State(state): State>, +pub async fn login_page( + State(state): State, login_error: Option, ) -> Response { let page = state @@ -33,8 +33,8 @@ pub async fn login_page( (StatusCode::OK, Html(page)).into_response() } -pub async fn get_login( - State(state): State>, +pub async fn get_login( + State(state): State, maybe_session: Option, ) -> Response { if maybe_session.is_some() { @@ -44,8 +44,8 @@ pub async fn get_login( login_page(State(state), None).await } -pub async fn post_login( - State(state): State>, +pub async fn post_login( + State(state): State, session: Option, cookies: CookieJar, Form(form): Form, diff --git a/src/http/logout.rs b/src/http/logout.rs index c742074..3dc5151 100644 --- a/src/http/logout.rs +++ b/src/http/logout.rs @@ -2,12 +2,11 @@ use axum::extract::State; use axum::response::{IntoResponse, Redirect, Response}; use axum_extra::extract::cookie::CookieJar; -use crate::db::DatabaseInterface; use crate::http::login::{LoginError, login_page}; use crate::http::{HttpState, OptionalHttpSession}; -pub async fn logout( - State(state): State>, +pub async fn logout( + State(state): State, session: Option, cookies: CookieJar, ) -> Response { diff --git a/src/http/mod.rs b/src/http/mod.rs index 17c9448..daf1507 100644 --- a/src/http/mod.rs +++ b/src/http/mod.rs @@ -9,7 +9,7 @@ use static_serve::embed_assets; #[cfg(not(feature = "embed"))] use tower_http::services::ServeDir; -use crate::db::{Database, DatabaseInterface}; +use crate::db::Database; use crate::listener::{Listener, ListenerKind}; use crate::stream::{AbstractSocketAddr, AbstractStreamKind}; @@ -62,14 +62,14 @@ impl AxumListener for Listener { } #[derive(Clone)] -pub struct HttpState { - pub db: Database, +pub struct HttpState { + pub db: Database, pub sessions: HttpSessionManager, pub templates: Environment<'static>, } -impl HttpState { - pub fn new(db: Database) -> Self { +impl HttpState { + pub fn new(db: Database) -> Self { let mut templates = Environment::new(); #[cfg(feature = "embed")] minijinja_embed::load_templates!(&mut templates); @@ -83,7 +83,7 @@ impl HttpState { } } -pub async fn http_listen(listener: Listener, db: Database) { +pub async fn http_listen(listener: Listener, db: Database) { #[cfg(all(feature = "embed", feature = "noembed"))] compile_error!("You cannot have `embed` and `noembed` features enabled at the same time."); #[cfg(not(any(feature = "embed", feature = "noembed")))] diff --git a/src/http/session.rs b/src/http/session.rs index 5005b8c..1f88874 100644 --- a/src/http/session.rs +++ b/src/http/session.rs @@ -6,7 +6,7 @@ use uuid::Uuid; use std::sync::{Arc, RwLock}; -use crate::db::{DatabaseInterface, User}; +use crate::db::User; use crate::http::HttpState; pub const COOKIE_NAME: &str = "lldap_session"; @@ -83,12 +83,12 @@ impl PartialEq for HttpSession { } } -impl FromRequestParts> for HttpSession { +impl FromRequestParts for HttpSession { type Rejection = Redirect; async fn from_request_parts( parts: &mut Parts, - state: &HttpState, + state: &HttpState, ) -> Result { let cookies = CookieJar::from_request_parts(parts, state).await.unwrap(); state @@ -108,12 +108,12 @@ impl std::ops::Deref for OptionalHttpSession { } } -impl OptionalFromRequestParts> for OptionalHttpSession { +impl OptionalFromRequestParts for OptionalHttpSession { type Rejection = Redirect; async fn from_request_parts( parts: &mut Parts, - state: &HttpState, + state: &HttpState, ) -> Result, Self::Rejection> { let maybe_session = HttpSession::from_request_parts(parts, state) .await diff --git a/src/http/user.rs b/src/http/user.rs index 2d0d385..00fd976 100644 --- a/src/http/user.rs +++ b/src/http/user.rs @@ -12,8 +12,8 @@ pub struct UserCreationForm { pub password: String, } -pub async fn create_user( - State(mut state): State>, +pub async fn create_user( + State(mut state): State, session: HttpSession, Form(form): Form, ) -> Response { diff --git a/src/ldap/handler.rs b/src/ldap/handler.rs index 32d2ac0..084cfa5 100644 --- a/src/ldap/handler.rs +++ b/src/ldap/handler.rs @@ -1,13 +1,13 @@ use ldap3_proto::LdapMsg; use ldap3_proto::proto::LdapOp; -use crate::db::{Database, DatabaseInterface}; +use crate::db::Database; use crate::ldap::{ LdapClientState, LdapStream, LdapStreamError, op_bind, op_ext, search_by_mail_filter, }; #[tracing::instrument(name = "ldap", skip(stream, db), fields(session = %stream.session))] -pub async fn ldap_handler(mut stream: LdapStream, mut db: Database) { +pub async fn ldap_handler(mut stream: LdapStream, mut db: Database) { tracing::info! { remote_addr = ?stream.remote_addr, "New client connection" @@ -45,11 +45,11 @@ pub async fn ldap_handler(mut stream: LdapStream, mut db: /// Return true to keep the connection going, false to close it. #[tracing::instrument(name = "ldap-handler", skip(client_state, db, stream))] -pub async fn ldap_handler_inner( +pub async fn ldap_handler_inner( stream: &mut LdapStream, msg: LdapMsg, client_state: &mut LdapClientState, - db: &mut Database, + db: &mut Database, ) -> Result { tracing::debug!(msg = ?msg, "Received LDAP message"); match msg { diff --git a/src/ldap/op/bind.rs b/src/ldap/op/bind.rs index fabdfa6..144efaa 100644 --- a/src/ldap/op/bind.rs +++ b/src/ldap/op/bind.rs @@ -2,7 +2,7 @@ use ldap3_proto::proto::{LdapBindCred, LdapBindRequest, LdapBindResponse, LdapOp use ldap3_proto::{LdapMsg, LdapResultCode}; use crate::db::error::BoxedError; -use crate::db::{Database, DatabaseInterface, UserRef}; +use crate::db::{Database, UserRef}; use crate::ldap::{Dn, LdapReturnError, LdapStream, LdapStreamError, MalformedDn}; #[derive(Debug)] @@ -165,9 +165,9 @@ pub async fn bind_success(stream: &mut LdapStream, msgid: i32) -> Result<(), Lda /// /// On success, returns `Ok(Some(bound_dn))`. `Ok(None)` means credentials failed, /// either because the account does not exist, or the password is wrong. -pub async fn op_bind( +pub async fn op_bind( stream: &mut LdapStream, - db: &Database, + db: &Database, req: LdapBindRequest, msgid: i32, ) -> Result, LdapStreamError> { diff --git a/src/ldap/op/search.rs b/src/ldap/op/search.rs index 9182fdb..d881508 100644 --- a/src/ldap/op/search.rs +++ b/src/ldap/op/search.rs @@ -174,9 +174,9 @@ fn search_entry_from_user(user: &User, req_attrs: &[String]) -> LdapSearchResult } } -pub async fn search_by_mail_filter( +pub async fn search_by_mail_filter( stream: &mut LdapStream, - db: &Database, + db: &Database, sr: LdapSearchRequest, msgid: i32, ) -> Result<(), LdapStreamError> { diff --git a/src/main.rs b/src/main.rs index 91a8415..ac42c60 100644 --- a/src/main.rs +++ b/src/main.rs @@ -17,7 +17,7 @@ use error::GlobalError; use ldap::ldap_handler; use listener::ListenerPath; -async fn create_dummy_users(db: &mut Database) { +async fn create_dummy_users(db: &mut Database) { db.create_user(User { username: "admin".to_string(), domain: None, @@ -69,12 +69,11 @@ async fn main() -> Result<(), GlobalError> { let ldap_listener = ListenerPath::new(&cli.listen_ldap)?.listener().await?; - // let mut db = if let Some(db_path) = &cli.db { - // FilesystemDatabase::from_path(db_path).await.unwrap() - // } else { - // MemoryDatabase::new() - // }; - let mut db = MemoryDatabase::new(); + let mut db = if let Some(db_path) = &cli.db { + FilesystemDatabase::from_path(db_path).await.unwrap() + } else { + MemoryDatabase::new() + }; create_dummy_users(&mut db).await; #[cfg(feature = "http")]