From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id E87A899D18 for ; Tue, 14 Nov 2023 14:01:08 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 52C6630161 for ; Tue, 14 Nov 2023 14:00:24 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Tue, 14 Nov 2023 14:00:16 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id B5EE9429A5 for ; Tue, 14 Nov 2023 14:00:16 +0100 (CET) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Tue, 14 Nov 2023 13:59:19 +0100 Message-Id: <20231114130000.565122-12-l.wagner@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20231114130000.565122-1-l.wagner@proxmox.com> References: <20231114130000.565122-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.062 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment PROLO_LEO1 0.1 Meta Catches all Leo drug variations so far SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pve-devel] [PATCH v2 proxmox 11/52] notify: add PVE/PBS context X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 14 Nov 2023 13:01:09 -0000 This commit moves PVEContext from `proxmox-perl-rs` into the `proxmox-notify` crate, since we now also need to access it from `promxox-mail-forward`. The context is now hidden behind a feature flag `pve-context`, ensuring that we only compile it when needed. This commit adds PBSContext, since we now require it for `proxmox-mail-forward`. Some of the code for PBSContext comes from `proxmox-mail-forward`. This commit also changes the global context from being stored in a `once_cell` to a regular `Mutex`, since we now need to set/reset the context in `proxmox-mail-forward`. Signed-off-by: Lukas Wagner --- Notes: Changes v2 -> v3: - no changes proxmox-notify/Cargo.toml | 3 +- proxmox-notify/src/context.rs | 21 ----- proxmox-notify/src/context/common.rs | 27 ++++++ proxmox-notify/src/context/mod.rs | 36 ++++++++ proxmox-notify/src/context/pbs.rs | 130 +++++++++++++++++++++++++++ proxmox-notify/src/context/pve.rs | 82 +++++++++++++++++ 6 files changed, 277 insertions(+), 22 deletions(-) delete mode 100644 proxmox-notify/src/context.rs create mode 100644 proxmox-notify/src/context/common.rs create mode 100644 proxmox-notify/src/context/mod.rs create mode 100644 proxmox-notify/src/context/pbs.rs create mode 100644 proxmox-notify/src/context/pve.rs diff --git a/proxmox-notify/Cargo.toml b/proxmox-notify/Cargo.toml index f2b4db5..7a3d434 100644 --- a/proxmox-notify/Cargo.toml +++ b/proxmox-notify/Cargo.toml @@ -13,7 +13,6 @@ handlebars = { workspace = true } lazy_static.workspace = true log.workspace = true mail-parser = { workspace = true, optional = true } -once_cell.workspace = true openssl.workspace = true proxmox-http = { workspace = true, features = ["client-sync"], optional = true } proxmox-http-error.workspace = true @@ -32,3 +31,5 @@ default = ["sendmail", "gotify"] mail-forwarder = ["dep:mail-parser"] sendmail = ["dep:proxmox-sys"] gotify = ["dep:proxmox-http"] +pve-context = ["dep:proxmox-sys"] +pbs-context = ["dep:proxmox-sys"] diff --git a/proxmox-notify/src/context.rs b/proxmox-notify/src/context.rs deleted file mode 100644 index 370c7ee..0000000 --- a/proxmox-notify/src/context.rs +++ /dev/null @@ -1,21 +0,0 @@ -use std::fmt::Debug; - -use once_cell::sync::OnceCell; - -pub trait Context: Send + Sync + Debug { - fn lookup_email_for_user(&self, user: &str) -> Option; - fn default_sendmail_author(&self) -> String; - fn default_sendmail_from(&self) -> String; - fn http_proxy_config(&self) -> Option; -} - -static CONTEXT: OnceCell<&'static dyn Context> = OnceCell::new(); - -pub fn set_context(context: &'static dyn Context) { - CONTEXT.set(context).expect("context has already been set"); -} - -#[allow(unused)] // context is not used if all endpoint features are disabled -pub(crate) fn context() -> &'static dyn Context { - *CONTEXT.get().expect("context has not been yet") -} diff --git a/proxmox-notify/src/context/common.rs b/proxmox-notify/src/context/common.rs new file mode 100644 index 0000000..7580bd1 --- /dev/null +++ b/proxmox-notify/src/context/common.rs @@ -0,0 +1,27 @@ +use std::path::Path; + +pub(crate) fn attempt_file_read>(path: P) -> Option { + match proxmox_sys::fs::file_read_optional_string(path) { + Ok(contents) => contents, + Err(err) => { + log::error!("{err}"); + None + } + } +} + +pub(crate) fn lookup_datacenter_config_key(content: &str, key: &str) -> Option { + let key_prefix = format!("{key}:"); + normalize_for_return( + content + .lines() + .find_map(|line| line.strip_prefix(&key_prefix)), + ) +} + +pub(crate) fn normalize_for_return(s: Option<&str>) -> Option { + match s?.trim() { + "" => None, + s => Some(s.to_string()), + } +} diff --git a/proxmox-notify/src/context/mod.rs b/proxmox-notify/src/context/mod.rs new file mode 100644 index 0000000..99d86de --- /dev/null +++ b/proxmox-notify/src/context/mod.rs @@ -0,0 +1,36 @@ +use std::fmt::Debug; +use std::sync::Mutex; + +#[cfg(any(feature = "pve-context", feature = "pbs-context"))] +pub mod common; +#[cfg(feature = "pbs-context")] +pub mod pbs; +#[cfg(feature = "pve-context")] +pub mod pve; + +/// Product-specific context +pub trait Context: Send + Sync + Debug { + /// Look up a user's email address from users.cfg + fn lookup_email_for_user(&self, user: &str) -> Option; + /// Default mail author for mail-based targets + fn default_sendmail_author(&self) -> String; + /// Default from address for sendmail-based targets + fn default_sendmail_from(&self) -> String; + /// Proxy configuration for the current node + fn http_proxy_config(&self) -> Option; +} + +static CONTEXT: Mutex> = Mutex::new(None); + +/// Set the product-specific context +pub fn set_context(context: &'static dyn Context) { + *CONTEXT.lock().unwrap() = Some(context); +} + +/// Get product-specific context. +/// +/// Panics if the context has not been set yet. +#[allow(unused)] // context is not used if all endpoint features are disabled +pub(crate) fn context() -> &'static dyn Context { + (*CONTEXT.lock().unwrap()).expect("context for proxmox-notify has not been set yet") +} diff --git a/proxmox-notify/src/context/pbs.rs b/proxmox-notify/src/context/pbs.rs new file mode 100644 index 0000000..b5d3168 --- /dev/null +++ b/proxmox-notify/src/context/pbs.rs @@ -0,0 +1,130 @@ +use serde::Deserialize; + +use proxmox_schema::{ObjectSchema, Schema, StringSchema}; +use proxmox_section_config::{SectionConfig, SectionConfigPlugin}; + +use crate::context::{common, Context}; + +const PBS_USER_CFG_FILENAME: &str = "/etc/proxmox-backup/user.cfg"; +const PBS_NODE_CFG_FILENAME: &str = "/etc/proxmox-backup/node.cfg"; + +// FIXME: Switch to the actual schema when possible in terms of dependency. +// It's safe to assume that the config was written with the actual schema restrictions, so parsing +// it with the less restrictive schema should be enough for the purpose of getting the mail address. +const DUMMY_ID_SCHEMA: Schema = StringSchema::new("dummy ID").min_length(3).schema(); +const DUMMY_EMAIL_SCHEMA: Schema = StringSchema::new("dummy email").schema(); +const DUMMY_USER_SCHEMA: ObjectSchema = ObjectSchema { + description: "minimal PBS user", + properties: &[ + ("userid", false, &DUMMY_ID_SCHEMA), + ("email", true, &DUMMY_EMAIL_SCHEMA), + ], + additional_properties: true, + default_key: None, +}; + +#[derive(Deserialize)] +struct DummyPbsUser { + pub email: Option, +} + +/// Extract the root user's email address from the PBS user config. +fn lookup_mail_address(content: &str, username: &str) -> Option { + let mut config = SectionConfig::new(&DUMMY_ID_SCHEMA).allow_unknown_sections(true); + let user_plugin = SectionConfigPlugin::new( + "user".to_string(), + Some("userid".to_string()), + &DUMMY_USER_SCHEMA, + ); + config.register_plugin(user_plugin); + + match config.parse(PBS_USER_CFG_FILENAME, content) { + Ok(parsed) => { + parsed.sections.get(username)?; + match parsed.lookup::("user", username) { + Ok(user) => common::normalize_for_return(user.email.as_deref()), + Err(err) => { + log::error!("unable to parse {PBS_USER_CFG_FILENAME}: {err}"); + None + } + } + } + Err(err) => { + log::error!("unable to parse {PBS_USER_CFG_FILENAME}: {err}"); + None + } + } +} + +#[derive(Debug)] +pub struct PBSContext; + +pub static PBS_CONTEXT: PBSContext = PBSContext; + +impl Context for PBSContext { + fn lookup_email_for_user(&self, user: &str) -> Option { + let content = common::attempt_file_read(PBS_USER_CFG_FILENAME); + content.and_then(|content| lookup_mail_address(&content, user)) + } + + fn default_sendmail_author(&self) -> String { + "Proxmox Backup Server".into() + } + + fn default_sendmail_from(&self) -> String { + let content = common::attempt_file_read(PBS_NODE_CFG_FILENAME); + content + .and_then(|content| common::lookup_datacenter_config_key(&content, "email-from")) + .unwrap_or_else(|| String::from("root")) + } + + fn http_proxy_config(&self) -> Option { + let content = common::attempt_file_read(PBS_NODE_CFG_FILENAME); + content.and_then(|content| common::lookup_datacenter_config_key(&content, "http-proxy")) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + const USER_CONFIG: &str = " +user: root@pam + email root@example.com + +user: test@pbs + enable true + expire 0 + "; + + #[test] + fn test_parse_mail() { + assert_eq!( + lookup_mail_address(USER_CONFIG, "root@pam"), + Some("root@example.com".to_string()) + ); + assert_eq!(lookup_mail_address(USER_CONFIG, "test@pbs"), None); + } + + const NODE_CONFIG: &str = " +default-lang: de +email-from: root@example.com +http-proxy: http://localhost:1234 + "; + + #[test] + fn test_parse_node_config() { + assert_eq!( + common::lookup_datacenter_config_key(NODE_CONFIG, "email-from"), + Some("root@example.com".to_string()) + ); + assert_eq!( + common::lookup_datacenter_config_key(NODE_CONFIG, "http-proxy"), + Some("http://localhost:1234".to_string()) + ); + assert_eq!( + common::lookup_datacenter_config_key(NODE_CONFIG, "foo"), + None + ); + } +} diff --git a/proxmox-notify/src/context/pve.rs b/proxmox-notify/src/context/pve.rs new file mode 100644 index 0000000..f263c95 --- /dev/null +++ b/proxmox-notify/src/context/pve.rs @@ -0,0 +1,82 @@ +use crate::context::{common, Context}; + +fn lookup_mail_address(content: &str, user: &str) -> Option { + common::normalize_for_return(content.lines().find_map(|line| { + let fields: Vec<&str> = line.split(':').collect(); + #[allow(clippy::get_first)] // to keep expression style consistent + match fields.get(0)?.trim() == "user" && fields.get(1)?.trim() == user { + true => fields.get(6).copied(), + false => None, + } + })) +} + +#[derive(Debug)] +pub struct PVEContext; + +impl Context for PVEContext { + fn lookup_email_for_user(&self, user: &str) -> Option { + let content = common::attempt_file_read("/etc/pve/user.cfg"); + content.and_then(|content| lookup_mail_address(&content, user)) + } + + fn default_sendmail_author(&self) -> String { + "Proxmox VE".into() + } + + fn default_sendmail_from(&self) -> String { + let content = common::attempt_file_read("/etc/pve/datacenter.cfg"); + content + .and_then(|content| common::lookup_datacenter_config_key(&content, "email_from")) + .unwrap_or_else(|| String::from("root")) + } + + fn http_proxy_config(&self) -> Option { + let content = common::attempt_file_read("/etc/pve/datacenter.cfg"); + content.and_then(|content| common::lookup_datacenter_config_key(&content, "http_proxy")) + } +} + +pub static PVE_CONTEXT: PVEContext = PVEContext; + +#[cfg(test)] +mod tests { + use super::*; + + const USER_CONFIG: &str = " +user:root@pam:1:0:::root@example.com::: +user:test@pve:1:0:::test@example.com::: +user:no-mail@pve:1:0:::::: + "; + + #[test] + fn test_parse_mail() { + assert_eq!( + lookup_mail_address(USER_CONFIG, "root@pam"), + Some("root@example.com".to_string()) + ); + assert_eq!( + lookup_mail_address(USER_CONFIG, "test@pve"), + Some("test@example.com".to_string()) + ); + assert_eq!(lookup_mail_address(USER_CONFIG, "no-mail@pve"), None); + } + + const DC_CONFIG: &str = " +email_from: user@example.com +http_proxy: http://localhost:1234 +keyboard: en-us +"; + #[test] + fn test_parse_dc_config() { + assert_eq!( + common::lookup_datacenter_config_key(DC_CONFIG, "email_from"), + Some("user@example.com".to_string()) + ); + assert_eq!( + common::lookup_datacenter_config_key(DC_CONFIG, "http_proxy"), + Some("http://localhost:1234".to_string()) + ); + assert_eq!(common::lookup_datacenter_config_key(DC_CONFIG, "foo"), None); + } +} -- 2.39.2