summaryrefslogtreecommitdiff
path: root/docs/htmldocs/smbpasswd.8.html
blob: bb3eb7ca47d344fa18ee5874144a9f9dddfd3a90 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
<HTML
><HEAD
><TITLE
>smbpasswd</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="SMBPASSWD"
>smbpasswd</A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5"
></A
><H2
>Name</H2
>smbpasswd&nbsp;--&nbsp;change a users SMB password</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN8"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>smbpasswd</B
>  [-a] [-x] [-d] [-e] [-D debuglevel] [-n] [-r &lt;remote machine&gt;] [-R &lt;name resolve order&gt;] [-m] [-j DOMAIN] [-U username] [-h] [-s] [username]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN25"
></A
><H2
>DESCRIPTION</H2
><P
>This tool is part of the <A
HREF="samba.7.html"
TARGET="_top"
>	Samba</A
> suite.</P
><P
>The smbpasswd program has several different 
	functions, depending on whether it is run by the <I
CLASS="EMPHASIS"
>root</I
> 
	user or not. When run as a normal user it allows the user to change 
	the password used for their SMB sessions on any machines that store 
	SMB passwords. </P
><P
>By default (when run with no arguments) it will attempt to 
	change the current users SMB password on the local machine. This is 
	similar to the way the <B
CLASS="COMMAND"
>passwd(1)</B
> program works. 
	<B
CLASS="COMMAND"
>smbpasswd</B
> differs from how the passwd program works 
	however in that it is not <I
CLASS="EMPHASIS"
>setuid root</I
> but works in 
	a client-server mode and communicates with a locally running
	<B
CLASS="COMMAND"
>smbd(8)</B
>. As a consequence in order for this to 
	succeed the smbd daemon must be running on the local machine. On a 
	UNIX machine the encrypted SMB passwords are usually stored in 
	the <TT
CLASS="FILENAME"
>smbpasswd(5)</TT
> file. </P
><P
>When run by an ordinary user with no options. smbpasswd 
	will prompt them for their old smb password and then ask them 
	for their new password twice, to ensure that the new password
	was typed correctly. No passwords will be echoed on the screen 
	whilst being typed. If you have a blank smb password (specified by 
	the string "NO PASSWORD" in the smbpasswd file) then just press 
	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
	SMB password on remote machines, such as Windows NT Primary Domain 
	Controllers.   See the (-r) and -U options below. </P
><P
>When run by root, smbpasswd allows new users to be added 
	and deleted in the smbpasswd file, as well as allows changes to 
	the attributes of the user in this file to be made. When run by root, 
	<B
CLASS="COMMAND"
>smbpasswd</B
> accesses the local smbpasswd file 
	directly, thus enabling changes to be made even if smbd is not 
	running. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN41"
></A
><H2
>OPTIONS</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>-a</DT
><DD
><P
>This option specifies that the username 
		following should be added to the local smbpasswd file, with the 
		new password typed (type &lt;Enter&gt; for the old password). This 
		option is ignored if the username following already exists in 
		the smbpasswd file and it is treated like a regular change 
		password command. Note that the user to be added must already exist 
		in the system password file (usually <TT
CLASS="FILENAME"
>/etc/passwd</TT
>)
		else the request to add the user will fail. </P
><P
>This option is only available when running smbpasswd 
		as root. </P
></DD
><DT
>-x</DT
><DD
><P
>This option specifies that the username 
		following should be deleted from the local smbpasswd file.
		</P
><P
>This option is only available when running smbpasswd as 
		root.</P
></DD
><DT
>-d</DT
><DD
><P
>This option specifies that the username following 
		should be <TT
CLASS="CONSTANT"
>disabled</TT
> in the local smbpasswd 
		file. This is done by writing a <TT
CLASS="CONSTANT"
>'D'</TT
> flag 
		into the account control space in the smbpasswd file. Once this 
		is done all attempts to authenticate via SMB using this username 
		will fail. </P
><P
>If the smbpasswd file is in the 'old' format (pre-Samba 2.0 
		format) there is no space in the users password entry to write
		this information and so the user is disabled by writing 'X' characters 
		into the password space in the smbpasswd file. See <B
CLASS="COMMAND"
>smbpasswd(5)
		</B
> for details on the 'old' and new password file formats.
		</P
><P
>This option is only available when running smbpasswd as 
		root.</P
></DD
><DT
>-e</DT
><DD
><P
>This option specifies that the username following 
		should be <TT
CLASS="CONSTANT"
>enabled</TT
> in the local smbpasswd file, 
		if the account was previously disabled. If the account was not 
		disabled this option has no effect. Once the account is enabled then 
		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"
>		smbpasswd</B
> will prompt for a new password for this user, 
		otherwise the account will be enabled by removing the <TT
CLASS="CONSTANT"
>'D'
		</TT
> flag from account control space in the <TT
CLASS="FILENAME"
>		smbpasswd</TT
> file. See <B
CLASS="COMMAND"
>smbpasswd (5)</B
> for 
		details on the 'old' and new password file formats. </P
