docs/manpages-3/winbindd.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="winbindd.8">
   4
   5 <refmeta>
   6         <refentrytitle>winbindd</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>winbindd</refname>
  13         <refpurpose>Name Service Switch daemon for resolving names
  14         from NT servers</refpurpose>
  15 </refnamediv>
  16
  17 <refsynopsisdiv>
  18         <cmdsynopsis>
  19                 <command>winbindd</command>
  20                 <arg choice="opt">-D</arg>
  21                 <arg choice="opt">-F</arg>
  22                 <arg choice="opt">-S</arg>
  23                 <arg choice="opt">-i</arg>
  24                 <arg choice="opt">-Y</arg>
  25                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  26                 <arg choice="opt">-s &lt;smb config file&gt;</arg>
  27                 <arg choice="opt">-n</arg>
  28         </cmdsynopsis>
  29 </refsynopsisdiv>
  30
  31 <refsect1>
  32         <title>DESCRIPTION</title>
  33
  34         <para>This program is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  35         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  36
  37         <para><command>winbindd</command> is a daemon that provides
  38         a number of services to the Name Service Switch capability found
  39         in most modern C libraries, to arbitrary applications via PAM
  40         and <command>ntlm_auth</command> and to Samba itself.</para>
  41
  42         <para>Even if winbind is not used for nsswitch, it still provides a
  43         service to <command>smbd</command>, <command>ntlm_auth</command>
  44         and the <command>pam_winbind.so</command> PAM module, by managing connections to
  45         domain controllers.  In this configuraiton the
  46         <smbconfoption name="idmap uid"/> and
  47         <smbconfoption name="idmap gid"/>
  48         parameters are not required. (This is known as `netlogon proxy only mode'.)</para>
  49
  50         <para> The Name Service Switch allows user
  51         and system information to be obtained from different databases
  52         services such as NIS or DNS.  The exact behaviour can be configured
  53         throught the <filename>/etc/nsswitch.conf</filename> file.
  54         Users and groups are allocated as they are resolved to a range
  55         of user and group ids specified by the administrator of the
  56         Samba system.</para>
  57
  58         <para>The service provided by <command>winbindd</command> is called `winbind' and
  59         can be used to resolve user and group information from a
  60         Windows NT server. The service can also provide authentication
  61         services via an associated PAM module. </para>
  62
  63         <para>
  64         The <filename>pam_winbind</filename> module supports the
  65         <parameter>auth</parameter>, <parameter>account</parameter>
  66         and <parameter>password</parameter>
  67         module-types.  It should be noted that the
  68         <parameter>account</parameter> module simply performs a getpwnam() to verify that
  69         the system can obtain a uid for the user, as the domain
  70         controller has already performed access control.  If the
  71         <filename>libnss_winbind</filename> library has been correctly
  72         installed, or an alternate source of names configured, this should always succeed.
  73         </para>
  74
  75         <para>The following nsswitch databases are implemented by
  76         the winbindd service: </para>
  77
  78         <variablelist>
  79                 <varlistentry>
  80                 <term>-D</term>
  81                 <listitem><para>If specified, this parameter causes
  82                 the server to operate as a daemon. That is, it detaches
  83                 itself and runs in the background on the appropriate port.
  84                 This switch is assumed if <command>winbindd</command> is
  85                 executed on the command line of a shell.
  86                 </para></listitem>
  87                 </varlistentry>
  88
  89                 <varlistentry>
  90                 <term>hosts</term>
  91                 <listitem><para>This feature is only available on IRIX.
  92                 User information traditionally stored in
  93                 the <filename>hosts(5)</filename> file and used by
  94                 <command>gethostbyname(3)</command> functions. Names are
  95                 resolved through the WINS server or by broadcast.
  96                 </para></listitem>
  97                 </varlistentry>
  98
  99                 <varlistentry>
 100                 <term>passwd</term>
 101                 <listitem><para>User information traditionally stored in
 102                 the <filename>passwd(5)</filename> file and used by
 103                 <command>getpwent(3)</command> functions. </para></listitem>
 104                 </varlistentry>
 105
 106                 <varlistentry>
 107                 <term>group</term>
 108                 <listitem><para>Group information traditionally stored in
 109                 the <filename>group(5)</filename> file and used by
 110                 <command>getgrent(3)</command> functions. </para></listitem>
 111                 </varlistentry>
 112         </variablelist>
 113
 114         <para>For example, the following simple configuration in the
 115         <filename>/etc/nsswitch.conf</filename> file can be used to initially
 116         resolve user and group information from <filename>/etc/passwd
 117         </filename> and <filename>/etc/group</filename> and then from the
 118         Windows NT server.
 119 <programlisting>
 120 passwd:         files winbind
 121 group:          files winbind
 122 ## only available on IRIX; Linux users should us libnss_wins.so
 123 hosts:          files dns winbind
 124 </programlisting></para>
 125
 126         <para>The following simple configuration in the
 127         <filename>/etc/nsswitch.conf</filename> file can be used to initially
 128         resolve hostnames from <filename>/etc/hosts</filename> and then from the
 129         WINS server.</para>
 130 <programlisting>
 131 hosts:          files wins
 132 </programlisting>
 133
 134 </refsect1>
 135
 136
 137 <refsect1>
 138         <title>OPTIONS</title>
 139
 140         <variablelist>
 141                 <varlistentry>
 142                 <term>-F</term>
 143                 <listitem><para>If specified, this parameter causes
 144                 the main <command>winbindd</command> process to not daemonize,
 145                 i.e. double-fork and disassociate with the terminal.
 146                 Child processes are still created as normal to service
 147                 each connection request, but the main process does not
 148                 exit. This operation mode is suitable for running
 149                 <command>winbindd</command> under process supervisors such
 150                 as <command>supervise</command> and <command>svscan</command>
 151                 from Daniel J. Bernstein's <command>daemontools</command>
 152                 package, or the AIX process monitor.
 153                 </para></listitem>
 154                 </varlistentry>
 155
 156                 <varlistentry>
 157                 <term>-S</term>
 158                 <listitem><para>If specified, this parameter causes
 159                 <command>winbindd</command> to log to standard output rather
 160                 than a file.</para></listitem>
 161                 </varlistentry>
 162
 163                 &stdarg.server.debug;
 164                 &popt.common.samba;
 165                 &stdarg.help;
 166
 167                 <varlistentry>
 168                 <term>-i</term>
 169                 <listitem><para>Tells <command>winbindd</command> to not
 170                 become a daemon and detach from the current terminal. This
 171                 option is used by developers when interactive debugging
 172                 of <command>winbindd</command> is required.
 173                 <command>winbindd</command> also logs to standard output,
 174                 as if the <command>-S</command> parameter had been given.
 175                 </para></listitem>
 176                 </varlistentry>
 177
 178                 <varlistentry>
 179                 <term>-n</term>
 180                 <listitem><para>Disable caching. This means winbindd will
 181                 always have to wait for a response from the domain controller
 182                 before it can respond to a client and this thus makes things
 183                 slower. The results will however be more accurate, since
 184                 results from the cache might not be up-to-date. This
 185                 might also temporarily hang winbindd if the DC doesn't respond.
 186                 </para></listitem>
 187                 </varlistentry>
 188
 189                 <varlistentry>
 190                 <term>-Y</term>
 191                 <listitem><para>Single daemon mode. This means winbindd will run
 192                 as a single process (the mode of operation in Samba 2.2).  Winbindd's
 193                 default behavior is to launch a child process that is responsible for
 194                 updating expired cache entries.
 195                 </para></listitem>
 196                 </varlistentry>
 197
 198         </variablelist>
 199 </refsect1>
 200
 201
 202 <refsect1>
 203         <title>NAME AND ID RESOLUTION</title>
 204
 205         <para>Users and groups on a Windows NT server are assigned
 206         a security id (SID) which is globally unique when the
 207         user or group is created.  To convert the Windows NT user or group
 208         into a unix user or group, a mapping between SIDs and unix user
 209         and group ids is required.  This is one of the jobs that <command>
 210         winbindd</command> performs. </para>
 211
 212         <para>As winbindd users and groups are resolved from a server, user
 213         and group ids are allocated from a specified range.  This
 214         is done on a first come, first served basis, although all existing
 215         users and groups will be mapped as soon as a client performs a user
 216         or group enumeration command.  The allocated unix ids are stored
 217         in a database and will be remembered. </para>
 218
 219         <para>WARNING: The SID to unix id database is the only location
 220         where the user and group mappings are stored by winbindd.  If this
 221         store is deleted or corrupted, there is no way for winbindd to
 222         determine which user and group ids correspond to Windows NT user
 223         and group rids. </para>
 224
 225         <para>See the <smbconfoption><name>idmap
 226         domains</name></smbconfoption> or the old <smbconfoption><name>idmap
 227         backend</name></smbconfoption> parameters in
 228         <filename>smb.conf</filename> for options for sharing this
 229         database, such as via LDAP.</para>
 230 </refsect1>
 231
 232
 233 <refsect1>
 234         <title>CONFIGURATION</title>
 235
 236         <para>Configuration of the <command>winbindd</command> daemon
 237         is done through configuration parameters in the <citerefentry>
 238         <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
 239         </citerefentry> file.  All parameters should be specified in the
 240         [global] section of smb.conf. </para>
 241
 242         <itemizedlist>
 243                 <listitem><para>
 244                 <smbconfoption name="winbind separator"/></para></listitem>
 245                 <listitem><para>
 246                 <smbconfoption name="idmap uid"/></para></listitem>
 247                 <listitem><para>
 248                 <smbconfoption name="idmap gid"/></para></listitem>
 249                 <listitem><para>
 250                 <smbconfoption name="idmap backend"/></para></listitem>
 251                 <listitem><para>
 252                 <smbconfoption name="winbind cache time"/></para></listitem>
 253                 <listitem><para>
 254                 <smbconfoption name="winbind enum users"/></para></listitem>
 255                 <listitem><para>
 256                 <smbconfoption name="winbind enum groups"/></para></listitem>
 257                 <listitem><para>
 258                 <smbconfoption name="template homedir"/></para></listitem>
 259                 <listitem><para>
 260                 <smbconfoption name="template shell"/></para></listitem>
 261                 <listitem><para>
 262                 <smbconfoption name="winbind use default domain"/></para></listitem>
 263                 <listitem><para>
 264                 <smbconfoption name="winbind: rpc only"/>
 265                 Setting this parameter forces winbindd to use RPC
 266                 instead of LDAP to retrieve information from Domain
 267                 Controllers.
 268                 </para></listitem>
 269         </itemizedlist>
 270 </refsect1>
 271
 272
 273 <refsect1>
 274         <title>EXAMPLE SETUP</title>
 275
 276         <para>
 277         To setup winbindd for user and group lookups plus
 278         authentication from a domain controller use something like the
 279         following setup. This was tested on an early Red Hat Linux box.
 280         </para>
 281
 282         <para>In <filename>/etc/nsswitch.conf</filename> put the
 283         following:
 284 <programlisting>
 285 passwd: files winbind
 286 group:  files winbind
 287 </programlisting>
 288         </para>
 289
 290         <para>In <filename>/etc/pam.d/*</filename> replace the <parameter>
 291         auth</parameter> lines with something like this:
 292 <programlisting>
 293 auth  required    /lib/security/pam_securetty.so
 294 auth  required    /lib/security/pam_nologin.so
 295 auth  sufficient  /lib/security/pam_winbind.so
 296 auth  required    /lib/security/pam_unix.so \
 297                   use_first_pass shadow nullok
 298 </programlisting>
 299         </para>
 300
 301         <note><para>
 302         The PAM module pam_unix has recently replaced the module pam_pwdb.
 303         Some Linux systems use the module pam_unix2 in place of pam_unix.
 304         </para></note>
 305
 306         <para>Note in particular the use of the <parameter>sufficient
 307         </parameter> keyword and the <parameter>use_first_pass</parameter> keyword. </para>
 308
 309         <para>Now replace the account lines with this: </para>
 310
 311         <para><command>account    required      /lib/security/pam_winbind.so
 312         </command></para>
 313
 314         <para>The next step is to join the domain. To do that use the
 315         <command>net</command> program like this:  </para>
 316
 317         <para><command>net join -S PDC -U Administrator</command></para>
 318
 319         <para>The username after the <parameter>-U</parameter> can be any
 320         Domain user that has administrator privileges on the machine.
 321         Substitute the name or IP of your PDC for "PDC".</para>
 322
 323         <para>Next copy <filename>libnss_winbind.so</filename> to
 324         <filename>/lib</filename> and <filename>pam_winbind.so
 325         </filename> to <filename>/lib/security</filename>.  A symbolic link needs to be
 326         made from <filename>/lib/libnss_winbind.so</filename> to
 327         <filename>/lib/libnss_winbind.so.2</filename>.  If you are using an
 328         older version of glibc then the target of the link should be
 329         <filename>/lib/libnss_winbind.so.1</filename>.</para>
 330
 331         <para>Finally, setup a <citerefentry><refentrytitle>smb.conf</refentrytitle>
 332         <manvolnum>5</manvolnum></citerefentry> containing directives like the
 333         following:
 334 <programlisting>
 335 [global]
 336         winbind separator = +
 337         winbind cache time = 10
 338         template shell = /bin/bash
 339         template homedir = /home/%D/%U
 340         idmap uid = 10000-20000
 341         idmap gid = 10000-20000
 342         workgroup = DOMAIN
 343         security = domain
 344         password server = *
 345 </programlisting></para>
 346
 347
 348         <para>Now start winbindd and you should find that your user and
 349         group database is expanded to include your NT users and groups,
 350         and that you can login to your unix box as a domain user, using
 351         the DOMAIN+user syntax for the username. You may wish to use the
 352         commands <command>getent passwd</command> and <command>getent group
 353         </command> to confirm the correct operation of winbindd.</para>
 354 </refsect1>
 355
 356
 357 <refsect1>
 358         <title>NOTES</title>
 359
 360         <para>The following notes are useful when configuring and
 361         running <command>winbindd</command>: </para>
 362
 363         <para><citerefentry><refentrytitle>nmbd</refentrytitle>
 364         <manvolnum>8</manvolnum></citerefentry> must be running on the local machine
 365         for <command>winbindd</command> to work. </para>
 366
 367         <para>PAM is really easy to misconfigure.  Make sure you know what
 368         you are doing when modifying PAM configuration files.  It is possible
 369         to set up PAM such that you can no longer log into your system. </para>
 370
 371         <para>If more than one UNIX machine is running <command>winbindd</command>,
 372         then in general the user and groups ids allocated by winbindd will not
 373         be the same.  The user and group ids will only be valid for the local
 374         machine, unless a shared <smbconfoption><name>idmap
 375         backend</name></smbconfoption> is configured.</para>
 376
 377         <para>If the the Windows NT SID to UNIX user and group id mapping
 378         file is damaged or destroyed then the mappings will be lost. </para>
 379 </refsect1>
 380
 381
 382 <refsect1>
 383         <title>SIGNALS</title>
 384
 385         <para>The following signals can be used to manipulate the
 386         <command>winbindd</command> daemon. </para>
 387
 388         <variablelist>
 389                 <varlistentry>
 390                 <term>SIGHUP</term>
 391                 <listitem><para>Reload the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 392                 <manvolnum>5</manvolnum></citerefentry> file and
 393                 apply any parameter changes to the running
 394                 version of winbindd.  This signal also clears any cached
 395                 user and group information.  The list of other domains trusted
 396                 by winbindd is also reloaded.  </para></listitem>
 397                 </varlistentry>
 398
 399                 <varlistentry>
 400                 <term>SIGUSR2</term>
 401                 <listitem><para>The SIGUSR2 signal will cause <command>
 402                 winbindd</command> to write status information to the winbind
 403                 log file.</para>
 404
 405                 <para>Log files are stored in the filename specified by the
 406                 log file parameter.</para></listitem>
 407                 </varlistentry>
 408         </variablelist>
 409 </refsect1>
 410
 411 <refsect1>
 412         <title>FILES</title>
 413
 414         <variablelist>
 415                 <varlistentry>
 416                 <term><filename>/etc/nsswitch.conf(5)</filename></term>
 417                 <listitem><para>Name service switch configuration file.</para>
 418                 </listitem>
 419                 </varlistentry>
 420
 421                 <varlistentry>
 422                 <term>/tmp/.winbindd/pipe</term>
 423                 <listitem><para>The UNIX pipe over which clients communicate with
 424                 the <command>winbindd</command> program.  For security reasons, the
 425                 winbind client will only attempt to connect to the winbindd daemon
 426                 if both the <filename>/tmp/.winbindd</filename> directory
 427                 and <filename>/tmp/.winbindd/pipe</filename> file are owned by
 428                 root. </para></listitem>
 429                 </varlistentry>
 430
 431                 <varlistentry>
 432                 <term>$LOCKDIR/winbindd_privileged/pipe</term>
 433                 <listitem><para>The UNIX pipe over which 'privileged' clients
 434                 communicate with the <command>winbindd</command> program.  For security
 435                 reasons, access to some winbindd functions - like those needed by
 436                 the <command>ntlm_auth</command> utility - is restricted.  By default,
 437                 only users in the 'root' group will get this access, however the administrator
 438                 may change the group permissions on $LOCKDIR/winbindd_privileged to allow
 439                 programs like 'squid' to use ntlm_auth.
 440                 Note that the winbind client will only attempt to connect to the winbindd daemon
 441                 if both the <filename>$LOCKDIR/winbindd_privileged</filename> directory
 442                 and <filename>$LOCKDIR/winbindd_privileged/pipe</filename> file are owned by
 443                 root. </para></listitem>
 444                 </varlistentry>
 445
 446                 <varlistentry>
 447                 <term>/lib/libnss_winbind.so.X</term>
 448                 <listitem><para>Implementation of name service switch library.
 449                 </para></listitem>
 450                 </varlistentry>
 451
 452                 <varlistentry>
 453                 <term>$LOCKDIR/winbindd_idmap.tdb</term>
 454                 <listitem><para>Storage for the Windows NT rid to UNIX user/group
 455                 id mapping.  The lock directory is specified when Samba is initially
 456                 compiled using the <parameter>--with-lockdir</parameter> option.
 457                 This directory is by default <filename>/usr/local/samba/var/locks
 458                 </filename>. </para></listitem>
 459                 </varlistentry>
 460
 461                 <varlistentry>
 462                 <term>$LOCKDIR/winbindd_cache.tdb</term>
 463                 <listitem><para>Storage for cached user and group information.
 464                 </para></listitem>
 465                 </varlistentry>
 466         </variablelist>
 467 </refsect1>
 468
 469
 470 <refsect1>
 471         <title>VERSION</title>
 472
 473         <para>This man page is correct for version 3.0 of
 474         the Samba suite.</para>
 475 </refsect1>
 476
 477 <refsect1>
 478         <title>SEE ALSO</title>
 479
 480         <para><filename>nsswitch.conf(5)</filename>, <citerefentry>
 481         <refentrytitle>samba</refentrytitle>
 482         <manvolnum>7</manvolnum></citerefentry>, <citerefentry>
 483         <refentrytitle>wbinfo</refentrytitle>
 484         <manvolnum>1</manvolnum></citerefentry>, <citerefentry>
 485         <refentrytitle>ntlm_auth</refentrytitle>
 486         <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 487         <refentrytitle>smb.conf</refentrytitle>
 488         <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 489         <refentrytitle>pam_winbind</refentrytitle>
 490         <manvolnum>8</manvolnum></citerefentry></para>
 491 </refsect1>
 492
 493 <refsect1>
 494         <title>AUTHOR</title>
 495
 496         <para>The original Samba software and related utilities
 497         were created by Andrew Tridgell. Samba is now developed
 498         by the Samba Team as an Open Source project similar
 499         to the way the Linux kernel is developed.</para>
 500
 501         <para><command>wbinfo</command> and <command>winbindd</command> were
 502         written by Tim Potter.</para>
 503
 504         <para>The conversion to DocBook for Samba 2.2 was done
 505         by Gerald Carter. The conversion to DocBook XML 4.2 for
 506         Samba 3.0 was done by Alexander Bokovoy.</para>
 507 </refsect1>
 508
 509 </refentry>