summaryrefslogtreecommitdiffstats
path: root/docs-xml/smbdotconf/security/passwdchat.xml
blob: a04fc62fdf6e1c1b9629ffad32b8302f03284dd4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<samba:parameter name="passwd chat"
                 context="G"
		 type="string"
                 substitution="1"
                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
    <para>This string controls the <emphasis>&quot;chat&quot;</emphasis> 
    conversation that takes places between <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> and the local password changing
    program to change the user's password. The string describes a 
    sequence of response-receive pairs that <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> uses to determine what to send to the 
    <smbconfoption name="passwd program"/> and what to expect back. If the expected output is not 
    received then the password is not changed.</para>

    <para>This chat sequence is often quite site specific, depending 
    on what local methods are used for password control.</para>

    <para>Note that this parameter only is used if the <smbconfoption
    name="unix password sync"/> parameter is set  to <constant>yes</constant>. This sequence is 
    then called <emphasis>AS ROOT</emphasis> when the SMB password  in the 
    smbpasswd file is being changed, without access to the old password
    cleartext. This means that root must be able to reset the user's password without
    knowing the text of the previous password.
    </para>

    <para>The string can contain the macro <parameter
    moreinfo="none">%n</parameter> which is substituted 
    for the new password.  The old password (<parameter 
    moreinfo="none">%o</parameter>) is only available when
    <smbconfoption name="encrypt passwords"/> has been disabled.
    The chat sequence can also contain the standard macros 
    \n, \r, \t and \s to give line-feed, carriage-return, tab 
    and space.  The chat sequence string can also contain 
    a '*' which matches any sequence of characters. Double quotes can 
    be used to collect strings with spaces in them into a single 
    string.</para>

    <para>If the send string in any part of the chat sequence  is a full
    stop &quot;.&quot;,  then no string is sent. Similarly,  if the
    expect string is a full stop then no string is expected.</para>

    <para>If the <smbconfoption name="pam password change"/> parameter is set to <constant>yes</constant>, the
	chat pairs may be matched in any order, and success is determined by the PAM result, not any particular
	output. The \n macro is ignored for PAM conversions.
    </para>

</description>

<related>unix password sync</related>
<related>passwd program</related>
<related>passwd chat debug</related>
<related>pam password change</related>

<value type="default">*new*password* %n\n *new*password* %n\n *changed*</value>
<value type="example">&quot;*Enter NEW password*&quot; %n\n &quot;*Reenter NEW password*&quot; %n\n &quot;*Password changed*&quot;</value>
</samba:parameter>