From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
by lore.proxmox.com (Postfix) with ESMTPS id 2D32A1FF16F
for <inbox@lore.proxmox.com>; Thu, 27 Mar 2025 02:58:17 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 322AE21D9;
Thu, 27 Mar 2025 02:58:12 +0100 (CET)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1743040687; x=1743645487;
h=content-transfer-encoding:mime-version:references:in-reply-to
:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc
:subject:date:message-id:reply-to;
bh=YfCWbXhFMW+e34FwqQugEOoGWyiAPQt4JL8zoqa77QE=;
b=syOHWui1xlWB7to/+ZMRf5nmcqjzIwmWJzAcqvZIeAjq9d5URA3gdg47TY2ktl/Lxc
SMchvK0mgV4kiGVJ0pQyolJQwcOMqM+DKM1YLdjIULNx6DHBde/Bc1kCi8yIevmWYNCF
IyYvE7+QKdfpaLU7g7W2yhisleKFZQuXzsIvbgVTVatokmbpQhEpVYKmFkA17g+UR03I
HqCkTYBlia7SxHkkRjSmm8zXihAcsYkn+gb5XBjRbdr50HQUn7gAIC0Y27DCvqaxKAme
Dmd2cVdFTEzEfk4Rtkme0kUaxtVoVRnY6k6beZcecmU/Ea0weR5V/HQDTeH+roaLQPba
35Ww==
X-Gm-Message-State: AOJu0Yx5F87S5FqiL7mj4L5bK1hfPRLx1rH/BtYCNgOaNY2EZN+a6W/8
RTDW1VELrnKFNKjdtn/9Qam3IX/b8RDRER+ysPjNFDa+Q/QcwEfX+iFi+QxS
X-Gm-Gg: ASbGncv9lf2oKt/bqX4rlnZM65k8+uEEV8lpF9pzx/8neP3Rwc0zDld1BGYx8FgVflM
4VOnueKmu6MQfH+IHYW5o5/1dHERJUyWnXgrhAR7ZMfyxMVKvjF3K+9Jk7lPYqpEKP6mdKBBWnJ
UlOoLkaPmOk5Z1kvUfiTWkZp+cJyjKMd4BeieeygvwDrhJ55XettxiB/Bjs7sDnZz8kWypkAvKy
BreSGhnwz1FYFXJVW0qt0kgisvvSZr6WPbzMAiV9PyO3MdSbjqh8yPItYt+5Ez5f5OAQ+R395Dv
3UDYTJelkyHIYIdLxXGBKCFBPJItMOXCEm32pe9bOJW7Uqk6xupD4UkYBIDyT5FYB+HWwCtpi33
vGgzPHKLOg3dX/ucweifi3BLaJ/2lg20+iB/R99FFvQvyJ0h0tLXFgOZOcw==
X-Google-Smtp-Source: AGHT+IHvbIN640xbLg58Zt30K7/Kix+S7axdcUxUqAj4VrFid1rAcV2uEzyZT+kO0a5T8wUB1InfSQ==
X-Received: by 2002:a05:690c:7242:b0:6ef:6d61:c254 with SMTP id
00721157ae682-70225120c7emr25481507b3.38.1743040212540;
Wed, 26 Mar 2025 18:50:12 -0700 (PDT)
From: Thomas Skinner <thomas@atskinner.net>
To: pve-devel@lists.proxmox.com
Date: Wed, 26 Mar 2025 20:49:59 -0500
Message-Id: <20250327015002.1982876-2-thomas@atskinner.net>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20250327015002.1982876-1-thomas@atskinner.net>
References: <20250327015002.1982876-1-thomas@atskinner.net>
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results: 0
AWL 0.006 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
FREEMAIL_FORGED_FROMDOMAIN 0.001 2nd level domains in From and EnvelopeFrom
freemail headers are different
FREEMAIL_FROM 0.001 Sender email is commonly abused enduser mail provider
HEADER_FROM_DIFFERENT_DOMAINS 0.007 From and EnvelopeFrom 2nd level mail
domains are different
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
RCVD_IN_DNSWL_NONE -0.0001 Sender listed at https://www.dnswl.org/,
no trust RCVD_IN_MSPIKE_H2 0.001 Average reputation (+2)
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.
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
Subject: [pve-devel] [PATCH docs v5 1/1] fix #4411: openid: add docs for
openid groups support
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Cc: Thomas Skinner <thomas@atskinner.net>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com>
Signed-off-by: Thomas Skinner <thomas@atskinner.net>
---
pveum.adoc | 34 ++++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
diff --git a/pveum.adoc b/pveum.adoc
index 81565ab..3b76aca 100644
--- a/pveum.adoc
+++ b/pveum.adoc
@@ -456,6 +456,15 @@ use the `autocreate` option to automatically add new users.
* `Username Claim` (`username-claim`): OpenID claim used to generate the unique
username (`subject`, `username` or `email`).
+* `Autocreate Groups` (`groups-autocreate`): Create all groups in the claim
+instead of using existing PVE groups (default behavior).
+
+* `Groups Claim` (`groups-claim`): OpenID claim used to retrieve the groups from
+the ID token or userinfo endpoint.
+
+* `Overwrite Groups` (`groups-overwrite`): Overwrite all groups assigned to user
+instead of appending to existing groups (default behavior).
+
Username mapping
^^^^^^^^^^^^^^^^
@@ -479,6 +488,31 @@ Another option is to use `email`, which also yields human readable
usernames. Again, only use this setting if the server guarantees the
uniqueness of this attribute.
+Groups mapping
+^^^^^^^^^^^^^^
+
+Specifying the `groups-claim` setting in the OpenID configuration enables group
+mapping functionality. The data provided in the `groups-claim` should be
+a list of strings that correspond to groups that a user should be a member of in
+{pve}. To prevent collisions, group names from the OpenID claim are suffixed
+with `-<realm name>` (e.g. for the OpenID group name `my-openid-group` in the
+realm `oidc`, the group name in {pve} would be `my-openid-group-oidc`).
+
+Any groups reported by the OpenID provider that do not exist in {pve} are
+ignored by default. If all groups reported by the OpenID provider should exist
+in {pve}, the `groups-autocreate` option may be used to automatically create
+these groups on user logins.
+
+By default, groups are appended to the user's existing groups. It may be
+desirable to overwrite any groups that the user is already a member in {pve}
+with those from the OpenID provider. Enabling the `groups-overwrite` setting
+removes all groups from the user in {pve} before adding the groups reported by
+the OpenID provider.
+
+In some cases, OpenID servers may send groups claims which include invalid
+characters for {pve} group IDs. Any groups that contain characters not allowed
+in a {pve} group name are not included and a warning will be sent to the logs.
+
Examples
^^^^^^^^
--
2.39.5
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel