From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id BFFF51FF348 for ; Wed, 17 Apr 2024 16:35:59 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 5801FB83B; Wed, 17 Apr 2024 16:35:59 +0200 (CEST) From: Lukas Wagner To: pbs-devel@lists.proxmox.com Date: Wed, 17 Apr 2024 16:34:45 +0200 Message-Id: <20240417143514.346233-15-l.wagner@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240417143514.346233-1-l.wagner@proxmox.com> References: <20240417143514.346233-1-l.wagner@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL -0.054 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 POISEN_SPAM_PILL_3 0.1 random spam to be learned in bayes SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH proxmox-backup v2 14/43] api: add endpoints for notification matchers X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Backup Server development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" These endpoints require Sys.Audit/Sys.Modify permissions on /system/notifications. Signed-off-by: Lukas Wagner Tested-by: Gabriel Goller Reviewed-by: Gabriel Goller --- src/api2/config/notifications/matchers.rs | 170 ++++++++++++++++++++++ src/api2/config/notifications/mod.rs | 6 +- 2 files changed, 175 insertions(+), 1 deletion(-) create mode 100644 src/api2/config/notifications/matchers.rs diff --git a/src/api2/config/notifications/matchers.rs b/src/api2/config/notifications/matchers.rs new file mode 100644 index 00000000..fba1859c --- /dev/null +++ b/src/api2/config/notifications/matchers.rs @@ -0,0 +1,170 @@ +use anyhow::Error; +use serde_json::Value; + +use proxmox_notify::matcher::{DeleteableMatcherProperty, MatcherConfig, MatcherConfigUpdater}; +use proxmox_notify::schema::ENTITY_NAME_SCHEMA; +use proxmox_router::{Permission, Router, RpcEnvironment}; +use proxmox_schema::api; + +use pbs_api_types::{PRIV_SYS_AUDIT, PRIV_SYS_MODIFY, PROXMOX_CONFIG_DIGEST_SCHEMA}; + +#[api( + protected: true, + input: { + properties: {}, + }, + returns: { + description: "List of matchers.", + type: Array, + items: { type: MatcherConfig }, + }, + access: { + permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_AUDIT, false), + }, +)] +/// List all notification matchers. +pub fn list_matchers( + _param: Value, + _rpcenv: &mut dyn RpcEnvironment, +) -> Result, Error> { + let config = pbs_config::notifications::config()?; + + let matchers = proxmox_notify::api::matcher::get_matchers(&config)?; + + Ok(matchers) +} + +#[api( + protected: true, + input: { + properties: { + name: { + schema: ENTITY_NAME_SCHEMA, + } + }, + }, + returns: { type: MatcherConfig }, + access: { + permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_AUDIT, false), + }, +)] +/// Get a notification matcher. +pub fn get_matcher(name: String, rpcenv: &mut dyn RpcEnvironment) -> Result { + let config = pbs_config::notifications::config()?; + let matcher = proxmox_notify::api::matcher::get_matcher(&config, &name)?; + + rpcenv["digest"] = hex::encode(config.digest()).into(); + + Ok(matcher) +} + +#[api( + protected: true, + input: { + properties: { + matcher: { + type: MatcherConfig, + flatten: true, + } + }, + }, + access: { + permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_MODIFY, false), + }, +)] +/// Add a new notification matcher. +pub fn add_matcher(matcher: MatcherConfig, _rpcenv: &mut dyn RpcEnvironment) -> Result<(), Error> { + let _lock = pbs_config::notifications::lock_config()?; + let mut config = pbs_config::notifications::config()?; + + proxmox_notify::api::matcher::add_matcher(&mut config, matcher)?; + + pbs_config::notifications::save_config(config)?; + Ok(()) +} + +#[api( + protected: true, + input: { + properties: { + name: { + schema: ENTITY_NAME_SCHEMA, + }, + updater: { + type: MatcherConfigUpdater, + flatten: true, + }, + delete: { + description: "List of properties to delete.", + type: Array, + optional: true, + items: { + type: DeleteableMatcherProperty, + } + }, + digest: { + optional: true, + schema: PROXMOX_CONFIG_DIGEST_SCHEMA, + }, + }, + }, + access: { + permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_MODIFY, false), + }, +)] +/// Update notification matcher. +pub fn update_matcher( + name: String, + updater: MatcherConfigUpdater, + delete: Option>, + digest: Option, + _rpcenv: &mut dyn RpcEnvironment, +) -> Result<(), Error> { + let _lock = pbs_config::notifications::lock_config()?; + let mut config = pbs_config::notifications::config()?; + let digest = digest.map(hex::decode).transpose()?; + + proxmox_notify::api::matcher::update_matcher( + &mut config, + &name, + updater, + delete.as_deref(), + digest.as_deref(), + )?; + + pbs_config::notifications::save_config(config)?; + Ok(()) +} + +#[api( + protected: true, + input: { + properties: { + name: { + schema: ENTITY_NAME_SCHEMA, + } + }, + }, + access: { + permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_MODIFY, false), + }, +)] +/// Delete notification matcher. +pub fn delete_matcher(name: String, _rpcenv: &mut dyn RpcEnvironment) -> Result<(), Error> { + let _lock = pbs_config::notifications::lock_config()?; + let mut config = pbs_config::notifications::config()?; + proxmox_notify::api::matcher::delete_matcher(&mut config, &name)?; + + pbs_config::notifications::save_config(config)?; + Ok(()) +} + +const ITEM_ROUTER: Router = Router::new() + .get(&API_METHOD_GET_MATCHER) + .put(&API_METHOD_UPDATE_MATCHER) + .delete(&API_METHOD_DELETE_MATCHER); + +pub const ROUTER: Router = Router::new() + .get(&API_METHOD_LIST_MATCHERS) + .post(&API_METHOD_ADD_MATCHER) + .match_all("name", &ITEM_ROUTER); diff --git a/src/api2/config/notifications/mod.rs b/src/api2/config/notifications/mod.rs index f75e3910..361dc593 100644 --- a/src/api2/config/notifications/mod.rs +++ b/src/api2/config/notifications/mod.rs @@ -2,10 +2,14 @@ use proxmox_router::list_subdirs_api_method; use proxmox_router::{Router, SubdirMap}; use proxmox_sortable_macro::sortable; +mod matchers; mod targets; #[sortable] -const SUBDIRS: SubdirMap = &sorted!([("targets", &targets::ROUTER),]); +const SUBDIRS: SubdirMap = &sorted!([ + ("targets", &targets::ROUTER), + ("matchers", &matchers::ROUTER), +]); pub const ROUTER: Router = Router::new() .get(&list_subdirs_api_method!(SUBDIRS)) -- 2.39.2 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel