From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 0697E90EF5 for ; Tue, 31 Jan 2023 13:51:18 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id DD3D123B30 for ; Tue, 31 Jan 2023 13:50:47 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Tue, 31 Jan 2023 13:50:47 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 25D6845503 for ; Tue, 31 Jan 2023 13:50:47 +0100 (CET) From: Christoph Heiss To: pve-devel@lists.proxmox.com Date: Tue, 31 Jan 2023 13:50:43 +0100 Message-Id: <20230131125043.380402-3-c.heiss@proxmox.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230131125043.380402-1-c.heiss@proxmox.com> References: <20230131125043.380402-1-c.heiss@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.163 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment 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 2/2] pveum: Document reserved characters and quoting of LDAP DNs 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: , X-List-Received-Date: Tue, 31 Jan 2023 12:51:18 -0000 Signed-off-by: Christoph Heiss --- pveum.adoc | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/pveum.adoc b/pveum.adoc index 65d874a..1562b6c 100644 --- a/pveum.adoc +++ b/pveum.adoc @@ -390,6 +390,39 @@ The main options for syncing are: * `Preview` (`dry-run`): No data is written to the config. This is useful if you want to see which users and groups would get synced to the `user.cfg`. +[[pveum_ldap_reserved_characters]] +Reserved characters +^^^^^^^^^^^^^^^^^^^ + +Certain characters are reserved and cannot be easily used in attribute values +in DNs without being escaped properly. + +Following characters need escaping: + +* Space (` `) + +* Comma (`,`) + +* Plus sign (`+`) + +* Double quote (`"`) + +* Forward slashes (`/`) + +* Angle brackets (`<>`) + +* Semicolon (`;`) + +* Equals sign (`=`) + +To use such characters in DNs, surround the attribute value in double quotes. +For example, to bind with a user with the CN (Common Name) `Example, User`, use +`CN="Example, User",OU=people,DC=example,DC=com` as value for `bind_dn`. + +This applies to the `base_dn`, `bind_dn`, and `group_dn` attributes. + +NOTE: Users with colons and forward slashes cannot be synced since these are +reserved characters in usernames. [[pveum_openid]] OpenID Connect -- 2.34.1