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     <smbconfoption name="passwd program"/> 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 <smbconfoption
  21     name="unix password sync"/> parameter is set  to <constant>yes</constant>. This sequence is
  22     then called <emphasis>AS ROOT</emphasis> when the SMB password  in the
  23     smbpasswd file is being changed, without access to the old password
  24     cleartext. This means that root must be able to reset the user's password without
  25     knowing the text of the previous password. In the presence of
  26     NIS/YP,  this means that the <smbconfoption name="passwd program"/> must
  27     be executed on the NIS master.
  28     </para>
  29
  30
  31     <para>The string can contain the macro <parameter moreinfo="none">%n</parameter> which is substituted
  32     for the new password.  The chat sequence can also contain the standard
  33     macros \\n, \\r, \\t and \\s to
  34     give line-feed, carriage-return, tab and space.  The chat sequence string can also contain
  35     a '*' which matches any sequence of characters. Double quotes can be used to collect strings with spaces
  36     in them into a single string.</para>
  37
  38     <para>If the send string in any part of the chat sequence  is a full
  39     stop &quot;.&quot;,  then no string is sent. Similarly,  if the
  40     expect string is a full stop then no string is expected.</para>
  41
  42     <para>If the <smbconfoption name="pam password change"/> parameter is set to <constant>yes</constant>, the
  43         chat pairs may be matched in any order, and success is determined by the PAM result, not any particular
  44         output. The \\n macro is ignored for PAM conversions.
  45     </para>
  46
  47 </description>
  48
  49 <related>unix password sync</related>
  50 <related>passwd program</related>
  51 <related>passwd chat debug</related>
  52 <related>pam password change</related>
  53
  54 <value type="default">*new*password* %n\n*new*password* %n\n *changed*</value>
  55 <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>
  56 </samba:parameter>