public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup v3 15/42] api: add endpoints for smtp targets
Date: Mon, 22 Apr 2024 09:50:03 +0200	[thread overview]
Message-ID: <20240422075030.73895-16-l.wagner@proxmox.com> (raw)
In-Reply-To: <20240422075030.73895-1-l.wagner@proxmox.com>

These endpoints require Sys.Audit/Sys.Modify permissions on
/system/notifications.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Tested-by: Gabriel Goller <g.goller@proxmox.com>
Reviewed-by: Gabriel Goller <g.goller@proxmox.com>
---
 src/api2/config/notifications/mod.rs  |   4 +-
 src/api2/config/notifications/smtp.rs | 191 ++++++++++++++++++++++++++
 2 files changed, 194 insertions(+), 1 deletion(-)
 create mode 100644 src/api2/config/notifications/smtp.rs

diff --git a/src/api2/config/notifications/mod.rs b/src/api2/config/notifications/mod.rs
index 76233b6c..75b96ce1 100644
--- a/src/api2/config/notifications/mod.rs
+++ b/src/api2/config/notifications/mod.rs
@@ -4,6 +4,7 @@ use proxmox_sortable_macro::sortable;
 
 mod matchers;
 mod sendmail;
+mod smtp;
 mod targets;
 
 #[sortable]
@@ -18,7 +19,8 @@ pub const ROUTER: Router = Router::new()
     .subdirs(SUBDIRS);
 
 #[sortable]
-const ENDPOINT_SUBDIRS: SubdirMap = &sorted!([("sendmail", &sendmail::ROUTER),]);
+const ENDPOINT_SUBDIRS: SubdirMap =
+    &sorted!([("sendmail", &sendmail::ROUTER), ("smtp", &smtp::ROUTER),]);
 
 const ENDPOINT_ROUTER: Router = Router::new()
     .get(&list_subdirs_api_method!(ENDPOINT_SUBDIRS))
