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 4BD82EEFA for ; Thu, 20 Jul 2023 16:33:34 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id BD35E146D5 for ; Thu, 20 Jul 2023 16:33:03 +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:02 +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 952A241E8D for ; Thu, 20 Jul 2023 16:33:02 +0200 (CEST) From: Lukas Wagner To: pve-devel@lists.proxmox.com Date: Thu, 20 Jul 2023 16:31:36 +0200 Message-Id: <20230720143236.652292-10-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.097 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 09/69] notify: add gotify endpoint 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:34 -0000 Add an endpoint for Gotify [1], showing the how easy it is to add new endpoint implementations. [1] https://gotify.net/ Signed-off-by: Lukas Wagner --- proxmox-notify/Cargo.toml | 6 +- proxmox-notify/src/config.rs | 23 +++++ proxmox-notify/src/endpoints/gotify.rs | 117 +++++++++++++++++++++++++ proxmox-notify/src/endpoints/mod.rs | 2 + proxmox-notify/src/lib.rs | 18 +++- 5 files changed, 163 insertions(+), 3 deletions(-) create mode 100644 proxmox-notify/src/endpoints/gotify.rs diff --git a/proxmox-notify/Cargo.toml b/proxmox-notify/Cargo.toml index c19cae14..b54f8adc 100644 --- a/proxmox-notify/Cargo.toml +++ b/proxmox-notify/Cargo.toml @@ -12,6 +12,7 @@ handlebars = { workspace = true, optional = true } lazy_static.workspace = true log.workspace = true openssl.workspace = true +proxmox-http = { workspace = true, features = ["client-sync"], optional = true } proxmox-schema = { workspace = true, features = ["api-macro", "api-types"]} proxmox-section-config = { workspace = true } proxmox-sys = { workspace = true, optional = true } @@ -20,5 +21,6 @@ serde = { workspace = true, features = ["derive"]} serde_json.workspace = true [features] -default = ["sendmail"] -sendmail = ["dep:handlebars", "dep:proxmox-sys"] \ No newline at end of file +default = ["sendmail", "gotify"] +sendmail = ["dep:handlebars", "dep:proxmox-sys"] +gotify = ["dep:proxmox-http"] diff --git a/proxmox-notify/src/config.rs b/proxmox-notify/src/config.rs index 6269ec3c..5508c916 100644 --- a/proxmox-notify/src/config.rs +++ b/proxmox-notify/src/config.rs @@ -24,6 +24,17 @@ fn config_init() -> SectionConfig { SENDMAIL_SCHEMA, )); } + #[cfg(feature = "gotify")] + { + use crate::endpoints::gotify::{GotifyConfig, GOTIFY_TYPENAME}; + + const GOTIFY_SCHEMA: &ObjectSchema = GotifyConfig::API_SCHEMA.unwrap_object_schema(); + config.register_plugin(SectionConfigPlugin::new( + GOTIFY_TYPENAME.to_string(), + Some(String::from("name")), + GOTIFY_SCHEMA, + )); + } config } @@ -31,6 +42,18 @@ fn config_init() -> SectionConfig { fn private_config_init() -> SectionConfig { let mut config = SectionConfig::new(&BACKEND_NAME_SCHEMA); + #[cfg(feature = "gotify")] + { + use crate::endpoints::gotify::{GotifyPrivateConfig, GOTIFY_TYPENAME}; + + const GOTIFY_SCHEMA: &ObjectSchema = GotifyPrivateConfig::API_SCHEMA.unwrap_object_schema(); + config.register_plugin(SectionConfigPlugin::new( + GOTIFY_TYPENAME.to_string(), + Some(String::from("name")), + GOTIFY_SCHEMA, + )); + } + config } diff --git a/proxmox-notify/src/endpoints/gotify.rs b/proxmox-notify/src/endpoints/gotify.rs new file mode 100644 index 00000000..37553d4f --- /dev/null +++ b/proxmox-notify/src/endpoints/gotify.rs @@ -0,0 +1,117 @@ +use std::collections::HashMap; + +use crate::schema::ENTITY_NAME_SCHEMA; +use crate::{Endpoint, Error, Notification, Severity}; + +use proxmox_schema::api_types::COMMENT_SCHEMA; +use serde::{Deserialize, Serialize}; + +use proxmox_http::client::sync::Client; +use proxmox_http::{HttpClient, HttpOptions}; +use proxmox_schema::{api, Updater}; + +#[derive(Serialize)] +struct GotifyMessageBody<'a> { + title: &'a str, + message: &'a str, + priority: u32, +} + +fn severity_to_priority(level: Severity) -> u32 { + match level { + Severity::Info => 1, + Severity::Notice => 3, + Severity::Warning => 5, + Severity::Error => 9, + } +} + +pub(crate) const GOTIFY_TYPENAME: &str = "gotify"; + +#[api( + properties: { + name: { + schema: ENTITY_NAME_SCHEMA, + }, + comment: { + optional: true, + schema: COMMENT_SCHEMA, + }, + } +)] +#[derive(Serialize, Deserialize, Updater, Default)] +#[serde(rename_all = "kebab-case")] +/// Config for Gotify notification endpoints +pub struct GotifyConfig { + /// Name of the endpoint + #[updater(skip)] + pub name: String, + /// Gotify Server URL + pub server: String, + /// Comment + #[serde(skip_serializing_if = "Option::is_none")] + pub comment: Option, +} + +#[api()] +#[derive(Serialize, Deserialize, Clone, Updater)] +#[serde(rename_all = "kebab-case")] +/// Private configuration for Gotify notification endpoints. +/// This config will be saved to a separate configuration file with stricter +/// permissions (root:root 0600) +pub struct GotifyPrivateConfig { + /// Name of the endpoint + #[updater(skip)] + pub name: String, + /// Authentication token + pub token: String, +} + +/// A Gotify notification endpoint. +pub struct GotifyEndpoint { + pub config: GotifyConfig, + pub private_config: GotifyPrivateConfig, +} + +#[derive(Serialize, Deserialize)] +#[serde(rename_all = "kebab-case")] +pub enum DeleteableGotifyProperty { + Comment, +} + +impl Endpoint for GotifyEndpoint { + fn send(&self, notification: &Notification) -> Result<(), Error> { + // TODO: What about proxy configuration? + let client = Client::new(HttpOptions::default()); + + let uri = format!("{}/message", self.config.server); + + let body = GotifyMessageBody { + title: ¬ification.title, + message: ¬ification.body, + priority: severity_to_priority(notification.severity), + }; + + let body = serde_json::to_vec(&body) + .map_err(|err| Error::NotifyFailed(self.name().to_string(), err.into()))?; + let extra_headers = HashMap::from([( + "Authorization".into(), + format!("Bearer {}", self.private_config.token), + )]); + + client + .post( + &uri, + Some(body.as_slice()), + Some("application/json"), + Some(&extra_headers), + ) + .map_err(|err| Error::NotifyFailed(self.name().to_string(), err.into()))?; + + Ok(()) + } + + fn name(&self) -> &str { + &self.config.name + } +} diff --git a/proxmox-notify/src/endpoints/mod.rs b/proxmox-notify/src/endpoints/mod.rs index dd80d9bc..d1cec654 100644 --- a/proxmox-notify/src/endpoints/mod.rs +++ b/proxmox-notify/src/endpoints/mod.rs @@ -1,2 +1,4 @@ +#[cfg(feature = "gotify")] +pub mod gotify; #[cfg(feature = "sendmail")] pub mod sendmail; diff --git a/proxmox-notify/src/lib.rs b/proxmox-notify/src/lib.rs index ff985393..da794c07 100644 --- a/proxmox-notify/src/lib.rs +++ b/proxmox-notify/src/lib.rs @@ -201,7 +201,6 @@ impl Bus { let mut endpoints = HashMap::new(); // Instantiate endpoints - #[cfg(feature = "sendmail")] { use endpoints::sendmail::SENDMAIL_TYPENAME; @@ -218,6 +217,23 @@ impl Bus { ); } + #[cfg(feature = "gotify")] + { + use endpoints::gotify::GOTIFY_TYPENAME; + use endpoints::gotify::{GotifyConfig, GotifyEndpoint, GotifyPrivateConfig}; + endpoints.extend( + parse_endpoints_with_private_config!( + config, + GotifyConfig, + GotifyPrivateConfig, + GotifyEndpoint, + GOTIFY_TYPENAME + )? + .into_iter() + .map(|e| (e.name().into(), e)), + ); + } + Ok(Bus { endpoints }) } -- 2.39.2