docs/Samba3-HOWTO/TOSHARG-Passdb.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE chapter PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <chapter id="passdb">
   4 <chapterinfo>
   5         &author.jelmer;
   6         &author.jht;
   7         &author.jerry;
   8         &author.jeremy;
   9         <author>&person.gd;<contrib>LDAP updates</contrib></author>
  10         <author>
  11                 <firstname>Olivier (lem)</firstname><surname>Lemaire</surname>
  12                 <affiliation>
  13                         <orgname>IDEALX</orgname>
  14                         <address><email>olem@IDEALX.org</email></address>
  15                 </affiliation>
  16         </author>
  17
  18         <pubdate>May 24, 2003</pubdate>
  19 </chapterinfo>
  20 <title>Account Information Databases</title>
  21
  22 <para>
  23 <indexterm><primary>account backends</primary></indexterm>
  24 <indexterm><primary>password backends</primary></indexterm>
  25 <indexterm><primary>scalability</primary></indexterm>
  26 <indexterm><primary>ADS</primary></indexterm>
  27 Samba-3 implements a new capability to work concurrently with multiple account backends.
  28 The possible new combinations of password backends allows Samba-3 a degree of flexibility
  29 and scalability that previously could be achieved only with MS Windows Active Directory (ADS).
  30 This chapter describes the new functionality and how to get the most out of it.
  31 </para>
  32
  33 <para>
  34 <indexterm><primary>passdb backend</primary></indexterm>
  35 <indexterm><primary>smbpasswd</primary></indexterm>
  36 <indexterm><primary>tdbsam</primary></indexterm>
  37 <indexterm><primary>ldapsam</primary></indexterm>
  38 <indexterm><primary>LDAP</primary></indexterm>
  39 <indexterm><primary>single repository</primary></indexterm>
  40 The three passdb backends that are fully maintained (actively supported) by the Samba Team are:
  41 <literal>smbpasswd</literal> (being obsoleted), <literal>tdbsam</literal> (a tdb based binary file format),
  42 and <literal>ldapsam</literal> (LDAP directory).  Of these, only the <literal>ldapsam</literal> backend
  43 stores both POSIX (UNIX) and Samba user and group account information in a single repository. The
  44 <literal>smbpasswd</literal> and <literal>tdbsam</literal> backends store only Samba user accounts.
  45 </para>
  46
  47 <para>
  48 In a strict sense, there are three supported account storage and access systems. One of these is considered
  49 obsolete (smbpasswd). It is recommended to use <literal>tdbsam</literal> method for all simple systems. Use
  50 the <literal>ldapsam</literal> for larger and more complex networks.
  51 </para>
  52
  53 <para>
  54 <indexterm><primary>passdb backend</primary></indexterm>
  55 <indexterm><primary>account storage mechanisms</primary></indexterm>
  56 <indexterm><primary>account storage system</primary></indexterm>
  57 <indexterm><primary>user and trust accounts</primary></indexterm>
  58 <indexterm><primary>machine trust accounts</primary></indexterm>
  59 <indexterm><primary>computer accounts</primary></indexterm>
  60 <indexterm><primary>interdomain trust accounts</primary></indexterm>
  61 In a strict and literal sense, the passdb backends are account storage mechanisms (or methods) alone. The choice
  62 of terminology can be misleading, however we are stuck with this choice of wording. This chapter documents the
  63 nature of the account storage system with a focus on user and trust accounts. Trust accounts have two forms,
  64 machine trust accounts (computer accounts) and interdomain trust accounts. These are all treated as user-like
  65 entities.
  66 </para>
  67
  68 <sect1>
  69 <title>Features and Benefits</title>
  70
  71 <para>
  72 Samba-3 provides for complete backward compatibility with Samba-2.2.x functionality
  73 as follows:
  74 <indexterm><primary>SAM backend</primary><secondary>smbpasswd</secondary></indexterm>
  75 <indexterm><primary>SAM backend</primary><secondary>ldapsam_compat</secondary></indexterm>
  76 <indexterm><primary>encrypted passwords</primary></indexterm>
  77 </para>
  78
  79 <sect2>
  80         <title>Backward Compatibility Account Storage Systems</title>
  81
  82 <variablelist>
  83         <varlistentry><term>Plaintext</term>
  84                 <listitem>
  85                         <para>
  86 <indexterm><primary>plaintext</primary></indexterm>
  87 <indexterm><primary>plaintext authentication</primary></indexterm>
  88 <indexterm><primary>/etc/passwd</primary></indexterm>
  89 <indexterm><primary>/etc/shadow</primary></indexterm>
  90 <indexterm><primary>PAM</primary></indexterm>
  91                         This isn't really a backend at all, but is listed here for simplicity.  Samba can be configured to pass
  92                         plaintext authentication requests to the traditional UNIX/Linux <filename>/etc/passwd</filename> and
  93                         <filename>/etc/shadow</filename>-style subsystems.  On systems that have Pluggable Authentication Modules
  94                         (PAM) support, all PAM modules are supported. The behavior is just as it was with Samba-2.2.x, and the
  95                         protocol limitations imposed by MS Windows clients apply likewise. Please refer to <link
  96                         linkend="passdbtech">Technical Information</link>, for more information regarding the limitations of plaintext
  97                         password usage.
  98                         </para>
  99                 </listitem>
 100         </varlistentry>
 101
 102         <varlistentry><term>smbpasswd</term>
 103                 <listitem>
 104                         <para>
 105 <indexterm><primary>smbpasswd</primary></indexterm>
 106 <indexterm><primary>LanMan passwords</primary></indexterm>
 107 <indexterm><primary>NT-encrypted passwords</primary></indexterm>
 108 <indexterm><primary>SAM</primary></indexterm>
 109                         This option allows continued use of the <filename>smbpasswd</filename>
 110                         file that maintains a plain ASCII (text) layout that includes the MS Windows
 111                         LanMan and NT-encrypted passwords as well as a field that stores some
 112                         account information. This form of password backend does not store any of
 113                         the MS Windows NT/200x SAM (Security Account Manager) information required to
 114                         provide the extended controls that are needed for more comprehensive
 115                         interoperation with MS Windows NT4/200x servers.
 116                         </para>
 117
 118                         <para>
 119                         This backend should be used only for backward compatibility with older
 120                         versions of Samba. It may be deprecated in future releases.
 121                         </para>
 122                 </listitem>
 123         </varlistentry>
 124
 125         <varlistentry><term>ldapsam_compat (Samba-2.2 LDAP Compatibility)</term>
 126                 <listitem>
 127                         <para>
 128 <indexterm><primary>ldapsam_compat</primary></indexterm>
 129 <indexterm><primary>Samba-2.2.x LDAP schema</primary></indexterm>
 130 <indexterm><primary>OpenLDAP backend</primary></indexterm>
 131                         There is a password backend option that allows continued operation with
 132                         an existing OpenLDAP backend that uses the Samba-2.2.x LDAP schema extension.
 133                         This option is provided primarily as a migration tool, although there is
 134                         no reason to force migration at this time. This tool will eventually
 135                         be deprecated.
 136                         </para>
 137                 </listitem>
 138         </varlistentry>
 139 </variablelist>
 140
 141 </sect2>
 142
 143 <sect2>
 144 <title>New Account Storage Systems</title>
 145
 146 <para>
 147 Samba-3 introduces a number of new password backend capabilities.
 148 <indexterm><primary>SAM backend</primary><secondary>tdbsam</secondary></indexterm>
 149 <indexterm><primary>SAM backend</primary><secondary>ldapsam</secondary></indexterm>
 150 <indexterm><primary>SAM backend</primary><secondary>mysqlsam</secondary></indexterm>
 151 <indexterm><primary>SAM backend</primary><secondary>xmlsam</secondary></indexterm>
 152 </para>
 153
 154 <variablelist>
 155         <varlistentry><term>tdbsam</term>
 156                 <listitem>
 157                         <para>
 158 <indexterm><primary>rich database backend</primary></indexterm>
 159 <indexterm><primary>PDC</primary></indexterm>
 160 <indexterm><primary>BDC</primary></indexterm>
 161                         This backend provides a rich database backend for local servers. This
 162                         backend is not suitable for multiple domain controllers (i.e., PDC + one
 163                         or more BDC) installations.
 164                         </para>
 165
 166                         <para>
 167 <indexterm><primary>extended SAM</primary></indexterm>
 168 <indexterm><primary>TDB</primary></indexterm>
 169 <indexterm><primary>binary format TDB</primary></indexterm>
 170 <indexterm><primary>trivial database</primary></indexterm>
 171 <indexterm><primary>system access controls</primary></indexterm>
 172 <indexterm><primary>MS Windows NT4/200x</primary></indexterm>
 173                         The <emphasis>tdbsam</emphasis> password backend stores the old <emphasis>
 174                         smbpasswd</emphasis> information plus the extended MS Windows NT/200x
 175                         SAM information into a binary format TDB (trivial database) file.
 176                         The inclusion of the extended information makes it possible for Samba-3
 177                         to implement the same account and system access controls that are possible
 178                         with MS Windows NT4/200x-based systems.
 179                         </para>
 180
 181                         <para>
 182 <indexterm><primary>simple operation</primary></indexterm>
 183 <indexterm><primary>OpenLDAP</primary></indexterm>
 184 <indexterm><primary>ADS</primary></indexterm>
 185                         The inclusion of the <emphasis>tdbsam</emphasis> capability is a direct
 186                         response to user requests to allow simple site operation without the overhead
 187                         of the complexities of running OpenLDAP. It is recommended to use this only
 188                         for sites that have fewer than 250 users. For larger sites or implementations,
 189                         the use of OpenLDAP or of Active Directory integration is strongly recommended.
 190                         </para>
 191                 </listitem>
 192         </varlistentry>
 193
 194         <varlistentry><term>ldapsam</term>
 195                 <listitem>
 196                         <para>
 197 <indexterm><primary>rich directory backend</primary></indexterm>
 198 <indexterm><primary>distributed account</primary></indexterm>
 199                         This provides a rich directory backend for distributed account installation.
 200                         </para>
 201
 202                         <para>
 203 <indexterm><primary>LDAP</primary></indexterm>
 204 <indexterm><primary>OpenLDAP</primary></indexterm>
 205 <indexterm><primary>Samba schema</primary></indexterm>
 206 <indexterm><primary>schema file</primary></indexterm>
 207 <indexterm><primary>examples/LDAP</primary></indexterm>
 208                         Samba-3 has a new and extended LDAP implementation that requires configuration
 209                         of OpenLDAP with a new format Samba schema. The new format schema file is
 210                         included in the <filename class="directory">examples/LDAP</filename> directory of the Samba distribution.
 211                         </para>
 212
 213                         <para>
 214 <indexterm><primary>expands control abilities</primary></indexterm>
 215 <indexterm><primary>profile</primary></indexterm>
 216 <indexterm><primary>home directories</primary></indexterm>
 217 <indexterm><primary>account access controls</primary></indexterm>
 218 <indexterm><primary>greater scalability</primary></indexterm>
 219                         The new LDAP implementation significantly expands the control abilities that
 220                         were possible with prior versions of Samba. It is now possible to specify
 221                         <quote>per-user</quote> profile settings, home directories, account access controls, and
 222                         much more. Corporate sites will see that the Samba Team has listened to their
 223                         requests both for capability and greater scalability.
 224                         </para>
 225                 </listitem>
 226         </varlistentry>
 227
 228         <varlistentry><term>mysqlsam (MySQL-based backend)</term>
 229                 <listitem>
 230                         <para>
 231 <indexterm><primary>MySQL-based SAM</primary></indexterm>
 232 <indexterm><primary>database backend</primary></indexterm>
 233                         It is expected that the MySQL-based SAM will be very popular in some corners.
 234                         This database backend will be of considerable interest to sites that want to
 235                         leverage existing MySQL technology.
 236                         </para>
 237                 </listitem>
 238         </varlistentry>
 239
 240         <varlistentry><term>pgsqlsam (PostGreSQL-based backend)</term>
 241                 <listitem>
 242                         <para>
 243 <indexterm><primary>PostgreSQL database</primary></indexterm>
 244 <indexterm><primary>mysqlsam</primary></indexterm>
 245                                 Stores user information in a PostgreSQL database.  This backend is largely undocumented at
 246                                 the moment, though its configuration is very similar to that of the mysqlsam backend.
 247                         </para>
 248                 </listitem>
 249         </varlistentry>
 250
 251         <varlistentry><term>xmlsam (XML-based datafile)</term>
 252                 <listitem>
 253                         <para>
 254 <indexterm><primary>pdbedit</primary></indexterm>
 255 <indexterm><primary>XML format</primary></indexterm>
 256 <indexterm><primary>pdb2pdb</primary></indexterm>
 257                         Allows the account and password data to be stored in an XML format
 258                         data file. This backend cannot be used for normal operation, it can only
 259                         be used in conjunction with <command>pdbedit</command>'s pdb2pdb
 260                         functionality. The Document Type Definition (DTD) file that is used
 261                         might be subject to changes in the future. (See the XML <ulink
 262                         url="http://www.brics.dk/~amoeller/XML/schemas/">reference</ulink> for a definition
 263                         of XML terms.)
 264                         </para>
 265
 266                         <para>
 267 <indexterm><primary>account migration</primary></indexterm>
 268 <indexterm><primary>database backends</primary></indexterm>
 269 <indexterm><primary>backend format</primary></indexterm>
 270                         The <parameter>xmlsam</parameter> option can be useful for account migration between database
 271                         backends or backups. Use of this tool allows the data to be edited before migration
 272                         into another backend format.
 273                         </para>
 274                 </listitem>
 275         </varlistentry>
 276
 277 </variablelist>
 278
 279 </sect2>
 280
 281 </sect1>
 282
 283 <sect1 id="passdbtech">
 284         <title>Technical Information</title>
 285
 286         <para>
 287 <indexterm><primary>plaintext passwords</primary></indexterm>
 288 <indexterm><primary>encrypted passwords</primary></indexterm>
 289         Old Windows clients send plaintext passwords over the wire. Samba can check these
 290         passwords by encrypting them and comparing them to the hash stored in the UNIX user database.
 291         </para>
 292
 293         <para>
 294 <indexterm><primary>encrypted passwords</primary></indexterm>
 295 <indexterm><primary>LanMan</primary></indexterm>
 296 <indexterm><primary>plaintext passwords</primary></indexterm>
 297 <indexterm><primary>registry</primary></indexterm>
 298         Newer Windows clients send encrypted passwords (LanMan and NT hashes) instead of plaintext passwords over
 299         the wire. The newest clients will send only encrypted passwords and refuse to send plaintext passwords unless
 300         their registry is tweaked.
 301         </para>
 302
 303         <para>
 304 <indexterm><primary>UNIX-style encrypted passwords</primary></indexterm>
 305 <indexterm><primary>converted</primary></indexterm>
 306         Many people ask why Samba can not simply use the UNIX password database. Windows requires
 307         passwords that are encrypted in its own format.  The UNIX passwords can't be converted to
 308         UNIX-style encrypted passwords. Because of that, you can't use the standard UNIX user
 309         database, and you have to store the LanMan and NT hashes somewhere else.
 310         </para>
 311
 312         <para>
 313 <indexterm><primary>differently encrypted passwords</primary></indexterm>
 314 <indexterm><primary>profile</primary></indexterm>
 315 <indexterm><primary>workstations</primary></indexterm>
 316 <indexterm><primary>tdbsam</primary></indexterm>
 317         In addition to differently encrypted passwords, Windows also stores certain data for each
 318         user that is not stored in a UNIX user database: for example, workstations the user may logon from,
 319         the location where the user's profile is stored, and so on. Samba retrieves and stores this
 320         information using a <smbconfoption name="passdb backend"/>. Commonly available backends are LDAP,
 321         tdbsam, plain text file, and MySQL. For more information, see the man page for &smb.conf; regarding the
 322         <smbconfoption name="passdb backend"/> parameter.
 323         </para>
 324
 325
 326         <figure id="idmap-sid2uid">
 327                 <title>IDMAP: Resolution of SIDs to UIDs.</title>
 328                 <imagefile scale="40">idmap-sid2uid</imagefile>
 329         </figure>
 330
 331         <para>
 332         <indexterm><primary>SID</primary></indexterm>
 333 <indexterm><primary>UID</primary></indexterm>
 334 <indexterm><primary>SID</primary></indexterm>
 335         The resolution of SIDs to UIDs is fundamental to correct operation of Samba. In both cases shown, if winbindd
 336         is not running or cannot be contacted, then only local SID/UID resolution is possible. See <link
 337         linkend="idmap-sid2uid">resolution of SIDs to UIDs</link> and <link linkend="idmap-uid2sid">resolution of UIDs
 338         to SIDs</link> diagrams.
 339         </para>
 340
 341         <figure id="idmap-uid2sid">
 342                 <title>IDMAP: Resolution of UIDs to SIDs.</title>
 343                 <imagefile scale="50">idmap-uid2sid</imagefile>
 344         </figure>
 345
 346         <sect2>
 347         <title>Important Notes About Security</title>
 348
 349                 <para>
 350 <indexterm><primary>SMB password encryption</primary></indexterm>
 351 <indexterm><primary>clear-text passwords</primary></indexterm>
 352 <indexterm><primary>hashed password equivalent</primary></indexterm>
 353 <indexterm><primary>LDAP</primary></indexterm>
 354 <indexterm><primary>MYSQL</primary></indexterm>
 355 <indexterm><primary>secret</primary></indexterm>
 356                 The UNIX and SMB password encryption techniques seem similar on the surface. This
 357                 similarity is, however, only skin deep. The UNIX scheme typically sends clear-text
 358                 passwords over the network when logging in. This is bad. The SMB encryption scheme
 359                 never sends the clear-text password over the network, but it does store the 16-byte
 360                 hashed values on disk. This is also bad. Why? Because the 16 byte hashed values
 361                 are a <quote>password equivalent.</quote> You cannot derive the user's password from them, but
 362                 they could potentially be used in a modified client to gain access to a server.
 363                 This would require considerable technical knowledge on behalf of the attacker but
 364                 is perfectly possible. You should therefore treat the data stored in whatever passdb
 365                 backend you use (smbpasswd file, LDAP, MYSQL) as though it contained the clear-text
 366                 passwords of all your users. Its contents must be kept secret, and the file should
 367                 be protected accordingly.
 368                 </para>
 369
 370                 <para>
 371 <indexterm><primary>password scheme</primary></indexterm>
 372 <indexterm><primary>plaintext passwords</primary></indexterm>
 373 <indexterm><primary>compatible</primary></indexterm>
 374                 Ideally, we would like a password scheme that involves neither plaintext passwords
 375                 on the network nor plaintext passwords on disk. Unfortunately, this is not available because Samba is stuck with
 376                 having to be compatible with other SMB systems (Windows NT, Windows for Workgroups, Windows 9x/Me).
 377                 </para>
 378
 379                 <para>
 380 <indexterm><primary>encrypted passwords</primary></indexterm>
 381 <indexterm><primary>plaintext passwords</primary></indexterm>
 382                 Windows NT 4.0 Service Pack 3 changed the default setting so plaintext passwords
 383                 are disabled from being sent over the wire. This mandates either the use of encrypted
 384                 password support or editing the Windows NT registry to re-enable plaintext passwords.
 385                 </para>
 386
 387                 <para>
 388 <indexterm><primary>domain security</primary></indexterm>
 389 <indexterm><primary>domain environment</primary></indexterm>
 390                 The following versions of Microsoft Windows do not support full domain security protocols,
 391                 although they may log onto a domain environment:
 392                 </para>
 393
 394                 <itemizedlist>
 395                         <listitem><para>MS DOS Network client 3.0 with the basic network redirector installed.</para></listitem>
 396                         <listitem><para>Windows 95 with the network redirector update installed.</para></listitem>
 397                         <listitem><para>Windows 98 [Second Edition].</para></listitem>
 398                         <listitem><para>Windows Me.</para></listitem>
 399                 </itemizedlist>
 400
 401                 <note>
 402                 <para>
 403 <indexterm><primary>Windows XP Home</primary></indexterm>
 404 <indexterm><primary>domain member</primary></indexterm>
 405 <indexterm><primary>domain logons</primary></indexterm>
 406                 MS Windows XP Home does not have facilities to become a domain member, and it cannot participate in domain logons.
 407                 </para>
 408                 </note>
 409
 410                 <para>
 411                 The following versions of MS Windows fully support domain security protocols.
 412                 </para>
 413
 414                 <itemizedlist>
 415                         <listitem><para>Windows NT 3.5x.</para></listitem>
 416                         <listitem><para>Windows NT 4.0.</para></listitem>
 417                         <listitem><para>Windows 2000 Professional.</para></listitem>
 418                         <listitem><para>Windows 200x Server/Advanced Server.</para></listitem>
 419                         <listitem><para>Windows XP Professional.</para></listitem>
 420                 </itemizedlist>
 421
 422                 <para>
 423 <indexterm><primary>SMB/CIFS</primary></indexterm>
 424 <indexterm><primary>authentication</primary></indexterm>
 425 <indexterm><primary>challenge/response mechanis</primary></indexterm>
 426 <indexterm><primary>clear-text</primary></indexterm>
 427 <indexterm><primary>encrypted</primary></indexterm>
 428 <indexterm><primary>negotiate</primary></indexterm>
 429                 All current releases of Microsoft SMB/CIFS clients support authentication via the
 430                 SMB challenge/response mechanism described here. Enabling clear-text authentication
 431                 does not disable the ability of the client to participate in encrypted authentication.
 432                 Instead, it allows the client to negotiate either plaintext or encrypted password
 433                 handling.
 434                 </para>
 435
 436                 <para>
 437 <indexterm><primary>cached encrypted password</primary></indexterm>
 438 <indexterm><primary>plaintext passwords</primary></indexterm>
 439 <indexterm><primary>registry change</primary></indexterm>
 440 <indexterm><primary>auto-reconnect</primary></indexterm>
 441 <indexterm><primary>encrypted passwords</primary></indexterm>
 442                 MS Windows clients will cache the encrypted password alone. Where plaintext passwords
 443                 are re-enabled through the appropriate registry change, the plaintext password is never
 444                 cached. This means that in the event that a network connections should become disconnected
 445                 (broken), only the cached (encrypted) password will be sent to the resource server to
 446                 effect an auto-reconnect. If the resource server does not support encrypted passwords, the
 447                 auto-reconnect will fail. Use of encrypted passwords is strongly advised.
 448                 </para>
 449
 450                 <sect3>
 451                 <title>Advantages of Encrypted Passwords</title>
 452
 453                         <itemizedlist>
 454                                 <listitem><para>
 455 <indexterm><primary>passed across the network</primary></indexterm>
 456 <indexterm><primary>network sniffer</primary></indexterm>
 457 <indexterm><primary>SMB server</primary></indexterm>
 458                                 Plaintext passwords are not passed across the network. Someone using a network sniffer
 459                                 cannot just record passwords going to the SMB server.
 460                                 </para></listitem>
 461
 462                                 <listitem><para>
 463 <indexterm><primary>not stored anywhere</primary></indexterm>
 464 <indexterm><primary>memory</primary></indexterm>
 465 <indexterm><primary>disk</primary></indexterm>
 466                                 Plaintext passwords are not stored anywhere in memory or on disk.
 467                                 </para></listitem>
 468
 469                                 <listitem><para>
 470 <indexterm><primary>encrypted passwords</primary></indexterm>
 471 <indexterm><primary>user-level security</primary></indexterm>
 472 <indexterm><primary>password prompt</primary></indexterm>
 473 <indexterm><primary>SMB encryption</primary></indexterm>
 474                                 Windows NT does not like talking to a server that does not support encrypted passwords. It will refuse to
 475                                 browse the server if the server is also in user-level security mode. It will insist on prompting the user for
 476                                 the password on each connection, which is very annoying. The only thing you can do to stop this is to use SMB
 477                                 encryption.
 478                                 </para></listitem>
 479
 480                                 <listitem><para>
 481 <indexterm><primary>encrypted password</primary></indexterm>
 482 <indexterm><primary>automatic reconnects</primary></indexterm>
 483                                 Encrypted password support allows automatic share (resource) reconnects.
 484                                 </para></listitem>
 485
 486                                 <listitem><para>
 487 <indexterm><primary>PDC</primary></indexterm>
 488 <indexterm><primary>BDC</primary></indexterm>
 489                                 Encrypted passwords are essential for PDC/BDC operation.
 490                                 </para></listitem>
 491                         </itemizedlist>
 492                 </sect3>
 493
 494
 495                 <sect3>
 496                 <title>Advantages of Non-Encrypted Passwords</title>
 497
 498                         <itemizedlist>
 499                                 <listitem><para>
 500 <indexterm><primary>cached in memory</primary></indexterm>
 501                                 Plaintext passwords are not kept on disk and are not cached in memory.
 502                                 </para></listitem>
 503
 504                                 <listitem><para>
 505 <indexterm><primary>Login</primary></indexterm>
 506 <indexterm><primary>FTP</primary></indexterm>
 507                                 Plaintext passwords use the same password file as other UNIX services, such as Login and FTP.
 508                                 </para></listitem>
 509
 510                                 <listitem><para>
 511 <indexterm><primary>Telnet</primary></indexterm>
 512 <indexterm><primary>FTP</primary></indexterm>
 513                                 Use of other services (such as Telnet and FTP) that send plaintext passwords over
 514                                 the network makes sending them for SMB is not such a big deal.
 515                                 </para></listitem>
 516                         </itemizedlist>
 517                 </sect3>
 518         </sect2>
 519
 520         <sect2>
 521         <title>Mapping User Identifiers between MS Windows and UNIX</title>
 522
 523         <para>
 524 <indexterm><primary>UID</primary></indexterm>
 525 <indexterm><primary>SID</primary></indexterm>
 526 <indexterm><primary>mapping</primary></indexterm>
 527         Every operation in UNIX/Linux requires a user identifier (UID), just as in
 528         MS Windows NT4/200x this requires a security identifier (SID). Samba provides
 529         two means for mapping an MS Windows user to a UNIX/Linux UID.
 530         </para>
 531
 532         <para>
 533 <indexterm><primary>Samba SAM</primary></indexterm>
 534 <indexterm><primary>SAM</primary></indexterm>
 535 <indexterm><primary>UID</primary></indexterm>
 536 <indexterm><primary>account information database</primary></indexterm>
 537 <indexterm><primary>local user account</primary></indexterm>
 538         First, all Samba SAM database accounts require a UNIX/Linux UID that the account will map to. As users are
 539         added to the account information database, Samba will call the <smbconfoption name="add user script"/>
 540         interface to add the account to the Samba host OS. In essence all accounts in the local SAM require a local
 541         user account.
 542         </para>
 543
 544         <para>
 545         <indexterm><primary>idmap uid</primary></indexterm>
 546         <indexterm><primary>idmap gid</primary></indexterm>
 547         <indexterm><primary>UID</primary></indexterm>
 548         <indexterm><primary>SAM</primary></indexterm>
 549         <indexterm><primary>foreign domain</primary></indexterm>
 550         <indexterm><primary>non-member Windows client</primary></indexterm>
 551         <indexterm><primary>SID</primary></indexterm>
 552         The second way to map Windows SID to UNIX UID is via the <emphasis>idmap uid</emphasis> and
 553         <emphasis>idmap gid</emphasis> parameters in &smb.conf;.  Please refer to the man page for information about
 554         these parameters.  These parameters are essential when mapping users from a remote (non-member Windows client
 555         or a member of a foreign domain) SAM server.
 556         </para>
 557
 558         </sect2>
 559
 560         <sect2 id="idmapbackend">
 561         <title>Mapping Common UIDs/GIDs on Distributed Machines</title>
 562
 563         <para>
 564 <indexterm><primary>UID</primary></indexterm>
 565 <indexterm><primary>GID</primary></indexterm>
 566 <indexterm><primary>BDC</primary></indexterm>
 567 <indexterm><primary>domain member servers</primary></indexterm>
 568 <indexterm><primary>NFS</primary></indexterm>
 569 <indexterm><primary>rsync</primary></indexterm>
 570         Samba-3 has a special facility that makes it possible to maintain identical UIDs and GIDs
 571         on all servers in a distributed network. A distributed network is one where there exists
 572         a PDC, one or more BDCs, and/or one or more domain member servers. Why is this important?
 573         This is important if files are being shared over more than one protocol (e.g., NFS) and where
 574         users are copying files across UNIX/Linux systems using tools such as <command>rsync</command>.
 575         </para>
 576
 577         <para>
 578 <indexterm><primary>LDAP-based</primary></indexterm>
 579 <indexterm><primary>idmap backend</primary></indexterm>
 580 <indexterm><primary>UID</primary></indexterm>
 581 <indexterm><primary>GID</primary></indexterm>
 582 <indexterm><primary>LDAP</primary></indexterm>
 583 <indexterm><primary>SAM backend</primary></indexterm>
 584 <indexterm><primary>LDAP idmap Backend</primary></indexterm>
 585         <indexterm><primary>idmap backend</primary></indexterm>
 586         The special facility is enabled using a parameter called <parameter>idmap backend</parameter>.
 587         The default setting for this parameter is an empty string. Technically it is possible to use
 588         an LDAP-based idmap backend for UIDs and GIDs, but it makes most sense when this is done for
 589         network configurations that also use LDAP for the SAM backend.
 590         <link linkend="idmapbackendexample">Example Configuration with the LDAP idmap Backend</link>
 591         shows that configuration.
 592         </para>
 593
 594 <indexterm><primary>SAM backend</primary><secondary>ldapsam</secondary></indexterm>
 595 <example id="idmapbackendexample">
 596 <title>Example Configuration with the LDAP idmap Backend</title>
 597 <smbconfblock>
 598 <smbconfsection name="[global]"/>
 599 <smbconfoption name="idmap backend">ldap:ldap://ldap-server.quenya.org:636</smbconfoption>
 600 <smbconfcomment>Alternatively, this could be specified as:</smbconfcomment>
 601 <smbconfoption name="idmap backend">ldap:ldaps://ldap-server.quenya.org</smbconfoption>
 602 </smbconfblock>
 603 </example>
 604
 605         <para>
 606 <indexterm><primary>LDAP backends</primary></indexterm>
 607 <indexterm><primary>PADL Software</primary></indexterm>
 608         A network administrator who wants to make significant use of LDAP backends will sooner or later be
 609         exposed to the excellent work done by PADL Software. PADL <ulink url="http://www.padl.com"/> have
 610         produced and released to open source an array of tools that might be of interest. These tools include:
 611         </para>
 612
 613         <itemizedlist>
 614                 <listitem>
 615                 <para>
 616 <indexterm><primary>nss_ldap</primary></indexterm>
 617 <indexterm><primary>NSS</primary></indexterm>
 618 <indexterm><primary>AIX</primary></indexterm>
 619 <indexterm><primary>Linux</primary></indexterm>
 620 <indexterm><primary>LDAP</primary></indexterm>
 621 <indexterm><primary>Solaris</primary></indexterm>
 622 <indexterm><primary>UID</primary></indexterm>
 623 <indexterm><primary>GID</primary></indexterm>
 624                 <emphasis>nss_ldap:</emphasis> An LDAP name service switch (NSS) module to provide native
 625                 name service support for AIX, Linux, Solaris, and other operating systems. This tool
 626                 can be used for centralized storage and retrieval of UIDs and GIDs.
 627                 </para>
 628                 </listitem>
 629
 630                 <listitem>
 631                 <para>
 632 <indexterm><primary>pam_ldap</primary></indexterm>
 633 <indexterm><primary>PAM</primary></indexterm>
 634 <indexterm><primary>LDAP</primary></indexterm>
 635 <indexterm><primary>access authentication</primary></indexterm>
 636                 <emphasis>pam_ldap:</emphasis> A PAM module that provides LDAP integration for UNIX/Linux
 637                 system access authentication.
 638                 </para>
 639                 </listitem>
 640
 641                 <listitem>
 642                 <para>
 643 <indexterm><primary>idmap_ad</primary></indexterm>
 644 <indexterm><primary>IDMAP backend</primary></indexterm>
 645 <indexterm><primary>RFC 2307</primary></indexterm>
 646 <indexterm><primary>PADL</primary></indexterm>
 647                 <emphasis>idmap_ad:</emphasis> An IDMAP backend that supports the Microsoft Services for
 648                 UNIX RFC 2307 schema available from the PADL Web
 649                 <ulink url="http://www.padl.com/download/xad_oss_plugins.tar.gz">site</ulink>.
 650                 </para>
 651                 </listitem>
 652         </itemizedlist>
 653
 654         </sect2>
 655
 656         <sect2>
 657         <title>Comments Regarding LDAP</title>
 658
 659         <para>
 660 <indexterm><primary>LDAP</primary><secondary>directories</secondary></indexterm>
 661 <indexterm><primary>architecture</primary></indexterm>
 662 <indexterm><primary>FIM</primary></indexterm>
 663 <indexterm><primary>SSO</primary></indexterm>
 664         There is much excitement and interest in LDAP directories in the information technology world
 665         today. The LDAP architecture was designed to be highly scalable. It was also designed for
 666         use across a huge number of potential areas of application encompasing a wide range of operating
 667         systems and platforms. LDAP technologies are at the heart of the current generations of Federated
 668         Identity Management (FIM) solutions that can underlie a corporate Single Sign-On (SSO) environment.
 669         </para>
 670
 671         <para>
 672 <indexterm><primary>LDAP</primary></indexterm>
 673 <indexterm><primary>eDirectory</primary></indexterm>
 674 <indexterm><primary>ADS</primary></indexterm>
 675 <indexterm><primary>authentication</primary></indexterm>
 676         LDAP implementations have been built across a wide variety of platforms. It lies at the core of Microsoft
 677         Windows Active Directory services (ADS), Novell's eDirectory, as well as many others. Implementation of the
 678         directory services LDAP involves interaction with legacy as well as new generation applications, all of which
 679         depend on some form of authentication services.
 680         </para>
 681
 682         <para>
 683 <indexterm><primary>LDAP directory</primary></indexterm>
 684 <indexterm><primary>authentication</primary></indexterm>
 685 <indexterm><primary>access controls</primary></indexterm>
 686 <indexterm><primary>intermediate tools</primary></indexterm>
 687 <indexterm><primary>middle-ware</primary></indexterm>
 688 <indexterm><primary>central environment</primary></indexterm>
 689 <indexterm><primary>infrastructure</primary></indexterm>
 690 <indexterm><primary>login shells</primary></indexterm>
 691 <indexterm><primary>mail</primary></indexterm>
 692 <indexterm><primary>messaging systems</primary></indexterm>
 693 <indexterm><primary>quota controls</primary></indexterm>
 694 <indexterm><primary>printing systems</primary></indexterm>
 695 <indexterm><primary>DNS servers</primary></indexterm>
 696 <indexterm><primary>DHCP servers</primary></indexterm>
 697         UNIX services can utilize LDAP directory information for authentication and access controls
 698         through intermediate tools and utilities. The total environment that consists of the LDAP directory
 699         and the middle-ware tools and utilities makes it possible for all user access to the UNIX platform
 700         to be managed from a central environment and yet distributed to wherever the point of need may
 701         be physically located. Applications that benefit from this infrastructure include: UNIX login
 702         shells, mail and messaging systems, quota controls, printing systems, DNS servers, DHCP servers,
 703         and also Samba.
 704         </para>
 705
 706         <para>
 707 <indexterm><primary>LDAP</primary></indexterm>
 708 <indexterm><primary>passdb backend</primary></indexterm>
 709 <indexterm><primary>scalable</primary></indexterm>
 710 <indexterm><primary>SAM backend</primary></indexterm>
 711 <indexterm><primary>LDAP directory</primary></indexterm>
 712 <indexterm><primary>management costs</primary></indexterm>
 713         Many sites are installing LDAP for the first time in order to provide a scalable passdb backend
 714         for Samba. Others are faced with the need to adapt an existing LDAP directory to new uses such
 715         as for the Samba SAM backend. Whatever your particular need and attraction to Samba may be,
 716         decisions made in respect of the design of the LDAP directory structure and its implementation
 717         are of a durable nature for the site. These have far-reaching implications that affect long term
 718         information systems management costs.
 719         </para>
 720
 721         <para>
 722 <indexterm><primary>LDAP deployment</primary></indexterm>
 723 <indexterm><primary>Directory Information Tree</primary><see>DIT</see></indexterm>
 724         Do not rush into an LDAP deployment. Take the time to understand how the design of the Directory
 725         Information Tree (DIT) may impact current and future site needs, as well as the ability to meet
 726         them. The way that Samba SAM information should be stored within the DIT varies from site to site
 727         and with each implementation new experience is gained. It is well understood by LDAP veterans that
 728         first implementation create awakening, second implementations of LDAP create fear, and
 729         third-generation deployments bring peace and tranquility.
 730         </para>
 731
 732         <sect3>
 733         <title>Caution Regarding LDAP and Samba</title>
 734
 735         <para>
 736 <indexterm><primary>POSIX identity</primary></indexterm>
 737 <indexterm><primary>networking environment</primary></indexterm>
 738 <indexterm><primary>user accounts</primary></indexterm>
 739 <indexterm><primary>group accounts</primary></indexterm>
 740 <indexterm><primary>machine trust accounts</primary></indexterm>
 741 <indexterm><primary>interdomain trust accounts</primary></indexterm>
 742 <indexterm><primary>intermediate information</primary></indexterm>
 743         Samba requires UNIX POSIX identity information as well as a place to store information that is
 744         specific to Samba and the Windows networking environment. The most used information that must
 745         be dealt with includes: user accounts, group accounts, machine trust accounts, interdomain
 746         trust accounts, and intermediate information specific to Samba internals.
 747         </para>
 748
 749         <para>
 750 <indexterm><primary>deployment guidelines</primary></indexterm>
 751 <indexterm><primary>HOWTO documents</primary></indexterm>
 752 <indexterm><primary>LDAP</primary></indexterm>
 753         The example deployment guidelines in this book, as well as other books and HOWTO documents
 754         available from the internet may not fit with established directory designs and implementations.
 755         The existing DIT may not be able to accomodate the simple information layout proposed in common
 756         sources. Additionally, you may find that the common scripts and tools that are used to provision
 757         the LDAP directory for use with Samba may not suit your needs.
 758         </para>
 759
 760         <para>
 761 <indexterm><primary>existing LDAP DIT</primary></indexterm>
 762         It is not uncommon, for sites that have existing LDAP DITs to find necessity to generate a
 763         set of site specific scripts and utilities to make it possible to deploy Samba within the
 764         scope of site operations. The way that user and group accounts are distributed throughout
 765         the DIT may make this a challenging matter. The solution will of course be rewarding, but
 766         the journey to it may be challenging. Take time to understand site needs and do not rush
 767         into deployment.
 768         </para>
 769
 770         <para>
 771 <indexterm><primary>scripts</primary></indexterm>
 772 <indexterm><primary>tools</primary></indexterm>
 773         Above all, do not blindly use scripts and tools that are not suitable for your site. Check
 774         and validate all scripts before you execute them to make sure that the existing infrastructure
 775         will not be damaged by inadvertent use of an inappropriate tool.
 776         </para>
 777
 778         </sect3>
 779
 780         </sect2>
 781
 782         <sect2>
 783         <title>LDAP Directories and Windows Computer Accounts</title>
 784
 785                 <para>
 786 <indexterm><primary>turnkey solution</primary></indexterm>
 787 <indexterm><primary>LDAP.</primary></indexterm>
 788 <indexterm><primary>frustrating experience</primary></indexterm>
 789                 Samba doesn't provide a turnkey solution to LDAP. It is best to deal with the design and
 790                 configuration of an LDAP directory prior to integration with Samba. A working knowledge
 791                 of LDAP makes Samba integration easy, and the lack of a working knowledge of LDAP can make
 792                 it a frustrating experience.
 793                 </para>
 794
 795                 <para>
 796 <indexterm><primary>computer accounts</primary></indexterm>
 797 <indexterm><primary>machine accounts</primary></indexterm>
 798 <indexterm><primary>LDAP</primary></indexterm>
 799                 Computer (machine) accounts can be placed wherever you like in an LDAP directory subject
 800                 to some constraints that are described in this chapter.
 801                 </para>
 802
 803                 <para>
 804 <indexterm><primary>POSIX</primary></indexterm>
 805 <indexterm><primary>sambaSamAccount</primary></indexterm>
 806 <indexterm><primary>computer accounts</primary></indexterm>
 807 <indexterm><primary>machine accounts</primary></indexterm>
 808 <indexterm><primary>Windows NT4/200X</primary></indexterm>
 809 <indexterm><primary>user account</primary></indexterm>
 810 <indexterm><primary>trust accounts</primary></indexterm>
 811                 The POSIX and sambaSamAccount components of computer (machine) accounts are both used by Samba.
 812                 Thus, machine accounts are treated inside Samba in the same way that Windows NT4/200X treats
 813                 them. A user account and a machine account are indistinquishable from each other, except that
 814                 the machine account ends in a $ character, as do trust accounts.
 815                 </para>
 816
 817                 <para>
 818 <indexterm><primary>user</primary></indexterm>
 819 <indexterm><primary>group</primary></indexterm>
 820 <indexterm><primary>machine</primary></indexterm>
 821 <indexterm><primary>trust</primary></indexterm>
 822 <indexterm><primary>UID</primary></indexterm>
 823                 The need for Windows user, group, machine, trust, and other accounts to be tied to a valid UNIX
 824                 UID is a design decision that was made a long way back in the history of Samba development. It
 825                 is unlikely that this decision will be reversed or changed during the remaining life of the
 826                 Samba-3.x series.
 827                 </para>
 828
 829                 <para>
 830 <indexterm><primary>UID</primary></indexterm>
 831 <indexterm><primary>SID</primary></indexterm>
 832 <indexterm><primary>NSS</primary></indexterm>
 833                 The resolution of a UID from the Windows SID is achieved within Samba through a mechanism that
 834                 must refer back to the host operating system on which Samba is running. The NSS is the preferred
 835                 mechanism that shields applications (like Samba) from the need to know everything about every
 836                 host OS it runs on.
 837                 </para>
 838
 839                 <para>
 840 <indexterm><primary>UID</primary></indexterm>
 841 <indexterm><primary>passwd</primary></indexterm>
 842 <indexterm><primary>shadow</primary></indexterm>
 843 <indexterm><primary>group</primary></indexterm>
 844 <indexterm><primary>NSS</primary></indexterm>
 845 <indexterm><primary>winbindd</primary></indexterm>
 846 <indexterm><primary>LDAP</primary></indexterm>
 847                 Samba asks the host OS to provide a UID via the <quote>passwd</quote>, <quote>shadow</quote>,
 848                 and <quote>group</quote> facilities in the NSS control (configuration) file. The best tool
 849                 for achieving this is left up to the UNIX administrator to determine. It is not imposed by
 850                 Samba. Samba provides winbindd with its support libraries as one method. It is
 851                 possible to do this via LDAP, and for that Samba provides the appropriate hooks so that
 852                 all account entities can be located in an LDAP directory.
 853                 </para>
 854
 855                 <para>
 856 <indexterm><primary>PADL</primary></indexterm>
 857 <indexterm><primary>nss_ldap</primary></indexterm>
 858 <indexterm><primary>UID</primary></indexterm>
 859 <indexterm><primary>LDAP</primary></indexterm>
 860 <indexterm><primary>documentation</primary></indexterm>
 861                 For many the weapon of choice is to use the PADL nss_ldap utility. This utility must
 862                 be configured so that computer accounts can be resolved to a POSIX/UNIX account UID. That
 863                 is fundamentally an LDAP design question.  The information provided on the Samba list and
 864                 in the documentation is directed at providing working examples only. The design
 865                 of an LDAP directory is a complex subject that is beyond the scope of this documentation.
 866                 </para>
 867
 868         </sect2>
 869
 870 </sect1>
 871
 872 <sect1 id="acctmgmttools">
 873 <title>Account Management Tools</title>
 874
 875 <para>
 876 <indexterm><primary>pdbedit</primary></indexterm>
 877 <indexterm><primary>machine accounts</primary></indexterm>
 878 <indexterm><primary>management tools</primary></indexterm>
 879 Samba provides two tools for management of user and machine accounts:
 880 <command>smbpasswd</command> and <command>pdbedit</command>.
 881 </para>
 882
 883 <para>
 884 <indexterm><primary>smbpasswd</primary></indexterm>
 885 <indexterm><primary>storage mechanism</primary></indexterm>
 886 <indexterm><primary>SambaSAMAccount</primary></indexterm>
 887 <indexterm><primary>net</primary></indexterm>
 888 Some people are confused when reference is made to <literal>smbpasswd</literal> because the
 889 name refers to a storage mechanism for SambaSAMAccount information, but it is also the name
 890 of a utility tool. That tool is destined to eventually be replaced by new functionality that
 891 is being added to the <command>net</command> toolset (see <link linkend="NetCommand">the Net Command</link>.
 892 </para>
 893
 894         <sect2>
 895         <title>The <command>smbpasswd</command> Command</title>
 896
 897                 <para>
 898 <indexterm><primary>smbpasswd</primary></indexterm>
 899 <indexterm><primary>passwd</primary></indexterm>
 900 <indexterm><primary>yppasswd</primary></indexterm>
 901 <indexterm><primary>passdb backend</primary></indexterm>
 902 <indexterm><primary>storage methods</primary></indexterm>
 903                 The <command>smbpasswd</command> utility is similar to the <command>passwd</command>
 904                 and <command>yppasswd</command> programs. It maintains the two 32 byte password
 905                 fields in the passdb backend. This utility operates independantly of the actual
 906                 account and password storage methods used (as specified by the <parameter>passdb
 907                 backend</parameter> in the &smb.conf; file.
 908                 </para>
 909
 910                 <para>
 911 <indexterm><primary>smbpasswd</primary></indexterm>
 912 <indexterm><primary>client-server mode</primary></indexterm>
 913                 <command>smbpasswd</command> works in a client-server mode where it contacts the
 914                 local smbd to change the user's password on its behalf. This has enormous benefits.
 915                 </para>
 916
 917                 <para>
 918 <indexterm><primary>smbpasswd</primary></indexterm>
 919 <indexterm><primary>change passwords</primary></indexterm>
 920                 <command>smbpasswd</command> has the capability to change passwords on Windows NT
 921                 servers (this only works when the request is sent to the NT PDC if changing an NT
 922                 domain user's password).
 923                 </para>
 924
 925                 <para>
 926                 <indexterm><primary>user management</primary></indexterm>
 927                 <indexterm><primary>user account</primary><secondary>Adding/Deleting</secondary></indexterm>
 928                 <command>smbpasswd</command> can be used to:
 929                 </para>
 930
 931                 <itemizedlist>
 932                         <listitem><para><emphasis>add</emphasis> user or machine accounts.</para></listitem>
 933                         <listitem><para><emphasis>delete</emphasis> user or machine accounts.</para></listitem>
 934                         <listitem><para><emphasis>enable</emphasis> user or machine accounts.</para></listitem>
 935                         <listitem><para><emphasis>disable</emphasis> user or machine accounts.</para></listitem>
 936                         <listitem><para><emphasis>set to NULL</emphasis> user passwords.</para></listitem>
 937                         <listitem><para><emphasis>manage</emphasis> interdomain trust accounts.</para></listitem>
 938                 </itemizedlist>
 939
 940                 <para>
 941                 To run smbpasswd as a normal user, just type:
 942                 </para>
 943
 944                 <para>
 945 <screen>
 946 &prompt;<userinput>smbpasswd</userinput>
 947 <prompt>Old SMB password: </prompt><userinput><replaceable>secret</replaceable></userinput>
 948 </screen>
 949                 For <replaceable>secret</replaceable>, type the old value here or press return if
 950                 there is no old password.
 951 <screen>
 952 <prompt>New SMB Password: </prompt><userinput><replaceable>new secret</replaceable></userinput>
 953 <prompt>Repeat New SMB Password: </prompt><userinput><replaceable>new secret</replaceable></userinput>
 954 </screen>
 955                 </para>
 956
 957                 <para>
 958                 If the old value does not match the current value stored for that user, or the two
 959                 new values do not match each other, then the password will not be changed.
 960                 </para>
 961
 962                 <para>
 963 <indexterm><primary>SMB password</primary></indexterm>
 964                 When invoked by an ordinary user, the command will allow only the user to change his or her own
 965                 SMB password.
 966                 </para>
 967
 968                 <para>
 969 <indexterm><primary>smbpasswd</primary></indexterm>
 970 <indexterm><primary>SMB password</primary></indexterm>
 971                 When run by root, <command>smbpasswd</command> may take an optional argument specifying
 972                 the username whose SMB password you wish to change. When run as root, <command>smbpasswd</command>
 973                 does not prompt for or check the old password value, thus allowing root to set passwords
 974                 for users who have forgotten their passwords.
 975                 </para>
 976
 977                 <para>
 978 <indexterm><primary>smbpasswd</primary></indexterm>
 979 <indexterm><primary>passwd</primary></indexterm>
 980 <indexterm><primary>yppasswd</primary></indexterm>
 981 <indexterm><primary>change capabilities</primary></indexterm>
 982                 <command>smbpasswd</command> is designed to work in the way familiar to UNIX
 983                 users who use the <command>passwd</command> or <command>yppasswd</command> commands.
 984                 While designed for administrative use, this tool provides essential user-level
 985                 password change capabilities.
 986                 </para>
 987
 988                 <para>
 989 <indexterm><primary>smbpasswd</primary></indexterm>
 990                 For more details on using <command>smbpasswd</command>, refer to the man page (the
 991                 definitive reference).
 992                 </para>
 993         </sect2>
 994
 995         <sect2 id="pdbeditthing">
 996         <title>The <command>pdbedit</command> Command</title>
 997
 998                 <para>
 999                 <indexterm><primary>pdbedit</primary></indexterm>
1000                 <indexterm><primary>User Management</primary></indexterm>
1001                 <indexterm><primary>User Accounts</primary><secondary>Adding/Deleting</secondary></indexterm>
1002                 <command>pdbedit</command> is a tool that can be used only by root. It is used to
1003                 manage the passdb backend. <command>pdbedit</command> can be used to:
1004                 </para>
1005
1006                 <itemizedlist>
1007                         <listitem><para>add, remove, or modify user accounts.</para></listitem>
1008                         <listitem><para>list user accounts.</para></listitem>
1009                         <listitem><para>migrate user accounts.</para></listitem>
1010                 </itemizedlist>
1011
1012                 <para>
1013                 <indexterm><primary>pdbedit</primary></indexterm>
1014 <indexterm><primary>policy settings</primary></indexterm>
1015 <indexterm><primary>account security</primary></indexterm>
1016 <indexterm><primary>smbpasswd</primary></indexterm>
1017                 The <command>pdbedit</command> tool is the only one that can manage the account
1018                 security and policy settings. It is capable of all operations that smbpasswd can
1019                 do as well as a superset of them.
1020                 </para>
1021
1022                 <para>
1023                 <indexterm><primary>pdbedit</primary></indexterm>
1024 <indexterm><primary>account migration</primary></indexterm>
1025 <indexterm><primary>passdb backend</primary></indexterm>
1026                 One particularly important purpose of the <command>pdbedit</command> is to allow
1027                 the migration of account information from one passdb backend to another. See the
1028                 <link linkend="XMLpassdb">XML</link> password backend section of this chapter.
1029                 </para>
1030
1031                 <para>
1032 <indexterm><primary>tdbsam</primary></indexterm>
1033                 The following is an example of the user account information that is stored in
1034                 a tdbsam password backend. This listing was produced by running:
1035                 </para>
1036
1037 <screen>
1038 &prompt;<userinput>pdbedit -Lv met</userinput>
1039 UNIX username:        met
1040 NT username:
1041 Account Flags:        [UX         ]
1042 User SID:             S-1-5-21-1449123459-1407424037-3116680435-2004
1043 Primary Group SID:    S-1-5-21-1449123459-1407424037-3116680435-1201
1044 Full Name:            Melissa E Terpstra
1045 Home Directory:       \\frodo\met\Win9Profile
1046 HomeDir Drive:        H:
1047 Logon Script:         scripts\logon.bat
1048 Profile Path:         \\frodo\Profiles\met
1049 Domain:               &example.workgroup;
1050 Account desc:
1051 Workstations:         melbelle
1052 Munged dial:
1053 Logon time:           0
1054 Logoff time:          Mon, 18 Jan 2038 20:14:07 GMT
1055 Kickoff time:         Mon, 18 Jan 2038 20:14:07 GMT
1056 Password last set:    Sat, 14 Dec 2002 14:37:03 GMT
1057 Password can change:  Sat, 14 Dec 2002 14:37:03 GMT
1058 Password must change: Mon, 18 Jan 2038 20:14:07 GMT
1059 </screen>
1060
1061                 <para>
1062                 <indexterm><primary>pdbedit</primary></indexterm>
1063 <indexterm><primary>migrate accounts</primary></indexterm>
1064 <indexterm><primary>authentication</primary></indexterm>
1065                 The <command>pdbedit</command> tool allows migration of authentication (account)
1066                 databases from one backend to another. For example, to migrate accounts from an
1067                 old <filename>smbpasswd</filename> database to a <parameter>tdbsam</parameter>
1068                 backend:
1069                 </para>
1070
1071                 <procedure>
1072                         <step><para>
1073                         Set the <smbconfoption name="passdb backend">tdbsam, smbpasswd</smbconfoption>.
1074                         </para></step>
1075
1076                         <step><para>
1077 <indexterm><primary>pdbedit</primary></indexterm>
1078                         Execute:
1079 <screen>
1080 &rootprompt;<userinput>pdbedit -i smbpasswd -e tdbsam</userinput>
1081 </screen>
1082                         </para></step>
1083
1084                         <step><para>
1085 <indexterm><primary>smbpasswd</primary></indexterm>
1086                         Remove the <parameter>smbpasswd</parameter> from the passdb backend
1087                         configuration in &smb.conf;.
1088                         </para></step>
1089                 </procedure>
1090
1091         </sect2>
1092 </sect1>
1093
1094 <sect1>
1095 <title>Password Backends</title>
1096
1097 <para>
1098 <indexterm><primary>account database</primary></indexterm>
1099 <indexterm><primary>SMB/CIFS server</primary></indexterm>
1100 Samba offers the greatest flexibility in backend account database design of any SMB/CIFS server
1101 technology available today. The flexibility is immediately obvious as one begins to explore this
1102 capability.
1103 </para>
1104
1105 <para>
1106 <indexterm><primary>multiple backends</primary></indexterm>
1107 <indexterm><primary>tdbsam databases</primary></indexterm>
1108 It is possible to specify not only multiple password backends, but even multiple
1109 backends of the same type. For example, to use two different <literal>tdbsam</literal> databases:
1110
1111 <smbconfblock>
1112 <smbconfoption name="passdb backend">tdbsam:/etc/samba/passdb.tdb tdbsam:/etc/samba/old-passdb.tdb</smbconfoption>
1113 </smbconfblock>
1114
1115 What is possible, is not always sensible. Be careful to avoid complexity to the point that it
1116 may be said that the solution is <quote>too clever by half!</quote>
1117 </para>
1118
1119
1120         <sect2>
1121         <title>Plaintext</title>
1122
1123                 <para>
1124 <indexterm><primary>user database</primary></indexterm>
1125 <indexterm><primary>/etc/samba/smbpasswd</primary></indexterm>
1126 <indexterm><primary>/etc/smbpasswd</primary></indexterm>
1127 <indexterm><primary>password encryption</primary></indexterm>
1128 <indexterm><primary>/etc/passwd</primary></indexterm>
1129 <indexterm><primary>PAM</primary></indexterm>
1130                 Older versions of Samba retrieved user information from the UNIX user database
1131                 and eventually some other fields from the file <filename>/etc/samba/smbpasswd</filename>
1132                 or <filename>/etc/smbpasswd</filename>. When password encryption is disabled, no
1133                 SMB-specific data is stored at all. Instead, all operations are conducted via the way
1134                 that the Samba host OS will access its <filename>/etc/passwd</filename> database.
1135                 On most Linux systems, for example, all user and group resolution is done via PAM.
1136                 </para>
1137
1138         </sect2>
1139
1140         <sect2>
1141         <title>smbpasswd: Encrypted Password Database</title>
1142
1143                 <para>
1144                 <indexterm><primary>SAM backend</primary><secondary>smbpasswd</secondary></indexterm>
1145 <indexterm><primary>user account</primary></indexterm>
1146 <indexterm><primary>LM/NT password hashes</primary></indexterm>
1147 <indexterm><primary>smbpasswd</primary></indexterm>
1148                 Traditionally, when configuring <smbconfoption name="encrypt passwords">yes</smbconfoption>
1149                 in Samba's &smb.conf; file, user account information such as username, LM/NT password hashes,
1150                 password change times, and account flags have been stored in the <filename>smbpasswd(5)</filename>
1151                 file. There are several disadvantages to this approach for sites with large numbers of users
1152                 (counted in the thousands).
1153                 </para>
1154
1155                 <itemizedlist>
1156                 <listitem><para>
1157 <indexterm><primary>lookups</primary></indexterm>
1158                 The first problem is that all lookups must be performed sequentially. Given that
1159                 there are approximately two lookups per domain logon (one during intial logon validation
1160                 and one for a session connection setup, such as when mapping a network drive or printer), this
1161                 is a performance bottleneck for large sites. What is needed is an indexed approach
1162                 such as used in databases.
1163                 </para></listitem>
1164
1165                 <listitem><para>
1166 <indexterm><primary>smbpasswd</primary></indexterm>
1167 <indexterm><primary>replicate</primary></indexterm>
1168 <indexterm><primary>rsync</primary></indexterm>
1169 <indexterm><primary>ssh</primary></indexterm>
1170 <indexterm><primary>custom scripts</primary></indexterm>
1171                 The second problem is that administrators who desire to replicate an smbpasswd file
1172                 to more than one Samba server are left to use external tools such as
1173                 <command>rsync(1)</command> and <command>ssh(1)</command> and write custom,
1174                 in-house scripts.
1175                 </para></listitem>
1176
1177                 <listitem><para>
1178 <indexterm><primary>smbpasswd</primary></indexterm>
1179 <indexterm><primary>home directory</primary></indexterm>
1180 <indexterm><primary>password expiration</primary></indexterm>
1181 <indexterm><primary>relative identifier</primary></indexterm>
1182 <indexterm><primary>relative identifier</primary><see>RID</see></indexterm>
1183                 Finally, the amount of information that is stored in an smbpasswd entry leaves
1184                 no room for additional attributes such as a home directory, password expiration time,
1185                 or even a relative identifier (RID).
1186                 </para></listitem>
1187                 </itemizedlist>
1188
1189                 <para>
1190 <indexterm><primary>user attributes</primary></indexterm>
1191 <indexterm><primary>smbd</primary></indexterm>
1192 <indexterm><primary>API</primary></indexterm>
1193 <indexterm><primary>samdb interface</primary></indexterm>
1194                 As a result of these deficiencies, a more robust means of storing user attributes
1195                 used by smbd was developed. The API that defines access to user accounts
1196                 is commonly referred to as the samdb interface (previously, this was called the passdb
1197                 API and is still so named in the Samba source code trees).
1198                 </para>
1199
1200                 <para>
1201 <indexterm><primary>passdb backends</primary></indexterm>
1202 <indexterm><primary>smbpasswd plaintext database</primary></indexterm>
1203 <indexterm><primary>tdbsam</primary></indexterm>
1204 <indexterm><primary>ldapsam</primary></indexterm>
1205 <indexterm><primary>xmlsam</primary></indexterm>
1206 <indexterm><primary>enterprise</primary></indexterm>
1207                 Samba provides an enhanced set of passdb backends that overcome the deficiencies
1208                 of the smbpasswd plaintext database. These are tdbsam, ldapsam, and xmlsam.
1209                 Of these, ldapsam will be of most interest to large corporate or enterprise sites.
1210                 </para>
1211
1212         </sect2>
1213
1214         <sect2>
1215         <title>tdbsam</title>
1216
1217                 <para>
1218                 <indexterm><primary>SAM backend</primary><secondary>tdbsam</secondary></indexterm>
1219 <indexterm><primary>trivial database</primary><see>TDB</see></indexterm>
1220 <indexterm><primary>machine account</primary></indexterm>
1221                 Samba can store user and machine account data in a <quote>TDB</quote> (trivial database).
1222                 Using this backend does not require any additional configuration. This backend is
1223                 recommended for new installations that do not require LDAP.
1224                 </para>
1225
1226                 <para>
1227 <indexterm><primary>tdbsam</primary></indexterm>
1228 <indexterm><primary>PDC</primary></indexterm>
1229 <indexterm><primary>BDC</primary></indexterm>
1230 <indexterm><primary>scalability</primary></indexterm>
1231                 As a general guide, the Samba Team does not recommend using the tdbsam backend for sites
1232                 that have 250 or more users. Additionally, tdbsam is not capable of scaling for use
1233                 in sites that require PDB/BDC implementations that require replication of the account
1234                 database. Clearly, for reason of scalability, the use of ldapsam should be encouraged.
1235                 </para>
1236
1237                 <para>
1238 <indexterm><primary>250-user limit</primary></indexterm>
1239 <indexterm><primary>performance-based</primary></indexterm>
1240 <indexterm><primary>tdbsam</primary></indexterm>
1241                 The recommendation of a 250-user limit is purely based on the notion that this
1242                 would generally involve a site that has routed networks, possibly spread across
1243                 more than one physical location. The Samba Team has not at this time established
1244                 the performance-based scalability limits of the tdbsam architecture.
1245                 </para>
1246
1247                 <para>
1248 <indexterm><primary>4,500 user accounts</primary></indexterm>
1249 <indexterm><primary>passdb backend</primary></indexterm>
1250 <indexterm><primary>tdbsam</primary></indexterm>
1251 <indexterm><primary>SambaSAMAccount</primary></indexterm>
1252                 There are sites that have thousands of users and yet require only one server.
1253                 One site recently reported having 4,500 user accounts on one UNIX system and
1254                 reported excellent performance with the <literal>tdbsam</literal> passdb backend.
1255                 The limitation of where the <literal>tdbsam</literal> passdb backend can be used
1256                 is not one pertaining to a limitation in the TDB storage system, it is based
1257                 only on the need for a reliable distribution mechanism for the SambaSAMAccount
1258                 backend.
1259                 </para>
1260
1261         </sect2>
1262
1263         <sect2>
1264         <title>ldapsam</title>
1265
1266                 <para>
1267 <indexterm><primary>LDAP</primary></indexterm>
1268 <indexterm><primary>ldapsam</primary></indexterm>
1269                 <indexterm><primary>SAM backend</primary><secondary>ldapsam</secondary></indexterm>
1270                 There are a few points to stress that the ldapsam does not provide. The LDAP
1271                 support referred to in this documentation does not include:
1272                 </para>
1273
1274                 <itemizedlist>
1275                         <listitem><para>A means of retrieving user account information from
1276                         a Windows 200x Active Directory server.</para></listitem>
1277                         <listitem><para>A means of replacing /etc/passwd.</para></listitem>
1278                 </itemizedlist>
1279
1280                 <para>
1281 <indexterm><primary>LDAP</primary></indexterm>
1282 <indexterm><primary>NSS</primary></indexterm>
1283 <indexterm><primary>PAM</primary></indexterm>
1284 <indexterm><primary>LGPL</primary></indexterm>
1285                 The second item can be accomplished by using LDAP NSS and PAM modules. LGPL versions of these libraries can be
1286                 obtained from <ulink url="http://www.padl.com/">PADL Software</ulink>.  More information about the
1287                 configuration of these packages may be found in <ulink url="http://safari.oreilly.com/?XmlId=1-56592-491-6">
1288                 <emphasis>LDAP, System Administration</emphasis> by Gerald Carter, Chapter 6, Replacing NIS"</ulink>.
1289                 </para>
1290
1291                 <para>
1292 <indexterm><primary>LDAP directory</primary></indexterm>
1293 <indexterm><primary>smbpasswd</primary></indexterm>
1294 <indexterm><primary>directory server</primary></indexterm>
1295                 This document describes how to use an LDAP directory for storing Samba user
1296                 account information traditionally stored in the smbpasswd(5) file. It is
1297                 assumed that the reader already has a basic understanding of LDAP concepts
1298                 and has a working directory server already installed. For more information
1299                 on LDAP architectures and directories, please refer to the following sites:
1300                 </para>
1301
1302                 <itemizedlist>
1303                         <listitem><para><ulink url="http://www.openldap.org/">OpenLDAP</ulink></para></listitem>
1304                         <listitem><para><ulink url="http://www.sun.com/software/products/directory_srvr_ee/index.xml">
1305                                 Sun One Directory Server</ulink></para></listitem>
1306                         <listitem><para><ulink url="http://www.novell.com/products/edirectory/">Novell eDirectory</ulink></para></listitem>
1307                         <listitem><para><ulink url="http://www-306.ibm.com/software/tivoli/products/directory-server/">IBM
1308                                 Tivoli Directory Server</ulink></para></listitem>
1309                         <listitem><para><ulink url="http://www.redhat.com/software/rha/directory/">Red Hat Directory
1310                                 Server</ulink></para></listitem>
1311                         <listitem><para><ulink url="http://www.linuxsecurity.com/content/view/119229">Fedora Directory
1312                                 Server</ulink></para></listitem>
1313                 </itemizedlist>
1314
1315                 <para>
1316                 Two additional Samba resources that may prove to be helpful are:
1317                 </para>
1318
1319                 <itemizedlist>
1320                         <listitem><para>
1321 <indexterm><primary>Samba-PDC-LDAP-HOWTO</primary></indexterm>
1322                         The <ulink url="http://www.unav.es/cti/ldap-smb/ldap-smb-3-howto.html">Samba-PDC-LDAP-HOWTO</ulink>
1323                         maintained by Ignacio Coupeau.
1324                         </para></listitem>
1325
1326                         <listitem><para>
1327 <indexterm><primary>IDEALX</primary></indexterm>
1328 <indexterm><primary>NT migration scripts</primary></indexterm>
1329 <indexterm><primary>smbldap-tools</primary></indexterm>
1330                         The NT migration scripts from <ulink url="http://samba.idealx.org/">IDEALX</ulink> that are
1331                         geared to manage users and groups in such a Samba-LDAP domain controller configuration.
1332                         Idealx also produced the smbldap-tools and the Interactive Console Management tool.
1333                         </para></listitem>
1334                 </itemizedlist>
1335
1336                 <sect3>
1337                 <title>Supported LDAP Servers</title>
1338
1339                         <para>
1340 <indexterm><primary>LDAP</primary></indexterm>
1341 <indexterm><primary>ldapsam</primary></indexterm>
1342 <indexterm><primary>OpenLDAP</primary></indexterm>
1343 <indexterm><primary>Netscape's Directory Server</primary></indexterm>
1344                         The LDAP ldapsam code was developed and tested using the OpenLDAP 2.x server and
1345                         client libraries. The same code should work with Netscape's Directory Server and client SDK.
1346                         However, there are bound to be compile errors and bugs. These should not be hard to fix.
1347                         Please submit fixes via the process outlined in <link linkend="bugreport">Reporting Bugs</link>.
1348                         </para>
1349
1350                         <para>
1351                         Samba is capable of working with any standards compliant LDAP server.
1352                         </para>
1353
1354                 </sect3>
1355
1356                 <sect3>
1357                 <title>Schema and Relationship to the RFC 2307 posixAccount</title>
1358
1359
1360                         <para>
1361                         Samba-3.0 includes the necessary schema file for OpenLDAP 2.x in
1362                         <filename>examples/LDAP/samba.schema</filename> directory of the source code distribution
1363                         tarball. The schema entry for the sambaSamAccount ObjectClass is shown here:
1364 <programlisting>
1365 ObjectClass (1.3.6.1.4.1.7165.2.2.6 NAME 'sambaSamAccount' SUP top AUXILIARY
1366     DESC 'Samba-3.0 Auxiliary SAM Account'
1367     MUST ( uid $ sambaSID )
1368     MAY  ( cn $ sambaLMPassword $ sambaNTPassword $ sambaPwdLastSet $
1369           sambaLogonTime $ sambaLogoffTime $ sambaKickoffTime $
1370           sambaPwdCanChange $ sambaPwdMustChange $ sambaAcctFlags $
1371           displayName $ sambaHomePath $ sambaHomeDrive $ sambaLogonScript $
1372           sambaProfilePath $ description $ sambaUserWorkstations $
1373           sambaPrimaryGroupSID $ sambaDomainName ))
1374 </programlisting>
1375                         </para>
1376
1377                         <para>
1378 <indexterm><primary>samba.schema</primary></indexterm>
1379 <indexterm><primary>OpenLDAP</primary></indexterm>
1380 <indexterm><primary>OID</primary></indexterm>
1381                         The <filename>samba.schema</filename> file has been formatted for OpenLDAP 2.0/2.1.
1382                         The Samba Team owns the OID space used by the above schema and recommends its use.
1383                         If you translate the schema to be used with Netscape DS, please submit the modified
1384                         schema file as a patch to <ulink url="mailto:jerry@samba.org">jerry@samba.org</ulink>.
1385                         </para>
1386
1387                         <para>
1388 <indexterm><primary>smbpasswd</primary></indexterm>
1389 <indexterm><primary>/etc/passwd</primary></indexterm>
1390 <indexterm><primary>sambaSamAccount</primary></indexterm>
1391 <indexterm><primary>AUXILIARY</primary></indexterm>
1392 <indexterm><primary>ObjectClass</primary></indexterm>
1393 <indexterm><primary>LDAP</primary></indexterm>
1394 <indexterm><primary>RFC 2307.</primary></indexterm>
1395                         Just as the smbpasswd file is meant to store information that provides information
1396                         additional to  a user's <filename>/etc/passwd</filename> entry, so is the sambaSamAccount
1397                         object meant to supplement the UNIX user account information. A sambaSamAccount is an
1398                         <constant>AUXILIARY</constant> ObjectClass, so it can be used to augment existing
1399                         user account information in the LDAP directory, thus providing information needed
1400                         for Samba account handling. However, there are several fields (e.g., uid) that overlap
1401                         with the posixAccount ObjectClass outlined in RFC 2307. This is by design.
1402                         </para>
1403
1404                         <para>
1405 <indexterm><primary>account information</primary></indexterm>
1406 <indexterm><primary>sambaSamAccount</primary></indexterm>
1407 <indexterm><primary>posixAccount</primary></indexterm>
1408 <indexterm><primary>ObjectClasses</primary></indexterm>
1409 <indexterm><primary>smbd</primary></indexterm>
1410 <indexterm><primary>getpwnam</primary></indexterm>
1411 <indexterm><primary>LDAP</primary></indexterm>
1412 <indexterm><primary>NIS</primary></indexterm>
1413 <indexterm><primary>NSS</primary></indexterm>
1414                         In order to store all user account information (UNIX and Samba) in the directory,
1415                         it is necessary to use the sambaSamAccount and posixAccount ObjectClasses in
1416                         combination. However, <command>smbd</command> will still obtain the user's UNIX account
1417                         information via the standard C library calls, such as getpwnam().
1418                         This means that the Samba server must also have the LDAP NSS library installed
1419                         and functioning correctly. This division of information makes it possible to
1420                         store all Samba account information in LDAP, but still maintain UNIX account
1421                         information in NIS while the network is transitioning to a full LDAP infrastructure.
1422                         </para>
1423                 </sect3>
1424
1425                 <sect3>
1426                 <title>OpenLDAP Configuration</title>
1427
1428                 <para>
1429 <indexterm><primary>sambaSamAccount</primary></indexterm>
1430 <indexterm><primary>OpenLDAP</primary></indexterm>
1431 <indexterm><primary>slapd</primary></indexterm>
1432 <indexterm><primary>samba.schema</primary></indexterm>
1433                 To include support for the sambaSamAccount object in an OpenLDAP directory
1434                 server, first copy the samba.schema file to slapd's configuration directory.
1435                 The samba.schema file can be found in the directory <filename>examples/LDAP</filename>
1436                 in the Samba source distribution.
1437 <screen>
1438 &rootprompt;<userinput>cp samba.schema /etc/openldap/schema/</userinput>
1439 </screen>
1440                 </para>
1441
1442                 <para>
1443 <indexterm><primary>samba.schema</primary></indexterm>
1444 <indexterm><primary>slapd.conf</primary></indexterm>
1445 <indexterm><primary>sambaSamAccount</primary></indexterm>
1446 <indexterm><primary>cosine.schema</primary></indexterm>
1447 <indexterm><primary>uid</primary></indexterm>
1448 <indexterm><primary>inetorgperson.schema</primary></indexterm>
1449 <indexterm><primary>displayName</primary></indexterm>
1450 <indexterm><primary>attribute</primary></indexterm>
1451                 Next, include the <filename>samba.schema</filename> file in <filename>slapd.conf</filename>.
1452                 The sambaSamAccount object contains two attributes that depend on other schema
1453                 files. The <parameter>uid</parameter> attribute is defined in <filename>cosine.schema</filename> and
1454                 the <parameter>displayName</parameter> attribute is defined in the <filename>inetorgperson.schema</filename>
1455                 file. Both of these must be included before the <filename>samba.schema</filename> file.
1456 <programlisting>
1457 ## /etc/openldap/slapd.conf
1458
1459 ## schema files (core.schema is required by default)
1460 include            /etc/openldap/schema/core.schema
1461
1462 ## needed for sambaSamAccount
1463 include            /etc/openldap/schema/cosine.schema
1464 include            /etc/openldap/schema/inetorgperson.schema
1465 include            /etc/openldap/schema/nis.schema
1466 include            /etc/openldap/schema/samba.schema
1467 ....
1468 </programlisting>
1469                 </para>
1470
1471                 <para>
1472 <indexterm><primary>sambaSamAccount</primary></indexterm>
1473 <indexterm><primary>posixAccount</primary></indexterm>
1474 <indexterm><primary>posixGroup</primary></indexterm>
1475 <indexterm><primary>ObjectClasses</primary></indexterm>
1476                 It is recommended that you maintain some indices on some of the most useful attributes,
1477                 as in the following example, to speed up searches made on sambaSamAccount ObjectClasses
1478                 (and possibly posixAccount and posixGroup as well):
1479                 </para>
1480
1481 <para>
1482 <programlisting>
1483 # Indices to maintain
1484 ## required by OpenLDAP
1485 index objectclass             eq
1486
1487 index cn                      pres,sub,eq
1488 index sn                      pres,sub,eq
1489 ## required to support pdb_getsampwnam
1490 index uid                     pres,sub,eq
1491 ## required to support pdb_getsambapwrid()
1492 index displayName             pres,sub,eq
1493
1494 ## uncomment these if you are storing posixAccount and
1495 ## posixGroup entries in the directory as well
1496 ##index uidNumber               eq
1497 ##index gidNumber               eq
1498 ##index memberUid               eq
1499
1500 index   sambaSID              eq
1501 index   sambaPrimaryGroupSID  eq
1502 index   sambaDomainName       eq
1503 index   default               sub
1504 </programlisting>
1505 </para>
1506
1507                 <para>
1508                 Create the new index by executing:
1509 <screen>
1510 &rootprompt;./sbin/slapindex -f slapd.conf
1511 </screen>
1512                 </para>
1513
1514                 <para>
1515                 Remember to restart slapd after making these changes:
1516 <screen>
1517 &rootprompt;<userinput>/etc/init.d/slapd restart</userinput>
1518 </screen>
1519                 </para>
1520
1521                 </sect3>
1522
1523                 <sect3>
1524                 <title>Initialize the LDAP Database</title>
1525
1526                 <para>
1527 <indexterm><primary>LDAP database</primary></indexterm>
1528 <indexterm><primary>account containers</primary></indexterm>
1529 <indexterm><primary>LDIF file</primary></indexterm>
1530 <indexterm><primary>DNS</primary></indexterm>
1531                 Before you can add accounts to the LDAP database, you must create the account containers
1532                 that they will be stored in. The following LDIF file should be modified to match your
1533                 needs (DNS entries, and so on):
1534 <programlisting>
1535 # Organization for Samba Base
1536 dn: dc=quenya,dc=org
1537 objectclass: dcObject
1538 objectclass: organization
1539 dc: quenya
1540 o: Quenya Org Network
1541 description: The Samba-3 Network LDAP Example
1542
1543 # Organizational Role for Directory Management
1544 dn: cn=Manager,dc=quenya,dc=org
1545 objectclass: organizationalRole
1546 cn: Manager
1547 description: Directory Manager
1548
1549 # Setting up container for Users OU
1550 dn: ou=People,dc=quenya,dc=org
1551 objectclass: top
1552 objectclass: organizationalUnit
1553 ou: People
1554
1555 # Setting up admin handle for People OU
1556 dn: cn=admin,ou=People,dc=quenya,dc=org
1557 cn: admin
1558 objectclass: top
1559 objectclass: organizationalRole
1560 objectclass: simpleSecurityObject
1561 userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz
1562
1563 # Setting up container for groups
1564 dn: ou=Groups,dc=quenya,dc=org
1565 objectclass: top
1566 objectclass: organizationalUnit
1567 ou: Groups
1568
1569 # Setting up admin handle for Groups OU
1570 dn: cn=admin,ou=Groups,dc=quenya,dc=org
1571 cn: admin
1572 objectclass: top
1573 objectclass: organizationalRole
1574 objectclass: simpleSecurityObject
1575 userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz
1576
1577 # Setting up container for computers
1578 dn: ou=Computers,dc=quenya,dc=org
1579 objectclass: top
1580 objectclass: organizationalUnit
1581 ou: Computers
1582
1583 # Setting up admin handle for Computers OU
1584 dn: cn=admin,ou=Computers,dc=quenya,dc=org
1585 cn: admin
1586 objectclass: top
1587 objectclass: organizationalRole
1588 objectclass: simpleSecurityObject
1589 userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz
1590 </programlisting>
1591                 </para>
1592
1593                 <para>
1594 <indexterm><primary>userPassword</primary></indexterm>
1595 <indexterm><primary>slappasswd</primary></indexterm>
1596                 The userPassword shown above should be generated using <command>slappasswd</command>.
1597                 </para>
1598
1599                 <para>
1600 <indexterm><primary>LDIF</primary></indexterm>
1601 <indexterm><primary>LDAP</primary></indexterm>
1602                 The following command will then load the contents of the LDIF file into the LDAP
1603                 database.
1604 <indexterm><primary>slapadd</primary></indexterm>
1605 <screen>
1606 &prompt;<userinput>slapadd -v -l initldap.dif</userinput>
1607 </screen>
1608                 </para>
1609
1610                 <para>
1611                 Do not forget to secure your LDAP server with an adequate access control list
1612                 as well as an admin password.
1613                 </para>
1614
1615                 <note><para>
1616 <indexterm><primary>secrets.tdb</primary></indexterm>
1617                 Before Samba can access the LDAP server, you need to store the LDAP admin password
1618                 in the Samba-3 <filename>secrets.tdb</filename> database by:
1619 <indexterm><primary>smbpasswd</primary></indexterm>
1620 <screen>
1621 &rootprompt;<userinput>smbpasswd -w <replaceable>secret</replaceable></userinput>
1622 </screen>
1623                 </para></note>
1624
1625                 </sect3>
1626
1627                 <sect3>
1628                 <title>Configuring Samba</title>
1629
1630                         <para>
1631 <indexterm><primary>LDAP</primary></indexterm>
1632 <indexterm><primary>smbd</primary></indexterm>
1633                         The following parameters are available in &smb.conf; only if your version of Samba was built with
1634                         LDAP support. Samba automatically builds with LDAP support if the LDAP libraries are found. The
1635                         best method to verify that Samba was built with LDAP support is:
1636 <screen>
1637 &rootprompt; smbd -b | grep LDAP
1638    HAVE_LDAP_H
1639    HAVE_LDAP
1640    HAVE_LDAP_DOMAIN2HOSTLIST
1641    HAVE_LDAP_INIT
1642    HAVE_LDAP_INITIALIZE
1643    HAVE_LDAP_SET_REBIND_PROC
1644    HAVE_LIBLDAP
1645    LDAP_SET_REBIND_PROC_ARGS
1646 </screen>
1647                         If the build of the <command>smbd</command> command you are using does not produce output
1648                         that includes <literal>HAVE_LDAP_H</literal> it is necessary to discover why the LDAP headers
1649                         and libraries were not found during compilation.
1650                         </para>
1651
1652                         <para>LDAP-related smb.conf options include these:
1653                         <smbconfblock>
1654                         <smbconfoption name="passdb backend">ldapsam:url</smbconfoption>
1655                         <smbconfoption name="ldap admin dn"/>
1656                         <smbconfoption name="ldap delete dn"/>
1657                         <smbconfoption name="ldap filter"/>
1658                         <smbconfoption name="ldap group suffix"/>
1659                         <smbconfoption name="ldap idmap suffix"/>
1660                         <smbconfoption name="ldap machine suffix"/>
1661                         <smbconfoption name="ldap passwd sync"/>
1662                         <smbconfoption name="ldap ssl"/>
1663                         <smbconfoption name="ldap suffix"/>
1664                         <smbconfoption name="ldap user suffix"/>
1665                         <smbconfoption name="ldap replication sleep"/>
1666                         <smbconfoption name="ldap timeout"/>
1667                         <smbconfoption name="ldap page size"/>
1668                         </smbconfblock>
1669                         </para>
1670
1671                         <para>
1672                         These are described in the &smb.conf; man page and so are not repeated here. However, an example
1673                         for use with an LDAP directory is shown in <link linkend="confldapex">the Configuration with LDAP.</link>
1674                         </para>
1675
1676 <example id="confldapex">
1677 <title>Configuration with LDAP</title>
1678 <smbconfblock>
1679 <smbconfsection name="[global]"/>
1680 <smbconfoption name="security">user</smbconfoption>
1681 <smbconfoption name="encrypt passwords">yes</smbconfoption>
1682 <smbconfoption name="netbios name">MORIA</smbconfoption>
1683 <smbconfoption name="workgroup">NOLDOR</smbconfoption>
1684
1685 <smbconfcomment>LDAP related parameters:</smbconfcomment>
1686
1687 <smbconfcomment>Define the DN used when binding to the LDAP servers.</smbconfcomment>
1688 <smbconfcomment>The password for this DN is not stored in smb.conf</smbconfcomment>
1689 <smbconfcomment>Set it using 'smbpasswd -w secret' to store the</smbconfcomment>
1690 <smbconfcomment>passphrase in the secrets.tdb file.</smbconfcomment>
1691 <smbconfcomment>If the "ldap admin dn" value changes, it must be reset.</smbconfcomment>
1692 <smbconfoption name="ldap admin dn">"cn=Manager,dc=quenya,dc=org"</smbconfoption>
1693
1694 <smbconfcomment>SSL directory connections can be configured by:</smbconfcomment>
1695 <smbconfcomment>('off', 'start tls', or 'on' (default))</smbconfcomment>
1696 <smbconfoption name="ldap ssl">start tls</smbconfoption>
1697
1698 <smbconfcomment>syntax: passdb backend = ldapsam:ldap://server-name[:port]</smbconfcomment>
1699 <smbconfoption name="passdb backend">ldapsam:ldap://frodo.quenya.org</smbconfoption>
1700
1701 <smbconfcomment>smbpasswd -x delete the entire dn-entry</smbconfcomment>
1702 <smbconfoption name="ldap delete dn">no</smbconfoption>
1703
1704 <smbconfcomment>The machine and user suffix are added to the base suffix</smbconfcomment>
1705 <smbconfcomment>wrote WITHOUT quotes. NULL suffixes by default</smbconfcomment>
1706 <smbconfoption name="ldap user suffix">ou=People</smbconfoption>
1707 <smbconfoption name="ldap group suffix">ou=Groups</smbconfoption>
1708 <smbconfoption name="ldap machine suffix">ou=Computers</smbconfoption>
1709
1710 <smbconfcomment>Trust UNIX account information in LDAP</smbconfcomment>
1711 <smbconfcomment> (see the smb.conf man page for details)</smbconfcomment>
1712
1713 <smbconfcomment>Specify the base DN to use when searching the directory</smbconfcomment>
1714 <smbconfoption name="ldap suffix">dc=quenya,dc=org</smbconfoption>
1715 </smbconfblock>
1716 </example>
1717
1718                 </sect3>
1719
1720                 <sect3>
1721                 <title>Accounts and Groups Management</title>
1722
1723                         <para>
1724                         <indexterm><primary>User Management</primary></indexterm>
1725                         <indexterm><primary>User Accounts</primary><secondary>Adding/Deleting</secondary></indexterm>
1726                         Because user accounts are managed through the sambaSamAccount ObjectClass, you should
1727                         modify your existing administration tools to deal with sambaSamAccount attributes.
1728                         </para>
1729
1730                         <para>
1731 <indexterm><primary>sambaSamAccount</primary></indexterm>
1732 <indexterm><primary>/etc/openldap/sldap.conf</primary></indexterm>
1733 <indexterm><primary>NSS</primary></indexterm>
1734                         Machine accounts are managed with the sambaSamAccount ObjectClass, just
1735                         like user accounts. However, it is up to you to store those accounts
1736                         in a different tree of your LDAP namespace. You should use
1737                         <quote>ou=Groups,dc=quenya,dc=org</quote> to store groups and
1738                         <quote>ou=People,dc=quenya,dc=org</quote> to store users. Just configure your
1739                         NSS and PAM accordingly (usually, in the <filename>/etc/openldap/sldap.conf</filename>
1740                         configuration file).
1741                         </para>
1742
1743                         <para>
1744 <indexterm><primary>POSIX</primary></indexterm>
1745 <indexterm><primary>posixGroup</primary></indexterm>
1746 <indexterm><primary>Domain Groups</primary></indexterm>
1747 <indexterm><primary>ADS</primary></indexterm>
1748                         In Samba-3, the group management system is based on POSIX
1749                         groups. This means that Samba makes use of the posixGroup ObjectClass.
1750                         For now, there is no NT-like group system management (global and local
1751                         groups). Samba-3 knows only about <constant>Domain Groups</constant>
1752                         and, unlike MS Windows 2000 and Active Directory, Samba-3 does not
1753                         support nested groups.
1754                         </para>
1755
1756                 </sect3>
1757
1758                 <sect3>
1759                 <title>Security and sambaSamAccount</title>
1760
1761
1762                         <para>
1763 <indexterm><primary>sambaSAMAccount</primary></indexterm>
1764                         There are two important points to remember when discussing the security
1765                         of sambaSAMAccount entries in the directory.
1766                         </para>
1767
1768                         <itemizedlist>
1769                                 <listitem><para><emphasis>Never</emphasis> retrieve the SambaLMPassword or
1770 <indexterm><primary>SambaNTPassword</primary></indexterm>
1771                                 SambaNTPassword attribute values over an unencrypted LDAP session.</para></listitem>
1772                                 <listitem><para><emphasis>Never</emphasis> allow non-admin users to
1773                                 view the SambaLMPassword or SambaNTPassword attribute values.</para></listitem>
1774                         </itemizedlist>
1775
1776                         <para>
1777 <indexterm><primary>clear-text</primary></indexterm>
1778 <indexterm><primary>impersonate</primary></indexterm>
1779 <indexterm><primary>LM/NT password hashes</primary></indexterm>
1780                         These password hashes are clear-text equivalents and can be used to impersonate
1781                         the user without deriving the original clear-text strings. For more information
1782                         on the details of LM/NT password hashes, refer to <link linkend="passdb">the
1783                         Account Information Database section</link>.
1784                         </para>
1785
1786                         <para>
1787 <indexterm><primary>encrypted session</primary></indexterm>
1788 <indexterm><primary>StartTLS</primary></indexterm>
1789 <indexterm><primary>LDAPS</primary></indexterm>
1790 <indexterm><primary>secure communications</primary></indexterm>
1791                         To remedy the first security issue, the <smbconfoption name="ldap ssl"/> &smb.conf;
1792                         parameter defaults to require an encrypted session (<smbconfoption name="ldap
1793                         ssl">on</smbconfoption>) using the default port of <constant>636</constant> when
1794                         contacting the directory server. When using an OpenLDAP server, it
1795                         is possible to use the StartTLS LDAP extended operation in the place of LDAPS.
1796                         In either case, you are strongly encouraged to use secure communications protocols
1797                         (so do not set <smbconfoption name="ldap ssl">off</smbconfoption>).
1798                         </para>
1799
1800                         <para>
1801 <indexterm><primary>LDAPS</primary></indexterm>
1802 <indexterm><primary>StartTLS</primary></indexterm>
1803 <indexterm><primary>LDAPv3</primary></indexterm>
1804                         Note that the LDAPS protocol is deprecated in favor of the LDAPv3 StartTLS
1805                         extended operation. However, the OpenLDAP library still provides support for
1806                         the older method of securing communication between clients and servers.
1807                         </para>
1808
1809                         <para>
1810 <indexterm><primary>harvesting password hashes</primary></indexterm>
1811 <indexterm><primary>ACL</primary></indexterm>
1812 <indexterm><primary>slapd.conf</primary></indexterm>
1813                         The second security precaution is to prevent non-administrative users from
1814                         harvesting password hashes from the directory. This can be done using the
1815                         following ACL in <filename>slapd.conf</filename>:
1816                         </para>
1817
1818 <para>
1819 <programlisting>
1820 ## allow the "ldap admin dn" access, but deny everyone else
1821 access to attrs=SambaLMPassword,SambaNTPassword
1822      by dn="cn=Samba Admin,ou=People,dc=quenya,dc=org" write
1823      by * none
1824 </programlisting>
1825 </para>
1826
1827                 </sect3>
1828
1829                 <sect3>
1830                 <title>LDAP Special Attributes for sambaSamAccounts</title>
1831
1832                         <para> The sambaSamAccount ObjectClass is composed of the attributes shown in next tables: <link
1833                         linkend="attribobjclPartA">Part A</link>, and <link linkend="attribobjclPartB">Part B</link>.
1834                         </para>
1835
1836                         <table frame="all" id="attribobjclPartA">
1837                                 <title>Attributes in the sambaSamAccount ObjectClass (LDAP), Part A</title>
1838                         <tgroup cols="2" align="justify">
1839                                         <colspec align="left"/>
1840                                         <colspec align="justify" colwidth="1*"/>
1841                         <tbody>
1842                                 <row><entry><constant>sambaLMPassword</constant></entry><entry>The LanMan password 16-byte hash stored as a character
1843                                                 representation of a hexadecimal string.</entry></row>
1844                                 <row><entry><constant>sambaNTPassword</constant></entry><entry>The NT password 16-byte hash stored as a character
1845                                                 representation of a hexadecimal string.</entry></row>
1846                                 <row><entry><constant>sambaPwdLastSet</constant></entry><entry>The integer time in seconds since 1970 when the
1847                                                 <constant>sambaLMPassword</constant> and <constant>sambaNTPassword</constant> attributes were last set.
1848                                 </entry></row>
1849
1850                                 <row><entry><constant>sambaAcctFlags</constant></entry><entry>String of 11 characters surrounded by square brackets [ ]
1851                                                 representing account flags such as U (user), W (workstation), X (no password expiration),
1852                                                 I (domain trust account), H (home dir required), S (server trust account),
1853                                                 and D (disabled).</entry></row>
1854
1855                                 <row><entry><constant>sambaLogonTime</constant></entry><entry>Integer value currently unused.</entry></row>
1856
1857                                 <row><entry><constant>sambaLogoffTime</constant></entry><entry>Integer value currently unused.</entry></row>
1858
1859                                 <row><entry><constant>sambaKickoffTime</constant></entry><entry>Specifies the time (UNIX time format) when the user
1860                                 will be locked down and cannot login any longer. If this attribute is omitted, then the account will never expire.
1861                                 Using this attribute together with shadowExpire of the shadowAccount ObjectClass will enable accounts to
1862                                 expire completely on an exact date.</entry></row>
1863
1864                                 <row><entry><constant>sambaPwdCanChange</constant></entry><entry>Specifies the time (UNIX time format)
1865                                 after which the user is allowed to change his password. If attribute is not set, the user will be free
1866                                 to change his password whenever he wants.</entry></row>
1867
1868                                 <row><entry><constant>sambaPwdMustChange</constant></entry><entry>Specifies the time (UNIX time format) when the user is
1869                                 forced to change his password. If this value is set to 0, the user will have to change his password at first login.
1870                                 If this attribute is not set, then the password will never expire.</entry></row>
1871
1872                                 <row><entry><constant>sambaHomeDrive</constant></entry><entry>Specifies the drive letter to which to map the
1873                                 UNC path specified by sambaHomePath. The drive letter must be specified in the form <quote>X:</quote>
1874                                 where X is the letter of the drive to map. Refer to the <quote>logon drive</quote> parameter in the
1875                                 smb.conf(5) man page for more information.</entry></row>
1876
1877                                 <row><entry><constant>sambaLogonScript</constant></entry><entry>The sambaLogonScript property specifies the path of
1878                                 the user's logon script, .CMD, .EXE, or .BAT file. The string can be null. The path
1879                                 is relative to the netlogon share. Refer to the <smbconfoption name="logon script"/> parameter in the
1880                                 &smb.conf; man page for more information.</entry></row>
1881
1882                                 <row><entry><constant>sambaProfilePath</constant></entry><entry>Specifies a path to the user's profile.
1883                                 This value can be a null string, a local absolute path, or a UNC path. Refer to the
1884                                 <smbconfoption name="logon path"/> parameter in the &smb.conf; man page for more information.</entry></row>
1885
1886                                 <row><entry><constant>sambaHomePath</constant></entry><entry>The sambaHomePath property specifies the path of
1887                                 the home directory for the user. The string can be null. If sambaHomeDrive is set and specifies
1888                                 a drive letter, sambaHomePath should be a UNC path. The path must be a network
1889                                 UNC path of the form <filename>\\server\share\directory</filename>. This value can be a null string.
1890                                 Refer to the <command>logon home</command> parameter in the &smb.conf; man page for more information.
1891                                 </entry></row>
1892                         </tbody>
1893                         </tgroup></table>
1894
1895
1896                         <table frame="all" id="attribobjclPartB">
1897                                 <title>Attributes in the sambaSamAccount ObjectClass (LDAP), Part B</title>
1898                         <tgroup cols="2" align="justify">
1899                                         <colspec align="left"/>
1900                                         <colspec align="justify" colwidth="1*"/>
1901                         <tbody>
1902                                 <row><entry><constant>sambaUserWorkstations</constant></entry><entry>Here you can give a comma-separated list of machines
1903                                 on which the user is allowed to login. You may observe problems when you try to connect to a Samba domain member.
1904                                 Because domain members are not in this list, the domain controllers will reject them. Where this attribute is omitted,
1905                                 the default implies no restrictions.
1906                                 </entry></row>
1907
1908                                 <row><entry><constant>sambaSID</constant></entry><entry>The security identifier(SID) of the user.
1909                                 The Windows equivalent of UNIX UIDs.</entry></row>
1910
1911                                 <row><entry><constant>sambaPrimaryGroupSID</constant></entry><entry>The security identifier (SID) of the primary group
1912                                 of the user.</entry></row>
1913
1914                                 <row><entry><constant>sambaDomainName</constant></entry><entry>Domain the user is part of.</entry></row>
1915                         </tbody>
1916                         </tgroup></table>
1917
1918
1919                         <para>
1920 <indexterm><primary>PDC</primary></indexterm>
1921 <indexterm><primary>sambaSamAccount</primary></indexterm>
1922                         The majority of these parameters are only used when Samba is acting as a PDC of
1923                         a domain (refer to <link linkend="samba-pdc">Domain Control</link>, for details on
1924                         how to configure Samba as a PDC). The following four attributes
1925                         are only stored with the sambaSamAccount entry if the values are non-default values:
1926                         </para>
1927
1928                         <itemizedlist>
1929 <indexterm><primary>sambaHomePath</primary></indexterm>
1930 <indexterm><primary>sambaLogonScript</primary></indexterm>
1931 <indexterm><primary>sambaProfilePath</primary></indexterm>
1932 <indexterm><primary>sambaHomeDrive</primary></indexterm>
1933                                 <listitem><para>sambaHomePath</para></listitem>
1934                                 <listitem><para>sambaLogonScript</para></listitem>
1935                                 <listitem><para>sambaProfilePath</para></listitem>
1936                                 <listitem><para>sambaHomeDrive</para></listitem>
1937                         </itemizedlist>
1938
1939                         <para>
1940 <indexterm><primary>sambaSamAccount</primary></indexterm>
1941 <indexterm><primary>PDC</primary></indexterm>
1942 <indexterm><primary>smbHome</primary></indexterm>
1943                         These attributes are only stored with the sambaSamAccount entry if
1944                         the values are non-default values. For example, assume MORIA has now been
1945                         configured as a PDC and that <smbconfoption name="logon home">\\%L\%u</smbconfoption> was defined in
1946                         its &smb.conf; file. When a user named <quote>becky</quote> logs on to the domain,
1947                         the <smbconfoption name="logon home"/> string is expanded to \\MORIA\becky.
1948                         If the smbHome attribute exists in the entry <quote>uid=becky,ou=People,dc=samba,dc=org</quote>,
1949                         this value is used. However, if this attribute does not exist, then the value
1950                         of the <smbconfoption name="logon home"/> parameter is used in its place. Samba
1951                         will only write the attribute value to the directory entry if the value is
1952                         something other than the default (e.g., <filename>\\MOBY\becky</filename>).
1953                         </para>
1954
1955                 </sect3>
1956
1957                 <sect3>
1958                 <title>Example LDIF Entries for a sambaSamAccount</title>
1959
1960                         <para>
1961                         The following is a working LDIF that demonstrates the use of the SambaSamAccount ObjectClass:
1962 <programlisting>
1963 dn: uid=guest2, ou=People,dc=quenya,dc=org
1964 sambaLMPassword: 878D8014606CDA29677A44EFA1353FC7
1965 sambaPwdMustChange: 2147483647
1966 sambaPrimaryGroupSID: S-1-5-21-2447931902-1787058256-3961074038-513
1967 sambaNTPassword: 552902031BEDE9EFAAD3B435B51404EE
1968 sambaPwdLastSet: 1010179124
1969 sambaLogonTime: 0
1970 objectClass: sambaSamAccount
1971 uid: guest2
1972 sambaKickoffTime: 2147483647
1973 sambaAcctFlags: [UX         ]
1974 sambaLogoffTime: 2147483647
1975 sambaSID: S-1-5-21-2447931902-1787058256-3961074038-5006
1976 sambaPwdCanChange: 0
1977 </programlisting>
1978                         </para>
1979
1980                         <para>
1981                         The following is an LDIF entry for using both the sambaSamAccount and
1982                         posixAccount ObjectClasses:
1983 <programlisting>
1984 dn: uid=gcarter, ou=People,dc=quenya,dc=org
1985 sambaLogonTime: 0
1986 displayName: Gerald Carter
1987 sambaLMPassword: 552902031BEDE9EFAAD3B435B51404EE
1988 sambaPrimaryGroupSID: S-1-5-21-2447931902-1787058256-3961074038-1201
1989 objectClass: posixAccount
1990 objectClass: sambaSamAccount
1991 sambaAcctFlags: [UX         ]
1992 userPassword: {crypt}BpM2ej8Rkzogo
1993 uid: gcarter
1994 uidNumber: 9000
1995 cn: Gerald Carter
1996 loginShell: /bin/bash
1997 logoffTime: 2147483647
1998 gidNumber: 100
1999 sambaKickoffTime: 2147483647
2000 sambaPwdLastSet: 1010179230
2001 sambaSID: S-1-5-21-2447931902-1787058256-3961074038-5004
2002 homeDirectory: /home/moria/gcarter
2003 sambaPwdCanChange: 0
2004 sambaPwdMustChange: 2147483647
2005 sambaNTPassword: 878D8014606CDA29677A44EFA1353FC7
2006 </programlisting>
2007                 </para>
2008
2009                 </sect3>
2010
2011                 <sect3>
2012                 <title>Password Synchronization</title>
2013
2014                 <para>
2015                 Samba-3 and later can update the non-Samba (LDAP) password stored with an account. When
2016                 using pam_ldap, this allows changing both UNIX and Windows passwords at once.
2017                 </para>
2018
2019                 <para>The <smbconfoption name="ldap passwd sync"/> options can have the  values shown in
2020                 <link linkend="ldappwsync">Possible <emphasis>ldap passwd sync</emphasis> Values</link>.</para>
2021
2022                 <table frame="all" id="ldappwsync">
2023                 <title>Possible <parameter>ldap passwd sync</parameter> Values</title>
2024                 <tgroup cols="2">
2025                         <colspec align="left" colwidth="1*"/>
2026                         <colspec align="justify" colwidth="4*"/>
2027                 <thead>
2028                         <row><entry align="left">Value</entry><entry align="center">Description</entry></row>
2029                 </thead>
2030                 <tbody>
2031                 <row><entry>yes</entry><entry><para>When the user changes his password, update
2032                                <constant>SambaNTPassword</constant>, <constant>SambaLMPassword</constant>,
2033                                and the <constant>password</constant> fields.</para></entry></row>
2034
2035                 <row><entry>no</entry><entry><para>Only update <constant>SambaNTPassword</constant> and
2036                                         <constant>SambaLMPassword</constant>.</para></entry></row>
2037
2038                 <row><entry>only</entry><entry><para>Only update the LDAP password and let the LDAP server
2039                         worry about the other fields.  This option is only available on some LDAP servers and
2040                         only when the LDAP server supports LDAP_EXOP_X_MODIFY_PASSWD.</para></entry></row>
2041                 </tbody>
2042                 </tgroup>
2043                 </table>
2044
2045
2046                 <para>More information can be found in the &smb.conf; man page.</para>
2047
2048                 </sect3>
2049
2050         </sect2>
2051
2052         <sect2>
2053         <title>MySQL</title>
2054
2055         <para>
2056         <indexterm><primary>SAM backend</primary><secondary>mysqlsam</secondary></indexterm>
2057 <indexterm><primary>SQL backend</primary></indexterm>
2058         Every so often someone comes along with what seems to them like a great new idea. Storing user accounts
2059         in a SQL backend is one of them. Those who want to do this are in the best position to know what the
2060         specific benefits are to them. This may sound like a cop-out, but in truth we cannot document
2061         every little detail of why certain things of marginal utility to the bulk of Samba users might make sense
2062         to the rest. In any case, the following instructions should help the determined SQL user to implement a
2063         working system. These account storage methods are not actively maintained by the Samba Team.
2064         </para>
2065
2066                 <sect3>
2067                 <title>Creating the Database</title>
2068
2069                         <para>
2070 <indexterm><primary>MySQL</primary></indexterm>
2071                         You can set up your own table and specify the field names to pdb_mysql (see
2072                         <link linkend="moremysqlpdbe">MySQL field names for MySQL passdb backend</link> for
2073                         the column names) or use the default table. The file
2074                         <filename>examples/pdb/mysql/mysql.dump</filename> contains the correct queries to
2075                         create the required tables. Use the command:
2076 <screen>
2077 &rootprompt;<userinput>mysql -u<replaceable>username</replaceable> -h<replaceable>hostname</replaceable> -p<replaceable>password</replaceable> \
2078         <replaceable>databasename</replaceable> &lt; <filename>/path/to/samba/examples/pdb/mysql/mysql.dump</filename></userinput>
2079 </screen>
2080                         </para>
2081                 </sect3>
2082
2083                 <sect3>
2084                 <title>Configuring</title>
2085
2086                         <para>This plug-in lacks some good documentation, but here is some brief information. Add the following to the
2087                         <smbconfoption name="passdb backend"/> variable in your &smb.conf;:
2088 <smbconfblock>
2089 <smbconfoption name="passdb backend">[other-plugins] mysql:identifier [other-plugins]</smbconfoption>
2090 </smbconfblock>
2091                         </para>
2092
2093                         <para>The identifier can be any string you like, as long as it does not collide with
2094                         the identifiers of other plugins or other instances of pdb_mysql. If you
2095                         specify multiple pdb_mysql.so entries in <smbconfoption name="passdb backend"/>, you also need to
2096                         use different identifiers.
2097                         </para>
2098
2099                         <para>
2100                         Additional options can be given through the &smb.conf; file in the <smbconfsection name="[global]"/> section.
2101                         Refer to <link linkend="mysqlpbe">Basic smb.conf Options for MySQL passdb Backend</link>.
2102                         </para>
2103
2104                         <table frame="all" id="mysqlpbe">
2105                                 <title>Basic smb.conf Options for MySQL passdb Backend</title>
2106                                 <tgroup cols="2">
2107                                         <colspec align="left"/>
2108                                         <colspec align="justify" colwidth="1*"/>
2109                                 <thead>
2110                                         <row><entry>Field</entry><entry>Contents</entry></row>
2111                                 </thead>
2112                                 <tbody>
2113                                         <row><entry>mysql host</entry><entry>Host name, defaults to `localhost'</entry></row>
2114                                         <row><entry>mysql password</entry><entry></entry></row>
2115                                         <row><entry>mysql user</entry><entry>Defaults to `samba'</entry></row>
2116                                         <row><entry>mysql database</entry><entry>Defaults to `samba'</entry></row>
2117                                         <row><entry>mysql port</entry><entry>Defaults to 3306</entry></row>
2118                                         <row><entry>table</entry><entry>Name of the table containing the users</entry></row>
2119                                 </tbody>
2120                                 </tgroup>
2121                         </table>
2122
2123                         <warning>
2124                         <para>
2125                         Since the password for the MySQL user is stored in the &smb.conf; file, you should make the &smb.conf; file
2126                         readable only to the user who runs Samba. This is considered a security bug and will soon be fixed.
2127                         </para>
2128                         </warning>
2129
2130                         <para>Names of the columns are given in <link linkend="moremysqlpdbe">MySQL field names for MySQL
2131                         passdb backend</link>.  The default column names can be found in the example table dump.
2132                          </para>
2133
2134                 <para>
2135                         <table frame="all" id="moremysqlpdbe">
2136                                 <title>MySQL field names for MySQL passdb backend</title>
2137                                 <tgroup cols="3" align="justify">
2138                                         <colspec align="left"/>
2139                                         <colspec align="left"/>
2140                                         <colspec align="justify" colwidth="1*"/>
2141                         <thead>
2142                                 <row><entry>Field</entry><entry>Type</entry><entry>Contents</entry></row>
2143                         </thead>
2144                         <tbody>
2145                                 <row><entry>logon time column</entry><entry>int(9)</entry><entry>UNIX timestamp of last logon of user</entry></row>
2146                                 <row><entry>logoff time column</entry><entry>int(9)</entry><entry>UNIX timestamp of last logoff of user</entry></row>
2147                                 <row><entry>kickoff time column</entry><entry>int(9)</entry><entry>UNIX timestamp of moment user should be kicked off workstation (not enforced)</entry></row>
2148                                 <row><entry>pass last set time column</entry><entry>int(9)</entry><entry>UNIX timestamp of moment password was last set</entry></row>
2149                                 <row><entry>pass can change time column</entry><entry>int(9)</entry><entry>UNIX timestamp of moment from which password can be changed</entry></row>
2150                                 <row><entry>pass must change time column</entry><entry>int(9)</entry><entry>UNIX timestamp of moment on which password must be changed</entry></row>
2151                                 <row><entry>username column</entry><entry>varchar(255)</entry><entry>UNIX username</entry></row>
2152                                 <row><entry>domain column</entry><entry>varchar(255)</entry><entry>NT domain user belongs to</entry></row>
2153                                 <row><entry>nt username column</entry><entry>varchar(255)</entry><entry>NT username</entry></row>
2154                                 <row><entry>fullname column</entry><entry>varchar(255)</entry><entry>Full name of user</entry></row>
2155                                 <row><entry>home dir column</entry><entry>varchar(255)</entry><entry>UNIX homedir path (equivalent of the <smbconfoption name="logon home"/> parameter.</entry></row>
2156                                 <row><entry>dir drive column</entry><entry>varchar(2)</entry><entry>Directory drive path (e.g., <quote>H:</quote>)</entry></row>
2157                                 <row><entry>logon script column</entry><entry>varchar(255)</entry><entry>Batch file to run on client side when logging on</entry></row>
2158                                 <row><entry>profile path column</entry><entry>varchar(255)</entry><entry>Path of profile</entry></row>
2159                                 <row><entry>acct desc column</entry><entry>varchar(255)</entry><entry>Some ASCII NT user data</entry></row>
2160                                 <row><entry>workstations column</entry><entry>varchar(255)</entry><entry>Workstations user can logon to (or NULL for all)</entry></row>
2161                                 <row><entry>unknown string column</entry><entry>varchar(255)</entry><entry>Unknown string</entry></row>
2162                                 <row><entry>munged dial column</entry><entry>varchar(255)</entry><entry>Unknown</entry></row>
2163                                 <row><entry>user sid column</entry><entry>varchar(255)</entry><entry>NT user SID</entry></row>
2164                                 <row><entry>group sid column</entry><entry>varchar(255)</entry><entry>NT group SID</entry></row>
2165                                 <row><entry>lanman pass column</entry><entry>varchar(255)</entry><entry>Encrypted lanman password</entry></row>
2166                                 <row><entry>nt pass column</entry><entry>varchar(255)</entry><entry>Encrypted nt passwd</entry></row>
2167                                 <row><entry>plain pass column</entry><entry>varchar(255)</entry><entry>Plaintext password</entry></row>
2168                                 <row><entry>acct ctrl column</entry><entry>int(9)</entry><entry>NT user data</entry></row>
2169                                 <row><entry>unknown 3 column</entry><entry>int(9)</entry><entry>Unknown</entry></row>
2170                                 <row><entry>logon divs column</entry><entry>int(9)</entry><entry>Unknown</entry></row>
2171                                 <row><entry>hours len column</entry><entry>int(9)</entry><entry>Unknown</entry></row>
2172                                 <row><entry>bad password count column</entry><entry>int(5)</entry><entry>Number of failed password tries before disabling an account</entry></row>
2173                                 <row><entry>logon count column</entry><entry>int(5)</entry><entry>Number of logon attempts</entry></row>
2174                                 <row><entry>unknown 6 column</entry><entry>int(9)</entry><entry>Unknown</entry></row>
2175                         </tbody></tgroup>
2176                 </table>
2177                 </para>
2178
2179                         <para>
2180                         You can put a colon (:) after the name of each column, which
2181                         should specify the column to update when updating the table. You can also specify nothing behind the colon, in which case the field data will not be updated. Setting a column name to <parameter>NULL</parameter> means the field should not be used.
2182                         </para>
2183
2184                         <para><link linkend="mysqlsam">An example configuration</link> is shown in <link
2185                         linkend="mysqlsam">Example Configuration for the MySQL passdb Backend</link>.
2186                         </para>
2187
2188                         <example id="mysqlsam">
2189                         <title>Example Configuration for the MySQL passdb Backend</title>
2190                         <smbconfblock>
2191                         <smbconfsection name="[global]"/>
2192                         <smbconfoption name="passdb backend">mysql:foo</smbconfoption>
2193                         <smbconfoption name="foo:mysql user">samba</smbconfoption>
2194                         <smbconfoption name="foo:mysql password">abmas</smbconfoption>
2195                         <smbconfoption name="foo:mysql database">samba</smbconfoption>
2196                         <smbconfcomment>domain name is static and can't be changed</smbconfcomment>
2197                         <smbconfoption name="foo:domain column">'MYWORKGROUP':</smbconfoption>
2198                         <smbconfcomment>The fullname column comes from several other columns</smbconfcomment>
2199                         <smbconfoption name="foo:fullname column">CONCAT(firstname,' ',surname):</smbconfoption>
2200                         <smbconfcomment>Samba should never write to the password columns</smbconfcomment>
2201                         <smbconfoption name="foo:lanman pass column">lm_pass:</smbconfoption>
2202                         <smbconfoption name="foo:nt pass column">nt_pass:</smbconfoption>
2203                         <smbconfcomment>The unknown 3 column is not stored</smbconfcomment>
2204                         <smbconfoption name="foo:unknown 3 column">NULL</smbconfoption>
2205                         </smbconfblock>
2206                         </example>
2207                 </sect3>
2208
2209                 <sect3>
2210                 <title>Using Plaintext Passwords or Encrypted Password</title>
2211
2212                         <para>
2213 <indexterm><primary>encrypted passwords</primary></indexterm>
2214                         I strongly discourage the use of plaintext passwords; however, you can use them.
2215                         </para>
2216
2217                         <para>
2218 <indexterm><primary>plaintext passwords</primary></indexterm>
2219                         If you would like to use plaintext passwords, set
2220                         `identifier:lanman pass column' and `identifier:nt pass column' to
2221                         `NULL' (without the quotes) and `identifier:plain pass column' to the
2222                         name of the column containing the plaintext passwords.
2223                         </para>
2224
2225                         <para>
2226                         If you use encrypted passwords, set the 'identifier:plain pass
2227                         column' to 'NULL' (without the quotes). This is the default.
2228                         </para>
2229
2230                 </sect3>
2231
2232                 <sect3>
2233                 <title>Getting Non-Column Data from the Table</title>
2234
2235                         <para>
2236                         It is possible to have not all data in the database by making some "constant."
2237                         </para>
2238
2239                         <para>
2240                         For example, you can set `identifier:fullname column' to
2241                         something like <?latex \linebreak ?><command>CONCAT(Firstname,' ',Surname)</command>
2242                         </para>
2243
2244                         <para>
2245                         Or, set `identifier:workstations column' to:
2246                         <command>NULL</command></para>.
2247
2248                         <para>See the MySQL documentation for more language constructs.</para>
2249
2250                 </sect3>
2251         </sect2>
2252
2253         <sect2 id="XMLpassdb">
2254         <title>XML</title>
2255
2256         <para>
2257 <indexterm><primary>SAM backend</primary><secondary>xmlsam</secondary></indexterm>
2258 <indexterm><primary>libxml2</primary></indexterm>
2259 <indexterm><primary>pdb_xml</primary></indexterm>
2260                 This module requires libxml2 to be installed.</para>
2261
2262                 <para>The usage of pdb_xml is fairly straightforward. To export data, use:
2263                 </para>
2264
2265                 <para>
2266 <indexterm><primary>pdbedit</primary></indexterm>
2267                         <prompt>$ </prompt> <userinput>pdbedit -e xml:filename</userinput>
2268                 </para>
2269
2270                 <para>
2271                 where filename is the name of the file to put the data in.
2272                 </para>
2273
2274                 <para>
2275                 To import data, use:
2276                 <prompt>$ </prompt> <userinput>pdbedit -i xml:filename</userinput>
2277                 </para>
2278         </sect2>
2279 </sect1>
2280
2281 <sect1>
2282 <title>Common Errors</title>
2283
2284         <sect2>
2285                 <title>Users Cannot Logon</title>
2286
2287                 <para><quote>I've installed Samba, but now I can't log on with my UNIX account! </quote></para>
2288
2289                 <para>Make sure your user has been added to the current Samba <smbconfoption name="passdb backend"/>.
2290                 Read the <link linkend="acctmgmttools">Account Management Tools,</link> for details.</para>
2291
2292         </sect2>
2293
2294         <sect2>
2295         <title>Users Being Added to the Wrong Backend Database</title>
2296
2297         <para>
2298         A few complaints have been received from users who just moved to Samba-3. The following
2299         &smb.conf; file entries were causing problems: new accounts were being added to the old
2300         smbpasswd file, not to the tdbsam passdb.tdb file:
2301         </para>
2302
2303         <para>
2304         <smbconfblock>
2305         <smbconfsection name="[global]"/>
2306         <member>...</member>
2307         <smbconfoption name="passdb backend">smbpasswd, tdbsam</smbconfoption>
2308         <member>...</member>
2309         </smbconfblock>
2310         </para>
2311
2312         <para>
2313         Samba will add new accounts to the first entry in the <emphasis>passdb backend</emphasis>
2314         parameter entry. If you want to update to the tdbsam, then change the entry to:
2315         </para>
2316
2317         <para>
2318 <smbconfblock>
2319 [globals]
2320 ...
2321 <smbconfoption name="passdb backend">tdbsam, smbpasswd</smbconfoption>
2322 ...
2323 </smbconfblock>
2324         </para>
2325
2326         </sect2>
2327
2328         <sect2>
2329         <title>Configuration of <parameter>auth methods</parameter></title>
2330
2331         <para>
2332         When explicitly setting an <smbconfoption name="auth methods"/> parameter,
2333         <parameter>guest</parameter> must be specified as the first entry on the line &smbmdash;
2334         for example, <smbconfoption name="auth methods">guest sam</smbconfoption>.
2335         </para>
2336
2337         </sect2>
2338
2339 </sect1>
2340
2341 </chapter>