public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Arthur Bied-Charreton <a.bied-charreton@proxmox.com>
To: Lukas Wagner <l.wagner@proxmox.com>
Cc: pve-devel@lists.proxmox.com
Subject: Re: [PATCH proxmox 2/7] notify (smtp): Introduce state module
Date: Mon, 23 Mar 2026 17:32:23 +0100	[thread overview]
Message-ID: <xueqfcq7cmqiup7heyp4dx3g4vkb3hwrjyuxjko3vnlikdodsk@7tmjjyep5fzc> (raw)
In-Reply-To: <DHA5SAKGQAN1.BVWSK7UCNBR8@proxmox.com>

On Mon, Mar 23, 2026 at 01:26:05PM +0100, Lukas Wagner wrote:
> Hi Arthur!
> 
> Generally we'd write the commit subject rather like this:
> 
>  "notify: smtp: ...."
> 
>  instead of
> 
>  "notify (smtp): ..."
> 
>  (but not a big deal IMO, just mentioning it)
> 
ACK, got my conventions confused, my bad
> 
[...]
> > @@ -32,6 +34,10 @@ pub trait Context: Send + Sync + Debug {
> >          namespace: Option<&str>,
> >          source: TemplateSource,
> >      ) -> Result<Option<String>, Error>;
> > +    /// Return the path to the state file for this context.
> > +    fn state_file_path(&self, name: &str) -> String;
> 
> I think this should rather return a PathBuf. And rename `name` ->
> `endpoint_name`?
> 
Thanks for catching that, I could not do the usual `P: AsRef<Path>` and
somehow fell back to `String` directly..

