summaryrefslogtreecommitdiff
path: root/docs/htmldocs/winbindd.8.html
blob: 09c3513c70df4e7ca741000d5c41253eb3f7f626 (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
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>winbindd</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.77"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="WINBINDD"
></A
>winbindd</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5"
></A
><H2
>Name</H2
>winbindd&nbsp;--&nbsp;Name Service Switch daemon for resolving names 
	from NT servers</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN8"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>winbindd</B
>  [-i] [-B] [-d &lt;debug level&gt;] [-s &lt;smb config file&gt;] [-n]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN16"
></A
><H2
>DESCRIPTION</H2
><P
>This program is part of the <A
HREF="samba.7.html"
TARGET="_top"
>	Samba</A
> suite.</P
><P
><B
CLASS="COMMAND"
>winbindd</B
> is a daemon that provides 
	a service for the Name Service Switch capability that is present 
	in most modern C libraries.  The Name Service Switch allows user 
	and system information to be obtained from different databases 
	services such as NIS or DNS.  The exact behaviour can be configured 
	throught the <TT
CLASS="FILENAME"
>/etc/nsswitch.conf</TT
> file.  
	Users and groups are allocated as they are resolved to a range 
	of user and group ids specified by the administrator of the 
	Samba system.</P
><P
>The service provided by <B
CLASS="COMMAND"
>winbindd</B
> is called `winbind' and 
	can be used to resolve user and group information from a 
	Windows NT server. The service can also provide authentication
	services via an associated PAM module. </P
><P
>	The <TT
CLASS="FILENAME"
>pam_winbind</TT
> module in the 2.2.2 release only 
	supports the <TT
CLASS="PARAMETER"
><I
>auth</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>account</I
></TT
> 
	module-types.  The latter simply
	performs a getpwnam() to verify that the system can obtain a uid for the
	user.  If the <TT
CLASS="FILENAME"
>libnss_winbind</TT
> library has been correctly 
	installed, this should always succeed.
	</P
><P
>The following nsswitch databases are implemented by 
	the winbindd service: </P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>hosts</DT
><DD
><P
>User information traditionally stored in 
		the <TT
CLASS="FILENAME"
>hosts(5)</TT
> file and used by 
		<B
CLASS="COMMAND"
>gethostbyname(3)</B
> functions. Names are
		resolved through the WINS server or by broadcast.
		</P
></DD
><DT
>passwd</DT
><DD
><P
>User information traditionally stored in 
		the <TT
CLASS="FILENAME"
>passwd(5)</TT
> file and used by 
		<B
CLASS="COMMAND"
>getpwent(3)</B
> functions. </P
></DD
><DT
>group</DT
><DD
><P
>Group information traditionally stored in 
		the <TT
CLASS="FILENAME"
>group(5)</TT
> file and used by 		
		<B
CLASS="COMMAND"
>getgrent(3)</B
> functions. </P
></DD
></DL
></DIV
><P
>For example, the following simple configuration in the
	<TT
CLASS="FILENAME"
>/etc/nsswitch.conf</TT
> file can be used to initially 
	resolve user and group information from <TT
CLASS="FILENAME"
>/etc/passwd
	</TT
> and <TT
CLASS="FILENAME"
>/etc/group</TT
> and then from the 
	Windows NT server. </P
><P
><PRE
CLASS="PROGRAMLISTING"
>passwd:         files winbind
group:          files winbind
	</PRE
></P
><P
>The following simple configuration in the
	<TT
CLASS="FILENAME"
>/etc/nsswitch.conf</TT
> file can be used to initially
	resolve hostnames from <TT
CLASS="FILENAME"
>/etc/hosts</TT
> and then from the
	WINS server.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN59"
></A
><H2
>OPTIONS</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>-d debuglevel</DT
><DD
><P
>Sets the debuglevel to an integer between 
		0 and 100. 0 is for no debugging and 100 is for reams and 
		reams. To submit a bug report to the Samba Team, use debug 
		level 100 (see BUGS.txt).   </P
></DD
><DT
>-i</DT
><DD
><P
>Tells <B
CLASS="COMMAND"
>winbindd</B
> to not 
		become a daemon and detach from the current terminal. This 
		option is used by developers when interactive debugging 
		of <B
CLASS="COMMAND"
>winbindd</B
> is required. </P
></DD
><DT
>-n</DT
><DD
><P
>Disable caching. This means winbindd will 
		always have to wait for a response from the domain controller 
		before it can respond to a client and this thus makes things 
		slower. The results will however be more accurate, since 
		results from the cache might not be up-to-date. This 
		might also temporarily hang winbindd if the DC doesn't respond.
		</P
></DD
><DT
>-B</DT
><DD
><P
>Dual daemon mode. This means winbindd will run 
		as 2 threads. The first will answer all requests from the cache, 
		thus making responses to clients faster. The other will 
		update the cache for the query that the first has just responded. 
		Advantage of this is that responses are accurate and fast.
		</P
></DD
><DT
>-s|--conf=smb.conf</DT
><DD
><P
>Specifies the location of the all-important
		<TT
CLASS="FILENAME"
>smb.conf</TT
> file. </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN85"
></A
><H2
>NAME AND ID RESOLUTION</H2
><P
>Users and groups on a Windows NT server are assigned 
	a relative id (rid) which is unique for the domain when the 
	user or group is created.  To convert the Windows NT user or group 
	into a unix user or group, a mapping between rids and unix user 
	and group ids is required.  This is one of the jobs that <B
CLASS="COMMAND"
>	winbindd</B
> performs. </P
><P
>As winbindd users and groups are resolved from a server, user 
	and group ids are allocated from a specified range.  This
	is done on a first come, first served basis, although all existing 
	users and groups will be mapped as soon as a client performs a user 
	or group enumeration command.  The allocated unix ids are stored 
	in a database file under the Samba lock directory and will be 
	remembered. </P
><P
>WARNING: The rid to unix id database is the only location 
	where the user and group mappings are stored by winbindd.  If this 
	file is deleted or corrupted, there is no way for winbindd to 
	determine which user and group ids correspond to Windows NT user 
	and group rids. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN91"
></A
><H2
>CONFIGURATION</H2
><P
>Configuration of the <B
CLASS="COMMAND"
>winbindd</B
> daemon 
	is done through configuration parameters in the <TT
CLASS="FILENAME"
>smb.conf(5)
	</TT
> file.  All parameters should be specified in the 
	[global] section of smb.conf. </P
><P
></P
><UL
><LI
><P
><A
HREF="smb.conf.5.html#WINBINDSEPARATOR"
TARGET="_top"
>		<TT
CLASS="PARAMETER"
><I
>winbind separator</I
></TT
></A
></P
></LI
><LI
><P
><A
HREF="smb.conf.5.html#WINBINDUID"
TARGET="_top"
>		<TT
CLASS="PARAMETER"
><I
>winbind uid</I
></TT
></A
></P
></LI
><LI
><P
><A
HREF="smb.conf.5.html#WINBINDGID"
TARGET="_top"
>		<TT
CLASS="PARAMETER"
><I
>winbind gid</I
></TT
></A
></P
></LI
><LI
><P
><A
HREF="smb.conf.5.html#WINBINDCACHETIME"
TARGET="_top"
>		<TT
CLASS="PARAMETER"
><I
>winbind cache time</I
></TT
></A
></P
></LI
><LI
><P
><A
HREF="smb.conf.5.html#WINBINDENUMUSERS"
TARGET="_top"
>		<TT
CLASS="PARAMETER"
><I
>winbind enum users</I
></TT
></A
></P
></LI
><LI
><P
><A
HREF="smb.conf.5.html#WINBINDENUMGROUPS"
TARGET="_top"
>		<TT
CLASS="PARAMETER"
><I
>winbind enum groups</I
></TT
></A
></P
></LI
><LI
><P
><A
HREF="smb.conf.5.html#TEMPLATEHOMEDIR"
TARGET="_top"
>		<TT
CLASS="PARAMETER"
><I
>template homedir</I
></TT
></A
></P
></LI
><LI
><P
><A
HREF="smb.conf.5.html#TEMPLATESHELL"
TARGET="_top"
>		<TT
CLASS="PARAMETER"
><I
>template shell</I
></TT
></A
></P
></LI
><LI
><P
><A
HREF="smb.conf.5.html#WINBINDUSEDEFAULTDOMAIN"
TARGET="_top"
>		<TT
CLASS="PARAMETER"
><I
>winbind use default domain</I
></TT
></A
></P
></LI
></UL
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN133"
></A
><H2
>EXAMPLE SETUP</H2
><P
>To setup winbindd for user and group lookups plus 
	authentication from a domain controller use something like the 
	following setup. This was tested on a RedHat 6.2 Linux box. </P
><P
>In <TT
CLASS="FILENAME"
>/etc/nsswitch.conf</TT
> put the 
	following:</P
><P
><PRE
CLASS="PROGRAMLISTING"
>passwd:     files winbind
group:      files winbind
	</PRE
></P
><P
>In <TT
CLASS="FILENAME"
>/etc/pam.d/*</TT
> replace the 
	<TT
CLASS="PARAMETER"
><I
>auth</I
></TT
> lines with something like this: </P
><P
><PRE
CLASS="PROGRAMLISTING"
>auth       required	/lib/security/pam_securetty.so
auth       required	/lib/security/pam_nologin.so
auth       sufficient	/lib/security/pam_winbind.so
auth       required     /lib/security/pam_pwdb.so use_first_pass shadow nullok
	</PRE
></P
><P
>Note in particular the use of the <TT
CLASS="PARAMETER"
><I
>sufficient</I
></TT
> 
	keyword and the <TT
CLASS="PARAMETER"
><I
>use_first_pass</I
></TT
> keyword. </P
><P
>Now replace the account lines with this: </P
><P
><B
CLASS="COMMAND"
>account    required	/lib/security/pam_winbind.so
	</B
></P
><P
>The next step is to join the domain. To do that use the 
	<B
CLASS="COMMAND"
>smbpasswd</B
> program like this:  </P
><P
><B
CLASS="COMMAND"
>smbpasswd -j DOMAIN -r PDC -U
	Administrator</B
></P
><P
>The username after the <TT
CLASS="PARAMETER"
><I
>-U</I
></TT
> can be any
	Domain user that has administrator privileges on the machine.
	Substitute your domain name for "DOMAIN" and the name of your PDC
	for "PDC".</P
><P
>Next copy <TT
CLASS="FILENAME"
>libnss_winbind.so</TT
> to 
	<TT
CLASS="FILENAME"
>/lib</TT
> and <TT
CLASS="FILENAME"
>pam_winbind.so</TT
>
	to <TT
CLASS="FILENAME"
>/lib/security</TT
>.  A symbolic link needs to be
	made from <TT
CLASS="FILENAME"
>/lib/libnss_winbind.so</TT
> to
	<TT
CLASS="FILENAME"
>/lib/libnss_winbind.so.2</TT
>.  If you are using an
	older version of glibc then the target of the link should be
	<TT
CLASS="FILENAME"
>/lib/libnss_winbind.so.1</TT
>.</P
><P
>Finally, setup a <TT
CLASS="FILENAME"
>smb.conf</TT
> containing directives like the 
	following:  </P
><P
><PRE
CLASS="PROGRAMLISTING"
>[global]
	winbind separator = +
        winbind cache time = 10
        template shell = /bin/bash
        template homedir = /home/%D/%U
        winbind uid = 10000-20000
        winbind gid = 10000-20000
        workgroup = DOMAIN
        security = domain
        password server = *
	</PRE
></P
><P
>Now start winbindd and you should find that your user and 
	group database is expanded to include your NT users and groups, 
	and that you can login to your unix box as a domain user, using 
	the DOMAIN+user syntax for the username. You may wish to use the 
	commands <B
CLASS="COMMAND"
>getent passwd</B
> and <B
CLASS="COMMAND"
>getent group
	</B
> to confirm the correct operation of winbindd.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN172"
></A
><H2
>NOTES</H2
><P
>The following notes are useful when configuring and 
	running <B
CLASS="COMMAND"
>winbindd</B
>: </P
><P
><B
CLASS="COMMAND"
>nmbd</B
> must be running on the local machine 
	for <B
CLASS="COMMAND"
>winbindd</B
> to work. <B
CLASS="COMMAND"
>winbindd</B
>
	queries the list of trusted domains for the Windows NT server
	on startup and when a SIGHUP is received.  Thus, for a running <B
CLASS="COMMAND"
>	winbindd</B
> to become aware of new trust relationships between 
	servers, it must be sent a SIGHUP signal. </P
><P
>Client processes resolving names through the <B
CLASS="COMMAND"
>winbindd</B
>
	nsswitch module read an environment variable named <TT
CLASS="ENVAR"
>	$WINBINDD_DOMAIN</TT
>.  If this variable contains a comma separated
	list of Windows NT domain names, then winbindd will only resolve users
	and groups within those Windows NT domains. </P
><P
>PAM is really easy to misconfigure.  Make sure you know what 
	you are doing when modifying PAM configuration files.  It is possible 
	to set up PAM such that you can no longer log into your system. </P
><P
>If more than one UNIX machine is running <B
CLASS="COMMAND"
>winbindd</B
>, 
	then in general the user and groups ids allocated by winbindd will not 
	be the same.  The user and group ids will only be valid for the local 
	machine.</P
><P
>If the the Windows NT RID to UNIX user and group id mapping 
	file is damaged or destroyed then the mappings will be lost. </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN188"
></A
><H2
>SIGNALS</H2
><P
>The following signals can be used to manipulate the 
	<B
CLASS="COMMAND"
>winbindd</B
> daemon. </P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>SIGHUP</DT
><DD
><P
>Reload the <TT
CLASS="FILENAME"
>smb.conf(5)</TT
>
		file and apply any parameter changes to the running 
		version of winbindd.  This signal also clears any cached 
		user and group information.  The list of other domains trusted 
		by winbindd is also reloaded.  </P
></DD
><DT
>SIGUSR1</DT
><DD
><P
>The SIGUSR1 signal will cause <B
CLASS="COMMAND"
>		winbindd</B
> to write status information to the winbind 
		log file including information about the number of user and 
		group ids allocated by <B
CLASS="COMMAND"
>winbindd</B
>.</P
><P
>Log files are stored in the filename specified by the 
		log file parameter.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN205"
></A
><H2
>FILES</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="FILENAME"
>/etc/nsswitch.conf(5)</TT
></DT
><DD
><P
>Name service switch configuration file.</P
></DD
><DT
>/tmp/.winbindd/pipe</DT
><DD
><P
>The UNIX pipe over which clients communicate with 
		the <B
CLASS="COMMAND"
>winbindd</B
> program.  For security reasons, the 
		winbind client will only attempt to connect to the winbindd daemon 
		if both the <TT
CLASS="FILENAME"
>/tmp/.winbindd</TT
> directory
		and <TT
CLASS="FILENAME"
>/tmp/.winbindd/pipe</TT
> file are owned by 
		root. </P
></DD
><DT
>/lib/libnss_winbind.so.X</DT
><DD
><P
>Implementation of name service switch library.
		</P
></DD
><DT
>$LOCKDIR/winbindd_idmap.tdb</DT
><DD
><P
>Storage for the Windows NT rid to UNIX user/group 
		id mapping.  The lock directory is specified when Samba is initially 
		compiled using the <TT
CLASS="PARAMETER"
><I
>--with-lockdir</I
></TT
> option.
		This directory is by default <TT
CLASS="FILENAME"
>/usr/local/samba/var/locks
		</TT
>. </P
></DD
><DT
>$LOCKDIR/winbindd_cache.tdb</DT
><DD
><P
>Storage for cached user and group information.
		</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN234"
></A
><H2
>VERSION</H2
><P
>This man page is correct for version 3.0 of
        the Samba suite.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN237"
></A
><H2
>SEE ALSO</H2
><P
><TT
CLASS="FILENAME"
>nsswitch.conf(5)</TT
>,
	<A
HREF="samba.7.html"
TARGET="_top"
>samba(7)</A
>,
	<A
HREF="wbinfo.1.html"
TARGET="_top"
>wbinfo(1)</A
>,
	<A
HREF="smb.conf.5.html"
TARGET="_top"
>smb.conf(5)</A
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN244"
></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
><B
CLASS="COMMAND"
>wbinfo</B
> and <B
CLASS="COMMAND"
>winbindd</B
>
	were written by Tim Potter.</P
><P
>The conversion to DocBook for Samba 2.2 was done 
	by Gerald Carter</P
></DIV
></BODY
></HTML
>