CVE-2016-2115: docs-xml: always default "client ipc signing" to "mandatory"
[samba.git] / docs-xml / smbdotconf / security / passwdchat.xml
1 <samba:parameter name="passwd chat"
2                  context="G"
3                  type="string"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6     <para>This string controls the <emphasis>&quot;chat&quot;</emphasis> 
7     conversation that takes places between <citerefentry><refentrytitle>smbd</refentrytitle>
8     <manvolnum>8</manvolnum></citerefentry> and the local password changing
9     program to change the user's password. The string describes a 
10     sequence of response-receive pairs that <citerefentry><refentrytitle>smbd</refentrytitle>
11     <manvolnum>8</manvolnum></citerefentry> uses to determine what to send to the 
12     <smbconfoption name="passwd program"/> and what to expect back. If the expected output is not 
13     received then the password is not changed.</para>
14
15     <para>This chat sequence is often quite site specific, depending 
16     on what local methods are used for password control (such as NIS 
17     etc).</para>
18
19     <para>Note that this parameter only is used if the <smbconfoption
20     name="unix password sync"/> parameter is set  to <constant>yes</constant>. This sequence is 
21     then called <emphasis>AS ROOT</emphasis> when the SMB password  in the 
22     smbpasswd file is being changed, without access to the old password
23     cleartext. This means that root must be able to reset the user's password without
24     knowing the text of the previous password. In the presence of
25     NIS/YP,  this means that the <smbconfoption name="passwd program"/> must
26     be executed on the NIS master.
27     </para>
28
29     <para>The string can contain the macro <parameter
30     moreinfo="none">%n</parameter> which is substituted 
31     for the new password.  The old passsword (<parameter 
32     moreinfo="none">%o</parameter>) is only available when
33     <smbconfoption name="encrypt passwords"/> has been disabled.
34     The chat sequence can also contain the standard macros 
35     \n, \r, \t and \s to give line-feed, carriage-return, tab 
36     and space.  The chat sequence string can also contain 
37     a '*' which matches any sequence of characters. Double quotes can 
38     be used to collect strings with spaces in them into a single 
39     string.</para>
40
41     <para>If the send string in any part of the chat sequence  is a full
42     stop &quot;.&quot;,  then no string is sent. Similarly,  if the
43     expect string is a full stop then no string is expected.</para>
44
45     <para>If the <smbconfoption name="pam password change"/> parameter is set to <constant>yes</constant>, the
46         chat pairs may be matched in any order, and success is determined by the PAM result, not any particular
47         output. The \n macro is ignored for PAM conversions.
48     </para>
49
50 </description>
51
52 <related>unix password sync</related>
53 <related>passwd program</related>
54 <related>passwd chat debug</related>
55 <related>pam password change</related>
56
57 <value type="default">*new*password* %n\n *new*password* %n\n *changed*</value>
58 <value type="example">&quot;*Enter NEW password*&quot; %n\n &quot;*Reenter NEW password*&quot; %n\n &quot;*Password changed*&quot;</value>
59 </samba:parameter>