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 2CAA7F05B for ; Thu, 20 Jul 2023 16:33:44 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 8E8B014985 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 4494541E9C 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:37 +0200 Message-Id: <20230720143236.652292-11-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.094 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 10/69] notify: api: add API for gotify 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:44 -0000 Signed-off-by: Lukas Wagner --- proxmox-notify/src/api/gotify.rs | 284 +++++++++++++++++++++++++++++++ proxmox-notify/src/api/mod.rs | 6 + 2 files changed, 290 insertions(+) create mode 100644 proxmox-notify/src/api/gotify.rs diff --git a/proxmox-notify/src/api/gotify.rs b/proxmox-notify/src/api/gotify.rs new file mode 100644 index 00000000..fcc1aabf --- /dev/null +++ b/proxmox-notify/src/api/gotify.rs @@ -0,0 +1,284 @@ +use crate::api::ApiError; +use crate::endpoints::gotify::{ + DeleteableGotifyProperty, GotifyConfig, GotifyConfigUpdater, GotifyPrivateConfig, + GotifyPrivateConfigUpdater, GOTIFY_TYPENAME, +}; +use crate::Config; + +/// Get a list of all gotify endpoints. +/// +/// The caller is responsible for any needed permission checks. +/// Returns a list of all gotify endpoints or an `ApiError` if the config is erroneous. +pub fn get_endpoints(config: &Config) -> Result, ApiError> { + config + .config + .convert_to_typed_array(GOTIFY_TYPENAME) + .map_err(|e| ApiError::internal_server_error("Could not fetch endpoints", Some(e.into()))) +} + +/// Get gotify 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(GOTIFY_TYPENAME, name) + .map_err(|_| ApiError::not_found(format!("endpoint '{name}' not found"), None)) +} + +/// Add a new gotify 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_config: &GotifyConfig, + private_endpoint_config: &GotifyPrivateConfig, +) -> Result<(), ApiError> { + if endpoint_config.name != private_endpoint_config.name { + // Programming error by the user of the crate, thus we panic + panic!("name for endpoint config and private config must be identical"); + } + + if super::endpoint_exists(config, &endpoint_config.name) { + return Err(ApiError::bad_request( + format!( + "endpoint with name '{}' already exists!", + endpoint_config.name + ), + None, + )); + } + + set_private_config_entry(config, private_endpoint_config)?; + + config + .config + .set_data(&endpoint_config.name, GOTIFY_TYPENAME, endpoint_config) + .map_err(|e| { + ApiError::internal_server_error( + format!("could not save endpoint '{}'", endpoint_config.name), + Some(e.into()), + ) + })?; + + Ok(()) +} + +/// Update existing gotify 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, + endpoint_config_updater: &GotifyConfigUpdater, + private_endpoint_config_updater: &GotifyPrivateConfigUpdater, + delete: Option<&[DeleteableGotifyProperty]>, + 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 { + DeleteableGotifyProperty::Comment => endpoint.comment = None, + } + } + } + + if let Some(server) = &endpoint_config_updater.server { + endpoint.server = server.into(); + } + + if let Some(token) = &private_endpoint_config_updater.token { + set_private_config_entry( + config, + &GotifyPrivateConfig { + name: name.into(), + token: token.into(), + }, + )?; + } + + if let Some(comment) = &endpoint_config_updater.comment { + endpoint.comment = Some(comment.into()); + } + + config + .config + .set_data(name, GOTIFY_TYPENAME, &endpoint) + .map_err(|e| { + ApiError::internal_server_error( + format!("could not save endpoint '{name}'"), + Some(e.into()), + ) + })?; + + Ok(()) +} + +/// Delete existing gotify 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_gotify_endpoint(config: &mut Config, name: &str) -> Result<(), ApiError> { + // Check if the endpoint exists + let _ = get_endpoint(config, name)?; + + remove_private_config_entry(config, name)?; + config.config.sections.remove(name); + + Ok(()) +} + +fn set_private_config_entry( + config: &mut Config, + private_config: &GotifyPrivateConfig, +) -> Result<(), ApiError> { + config + .private_config + .set_data(&private_config.name, GOTIFY_TYPENAME, private_config) + .map_err(|e| { + ApiError::internal_server_error( + format!( + "could not save private config for endpoint '{}'", + private_config.name + ), + Some(e.into()), + ) + }) +} + +fn remove_private_config_entry(config: &mut Config, name: &str) -> Result<(), ApiError> { + config.private_config.sections.remove(name); + Ok(()) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::api::test_helpers::empty_config; + + pub fn add_default_gotify_endpoint(config: &mut Config) -> Result<(), ApiError> { + add_endpoint( + config, + &GotifyConfig { + name: "gotify-endpoint".into(), + server: "localhost".into(), + comment: Some("comment".into()), + }, + &GotifyPrivateConfig { + name: "gotify-endpoint".into(), + token: "supersecrettoken".into(), + }, + )?; + + assert!(get_endpoint(config, "gotify-endpoint").is_ok()); + Ok(()) + } + + #[test] + fn test_update_not_existing_returns_error() -> Result<(), ApiError> { + let mut config = empty_config(); + + assert!(update_endpoint( + &mut config, + "test", + &Default::default(), + &Default::default(), + None, + None + ) + .is_err()); + + Ok(()) + } + + #[test] + fn test_update_invalid_digest_returns_error() -> Result<(), ApiError> { + let mut config = empty_config(); + add_default_gotify_endpoint(&mut config)?; + + assert!(update_endpoint( + &mut config, + "gotify-endpoint", + &Default::default(), + &Default::default(), + None, + Some(&[0; 32]) + ) + .is_err()); + + Ok(()) + } + + #[test] + fn test_gotify_update() -> Result<(), ApiError> { + let mut config = empty_config(); + add_default_gotify_endpoint(&mut config)?; + + let digest = config.digest; + + update_endpoint( + &mut config, + "gotify-endpoint", + &GotifyConfigUpdater { + server: Some("newhost".into()), + comment: Some("newcomment".into()), + }, + &GotifyPrivateConfigUpdater { + token: Some("changedtoken".into()), + }, + None, + Some(&digest), + )?; + + let endpoint = get_endpoint(&config, "gotify-endpoint")?; + + assert_eq!(endpoint.server, "newhost".to_string()); + + let token = config + .private_config + .lookup::(GOTIFY_TYPENAME, "gotify-endpoint") + .unwrap() + .token; + + assert_eq!(token, "changedtoken".to_string()); + assert_eq!(endpoint.comment, Some("newcomment".to_string())); + + // Test property deletion + update_endpoint( + &mut config, + "gotify-endpoint", + &Default::default(), + &Default::default(), + Some(&[DeleteableGotifyProperty::Comment]), + None, + )?; + + let endpoint = get_endpoint(&config, "gotify-endpoint")?; + assert_eq!(endpoint.comment, None); + + Ok(()) + } + + #[test] + fn test_gotify_endpoint_delete() -> Result<(), ApiError> { + let mut config = empty_config(); + add_default_gotify_endpoint(&mut config)?; + + delete_gotify_endpoint(&mut config, "gotify-endpoint")?; + assert!(delete_gotify_endpoint(&mut config, "gotify-endpoint").is_err()); + assert_eq!(get_endpoints(&config)?.len(), 0); + + Ok(()) + } +} diff --git a/proxmox-notify/src/api/mod.rs b/proxmox-notify/src/api/mod.rs index 4baae899..1a4cc873 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 = "gotify")] +pub mod gotify; #[cfg(feature = "sendmail")] pub mod sendmail; @@ -89,6 +91,10 @@ fn endpoint_exists(config: &Config, name: &str) -> bool { { exists = exists || sendmail::get_endpoint(config, name).is_ok(); } + #[cfg(feature = "gotify")] + { + exists = exists || gotify::get_endpoint(config, name).is_ok(); + } exists } -- 2.39.2