all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH proxmox-mail-forward v2 57/63] forward mails via notification queue
Date: Wed, 18 Nov 2026 10:43:41 +0100	[thread overview]
Message-ID: <20261118094348.273646-58-l.wagner@proxmox.com> (raw)
In-Reply-To: <20261118094348.273646-1-l.wagner@proxmox.com>

Instead of loading the notification configuration and sending the
notification directly, submit the forwarded mail to the notification
queue of the installed product. The product's notification worker then
picks it up and handles matching and delivery like for any other
notification.

This way, the setuid helper no longer parses the product's notification
configuration, including the private part with secrets, and contains
none of the sending logic. The product-specific workarounds go away as
well, such as the default sendmail target that was added for PBS
installations without a notifications.cfg.

The helper still has to start as root, since postfix runs it as 'nobody'
and the queue must not be world-writable. Root is only used to switch to
the user and group that own the queue (www-data for PVE, backup for
PBS), and all privileges are dropped permanently before the mail is
read. A bug in the code handling the mail can therefore not be used to
gain root, and queue files get the ownership the consumer expects.

If PVE and PBS are installed on the same host, the mail is now only
submitted to the PVE queue. Previously, it was passed to both
notification systems, unless PBS had no notifications.cfg of its own.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
 Cargo.toml  |   5 +-
 src/main.rs | 227 ++++++++++++++++++++++++++++++----------------------
 2 files changed, 133 insertions(+), 99 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index 6860f49..d6ba2ae 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -18,8 +18,5 @@ anyhow = "1.0"
 nix = "0.29"
 
 proxmox-log = "1"
-proxmox-notify = {version = "2", features = ["mail-forwarder", "pve-context", "pbs-context", "legacy-matchers"] }
+proxmox-notify = { version = "2", features = ["queue-submitter"] }
 proxmox-sys = "1"
-
-# Not directly used, this is just to force it to the new version:
-proxmox-http = "1.0.2"
diff --git a/src/main.rs b/src/main.rs
index a95d75c..d388134 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,54 +1,114 @@
 //! A helper binary that forwards any mail passed via stdin to
-//! proxmox_notify.
+//! the notification queue of the currently installed Proxmox product.
+//!
+//! If multiple products are installed side-by-side, only one notification is created.
+//! The order of precedence is:
+//!   - PVE
+//!   - PBS
 //!
 //! The binary's path is added to /root/.forward, which means that
 //! postfix will invoke it when the local root user receives an email message.
 //! The message is passed via stdin.
-//! The binary is installed with setuid permissions and will thus run as
-//! root (euid ~ root, ruid ~ nobody)
+//! The binary is installed with setuid permissions and will thus start as
+//! root (euid ~ root, ruid ~ nobody).
 //!
-//! The forwarding behavior is the following:
-//!   - PVE installed: Use PVE's notifications.cfg
-//!   - PBS installed: Use PBS's notifications.cfg if present. If not,
-//!     use an empty configuration and add a default sendmail target and
-//!     a matcher - this is needed because notifications are not yet
-//!     integrated in PBS.
-//!   - PVE/PBS co-installed: Use PVE's config *and* PBS's config, but if
-//!     PBS's config does not exist, a default sendmail target will *not* be
-//!     added. We assume that PVE's config contains the desired notification
-//!     behavior for system mails.
+//! The setuid permissions are needed since postfix will run the script as
+//! `nobody`. If we would not become `root` via a setuid binary, we would need to
+//! make the notification submission queue world-writable, which is
+//! not what we want.
 //!
+//! Root privileges are only needed to switch to the user that owns the
+//! notification queue of the installed product. Once the product has been
+//! determined, the binary permanently drops to that user and group before
+//! reading the mail from stdin.
+
 use std::io::Read;
 use std::path::Path;
 
+use anyhow::Context;
 use anyhow::Error;
+use anyhow::bail;
+use nix::sys::stat::Mode;
+use nix::unistd::Gid;
+use nix::unistd::Group;
+use nix::unistd::Uid;
+use nix::unistd::User;
 
 use proxmox_log::LevelFilter;
 use proxmox_log::Logger;
 use proxmox_log::error;
-use proxmox_notify::Config;
-use proxmox_notify::context::pbs::PBS_CONTEXT;
-use proxmox_notify::context::pve::PVE_CONTEXT;
-use proxmox_sys::fs;
+use proxmox_notify::Notification;
+use proxmox_notify::Severity;
+use proxmox_notify::queue::QueueSubmitter;
+use proxmox_sys::fs::CreateOptions;
 
