From: Stefan Metzmacher <metze@samba.org>
Date: Mon, 4 Feb 2019 14:40:16 +0000 (+0100)
Subject: docs-xml/smbdotconf: document export of SAMBA_CPS_{ACCOUNT,USER_PRINCIPAL,FULL}_NAME... 
X-Git-Tag: ldb-1.6.1~179
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2e8daeb2bb30f57284f80cac51eb005f775e155f;p=thirdparty%2Fsamba.git

docs-xml/smbdotconf: document export of SAMBA_CPS_{ACCOUNT,USER_PRINCIPAL,FULL}_NAME for check password script

Signed-off-by: Stefan Metzmacher <metze@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>

Autobuild-User(master): Andrew Bartlett <abartlet@samba.org>
Autobuild-Date(master): Mon Feb 11 11:03:58 CET 2019 on sn-devel-144
---

diff --git a/docs-xml/smbdotconf/security/checkpasswordscript.xml b/docs-xml/smbdotconf/security/checkpasswordscript.xml
index 54f1096802b..1e9031fda42 100644
--- a/docs-xml/smbdotconf/security/checkpasswordscript.xml
+++ b/docs-xml/smbdotconf/security/checkpasswordscript.xml
@@ -15,6 +15,23 @@
     <citerefentry><refentrytitle>samba</refentrytitle> <manvolnum>8</manvolnum>
     </citerefentry> without any substitutions.</para>
 
+    <para>Note that starting with Samba 4.11 the following environment variables are exported to the script:</para>
+
+    <itemizedlist>
+	<listitem><para>
+	SAMBA_CPS_ACCOUNT_NAME is always present and contains the sAMAccountName of user,
+	the is the same as the %u substitutions in the none AD DC case.
+	</para></listitem>
+
+	<listitem><para>
+	SAMBA_CPS_USER_PRINCIPAL_NAME is optional in the AD DC case if the userPrincipalName is present.
+	</para></listitem>
+
+	<listitem><para>
+	SAMBA_CPS_FULL_NAME is optional if the displayName is present.
+	</para></listitem>
+    </itemizedlist>
+
     <para>Note: In the example directory is a sample program called <command moreinfo="none">crackcheck</command>
     that uses cracklib to check the password quality.</para>