docs-xml/smbdotconf: document export of SAMBA_CPS_{ACCOUNT,USER_PRINCIPAL,FULL}_NAME...

[nivanova/samba-autobuild/.git] / docs-xml / smbdotconf / security / checkpasswordscript.xml

diff --git a/docs-xml/smbdotconf/security/checkpasswordscript.xml b/docs-xml/smbdotconf/security/checkpasswordscript.xml
index 54f1096802b94598d4592b087695d85416e04ec7..1e9031fda42bf328a10dbbbc7942c01f625e96e9 100644 (file)
--- 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>