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 3E29CEE94 for ; Thu, 20 Jul 2023 16:33:13 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 5407214948 for ; Thu, 20 Jul 2023 16:33:09 +0200 (CEST) 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 ; Thu, 20 Jul 2023 16:33:04 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 2B23D41EF9 for ; Thu, 20 Jul 2023 16:33:04 +0200 (CEST) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Thu, 20 Jul 2023 16:31:35 +0200 Message-Id: <20230720143236.652292-9-l.wagner@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230720143236.652292-1-l.wagner@proxmox.com> References: <20230720143236.652292-1-l.wagner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.095 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 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 v4 proxmox 08/69] notify: api: add API for sendmail endpoints 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: Thu, 20 Jul 2023 14:33:13 -0000 Signed-off-by: Lukas Wagner --- proxmox-notify/src/api/mod.rs | 7 + proxmox-notify/src/api/sendmail.rs | 254 +++++++++++++++++++++++++++++ 2 files changed, 261 insertions(+) create mode 100644 proxmox-notify/src/api/sendmail.rs diff --git a/proxmox-notify/src/api/mod.rs b/proxmox-notify/src/api/mod.rs index db9ad1ca..4baae899 100644 --- a/proxmox-notify/src/api/mod.rs +++ b/proxmox-notify/src/api/mod.rs @@ -5,6 +5,8 @@ use crate::Config; use serde::Serialize; pub mod common; +#[cfg(feature = "sendmail")] +pub mod sendmail; #[derive(Debug, Serialize)] pub struct ApiError { @@ -83,6 +85,11 @@ fn verify_digest(config: &Config, digest: Option<&[u8]>) -> Result<(), ApiError> fn endpoint_exists(config: &Config, name: &str) -> bool { let mut exists = false; + #[cfg(feature = "sendmail")] + { + exists = exists || sendmail::get_endpoint(config, name).is_ok(); + } + exists } diff --git a/proxmox-notify/src/api/sendmail.rs b/proxmox-notify/src/api/sendmail.rs new file mode 100644 index 00000000..8eafe359 --- /dev/null +++ b/proxmox-notify/src/api/sendmail.rs @@ -0,0 +1,254 @@ +use crate::api::ApiError; +use crate::endpoints::sendmail::{ + DeleteableSendmailProperty, SendmailConfig, SendmailConfigUpdater, SENDMAIL_TYPENAME, +}; +use crate::Config; + +/// Get a list of all sendmail endpoints. +/// +/// The caller is responsible for any needed permission checks. +/// Returns a list of all sendmail endpoints or an `ApiError` if the config is erroneous. +pub fn get_endpoints(config: &Config) -> Result, ApiError> { + config + .config + .convert_to_typed_array(SENDMAIL_TYPENAME) + .map_err(|e| ApiError::internal_server_error("Could not fetch endpoints", Some(e.into()))) +} + +/// Get sendmail endpoint with given `name`. +/// +/// The caller is responsible for any needed permission checks. +/// Returns the endpoint or an `ApiError` if the endpoint was not found. +pub fn get_endpoint(config: &Config, name: &str) -> Result { + config + .config + .lookup(SENDMAIL_TYPENAME, name) + .map_err(|_| ApiError::not_found(format!("endpoint '{name}' not found"), None)) +} + +/// Add a new sendmail endpoint. +/// +/// The caller is responsible for any needed permission checks. +/// The caller also responsible for locking the configuration files. +/// Returns an `ApiError` if an endpoint with the same name already exists, +/// or if the endpoint could not be saved. +pub fn add_endpoint(config: &mut Config, endpoint: &SendmailConfig) -> Result<(), ApiError> { + if super::endpoint_exists(config, &endpoint.name) { + return Err(ApiError::bad_request( + format!("endpoint with name '{}' already exists!", &endpoint.name), + None, + )); + } + + config + .config + .set_data(&endpoint.name, SENDMAIL_TYPENAME, endpoint) + .map_err(|e| { + ApiError::internal_server_error( + format!("could not save endpoint '{}'", endpoint.name), + Some(e.into()), + ) + })?; + + Ok(()) +} + +/// Update existing sendmail endpoint +/// +/// The caller is responsible for any needed permission checks. +/// The caller also responsible for locking the configuration files. +/// Returns an `ApiError` if the config could not be saved. +pub fn update_endpoint( + config: &mut Config, + name: &str, + updater: &SendmailConfigUpdater, + delete: Option<&[DeleteableSendmailProperty]>, + digest: Option<&[u8]>, +) -> Result<(), ApiError> { + super::verify_digest(config, digest)?; + + let mut endpoint = get_endpoint(config, name)?; + + if let Some(delete) = delete { + for deleteable_property in delete { + match deleteable_property { + DeleteableSendmailProperty::FromAddress => endpoint.from_address = None, + DeleteableSendmailProperty::Author => endpoint.author = None, + DeleteableSendmailProperty::Comment => endpoint.comment = None, + } + } + } + + if let Some(mailto) = &updater.mailto { + endpoint.mailto = mailto.iter().map(String::from).collect(); + } + + if let Some(from_address) = &updater.from_address { + endpoint.from_address = Some(from_address.into()); + } + + if let Some(author) = &updater.author { + endpoint.author = Some(author.into()); + } + + if let Some(comment) = &updater.comment { + endpoint.comment = Some(comment.into()); + } + + config + .config + .set_data(name, SENDMAIL_TYPENAME, &endpoint) + .map_err(|e| { + ApiError::internal_server_error( + format!("could not save endpoint '{name}'"), + Some(e.into()), + ) + })?; + + Ok(()) +} + +/// Delete existing sendmail endpoint +/// +/// The caller is responsible for any needed permission checks. +/// The caller also responsible for locking the configuration files. +/// Returns an `ApiError` if the endpoint does not exist. +pub fn delete_endpoint(config: &mut Config, name: &str) -> Result<(), ApiError> { + // Check if the endpoint exists + let _ = get_endpoint(config, name)?; + + config.config.sections.remove(name); + + Ok(()) +} + +#[cfg(test)] +pub mod tests { + use super::*; + use crate::api::test_helpers::*; + + pub fn add_sendmail_endpoint_for_test(config: &mut Config, name: &str) -> Result<(), ApiError> { + add_endpoint( + config, + &SendmailConfig { + name: name.into(), + mailto: vec!["user1@example.com".into()], + from_address: Some("from@example.com".into()), + author: Some("root".into()), + comment: Some("Comment".into()), + }, + )?; + + assert!(get_endpoint(config, name).is_ok()); + Ok(()) + } + + #[test] + fn test_sendmail_create() -> Result<(), ApiError> { + let mut config = empty_config(); + + assert_eq!(get_endpoints(&config)?.len(), 0); + add_sendmail_endpoint_for_test(&mut config, "sendmail-endpoint")?; + + // Endpoints must have a unique name + assert!(add_sendmail_endpoint_for_test(&mut config, "sendmail-endpoint").is_err()); + assert_eq!(get_endpoints(&config)?.len(), 1); + Ok(()) + } + + #[test] + fn test_update_not_existing_returns_error() -> Result<(), ApiError> { + let mut config = empty_config(); + + assert!(update_endpoint(&mut config, "test", &Default::default(), None, None,).is_err()); + + Ok(()) + } + + #[test] + fn test_update_invalid_digest_returns_error() -> Result<(), ApiError> { + let mut config = empty_config(); + add_sendmail_endpoint_for_test(&mut config, "sendmail-endpoint")?; + + assert!(update_endpoint( + &mut config, + "sendmail-endpoint", + &SendmailConfigUpdater { + mailto: Some(vec!["user2@example.com".into(), "user3@example.com".into()]), + from_address: Some("root@example.com".into()), + author: Some("newauthor".into()), + comment: Some("new comment".into()), + }, + None, + Some(&[0; 32]), + ) + .is_err()); + + Ok(()) + } + + #[test] + fn test_sendmail_update() -> Result<(), ApiError> { + let mut config = empty_config(); + add_sendmail_endpoint_for_test(&mut config, "sendmail-endpoint")?; + + let digest = config.digest; + + update_endpoint( + &mut config, + "sendmail-endpoint", + &SendmailConfigUpdater { + mailto: Some(vec!["user2@example.com".into(), "user3@example.com".into()]), + from_address: Some("root@example.com".into()), + author: Some("newauthor".into()), + comment: Some("new comment".into()), + }, + None, + Some(&digest), + )?; + + let endpoint = get_endpoint(&config, "sendmail-endpoint")?; + + assert_eq!( + endpoint.mailto, + vec![ + "user2@example.com".to_string(), + "user3@example.com".to_string() + ] + ); + assert_eq!(endpoint.from_address, Some("root@example.com".to_string())); + assert_eq!(endpoint.author, Some("newauthor".to_string())); + assert_eq!(endpoint.comment, Some("new comment".to_string())); + + // Test property deletion + update_endpoint( + &mut config, + "sendmail-endpoint", + &Default::default(), + Some(&[ + DeleteableSendmailProperty::FromAddress, + DeleteableSendmailProperty::Author, + ]), + None, + )?; + + let endpoint = get_endpoint(&config, "sendmail-endpoint")?; + + assert_eq!(endpoint.from_address, None); + assert_eq!(endpoint.author, None); + + Ok(()) + } + + #[test] + fn test_sendmail_delete() -> Result<(), ApiError> { + let mut config = empty_config(); + add_sendmail_endpoint_for_test(&mut config, "sendmail-endpoint")?; + + delete_endpoint(&mut config, "sendmail-endpoint")?; + assert!(delete_endpoint(&mut config, "sendmail-endpoint").is_err()); + assert_eq!(get_endpoints(&config)?.len(), 0); + + Ok(()) + } +} -- 2.39.2