From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 1AC4C1FF142 for ; Mon, 16 Feb 2026 08:40:15 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 094316D3E; Mon, 16 Feb 2026 08:41:01 +0100 (CET) From: Arthur Bied-Charreton To: pve-devel@lists.proxmox.com Subject: [PATCH pve-docs 1/1] notifications: Add section about OAuth2 to SMTP targets docs Date: Fri, 13 Feb 2026 17:04:15 +0100 Message-ID: <20260213160415.609868-18-a.bied-charreton@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260213160415.609868-1-a.bied-charreton@proxmox.com> References: <20260213160415.609868-1-a.bied-charreton@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.235 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 KAM_LAZY_DOMAIN_SECURITY 1 Sending domain does not have any anti-forgery methods POISEN_SPAM_PILL 0.1 Meta: its spam POISEN_SPAM_PILL_1 0.1 random spam to be learned in bayes POISEN_SPAM_PILL_3 0.1 random spam to be learned in bayes RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RDNS_NONE 0.793 Delivered to internal network by a host with no rDNS SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_NONE 0.001 SPF: sender does not publish an SPF Record WEIRD_PORT 0.001 Uses non-standard port number for HTTP Message-ID-Hash: UE3IFK3PJV5YLH7GSRCNLPOVMWPAXPSF X-Message-ID-Hash: UE3IFK3PJV5YLH7GSRCNLPOVMWPAXPSF X-MailFrom: abied-charreton@jett.proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Document the new config entries and the requirements to use XOAUTH2 for SMTP notification targets, and add notes/warnings to communicate that: 1. User intervention is required for initial OAuth2 target setup, and 2. Microsoft OAuth2 apps *must not* be configured as SPAs by the user, since it would prevent PVE from automatically extending the refresh token's lifetime Signed-off-by: Arthur Bied-Charreton --- notifications.adoc | 99 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 99 insertions(+) diff --git a/notifications.adoc b/notifications.adoc index 801b327..1ff0552 100644 --- a/notifications.adoc +++ b/notifications.adoc @@ -108,10 +108,17 @@ The configuration for SMTP target plugins has the following options: * `from-address`: Sets the From-address of the email. SMTP relays might require that this address is owned by the user in order to avoid spoofing. The `From` header in the email will be set to `$author <$from-address>`. +* `auth-method`: Sets the authentication method (`plain`, `google-oauth2` or + `microsoft-oauth2`). * `username`: Username to use during authentication. If no username is set, no authentication will be performed. The PLAIN and LOGIN authentication methods are supported. * `password`: Password to use when authenticating. +* `oauth2-client-id`: Client ID for the OAuth2 application, if applicable. +* `oauth2-client-secret`: Client secret for the OAuth2 application, if + applicable. +* `oauth2-tenant-id`: Tenant ID for the OAuth2 application, if applicable. + Only required for Microsoft OAuth2. * `mode`: Sets the encryption mode (`insecure`, `starttls` or `tls`). Defaults to `tls`. * `server`: Address/IP of the SMTP relay. @@ -140,6 +147,98 @@ smtp: example password somepassword ---- +[[notification_targets_smtp_oauth2]] +==== OAuth2 Authentication + +{pve} supports OAuth2 authentication for SMTP targets via the XOAUTH2 +mechanism. This is currently available for Google and Microsoft mail providers. + +===== Creating an OAuth2 Application + +Before configuring OAuth2 in {pve}, you must register an OAuth2 application +with your mail provider: + +* https://developers.google.com/identity/protocols/oauth2/web-server[Google] +* https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app[Microsoft Entra ID] + +Choose *Web application* as application type. + +During registration, add a redirect URI pointing to the {pve} web interface +URL from which you will perform the authorization flow, for example: + +* `https://pve1.yourdomain.com:8006` +* `https://localhost:8006` + +You can add multiple redirect URIs to allow the authorization flow to work from +any cluster node. + +NOTE: Google does not allow bare IP addresses as redirect URIs. See +<> below for a +workaround. + +===== Configuring OAuth2 in {pve} + +In the web UI, open the notification target's edit panel and select +`OAuth2 (Google)` or `OAuth2 (Microsoft)` as the authentication method. Fill in +the client ID and secret. For Microsoft, also fill in the tenant ID. + +Click *Authenticate*. This opens a new window where you can sign in with your +mail provider and grant the requested permissions. On success, a refresh token +is obtained and stored. + +Token refresh happens automatically, at least once every 24 hours. If the token +expires due to extended cluster downtime or is revoked, you will need to +re-authenticate: open the notification target's edit panel, fill in your client +secret, and click *Authenticate* again. + +NOTE: OAuth2 cannot be configured through direct configuration file editing. Use +the web interface, or alternatively `pvesh`, to configure OAuth2 targets. Note +that when using `pvesh`, you are responsible for providing the initial refresh +token. + +---- +pvesh create /cluster/notifications/endpoints/smtp \ + --name oauth2-smtp \ + --server smtp.example.com \ + --from-address from@example.com \ + --mailto-user root@pam \ + --auth-method google-oauth2 \ + --oauth2-client-id \ + --oauth2-client-secret \ + --oauth2-refresh-token +---- + +For Microsoft, use `--auth-method microsoft-oauth2` and add +`--oauth2-tenant-id `. + +[[notification_targets_smtp_oauth2_google]] +===== Google + +Google does not allow bare IP addresses as redirect URIs. To work around this, +add an entry to `/etc/hosts` *on the machine where your browser is running*, +i.e., your local workstation. + +---- +# Replace with the IP address of your PVE node + local.oauth2-redirect.com +---- + +You can now register `https://local.oauth2-redirect.com:8006` as a redirect +URI in your Google OAuth2 application, and use that same URL in the browser +when accessing the {pve} web interface to perform the authorization flow. + +[[notification_targets_smtp_oauth2_microsoft]] +===== Microsoft + +WARNING: For Microsoft, the application must *not* be registered as a +Single-Page Application (SPA). {pve} requires long-lived refresh tokens, and +Microsoft does not allow extending the lifetime of refresh tokens granted for +SPAs. + +Register your OAuth2 application as a standard *Web* application in the Entra +admin center. In addition to the client ID and secret, you will also need the +*tenant ID* from your application registration. + [[notification_targets_gotify]] Gotify ~~~~~~ -- 2.47.3