docs-xml/smbdotconf/security/passwdchat.xml

   1 <samba:parameter name="passwd chat"
   2                  context="G"
   3                  type="string"
   4                  substitution="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.</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.
  25     </para>
  26
  27     <para>The string can contain the macro <parameter
  28     moreinfo="none">%n</parameter> which is substituted
  29     for the new password.  The old password (<parameter
  30     moreinfo="none">%o</parameter>) is only available when
  31     <smbconfoption name="encrypt passwords"/> has been disabled.
  32     The chat sequence can also contain the standard macros
  33     \n, \r, \t and \s to give line-feed, carriage-return, tab
  34     and space.  The chat sequence string can also contain
  35     a '*' which matches any sequence of characters. Double quotes can
  36     be used to collect strings with spaces in them into a single
  37     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 <smbconfoption name="pam password change"/> parameter is set to <constant>yes</constant>, the
  44         chat pairs may be matched in any order, and success is determined by the PAM result, not any particular
  45         output. The \n macro is ignored for PAM conversions.
  46     </para>
  47
  48 </description>
  49
  50 <related>unix password sync</related>
  51 <related>passwd program</related>
  52 <related>passwd chat debug</related>
  53 <related>pam password change</related>
  54
  55 <value type="default">*new*password* %n\n *new*password* %n\n *changed*</value>
  56 <value type="example">&quot;*Enter NEW password*&quot; %n\n &quot;*Reenter NEW password*&quot; %n\n &quot;*Password changed*&quot;</value>
  57 </samba:parameter>