HTML version of yodl doc.
[kai/samba.git] / docs / htmldocs / winbindd.8.html
1
2
3
4
5
6 <html><head><title>winbindd (1)</title>
7
8 <link rev="made" href="mailto:samba-bugs@samba.org">
9 </head>
10 <body>
11
12 <hr>
13
14 <h1>winbindd (1)</h1>
15 <h2>Samba</h2>
16 <h2>8 May 2000</h2>
17
18
19     
20 <p><a name="NAME"></a>
21 <h2>NAME</h2>
22     winbindd - Name Service Switch daemon for resolving names from NT servers
23 <p><a name="SYNOPSIS"></a>
24 <h2>SYNOPSIS</h2>
25      
26 <p><strong>winbindd</strong> [<a href="winbindd.8.html#minusd">-d debuglevel</a>] [<a href="winbindd.8.html#minusi">-i</a>]
27 <p><a name="DESCRIPTION"></a>
28 <h2>DESCRIPTION</h2>
29     
30 <p>This program is part of the <strong>Samba</strong> suite version 3.0 and describes
31 functionality not yet implemented in the main version of Samba.
32 <p><strong>winbindd</strong> is a daemon that provides a service for the Name Service
33 Switch capability that is present in most modern C libraries.  The Name
34 Service Switch allows user and system information to be obtained from
35 different databases services such as NIS or DNS.  The exact behaviour can
36 be configured throught the <code>/etc/nsswitch.conf</code> file.  Users and groups
37 are allocated as they are resolved to a range of user and group ids
38 specified by the administrator of the Samba system.  
39 <p>The service provided by <strong>winbindd</strong> is called `winbind' and can be used to
40 resolve user and group information from a Windows NT server.  
41 <p>The following nsswitch databases are implemented by the <strong>winbindd</strong>
42 service:
43 <p><dl>
44 <p><p></p><dt><strong>passwd</strong><dd>
45 <p>User information traditionally stored in the <strong>passwd(5)</strong> file and used by
46 <strong>getpwent(3)</strong> functions.
47 <p><p></p><dt><strong>group</strong><dd>
48 <p>Group information traditionally stored in the <strong>group(5)</strong> file and used by
49 <strong>getgrent(3)</strong> functions.
50 <p></dl>
51 <p>For example, the following simple configuration in the
52 <code>/etc/nsswitch.conf</code> file can be used to initially resolve user and group
53 information from <code>/etc/passwd</code> and <code>/etc/group</code> and then from the
54 Windows NT server.
55 <p><code>passwd:         files winbind</code>
56 <p><code>group:          files winbind</code>
57 <p><a name="OPTIONS"></a>
58 <h2>OPTIONS</h2>
59     
60 <p>The following options are available to the <strong>winbindd</strong> daemon:
61 <p><dl>
62 <p><a name="minusd"></a>
63 <p></p><dt><strong><strong>-d debuglevel</strong></strong><dd>
64 Sets the debuglevel to an integer between 0 and 100. 0 is for no debugging
65 and 100 is for reams and reams. To submit a bug report to the Samba Team,
66 use debug level 100 (see <strong>BUGS.txt</strong>).  
67 <p><a name="minusi"></a>
68 <p></p><dt><strong><strong>-i</strong></strong><dd>
69 Tells winbindd to not become a daemon and detach from the current terminal.
70 This option is used by developers when interactive debugging of winbindd is
71 required.
72 <p></dl>
73 <p><a name="NAMEANDIDRESOLUTION"></a>
74 <h2>NAME AND ID RESOLUTION</h2>
75     
76 <p>Users and groups on a Windows NT server are assigned a relative id (rid)
77 which is unique for the domain when the user or group is created.  To
78 convert the Windows NT user or group into a unix user or group, a mapping
79 between rids and unix user and group ids is required.  This is one of the
80 jobs that <strong>winbindd</strong> performs.
81 <p>As <strong>winbindd</strong> users and groups are resolved from a server, user and group
82 ids are allocated from a specified range.  This is done on a first come,
83 first served basis, although all existing users and groups will be mapped
84 as soon as a client performs a user or group enumeration command.  The
85 allocated unix ids are stored in a database file under the Samba lock
86 directory and will be remembered.
87 <p>WARNING: The rid to unix id database is the only location where the user
88 and group mappings are stored by <strong>winbindd</strong>.  If this file is deleted or
89 corrupted, there is no way for <strong>winbindd</strong> to determine which user and
90 group ids correspond to Windows NT user and group rids.
91 <p><a name="CONFIGURATION"></a>
92 <h2>CONFIGURATION</h2>
93     
94 <p>Configuration of the <strong>winbindd</strong> daemon is done through configuration
95 parameters in the <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file.  All parameters
96 should be specified in the [global] section of
97 <a href="smb.conf.5.html"><strong>smb.conf</strong></a>.
98 <p><dl>
99 <p><p></p><dt><strong>winbind uid</strong><dd>
100 <p>The winbind uid parameter specifies the range of user ids that are
101 allocated by the <a href="winbindd.8.html"><strong>winbindd</strong></a> daemon.  This range of
102 ids should have no existing local or nis users within it as strange
103 conflicts can occur otherwise.
104 <p><strong>Default:</strong>
105 <code>     winbind uid = &lt;empty string&gt;</code>
106 <p><strong>Example:</strong>
107 <code>     winbind uid = 10000-20000</code>
108 <p><p></p><dt><strong>winbind gid</strong><dd>
109 <p>The winbind gid parameter specifies the range of group ids that are
110 allocated by the <a href="winbindd.8.html"><strong>winbindd</strong></a> daemon.  This range of
111 group ids should have no existing local or nis groups within it as strange
112 conflicts can occur otherwise.
113 <p><strong>Default:</strong>
114 <code>     winbind gid = &lt;empty string&gt;</code>
115 <p><strong>Example:</strong>
116 <code>     winbind gid = 10000-20000</code>
117 <p><p></p><dt><strong>winbind cache time</strong><dd>
118 <p>This parameter specifies the number of seconds the
119 <a href="winbindd.8.html"><strong>winbindd</strong></a> daemon will cache user and group
120 information before querying a Windows NT server again.
121 <p><strong>Default:</strong>
122 <code>     winbind cache type = 15</code>
123 <p><p></p><dt><strong>template homedir</strong><dd>
124 <p>When filling out the user information for a Windows NT user, the
125 <a href="winbindd.8.html"><strong>winbindd</strong></a> daemon uses this parameter to fill in
126 the home directory for that user.  If the string <code>%D</code> is present it is
127 substituted with the user's Windows NT domain name.  If the string <code>%U</code>
128 is present it is substituted with the user's Windows NT user name.
129 <p><strong>Default:</strong>
130 <code>     template homedir = /home/%D/%U</code>
131 <p><p></p><dt><strong>template shell</strong><dd>
132 <p>When filling out the user information for a Windows NT user, the
133 <a href="winbindd.8.html"><strong>winbindd</strong></a> daemon uses this parameter to fill in
134 the home directory for that user.  If the string <code>%D</code> is present it is
135 substituted with the user's Windows NT domain name.  If the string <code>%U</code>
136 is present it is substituted with the user's Windows NT user name.
137 <p><strong>Default:</strong>
138 <code>     template homedir = /home/%D/%U</code>
139 <p></dl>
140 <p><a name="FILES"></a>
141 <h2>FILES</h2>
142     
143 <p>The following files are relevant to the operation of the <strong>winbindd</strong>
144 daemon.
145 <p><dl>
146 <p><p></p><dt><strong>/etc/nsswitch.conf(5)</strong><dd>
147 <p>Name service switch configuration file.
148 <p><p></p><dt><strong>/tmp/.winbindd/pipe</strong><dd>
149 <p>The UNIX pipe over which clients communicate with the <strong>winbindd</strong> program.
150 For security reasons, the winbind client will only attempt to connect to the
151 <strong>winbindd</strong> daemon if both the <code>/tmp/.winbindd</code> directory and
152 <code>/tmp/.winbindd/pipe</code> file are owned by root.
153 <p><p></p><dt><strong>/lib/libnss_winbind.so.X</strong><dd>
154 <p>Implementation of name service switch library. 
155 <p><p></p><dt><strong>$LOCKDIR/winbindd_idmap.tdb</strong><dd>
156 <p>Storage for the Windows NT rid to UNIX user/group id mapping.  If this file
157 is damaged or destroyed then the mappings will be lost.
158 <p>The lock directory is specified when Samba is initially compiled using the
159 <code>--with-lockdir</code> option.  This directory is by default
160 <code>/usr/local/samba/var/locks</code>.
161 <p><p></p><dt><strong>$LOCKDIR/winbindd_cache.tdb</strong><dd>
162 <p>Storage for cached user and group information.
163 <p></dl>
164 <p><a name="SEEALSO"></a>
165 <h2>SEE ALSO</h2>
166     
167 <p><a href="samba.7.html"><strong>samba(7)</strong></a>, <a href="smb.conf.5.html"><strong>smb.conf(5)</strong></a>, 
168 <strong>nsswitch.conf(5)</strong>
169 <p><a name="AUTHOR"></a>
170 <h2>AUTHOR</h2>
171     
172 <p>The original Samba software and related utilities were created by
173 Andrew Tridgell <a href="mailto:samba-bugs@samba.org"><em>samba-bugs@samba.org</em></a>. Samba is now developed
174 by the Samba Team as an Open Source project similar to the way the
175 Linux kernel is developed.
176 <p>Winbindd was written by Tim Potter.
177 </body>
178 </html>