> > +    /// Create options to be used when writing files containing secrets.
> > +    fn secret_create_options(&self) -> CreateOptions;
> 
> Due to CreateOptions being part of the `Context` trait now, we need to
> pull in proxmox-sys unconditionally:
> 
> diff --git i/proxmox-notify/Cargo.toml w/proxmox-notify/Cargo.toml
> index d816c695..35d5b8cb 100644
> --- i/proxmox-notify/Cargo.toml
> +++ w/proxmox-notify/Cargo.toml
> @@ -36,17 +36,15 @@ proxmox-schema = { workspace = true, features = ["api-macro", "api-types"] }
>  proxmox-section-config = { workspace = true }
>  proxmox-serde.workspace = true
>  proxmox-sendmail = { workspace = true, optional = true }
> -proxmox-sys = { workspace = true, optional = true }
> +proxmox-sys = { workspace = true }
>  proxmox-time.workspace = true
>  proxmox-uuid = { workspace = true, features = ["serde"] }
>  nix.workspace = true
>  
>  [features]
>  default = ["sendmail", "gotify", "smtp", "webhook"]
> -mail-forwarder = ["dep:mail-parser", "dep:proxmox-sys", "proxmox-sendmail/mail-forwarder"]
> -sendmail = ["dep:proxmox-sys", "dep:proxmox-sendmail"]
> +mail-forwarder = ["dep:mail-parser", "proxmox-sendmail/mail-forwarder"]
> +sendmail = ["dep:proxmox-sendmail"]
>  gotify = ["dep:proxmox-http", "dep:http"]
> -pve-context = ["dep:proxmox-sys"]
> -pbs-context = ["dep:proxmox-sys"]
> -smtp = ["dep:lettre", "dep:oauth2", "dep:ureq", "dep:http", "dep:proxmox-sys"]
> +smtp = ["dep:lettre", "dep:oauth2", "dep:ureq", "dep:http"]
>  webhook = ["dep:http", "dep:percent-encoding", "dep:proxmox-base64", "dep:proxmox-http"]
> 
> 
ACK
> 
> >  }
> >  
> >  #[cfg(not(test))]
> > diff --git a/proxmox-notify/src/context/pbs.rs b/proxmox-notify/src/context/pbs.rs
> > index 3e5da59c..4f93b45d 100644
> > --- a/proxmox-notify/src/context/pbs.rs
> > +++ b/proxmox-notify/src/context/pbs.rs
> > @@ -125,6 +125,14 @@ impl Context for PBSContext {
> >              .map_err(|err| Error::Generic(format!("could not load template: {err}")))?;
> >          Ok(template_string)
> >      }
> > +
> > +    fn state_file_path(&self, name: &str) -> String {
> > +        format!("/var/lib/proxmox-backup/priv/notifications/{name}.json")
> > +    }
> > +
> > +    fn secret_create_options(&self) -> proxmox_sys::fs::CreateOptions {
> > +        proxmox_sys::fs::CreateOptions::new().perm(nix::sys::stat::Mode::from_bits_truncate(0o600))
> 
> (1) In the trait impl, you could get the appropriate CreateOptions via
> proxmox-product-config...
> 
> > +    }
> >  }
> >  
> >  #[cfg(test)]
> > diff --git a/proxmox-notify/src/context/pve.rs b/proxmox-notify/src/context/pve.rs
> > index a97cce26..e30f7b49 100644
> > --- a/proxmox-notify/src/context/pve.rs
> > +++ b/proxmox-notify/src/context/pve.rs
> > @@ -74,6 +74,14 @@ impl Context for PVEContext {
> >              .map_err(|err| Error::Generic(format!("could not load template: {err}")))?;
> >          Ok(template_string)
> >      }
> > +
> > +    fn state_file_path(&self, name: &str) -> String {
> > +        format!("/etc/pve/priv/notifications/{name}.json")
> 
> I think `state` should be somewhere in the path -- so maybe one of
> 
>   - priv/notification-endpoint-state/{name}.json
>   - priv/notification-state/{name}.json
>   - priv/notifications/state-{name}.json
> 
Makes sense, thanks for the suggestion. Will use the third one, 
it allows using the already existing /priv/notifications directory.
> > +    }
> > +
> > +    fn secret_create_options(&self) -> proxmox_sys::fs::CreateOptions {
> > +        proxmox_sys::fs::CreateOptions::new().perm(nix::sys::stat::Mode::from_bits_truncate(0o600))
> 
> (2) ... here as well, but you probably need to initialize
> proxmox-product-config in the proxmox-perl-rs bindings with the correct
> UIDs.
> 
ACK this and the other proxmox-product-config comment, will integrate
that crate in v2, thanks

[...]
> > +    /// Persist the state for the endpoint identified by `name`.
> > +    ///
> > +    /// # Errors
> > +    /// An [`Error`] is returned if serialization of the state object, or the final write, fail.
> > +    pub(crate) fn store(self, name: &str) -> Result<(), Error> {
> > +        let path = context().state_file_path(name);
> > +        let parent = std::path::Path::new(&path).parent().unwrap();
> > +
> > +        proxmox_sys::fs::ensure_dir_exists(parent, &context().secret_create_options(), false)
> > +            .map_err(|e| Error::ConfigSerialization(e.into()))?;
> 
> I'm getting a "bad permissions on "/etc/pve/priv/notifications" (0o700
> != 0o600)" error in the system/task logs when the token is refreshed.
> The CreateOptions provided by the context are 0o600, but I think pmxcfs
> automatically enforces the x-bit on directories, leading to 0o700 perms
> on the '/etc/pve/priv/notifications/' directory, which ultimately gives
> us this error. I think you either have to add a separate trait method
> for the directory permissions/CreateOptions, or add the x-bit to the
> existing CreateOptions yourself here at the callsite.
> 
Thanks for catching that! Will fix in v2
> > +
> > +        let s = serde_json::to_string_pretty(&self)
> > +            .map_err(|e| Error::ConfigSerialization(e.into()))?;
> > +
> > +        proxmox_sys::fs::replace_file(path, s.as_bytes(), context().secret_create_options(), true)
> > +            .map_err(|e| Error::ConfigSerialization(e.into()))
> > +    }
> > +
> > +    /// Set `last_refreshed`.
> > +    pub(crate) fn set_last_refreshed(mut self, last_refreshed: i64) -> Self {
> > +        self.last_refreshed = last_refreshed;
> > +        self
> > +    }
> > +
> > +    /// Set `oauth2_refresh_token`.
> > +    pub(crate) fn set_oauth2_refresh_token(mut self, oauth2_refresh_token: Option<String>) -> Self {
> > +        self.oauth2_refresh_token = oauth2_refresh_token;
> > +        self
> > +    }
> > +}
> 




  reply	other threads:[~2026-03-23 16:32 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-13 16:03 [PATCH cluster/docs/manager/proxmox{,-perl-rs,-widget-toolkit} 00/17] fix #7238: Add XOAUTH2 authentication support for SMTP notification targets Arthur Bied-Charreton
2026-02-13 16:03 ` [PATCH proxmox 1/7] notify (smtp): Introduce xoauth2 module Arthur Bied-Charreton
2026-02-13 16:04 ` [PATCH proxmox 2/7] notify (smtp): Introduce state module Arthur Bied-Charreton
2026-03-23 12:26   ` Lukas Wagner
2026-03-23 16:32     ` Arthur Bied-Charreton [this message]
2026-03-24  8:50     ` Arthur Bied-Charreton
2026-02-13 16:04 ` [PATCH proxmox 3/7] notify (smtp): Factor out transport building logic into own function Arthur Bied-Charreton
2026-02-13 16:04 ` [PATCH proxmox 4/7] notify (smtp): Update API with OAuth2 parameters Arthur Bied-Charreton
2026-02-13 16:04 ` [PATCH proxmox 5/7] notify (smtp): Add state handling logic Arthur Bied-Charreton
2026-03-23 12:26   ` Lukas Wagner
2026-02-13 16:04 ` [PATCH proxmox 6/7] notify (smtp): Add XOAUTH2 authentication support Arthur Bied-Charreton
2026-03-23 12:26   ` Lukas Wagner
2026-02-13 16:04 ` [PATCH proxmox 7/7] notify (smtp): Add logging and state-related error types Arthur Bied-Charreton
2026-03-23 12:26   ` Lukas Wagner
2026-02-13 16:04 ` [PATCH proxmox-perl-rs 1/1] notify (smtp): add oauth2 parameters to bindings Arthur Bied-Charreton
2026-03-23 12:26   ` Lukas Wagner
2026-03-23 16:44     ` Arthur Bied-Charreton
2026-02-13 16:04 ` [PATCH proxmox-widget-toolkit 1/2] utils: Add OAuth2 flow handlers Arthur Bied-Charreton
2026-03-23 12:26   ` Lukas Wagner
2026-02-13 16:04 ` [PATCH proxmox-widget-toolkit 2/2] notifications: Add opt-in OAuth2 support for SMTP targets Arthur Bied-Charreton
2026-03-23 12:26   ` Lukas Wagner
2026-03-23 16:49     ` Arthur Bied-Charreton
2026-02-13 16:04 ` [PATCH pve-manager 1/5] notifications: Add OAuth2 parameters to schema and add/update endpoints Arthur Bied-Charreton
2026-03-23 12:26   ` Lukas Wagner
2026-02-13 16:04 ` [PATCH pve-manager 2/5] notifications: Add trigger-state-refresh endpoint Arthur Bied-Charreton
2026-03-23 12:26   ` Lukas Wagner
2026-02-13 16:04 ` [PATCH pve-manager 3/5] notifications: Trigger notification target refresh in pveupdate Arthur Bied-Charreton
2026-02-13 16:04 ` [PATCH pve-manager 4/5] notifications: Handle OAuth2 callback in login handler Arthur Bied-Charreton
2026-02-13 16:04 ` [PATCH pve-manager 5/5] notifications: Opt into OAuth2 authentication Arthur Bied-Charreton
2026-02-13 16:04 ` [PATCH pve-cluster 1/1] notifications: Add refresh_targets subroutine to PVE::Notify Arthur Bied-Charreton
2026-03-23 12:26   ` Lukas Wagner
2026-03-23 16:54     ` Arthur Bied-Charreton
2026-02-13 16:04 ` [PATCH pve-docs 1/1] notifications: Add section about OAuth2 to SMTP targets docs Arthur Bied-Charreton
2026-03-23 12:25 ` [PATCH cluster/docs/manager/proxmox{,-perl-rs,-widget-toolkit} 00/17] fix #7238: Add XOAUTH2 authentication support for SMTP notification targets Lukas Wagner
2026-03-25 13:16 ` superseded: " Arthur Bied-Charreton

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=xueqfcq7cmqiup7heyp4dx3g4vkb3hwrjyuxjko3vnlikdodsk@7tmjjyep5fzc \
    --to=a.bied-charreton@proxmox.com \
    --cc=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 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