><P
>This option is only available when running smbpasswd as root. 
		</P
></DD
><DT
>-D debuglevel</DT
><DD
><P
><TT
CLASS="PARAMETER"
><I
>debuglevel</I
></TT
> is an integer 
		from 0 to 10.  The default value if this parameter is not specified 
		is zero. </P
><P
>The higher this value, the more detail will be logged to the 
		log files about the activities of smbpasswd. At level 0, only 
		critical errors and serious warnings will be logged. </P
><P
>Levels above 1 will generate considerable amounts of log 
		data, and should only be used when investigating a problem. Levels 
		above 3 are designed for use only by developers and generate
		HUGE amounts of log data, most of which is extremely cryptic. 
		</P
></DD
><DT
>-n</DT
><DD
><P
>This option specifies that the username following 
		should have their password set to null (i.e. a blank password) in 
		the local smbpasswd file. This is done by writing the string "NO 
		PASSWORD" as the first part of the first password stored in the 
		smbpasswd file. </P
><P
>Note that to allow users to logon to a Samba server once 
		the password has been set to "NO PASSWORD" in the smbpasswd
		file the administrator must set the following parameter in the [global]
		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 
		root.</P
></DD
><DT
>-r remote machine name</DT
><DD
><P
>This option allows a user to specify what machine 
		they wish to change their password on. Without this parameter 
		smbpasswd defaults to the local host. The <TT
CLASS="REPLACEABLE"
><I
>remote 
		machine name</I
></TT
> is the NetBIOS name of the SMB/CIFS 
		server to contact to attempt the password change. This name is 
		resolved into an IP address using the standard name resolution 
		mechanism in all programs of the Samba suite. See the <TT
CLASS="PARAMETER"
><I
>-R 
		name resolve order</I
></TT
> parameter for details on changing 
		this resolving mechanism. </P
><P
>The username whose password is changed is that of the 
		current UNIX logged on user. See the <TT
CLASS="PARAMETER"
><I
>-U username</I
></TT
>
		parameter for details on changing the password for a different 
		username. </P
><P
>Note that if changing a Windows NT Domain password the 
		remote machine specified must be the Primary Domain Controller for 
		the domain (Backup Domain Controllers only have a read-only
		copy of the user account database and will not allow the password 
		change).</P
><P
><I
CLASS="EMPHASIS"
>Note</I
> that Windows 95/98 do not have 
		a real password database so it is not possible to change passwords 
		specifying a Win95/98  machine as remote machine target. </P
></DD
><DT
>-R name resolve order</DT
><DD
><P
>This option allows the user of smbpasswd to determine 
		what name resolution services to use when looking up the NetBIOS
		name of the host being connected to. </P
><P
>The options are :"lmhosts", "host", "wins" and "bcast". They cause 
		names to be resolved as follows : </P
><P
></P
><UL
><LI
><P
><TT
CLASS="CONSTANT"
>lmhosts</TT
> : Lookup an IP 
            address in the Samba lmhosts file. If the line in lmhosts has 
            no name type attached to the NetBIOS name (see the <A
HREF="lmhosts.5.html"
TARGET="_top"
>lmhosts(5)</A
> for details) then
            any name type matches for lookup.</P
></LI
><LI
><P
><TT
CLASS="CONSTANT"
>host</TT
> : Do a standard host 
            name to IP address resolution, using the system <TT
CLASS="FILENAME"
>/etc/hosts
            </TT
>, NIS, or DNS lookups. This method of name resolution 
            is operating system depended for instance on IRIX or Solaris this 
            may be controlled by the <TT
CLASS="FILENAME"
>/etc/nsswitch.conf</TT
> 
            file).  Note that this method is only used if the NetBIOS name 
            type being queried is the 0x20 (server) name type, otherwise 
            it is ignored.</P
></LI
><LI
><P
><TT
CLASS="CONSTANT"
>wins</TT
> : Query a name with 
            the IP address listed in the <TT
CLASS="PARAMETER"
><I
>wins server</I
></TT
> 
				parameter.  If no WINS server has been specified this method 
				will be ignored.</P
></LI
><LI
><P
><TT
CLASS="CONSTANT"
>bcast</TT
> : Do a broadcast on 
            each of the known local interfaces listed in the
            <TT
CLASS="PARAMETER"
><I
>interfaces</I
></TT
> parameter. This is the least 
				reliable of the name resolution methods as it depends on the 
				target host being on a locally connected subnet.</P
></LI
></UL
><P
>The default order is <B
CLASS="COMMAND"
>lmhosts, host, wins, bcast</B
> 
		and without this parameter or any entry in the 
		<TT
CLASS="FILENAME"
>smb.conf</TT
> file the name resolution methods will 
		be attempted in this order. </P
></DD
><DT
>-m</DT
><DD
><P
>This option tells smbpasswd that the account 
		being changed is a MACHINE account. Currently this is used 
		when Samba is being used as an NT Primary Domain Controller.</P
><P
>This option is only available when running smbpasswd as root. 	
		</P
