docs/htmldocs/smbpasswd.8.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbpasswd</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbpasswd.8"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>smbpasswd &#8212; change a user's SMB password</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">smbpasswd</tt>  [-a] [-x] [-d] [-e] [-D debuglevel] [-n] [-r &lt;remote machine&gt;] [-R &lt;name resolve order&gt;] [-m] [-U username[%password]] [-h] [-s] [-w pass] [-i] [-L] [username]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p>The smbpasswd program has several different
   2         functions, depending on whether it is run by the <span class="emphasis"><em>root</em></span> user
   3         or not. When run as a normal user it allows the user to change
   4         the password used for their SMB sessions on any machines that store
   5         SMB passwords. </p><p>By default (when run with no arguments) it will attempt to
   6         change the current user's SMB password on the local machine. This is
   7         similar to the way the <b class="command">passwd(1)</b> program works. <b class="command">
   8         smbpasswd</b> differs from how the passwd program works
   9         however in that it is not <span class="emphasis"><em>setuid root</em></span> but works in
  10         a client-server mode and communicates with a
  11         locally running <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>. As a consequence in order for this to
  12         succeed the smbd daemon must be running on the local machine. On a
  13         UNIX machine the encrypted SMB passwords are usually stored in
  14         the <a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a> file. </p><p>When run by an ordinary user with no options, smbpasswd
  15         will prompt them for their old SMB password and then ask them
  16         for their new password twice, to ensure that the new password
  17         was typed correctly. No passwords will be echoed on the screen
  18         whilst being typed. If you have a blank SMB password (specified by
  19         the string &quot;NO PASSWORD&quot; in the smbpasswd file) then just press
  20         the &lt;Enter&gt; key when asked for your old password. </p><p>smbpasswd can also be used by a normal user to change their
  21         SMB password on remote machines, such as Windows NT Primary Domain
  22         Controllers.   See the (<i class="parameter"><tt>-r</tt></i>) and <i class="parameter"><tt>-U</tt></i> options
  23         below. </p><p>When run by root, smbpasswd allows new users to be added
  24         and deleted in the smbpasswd file, as well as allows changes to
  25         the attributes of the user in this file to be made. When run by root, <b class="command">
  26         smbpasswd</b> accesses the local smbpasswd file
  27         directly, thus enabling changes to be made even if smbd is not
  28         running. </p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-a</span></dt><dd><p>This option specifies that the username
  29                 following should be added to the local smbpasswd file, with the
  30                 new password typed (type &lt;Enter&gt; for the old password). This
  31                 option is ignored if the username following already exists in
  32                 the smbpasswd file and it is treated like a regular change
  33                 password command.  Note that the default passdb backends require
  34                 the user to already exist in the system password file (usually
  35                 <tt class="filename">/etc/passwd</tt>), else the request to add the
  36                 user will fail. </p><p>This option is only available when running smbpasswd
  37                 as root. </p></dd><dt><span class="term">-x</span></dt><dd><p>This option specifies that the username
  38                 following should be deleted from the local smbpasswd file.
  39                 </p><p>This option is only available when running smbpasswd as
  40                 root.</p></dd><dt><span class="term">-d</span></dt><dd><p>This option specifies that the username following
  41                 should be <tt class="constant">disabled</tt> in the local smbpasswd
  42                 file. This is done by writing a <tt class="constant">'D'</tt> flag
  43                 into the account control space in the smbpasswd file. Once this
  44                 is done all attempts to authenticate via SMB using this username
  45                 will fail. </p><p>If the smbpasswd file is in the 'old' format (pre-Samba 2.0
  46                 format) there is no space in the user's password entry to write
  47                 this information and the command will FAIL. See <a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a> for details on the 'old' and new password file formats.
  48                 </p><p>This option is only available when running smbpasswd as
  49                 root.</p></dd><dt><span class="term">-e</span></dt><dd><p>This option specifies that the username following
  50                 should be <tt class="constant">enabled</tt> in the local smbpasswd file,
  51                 if the account was previously disabled. If the account was not
  52                 disabled this option has no effect. Once the account is enabled then
  53                 the user will be able to authenticate via SMB once again. </p><p>If the smbpasswd file is in the 'old' format, then <b class="command">
  54                 smbpasswd</b> will FAIL to enable the account.
  55                 See <a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a> for
  56                 details on the 'old' and new password file formats. </p><p>This option is only available when running smbpasswd as root.
  57                 </p></dd><dt><span class="term">-D debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer
  58                 from 0 to 10.  The default value if this parameter is not specified
  59                 is zero. </p><p>The higher this value, the more detail will be logged to the
  60                 log files about the activities of smbpasswd. At level 0, only
  61                 critical errors and serious warnings will be logged. </p><p>Levels above 1 will generate considerable amounts of log
  62                 data, and should only be used when investigating a problem. Levels
  63                 above 3 are designed for use only by developers and generate
  64                 HUGE amounts of log data, most of which is extremely cryptic.
  65                 </p></dd><dt><span class="term">-n</span></dt><dd><p>This option specifies that the username following
  66                 should have their password set to null (i.e. a blank password) in
  67                 the local smbpasswd file. This is done by writing the string &quot;NO
  68                 PASSWORD&quot; as the first part of the first password stored in the
  69                 smbpasswd file. </p><p>Note that to allow users to logon to a Samba server once
  70                 the password has been set to &quot;NO PASSWORD&quot; in the smbpasswd
  71                 file the administrator must set the following parameter in the [global]
  72                 section of the <tt class="filename">smb.conf</tt> file : </p><p><b class="command">null passwords = yes</b></p><p>This option is only available when running smbpasswd as
  73                 root.</p></dd><dt><span class="term">-r remote machine name</span></dt><dd><p>This option allows a user to specify what machine
  74                 they wish to change their password on. Without this parameter
  75                 smbpasswd defaults to the local host. The <i class="replaceable"><tt>remote
  76                 machine name</tt></i> is the NetBIOS name of the SMB/CIFS
  77                 server to contact to attempt the password change. This name is
  78                 resolved into an IP address using the standard name resolution
  79                 mechanism in all programs of the Samba suite. See the <i class="parameter"><tt>-R
  80                 name resolve order</tt></i> parameter for details on changing
  81                 this resolving mechanism. </p><p>The username whose password is changed is that of the
  82                 current UNIX logged on user. See the <i class="parameter"><tt>-U username</tt></i>
  83                 parameter for details on changing the password for a different
  84                 username. </p><p>Note that if changing a Windows NT Domain password the
  85                 remote machine specified must be the Primary Domain Controller for
  86                 the domain (Backup Domain Controllers only have a read-only
  87                 copy of the user account database and will not allow the password
  88                 change).</p><p><span class="emphasis"><em>Note</em></span> that Windows 95/98 do not have
  89                 a real password database so it is not possible to change passwords
  90                 specifying a Win95/98  machine as remote machine target. </p></dd><dt><span class="term">-R name resolve order</span></dt><dd><p>This option allows the user of smbpasswd to determine
  91                 what name resolution services to use when looking up the NetBIOS
  92                 name of the host being connected to. </p><p>The options are :&quot;lmhosts&quot;, &quot;host&quot;, &quot;wins&quot; and &quot;bcast&quot;. They
  93                  cause names to be resolved as follows: </p><div class="itemizedlist"><ul type="disc"><li><p><tt class="constant">lmhosts</tt>: Lookup an IP
  94             address in the Samba lmhosts file. If the line in lmhosts has
  95             no name type attached to the NetBIOS name (see the <a href="lmhosts.5.html"><span class="citerefentry"><span class="refentrytitle">lmhosts</span>(5)</span></a> for details) then
  96             any name type matches for lookup.</p></li><li><p><tt class="constant">host</tt>: Do a standard host
  97             name to IP address resolution, using the system <tt class="filename">/etc/hosts
  98             </tt>, NIS, or DNS lookups. This method of name resolution
  99             is operating system depended for instance on IRIX or Solaris this
 100             may be controlled by the <tt class="filename">/etc/nsswitch.conf</tt>
 101             file).  Note that this method is only used if the NetBIOS name
 102             type being queried is the 0x20 (server) name type, otherwise
 103             it is ignored.</p></li><li><p><tt class="constant">wins</tt>: Query a name with
 104             the IP address listed in the <i class="parameter"><tt>wins server</tt></i>
 105             parameter.  If no WINS server has been specified this method
 106             will be ignored.</p></li><li><p><tt class="constant">bcast</tt>: Do a broadcast on
 107             each of the known local interfaces listed in the
 108             <i class="parameter"><tt>interfaces</tt></i> parameter. This is the least
 109             reliable of the name resolution methods as it depends on the
 110             target host being on a locally connected subnet.</p></li></ul></div><p>The default order is <b class="command">lmhosts, host, wins, bcast</b>
 111                 and without this parameter or any entry in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file the name resolution methods will
 112                 be attempted in this order. </p></dd><dt><span class="term">-m</span></dt><dd><p>This option tells smbpasswd that the account
 113                 being changed is a MACHINE account. Currently this is used
 114                 when Samba is being used as an NT Primary Domain Controller.</p><p>This option is only available when running smbpasswd as root.
 115                 </p></dd><dt><span class="term">-U username</span></dt><dd><p>This option may only be used in conjunction
 116                 with the <i class="parameter"><tt>-r</tt></i> option. When changing
 117                 a password on a remote machine it allows the user to specify
 118                 the user name on that machine whose password will be changed. It
 119                 is present to allow users who have different user names on
 120                 different systems to change these passwords. </p></dd><dt><span class="term">-h</span></dt><dd><p>This option prints the help string for <b class="command">
 121                 smbpasswd</b>, selecting the correct one for running as root
 122                 or as an ordinary user. </p></dd><dt><span class="term">-s</span></dt><dd><p>This option causes smbpasswd to be silent (i.e.
 123                 not issue prompts) and to read its old and new passwords from
 124                 standard  input, rather than from <tt class="filename">/dev/tty</tt>
 125                 (like the <b class="command">passwd(1)</b> program does). This option
 126                 is to aid people writing scripts to drive smbpasswd</p></dd><dt><span class="term">-w password</span></dt><dd><p>This parameter is only available if Samba
 127                 has been configured to use the experimental
 128                 <b class="command">--with-ldapsam</b> option. The <i class="parameter"><tt>-w</tt></i>
 129                 switch is used to specify the password to be used with the
 130                 <a href="smb.conf.5.html#LDAPADMINDN" target="_top"><i class="parameter"><tt>ldap admin
 131                 dn</tt></i></a>.  Note that the password is stored in
 132                 the <tt class="filename">secrets.tdb</tt> and is keyed off
 133                 of the admin's DN.  This means that if the value of <i class="parameter"><tt>ldap
 134                 admin dn</tt></i> ever changes, the password will need to be
 135                 manually updated as well.
 136                 </p></dd><dt><span class="term">-i</span></dt><dd><p>This option tells smbpasswd that the account
 137                 being changed is an interdomain trust account. Currently this is used
 138                 when Samba is being used as an NT Primary Domain Controller.
 139                 The account contains the info about another trusted domain.</p><p>This option is only available when running smbpasswd as root.
 140                 </p></dd><dt><span class="term">-L</span></dt><dd><p>Run in local mode.</p></dd><dt><span class="term">username</span></dt><dd><p>This specifies the username for all of the
 141                 <span class="emphasis"><em>root only</em></span> options to operate on. Only root
 142                 can specify this parameter as only root has the permission needed
 143                 to modify attributes directly in the local smbpasswd file.
 144                 </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>NOTES</h2><p>Since <b class="command">smbpasswd</b> works in client-server
 145         mode communicating  with a local smbd for a non-root user then
 146         the smbd daemon must be running for this to work. A common problem
 147         is to add a restriction to the hosts that may access the <b class="command">
 148         smbd</b> running on the local machine by specifying either <i class="parameter"><tt>allow
 149         hosts</tt></i> or <i class="parameter"><tt>deny hosts</tt></i> entry in
 150         the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file and neglecting to
 151         allow &quot;localhost&quot; access to the smbd. </p><p>In addition, the smbpasswd command is only useful if Samba
 152         has been set up to use encrypted passwords. See the document <a href="pwencrypt.html" target="_top">
 153         &quot;LanMan and NT Password Encryption in Samba&quot;</a> in the docs directory for details
 154         on how to do this. </p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a>, <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a>.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities
 155         were created by Andrew Tridgell. Samba is now developed
 156         by the Samba Team as an Open Source project similar
 157         to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer.
 158         The man page sources were converted to YODL format (another
 159         excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
 160         ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0
 161         release by Jeremy Allison.  The conversion to DocBook for
 162         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
 163         for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html>