diff --git a/src/api2/config/notifications/smtp.rs b/src/api2/config/notifications/smtp.rs
new file mode 100644
index 00000000..8df2ab18
--- /dev/null
+++ b/src/api2/config/notifications/smtp.rs
@@ -0,0 +1,191 @@
+use anyhow::Error;
+use serde_json::Value;
+
+use proxmox_notify::endpoints::smtp::{
+    DeleteableSmtpProperty, SmtpConfig, SmtpConfigUpdater, SmtpPrivateConfig,
+    SmtpPrivateConfigUpdater,
+};
+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 smtp endpoints.",
+        type: Array,
+        items: { type: SmtpConfig },
+    },
+    access: {
+        permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_AUDIT, false),
+    },
+)]
+/// List all smtp endpoints.
+pub fn list_endpoints(
+    _param: Value,
+    _rpcenv: &mut dyn RpcEnvironment,
+) -> Result<Vec<SmtpConfig>, Error> {
+    let config = pbs_config::notifications::config()?;
+
+    let endpoints = proxmox_notify::api::smtp::get_endpoints(&config)?;
+
+    Ok(endpoints)
+}
+
+#[api(
+    protected: true,
+    input: {
+        properties: {
+            name: {
+                schema: ENTITY_NAME_SCHEMA,
+            }
+        },
+    },
+    returns: { type: SmtpConfig },
+    access: {
+        permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_AUDIT, false),
+    },
+)]
+/// Get a smtp endpoint.
+pub fn get_endpoint(name: String, rpcenv: &mut dyn RpcEnvironment) -> Result<SmtpConfig, Error> {
+    let config = pbs_config::notifications::config()?;
+    let endpoint = proxmox_notify::api::smtp::get_endpoint(&config, &name)?;
+
+    rpcenv["digest"] = hex::encode(config.digest()).into();
+
+    Ok(endpoint)
+}
+
+#[api(
+    protected: true,
+    input: {
+        properties: {
+            endpoint: {
+                type: SmtpConfig,
+                flatten: true,
+            },
+            password: {
+                optional: true,
+                description: "SMTP authentication password"
+            }
+        },
+    },
+    access: {
+        permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_MODIFY, false),
+    },
+)]
+/// Add a new smtp endpoint.
+pub fn add_endpoint(
+    endpoint: SmtpConfig,
+    password: Option<String>,
+    _rpcenv: &mut dyn RpcEnvironment,
+) -> Result<(), Error> {
+    let _lock = pbs_config::notifications::lock_config()?;
+    let mut config = pbs_config::notifications::config()?;
+    let private_endpoint_config = SmtpPrivateConfig {
+        name: endpoint.name.clone(),
+        password,
+    };
+
+    proxmox_notify::api::smtp::add_endpoint(&mut config, endpoint, private_endpoint_config)?;
+
+    pbs_config::notifications::save_config(config)?;
+    Ok(())
+}
+
+#[api(
+    protected: true,
+    input: {
+        properties: {
+            name: {
+                schema: ENTITY_NAME_SCHEMA,
+            },
+            updater: {
+                type: SmtpConfigUpdater,
+                flatten: true,
+            },
+            password: {
+                description: "SMTP authentication password",
+                optional: true,
+            },
+            delete: {
+                description: "List of properties to delete.",
+                type: Array,
+                optional: true,
+                items: {
+                    type: DeleteableSmtpProperty,
+                }
+            },
+            digest: {
+                optional: true,
+                schema: PROXMOX_CONFIG_DIGEST_SCHEMA,
+            },
+        },
+    },
+    access: {
+        permission: &Permission::Privilege(&["system", "notifications"], PRIV_SYS_MODIFY, false),
+    },
+)]
+/// Update smtp endpoint.
+pub fn update_endpoint(
+    name: String,
+    updater: SmtpConfigUpdater,
+    password: Option<String>,
+    delete: Option<Vec<DeleteableSmtpProperty>>,
+    digest: Option<String>,
+    _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::smtp::update_endpoint(
+        &mut config,
+        &name,
+        updater,
+        SmtpPrivateConfigUpdater { password },
+        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 smtp endpoint.
+pub fn delete_endpoint(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::smtp::delete_endpoint(&mut config, &name)?;
+
+    pbs_config::notifications::save_config(config)?;
+    Ok(())
+}
+
+const ITEM_ROUTER: Router = Router::new()
+    .get(&API_METHOD_GET_ENDPOINT)
+    .put(&API_METHOD_UPDATE_ENDPOINT)
+    .delete(&API_METHOD_DELETE_ENDPOINT);
+
+pub const ROUTER: Router = Router::new()
+    .get(&API_METHOD_LIST_ENDPOINTS)
+    .post(&API_METHOD_ADD_ENDPOINT)
+    .match_all("name", &ITEM_ROUTER);
-- 
2.39.2



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


  parent reply	other threads:[~2024-04-22  7:51 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-22  7:49 [pbs-devel] [PATCH many v3 00/42] integrate notification system Lukas Wagner
2024-04-22  7:49 ` [pbs-devel] [PATCH proxmox v3 01/42] notify: expose `config` module Lukas Wagner
2024-04-22  7:49 ` [pbs-devel] [PATCH proxmox v3 02/42] notify: use std::sync::OnceCell instead of lazy_static! Lukas Wagner
2024-04-22  7:49 ` [pbs-devel] [PATCH proxmox v3 03/42] notify: pbs-context: exclude successful prunes in default matcher Lukas Wagner
2024-04-22  7:49 ` [pbs-devel] [PATCH proxmox v3 04/42] notify: endpoints: matcher: improve descriptions for API types Lukas Wagner
2024-04-22  7:49 ` [pbs-devel] [PATCH proxmox v3 05/42] notify: add getter for notification timestamp Lukas Wagner
2024-04-22  7:49 ` [pbs-devel] [PATCH widget-toolkit v3 06/42] sendmail: smtp: allow to overide default mail author Lukas Wagner
2024-04-22  7:49 ` [pbs-devel] [PATCH proxmox-backup v3 07/42] pbs-config: add module for loading notification config Lukas Wagner
2024-04-22  7:49 ` [pbs-devel] [PATCH proxmox-backup v3 08/42] server: rename email_notifications module to notifications Lukas Wagner
2024-04-22  7:49 ` [pbs-devel] [PATCH proxmox-backup v3 09/42] notifications: allow sending notifications via proxmox_notify Lukas Wagner
2024-04-22  7:49 ` [pbs-devel] [PATCH proxmox-backup v3 10/42] buildsys: install templates for test notifications Lukas Wagner
2024-04-22  7:49 ` [pbs-devel] [PATCH proxmox-backup v3 11/42] pbs-config: acl: add /system/notifications as known ACL path Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 12/42] api: add endpoints for querying/testing notification targets Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 13/42] api: add endpoints for notification matchers Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 14/42] api: add endpoints for sendmail targets Lukas Wagner
2024-04-22  7:50 ` Lukas Wagner [this message]
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 16/42] api: add endpoints for gotify targets Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 17/42] api: add endpoints for querying known notification values/fields Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 18/42] api-types: api: datatore: add notification-mode parameter Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 19/42] api-types: api: tape: " Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 20/42] server: notifications: send GC notifications via notification system Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 21/42] server: notifications: send prune " Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 22/42] server: notifications: send verify " Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 23/42] server: notifications: send sync " Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 24/42] server: notifications: send update " Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 25/42] server: notifications: send acme " Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 26/42] server: notifications: send tape " Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 27/42] ui: add notification config panel Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 28/42] ui: tape backup job: add selector for notification-mode Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 29/42] ui: tape backup: add selector for 'notification-mode' Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 30/42] ui: tape restore: add 'notification-mode' parameter Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 31/42] ui: datastore options: " Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 32/42] ui: utils: add overrides for known notification metadata fields/values Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 33/42] ui: datastore edit: make new stores use notification system by default Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 34/42] ui: permissions paths: add /system/notifications to combobox Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 35/42] proxmox-backup-manager: add CLI for notification targets Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 36/42] proxmox-backup-manager: add CLI for notification matchers Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 37/42] proxmox-backup-manager: add CLI for gotify endpoints Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 38/42] proxmox-backup-manager: add CLI for sendmail endpoints Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 39/42] proxmox-backup-manager: add CLI for SMTP endpoints Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 40/42] docgen: generate synopsis for notifications{-priv, }.cfg Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 41/42] docs: add documentation for notification system Lukas Wagner
2024-04-22  7:50 ` [pbs-devel] [PATCH proxmox-backup v3 42/42] ui: util: override default mail author for sendmail/smtp targets Lukas Wagner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240422075030.73895-16-l.wagner@proxmox.com \
    --to=l.wagner@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal