From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id EFA3A1FF168 for ; Tue, 24 Dec 2024 21:25:36 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 2489E18F3C; Tue, 24 Dec 2024 21:25:31 +0100 (CET) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1735071891; x=1735676691; 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=r149fY1ixV9bG04TxMKQADr82J7kISsm5qeO67p6w2E=; b=uT4xBr1p6fwlqPeGXG6NP2tpFMJbDikHXGr6uNrE/Nu3S615/bZRA/D/9c2gSNimu3 Ohw5CTXCDfTX5U2RdvXcYZxnp9PuuNYbC49Q76gKLiTaJDESiDpbwlAIJI6MORcfBgQ1 QcUDzszpyUsqJhpEzyHhl0rg6hqe8E87lZctfL+uaw2iifhDLbroh2kqnOz3iNZQ9oJo 4AQmSO1LVKaKIWAFy0HroUmXHfGgXzwFqHT8s6DDNZB6D1S3NDAmFyliWcsb4GdFES4H Dmr2ir0AKkoxWjpixWhM8yUVTrmJHRQDG0wno6OD3AFPJT8OqMdk76eQPvsaCoNnQEKX SNNA== X-Gm-Message-State: AOJu0YyuzWei1xBxAZALRffpDSA79lqua8ZzvpML7Csq/Nuzhei7W1SK NyTLfJk9Z9SSki9/6qQV9vRMOehKyv6NwbBxNCzecMCNe9nsdPmCpX2oqw== X-Gm-Gg: ASbGncv2y1fhP6QOLn3SZEUzu1NEpnpiVECBezdy50Ntk1h41hFWd/Ct2bb2DNXfypT 1tEJYb+ZHkhUh2KaovttlLxFWoKTXAytCwi0G3nPBhA0ccHEMlt43yuOwVb8uqHa3/IQW+dDIdM MEMQJQOsYZxV6ZStS7rdul968lnyGzdRYbcmzqv4goUhfqa4WuCYe+UGWJhYWdcM1dvKGYdVfeY ipG4S/iTo8jPs8zCvlIlKmT0QdRBXbZJFyF45l5s0JaRSGbujLRgguWSTZVeDyag7GtKIOvcwhi 43us8eSTulY+FHjgHOIYzogvMChp4LCu/KAIqExbDk6kneW153za9F97z6EXUiQcgHj8Sg== X-Google-Smtp-Source: AGHT+IGR1ThgepCgx9qrkq0y6DS6QAOntMcBnL2mJ7c2UP9hwi8d7Yzx6E88smKR1el0H4R07HoJcA== X-Received: by 2002:a05:6902:1a48:b0:e49:5f2d:e71d with SMTP id 3f1490d57ef6-e538c267d16mr14417891276.21.1735071891640; Tue, 24 Dec 2024 12:24:51 -0800 (PST) From: Thomas Skinner To: pve-devel@lists.proxmox.com Date: Tue, 24 Dec 2024 14:24:26 -0600 Message-Id: <20241224202429.3072813-2-thomas@atskinner.net> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241224202429.3072813-1-thomas@atskinner.net> References: <20241224202429.3072813-1-thomas@atskinner.net> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL -0.086 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.156 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) 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 v2 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox VE development discussion Cc: Thomas Skinner Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" Signed-off-by: Thomas Skinner --- pveum.adoc | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/pveum.adoc b/pveum.adoc index 81565ab..36b7560 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,36 @@ 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}. Any groups reported by the OpenID provider that do not exist in {pve} are +ignored. If all groups reported by the OpenID provider should exist in {pve}, +the `groups-autocreate` option may be used. + +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. By default, each invalid character is replaced +with an underscore (`'_'`). To adjust the character used for replacement, adjust +the `groups-replace-character` setting to any valid character for a {pve} group +ID (i.e. includes alphanumeric characters and any of the following: `'-'`, +`'_'`, `'.'`). + +Advanced settings +^^^^^^^^^^^^^^^^^ + +* `Groups Replacement Character` (`groups-replace-character`): Character to +replace invalid characters in groups names from the OpenID provider. Default +behavior is to replace each invalid character with an underscore (`'_'`). + Examples ^^^^^^^^ -- 2.39.5 _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel