source: vendor/3.5.7/docs/htmldocs/manpages/winbindd.8.html

Last change on this file was 478, checked in by Silvan Scherrer, 15 years ago

Samba 3.5: vendor update to 3.5.4
File size: 20.7 KB
Line 
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>winbindd</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="winbindd.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>winbindd &#8212; Name Service Switch daemon for resolving names
2 from NT servers</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">winbindd</code> [-D] [-F] [-S] [-i] [-Y] [-d &lt;debug level&gt;] [-s &lt;smb config file&gt;] [-n]</p></div></div><div class="refsect1" lang="en"><a name="id2483339"></a><h2>DESCRIPTION</h2><p>This program is part of the <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p><code class="literal">winbindd</code> is a daemon that provides
3 a number of services to the Name Service Switch capability found
4 in most modern C libraries, to arbitrary applications via PAM
5 and <code class="literal">ntlm_auth</code> and to Samba itself.</p><p>Even if winbind is not used for nsswitch, it still provides a
6 service to <code class="literal">smbd</code>, <code class="literal">ntlm_auth</code>
7 and the <code class="literal">pam_winbind.so</code> PAM module, by managing connections to
8 domain controllers. In this configuraiton the
9 <a class="link" href="smb.conf.5.html#IDMAPUID" target="_top">idmap uid</a> and
10 <a class="link" href="smb.conf.5.html#IDMAPGID" target="_top">idmap gid</a>
11 parameters are not required. (This is known as `netlogon proxy only mode'.)</p><p> The Name Service Switch allows user
12 and system information to be obtained from different databases
13 services such as NIS or DNS. The exact behaviour can be configured
14 through the <code class="filename">/etc/nsswitch.conf</code> file.
15 Users and groups are allocated as they are resolved to a range
16 of user and group ids specified by the administrator of the
17 Samba system.</p><p>The service provided by <code class="literal">winbindd</code> is called `winbind' and
18 can be used to resolve user and group information from a
19 Windows NT server. The service can also provide authentication
20 services via an associated PAM module. </p><p>
21 The <code class="filename">pam_winbind</code> module supports the
22 <em class="parameter"><code>auth</code></em>, <em class="parameter"><code>account</code></em>
23 and <em class="parameter"><code>password</code></em>
24 module-types. It should be noted that the
25 <em class="parameter"><code>account</code></em> module simply performs a getpwnam() to verify that
26 the system can obtain a uid for the user, as the domain
27 controller has already performed access control. If the
28 <code class="filename">libnss_winbind</code> library has been correctly
29 installed, or an alternate source of names configured, this should always succeed.
30 </p><p>The following nsswitch databases are implemented by
31 the winbindd service: </p><div class="variablelist"><dl><dt><span class="term">hosts</span></dt><dd><p>This feature is only available on IRIX.
32 User information traditionally stored in
33 the <code class="filename">hosts(5)</code> file and used by
34 <code class="literal">gethostbyname(3)</code> functions. Names are
35 resolved through the WINS server or by broadcast.
36 </p></dd><dt><span class="term">passwd</span></dt><dd><p>User information traditionally stored in
37 the <code class="filename">passwd(5)</code> file and used by
38 <code class="literal">getpwent(3)</code> functions. </p></dd><dt><span class="term">group</span></dt><dd><p>Group information traditionally stored in
39 the <code class="filename">group(5)</code> file and used by
40 <code class="literal">getgrent(3)</code> functions. </p></dd></dl></div><p>For example, the following simple configuration in the
41 <code class="filename">/etc/nsswitch.conf</code> file can be used to initially
42 resolve user and group information from <code class="filename">/etc/passwd
43 </code> and <code class="filename">/etc/group</code> and then from the
44 Windows NT server.
45 </p><pre class="programlisting">
46passwd: files winbind
47group: files winbind
48## only available on IRIX: use winbind to resolve hosts:
49# hosts: files dns winbind
50## All other NSS enabled systems should use libnss_wins.so like this:
51hosts: files dns wins
52
53</pre><p>The following simple configuration in the
54 <code class="filename">/etc/nsswitch.conf</code> file can be used to initially
55 resolve hostnames from <code class="filename">/etc/hosts</code> and then from the
56 WINS server.</p><pre class="programlisting">
57hosts: files wins
58</pre></div><div class="refsect1" lang="en"><a name="id2481522"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-D</span></dt><dd><p>If specified, this parameter causes
59 the server to operate as a daemon. That is, it detaches
60 itself and runs in the background on the appropriate port.
61 This switch is assumed if <code class="literal">winbindd</code> is
62 executed on the command line of a shell.
63 </p></dd><dt><span class="term">-F</span></dt><dd><p>If specified, this parameter causes
64 the main <code class="literal">winbindd</code> process to not daemonize,
65 i.e. double-fork and disassociate with the terminal.
66 Child processes are still created as normal to service
67 each connection request, but the main process does not
68 exit. This operation mode is suitable for running
69 <code class="literal">winbindd</code> under process supervisors such
70 as <code class="literal">supervise</code> and <code class="literal">svscan</code>
71 from Daniel J. Bernstein's <code class="literal">daemontools</code>
72 package, or the AIX process monitor.
73 </p></dd><dt><span class="term">-S</span></dt><dd><p>If specified, this parameter causes
74 <code class="literal">winbindd</code> to log to standard output rather
75 than a file.</p></dd><dt><span class="term">-d|--debuglevel=level</span></dt><dd><p><em class="replaceable"><code>level</code></em> is an integer
76from 0 to 10. The default value if this parameter is
77not specified is 0.</p><p>The higher this value, the more detail will be
78logged to the log files about the activities of the
79server. At level 0, only critical errors and serious
80warnings will be logged. Level 1 is a reasonable level for
81day-to-day running - it generates a small amount of
82information about operations carried out.</p><p>Levels above 1 will generate considerable
83amounts of log data, and should only be used when
84investigating a problem. Levels above 3 are designed for
85use only by developers and generate HUGE amounts of log
86data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will
87override the <a class="link" href="smb.conf.5.html#" target="_top"></a> parameter
88in the <code class="filename">smb.conf</code> file.</p></dd><dt><span class="term">-V|--version</span></dt><dd><p>Prints the program version number.
89</p></dd><dt><span class="term">-s|--configfile &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
90configuration details required by the server. The
91information in this file includes server-specific
92information such as what printcap file to use, as well
93as descriptions of all the services that the server is
94to provide. See <code class="filename">smb.conf</code> for more information.
95The default configuration file name is determined at
96compile time.</p></dd><dt><span class="term">-l|--log-basename=logdirectory</span></dt><dd><p>Base directory name for log/debug files. The extension
97<code class="constant">".progname"</code> will be appended (e.g. log.smbclient,
98log.smbd, etc...). The log file is never removed by the client.
99</p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
100</p></dd><dt><span class="term">-i</span></dt><dd><p>Tells <code class="literal">winbindd</code> to not
101 become a daemon and detach from the current terminal. This
102 option is used by developers when interactive debugging
103 of <code class="literal">winbindd</code> is required.
104 <code class="literal">winbindd</code> also logs to standard output,
105 as if the <code class="literal">-S</code> parameter had been given.
106 </p></dd><dt><span class="term">-n</span></dt><dd><p>Disable caching. This means winbindd will
107 always have to wait for a response from the domain controller
108 before it can respond to a client and this thus makes things
109 slower. The results will however be more accurate, since
110 results from the cache might not be up-to-date. This
111 might also temporarily hang winbindd if the DC doesn't respond.
112 </p></dd><dt><span class="term">-Y</span></dt><dd><p>Single daemon mode. This means winbindd will run
113 as a single process (the mode of operation in Samba 2.2). Winbindd's
114 default behavior is to launch a child process that is responsible for
115 updating expired cache entries.
116 </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2481802"></a><h2>NAME AND ID RESOLUTION</h2><p>Users and groups on a Windows NT server are assigned
117 a security id (SID) which is globally unique when the
118 user or group is created. To convert the Windows NT user or group
119 into a unix user or group, a mapping between SIDs and unix user
120 and group ids is required. This is one of the jobs that <code class="literal">
121 winbindd</code> performs. </p><p>As winbindd users and groups are resolved from a server, user
122 and group ids are allocated from a specified range. This
123 is done on a first come, first served basis, although all existing
124 users and groups will be mapped as soon as a client performs a user
125 or group enumeration command. The allocated unix ids are stored
126 in a database and will be remembered. </p><p>WARNING: The SID to unix id database is the only location
127 where the user and group mappings are stored by winbindd. If this
128 store is deleted or corrupted, there is no way for winbindd to
129 determine which user and group ids correspond to Windows NT user
130 and group rids. </p></div><div class="refsect1" lang="en"><a name="id2481840"></a><h2>CONFIGURATION</h2><p>Configuration of the <code class="literal">winbindd</code> daemon
131 is done through configuration parameters in the <a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file. All parameters should be specified in the
132 [global] section of smb.conf. </p><div class="itemizedlist"><ul type="disc"><li><p>
133 <a class="link" href="smb.conf.5.html#WINBINDSEPARATOR" target="_top">winbind separator</a></p></li><li><p>
134 <a class="link" href="smb.conf.5.html#IDMAPUID" target="_top">idmap uid</a></p></li><li><p>
135 <a class="link" href="smb.conf.5.html#IDMAPGID" target="_top">idmap gid</a></p></li><li><p>
136 <a class="link" href="smb.conf.5.html#IDMAPBACKEND" target="_top">idmap backend</a></p></li><li><p>
137 <a class="link" href="smb.conf.5.html#WINBINDCACHETIME" target="_top">winbind cache time</a></p></li><li><p>
138 <a class="link" href="smb.conf.5.html#WINBINDENUMUSERS" target="_top">winbind enum users</a></p></li><li><p>
139 <a class="link" href="smb.conf.5.html#WINBINDENUMGROUPS" target="_top">winbind enum groups</a></p></li><li><p>
140 <a class="link" href="smb.conf.5.html#TEMPLATEHOMEDIR" target="_top">template homedir</a></p></li><li><p>
141 <a class="link" href="smb.conf.5.html#TEMPLATESHELL" target="_top">template shell</a></p></li><li><p>
142 <a class="link" href="smb.conf.5.html#WINBINDUSEDEFAULTDOMAIN" target="_top">winbind use default domain</a></p></li><li><p>
143 <a class="link" href="smb.conf.5.html#WINBIND:RPCONLY" target="_top">winbind: rpc only</a>
144 Setting this parameter forces winbindd to use RPC
145 instead of LDAP to retrieve information from Domain
146 Controllers.
147 </p></li></ul></div></div><div class="refsect1" lang="en"><a name="id2532496"></a><h2>EXAMPLE SETUP</h2><p>
148 To setup winbindd for user and group lookups plus
149 authentication from a domain controller use something like the
150 following setup. This was tested on an early Red Hat Linux box.
151 </p><p>In <code class="filename">/etc/nsswitch.conf</code> put the
152 following:
153</p><pre class="programlisting">
154passwd: files winbind
155group: files winbind
156</pre><p>
157 </p><p>In <code class="filename">/etc/pam.d/*</code> replace the <em class="parameter"><code>
158 auth</code></em> lines with something like this:
159</p><pre class="programlisting">
160auth required /lib/security/pam_securetty.so
161auth required /lib/security/pam_nologin.so
162auth sufficient /lib/security/pam_winbind.so
163auth required /lib/security/pam_unix.so \
164 use_first_pass shadow nullok
165</pre><p>
166 </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
167 The PAM module pam_unix has recently replaced the module pam_pwdb.
168 Some Linux systems use the module pam_unix2 in place of pam_unix.
169 </p></div><p>Note in particular the use of the <em class="parameter"><code>sufficient
170 </code></em> keyword and the <em class="parameter"><code>use_first_pass</code></em> keyword. </p><p>Now replace the account lines with this: </p><p><code class="literal">account required /lib/security/pam_winbind.so
171 </code></p><p>The next step is to join the domain. To do that use the
172 <code class="literal">net</code> program like this: </p><p><code class="literal">net join -S PDC -U Administrator</code></p><p>The username after the <em class="parameter"><code>-U</code></em> can be any
173 Domain user that has administrator privileges on the machine.
174 Substitute the name or IP of your PDC for "PDC".</p><p>Next copy <code class="filename">libnss_winbind.so</code> to
175 <code class="filename">/lib</code> and <code class="filename">pam_winbind.so
176 </code> to <code class="filename">/lib/security</code>. A symbolic link needs to be
177 made from <code class="filename">/lib/libnss_winbind.so</code> to
178 <code class="filename">/lib/libnss_winbind.so.2</code>. If you are using an
179 older version of glibc then the target of the link should be
180 <code class="filename">/lib/libnss_winbind.so.1</code>.</p><p>Finally, setup a <a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> containing directives like the
181 following:
182</p><pre class="programlisting">
183[global]
184 winbind separator = +
185 winbind cache time = 10
186 template shell = /bin/bash
187 template homedir = /home/%D/%U
188 idmap uid = 10000-20000
189 idmap gid = 10000-20000
190 workgroup = DOMAIN
191 security = domain
192 password server = *
193</pre><p>Now start winbindd and you should find that your user and
194 group database is expanded to include your NT users and groups,
195 and that you can login to your unix box as a domain user, using
196 the DOMAIN+user syntax for the username. You may wish to use the
197 commands <code class="literal">getent passwd</code> and <code class="literal">getent group
198 </code> to confirm the correct operation of winbindd.</p></div><div class="refsect1" lang="en"><a name="id2532687"></a><h2>NOTES</h2><p>The following notes are useful when configuring and
199 running <code class="literal">winbindd</code>: </p><p><a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> must be running on the local machine
200 for <code class="literal">winbindd</code> to work. </p><p>PAM is really easy to misconfigure. Make sure you know what
201 you are doing when modifying PAM configuration files. It is possible
202 to set up PAM such that you can no longer log into your system. </p><p>If more than one UNIX machine is running <code class="literal">winbindd</code>,
203 then in general the user and groups ids allocated by winbindd will not
204 be the same. The user and group ids will only be valid for the local
205 machine, unless a shared <a class="link" href="smb.conf.5.html#IDMAPBACKEND" target="_top">idmap backend</a> is configured.</p><p>If the the Windows NT SID to UNIX user and group id mapping
206 file is damaged or destroyed then the mappings will be lost. </p></div><div class="refsect1" lang="en"><a name="id2532752"></a><h2>SIGNALS</h2><p>The following signals can be used to manipulate the
207 <code class="literal">winbindd</code> daemon. </p><div class="variablelist"><dl><dt><span class="term">SIGHUP</span></dt><dd><p>Reload the <a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file and
208 apply any parameter changes to the running
209 version of winbindd. This signal also clears any cached
210 user and group information. The list of other domains trusted
211 by winbindd is also reloaded. </p></dd><dt><span class="term">SIGUSR2</span></dt><dd><p>The SIGUSR2 signal will cause <code class="literal">
212 winbindd</code> to write status information to the winbind
213 log file.</p><p>Log files are stored in the filename specified by the
214 log file parameter.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2532815"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="filename">/etc/nsswitch.conf(5)</code></span></dt><dd><p>Name service switch configuration file.</p></dd><dt><span class="term">/tmp/.winbindd/pipe</span></dt><dd><p>The UNIX pipe over which clients communicate with
215 the <code class="literal">winbindd</code> program. For security reasons, the
216 winbind client will only attempt to connect to the winbindd daemon
217 if both the <code class="filename">/tmp/.winbindd</code> directory
218 and <code class="filename">/tmp/.winbindd/pipe</code> file are owned by
219 root. </p></dd><dt><span class="term">$LOCKDIR/winbindd_privileged/pipe</span></dt><dd><p>The UNIX pipe over which 'privileged' clients
220 communicate with the <code class="literal">winbindd</code> program. For security
221 reasons, access to some winbindd functions - like those needed by
222 the <code class="literal">ntlm_auth</code> utility - is restricted. By default,
223 only users in the 'root' group will get this access, however the administrator
224 may change the group permissions on $LOCKDIR/winbindd_privileged to allow
225 programs like 'squid' to use ntlm_auth.
226 Note that the winbind client will only attempt to connect to the winbindd daemon
227 if both the <code class="filename">$LOCKDIR/winbindd_privileged</code> directory
228 and <code class="filename">$LOCKDIR/winbindd_privileged/pipe</code> file are owned by
229 root. </p></dd><dt><span class="term">/lib/libnss_winbind.so.X</span></dt><dd><p>Implementation of name service switch library.
230 </p></dd><dt><span class="term">$LOCKDIR/winbindd_idmap.tdb</span></dt><dd><p>Storage for the Windows NT rid to UNIX user/group
231 id mapping. The lock directory is specified when Samba is initially
232 compiled using the <em class="parameter"><code>--with-lockdir</code></em> option.
233 This directory is by default <code class="filename">/usr/local/samba/var/locks
234 </code>. </p></dd><dt><span class="term">$LOCKDIR/winbindd_cache.tdb</span></dt><dd><p>Storage for cached user and group information.
235 </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2532961"></a><h2>VERSION</h2><p>This man page is correct for version 3 of
236 the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id2532971"></a><h2>SEE ALSO</h2><p><code class="filename">nsswitch.conf(5)</code>, <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a>, <a class="citerefentry" href="wbinfo.1.html"><span class="citerefentry"><span class="refentrytitle">wbinfo</span>(1)</span></a>, <a class="citerefentry" href="ntlm_auth.8.html"><span class="citerefentry"><span class="refentrytitle">ntlm_auth</span>(8)</span></a>, <a class="citerefentry" href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>, <a class="citerefentry" href="pam_winbind.8.html"><span class="citerefentry"><span class="refentrytitle">pam_winbind</span>(8)</span></a></p></div><div class="refsect1" lang="en"><a name="id2533027"></a><h2>AUTHOR</h2><p>The original Samba software and related utilities
237 were created by Andrew Tridgell. Samba is now developed
238 by the Samba Team as an Open Source project similar
239 to the way the Linux kernel is developed.</p><p><code class="literal">wbinfo</code> and <code class="literal">winbindd</code> were
240 written by Tim Potter.</p><p>The conversion to DocBook for Samba 2.2 was done
241 by Gerald Carter. The conversion to DocBook XML 4.2 for
242 Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.