-const PVE_CFG_PATH: &str = "/etc/pve";
-const PVE_PUB_NOTIFICATION_CFG_FILENAME: &str = "/etc/pve/notifications.cfg";
-const PVE_PRIV_NOTIFICATION_CFG_FILENAME: &str = "/etc/pve/priv/notifications.cfg";
+/// A Proxmox product whose notifications are processed via a notification queue.
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+enum Product {
+    /// Proxmox VE
+    Pve,
+    /// Proxmox Backup Server
+    Pbs,
+}
 
-const PBS_CFG_PATH: &str = "/etc/proxmox-backup";
-const PBS_PUB_NOTIFICATION_CFG_FILENAME: &str = "/etc/proxmox-backup/notifications.cfg";
-const PBS_PRIV_NOTIFICATION_CFG_FILENAME: &str = "/etc/proxmox-backup/notifications-priv.cfg";
+impl Product {
+    /// All supported products, in order of precedence.
+    const ALL: &[Product] = &[Product::Pve, Product::Pbs];
 
-/// Wrapper around `proxmox_sys::fs::file_read_optional_string` which also returns `None` upon error
-/// after logging it.
-fn attempt_file_read<P: AsRef<Path>>(path: P) -> Option<String> {
-    match fs::file_read_optional_string(path.as_ref()) {
-        Ok(contents) => contents,
-        Err(err) => {
-            error!("unable to read {path:?}: {err:#}", path = path.as_ref());
-            None
+    /// Directory of the product's notification queue.
+    fn queue_dir(self) -> &'static str {
+        match self {
+            Self::Pve => "/var/lib/pve-manager/notifications/queue",
+            Self::Pbs => "/var/lib/proxmox-backup/notifications/queue",
         }
     }
+
+    /// Check whether the product is installed on this host.
+    ///
+    /// A product counts as installed if its notification queue directory exists.
+    fn is_installed(self) -> bool {
+        Path::new(self.queue_dir()).exists()
+    }
+
+    /// Name of the user that owns the notification queue.
+    fn user(self) -> &'static str {
+        match self {
+            Self::Pve => "www-data",
+            Self::Pbs => "backup",
+        }
+    }
+
+    /// Name of the group that owns the notification queue.
+    fn group(self) -> &'static str {
+        match self {
+            Self::Pve => "www-data",
+            Self::Pbs => "backup",
+        }
+    }
+
+    /// Look up the ID of the user that owns the notification queue.
+    fn uid(self) -> Result<Uid, Error> {
+        let user = self.user();
+
+        let uid = User::from_name(user)
+            .with_context(|| format!("could not look up username {user}"))?
+            .with_context(|| format!("user {user} does not exist"))?
+            .uid;
+
+        Ok(uid)
+    }
+
+    /// Look up the ID of the group that owns the notification queue.
+    fn gid(self) -> Result<Gid, Error> {
+        let group = self.group();
+
+        let gid = Group::from_name(group)
+            .with_context(|| format!("could not look up group {group}"))?
+            .with_context(|| format!("group {group} does not exist"))?
+            .gid;
+
+        Ok(gid)
+    }
 }
 
 /// Read data from stdin, until EOF is encountered.
@@ -61,55 +121,53 @@ fn read_stdin() -> Result<Vec<u8>, Error> {
     Ok(input)
 }
 
