release/src/router/samba3/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 .HP 9
  25 \fBwinbindd\fR [-F] [-S] [-i] [-Y] [-d <debug level>] [-s <smb config file>] [-n]
  26 .SH "DESCRIPTION"
  27 .PP
  28 This program is part of the
  29 \fBsamba\fR(7)
  30 suite.
  31 .PP
  32 \fBwinbindd\fR
  33 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
  34 \fBntlm_auth\fR
  35 and to Samba itself.
  36 .PP
  37 Even if winbind is not used for nsswitch, it still provides a service to
  38 \fBsmbd\fR,
  39 \fBntlm_auth\fR
  40 and the
  41 \fBpam_winbind.so\fR
  42 PAM module, by managing connections to domain controllers. In this configuraiton the
  43 idmap uid and
  44 idmap gid parameters are not required. (This is known as `netlogon proxy only mode'.)
  45 .PP
  46 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
  47 \fI/etc/nsswitch.conf\fR
  48 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.
  49 .PP
  50 The service provided by
  51 \fBwinbindd\fR
  52 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.
  53 .PP
  54 The
  55 \fIpam_winbind\fR
  56 module supports the
  57 \fIauth\fR,
  58 \fIaccount\fR
  59 and
  60 \fIpassword\fR
  61 module-types. It should be noted that the
  62 \fIaccount\fR
  63 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
  64 \fIlibnss_winbind\fR
  65 library has been correctly installed, or an alternate source of names configured, this should always succeed.
  66 .PP
  67 The following nsswitch databases are implemented by the winbindd service:
  68 .TP 3n
  69 hosts
  70 This feature is only available on IRIX. User information traditionally stored in the
  71 \fIhosts(5)\fR
  72 file and used by
  73 \fBgethostbyname(3)\fR
  74 functions. Names are resolved through the WINS server or by broadcast.
  75 .TP 3n
  76 passwd
  77 User information traditionally stored in the
  78 \fIpasswd(5)\fR
  79 file and used by
  80 \fBgetpwent(3)\fR
  81 functions.
  82 .TP 3n
  83 group
  84 Group information traditionally stored in the
  85 \fIgroup(5)\fR
  86 file and used by
  87 \fBgetgrent(3)\fR
  88 functions.
  89 .PP
  90 For example, the following simple configuration in the
  91 \fI/etc/nsswitch.conf\fR
  92 file can be used to initially resolve user and group information from
  93 \fI/etc/passwd \fR
  94 and
  95 \fI/etc/group\fR
  96 and then from the Windows NT server.
  97
  98 .sp
  99 .nf
 100
 101 passwd:         files winbind
 102 group:          files winbind
 103 ## only available on IRIX; Linux users should us libnss_wins.so
 104 hosts:          files dns winbind
 105 .fi
 106
 107 .PP
 108 The following simple configuration in the
 109 \fI/etc/nsswitch.conf\fR
 110 file can be used to initially resolve hostnames from
 111 \fI/etc/hosts\fR
 112 and then from the WINS server.
 113 .nf
 114
 115 hosts:          files wins
 116 .fi
 117 .SH "OPTIONS"
 118 .TP 3n
 119 -F
 120 If specified, this parameter causes the main
 121 \fBwinbindd\fR
 122 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
 123 \fBwinbindd\fR
 124 under process supervisors such as
 125 \fBsupervise\fR
 126 and
 127 \fBsvscan\fR
 128 from Daniel J. Bernstein's
 129 \fBdaemontools\fR
 130 package, or the AIX process monitor.
 131 .TP 3n
 132 -S
 133 If specified, this parameter causes
 134 \fBwinbindd\fR
 135 to log to standard output rather than a file.
 136 .TP 3n
 137 -V
 138 Prints the program version number.
 139 .TP 3n
 140 -s <configuration file>
 141 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
 142 \fIsmb.conf\fR
 143 for more information. The default configuration file name is determined at compile time.
 144 .TP 3n
 145 -d|--debuglevel=level
 146 \fIlevel\fR
 147 is an integer from 0 to 10. The default value if this parameter is not specified is zero.
 148 .sp
 149 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.
 150 .sp
 151 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.
 152 .sp
 153 Note that specifying this parameter here will override the
 154
 155 parameter in the
 156 \fIsmb.conf\fR
 157 file.
 158 .TP 3n
 159 -l|--logfile=logdirectory
 160 Base directory name for log/debug files. The extension
 161 \fB".progname"\fR
 162 will be appended (e.g. log.smbclient, log.smbd, etc...). The log file is never removed by the client.
 163 .TP 3n
 164 -h|--help
 165 Print a summary of command line options.
 166 .TP 3n
 167 -i
 168 Tells
 169 \fBwinbindd\fR
 170 to not become a daemon and detach from the current terminal. This option is used by developers when interactive debugging of
 171 \fBwinbindd\fR
 172 is required.
 173 \fBwinbindd\fR
 174 also logs to standard output, as if the
 175 \fB-S\fR
 176 parameter had been given.
 177 .TP 3n
 178 -n
 179 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.
 180 .TP 3n
 181 -Y
 182 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.
 183 .SH "NAME AND ID RESOLUTION"
 184 .PP
 185 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
 186 \fB winbindd\fR
 187 performs.
 188 .PP
 189 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.
 190 .PP
 191 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.
 192 .PP
 193 See the
 194
 195 parameter in
 196 \fIsmb.conf\fR
 197 for options for sharing this database, such as via LDAP.
 198 .SH "CONFIGURATION"
 199 .PP
 200 Configuration of the
 201 \fBwinbindd\fR
 202 daemon is done through configuration parameters in the
 203 \fBsmb.conf\fR(5)
 204 file. All parameters should be specified in the [global] section of smb.conf.
 205 .TP 3n
 206 &#8226;
 207
 208 winbind separator
 209 .TP 3n
 210 &#8226;
 211
 212 idmap uid
 213 .TP 3n
 214 &#8226;
 215
 216 idmap gid
 217 .TP 3n
 218 &#8226;
 219
 220 idmap backend
 221 .TP 3n
 222 &#8226;
 223
 224 winbind cache time
 225 .TP 3n
 226 &#8226;
 227
 228 winbind enum users
 229 .TP 3n
 230 &#8226;
 231
 232 winbind enum groups
 233 .TP 3n
 234 &#8226;
 235
 236 template homedir
 237 .TP 3n
 238 &#8226;
 239
 240 template shell
 241 .TP 3n
 242 &#8226;
 243
 244 winbind use default domain
 245 .SH "EXAMPLE SETUP"
 246 .PP
 247 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.
 248 .PP
 249 In
 250 \fI/etc/nsswitch.conf\fR
 251 put the following:
 252
 253 .sp
 254 .nf
 255
 256 passwd: files winbind
 257 group:  files winbind
 258 .fi
 259
 260 .PP
 261 In
 262 \fI/etc/pam.d/*\fR
 263 replace the
 264 \fI auth\fR
 265 lines with something like this:
 266
 267 .sp
 268 .nf
 269
 270 auth  required    /lib/security/pam_securetty.so
 271 auth  required    /lib/security/pam_nologin.so
 272 auth  sufficient  /lib/security/pam_winbind.so
 273 auth  required    /lib/security/pam_unix.so \
 274                   use_first_pass shadow nullok
 275 .fi
 276
 277 .sp
 278 .it 1 an-trap
 279 .nr an-no-space-flag 1
 280 .nr an-break-flag 1
 281 .br
 282 \fBNote\fR
 283 .PP
 284 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.
 285 .PP
 286 Note in particular the use of the
 287 \fIsufficient \fR
 288 keyword and the
 289 \fIuse_first_pass\fR
 290 keyword.
 291 .PP
 292 Now replace the account lines with this:
 293 .PP
 294 \fBaccount required /lib/security/pam_winbind.so \fR
 295 .PP
 296 The next step is to join the domain. To do that use the
 297 \fBnet\fR
 298 program like this:
 299 .PP
 300 \fBnet join -S PDC -U Administrator\fR
 301 .PP
 302 The username after the
 303 \fI-U\fR
 304 can be any Domain user that has administrator privileges on the machine. Substitute the name or IP of your PDC for "PDC".
 305 .PP
 306 Next copy
 307 \fIlibnss_winbind.so\fR
 308 to
 309 \fI/lib\fR
 310 and
 311 \fIpam_winbind.so \fR
 312 to
 313 \fI/lib/security\fR. A symbolic link needs to be made from
 314 \fI/lib/libnss_winbind.so\fR
 315 to
 316 \fI/lib/libnss_winbind.so.2\fR. If you are using an older version of glibc then the target of the link should be
 317 \fI/lib/libnss_winbind.so.1\fR.
 318 .PP
 319 Finally, setup a
 320 \fBsmb.conf\fR(5)
 321 containing directives like the following:
 322
 323 .sp
 324 .nf
 325
 326 [global]
 327         winbind separator = +
 328         winbind cache time = 10
 329         template shell = /bin/bash
 330         template homedir = /home/%D/%U
 331         idmap uid = 10000-20000
 332         idmap gid = 10000-20000
 333         workgroup = DOMAIN
 334         security = domain
 335         password server = *
 336 .fi
 337
 338 .PP
 339 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
 340 \fBgetent passwd\fR
 341 and
 342 \fBgetent group \fR
 343 to confirm the correct operation of winbindd.
 344 .SH "NOTES"
 345 .PP
 346 The following notes are useful when configuring and running
 347 \fBwinbindd\fR:
 348 .PP
 349 \fBnmbd\fR(8)
 350 must be running on the local machine for
 351 \fBwinbindd\fR
 352 to work.
 353 .PP
 354 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.
 355 .PP
 356 If more than one UNIX machine is running
 357 \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
 358
 359 is configured.
 360 .PP
 361 If the the Windows NT SID to UNIX user and group id mapping file is damaged or destroyed then the mappings will be lost.
 362 .SH "SIGNALS"
 363 .PP
 364 The following signals can be used to manipulate the
 365 \fBwinbindd\fR
 366 daemon.
 367 .TP 3n
 368 SIGHUP
 369 Reload the
 370 \fBsmb.conf\fR(5)
 371 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.
 372 .TP 3n
 373 SIGUSR2
 374 The SIGUSR2 signal will cause
 375 \fB winbindd\fR
 376 to write status information to the winbind log file.
 377 .sp
 378 Log files are stored in the filename specified by the log file parameter.
 379 .SH "FILES"
 380 .TP 3n
 381 \fI/etc/nsswitch.conf(5)\fR
 382 Name service switch configuration file.
 383 .TP 3n
 384 /tmp/.winbindd/pipe
 385 The UNIX pipe over which clients communicate with the
 386 \fBwinbindd\fR
 387 program. For security reasons, the winbind client will only attempt to connect to the winbindd daemon if both the
 388 \fI/tmp/.winbindd\fR
 389 directory and
 390 \fI/tmp/.winbindd/pipe\fR
 391 file are owned by root.
 392 .TP 3n
 393 $LOCKDIR/winbindd_privileged/pipe
 394 The UNIX pipe over which 'privileged' clients communicate with the
 395 \fBwinbindd\fR
 396 program. For security reasons, access to some winbindd functions - like those needed by the
 397 \fBntlm_auth\fR
 398 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
 399 \fI$LOCKDIR/winbindd_privileged\fR
 400 directory and
 401 \fI$LOCKDIR/winbindd_privileged/pipe\fR
 402 file are owned by root.
 403 .TP 3n
 404 /lib/libnss_winbind.so.X
 405 Implementation of name service switch library.
 406 .TP 3n
 407 $LOCKDIR/winbindd_idmap.tdb
 408 Storage for the Windows NT rid to UNIX user/group id mapping. The lock directory is specified when Samba is initially compiled using the
 409 \fI--with-lockdir\fR
 410 option. This directory is by default
 411 \fI/usr/local/samba/var/locks \fR.
 412 .TP 3n
 413 $LOCKDIR/winbindd_cache.tdb
 414 Storage for cached user and group information.
 415 .SH "VERSION"
 416 .PP
 417 This man page is correct for version 3.0 of the Samba suite.
 418 .SH "SEE ALSO"
 419 .PP
 420 \fInsswitch.conf(5)\fR,
 421 \fBsamba\fR(7),
 422 \fBwbinfo\fR(1),
 423 \fBntlm_auth\fR(8),
 424 \fBsmb.conf\fR(5),
 425 \fBpam_winbind\fR(8)
 426 .SH "AUTHOR"
 427 .PP
 428 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.
 429 .PP
 430 \fBwbinfo\fR
 431 and
 432 \fBwinbindd\fR
 433 were written by Tim Potter.
 434 .PP
 435 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.
 436