d63309903568c07f4192ecde96159521c33eb348
[samba.git] / docs / yodldocs / smbpasswd.8.yo
1 mailto(samba-bugs@samba.anu.edu.au) 
2
3 manpage(smbpasswd)(8)(23 Oct 1998)(Samba)(SAMBA)
4
5 label(NAME)
6 manpagename(smbpasswd)(change a users SMB password)
7
8 label(SYNOPSIS)
9 manpagesynopsis() 
10
11 bf(smbpasswd) [-a] [-d] [-e] [-D debug level] [-n] [-r remote_machine] [-R name resolve order] [-m] [-j DOMAIN] [-U username] [-h] [-s] username
12
13 label(DESCRIPTION)
14 manpagedescription()
15
16 This program is part of the bf(Samba) suite.
17
18 The bf(smbpasswd) program has several different functions, depending
19 on whether it is run by the em(root) user or not. When run as a normal
20 user it allows the user to change the password used for their SMB
21 sessions on any machines that store SMB passwords.
22
23 By default (when run with no arguments) it will attempt to change the
24 current users SMB password on the local machine. This is similar to
25 the way the bf(passwd (1)) program works. bf(smbpasswd) differs from
26 the bf(passwd) program works however in that it is not em(setuid root)
27 but works in a client-server mode and communicates with a locally
28 running url(bf(smbd))(smbd.8.html). As a consequence in order for this
29 to succeed the url(bf(smbd))(smbd.8.html) daemon must be running on
30 the local machine. On a UNIX machine the encrypted SMB passwords are
31 usually stored in the url(bf(smbpasswd (5)))(smbpasswd.5.html) file.
32
33 When run by an ordinary user with no options. bf(smbpasswd) will
34 prompt them for their old smb password and then ask them for their new
35 password twice, to ensure that the new password was typed
36 correctly. No passwords will be echoed on the screen whilst being
37 typed. If you have a blank smb password (specified by the string "NO
38 PASSWORD" in the url(bf(smbpasswd))(smbpasswd.5.html) file) then just
39 press the <Enter> key when asked for your old password.
40
41 bf(smbpasswd) also can be used by a normal user to change their SMB
42 password on remote machines, such as Windows NT Primary Domain
43 Controllers. See the link((bf(-r)))(minusr) and
44 link(bf(-U))(minusU) options below.
45
46 When run by root, bf(smbpasswd) allows new users to be added and
47 deleted in the url(bf(smbpasswd))(smbpasswd.5.html) file, as well as
48 changes to the attributes of the user in this file to be made. When
49 run by root, bf(smbpasswd) accesses the local
50 url(bf(smbpasswd))(smbpasswd.5.html) file directly, thus enabling
51 changes to be made even if url(bf(smbd))(smbd.8.html) is not running.
52
53 label(OPTIONS)
54 manpageoptions()
55
56 startdit()
57
58 dit(bf(-a)) This option specifies that the username following should
59 be added to the local url(bf(smbpasswd))(smbpasswd.5.html) file, with
60 the new password typed (type <Enter> for the old password). This
61 option is ignored if the username following already exists in the
62 url(bf(smbpasswd))(smbpasswd.5.html) file and it is treated like a
63 regular change password command. Note that the user to be added .B
64 must already exist in the system password file (usually /etc/passwd)
65 else the request to add the user will fail.
66
67 This option is only available when running bf(smbpasswd) as
68 root.
69
70 label(minusd)
71 dit(bf(-d)) This option specifies that the username following should be
72 em(disabled) in the local url(bf(smbpasswd))(smbpasswd.5.html) file.
73 This is done by writing a em('D') flag into the account control space
74 in the url(bf(smbpasswd))(smbpasswd.5.html) file. Once this is done
75 all attempts to authenticate via SMB using this username will fail.
76
77 If the url(bf(smbpasswd))(smbpasswd.5.html) file is in the 'old'
78 format (pre-Samba 2.0 format) there is no space in the users password
79 entry to write this information and so the user is disabled by writing
80 'X' characters into the password space in the
81 url(bf(smbpasswd))(smbpasswd.5.html) file. See url(bf(smbpasswd
82 (5)))(smbpasswd.5.html) for details on the 'old' and new password file
83 formats.
84
85 This option is only available when running bf(smbpasswd) as root.
86
87 dit(bf(-e)) This option specifies that the username following should be
88 em(enabled) in the local url(bf(smbpasswd))(smbpasswd.5.html) file,
89 if the account was previously disabled. If the account was not
90 disabled this option has no effect. Once the account is enabled
91 then the user will be able to authenticate via SMB once again.
92
93 If the smbpasswd file is in the 'old' format then bf(smbpasswd) will
94 prompt for a new password for this user, otherwise the account will be
95 enabled by removing the em('D') flag from account control space in the
96 url(bf(smbpasswd))(smbpasswd.5.html) file. See url(bf(smbpasswd
97 (5)))(smbpasswd.5.html) for details on the 'old' and new password file
98 formats.
99
100 This option is only available when running bf(smbpasswd) as root.
101
102 label(minusD)
103 dit(bf(-D debuglevel)) debuglevel is an integer from 0
104 to 10.  The default value if this parameter is not specified is zero.
105
106 The higher this value, the more detail will be logged to the log files
107 about the activities of smbpasswd. At level 0, only critical errors
108 and serious warnings will be logged.
109
110 Levels above 1 will generate considerable amounts of log data, and
111 should only be used when investigating a problem. Levels above 3 are
112 designed for use only by developers and generate HUGE amounts of log
113 data, most of which is extremely cryptic.
114
115 dit(bf(-n)) This option specifies that the username following should
116 have their password set to null (i.e. a blank password) in the local
117 url(bf(smbpasswd))(smbpasswd.5.html) file. This is done by writing the
118 string "NO PASSWORD" as the first part of the first password stored in
119 the url(bf(smbpasswd))(smbpasswd.5.html) file.
120
121 Note that to allow users to logon to a Samba server once the password
122 has been set to "NO PASSWORD" in the
123 url(bf(smbpasswd))(smbpasswd.5.html) file the administrator must set
124 the following parameter in the [global] section of the
125 url(bf(smb.conf))(smb.conf.5.html) file :
126
127 url(null passwords = true)(smb.conf.5.html#nullpasswords)
128
129 This option is only available when running bf(smbpasswd) as root.
130
131 label(minusr) dit(bf(-r remote machine name)) This option allows a
132 user to specify what machine they wish to change their password
133 on. Without this parameter bf(smbpasswd) defaults to the local
134 host. The em("remote machine name") is the NetBIOS name of the
135 SMB/CIFS server to contact to attempt the password change. This name
136 is resolved into an IP address using the standard name resolution
137 mechanism in all programs of the url(bf(Samba))(samba.7.html)
138 suite. See the link(bf(-R name resolve order))(nameresolveorder) parameter for details on changing this resolving
139 mechanism.
140
141 The username whose password is changed is that of the current UNIX
142 logged on user. See the link(bf(-U username))(minusU)
143 parameter for details on changing the password for a different
144 username.
145  
146 Note that if changing a Windows NT Domain password the remote machine
147 specified must be the Primary Domain Controller for the domain (Backup
148 Domain Controllers only have a read-only copy of the user account
149 database and will not allow the password change).
150
151 label(nameresolveorder)
152 dit(bf(-R name resolve order)) This option allows the user of
153 smbclient to determine what name resolution services to use when
154 looking up the NetBIOS name of the host being connected to.
155
156 The options are :"lmhosts", "host", "wins" and "bcast". They cause
157 names to be resolved as follows :
158
159 startit()
160
161 it() bf(lmhosts) : Lookup an IP address in the Samba lmhosts file.
162
163 it() bf(host) : Do a standard host name to IP address resolution,
164 using the system /etc/hosts, NIS, or DNS lookups. This method of name
165 resolution is operating system depended for instance on IRIX or
166 Solaris this may be controlled by the em(/etc/nsswitch.conf) file).
167
168 it() bf(wins) : Query a name with the IP address listed in the url(bf(wins
169 server))(smb.conf.5.html#winsserver) parameter in the smb.conf file. If 
170 no WINS server has been specified this method will be ignored.
171
172 it() bf(bcast) : Do a broadcast on each of the known local interfaces
173 listed in the url(bf(interfaces))(smb.conf.5.html#interfaces) parameter
174 in the smb.conf file. This is the least reliable of the name resolution
175 methods as it depends on the target host being on a locally connected
176 subnet.
177
178 endit()
179
180 If this parameter is not set then the name resolver order defined
181 in the url(bf(smb.conf))(smb.conf.5.html) file parameter 
182 url(bf(name resolve order))(smb.conf.5.html#nameresolveorder)
183 will be used.
184
185 The default order is lmhosts, host, wins, bcast and without this
186 parameter or any entry in the url(bf(smb.conf))(smb.conf.5.html) 
187 file the name resolution methods will be attempted in this order.
188
189 dit(bf(-m)) This option tells bf(smbpasswd) that the account being
190 changed is a em(MACHINE) account. Currently this is used when Samba is
191 being used as an NT Primary Domain Controller. PDC support is not a
192 supported feature in Samba2.0 but will become supported in a later
193 release. If you wish to know more about using Samba as an NT PDC then
194 please subscribe to the mailing list
195 email(samba-ntdom@samba.anu.edu.au).
196
197 This option is only available when running bf(smbpasswd) as root.
198
199 dit(bf(-j DOMAIN)) This option is used to add a Samba server into a
200 Windows NT Domain, as a Domain member capable of authenticating user
201 accounts to any Domain Controller in the same way as a Windows NT
202 Server. See the url(bf(security=domain))(smb.conf.5.html#security)
203 option in the url(bf(smb.conf (5)))(smb.conf.5.html) man page.
204
205 In order to be used in this way, the Administrator for the Windows
206 NT Domain must have used the program em("Server Manager for Domains")
207 to add the url(primary NetBIOS name)(smb.conf.5.html#netbiosname) of 
208 the Samba server as a member of the Domain.
209
210 After this has been done, to join the Domain invoke bf(smbpasswd) with
211 this parameter. bf(smbpasswd) will then look up the Primary Domain
212 Controller for the Domain (found in the
213 url(bf(smb.conf))(smb.conf.5.html) file in the parameter
214 url(bf(password server))(smb.conf.5.html#passwordserver) and change
215 the machine account password used to create the secure Domain
216 communication.  This password is then stored by bf(smbpasswd) in a
217 file, read only by root, called tt(<Domain>.<Machine>.mac) where
218 tt(<Domain>) is the name of the Domain we are joining and tt<Machine>
219 is the primary NetBIOS name of the machine we are running on.
220
221 Once this operation has been performed the
222 url(bf(smb.conf))(smb.conf.5.html) file may be updated to set the
223 url(bf(security=domain))(smb.conf.5.html#security) option and all
224 future logins to the Samba server will be authenticated to the Windows
225 NT PDC.
226
227 Note that even though the authentication is being done to the PDC all
228 users accessing the Samba server must still have a valid UNIX account
229 on that machine.
230
231 This option is only available when running bf(smbpasswd) as root.
232
233 label(minusU)
234 dit(bf(-U username)) This option may only be used in
235 conjunction with the link(bf(-r))(minusr)
236 option. When changing a password on a remote machine it allows the
237 user to specify the user name on that machine whose password will be
238 changed. It is present to allow users who have different user names on
239 different systems to change these passwords.
240
241 dir(bf(username)) This specifies the username for all of the em(root
242 only) options to operate on. Only root can specify this parameter as
243 only root has the permission needed to modify attributes directly
244 in the local url(bf(smbpasswd))(smbpasswd.5.html) file.
245
246 label(NOTES)
247 manpagesection(NOTES)
248
249 As bf(smbpasswd) works in client-server mode communicating with a
250 local url(bf(smbd))(smbd.8.html) for a non-root user then the bf(smbd)
251 daemon must be running for this to work. A common problem is to add a
252 restriction to the hosts that may access the bf(smbd) running on the
253 local machine by specifying a url(bf("allow
254 hosts"))(smb.conf.5.html#allowhosts) or url(bf("deny
255 hosts"))(smb.conf.5.html#denyhosts) entry in the
256 url(bf(smb.conf))(smb.conf.5.html) file and neglecting to allow
257 em("localhost") access to the bf(smbd).
258
259 In addition, the bf(smbpasswd) command is only useful if bf(Samba) has
260 been set up to use encrypted passwords. See the file bf(ENCRYPTION.txt)
261 in the docs directory for details on how to do this.
262
263 label(VERSION)
264 manpagesection(VERSION)
265
266 This man page is correct for version 2.0 of the Samba suite.
267
268 label(AUTHOR)
269 manpageauthor()
270
271 The original Samba software and related utilities were created by
272 Andrew Tridgell email(samba-bugs@samba.anu.edu.au). Samba is now developed
273 by the Samba Team as an Open Source project similar to the way the
274 Linux kernel is developed.
275
276 The original Samba man pages were written by Karl Auer. The man page
277 sources were converted to YODL format (another excellent piece of Open
278 Source software) and updated for the Samba2.0 release by Jeremy
279 Allison, email(samba-bugs@samba.anu.edu.au).
280
281 See url(bf(samba (7)))(samba.7.html) to find out how to get a full
282 list of contributors and details on how to submit bug reports,
283 comments etc.