-fn forward_common(mail: &[u8], config: &Config) -> Result<(), Error> {
-    let real_uid = nix::unistd::getuid();
-    // The uid is passed so that `sendmail` can be called as the a correct user.
-    // (sendmail will show a warning if called from a setuid process)
-    let notification =
-        proxmox_notify::Notification::new_forwarded_mail(mail, Some(real_uid.as_raw()))?;
+fn installed_product() -> Result<Product, Error> {
+    Product::ALL
+        .iter()
+        .copied()
+        .find(|product| product.is_installed())
+        .context("no supported Proxmox product installed")
+}
 
-    proxmox_notify::api::common::send(config, &notification)?;
+/// Permanently switch to `uid` and `gid`, dropping all supplementary groups.
+///
+/// The real, effective and saved IDs are all set, so that the original privileges cannot be
+/// regained afterwards.
+fn drop_privileges(uid: Uid, gid: Gid) -> Result<(), Error> {
+    // Supplementary groups and the group IDs can only be changed while still privileged, so the
+    // user ID must be changed last.
+    nix::unistd::setgroups(&[]).context("could not drop supplementary groups")?;
+    nix::unistd::setresgid(gid, gid, gid).with_context(|| format!("could not set gid to {gid}"))?;
+    nix::unistd::setresuid(uid, uid, uid).with_context(|| format!("could not set uid to {uid}"))?;
+
+    if uid != Uid::from_raw(0) && nix::unistd::setuid(Uid::from_raw(0)).is_ok() {
+        bail!("root privileges could be regained after dropping them");
+    }
 
     Ok(())
 }
 
-/// Forward a mail to PVE's notification system
-fn forward_for_pve(mail: &[u8]) -> Result<(), Error> {
-    proxmox_notify::context::set_context(&PVE_CONTEXT);
-    let config = attempt_file_read(PVE_PUB_NOTIFICATION_CFG_FILENAME).unwrap_or_default();
-    let priv_config = attempt_file_read(PVE_PRIV_NOTIFICATION_CFG_FILENAME).unwrap_or_default();
+fn forward_mail_from_stdin() -> Result<(), Error> {
+    let product = installed_product()?;
+    drop_privileges(product.uid()?, product.gid()?)?;
 
-    let config = Config::new(&config, &priv_config)?;
+    let mail = read_stdin().context("could not read mail from STDIN")?;
 
-    forward_common(mail, &config)
-}
+    // Files are created by the queue's owner now, so only the mode needs to be set explicitly.
+    let queue = QueueSubmitter::new(
+        product.queue_dir(),
+        CreateOptions::new().perm(Mode::from_bits_truncate(0o0660)),
+    );
 
-/// Forward a mail to PBS's notification system
-fn forward_for_pbs(mail: &[u8], has_pve: bool) -> Result<(), Error> {
-    proxmox_notify::context::set_context(&PBS_CONTEXT);
+    let notification = Notification::forwarded_mail_builder(mail)
+        .severity(Severity::Unknown)
+        .field("hostname", proxmox_sys::nodename())
+        .field("type", "system-mail")
+        .build()?;
 
-    let config = if Path::new(PBS_PUB_NOTIFICATION_CFG_FILENAME).exists() {
-        let config = attempt_file_read(PBS_PUB_NOTIFICATION_CFG_FILENAME).unwrap_or_default();
-        let priv_config = attempt_file_read(PBS_PRIV_NOTIFICATION_CFG_FILENAME).unwrap_or_default();
-
-        Config::new(&config, &priv_config)?
-    } else {
-        // Instantiate empty config.
-        // Note: This will contain the default built-in targets/matchers.
-        let config = Config::new("", "")?;
-        if has_pve {
-            // Skip forwarding if we are co-installed with PVE AND
-            // we do not have our own notifications.cfg file yet
-            // --> We assume that PVE has a sane matcher configured that
-            // forwards the mail properly
-            // TODO: This can be removed once PBS has full notification integration
-
-            return Ok(());
-        }
-        config
-    };
-
-    forward_common(mail, &config)?;
+    queue
+        .submit(&notification)
+        .context("could not submit mail to notification queue")?;
 
     Ok(())
 }
@@ -119,31 +177,10 @@ fn main() {
         .journald()
         .init()
     {
-        eprintln!("unable to initialize syslog: {err}");
+        eprintln!("unable to initialize logging: {err}");
     }
 
-    // Read the mail that is to be forwarded from stdin
-    match read_stdin() {
-        Ok(mail) => {
-            let mut has_pve = false;
-
-            // Assume a PVE installation if /etc/pve exists
-            if Path::new(PVE_CFG_PATH).exists() {
-                has_pve = true;
-                if let Err(err) = forward_for_pve(&mail) {
-                    error!("could not forward mail for Proxmox VE: {err:#}");
-                }
-            }
-
-            // Assume a PBS installation if /etc/proxmox-backup exists
-            if Path::new(PBS_CFG_PATH).exists() {
-                if let Err(err) = forward_for_pbs(&mail, has_pve) {
-                    error!("could not forward mail for Proxmox Backup Server: {err:#}");
-                }
-            }
-        }
-        Err(err) => {
-            error!("could not read mail from STDIN: {err:#}")
-        }
+    if let Err(err) = forward_mail_from_stdin() {
+        error!("proxmox-mail-forward could not forward email: {err:#}");
     }
 }
-- 
2.47.3





  parent reply	other threads:[~2026-11-18  9:53 UTC|newest]

Thread overview: 66+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-18  9:42 [PATCH many v2 00/63] notify: maintenance, PDM preparations, queue + worker Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 01/63] notify: disallow `unsafe` code Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 02/63] notify: refactor error type Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 03/63] notify: move `Endpoint` trait to endpoint module as pub(crate) Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 04/63] notify: use ConfigDigest instead of raw byte arrays Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 05/63] notify: remove static context and pass context as parameter Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 06/63] notify: matcher: drop unused field matcher verifiers Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 07/63] notify: introduce 'send-impl', 'api-impl' and 'api-types' features Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 08/63] notify: matcher: make matcher validation methods public Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 09/63] notify: matcher: stub CalendarMatcher::matches on wasm32 Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 10/63] notify: make SendmailEndpoint and SmtpEndpoint private types Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 11/63] notify: move `send`, `test_target` and `Bus` to new `send` module Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 12/63] notify: move Origin type to api_types module Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 13/63] notify: move Target " Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 14/63] notify: move Config to config module Lukas Wagner
2026-11-18  9:42 ` [PATCH proxmox v2 15/63] notify: move Notification and sub-types to `notification` module Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 16/63] notify: move schema module to api_types Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 17/63] notify: move check_matches from api_types::matcher to send::Bus Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 18/63] notify: move TemplateSource to context module Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 19/63] notify: config: cleanup helper names and visibility Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 20/63] notify: config: rename section config parser/writer methods Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 21/63] notify: config: pass builtins explicitly when parsing section config Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 22/63] notify: implement PartialEq for all Config types Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 23/63] notify: use typed SectionConfigData Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 24/63] notify: api: api types: rename Deleteable* -> Deletable* Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 25/63] notify: context: parse builtin config only once Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 26/63] notify: context: parse proxy config in trait impl, not at the callsite Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 27/63] notify: gate sub-modules with the appropriate feature flags Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 28/63] notify: fold mail-forwarder feature into send-impl Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 29/63] notify: forwarded mails: don't hardcode severity and metadata fields Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 30/63] notify: don't pass uid when instantiating forwarded mail notifications Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 31/63] notify: derive PartialEq for Notification type Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 32/63] notify: add getters for severity and fields on " Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 33/63] notify: add test suite for " Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 34/63] notify: serialize raw, forwarded mail content as base64 Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 35/63] notify: unify code paths for legacy-sendmail and regular notifications Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 36/63] notify: add backwards-compat note to Notification type Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 37/63] notify: remove 'test_target' API Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 38/63] notify: replace notification instantiation with builder pattern Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 39/63] notify: add send receipts Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 40/63] notify: make sure that template name matches SAFE_ID_REGEX Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 41/63] notify: implement notification queue submitter Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 42/63] notify: context: add read_config Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 43/63] notify: queue: add queue consumer Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox v2 44/63] notify: queue: add worker task Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-backup v2 45/63] notifications: don't ignore verification errors in legacy-sendmail mode Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-backup v2 46/63] notifications: adapt to proxmox-notify API changes Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-backup v2 47/63] api: notification: send test notification via proxmox_notify::send Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-backup v2 48/63] notifications: send all notifications via proxmox-notify's queue Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-perl-rs v2 49/63] pve: notify: adapt to changes in the public API of proxmox-notify Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-perl-rs v2 50/63] pve: notify: add `PVE::RS::Notify::enqueue` method Lukas Wagner
2026-11-18  9:43 ` [PATCH pve-cluster v2 51/63] notify: send notifications via notification queue Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 52/63] vzdump: send legacy-sendmail notifications via simplified API Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 53/63] debian: create notification queue directory via tmpfiles Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 54/63] debian: add 'pve-notify-worker' as dependecy Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 55/63] api: services: add 'pve-notify-worker' as known service Lukas Wagner
2026-11-18  9:43 ` [PATCH manager v2 56/63] services: request pve-notify-worker.service via Wants Lukas Wagner
2026-11-18  9:43 ` Lukas Wagner [this message]
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 58/63] use return code to signal permanent or temporary failure Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 59/63] limit size of mail read from stdin Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 60/63] cargo: move mail forwarder into a workspace member crate Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 61/63] add crate for code shared between the mail-forwarder and the worker Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 62/63] add pve-notify-worker crate and package Lukas Wagner
2026-11-18  9:43 ` [PATCH proxmox-mail-forward v2 63/63] debian: add versioned break for pve-manager and proxmox-backup-server Lukas Wagner
2026-11-18 21:44 ` [PATCH many v2 00/63] notify: maintenance, PDM preparations, queue + worker Thomas Lamprecht
2026-11-19 10:45   ` 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=20261118094348.273646-58-l.wagner@proxmox.com \
    --to=l.wagner@proxmox.com \
    --cc=pve-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal