75d46af33b4d2b2786faceb8e6bdb312779efef2
[gd/samba/.git] / docs / docbook / projdoc / passdb.xml
1 <chapter id="passdb">
2 <chapterinfo>
3         &author.jelmer;
4         &author.jerry;
5         &author.jeremy;
6         &author.jht;
7         <author>
8                 <firstname>Olivier (lem)</firstname><surname>Lemaire</surname>
9                 <affiliation>
10                         <orgname>IDEALX</orgname>
11                         <address><email>olem@IDEALX.org</email></address>
12                 </affiliation>
13         </author>
14         
15         <pubdate>May 24, 2003</pubdate>
16 </chapterinfo>
17 <title>Account Information Databases</title>
18
19 <para>
20 Samba 3 implements a new capability to work concurrently with multiple account backends.
21 The possible new combinations of password backends allows Samba 3 a degree of flexibility
22 and scalability that previously could be achieved only with MS Windows Active Directory.
23 This chapter describes the new functionality and how to get the most out of it.
24 </para>
25
26 <para>
27 In the course of development of Samba-3, a number of requests were received to provide the
28 ability to migrate MS Windows NT4 SAM accounts to Samba-3 without the need to provide
29 matching UNIX/Linux accounts. We called this the <emphasis>Non UNIX Accounts (NUA)</emphasis>
30 capability. The intent was that an administrator could decide to use the <emphasis>tdbsam</emphasis>
31 backend and by simply specifying <smbconfoption><name>passdb backend</name><value>tdbsam_nua</value></smbconfoption>
32 this would allow Samba-3 to implement a solution that did not use UNIX accounts per se. Late
33 in the development cycle, the team doing this work hit upon some obstacles that prevents this
34 solution from being used. Given the delays with Samba-3 release a decision was made to NOT
35 deliver this functionality until a better method of recognising NT Group SIDs from NT User
36 SIDs could be found. This feature may thus return during the life cycle for the Samba-3 series.
37 </para>
38
39 <note><para>
40 Samba-3 does NOT support Non-UNIX Account (NUA) operation for user accounts.
41 Samba-3 does support NUA operation for machine accounts.
42 </para></note>
43
44 <sect1>
45 <title>Features and Benefits</title>
46
47 <para>
48 Samba-3 provides for complete backwards compatibility with Samba-2.2.x functionality
49 as follows:
50 </para>
51
52 <sect2>
53         <title>Backwards Compatibility Backends</title>
54
55 <variablelist>
56         <varlistentry><term>Plain Text:</term>
57                 <listitem>
58                         <para>
59                         This option uses nothing but the UNIX/Linux <filename>/etc/passwd</filename>
60                         style back end. On systems that have PAM (Pluggable Authentication Modules)
61                         support all PAM modules are supported. The behaviour is just as it was with
62                         Samba-2.2.x, and the protocol limitations imposed by MS Windows clients
63                         apply likewise.
64                         </para>
65                 </listitem>
66         </varlistentry>
67
68         <varlistentry><term>smbpasswd:</term>
69                 <listitem>
70                         <para>
71                         This option allows continues use of the <filename>smbpasswd</filename>
72                         file that maintains a plain ASCII (text) layout that includes the MS Windows
73                         LanMan and NT encrypted passwords as well as a field that stores some
74                         account information. This form of password backend does NOT store any of
75                         the MS Windows NT/200x SAM (Security Account Manager) information needed to
76                         provide the extended controls that are needed for more comprehensive 
77                         interoperation with MS Windows NT4 / 200x servers.
78                         </para>
79
80                         <para>
81                         This backend should be used only for backwards compatibility with older
82                         versions of Samba. It may be deprecated in future releases.
83                         </para>
84                 </listitem>
85         </varlistentry>
86
87         <varlistentry><term>ldapsam_compat (Samba-2.2 LDAP Compatibility):</term>
88                 <listitem>
89                         <para>
90                         There is a password backend option that allows continued operation with
91                         a existing OpenLDAP backend that uses the Samba-2.2.x LDAP schema extension.
92                         This option is provided primarily as a migration tool, although there is
93                         no reason to force migration at this time. Note that this tool will eventually
94                         be deprecated.
95                         </para>
96                 </listitem>
97         </varlistentry>
98 </variablelist>
99
100 </sect2>
101
102 <sect2>
103         <title>New Backends</title>
104
105 <para>
106 Samba-3 introduces the following new password backend capabilities:
107 </para>
108
109
110
111 <variablelist>
112         <varlistentry><term>tdbsam:</term>
113                 <listitem>
114                         <para>
115                         This backend provides a rich database backend for local servers. This
116                         backend is NOT suitable for multiple domain controller (ie: PDC + one
117                         or more BDC) installations.
118                         </para>
119
120                         <para>
121                         The <emphasis>tdbsam</emphasis> password backend stores the old <emphasis>
122                         smbpasswd</emphasis> information PLUS the extended MS Windows NT / 200x
123                         SAM information into a binary format TDB (trivial database) file.
124                         The inclusion of the extended information makes it possible for Samba-3
125                         to implement the same account and system access controls that are possible
126                         with MS Windows NT4 and MS Windows 200x based systems.
127                         </para>
128
129                         <para>
130                         The inclusion of the <emphasis>tdbsam</emphasis> capability is a direct
131                         response to user requests to allow simple site operation without the overhead
132                         of the complexities of running OpenLDAP. It is recommended to use this only
133                         for sites that have fewer than 250 users. For larger sites or implementations
134                         the use of OpenLDAP or of Active Directory integration is strongly recommended.
135                         </para>
136                 </listitem>
137         </varlistentry>
138
139         <varlistentry><term>ldapsam:</term>
140                 <listitem>
141                         <para>
142                         This provides a rich directory backend for distributed account installation.    
143                         </para>
144
145                         <para>
146                         Samba-3 has a new and extended LDAP implementation that requires configuration
147                         of OpenLDAP with a new format samba schema. The new format schema file is
148                         included in the <filename class="directory">examples/LDAP</filename> directory of the Samba distribution.
149                         </para>
150
151                         <para>
152                         The new LDAP implementation significantly expands the control abilities that
153                         were possible with prior versions of Samba. It is now possible to specify
154                         "per user" profile settings, home directories, account access controls, and
155                         much more. Corporate sites will see that the Samba-Team has listened to their
156                         requests both for capability and to allow greater scalability.
157                         </para>
158                 </listitem>
159         </varlistentry>
160
161         <varlistentry><term>mysqlsam (MySQL based backend):</term>
162                 <listitem>
163                         <para>
164                         It is expected that the MySQL based SAM will be very popular in some corners.
165                         This database backend will be on considerable interest to sites that want to
166                         leverage existing MySQL technology.
167                         </para>
168                 </listitem>
169         </varlistentry>
170
171         <varlistentry><term>xmlsam (XML based datafile):</term>
172                 <listitem>
173                         <para>
174                         Allows the account and password data to be stored in an XML format
175                         data file. This backend can not be used for normal operation, it can only 
176                         be used in conjunction with <command>pdbedit</command>'s pdb2pdb 
177                         functionality. The DTD that is used might be subject to changes in the future.
178                         </para>
179
180                         <para>
181                         The xmlsam option can be useful for account migration between database
182                         backends or backups. Use of this tool will allow the data to be edited before migration
183                         into another backend format.
184                         </para>
185                 </listitem>
186         </varlistentry>
187
188 </variablelist>
189
190 </sect2>
191
192 </sect1>
193
194 <sect1>
195         <title>Technical Information</title>
196
197         <para>
198         Old windows clients send plain text passwords over the wire. Samba can check these
199         passwords by crypting them and comparing them to the hash stored in the unix user database.
200         </para>
201         
202         <para>
203         Newer windows clients send encrypted passwords (so-called Lanman and NT hashes) over 
204         the wire, instead of plain text passwords. The newest clients will send only encrypted
205         passwords and refuse to send plain text passwords, unless their registry is tweaked.
206         </para>
207
208         <para>
209         These passwords can't be converted to unix style encrypted passwords. Because of that,
210         you can't use the standard unix user database, and you have to store the Lanman and NT
211         hashes somewhere else.
212         </para>
213         
214         <para>
215         In addition to differently encrypted passwords, windows also stores certain data for each
216         user that is not stored in a unix user database. e.g: workstations the user may logon from,
217         the location where the users' profile is stored, and so on. Samba retrieves and stores this
218         information using a <smbconfoption><name>passdb backend</name></smbconfoption>.  Commonly available backends are LDAP, plain text
219         file, MySQL and nisplus.  For more information, see the man page for &smb.conf; regarding the 
220         <smbconfoption><name>passdb backend</name></smbconfoption> parameter.
221         </para>
222
223
224         <figure id="idmap-diag"><title>IDMAP</title>
225         <mediaobject>
226         <imageobject role="latex"><imagedata fileref="projdoc/imagefiles/idmap" scale="50" scalefit="1"/></imageobject>
227         <imageobject><imagedata fileref="projdoc/imagefiles/idmap.png" scale="50" scalefit="1"/></imageobject>
228         </mediaobject>
229         </figure>
230
231         <sect2>
232         <title>Important Notes About Security</title>
233                 
234                 <para>
235                 The unix and SMB password encryption techniques seem similar on the surface. This
236                 similarity is, however, only skin deep. The unix scheme typically sends clear text
237                 passwords over the network when logging in. This is bad. The SMB encryption scheme
238                 never sends the cleartext password over the network but it does store the 16 byte 
239                 hashed values on disk. This is also bad. Why? Because the 16 byte hashed values
240                 are a "password equivalent". You cannot derive the user's password from them, but
241                 they could potentially be used in a modified client to gain access to a server.
242                 This would require considerable technical knowledge on behalf of the attacker but
243                 is perfectly possible. You should thus treat the data stored in whatever passdb
244                 backend you use (smbpasswd file, ldap, mysql) as though it contained the cleartext
245                 passwords of all your users. Its contents must be kept secret, and the file should
246                 be protected accordingly.
247                 </para>
248                 
249                 <para>
250                 Ideally we would like a password scheme that involves neither plain text passwords
251                 on the net nor on disk. Unfortunately this is not available as Samba is stuck with
252                 having to be compatible with other SMB systems (WinNT, WfWg, Win95 etc).
253                 </para>
254
255                 <para>
256                 Windows NT 4.0 Service pack 3 changed the default setting so that plaintext passwords
257                 are disabled from being sent over the wire. This mandates either the use of encrypted
258                 password support or edit the Windows NT registry to re-enable plaintext passwords.
259                 </para>
260                 
261                 <para>
262                 The following versions of MS Windows do not support full domain security protocols,
263                 although they may log onto a domain environment:
264                 </para>
265
266                 <itemizedlist>
267                         <listitem><para>MS DOS Network client 3.0 with the basic network redirector installed</para></listitem>
268                         <listitem><para>Windows 95 with the network redirector update installed</para></listitem>
269                         <listitem><para>Windows 98 [se]</para></listitem>
270                         <listitem><para>Windows Me</para></listitem>
271                 </itemizedlist>
272
273                 <note>
274                 <para>
275                 MS Windows XP Home does not have facilities to become a domain member and it can
276                 not participate in domain logons.
277                 </para>
278                 </note>
279
280                 <para>
281                 The following versions of MS Windows fully support domain security protocols.
282                 </para>
283
284                 <itemizedlist>
285                         <listitem><para>Windows NT 3.5x</para></listitem>
286                         <listitem><para>Windows NT 4.0</para></listitem>
287                         <listitem><para>Windows 2000 Professional</para></listitem>
288                         <listitem><para>Windows 200x Server/Advanced Server</para></listitem>
289                         <listitem><para>Windows XP Professional</para></listitem>
290                 </itemizedlist>
291                         
292                 <para>
293                 All current release of Microsoft SMB/CIFS clients support authentication via the
294                 SMB Challenge/Response mechanism described here. Enabling clear text authentication
295                 does not disable the ability of the client to participate in encrypted authentication.
296                 Instead, it allows the client to negotiate either plain text _or_ encrypted password
297                 handling.
298                 </para>
299
300                 <para>
301                 MS Windows clients will cache the encrypted password alone. Where plain text passwords
302                 are re-enabled, through the appropriate registry change, the plain text password is NEVER
303                 cached. This means that in the event that a network connections should become disconnected
304                 (broken) only the cached (encrypted) password will be sent to the resource server to
305                 affect a auto-reconnect. If the resource server does not support encrypted passwords the
306                 auto-reconnect will fail. <emphasis>USE OF ENCRYPTED PASSWORDS IS STRONGLY ADVISED.</emphasis>
307                 </para>
308
309                 <sect3>
310                 <title>Advantages of Encrypted Passwords</title>
311
312                         <itemizedlist>
313                                 <listitem><para>Plain text passwords are not passed across 
314                                 the network. Someone using a network sniffer cannot just 
315                                 record passwords going to the SMB server.</para></listitem>
316
317                                 <listitem><para>Plain text passwords are not stored anywhere in
318                                 memory or on disk.</para></listitem>
319                          
320                                 <listitem><para>WinNT doesn't like talking to a server 
321                                 that does not support encrypted passwords. It will refuse 
322                                 to browse the server if the server is also in user level 
323                                 security mode. It will insist on prompting the user for the 
324                                 password on each connection, which is very annoying. The
325                                 only things you can do to stop this is to use SMB encryption.
326                                 </para></listitem>
327
328                                 <listitem><para>Encrypted password support allows automatic share
329                                 (resource) reconnects.</para></listitem>
330
331                                 <listitem><para>Encrypted passwords are essential for PDC/BDC
332                                 operation.</para></listitem>
333                         </itemizedlist>
334                 </sect3>
335
336
337                 <sect3>
338                 <title>Advantages of non-encrypted passwords</title>
339
340                         <itemizedlist>
341                                 <listitem><para>Plain text passwords are not kept 
342                                 on disk, and are NOT cached in memory. </para></listitem>
343                                 
344                                 <listitem><para>Uses same password file as other unix 
345                                 services such as login and ftp</para></listitem>
346                                 
347                                 <listitem><para>Use of other services (such as telnet and ftp) which
348                                 send plain text passwords over the net, so sending them for SMB
349                                 isn't such a big deal.</para></listitem>
350                         </itemizedlist>
351                 </sect3>
352         </sect2>
353
354         <sect2>
355         <title>Mapping User Identifiers between MS Windows and UNIX</title>
356
357         <para>
358         Every operation in UNIX/Linux requires a user identifier (UID), just as in
359         MS Windows NT4 / 200x this requires a Security Identifier (SID). Samba provides
360         two means for mapping an MS Windows user to a UNIX/Linux UID.
361         </para>
362
363         <para>
364         Firstly, all Samba SAM (Security Account Manager database) accounts require
365         a UNIX/Linux UID that the account will map to. As users are added to the account
366         information database, Samba will call the <smbconfoption><name>add user script</name></smbconfoption>
367         interface to add the account to the Samba host OS. In essence all accounts in
368         the local SAM require a local user account.
369         </para>
370
371         <para>
372         The second way to affect Windows SID to UNIX UID mapping is via the
373         <emphasis>idmap uid, idmap gid</emphasis> parameters in &smb.conf;.
374         Please refer to the man page for information about these parameters.
375         These parameters are essential when mapping users from a remote SAM server.
376         </para>
377
378         </sect2>
379
380         <sect2 id="idmapbackend">
381         <title>Mapping Common UIDs/GIDs on Distributed Machines</title>
382
383         <para>
384         Samba-3 has a special facility that makes it possible to maintain identical UIDs and GIDs
385         on all servers in a distributed network. A distributed network is one where there exists
386         a PDC, one or more BDCs and/or one or more domain member servers. Why is this important?
387         This is important if files are being shared over more than one protocol (eg: NFS) and where
388         users are copying files across UNIX/Linux systems using tools such as <command>rsync</command>.
389         </para>
390
391         <para>
392         The special facility is enabled using a parameter called <parameter>idmap backend</parameter>.
393         The default setting for this parameter is an empty string. Administrators should NOT set this
394         parameter except when an LDAP based passdb backend is in use. An example of use is:
395         </para>
396
397         <para>
398 <smbconfexample id="idmapbackendexample">
399 <smbconfsection>[global]</smbconfsection>
400 <smbconfoption><name>idmap backend</name><value>ldapsam://ldap-server.quenya.org:636</value></smbconfoption>
401 </smbconfexample>
402         </para>
403
404         </sect2>
405 </sect1>
406
407 <sect1 id="acctmgmttools">
408 <title>Account Management Tools</title>
409
410 <para>
411 Samba provides two (2) tools for management of User and machine accounts. These tools are
412 called <command>smbpasswd</command> and <command>pdbedit</command>. A third tool is under
413 development but is NOT expected to ship in time for Samba-3.0.0. The new tool will be a TCL/TK
414 GUI tool that looks much like the MS Windows NT4 Domain User Manager - hopefully this will
415 be announced in time for the Samba-3.0.1 release.
416 </para>
417         <sect2>
418         <title>The <emphasis>smbpasswd</emphasis> Command</title>
419         
420                 <para>
421                 The smbpasswd utility is a utility similar to the <command>passwd</command>
422                 or <command>yppasswd</command> programs.  It maintains the two 32 byte password
423                 fields in the passdb backend.
424                 </para>
425
426                 <para>
427                 <command>smbpasswd</command> works in a client-server mode where it contacts the
428                 local smbd to change the user's password on its behalf. This has enormous benefits
429                 as follows:
430                 </para>
431
432                 <para>
433                 <command>smbpasswd</command> has the capability to change passwords on Windows NT
434                 servers (this only works when the request is sent to the NT Primary Domain Controller
435                 if changing an NT Domain user's password).
436                 </para>
437
438                 <para>
439                 <command>smbpasswd</command> can be used to:
440                 </para>
441                 
442                 <itemizedlist>
443                         <listitem><para><emphasis>add</emphasis> user or machine accounts</para></listitem>
444                         <listitem><para><emphasis>delete</emphasis> user or machine accounts</para></listitem>
445                         <listitem><para><emphasis>enable</emphasis> user or machine accounts</para></listitem>
446                         <listitem><para><emphasis>disable</emphasis> user or machine accounts</para></listitem>
447                         <listitem><para><emphasis>set to NULL</emphasis> user passwords</para></listitem>
448                         <listitem><para><emphasis>manage interdomain trust accounts</emphasis></para></listitem>
449                 </itemizedlist>
450                 
451                 <para>
452                 To run smbpasswd as a normal user just type:
453                 </para>
454                 
455                 <para>
456 <screen>
457 &prompt;<userinput>smbpasswd</userinput>
458 <prompt>Old SMB password: </prompt><userinput><replaceable>secret</replaceable></userinput>
459 </screen>
460                 For <replaceable>secret</replaceable> type old value here - or hit return if
461                 there was no old password
462 <screen>
463 <prompt>New SMB Password: </prompt><userinput><replaceable>new secret</replaceable></userinput>
464 <prompt>Repeat New SMB Password: </prompt><userinput><replaceable>new secret</replaceable></userinput>
465 </screen>
466                 </para>
467                 
468                 <para>
469                 If the old value does not match the current value stored for that user, or the two
470                 new values do not match each other, then the password will not be changed.
471                 </para>
472                 
473                 <para>
474                 When invoked by an ordinary user it will only allow change of their own
475                 SMB password.
476                 </para>
477                 
478                 <para>
479                 When run by root smbpasswd may take an optional argument, specifying
480                 the user name whose SMB password you wish to change. When run as root, smbpasswd
481                 does not prompt for or check the old password value, thus allowing root to set passwords 
482                 for users who have forgotten their passwords.
483                 </para>
484                 
485                 <para>
486                 <command>smbpasswd</command> is designed to work in the way familiar to UNIX
487                 users who use the <command>passwd</command> or <command>yppasswd</command> commands.
488                 While designed for administrative use, this tool provides essential user level
489                 password change capabilities.
490                 </para>
491
492                 <para>
493                 For more details on using <command>smbpasswd</command> refer to the man page (the
494                 definitive reference).
495                 </para>
496         </sect2>
497
498         <sect2>
499         <title>The <emphasis>pdbedit</emphasis> Command</title>
500
501                 <para>
502                 <command>pdbedit</command> is a tool that can be used only by root. It is used to
503                 manage the passdb backend. <command>pdbedit</command> can be used to:
504                 </para>
505
506                 <itemizedlist>
507                         <listitem><para>add, remove or modify user accounts</para></listitem>
508                         <listitem><para>listing user accounts</para></listitem>
509                         <listitem><para>migrate user accounts</para></listitem>
510                 </itemizedlist>
511
512                 <para>
513                 The <command>pdbedit</command> tool is the only one that can manage the account
514                 security and policy settings. It is capable of all operations that smbpasswd can
515                 do as well as a super set of them.
516                 </para>
517
518                 <para>
519                 One particularly important purpose of the <command>pdbedit</command> is to allow
520                 the migration of account information from one passdb backend to another. See the
521                 <link linkend="XMLpassdb">XML</link> password backend section of this chapter.
522                 </para>
523
524                 <para>
525                 The following is an example of the user account information that is stored in
526                 a tdbsam password backend. This listing was produced by running:
527                 </para>
528
529 <screen>
530 &prompt;<userinput>pdbedit -Lv met</userinput>
531 UNIX username:        met
532 NT username:
533 Account Flags:        [UX         ]
534 User SID:             S-1-5-21-1449123459-1407424037-3116680435-2004
535 Primary Group SID:    S-1-5-21-1449123459-1407424037-3116680435-1201
536 Full Name:            Melissa E Terpstra
537 Home Directory:       \\frodo\met\Win9Profile
538 HomeDir Drive:        H:
539 Logon Script:         scripts\logon.bat
540 Profile Path:         \\frodo\Profiles\met
541 Domain:               &example.workgroup;
542 Account desc:
543 Workstations:         melbelle
544 Munged dial:
545 Logon time:           0
546 Logoff time:          Mon, 18 Jan 2038 20:14:07 GMT
547 Kickoff time:         Mon, 18 Jan 2038 20:14:07 GMT
548 Password last set:    Sat, 14 Dec 2002 14:37:03 GMT
549 Password can change:  Sat, 14 Dec 2002 14:37:03 GMT
550 Password must change: Mon, 18 Jan 2038 20:14:07 GMT
551 </screen>
552
553                 <para>
554                 The <command>pdbedit</command> tool allows migration of authentication (account)
555                 databases from one backend to another. For example: To migrate accounts from an
556                 old <filename>smbpasswd</filename> database to a <parameter>tdbsam</parameter>
557                 backend:
558                 </para>
559
560                 <procedure>
561                         <step><para>
562                         Set the <smbconfoption><name>passdb backend</name><value>tdbsam, smbpasswd</value></smbconfoption>.
563                         </para></step>
564
565                         <step><para>
566                         Execute:
567 <screen>
568 &rootprompt;<userinput>pdbedit -i smbpassed -e tdbsam</userinput>
569 </screen>
570                         </para></step>
571
572                         <step><para>
573                         Now remove the <parameter>smbpasswd</parameter> from the passdb backend
574                         configuration in &smb.conf;.
575                         </para></step>
576                 </procedure>
577
578         </sect2>
579 </sect1>
580
581 <sect1>
582 <title>Password Backends</title>
583
584 <para>
585 Samba offers the greatest flexibility in backend account database design of any SMB/CIFS server
586 technology available today. The flexibility is immediately obvious as one begins to explore this
587 capability.
588 </para>
589
590 <para>
591 It is possible to specify not only multiple different password backends, but even multiple
592 backends of the same type. For example, to use two different tdbsam databases:
593 </para>
594
595 <para>
596 <smbconfblock>
597 <smbconfoption><name>passdb backend</name><value>tdbsam:/etc/samba/passdb.tdb, tdbsam:/etc/samba/old-passdb.tdb</value></smbconfoption>
598 </smbconfblock>
599 </para>
600
601
602         <sect2>
603         <title>Plain Text</title>
604
605                 <para>
606                 Older versions of Samba retrieved user information from the unix user database 
607                 and eventually some other fields from the file <filename>/etc/samba/smbpasswd</filename>
608                 or <filename>/etc/smbpasswd</filename>. When password encryption is disabled, no 
609                 SMB specific data is stored at all. Instead all operations are conducted via the way
610                 that the Samba host OS will access its <filename>/etc/passwd</filename> database.
611                 eg: On Linux systems that is done via PAM.
612                 </para>
613
614         </sect2>
615
616         <sect2>
617         <title>smbpasswd - Encrypted Password Database</title>
618
619                 <para>
620                 Traditionally, when configuring <smbconfoption><name>encrypt passwords</name><value>yes</value></smbconfoption> in Samba's &smb.conf; file, user account
621                 information such as username, LM/NT password hashes, password change times, and account
622                 flags have been stored in the <filename>smbpasswd(5)</filename> file.  There are several
623                 disadvantages to this approach for sites with very large numbers of users (counted
624                 in the thousands).
625                 </para>
626
627                 <itemizedlist>
628                 <listitem><para>
629                 The first is that all lookups must be performed sequentially.  Given that
630                 there are approximately two lookups per domain logon (one for a normal
631                 session connection such as when mapping a network drive or printer), this
632                 is a performance bottleneck for large sites.  What is needed is an indexed approach
633                 such as is used in databases.
634                 </para></listitem>
635
636                 <listitem><para>
637                 The second problem is that administrators who desire to replicate a smbpasswd file
638                 to more than one Samba server were left to use external tools such as
639                 <command>rsync(1)</command> and <command>ssh(1)</command> and wrote custom,
640                 in-house scripts.
641                 </para></listitem>
642
643                 <listitem><para>
644                 And finally, the amount of information which is stored in an smbpasswd entry leaves
645                 no room for additional attributes such as a home directory, password expiration time,
646                 or even a Relative Identifier (RID).
647                 </para></listitem>
648                 </itemizedlist>
649
650                 <para>
651                 As a result of these deficiencies, a more robust means of storing user attributes
652                 used by smbd was developed.  The API which defines access to user accounts
653                 is commonly referred to as the samdb interface (previously this was called the passdb
654                 API, and is still so named in the Samba CVS trees). 
655                 </para>
656
657                 <para>
658                 Samba provides an enhanced set of passdb backends that overcome the deficiencies
659                 of the smbpasswd plain text database. These are tdbsam, ldapsam, and xmlsam.
660                 Of these ldapsam will be of most interest to large corporate or enterprise sites.
661                 </para>
662
663         </sect2>
664
665         <sect2>
666         <title>tdbsam</title>
667
668                 <para>Samba can store user and machine account data in a "TDB" (Trivial Database).
669                 Using this backend doesn't require any additional configuration. This backend is
670                 recommended for new installations that do not require LDAP.
671                 </para>
672
673                 <para>
674                 As a general guide the Samba-Team does NOT recommend using the tdbsam backend for sites
675                 that have 250 or more users. Additionally, tdbsam is not capable of scaling for use
676                 in sites that require PDB/BDC implementations that requires replication of the account
677                 database. Clearly, for reason of scalability, the use of ldapsam should be encouraged.
678                 </para>
679
680         </sect2>
681
682         <sect2>
683         <title>ldapsam</title>
684
685                 <para>
686                 There are a few points to stress that the ldapsam does not provide. The LDAP
687                 support referred to in the this documentation does not include:
688                 </para>
689
690                 <itemizedlist>
691                         <listitem><para>A means of retrieving user account information from
692                         an Windows 200x Active Directory server.</para></listitem>
693                         <listitem><para>A means of replacing /etc/passwd.</para></listitem>
694                 </itemizedlist>
695
696                 <para>
697                 The second item can be accomplished by using LDAP NSS and PAM modules.  LGPL
698                 versions of these libraries can be obtained from PADL Software
699                 (<ulink noescape="1" url="http://www.padl.com/">http://www.padl.com/</ulink>). More
700                 information about the configuration of these packages may be found at "LDAP,
701                 System Administration; Gerald Carter, O'Reilly; Chapter 6: Replacing NIS".
702                 Refer to <ulink noescape="1" url="http://safari.oreilly.com/?XmlId=1-56592-491-6">
703                 http://safari.oreilly.com/?XmlId=1-56592-491-6</ulink> for those who might wish to know
704                 more about configuration and administration of an OpenLDAP server.
705                 </para>
706
707                 <para>
708                 This document describes how to use an LDAP directory for storing Samba user
709                 account information traditionally stored in the smbpasswd(5) file.  It is
710                 assumed that the reader already has a basic understanding of LDAP concepts
711                 and has a working directory server already installed.  For more information
712                 on LDAP architectures and Directories, please refer to the following sites.
713                 </para>
714
715                 <itemizedlist>
716                         <listitem><para>OpenLDAP - <ulink noescape="1" url="http://www.openldap.org/">http://www.openldap.org/</ulink></para></listitem>
717                         <listitem><para>iPlanet Directory Server -
718                                         <ulink noescape="1" url="http://iplanet.netscape.com/directory">http://iplanet.netscape.com/directory</ulink></para></listitem>
719                 </itemizedlist>
720
721                 <para>
722                 Two additional Samba resources which may prove to be helpful are
723                 </para>
724
725                 <itemizedlist>
726                         <listitem><para>The <ulink url="http://www.unav.es/cti/ldap-smb/ldap-smb-3-howto.html">Samba-PDC-LDAP-HOWTO</ulink>
727                         maintained by Ignacio Coupeau.</para></listitem>
728
729                         <listitem><para>The NT migration scripts from <ulink url="http://samba.idealx.org/">IDEALX</ulink> that are
730                         geared to manage users and group in such a Samba-LDAP Domain Controller configuration.
731                         </para></listitem>
732                 </itemizedlist>
733
734                 <sect3>
735                 <title>Supported LDAP Servers</title>
736
737                         <para>
738                         The LDAP ldapsam code has been developed and tested using the OpenLDAP 2.0 and 2.1 server and
739                         client libraries.  The same code should work with Netscape's Directory Server and client SDK.
740                         However, there are bound to be compile errors and bugs. These should not be hard to fix.
741                         Please submit fixes via <link linkend="bugreport">Bug reporting facility</link>.
742                         </para>
743
744                 </sect3>
745
746                 <sect3>
747                 <title>Schema and Relationship to the RFC 2307 posixAccount</title>
748
749
750                         <para>
751                         Samba 3.0 includes the necessary schema file for OpenLDAP 2.0 in
752                         <filename>examples/LDAP/samba.schema</filename>.  The sambaSamAccount objectclass is given here:
753                         </para>
754
755 <para>
756 <programlisting>
757 objectclass ( 1.3.6.1.4.1.7165.2.2.6 NAME 'sambaSamAccount' SUP top AUXILIARY
758     DESC 'Samba 3.0 Auxiliary SAM Account'
759     MUST ( uid $ sambaSID )
760     MAY  ( cn $ sambaLMPassword $ sambaNTPassword $ sambaPwdLastSet $
761           sambaLogonTime $ sambaLogoffTime $ sambaKickoffTime $
762           sambaPwdCanChange $ sambaPwdMustChange $ sambaAcctFlags $
763           displayName $ sambaHomePath $ sambaHomeDrive $ sambaLogonScript $
764           sambaProfilePath $ description $ sambaUserWorkstations $
765           sambaPrimaryGroupSID $ sambaDomainName ))
766 </programlisting>
767 </para>
768
769                         <para>
770                         The <filename>samba.schema</filename> file has been formatted for OpenLDAP 2.0/2.1.
771                         The OID's are owned by the Samba Team and as such is legal to be openly published.
772                         If you translate the schema to be used with Netscape DS, please
773                         submit the modified schema file as a patch to
774                         <ulink noescape="1" url="mailto:jerry@samba.org">jerry@samba.org</ulink>.
775                         </para>
776
777                         <para>
778                         Just as the smbpasswd file is meant to store information which supplements a
779                         user's <filename>/etc/passwd</filename> entry, so is the sambaSamAccount object
780                         meant to supplement the UNIX user account information.  A sambaSamAccount is a
781                         <constant>STRUCTURAL</constant> objectclass so it can be stored individually
782                         in the directory.  However, there are several fields (e.g. uid) which overlap
783                         with the posixAccount objectclass outlined in RFC2307.  This is by design.
784                         </para>
785
786                         <!--olem: we should perhaps have a note about shadowAccounts too as many
787                         systems use them, isn'it ? -->
788
789                         <para>
790                         In order to store all user account information (UNIX and Samba) in the directory,
791                         it is necessary to use the sambaSamAccount and posixAccount objectclasses in
792                         combination.  However, smbd will still obtain the user's UNIX account
793                         information via the standard C library calls (e.g. getpwnam(), et. al.).
794                         This means that the Samba server must also have the LDAP NSS library installed
795                         and functioning correctly.  This division of information makes it possible to
796                         store all Samba account information in LDAP, but still maintain UNIX account
797                         information in NIS while the network is transitioning to a full LDAP infrastructure.
798                         </para>
799                 </sect3>
800
801                 <sect3>
802                 <title>OpenLDAP configuration</title>
803
804                         <para>
805                         To include support for the sambaSamAccount object in an OpenLDAP directory
806                         server, first copy the samba.schema file to slapd's configuration directory.
807                         The samba.schema file can be found in the directory <filename>examples/LDAP</filename>
808                         in the samba source distribution.
809                         </para>
810
811 <para>
812 <screen>
813 &rootprompt;<userinput>cp samba.schema /etc/openldap/schema/</userinput>
814 </screen>
815 </para>
816
817                         <para>
818                         Next, include the <filename>samba.schema</filename> file in <filename>slapd.conf</filename>.
819                         The sambaSamAccount object contains two attributes which depend upon other schema
820                         files.  The 'uid' attribute is defined in <filename>cosine.schema</filename> and
821                         the 'displayName' attribute is defined in the <filename>inetorgperson.schema</filename>
822                         file.  Both of these must be included before the <filename>samba.schema</filename> file.
823                         </para>
824
825 <para>
826 <programlisting>
827 ## /etc/openldap/slapd.conf
828
829 ## schema files (core.schema is required by default)
830 include            /etc/openldap/schema/core.schema
831
832 ## needed for sambaSamAccount
833 include            /etc/openldap/schema/cosine.schema
834 include            /etc/openldap/schema/inetorgperson.schema
835 include            /etc/openldap/schema/samba.schema
836 include            /etc/openldap/schema/nis.schema
837 ....
838 </programlisting>
839 </para>
840
841                 <para>
842                 It is recommended that you maintain some indices on some of the most useful attributes,
843                 like in the following example, to speed up searches made on sambaSamAccount objectclasses
844                 (and possibly posixAccount and posixGroup as well).
845                 </para>
846
847 <para>
848 <programlisting>
849 # Indices to maintain
850 ## required by OpenLDAP
851 index objectclass             eq
852
853 index cn                      pres,sub,eq
854 index sn                      pres,sub,eq
855 ## required to support pdb_getsampwnam
856 index uid                     pres,sub,eq
857 ## required to support pdb_getsambapwrid()
858 index displayName             pres,sub,eq
859
860 ## uncomment these if you are storing posixAccount and
861 ## posixGroup entries in the directory as well
862 ##index uidNumber               eq
863 ##index gidNumber               eq
864 ##index memberUid               eq
865
866 index   sambaSID              eq
867 index   sambaPrimaryGroupSID  eq
868 index   sambaDomainName       eq
869 index   default               sub
870 </programlisting>
871 </para>
872
873                 <para>
874                 Create the new index by executing:
875                 </para>
876
877 <para>
878 <screen>
879 &rootprompt;./sbin/slapindex -f slapd.conf
880 </screen>
881 </para>
882
883                 <para>
884                 Remember to restart slapd after making these changes:
885                 </para>
886
887 <para>
888 <screen>
889 &rootprompt;<userinput>/etc/init.d/slapd restart</userinput>
890 </screen>
891 </para>
892
893                 </sect3>
894
895                 <sect3>
896                 <title>Initialise the LDAP database</title>
897
898                 <para>
899                 Before you can add accounts to the LDAP database you must create the account containers
900                 that they will be stored in. The following LDIF file should be modified to match your
901                 needs (ie: Your DNS entries, etc.).
902                 </para>
903                 
904 <para>
905 <programlisting>
906 # Organization for Samba Base
907 dn: dc=quenya,dc=org
908 objectclass: dcObject
909 objectclass: organization
910 dc: quenya
911 o: Quenya Org Network
912 description: The Samba-3 Network LDAP Example
913
914 # Organizational Role for Directory Management
915 dn: cn=Manager,dc=quenya,dc=org
916 objectclass: organizationalRole
917 cn: Manager
918 description: Directory Manager
919
920 # Setting up container for users
921 dn: ou=People,dc=quenya,dc=org
922 objectclass: top
923 objectclass: organizationalUnit
924 ou: People
925
926 # Setting up admin handle for People OU
927 dn: cn=admin,ou=People,dc=quenya,dc=org
928 cn: admin
929 objectclass: top
930 objectclass: organizationalRole
931 objectclass: simpleSecurityObject
932 userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz
933 </programlisting>
934 </para>
935
936                 <para>
937                 The userPassword shown above should be generated using <command>slappasswd</command>.
938                 </para>
939
940                 <para>
941                 The following command will then load the contents of the LDIF file into the LDAP
942                 database.
943                 </para>
944
945 <para>
946 <screen>
947 &prompt;<userinput>slapadd -v -l initldap.dif</userinput>
948 </screen>
949 </para>
950
951                 <para>
952                 Do not forget to secure your LDAP server with an adequate access control list,
953                 as well as an admin password.
954                 </para>
955
956                 <note>
957                 <para>
958                 Before Samba can access the LDAP server you need to store the LDAP admin password
959                 into the Samba-3 <filename>secrets.tdb</filename> database by:
960 <screen>
961 &rootprompt;<userinput>smbpasswd -w <replaceable>secret</replaceable></userinput>
962 </screen>
963                 </para>
964                 </note>
965
966                 </sect3>
967
968                 <sect3>
969                 <title>Configuring Samba</title>
970
971                         <para>
972                         The following parameters are available in smb.conf only if your
973                         version of samba was built with LDAP support. Samba automatically builds with LDAP support if the
974                         LDAP libraries are found.
975                         </para>
976
977                         <para>LDAP related smb.conf options: 
978                                 <smbconfoption><name>passdb backend</name><value>ldapsam:url</value></smbconfoption>,
979                         <smbconfoption><name>ldap ssl</name></smbconfoption>,
980                         <smbconfoption><name>ldap admin dn</name></smbconfoption>,
981                         <smbconfoption><name>ldap suffix</name></smbconfoption>,
982                         <smbconfoption><name>ldap filter</name></smbconfoption>,
983                         <smbconfoption><name>ldap machine suffix</name></smbconfoption>,
984                         <smbconfoption><name>ldap user suffix</name></smbconfoption>,
985                         <smbconfoption><name>ldap delete dn</name></smbconfoption>,
986                         <smbconfoption><name>ldap passwd sync</name></smbconfoption>,
987                         <smbconfoption><name>ldap trust ids</name></smbconfoption>.
988                 </para>
989
990                         <para>
991                         These are described in the &smb.conf; man
992                         page and so will not be repeated here.  However, a sample smb.conf file for
993                         use with an LDAP directory could appear as
994                         </para>
995
996 <para>
997 <smbconfexample>
998         <title>Configuration with LDAP</title>
999         <smbconfsection>[global]</smbconfsection>
1000 <smbconfoption><name>security</name><value>user</value></smbconfoption>
1001 <smbconfoption><name>encrypt passwords</name><value>yes</value></smbconfoption>
1002 <smbconfoption><name>netbios name</name><value>TASHTEGO</value></smbconfoption>
1003 <smbconfoption><name>workgroup</name><value>NARNIA</value></smbconfoption>
1004
1005 <smbconfcomment>ldap related parameters</smbconfcomment>
1006
1007 <smbconfcomment>define the DN to use when binding to the directory servers</smbconfcomment>
1008 <smbconfcomment>The password for this DN is not stored in smb.conf.  Rather it</smbconfcomment>
1009 <smbconfcomment>must be set by using 'smbpasswd -w <replaceable>secretpw</replaceable>' to store the</smbconfcomment>
1010 <smbconfcomment>passphrase in the secrets.tdb file.  If the "ldap admin dn" values</smbconfcomment>
1011 <smbconfcomment>change, this password will need to be reset.</smbconfcomment>
1012 <smbconfoption><name>ldap admin dn</name><value>"cn=Samba Manager,ou=people,dc=samba,dc=org"</value></smbconfoption>
1013
1014 <smbconfcomment>Define the SSL option when connecting to the directory</smbconfcomment>
1015 <smbconfcomment>('off', 'start tls', or 'on' (default))</smbconfcomment>
1016 <smbconfoption><name>ldap ssl</name><value>start tls</value></smbconfoption>
1017
1018 <smbconfcomment>syntax: passdb backend = ldapsam:ldap://server-name[:port]</smbconfcomment>
1019 <smbconfoption><name>passdb backend</name><value>ldapsam:ldap://funball.samba.org</value></smbconfoption>
1020
1021 <smbconfcomment>smbpasswd -x delete the entire dn-entry</smbconfcomment>
1022 <smbconfoption><name>ldap delete dn</name><value>no</value></smbconfoption>
1023
1024 <smbconfcomment>the machine and user suffix added to the base suffix</smbconfcomment>
1025 <smbconfcomment>wrote WITHOUT quotes. NULL suffixes by default</smbconfcomment>
1026 <smbconfoption><name>ldap user suffix</name><value>ou=People</value></smbconfoption>
1027 <smbconfoption><name>ldap machine suffix</name><value>ou=Systems</value></smbconfoption>
1028
1029 <smbconfcomment>Trust unix account information in LDAP</smbconfcomment>
1030 <smbconfcomment> (see the smb.conf manpage for details)</smbconfcomment>
1031 <smbconfoption><name>ldap trust ids</name><value>Yes</value></smbconfoption>
1032
1033 <smbconfcomment> specify the base DN to use when searching the directory</smbconfcomment>
1034 <smbconfoption><name>ldap suffix</name><value>ou=people,dc=samba,dc=org</value></smbconfoption>
1035
1036 <smbconfcomment> generally the default ldap search filter is ok</smbconfcomment>
1037 <smbconfoption><name>ldap filter</name><value>(&amp;(uid=%u)(objectclass=sambaSamAccount))</value></smbconfoption>
1038 </smbconfexample>
1039 </para>
1040
1041                 </sect3>
1042
1043                 <sect3>
1044                 <title>Accounts and Groups management</title>
1045
1046                         <para>
1047                         As users accounts are managed through the sambaSamAccount objectclass, you should
1048                         modify your existing administration tools to deal with sambaSamAccount attributes.
1049                         </para>
1050
1051                         <para>
1052                         Machines accounts are managed with the sambaSamAccount objectclass, just
1053                         like users accounts. However, it's up to you to store those accounts
1054                         in a different tree of your LDAP namespace: you should use
1055                         "ou=Groups,dc=quenya,dc=org" to store groups and
1056                         "ou=People,dc=quenya,dc=org" to store users. Just configure your
1057                         NSS and PAM accordingly (usually, in the /etc/ldap.conf configuration
1058                         file).
1059                         </para>
1060
1061                         <para>
1062                         In Samba release 3.0, the group management system is based on POSIX
1063                         groups. This means that Samba makes use of the posixGroup objectclass.
1064                         For now, there is no NT-like group system management (global and local
1065                         groups).
1066                         </para>
1067
1068                 </sect3>
1069
1070                 <sect3>
1071                 <title>Security and sambaSamAccount</title>
1072
1073
1074                         <para>
1075                         There are two important points to remember when discussing the security
1076                         of sambaSamAccount entries in the directory.
1077                         </para>
1078
1079                         <itemizedlist>
1080                                 <listitem><para><emphasis>Never</emphasis> retrieve the lmPassword or
1081                                 ntPassword attribute values over an unencrypted LDAP session.</para></listitem>
1082                                 <listitem><para><emphasis>Never</emphasis> allow non-admin users to
1083                                 view the lmPassword or ntPassword attribute values.</para></listitem>
1084                         </itemizedlist>
1085
1086                         <para>
1087                         These password hashes are clear text equivalents and can be used to impersonate
1088                         the user without deriving the original clear text strings.  For more information
1089                         on the details of LM/NT password hashes, refer to the
1090                         <link linkend="passdb">Account Information Database</link> section of this chapter.
1091                         </para>
1092
1093                         <para>
1094                                 To remedy the first security issue, the <smbconfoption><name>ldap ssl</name></smbconfoption> &smb.conf; parameter defaults
1095                         to require an encrypted session (<smbconfoption><name>ldap ssl</name><value>on</value></smbconfoption>) using
1096                         the default port of <constant>636</constant>
1097                         when contacting the directory server.  When using an OpenLDAP server, it
1098                         is possible to use the use the StartTLS LDAP extended  operation in the place of
1099                         LDAPS.  In either case, you are strongly discouraged to disable this security
1100                         (<smbconfoption><name>ldap ssl</name><value>off</value></smbconfoption>).
1101                         </para>
1102
1103                         <para>
1104                         Note that the LDAPS protocol is deprecated in favor of the LDAPv3 StartTLS
1105                         extended operation.  However, the OpenLDAP library still provides support for
1106                         the older method of securing communication between clients and servers.
1107                         </para>
1108
1109                         <para>
1110                         The second security precaution is to prevent non-administrative users from
1111                         harvesting password hashes from the directory.  This can be done using the
1112                         following ACL in <filename>slapd.conf</filename>:
1113                         </para>
1114
1115 <para>
1116 <programlisting>
1117 ## allow the "ldap admin dn" access, but deny everyone else
1118 access to attrs=lmPassword,ntPassword
1119      by dn="cn=Samba Admin,ou=people,dc=quenya,dc=org" write
1120      by * none
1121 </programlisting>
1122 </para>
1123
1124                 </sect3>
1125
1126                 <sect3>
1127                 <title>LDAP special attributes for sambaSamAccounts</title>
1128
1129                         <para>
1130                         The sambaSamAccount objectclass is composed of the following attributes:
1131                         </para>
1132
1133                         <para>
1134                         <table frame="all">
1135                                 <title>Attributes in the sambaSamAccount objectclass (LDAP)</title>
1136                         <tgroup cols="2" align="justify">
1137                                         <colspec align="left"/>
1138                                         <colspec align="justify"/>
1139                         <tbody>
1140                                 <row><entry><constant>sambaLMPassword</constant></entry><entry>the LANMAN password 16-byte hash stored as a character
1141 representation of a hexadecimal string.</entry></row>
1142                                 <row><entry><constant>sambaNTPassword</constant></entry><entry>the NT password hash 16-byte stored as a character
1143                                                 representation of a hexadecimal string.</entry></row>
1144                                 <row><entry><constant>sambaPwdLastSet</constant></entry><entry>The integer time in seconds since 1970 when the
1145                                                 <constant>sambaLMPassword</constant> and <constant>sambaNTPassword</constant> attributes were last set.
1146                                 </entry></row>
1147
1148                                 <row><entry><constant>sambaAcctFlags</constant></entry><entry>string of 11 characters surrounded by square brackets []
1149                                                 representing account flags such as U (user), W(workstation), X(no password expiration),
1150                                                 I(Domain trust account), H(Home dir required), S(Server trust account),
1151                                                 and D(disabled).</entry></row>
1152
1153                                 <row><entry><constant>sambaLogonTime</constant></entry><entry>Integer value currently unused</entry></row>
1154
1155                                 <row><entry><constant>sambaLogoffTime</constant></entry><entry>Integer value currently unused</entry></row>
1156
1157                                 <row><entry><constant>sambaKickoffTime</constant></entry><entry>Integer value currently unused</entry></row>
1158
1159                                 <row><entry><constant>sambaPwdCanChange</constant></entry><entry>Integer value currently unused</entry></row>
1160
1161                                 <row><entry><constant>sambaPwdMustChange</constant></entry><entry>Integer value currently unused</entry></row>
1162
1163                                 <row><entry><constant>sambaHomeDrive</constant></entry><entry>specifies the drive letter to which to map the
1164                                 UNC path specified by sambaHomePath. The drive letter must be specified in the form "X:"
1165                                 where X is the letter of the drive to map. Refer to the "logon drive" parameter in the
1166                                 smb.conf(5) man page for more information.</entry></row>
1167
1168                                 <row><entry><constant>sambaLogonScript</constant></entry><entry>The sambaLogonScript property specifies the path of
1169                                 the user's logon script, .CMD, .EXE, or .BAT file. The string can be null. The path
1170                                 is relative to the netlogon share.  Refer to the <smbconfoption><name>logon script</name></smbconfoption> parameter in the
1171                                 &smb.conf; man page for more information.</entry></row>
1172
1173                                 <row><entry><constant>sambaProfilePath</constant></entry><entry>specifies a path to the user's profile.
1174                                 This value can be a null string, a local absolute path, or a UNC path.  Refer to the
1175                                 <smbconfoption><name>logon path</name></smbconfoption> parameter in the &smb.conf; man page for more information.</entry></row>
1176
1177                 <row><entry><constant>sambaHomePath</constant></entry><entry>The sambaHomePath property specifies the path of
1178 the home directory for the user. The string can be null. If sambaHomeDrive is set and specifies
1179 a drive letter, sambaHomePath should be a UNC path. The path must be a network
1180 UNC path of the form <filename>\\server\share\directory</filename>. This value can be a null string.
1181 Refer to the <command>logon home</command> parameter in the &smb.conf; man page for more information.
1182                                 </entry></row>
1183
1184                                 <row><entry><constant>sambaUserWorkstations</constant></entry><entry>character string value currently unused.
1185                                 </entry></row>
1186
1187                                 <row><entry><constant>sambaSID</constant></entry><entry>The security identifier(SID) of the user. The windows equivalent of unix uid's.</entry></row>
1188
1189                                 <row><entry><constant>sambaPrimaryGroupSID</constant></entry><entry>the relative identifier (RID) of the primary group
1190                                 of the user.</entry></row>
1191
1192                 <row><entry><constant>sambaDomainName</constant></entry><entry>domain the user is part of.</entry></row>
1193                         </tbody>
1194                         </tgroup></table>
1195                         </para>
1196
1197                         <para>
1198                         The majority of these parameters are only used when Samba is acting as a PDC of
1199                         a domain (refer to the <link linkend="samba-pdc">Samba as a primary domain controller</link> chapter for details on
1200                         how to configure Samba as a Primary Domain Controller). The following four attributes
1201                         are only stored with the sambaSamAccount entry if the values are non-default values:
1202                         </para>
1203
1204                         <itemizedlist>
1205                                 <listitem><para>sambaHomePath</para></listitem>
1206                                 <listitem><para>sambaLogonScript</para></listitem>
1207                                 <listitem><para>sambaProfilePath</para></listitem>
1208                                 <listitem><para>sambaHomeDrive</para></listitem>
1209                         </itemizedlist>
1210
1211                         <para>
1212                         These attributes are only stored with the sambaSamAccount entry if
1213                         the values are non-default values.  For example, assume TASHTEGO has now been
1214                         configured as a PDC and that <smbconfoption><name>logon home</name><value>\\%L\%u</value></smbconfoption> was defined in
1215                         its &smb.conf; file. When a user named "becky" logons to the domain,
1216                         the <smbconfoption><name>logon home</name></smbconfoption> string is expanded to \\TASHTEGO\becky.
1217                         If the smbHome attribute exists in the entry "uid=becky,ou=people,dc=samba,dc=org",
1218                         this value is used.  However, if this attribute does not exist, then the value
1219                         of the <smbconfoption><name>logon home</name></smbconfoption> parameter is used in its place.  Samba
1220                         will only write the attribute value to the directory entry if the value is
1221                         something other than the default (e.g. <filename>\\MOBY\becky</filename>).
1222                         </para>
1223
1224                 </sect3>
1225
1226                 <sect3>
1227                 <title>Example LDIF Entries for a sambaSamAccount</title>
1228
1229                         <para>
1230                         The following is a working LDIF with the inclusion of the posixAccount objectclass:
1231                         </para>
1232
1233         <para>
1234         <programlisting>
1235         dn: uid=guest2, ou=people,dc=quenya,dc=org
1236         sambaNTPassword: 878D8014606CDA29677A44EFA1353FC7
1237         sambaPwdMustChange: 2147483647
1238         sambaPrimaryGroupSID: S-1-5-21-2447931902-1787058256-3961074038-513
1239         sambaNTPassword: 552902031BEDE9EFAAD3B435B51404EE
1240         sambaPwdLastSet: 1010179124
1241         sambaLogonTime: 0
1242         objectClass: sambaSamAccount
1243         uid: guest2
1244         sambaKickoffTime: 2147483647
1245         sambaAcctFlags: [UX         ]
1246         sambaLogoffTime: 2147483647
1247         sambaSID: S-1-5-21-2447931902-1787058256-3961074038-5006
1248         sambaPwdCanChange: 0
1249         </programlisting>
1250         </para>
1251
1252                         <para>
1253                         The following is an LDIF entry for using both the sambaSamAccount and
1254                         posixAccount objectclasses:
1255                         </para>
1256
1257         <para>
1258         <programlisting>
1259         dn: uid=gcarter, ou=people,dc=quenya,dc=org
1260         sambaLogonTime: 0
1261         displayName: Gerald Carter
1262         sambaLMPassword: 552902031BEDE9EFAAD3B435B51404EE
1263         sambaPrimaryGroupSID: S-1-5-21-2447931902-1787058256-3961074038-1201
1264         objectClass: posixAccount
1265         objectClass: sambaSamAccount
1266         sambaAcctFlags: [UX         ]
1267         userPassword: {crypt}BpM2ej8Rkzogo
1268         uid: gcarter
1269         uidNumber: 9000
1270         cn: Gerald Carter
1271         loginShell: /bin/bash
1272         logoffTime: 2147483647
1273         gidNumber: 100
1274         sambaKickoffTime: 2147483647
1275         sambaPwdLastSet: 1010179230
1276         sambaSID: S-1-5-21-2447931902-1787058256-3961074038-5004
1277         homeDirectory: /home/tashtego/gcarter
1278         sambaPwdCanChange: 0
1279         sambaPwdMustChange: 2147483647
1280         sambaNTPassword: 878D8014606CDA29677A44EFA1353FC7
1281 </programlisting>
1282         </para>
1283
1284                 </sect3>
1285
1286                 <sect3>
1287                 <title>Password synchronisation</title>
1288
1289                 <para>
1290                 Since version 3.0 samba can update the non-samba (LDAP) password stored with an account. When
1291                 using pam_ldap, this allows changing both unix and windows passwords at once.
1292                 </para>
1293
1294                 <para>The <smbconfoption><name>ldap passwd sync</name></smbconfoption> options can have the following values:</para>
1295
1296                 <variablelist>
1297                        <varlistentry>
1298                                <term>yes</term>
1299                                <listitem><para>When the user changes his password, update
1300                                                <constant>ntPassword</constant>, <constant>lmPassword</constant>
1301                                                and the <constant>password</constant> fields.</para></listitem>
1302                        </varlistentry>
1303
1304                        <varlistentry>
1305                                <term>no</term>
1306                                <listitem><para>Only update <constant>ntPassword</constant> and <constant>lmPassword</constant>.</para></listitem>
1307                        </varlistentry>
1308
1309                        <varlistentry>
1310                                <term>only</term>
1311                                    <listitem><para>Only update the LDAP password and let the LDAP server worry about the other fields. This option is only available on some LDAP servers. <footnote><para>Only when the LDAP server supports LDAP_EXOP_X_MODIFY_PASSWD</para></footnote></para></listitem>
1312                        </varlistentry>
1313                 </variablelist>
1314
1315                 <para>More information can be found in the smb.conf manpage.
1316                 </para>
1317
1318                 </sect3>
1319
1320         </sect2>
1321
1322         <sect2>
1323         <title>MySQL</title>
1324
1325         <para>
1326         Every so often someone will come along with a great new idea. Storing of user accounts in an
1327         SQL backend is one of them. Those who want to do this are in the best position to know what the
1328         specific benefits are to them. This may sound like a cop-out, but in truth we can not attempt
1329         to document every nitty little detail why certain things of marginal utility to the bulk of
1330         Samba users might make sense to the rest. In any case, the following instructions should help
1331         the determined SQL user to implement a working system.
1332         </para>
1333
1334                 <sect3>
1335                 <title>Creating the database</title>
1336
1337                         <para>
1338                         You either can set up your own table and specify the field names to pdb_mysql (see below
1339                         for the column names) or use the default table. The file <filename>examples/pdb/mysql/mysql.dump</filename> 
1340                         contains the correct queries to create the required tables. Use the command :
1341
1342 <screen>
1343 &prompt;<userinput>mysql -u<replaceable>username</replaceable> -h<replaceable>hostname</replaceable> -p<replaceable>password</replaceable> \
1344 <replaceable>databasename</replaceable> &lt; <filename>/path/to/samba/examples/pdb/mysql/mysql.dump</filename></userinput>
1345 </screen>
1346                         </para>
1347                 </sect3>
1348
1349                 <sect3>
1350                 <title>Configuring</title>
1351
1352                         <para>This plugin lacks some good documentation, but here is some short info:</para>
1353
1354                         <para>Add a the following to the <smbconfoption><name>passdb backend</name></smbconfoption> variable in your &smb.conf;:
1355                                 <smbconfblock>
1356 <smbconfoption><name>passdb backend</name><value>[other-plugins] mysql:identifier [other-plugins]</value></smbconfoption>
1357                 </smbconfblock>
1358                         </para>
1359
1360                         <para>The identifier can be any string you like, as long as it doesn't collide with 
1361                         the identifiers of other plugins or other instances of pdb_mysql. If you 
1362                         specify multiple pdb_mysql.so entries in <smbconfoption><name>passdb backend</name></smbconfoption>, you also need to 
1363                         use different identifiers!
1364                         </para>
1365
1366                         <para>
1367                                 Additional options can be given through the &smb.conf; file in the <smbconfsection>[global]</smbconfsection> section.
1368                         </para>
1369
1370                 <para>
1371                         <table frame="all">
1372                                 <title>Basic smb.conf options for MySQL passdb backend</title>
1373                                 <tgroup cols="2">
1374                                         <colspec align="left"/>
1375                                         <colspec align="justify"/>
1376                                 <thead>
1377                                         <row><entry>Field</entry><entry>Contents</entry></row>
1378                                 </thead>
1379                                 <tbody>
1380                                         <row><entry>mysql host</entry><entry>host name, defaults to 'localhost'</entry></row>
1381                                         <row><entry>mysql password</entry><entry></entry></row>
1382                                         <row><entry>mysql user</entry><entry>defaults to 'samba'</entry></row>
1383                                         <row><entry>mysql database</entry><entry>defaults to 'samba'</entry></row>
1384                                         <row><entry>mysql port</entry><entry>defaults to 3306</entry></row>
1385                                         <row><entry>table</entry><entry>Name of the table containing users</entry></row>
1386                                 </tbody>
1387                                 </tgroup>
1388                         </table>
1389                 </para>
1390
1391                         <warning>
1392                         <para>
1393                         Since the password for the MySQL user is stored in the 
1394                         &smb.conf; file, you should make the &smb.conf; file 
1395                         readable only to the user that runs Samba This is considered a security 
1396                         bug and will be fixed soon.
1397                         </para>
1398                         </warning>
1399
1400                         <para>Names of the columns in this table (I've added column types those columns should have first):</para>
1401
1402                 <para>
1403                         <table frame="all">
1404                                 <title>MySQL field names for MySQL passdb backend</title>
1405                                 <tgroup cols="3" align="justify">
1406                                         <colspec align="left"/>
1407                                         <colspec align="left"/>
1408                                         <colspec align="justify"/>
1409                         <thead>         
1410                                 <row><entry>Field</entry><entry>Type</entry><entry>Contents</entry></row>
1411                         </thead>
1412                         <tbody>
1413                                 <row><entry>logon time column</entry><entry>int(9)</entry><entry></entry></row>
1414                                 <row><entry>logoff time column</entry><entry>int(9)</entry><entry></entry></row>
1415                                 <row><entry>kickoff time column</entry><entry>int(9)</entry><entry></entry></row>
1416                                 <row><entry>pass last set time column</entry><entry>int(9)</entry><entry></entry></row>
1417                                 <row><entry>pass can change time column</entry><entry>int(9)</entry><entry></entry></row>
1418                                 <row><entry>pass must change time column</entry><entry>int(9)</entry><entry></entry></row>
1419                                 <row><entry>username column</entry><entry>varchar(255)</entry><entry>unix username</entry></row>
1420                                 <row><entry>domain column</entry><entry>varchar(255)</entry><entry>NT domain user is part of</entry></row>
1421                                 <row><entry>nt username column</entry><entry>varchar(255)</entry><entry>NT username</entry></row>
1422                                 <row><entry>fullname column</entry><entry>varchar(255)</entry><entry>Full name of user</entry></row>
1423                                 <row><entry>home dir column</entry><entry>varchar(255)</entry><entry>UNIX homedir path</entry></row>
1424                                 <row><entry>dir drive column</entry><entry>varchar(2)</entry><entry>Directory drive path (eg: 'H:')</entry></row>
1425                                 <row><entry>logon script column</entry><entry>varchar(255)</entry><entry>Batch file to run on client side when logging on</entry></row>
1426                                 <row><entry>profile path column</entry><entry>varchar(255)</entry><entry>Path of profile</entry></row>
1427                                 <row><entry>acct desc column</entry><entry>varchar(255)</entry><entry>Some ASCII NT user data</entry></row>
1428                                 <row><entry>workstations column</entry><entry>varchar(255)</entry><entry>Workstations user can logon to (or NULL for all)</entry></row>
1429                                 <row><entry>unknown string column</entry><entry>varchar(255)</entry><entry>unknown string</entry></row>
1430                                 <row><entry>munged dial column</entry><entry>varchar(255)</entry><entry>?</entry></row>
1431                                 <row><entry>user sid column</entry><entry>varchar(255)</entry><entry>NT user SID</entry></row>
1432                                 <row><entry>group sid column</entry><entry>varchar(255)</entry><entry>NT group ID</entry></row>
1433                                 <row><entry>lanman pass column</entry><entry>varchar(255)</entry><entry>encrypted lanman password</entry></row>
1434                                 <row><entry>nt pass column</entry><entry>varchar(255)</entry><entry>encrypted nt passwd</entry></row>
1435                                 <row><entry>plain pass column</entry><entry>varchar(255)</entry><entry>plaintext password</entry></row>
1436                                 <row><entry>acct control column</entry><entry>int(9)</entry><entry>nt user data</entry></row>
1437                                 <row><entry>unknown 3 column</entry><entry>int(9)</entry><entry>unknown</entry></row>
1438                                 <row><entry>logon divs column</entry><entry>int(9)</entry><entry>?</entry></row>
1439                                 <row><entry>hours len column</entry><entry>int(9)</entry><entry>?</entry></row>
1440                                 <row><entry>unknown 5 column</entry><entry>int(9)</entry><entry>unknown</entry></row>
1441                                 <row><entry>unknown 6 column</entry><entry>int(9)</entry><entry>unknown</entry></row>
1442                         </tbody></tgroup>
1443                 </table>
1444                 </para>
1445
1446                         <para>
1447                         Eventually, you can put a colon (:) after the name of each column, which 
1448                         should specify the column to update when updating the table. You can also
1449                         specify nothing behind the colon - then the data from the field will not be 
1450                         updated. 
1451                         </para>
1452
1453                 </sect3>
1454
1455                 <sect3>
1456                 <title>Using plaintext passwords or encrypted password</title>
1457
1458                         <para>
1459                         I strongly discourage the use of plaintext passwords, however, you can use them:
1460                         </para>
1461
1462                         <para>
1463                         If you would like to use plaintext passwords, set
1464                         'identifier:lanman pass column' and 'identifier:nt pass column' to
1465                         'NULL' (without the quotes) and 'identifier:plain pass column' to the
1466                         name of the column containing the plaintext passwords. 
1467                         </para>
1468
1469                         <para>
1470                         If you use encrypted passwords, set the 'identifier:plain pass
1471                         column' to 'NULL' (without the quotes). This is the default.
1472                         </para>
1473
1474                 </sect3>
1475
1476                 <sect3>
1477                 <title>Getting non-column data from the table</title>
1478
1479                         <para>
1480                         It is possible to have not all data in the database and making some 'constant'.
1481                         </para>
1482
1483                         <para>
1484                         For example, you can set 'identifier:fullname column' to : 
1485                         <command>CONCAT(First_name,' ',Sur_name)</command>
1486                         </para>
1487
1488                         <para>
1489                         Or, set 'identifier:workstations column' to :
1490                         <command>NULL</command></para>
1491
1492                         <para>See the MySQL documentation for more language constructs.</para>
1493
1494                 </sect3>
1495         </sect2>
1496
1497         <sect2 id="XMLpassdb">
1498         <title>XML</title>
1499
1500                 <para>This module requires libxml2 to be installed.</para>
1501
1502                 <para>The usage of pdb_xml is pretty straightforward. To export data, use:
1503                 </para>
1504
1505                 <para>
1506                         <prompt>$ </prompt> <userinput>pdbedit -e xml:filename</userinput>
1507                 </para>
1508
1509                 <para>
1510                 (where filename is the name of the file to put the data in)
1511                 </para>
1512
1513                 <para>
1514                 To import data, use:
1515                 <prompt>$ </prompt> <userinput>pdbedit -i xml:filename</userinput>
1516                 </para>
1517         </sect2>
1518 </sect1>
1519
1520 <sect1>
1521 <title>Common Errors</title>
1522
1523         <sect2>
1524                 <title>Users can not logon</title>
1525
1526                 <para><quote>I've installed samba, but now I can't log on with my unix account!</quote></para>
1527
1528                 <para>Make sure your user has been added to the current samba <smbconfoption><name>passdb backend</name></smbconfoption>. Read the section <link linkend="acctmgmttools">Account Management Tools</link> for details.</para>
1529
1530         </sect2>
1531
1532         <sect2>
1533         <title>Users being added to wrong backend database</title>
1534
1535         <para>
1536         A few complaints have been received from users that just moved to Samba-3. The following
1537         &smb.conf; file entries were causing problems, new accounts were being added to the old
1538         smbpasswd file, not to the tdbsam passdb.tdb file:
1539         </para>
1540
1541         <para>
1542                 <smbconfblock>
1543                         <smbconfsection>[global]</smbconfsection>
1544                         <member>...</member>
1545 <smbconfoption><name>passdb backend</name><value>smbpasswd, tdbsam</value></smbconfoption>
1546 <member>...</member>
1547         </smbconfblock>
1548         </para>
1549
1550         <para>
1551         Samba will add new accounts to the first entry in the <emphasis>passdb backend</emphasis>
1552         parameter entry. If you want to update to the tdbsam, then change the entry to:
1553         </para>
1554
1555         <para>
1556                 <smbconfblock>
1557                         <smbconfsection>[globals]</smbconfsection>
1558                         <member>...</member>
1559 <smbconfoption><name>passdb backend</name><value>tdbsam, smbpasswd</value></smbconfoption>
1560                         <member>...</member>
1561         </smbconfblock>
1562         </para>
1563
1564         </sect2>
1565
1566         <sect2>
1567         <title>auth methods does not work</title>
1568
1569         <para>
1570                 If you explicitly set an <smbconfoption><name>auth methods</name></smbconfoption> parameter, guest must be specified as the first
1571         entry on the line. Eg: <smbconfoption><name>auth methods</name><value>guest sam</value></smbconfoption>.
1572         </para>
1573
1574         <para>
1575         This is the exact opposite of the requirement for the <smbconfoption><name>passdb backend</name></smbconfoption>
1576         option, where it must be the <emphasis>LAST</emphasis> parameter on the line.
1577         </para>
1578
1579         </sect2>
1580
1581 </sect1>
1582
1583 </chapter>