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 35BDF1FF173
for <inbox@lore.proxmox.com>; Mon, 24 Mar 2025 03:46:45 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id F1F579464;
Mon, 24 Mar 2025 03:46:40 +0100 (CET)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20230601; t=1742784361; x=1743389161;
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=ytqGM3TjgRP0j1cuA82Y4LOsZtN4wHhlye1vO64qaLE=;
b=OIdatWGcU4NPnxeMSzXvLGo9rCf6YdWJIhf7yNK+3xWtT4pTG7ZmLEoMgQJNmj0eTv
sF1dCpZFumU+Gz7hTLyKh26eKw+F6+kJl/MrwWWBHJCyBVMmXudeFnrOBaVmOriYwet/
fq5DfpV/1va5xIU+wG2ZawZbnuR9oG7crvSrRHHIoWga2OPP2RwlQ+qS6L8+SSESuMF3
1JLhBPS+VDy5Kwz7oprg2SlqXKIy5Vgm8Gh0uo3FpuVKMR9BWzQ9Fs3y4/N7QEdF/eod
ZXMbtPgZZhf48BrenqXIYoaLGlTv1emkbl7c3/wI4OGrWK73l/2uUZAX0a5h04cSeTn8
K/GA==
X-Gm-Message-State: AOJu0YxrwVK5Mez3IK13bvv3j7JDJCy9FUBkWDWeZCgbbFBITRCoMoIQ
5rAmtGZzsX3nYToZXqjxuyxVF5cHpKiuBrSdJ9WpS07BQLSVKw5AEusPPg==
X-Gm-Gg: ASbGncsVO75j9V3bG33aoK1fPpwHR1GIn6+PeXvG8BftI4OhPfZmP3DzXicj3/xiCqS
Y91r9+kQDM+14pSN17R+pEsDadQVvDc/sSIGNeJPBCSUuCa3ygvGgvmwAvrgyqcgL0tlmB1xMVx
tsv+M2JQHzTRjBxd4/g9wVIkkDZneXlmAclyh3ztsIwoc/yEd9yJt+MROdFVzgh6PguTbCbGu0W
13dvD9hcdL18smQRK2LXll6+Nz0h7ToExNmQPiaQf5Q1r95yRJcBvrdXQxtovTxcUhCh6t2B/rg
TSVJJDrJuUMV5HmgpfsdNk9zpkKNWC6EPaX/7rgGq0wOQ6TOdquumWqmrUNAFVGtWEAaLXrqi/T
dalz2IIom+Wmf/k2hOfQEZQXsyevTCVxDF3DFULBpA3/yjfX1AjlvtU0H0A==
X-Google-Smtp-Source: AGHT+IG8Q/NmqQ7+HCRSXKlBbfXmY8/ZRIhMEG2CZ+rEi4S2lxllmf+qs5Fr/PIF7Vks23zufdIjwg==
X-Received: by 2002:a05:690c:dd4:b0:6f9:56a2:80f9 with SMTP id
00721157ae682-700bacfba88mr159660037b3.27.1742783870676;
Sun, 23 Mar 2025 19:37:50 -0700 (PDT)
From: Thomas Skinner <thomas@atskinner.net>
To: pve-devel@lists.proxmox.com
Date: Sun, 23 Mar 2025 21:37:25 -0500
Message-Id: <20250324023728.1294436-2-thomas@atskinner.net>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20250324023728.1294436-1-thomas@atskinner.net>
References: <20250324023728.1294436-1-thomas@atskinner.net>
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results: 0
AWL -0.016 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.062 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.01 Average reputation (+2)
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 v4 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 | 37 +++++++++++++++++++++++++++++++++++++
1 file changed, 37 insertions(+)
diff --git a/pveum.adoc b/pveum.adoc
index 81565ab..5da0e98 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,34 @@ 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.
+
+Advanced settings
+^^^^^^^^^^^^^^^^^
+
Examples
^^^^^^^^
--
2.39.5
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel