docs/docbook/smbdotconf/security/passwdchat.xml

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