Initial import
[samba] / docs / manpages / winbindd.8
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "WINBINDD" 8 "" "" ""
21 .SH NAME
22 winbindd \- Name Service Switch daemon for resolving names from NT servers
23 .SH "SYNOPSIS"
24 .ad l
25 .hy 0
26 .HP 9
27 \fBwinbindd\fR [\-F] [\-S] [\-i] [\-Y] [\-d\ <debug\ level>] [\-s\ <smb\ config\ file>] [\-n]
28 .ad
29 .hy
30
31 .SH "DESCRIPTION"
32
33 .PP
34 This program is part of the \fBsamba\fR(7) suite\&.
35
36 .PP
37 \fBwinbindd\fR is a daemon that provides a number of services to the Name Service Switch capability found in most modern C libraries, to arbitary applications via PAM and \fBntlm_auth\fR and to Samba itself\&.
38
39 .PP
40 Even if winbind is not used for nsswitch, it still provides a service to \fBsmbd\fR, \fBntlm_auth\fR and the \fBpam_winbind\&.so\fR PAM module, by managing connections to domain controllers\&. In this configuraiton the idmap uid and idmap gid parameters are not required\&. (This is known as `netlogon proxy only mode'\&.)
41
42 .PP
43 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 \fI/etc/nsswitch\&.conf\fR 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\&.
44
45 .PP
46 The service provided by \fBwinbindd\fR 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\&.
47
48 .PP
49 The \fIpam_winbind\fR module supports the \fIauth\fR, \fIaccount\fR and \fIpassword\fR module\-types\&. It should be noted that the \fIaccount\fR module simply performs a getpwnam() to verify that the system can obtain a uid for the user, as the domain controller has already performed access control\&. If the \fIlibnss_winbind\fR library has been correctly installed, or an alternate source of names configured, this should always succeed\&.
50
51 .PP
52 The following nsswitch databases are implemented by the winbindd service:
53
54 .TP
55 hosts
56 This feature is only available on IRIX\&. User information traditionally stored in the \fIhosts(5)\fR file and used by\fBgethostbyname(3)\fR functions\&. Names are resolved through the WINS server or by broadcast\&.
57
58 .TP
59 passwd
60 User information traditionally stored in the \fIpasswd(5)\fR file and used by\fBgetpwent(3)\fR functions\&.
61
62 .TP
63 group
64 Group information traditionally stored in the \fIgroup(5)\fR file and used by\fBgetgrent(3)\fR functions\&.
65
66 .PP
67 For example, the following simple configuration in the\fI/etc/nsswitch\&.conf\fR file can be used to initially resolve user and group information from \fI/etc/passwd \fR and \fI/etc/group\fR and then from the Windows NT server\&. 
68 .nf
69
70 passwd:         files winbind
71 group:          files winbind
72 ## only available on IRIX; Linux users should us libnss_wins\&.so
73 hosts:          files dns winbind
74 .fi
75
76
77 .PP
78 The following simple configuration in the\fI/etc/nsswitch\&.conf\fR file can be used to initially resolve hostnames from \fI/etc/hosts\fR and then from the WINS server\&.
79 .nf
80
81 hosts:          files wins
82 .fi
83
84 .SH "OPTIONS"
85
86 .TP
87 \-F
88 If specified, this parameter causes the main \fBwinbindd\fR process to not daemonize, i\&.e\&. double\-fork and disassociate with the terminal\&. Child processes are still created as normal to service each connection request, but the main process does not exit\&. This operation mode is suitable for running\fBwinbindd\fR under process supervisors such as \fBsupervise\fR and \fBsvscan\fR from Daniel J\&. Bernstein's \fBdaemontools\fR package, or the AIX process monitor\&.
89
90 .TP
91 \-S
92 If specified, this parameter causes\fBwinbindd\fR to log to standard output rather than a file\&.
93
94 .TP
95 \-V
96 Prints the program version number\&.
97
98 .TP
99 \-s <configuration file>
100 The file specified contains the configuration details required by the server\&. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See \fIsmb\&.conf\fR for more information\&. The default configuration file name is determined at compile time\&.
101
102 .TP
103 \-d|\-\-debuglevel=level
104 \fIlevel\fR is an integer from 0 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 about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
107
108 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\&.
109
110 Note that specifying this parameter here will override the  parameter in the \fIsmb\&.conf\fR file\&.
111
112 .TP
113 \-l|\-\-logfile=logdirectory
114 Base directory name for log/debug files\&. The extension \fB"\&.progname"\fR will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
115
116 .TP
117 \-h|\-\-help
118 Print a summary of command line options\&.
119
120 .TP
121 \-i
122 Tells \fBwinbindd\fR to not become a daemon and detach from the current terminal\&. This option is used by developers when interactive debugging of \fBwinbindd\fR is required\&.\fBwinbindd\fR also logs to standard output, as if the \fB\-S\fR parameter had been given\&.
123
124 .TP
125 \-n
126 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\&.
127
128 .TP
129 \-Y
130 Single daemon mode\&. This means winbindd will run as a single process (the mode of operation in Samba 2\&.2)\&. Winbindd's default behavior is to launch a child process that is responsible for updating expired cache entries\&.
131
132 .SH "NAME AND ID RESOLUTION"
133
134 .PP
135 Users and groups on a Windows NT server are assigned a security id (SID) which is globally unique when the user or group is created\&. To convert the Windows NT user or group into a unix user or group, a mapping between SIDs and unix user and group ids is required\&. This is one of the jobs that \fB winbindd\fR performs\&.
136
137 .PP
138 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\&.
139
140 .PP
141 WARNING: The SID 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\&.
142
143 .PP
144 See the  parameter in \fIsmb\&.conf\fR for options for sharing this database, such as via LDAP\&.
145
146 .SH "CONFIGURATION"
147
148 .PP
149 Configuration of the \fBwinbindd\fR daemon is done through configuration parameters in the \fBsmb\&.conf\fR(5) file\&. All parameters should be specified in the [global] section of smb\&.conf\&.
150
151 .TP 3
152 \(bu
153 winbind separator
154 .TP
155 \(bu
156 idmap uid
157 .TP
158 \(bu
159 idmap gid
160 .TP
161 \(bu
162 idmap backend
163 .TP
164 \(bu
165 winbind cache time
166 .TP
167 \(bu
168 winbind enum users
169 .TP
170 \(bu
171 winbind enum groups
172 .TP
173 \(bu
174 template homedir
175 .TP
176 \(bu
177 template shell
178 .TP
179 \(bu
180 winbind use default domain
181 .LP
182
183 .SH "EXAMPLE SETUP"
184
185 .PP
186 To setup winbindd for user and group lookups plus authentication from a domain controller use something like the following setup\&. This was tested on an early Red Hat Linux box\&.
187
188 .PP
189 In \fI/etc/nsswitch\&.conf\fR put the following: 
190 .nf
191
192 passwd: files winbind
193 group:  files winbind
194 .fi
195  
196
197 .PP
198 In \fI/etc/pam\&.d/*\fR replace the \fI auth\fR lines with something like this: 
199 .nf
200
201 auth  required    /lib/security/pam_securetty\&.so
202 auth  required    /lib/security/pam_nologin\&.so
203 auth  sufficient  /lib/security/pam_winbind\&.so
204 auth  required    /lib/security/pam_unix\&.so \\
205                   use_first_pass shadow nullok
206 .fi
207  
208
209 .RS
210 .Sh "Note"
211
212 .PP
213 The PAM module pam_unix has recently replaced the module pam_pwdb\&. Some Linux systems use the module pam_unix2 in place of pam_unix\&.
214
215 .RE
216
217 .PP
218 Note in particular the use of the \fIsufficient \fR keyword and the \fIuse_first_pass\fR keyword\&.
219
220 .PP
221 Now replace the account lines with this:
222
223 .PP
224 \fBaccount required /lib/security/pam_winbind\&.so \fR
225
226 .PP
227 The next step is to join the domain\&. To do that use the\fBnet\fR program like this:
228
229 .PP
230 \fBnet join \-S PDC \-U Administrator\fR
231
232 .PP
233 The username after the \fI\-U\fR can be any Domain user that has administrator privileges on the machine\&. Substitute the name or IP of your PDC for "PDC"\&.
234
235 .PP
236 Next copy \fIlibnss_winbind\&.so\fR to\fI/lib\fR and \fIpam_winbind\&.so \fR to \fI/lib/security\fR\&. A symbolic link needs to be made from \fI/lib/libnss_winbind\&.so\fR to\fI/lib/libnss_winbind\&.so\&.2\fR\&. If you are using an older version of glibc then the target of the link should be\fI/lib/libnss_winbind\&.so\&.1\fR\&.
237
238 .PP
239 Finally, setup a \fBsmb\&.conf\fR(5) containing directives like the following: 
240 .nf
241
242 [global]
243         winbind separator = +
244         winbind cache time = 10
245         template shell = /bin/bash
246         template homedir = /home/%D/%U
247         idmap uid = 10000\-20000
248         idmap gid = 10000\-20000
249         workgroup = DOMAIN
250         security = domain
251         password server = *
252 .fi
253
254
255 .PP
256 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 \fBgetent passwd\fR and \fBgetent group \fR to confirm the correct operation of winbindd\&.
257
258 .SH "NOTES"
259
260 .PP
261 The following notes are useful when configuring and running \fBwinbindd\fR:
262
263 .PP
264 \fBnmbd\fR(8) must be running on the local machine for \fBwinbindd\fR to work\&.
265
266 .PP
267 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\&.
268
269 .PP
270 If more than one UNIX machine is running \fBwinbindd\fR, 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, unless a shared  is configured\&.
271
272 .PP
273 If the the Windows NT SID to UNIX user and group id mapping file is damaged or destroyed then the mappings will be lost\&.
274
275 .SH "SIGNALS"
276
277 .PP
278 The following signals can be used to manipulate the\fBwinbindd\fR daemon\&.
279
280 .TP
281 SIGHUP
282 Reload the \fBsmb\&.conf\fR(5) 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\&.
283
284 .TP
285 SIGUSR2
286 The SIGUSR2 signal will cause \fB winbindd\fR to write status information to the winbind log file\&.
287
288 Log files are stored in the filename specified by the log file parameter\&.
289
290 .SH "FILES"
291
292 .TP
293 \fI/etc/nsswitch\&.conf(5)\fR
294 Name service switch configuration file\&.
295
296 .TP
297 /tmp/\&.winbindd/pipe
298 The UNIX pipe over which clients communicate with the \fBwinbindd\fR program\&. For security reasons, the winbind client will only attempt to connect to the winbindd daemon if both the \fI/tmp/\&.winbindd\fR directory and \fI/tmp/\&.winbindd/pipe\fR file are owned by root\&.
299
300 .TP
301 $LOCKDIR/winbindd_privileged/pipe
302 The UNIX pipe over which 'privileged' clients communicate with the \fBwinbindd\fR program\&. For security reasons, access to some winbindd functions \- like those needed by the \fBntlm_auth\fR utility \- is restricted\&. By default, only users in the 'root' group will get this access, however the administrator may change the group permissions on $LOCKDIR/winbindd_privileged to allow programs like 'squid' to use ntlm_auth\&. Note that the winbind client will only attempt to connect to the winbindd daemon if both the \fI$LOCKDIR/winbindd_privileged\fR directory and \fI$LOCKDIR/winbindd_privileged/pipe\fR file are owned by root\&.
303
304 .TP
305 /lib/libnss_winbind\&.so\&.X
306 Implementation of name service switch library\&.
307
308 .TP
309 $LOCKDIR/winbindd_idmap\&.tdb
310 Storage for the Windows NT rid to UNIX user/group id mapping\&. The lock directory is specified when Samba is initially compiled using the \fI\-\-with\-lockdir\fR option\&. This directory is by default \fI/usr/local/samba/var/locks \fR\&.
311
312 .TP
313 $LOCKDIR/winbindd_cache\&.tdb
314 Storage for cached user and group information\&.
315
316 .SH "VERSION"
317
318 .PP
319 This man page is correct for version 3\&.0 of the Samba suite\&.
320
321 .SH "SEE ALSO"
322
323 .PP
324 \fInsswitch\&.conf(5)\fR, \fBsamba\fR(7), \fBwbinfo\fR(1), \fBntlm_auth\fR(8), \fBsmb\&.conf\fR(5), \fBpam_winbind\fR(8)
325
326 .SH "AUTHOR"
327
328 .PP
329 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\&.
330
331 .PP
332 \fBwbinfo\fR and \fBwinbindd\fR were written by Tim Potter\&.
333
334 .PP
335 The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
336