></DD
><DT
>-j DOMAIN</DT
><DD
><P
>This option is used to add a Samba server 
		into a Windows NT Domain, as a Domain member capable of authenticating 
		user accounts to any Domain Controller in the same way as a Windows 
		NT Server. See the <B
CLASS="COMMAND"
>security = domain</B
> option in 
		the <TT
CLASS="FILENAME"
>smb.conf(5)</TT
> man page. </P
><P
>In order to be used in this way, the Administrator for 
		the Windows NT Domain must have used the program "Server Manager 
		for Domains" to add the primary NetBIOS name of  the Samba server 
		as a member of the Domain. </P
><P
>After this has been done, to join the Domain invoke <B
CLASS="COMMAND"
>		smbpasswd</B
> with this parameter. smbpasswd will then 
		look up the Primary Domain Controller for the Domain (found in 
		the <TT
CLASS="FILENAME"
>smb.conf</TT
> file in the parameter 
		<TT
CLASS="PARAMETER"
><I
>password server</I
></TT
> and change the machine account 
		password used to create the secure Domain communication.  This 
		password is then stored by smbpasswd in a TDB, writeable only by root, 
		called <TT
CLASS="FILENAME"
>secrets.tdb</TT
> </P
><P
>Once this operation has been performed the <TT
CLASS="FILENAME"
>		smb.conf</TT
> file may be updated to set the <B
CLASS="COMMAND"
>		security = domain</B
> option and all future logins
		to the Samba server will be authenticated to the Windows NT 
		PDC. </P
><P
>Note that even though the authentication is being 
		done to the PDC all users accessing the Samba server must still 
		have a valid UNIX account on that machine. </P
><P
>This option is only available when running smbpasswd as root. 
		</P
></DD
><DT
>-U username</DT
><DD
><P
>This option may only be used in conjunction 
		with the <TT
CLASS="PARAMETER"
><I
>-r</I
></TT
> option. When changing
		a password on a remote machine it allows the user to specify 
		the user name on that machine whose password will be changed. It 
		is present to allow users who have different user names on 
		different systems to change these passwords. </P
></DD
><DT
>-h</DT
><DD
><P
>This option prints the help string for <B
CLASS="COMMAND"
>		smbpasswd</B
>, selecting the correct one for running as root 
		or as an ordinary user. </P
></DD
><DT
>-s</DT
><DD
><P
>This option causes smbpasswd to be silent (i.e. 
		not issue prompts) and to read it's old and new passwords from 
		standard  input, rather than from <TT
CLASS="FILENAME"
>/dev/tty</TT
> 
		(like the <B
CLASS="COMMAND"
>passwd(1)</B
> program does). This option 
		is to aid people writing scripts to drive smbpasswd</P
></DD
><DT
>username</DT
><DD
><P
>This specifies the username for all of the 
		<I
CLASS="EMPHASIS"
>root only</I
> options to operate on. Only root 
		can specify this parameter as only root has the permission needed 
		to modify attributes directly in the local smbpasswd file. 
		</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN171"
></A
><H2
>NOTES</H2
><P
>Since <B
CLASS="COMMAND"
>smbpasswd</B
> works in client-server 
	mode communicating  with a local smbd for a non-root user then 
	the smbd daemon must be running for this to work. A common problem 
	is to add a restriction to the hosts that may access the <B
CLASS="COMMAND"
>	smbd</B
> running on the local machine by specifying a 
	<TT
CLASS="PARAMETER"
><I
>allow hosts</I
></TT
> or <TT
CLASS="PARAMETER"
><I
>deny hosts</I
></TT
> 
	entry in the <TT
CLASS="FILENAME"
>smb.conf</TT
> file and neglecting to 
	allow "localhost" access to the smbd. </P
><P
>In addition, the smbpasswd command is only useful if Samba
	has been set up to use encrypted passwords. See the file 
	<TT
CLASS="FILENAME"
>ENCRYPTION.txt</TT
> in the docs directory for details 
	on how to do this. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN181"
></A
><H2
>VERSION</H2
><P
>This man page is correct for version 2.2 of 
	the Samba suite.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN184"
></A
><H2
>SEE ALSO</H2
><P
><A
HREF="smbpasswd.5.html"
TARGET="_top"
><TT
CLASS="FILENAME"
>smbpasswd(5)</TT
></A
>, 
	<A
HREF="samba.7.html"
TARGET="_top"
>samba(7)</A
>
	</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN190"
></A
><H2
>AUTHOR</H2
><P
>The original Samba software and related utilities 
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar 
	to the way the Linux kernel is developed.</P
><P
>The original Samba man pages were written by Karl Auer. 
	The man page sources were converted to YODL format (another 
	excellent piece of Open Source software, available at
	<A
HREF="ftp://ftp.icce.rug.nl/pub/unix/"
TARGET="_top"
>	ftp://ftp.icce.rug.nl/pub/unix/</A
>) and updated for the Samba 2.0 
	release by Jeremy Allison.  The conversion to DocBook for 
	Samba 2.2 was done by Gerald Carter</P
></DIV
></BODY
></HTML
>