docs/smbdotconf/security/passwdchat.xml

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