From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH proxmox-mail-forward v2 61/63] add crate for code shared between the mail-forwarder and the worker
Date: Wed, 18 Nov 2026 10:43:45 +0100 [thread overview]
Message-ID: <20261118094348.273646-62-l.wagner@proxmox.com> (raw)
In-Reply-To: <20261118094348.273646-1-l.wagner@proxmox.com>
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
Cargo.toml | 3 ++
Makefile | 2 +-
common/Cargo.toml | 13 ++++++
common/src/lib.rs | 78 ++++++++++++++++++++++++++++++++
proxmox-mail-forward/Cargo.toml | 2 +
proxmox-mail-forward/src/main.rs | 74 +-----------------------------
6 files changed, 99 insertions(+), 73 deletions(-)
create mode 100644 common/Cargo.toml
create mode 100644 common/src/lib.rs
diff --git a/Cargo.toml b/Cargo.toml
index e6e70c6..27e4d8e 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,5 +1,6 @@
[workspace]
members = [
+ "common",
"proxmox-mail-forward",
]
resolver = "3"
@@ -22,3 +23,5 @@ nix = "0.29"
proxmox-log = "1"
proxmox-notify = "2"
proxmox-sys = "1"
+
+common = { path = "common" }
diff --git a/Makefile b/Makefile
index 72ae89a..0c7dc72 100644
--- a/Makefile
+++ b/Makefile
@@ -22,7 +22,7 @@ CARGO ?= cargo
$(BUILDDIR):
rm -rf $@ $@.tmp && mkdir $@.tmp
- cp -a debian Cargo.toml proxmox-mail-forward Makefile .cargo $@.tmp
+ cp -a debian Cargo.toml common proxmox-mail-forward Makefile .cargo $@.tmp
rm -f $@.tmp/Cargo.lock
find $@.tmp/debian -name "*.hint" -delete
mv $@.tmp $@
diff --git a/common/Cargo.toml b/common/Cargo.toml
new file mode 100644
index 0000000..e66ec5e
--- /dev/null
+++ b/common/Cargo.toml
@@ -0,0 +1,13 @@
+[package]
+name = "common"
+description = "Shared definitions for the Proxmox mail forwarder and notification worker"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
+homepage.workspace = true
+publish = false
+
+[dependencies]
+anyhow.workspace = true
+nix = { workspace = true, features = [ "user" ] }
diff --git a/common/src/lib.rs b/common/src/lib.rs
new file mode 100644
index 0000000..fe03064
--- /dev/null
+++ b/common/src/lib.rs
@@ -0,0 +1,78 @@
+//! Definitions shared between the Proxmox mail forwarder and the notification worker.
+
+#![deny(unsafe_code)]
+#![deny(missing_docs)]
+
+use std::path::Path;
+
+use anyhow::{Context, Error};
+use nix::unistd::{Gid, Group, Uid, User};
+
+/// A Proxmox product whose notifications are processed via a notification queue.
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+pub enum Product {
+ /// Proxmox VE
+ Pve,
+ /// Proxmox Backup Server
+ Pbs,
+}
+
+impl Product {
+ /// All supported products, in order of precedence.
+ pub const ALL: &[Product] = &[Product::Pve, Product::Pbs];
+
+ /// Directory of the product's notification queue.
+ pub 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.
+ pub fn is_installed(self) -> bool {
+ Path::new(self.queue_dir()).exists()
+ }
+
+ /// Name of the user that owns the notification queue.
+ pub fn user(self) -> &'static str {
+ match self {
+ Self::Pve => "www-data",
+ Self::Pbs => "backup",
+ }
+ }
+
+ /// Name of the group that owns the notification queue.
+ pub 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.
+ pub 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.
+ pub 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)
+ }
+}
diff --git a/proxmox-mail-forward/Cargo.toml b/proxmox-mail-forward/Cargo.toml
index c3f7f7d..ef3e4a7 100644
--- a/proxmox-mail-forward/Cargo.toml
+++ b/proxmox-mail-forward/Cargo.toml
@@ -11,6 +11,8 @@ homepage.workspace = true
anyhow.workspace = true
nix.workspace = true
+common.workspace = true
+
proxmox-log.workspace = true
proxmox-notify = { workspace = true, features = ["queue-submitter"] }
proxmox-sys.workspace = true
diff --git a/proxmox-mail-forward/src/main.rs b/proxmox-mail-forward/src/main.rs
index 60c8336..0673728 100644
--- a/proxmox-mail-forward/src/main.rs
+++ b/proxmox-mail-forward/src/main.rs
@@ -23,7 +23,6 @@
//! reading the mail from stdin.
use std::io::Read;
-use std::path::Path;
use std::process::ExitCode;
use anyhow::Context;
@@ -31,9 +30,9 @@ 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 common::Product;
use proxmox_log::LevelFilter;
use proxmox_log::Logger;
@@ -74,75 +73,6 @@ impl std::fmt::Display for ForwardError {
}
}
-/// 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,
-}
-
-impl Product {
- /// All supported products, in order of precedence.
- const ALL: &[Product] = &[Product::Pve, Product::Pbs];
-
- /// 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)
- }
-}
-
/// Maximum number of bytes read from stdin, as a safeguard against excessively large mails.
const MAX_MAIL_SIZE: u64 = 1024 * 1024;
--
2.47.3
next prev parent reply other threads:[~2026-11-18 9:52 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 ` [PATCH proxmox-mail-forward v2 57/63] forward mails via notification queue Lukas Wagner
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 ` Lukas Wagner [this message]
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-62-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.