8 <firstname>Olivier (lem)</firstname><surname>Lemaire</surname>
10 <orgname>IDEALX</orgname>
11 <address><email>olem@IDEALX.org</email></address>
15 <pubdate>May 24, 2003</pubdate>
17 <title>Account Information Databases</title>
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.
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 <emphasis>"passdb backend = tdbsam_nua, guest"</emphasis>
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.
40 Samba-3.0.0 does NOT support Non-Unix Account (NUA) operation.
44 <title>Features and Benefits</title>
47 Samba-3 provides for complete backwards compatibility with Samba-2.2.x functionality
52 <title>Backwards Compatibility Backends</title>
53 <varlistentry><term>Plain Text:</term>
56 This option uses nothing but the Unix/Linux <filename>/etc/passwd</filename>
57 style back end. On systems that have PAM (Pluggable Authentication Modules)
58 support all PAM modules are supported. The behaviour is just as it was with
59 Samba-2.2.x, and the protocol limitations imposed by MS Windows clients
65 <varlistentry><term>smbpasswd:</term>
68 This option allows continues use of the <filename>smbpasswd</filename>
69 file that maintains a plain ASCII (text) layout that includes the MS Windows
70 LanMan and NT encrypted passwords as well as a field that stores some
71 account information. This form of password backend does NOT store any of
72 the MS Windows NT/200x SAM (Security Account Manager) information needed to
73 provide the extended controls that are needed for more comprehensive
74 interoperation with MS Windows NT4 / 200x servers.
78 This backend should be used only for backwards compatibility with older
79 versions of Samba. It may be deprecated in future releases.
84 <varlistentry><term>ldapsam_compat (Samba-2.2 LDAP Compatibility):</term>
87 There is a password backend option that allows continued operation with
88 a existing OpenLDAP backend that uses the Samba-2.2.x LDAP schema extension.
89 This option is provided primarily as a migration tool, although there is
90 no reason to force migration at this time. Note that this tool will eventually
98 Samba-3 introduces the following new password backend capabilities:
102 <title>New Backends</title>
103 <varlistentry><term>guest:</term>
106 This is <emphasis>always</emphasis> required as the last backend specified.
107 It provides the ability to handle guest account requirements for access to
108 resources like <parameter>IPC$</parameter> which is used for browsing.
113 <varlistentry><term>tdbsam:</term>
116 This backend provides a rich database backend for local servers. This
117 backend is NOT suitable for multiple domain controller (ie: PDC + one
118 or more BDC) installations.
122 The <emphasis>tdbsam</emphasis> password backend stores the old <emphasis>
123 smbpasswd</emphasis> information PLUS the extended MS Windows NT / 200x
124 SAM information into a binary format TDB (trivial database) file.
125 The inclusion of the extended information makes it possible for Samba-3
126 to implement the same account and system access controls that are possible
127 with MS Windows NT4 and MS Windows 200x based systems.
131 The inclusion of the <emphasis>tdbsam</emphasis> capability is a direct
132 response to user requests to allow simple site operation without the overhead
133 of the complexities of running OpenLDAP. It is recommended to use this only
134 for sites that have fewer than 250 users. For larger sites or implementations
135 the use of OpenLDAP or of Active Directory integration is strongly recommended.
140 <varlistentry><term>ldapsam:</term>
143 This provides a rich directory backend for distributed account installation.
147 Samba-3 has a new and extended LDAP implementation that requires configuration
148 of OpenLDAP with a new format samba schema. The new format schema file is
149 included in the <filename class="directory">examples/LDAP</filename> directory of the Samba distribution.
153 The new LDAP implementation significantly expands the control abilities that
154 were possible with prior versions of Samba. It is now possible to specify
155 "per user" profile settings, home directories, account access controls, and
156 much more. Corporate sites will see that the Samba-Team has listened to their
157 requests both for capability and to allow greater scalability.
162 <varlistentry><term>mysqlsam (MySQL based backend):</term>
165 It is expected that the MySQL based SAM will be very popular in some corners.
166 This database backend will be on considerable interest to sites that want to
167 leverage existing MySQL technology.
172 <varlistentry><term>xmlsam (XML based datafile):</term>
175 Allows the account and password data to be stored in an XML format
176 data file. This backend can not be used for normal operation, it can only
177 be used in conjunction with <command>pdbedit</command>'s pdb2pdb
178 functionality. The DTD that is used might be subject to changes in the future.
182 The xmlsam option can be useful for account migration between database
183 backends or backups. Use of this tool will allow the data to be edited before migration
184 into another backend format.
189 <varlistentry><term>nisplussam:</term>
192 The NIS+ based passdb backend. Takes name NIS domain as an
193 optional argument. Only works with Sun NIS+ servers.
203 <title>Technical Information</title>
206 Old windows clients send plain text passwords over the wire. Samba can check these
207 passwords by crypting them and comparing them to the hash stored in the unix user database.
211 Newer windows clients send encrypted passwords (so-called Lanman and NT hashes) over
212 the wire, instead of plain text passwords. The newest clients will send only encrypted
213 passwords and refuse to send plain text passwords, unless their registry is tweaked.
217 These passwords can't be converted to unix style encrypted passwords. Because of that,
218 you can't use the standard unix user database, and you have to store the Lanman and NT
219 hashes somewhere else.
223 In addition to differently encrypted passwords, windows also stores certain data for each
224 user that is not stored in a unix user database. e.g: workstations the user may logon from,
225 the location where the users' profile is stored, and so on. Samba retrieves and stores this
226 information using a <parameter>passdb backend</parameter>. Commonly available backends are LDAP, plain text
227 file, MySQL and nisplus. For more information, see the man page for &smb.conf; regarding the
228 <parameter>passdb backend</parameter> parameter.
232 <title>Important Notes About Security</title>
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.
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).
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.
262 The following versions of MS Windows do not support full domain security protocols,
263 although they may log onto a domain environment:
267 <member>MS DOS Network client 3.0 with the basic network redirector installed</member>
268 <member>Windows 95 with the network redirector update installed</member>
269 <member>Windows 98 [se]</member>
270 <member>Windows Me</member>
275 MS Windows XP Home does not have facilities to become a domain member and it can
276 not participate in domain logons.
281 The following versions of MS Windows fully support domain security protocols.
285 <member>Windows NT 3.5x</member>
286 <member>Windows NT 4.0</member>
287 <member>Windows 2000 Professional</member>
288 <member>Windows 200x Server/Advanced Server</member>
289 <member>Windows XP Professional</member>
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
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>
310 <title>Advantages of Encrypted Passwords</title>
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>
317 <listitem><para>Plain text passwords are not stored anywhere in
318 memory or on disk.</para></listitem>
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.
328 <listitem><para>Encrypted password support allows automatic share
329 (resource) reconnects.</para></listitem>
331 <listitem><para>Encrypted passwords are essential for PDC/BDC
332 operation.</para></listitem>
338 <title>Advantages of non-encrypted passwords</title>
341 <listitem><para>Plain text passwords are not kept
342 on disk, and are NOT cached in memory. </para></listitem>
344 <listitem><para>Uses same password file as other unix
345 services such as login and ftp</para></listitem>
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>
355 <title>Mapping User Identifiers between MS Windows and Unix</title>
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.
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-3 will call the <parameter>add user script</parameter>
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.
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.
382 <title>Account Management Tools</title>
385 Samba-3 provides two (2) tools for management of User and machine accounts. These tools are
386 called <command>smbpasswd</command> and <command>pdbedit</command>. A third tool is under
387 development but is NOT expected to ship in time for Samba-3.0.0. The new tool will be a TCL/TK
388 GUI tool that looks much like the MS Windows NT4 Domain User Manager - hopefully this will
389 be announced in time for the Samba-3.0.1 release.
392 <title>The <emphasis>smbpasswd</emphasis> Command</title>
395 The smbpasswd utility is a utility similar to the <command>passwd</command>
396 or <command>yppasswd</command> programs. It maintains the two 32 byte password
397 fields in the passdb backend.
401 <command>smbpasswd</command> works in a client-server mode where it contacts the
402 local smbd to change the user's password on its behalf. This has enormous benefits
407 <command>smbpasswd</command> has the capability to change passwords on Windows NT
408 servers (this only works when the request is sent to the NT Primary Domain Controller
409 if changing an NT Domain user's password).
413 <command>smbpasswd</command> can be used to:
417 <member><emphasis>add</emphasis> user or machine accounts</member>
418 <member><emphasis>delete</emphasis> user or machine accounts</member>
419 <member><emphasis>enable</emphasis> user or machine accounts</member>
420 <member><emphasis>disable</emphasis> user or machine accounts</member>
421 <member><emphasis>set to NULL</emphasis> user passwords</member>
422 <member><emphasis>manage interdomain trust accounts</emphasis></member>
426 To run smbpasswd as a normal user just type:
431 <prompt>$ </prompt><userinput>smbpasswd</userinput>
432 <prompt>Old SMB password: </prompt><userinput><replaceable>secret</replaceable></userinput>
434 For <replaceable>secret</replaceable> type old value here - or hit return if
435 there was no old password
437 <prompt>New SMB Password: </prompt><userinput><replaceable>new secret</replaceable></userinput>
438 <prompt>Repeat New SMB Password: </prompt><userinput><replaceable>new secret</replaceable></userinput>
443 If the old value does not match the current value stored for that user, or the two
444 new values do not match each other, then the password will not be changed.
448 When invoked by an ordinary user it will only allow change of their own
453 When run by root smbpasswd may take an optional argument, specifying
454 the user name whose SMB password you wish to change. When run as root, smbpasswd
455 does not prompt for or check the old password value, thus allowing root to set passwords
456 for users who have forgotten their passwords.
460 <command>smbpasswd</command> is designed to work in the way familiar to UNIX
461 users who use the <command>passwd</command> or <command>yppasswd</command> commands.
462 While designed for administrative use, this tool provides essential user level
463 password change capabilities.
467 For more details on using <command>smbpasswd</command> refer to the man page (the
468 definitive reference).
473 <title>The <emphasis>pdbedit</emphasis> Command</title>
476 <command>pdbedit</command> is a tool that can be used only by root. It is used to
477 manage the passdb backend. <command>pdbedit</command> can be used to:
481 <member>add, remove or modify user accounts</member>
482 <member>listing user accounts</member>
483 <member>migrate user accounts</member>
487 The <command>pdbedit</command> tool is the only one that can manage the account
488 security and policy settings. It is capable of all operations that smbpasswd can
489 do as well as a super set of them.
493 One particularly important purpose of the <command>pdbedit</command> is to allow
494 the migration of account information from one passdb backend to another. See the
495 <link linkend="XMLpassdb">XML</link> password backend section of this chapter.
499 The following is an example of the user account information that is stored in
500 a tdbsam password backend. This listing was produced by running:
504 <prompt>$ </prompt><userinput>pdbedit -Lv met</userinput>
508 User SID: S-1-5-21-1449123459-1407424037-3116680435-2004
509 Primary Group SID: S-1-5-21-1449123459-1407424037-3116680435-1201
510 Full Name: Melissa E Terpstra
511 Home Directory: \\frodo\met\Win9Profile
513 Logon Script: scripts\logon.bat
514 Profile Path: \\frodo\Profiles\met
517 Workstations: melbelle
520 Logoff time: Mon, 18 Jan 2038 20:14:07 GMT
521 Kickoff time: Mon, 18 Jan 2038 20:14:07 GMT
522 Password last set: Sat, 14 Dec 2002 14:37:03 GMT
523 Password can change: Sat, 14 Dec 2002 14:37:03 GMT
524 Password must change: Mon, 18 Jan 2038 20:14:07 GMT
527 <!-- FIXME: Add note about migrating user accounts -->
533 <title>Password Backends</title>
536 Samba-3 offers the greatest flexibility in backend account database design of any SMB/CIFS server
537 technology available today. The flexibility is immediately obvious as one begins to explore this
542 It is possible to specify not only multiple different password backends, but even multiple
543 backends of the same type. For example, to use two different tdbsam databases:
549 passdb backend = tdbsam:/etc/samba/passdb.tdb, \
550 tdbsam:/etc/samba/old-passdb.tdb, guest
556 <title>Plain Text</title>
559 Older versions of Samba retrieved user information from the unix user database
560 and eventually some other fields from the file <filename>/etc/samba/smbpasswd</filename>
561 or <filename>/etc/smbpasswd</filename>. When password encryption is disabled, no
562 SMB specific data is stored at all. Instead all operations are conducted via the way
563 that the Samba host OS will access its <filename>/etc/passwd</filename> database.
564 eg: On Linux systems that is done via PAM.
570 <title>smbpasswd - Encrypted Password Database</title>
573 Traditionally, when configuring <ulink url="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt
574 passwords = yes</ulink> in Samba's <filename>smb.conf</filename> file, user account
575 information such as username, LM/NT password hashes, password change times, and account
576 flags have been stored in the <filename>smbpasswd(5)</filename> file. There are several
577 disadvantages to this approach for sites with very large numbers of users (counted
583 The first is that all lookups must be performed sequentially. Given that
584 there are approximately two lookups per domain logon (one for a normal
585 session connection such as when mapping a network drive or printer), this
586 is a performance bottleneck for large sites. What is needed is an indexed approach
587 such as is used in databases.
591 The second problem is that administrators who desire to replicate a smbpasswd file
592 to more than one Samba server were left to use external tools such as
593 <command>rsync(1)</command> and <command>ssh(1)</command> and wrote custom,
598 And finally, the amount of information which is stored in an smbpasswd entry leaves
599 no room for additional attributes such as a home directory, password expiration time,
600 or even a Relative Identifier (RID).
605 As a result of these deficiencies, a more robust means of storing user attributes
606 used by smbd was developed. The API which defines access to user accounts
607 is commonly referred to as the samdb interface (previously this was called the passdb
608 API, and is still so named in the Samba CVS trees).
612 Samba-3 provides an enhanced set of passdb backends that overcome the deficiencies
613 of the smbpasswd plain text database. These are tdbsam, ldapsam, and xmlsam.
614 Of these ldapsam will be of most interest to large corporate or enterprise sites.
620 <title>tdbsam</title>
622 <para>Samba can store user and machine account data in a "TDB" (Trivial Database).
623 Using this backend doesn't require any additional configuration. This backend is
624 recommended for new installations that do not require LDAP.
628 As a general guide the Samba-Team does NOT recommend using the tdbsam backend for sites
629 that have 250 or more users. Additionally, tdbsam is not capable of scaling for use
630 in sites that require PDB/BDC implementations that requires replication of the account
631 database. Clearly, for reason of scalability, the use of ldapsam should be encouraged.
637 <title>ldapsam</title>
640 There are a few points to stress that the ldapsam does not provide. The LDAP
641 support referred to in the this documentation does not include:
645 <listitem><para>A means of retrieving user account information from
646 an Windows 200x Active Directory server.</para></listitem>
647 <listitem><para>A means of replacing /etc/passwd.</para></listitem>
651 The second item can be accomplished by using LDAP NSS and PAM modules. LGPL
652 versions of these libraries can be obtained from PADL Software
653 (<ulink url="http://www.padl.com/">http://www.padl.com/</ulink>). More
654 information about the configuration of these packages may be found at "LDAP,
655 System Administration; Gerald Carter, O'Reilly; Chapter 6: Replacing NIS".
656 Refer to <ulink url="http://safari.oreilly.com/?XmlId=1-56592-491-6">
657 http://safari.oreilly.com/?XmlId=1-56592-491-6</ulink> for those who might wish to know
658 more about configuration and administration of an OpenLDAP server.
663 This section is outdated for Samba-3 schema. Samba-3 introduces a new schema
664 that has not been documented at the time of this publication.
669 This document describes how to use an LDAP directory for storing Samba user
670 account information traditionally stored in the smbpasswd(5) file. It is
671 assumed that the reader already has a basic understanding of LDAP concepts
672 and has a working directory server already installed. For more information
673 on LDAP architectures and Directories, please refer to the following sites.
677 <listitem><para>OpenLDAP - <ulink url="http://www.openldap.org/">http://www.openldap.org/</ulink></para></listitem>
678 <listitem><para>iPlanet Directory Server -
679 <ulink url="http://iplanet.netscape.com/directory">http://iplanet.netscape.com/directory</ulink></para></listitem>
683 Two additional Samba resources which may prove to be helpful are
687 <listitem><para>The <ulink url="http://www.unav.es/cti/ldap-smb/ldap-smb-3-howto.html">Samba-PDC-LDAP-HOWTO</ulink>
688 maintained by Ignacio Coupeau.</para></listitem>
690 <listitem><para>The NT migration scripts from <ulink url="http://samba.idealx.org/">IDEALX</ulink> that are
691 geared to manage users and group in such a Samba-LDAP Domain Controller configuration.
696 <title>Supported LDAP Servers</title>
699 The LDAP ldapsam code has been developed and tested using the OpenLDAP 2.0 and 2.1 server and
700 client libraries. The same code should work with Netscape's Directory Server and client SDK.
701 However, there are bound to be compile errors and bugs. These should not be hard to fix.
702 Please submit fixes via <link linkend="bugreport">Bug reporting facility</link>.
708 <title>Schema and Relationship to the RFC 2307 posixAccount</title>
712 Samba 3.0 includes the necessary schema file for OpenLDAP 2.0 in
713 <filename>examples/LDAP/samba.schema</filename>. The sambaSamAccount objectclass is given here:
718 objectclass ( 1.3.6.1.4.1.7165.2.2.3 NAME 'sambaSamAccount' SUP top AUXILIARY
719 DESC 'Samba Auxiliary Account'
721 MAY ( cn $ lmPassword $ ntPassword $ pwdLastSet $ logonTime $
722 logoffTime $ kickoffTime $ pwdCanChange $ pwdMustChange $ acctFlags $
723 displayName $ smbHome $ homeDrive $ scriptPath $ profilePath $
724 description $ userWorkstations $ primaryGroupID $ domain ))
729 The <filename>samba.schema</filename> file has been formatted for OpenLDAP 2.0/2.1.
730 The OID's are owned by the Samba Team and as such is legal to be openly published.
731 If you translate the schema to be used with Netscape DS, please
732 submit the modified schema file as a patch to
733 <ulink url="mailto:jerry@samba.org">jerry@samba.org</ulink>.
737 Just as the smbpasswd file is meant to store information which supplements a
738 user's <filename>/etc/passwd</filename> entry, so is the sambaSamAccount object
739 meant to supplement the UNIX user account information. A sambaSamAccount is a
740 <constant>STRUCTURAL</constant> objectclass so it can be stored individually
741 in the directory. However, there are several fields (e.g. uid) which overlap
742 with the posixAccount objectclass outlined in RFC2307. This is by design.
745 <!--olem: we should perhaps have a note about shadowAccounts too as many
746 systems use them, isn'it ? -->
749 In order to store all user account information (UNIX and Samba) in the directory,
750 it is necessary to use the sambaSamAccount and posixAccount objectclasses in
751 combination. However, smbd will still obtain the user's UNIX account
752 information via the standard C library calls (e.g. getpwnam(), et. al.).
753 This means that the Samba server must also have the LDAP NSS library installed
754 and functioning correctly. This division of information makes it possible to
755 store all Samba account information in LDAP, but still maintain UNIX account
756 information in NIS while the network is transitioning to a full LDAP infrastructure.
761 <title>OpenLDAP configuration</title>
764 To include support for the sambaSamAccount object in an OpenLDAP directory
765 server, first copy the samba.schema file to slapd's configuration directory.
766 The samba.schema file can be found in the directory <filename>examples/LDAP</filename>
767 in the samba source distribution.
772 &rootprompt;<userinput>cp samba.schema /etc/openldap/schema/</userinput>
777 Next, include the <filename>samba.schema</filename> file in <filename>slapd.conf</filename>.
778 The sambaSamAccount object contains two attributes which depend upon other schema
779 files. The 'uid' attribute is defined in <filename>cosine.schema</filename> and
780 the 'displayName' attribute is defined in the <filename>inetorgperson.schema</filename>
781 file. Both of these must be included before the <filename>samba.schema</filename> file.
786 ## /etc/openldap/slapd.conf
788 ## schema files (core.schema is required by default)
789 include /etc/openldap/schema/core.schema
791 ## needed for sambaSamAccount
792 include /etc/openldap/schema/cosine.schema
793 include /etc/openldap/schema/inetorgperson.schema
794 include /etc/openldap/schema/samba.schema
795 include /etc/openldap/schema/nis.schema
801 It is recommended that you maintain some indices on some of the most useful attributes,
802 like in the following example, to speed up searches made on sambaSamAccount objectclasses
803 (and possibly posixAccount and posixGroup as well).
808 # Indices to maintain
809 ## required by OpenLDAP
814 ## required to support pdb_getsampwnam
815 index uid pres,sub,eq
816 ## required to support pdb_getsambapwrid()
817 index displayName pres,sub,eq
819 ## uncomment these if you are storing posixAccount and
820 ## posixGroup entries in the directory as well
826 index sambaPrimaryGroupSID eq
827 index sambaDomainName eq
833 Create the new index by executing:
838 ./sbin/slapindex -f slapd.conf
843 Remember to restart slapd after making these changes:
848 &rootprompt;<userinput>/etc/init.d/slapd restart</userinput>
855 <title>Initialise the LDAP database</title>
858 Before you can add accounts to the LDAP database you must create the account containers
859 that they will be stored in. The following LDIF file should be modified to match your
860 needs (ie: Your DNS entries, etc.).
865 # Organization for Samba Base
866 dn: dc=plainjoe,dc=org
867 objectclass: dcObject
868 objectclass: organization
870 o: Terpstra Org Network
871 description: The Samba-3 Network LDAP Example
873 # Organizational Role for Directory Management
874 dn: cn=Manager,dc=plainjoe,dc=org
875 objectclass: organizationalRole
877 description: Directory Manager
879 # Setting up container for users
880 dn: ou=People,dc=plainjoe,dc=org
882 objectclass: organizationalUnit
885 # Setting up admin handle for People OU
886 dn: cn=admin,ou=People,dc=plainjoe,dc=org
889 objectclass: organizationalRole
890 objectclass: simpleSecurityObject
891 userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz
896 The userPassword shown above should be generated using <command>slappasswd</command>.
900 The following command will then load the contents of the LDIF file into the LDAP
906 <prompt>$ </prompt><userinput>slapadd -v -l initldap.dif</userinput>
911 Do not forget to secure your LDAP server with an adequate access control list,
912 as well as an admin password.
917 Before Samba can access the LDAP server you need to store the LDAP admin password
918 into the Samba-3 <filename>secrets.tdb</filename> database by:
920 &rootprompt; <userinput>smbpasswd -w <replaceable>secret</replaceable></userinput>
928 <title>Configuring Samba</title>
931 The following parameters are available in smb.conf only if your
932 version of samba was built with LDAP support. Samba automatically builds with LDAP support if the
933 LDAP libraries are found.
937 <listitem><para><ulink url="smb.conf.5.html#PASSDBBACKEND">passdb backend = ldapsam:url</ulink></para></listitem>
938 <listitem><para><ulink url="smb.conf.5.html#LDAPSSL">ldap ssl</ulink></para></listitem>
939 <listitem><para><ulink url="smb.conf.5.html#LDAPADMINDN">ldap admin dn</ulink></para></listitem>
940 <listitem><para><ulink url="smb.conf.5.html#LDAPSUFFIX">ldap suffix</ulink></para></listitem>
941 <listitem><para><ulink url="smb.conf.5.html#LDAPFILTER">ldap filter</ulink></para></listitem>
942 <listitem><para><ulink url="smb.conf.5.html#LDAPMACHINSUFFIX">ldap machine suffix</ulink></para></listitem>
943 <listitem><para><ulink url="smb.conf.5.html#LDAPUSERSUFFIX">ldap user suffix</ulink></para></listitem>
944 <listitem><para><ulink url="smb.conf.5.html#LDAPDELETEDN">ldap delete dn</ulink></para></listitem>
945 <listitem><para><ulink url="smb.conf.5.html#LDAPPASSWDSYNC">ldap passwd sync</ulink></para></listitem>
946 <listitem><para><ulink url="smb.conf.5.html#LDAPTRUSTIDS">ldap trust ids</ulink></para></listitem>
951 These are described in the &smb.conf; man
952 page and so will not be repeated here. However, a sample smb.conf file for
953 use with an LDAP directory could appear as
958 ## /usr/local/samba/lib/smb.conf
961 encrypt passwords = yes
963 netbios name = TASHTEGO
966 # ldap related parameters
968 # define the DN to use when binding to the directory servers
969 # The password for this DN is not stored in smb.conf. Rather it
970 # must be set by using 'smbpasswd -w <replaceable>secretpw</replaceable>' to store the
971 # passphrase in the secrets.tdb file. If the "ldap admin dn" values
972 # change, this password will need to be reset.
973 ldap admin dn = "cn=Samba Manager,ou=people,dc=samba,dc=org"
975 # Define the SSL option when connecting to the directory
976 # ('off', 'start tls', or 'on' (default))
979 # syntax: passdb backend = ldapsam:ldap://server-name[:port]
980 passdb backend = ldapsam:ldap://funball.samba.org, guest
982 # smbpasswd -x delete the entire dn-entry
985 # the machine and user suffix added to the base suffix
986 # wrote WITHOUT quotes. NULL suffixes by default
987 ldap user suffix = ou=People
988 ldap machine suffix = ou=Systems
990 # Trust unix account information in LDAP
991 # (see the smb.conf manpage for details)
994 # specify the base DN to use when searching the directory
995 ldap suffix = "ou=people,dc=samba,dc=org"
997 # generally the default ldap search filter is ok
998 # ldap filter = "(&(uid=%u)(objectclass=sambaSamAccount))"
1005 <title>Accounts and Groups management</title>
1008 As users accounts are managed through the sambaSamAccount objectclass, you should
1009 modify your existing administration tools to deal with sambaSamAccount attributes.
1013 Machines accounts are managed with the sambaSamAccount objectclass, just
1014 like users accounts. However, it's up to you to store those accounts
1015 in a different tree of your LDAP namespace: you should use
1016 "ou=Groups,dc=plainjoe,dc=org" to store groups and
1017 "ou=People,dc=plainjoe,dc=org" to store users. Just configure your
1018 NSS and PAM accordingly (usually, in the /etc/ldap.conf configuration
1023 In Samba release 3.0, the group management system is based on POSIX
1024 groups. This means that Samba makes use of the posixGroup objectclass.
1025 For now, there is no NT-like group system management (global and local
1032 <title>Security and sambaSamAccount</title>
1036 There are two important points to remember when discussing the security
1037 of sambaSamAccount entries in the directory.
1041 <listitem><para><emphasis>Never</emphasis> retrieve the lmPassword or
1042 ntPassword attribute values over an unencrypted LDAP session.</para></listitem>
1043 <listitem><para><emphasis>Never</emphasis> allow non-admin users to
1044 view the lmPassword or ntPassword attribute values.</para></listitem>
1048 These password hashes are clear text equivalents and can be used to impersonate
1049 the user without deriving the original clear text strings. For more information
1050 on the details of LM/NT password hashes, refer to the
1051 <link linkend="passdb">Account Information Database</link> section of this chapter.
1055 To remedy the first security issue, the <parameter>ldap ssl</parameter> &smb.conf; parameter defaults
1056 to require an encrypted session (<parameter>ldap ssl = on</parameter>) using
1057 the default port of <constant>636</constant>
1058 when contacting the directory server. When using an OpenLDAP server, it
1059 is possible to use the use the StartTLS LDAP extended operation in the place of
1060 LDAPS. In either case, you are strongly discouraged to disable this security
1061 (<parameter>ldap ssl = off</parameter>).
1065 Note that the LDAPS protocol is deprecated in favor of the LDAPv3 StartTLS
1066 extended operation. However, the OpenLDAP library still provides support for
1067 the older method of securing communication between clients and servers.
1071 The second security precaution is to prevent non-administrative users from
1072 harvesting password hashes from the directory. This can be done using the
1073 following ACL in <filename>slapd.conf</filename>:
1078 ## allow the "ldap admin dn" access, but deny everyone else
1079 access to attrs=lmPassword,ntPassword
1080 by dn="cn=Samba Admin,ou=people,dc=plainjoe,dc=org" write
1088 <title>LDAP special attributes for sambaSamAccounts</title>
1091 The sambaSamAccount objectclass is composed of the following attributes:
1096 <title>Attributes in the sambaSamAccount objectclass (LDAP)</title>
1097 <tgroup cols="2" align="left">
1099 <row><entry><constant>lmPassword</constant></entry><entry>the LANMAN password 16-byte hash stored as a character
1100 representation of a hexadecimal string.</entry></row>
1101 <row><entry><constant>ntPassword</constant></entry><entry>the NT password hash 16-byte stored as a character
1102 representation of a hexadecimal string.</entry></row>
1103 <row><entry><constant>pwdLastSet</constant></entry><entry>The integer time in seconds since 1970 when the
1104 <constant>lmPassword</constant> and <constant>ntPassword</constant> attributes were last set.
1107 <row><entry><constant>acctFlags</constant></entry><entry>string of 11 characters surrounded by square brackets []
1108 representing account flags such as U (user), W(workstation), X(no password expiration),
1109 I(Domain trust account), H(Home dir required), S(Server trust account),
1110 and D(disabled).</entry></row>
1112 <row><entry><constant>logonTime</constant></entry><entry>Integer value currently unused</entry></row>
1114 <row><entry><constant>logoffTime</constant></entry><entry>Integer value currently unused</entry></row>
1116 <row><entry><constant>kickoffTime</constant></entry><entry>Integer value currently unused</entry></row>
1118 <row><entry><constant>pwdCanChange</constant></entry><entry>Integer value currently unused</entry></row>
1120 <row><entry><constant>pwdMustChange</constant></entry><entry>Integer value currently unused</entry></row>
1122 <row><entry><constant>homeDrive</constant></entry><entry>specifies the drive letter to which to map the
1123 UNC path specified by homeDirectory. The drive letter must be specified in the form "X:"
1124 where X is the letter of the drive to map. Refer to the "logon drive" parameter in the
1125 smb.conf(5) man page for more information.</entry></row>
1127 <row><entry><constant>scriptPath</constant></entry><entry>The scriptPath property specifies the path of
1128 the user's logon script, .CMD, .EXE, or .BAT file. The string can be null. The path
1129 is relative to the netlogon share. Refer to the "logon script" parameter in the
1130 smb.conf(5) man page for more information.</entry></row>
1132 <row><entry><constant>profilePath</constant></entry><entry>specifies a path to the user's profile.
1133 This value can be a null string, a local absolute path, or a UNC path. Refer to the
1134 "logon path" parameter in the smb.conf(5) man page for more information.</entry></row>
1136 <row><entry><constant>smbHome</constant></entry><entry>The homeDirectory property specifies the path of
1137 the home directory for the user. The string can be null. If homeDrive is set and specifies
1138 a drive letter, homeDirectory should be a UNC path. The path must be a network
1139 UNC path of the form <filename>\\server\share\directory</filename>. This value can be a null string.
1140 Refer to the <command>logon home</command> parameter in the &smb.conf; man page for more information.
1143 <row><entry><constant>userWorkstation</constant></entry><entry>character string value currently unused.
1146 <row><entry><constant>rid</constant></entry><entry>the integer representation of the user's relative identifier
1147 (RID).</entry></row>
1149 <row><entry><constant>primaryGroupID</constant></entry><entry>the relative identifier (RID) of the primary group
1150 of the user.</entry></row>
1152 <row><entry><constant>domain</constant></entry><entry>domain the user is part of.</entry></row>
1158 The majority of these parameters are only used when Samba is acting as a PDC of
1159 a domain (refer to the <link linkend="samba-pdc">Samba as a primary domain controller</link> chapter for details on
1160 how to configure Samba as a Primary Domain Controller). The following four attributes
1161 are only stored with the sambaSamAccount entry if the values are non-default values:
1165 <member>smbHome</member>
1166 <member>scriptPath</member>
1167 <member>logonPath</member>
1168 <member>homeDrive</member>
1172 These attributes are only stored with the sambaSamAccount entry if
1173 the values are non-default values. For example, assume TASHTEGO has now been
1174 configured as a PDC and that <parameter>logon home = \\%L\%u</parameter> was defined in
1175 its &smb.conf; file. When a user named "becky" logons to the domain,
1176 the <parameter>logon home</parameter> string is expanded to \\TASHTEGO\becky.
1177 If the smbHome attribute exists in the entry "uid=becky,ou=people,dc=samba,dc=org",
1178 this value is used. However, if this attribute does not exist, then the value
1179 of the <parameter>logon home</parameter> parameter is used in its place. Samba
1180 will only write the attribute value to the directory entry if the value is
1181 something other than the default (e.g. <filename>\\MOBY\becky</filename>).
1187 <title>Example LDIF Entries for a sambaSamAccount</title>
1190 The following is a working LDIF with the inclusion of the posixAccount objectclass:
1195 dn: uid=guest2, ou=people,dc=plainjoe,dc=org
1196 ntPassword: 878D8014606CDA29677A44EFA1353FC7
1197 pwdMustChange: 2147483647
1198 primaryGroupID: 1201
1199 lmPassword: 552902031BEDE9EFAAD3B435B51404EE
1200 pwdLastSet: 1010179124
1202 objectClass: sambaSamAccount
1204 kickoffTime: 2147483647
1206 logoffTime: 2147483647
1213 The following is an LDIF entry for using both the sambaSamAccount and
1214 posixAccount objectclasses:
1219 dn: uid=gcarter, ou=people,dc=plainjoe,dc=org
1221 displayName: Gerald Carter
1222 lmPassword: 552902031BEDE9EFAAD3B435B51404EE
1223 primaryGroupID: 1201
1224 objectClass: posixAccount
1225 objectClass: sambaSamAccount
1227 userPassword: {crypt}BpM2ej8Rkzogo
1231 loginShell: /bin/bash
1232 logoffTime: 2147483647
1234 kickoffTime: 2147483647
1235 pwdLastSet: 1010179230
1237 homeDirectory: /home/tashtego/gcarter
1239 pwdMustChange: 2147483647
1240 ntPassword: 878D8014606CDA29677A44EFA1353FC7
1247 <title>Password synchronisation</title>
1250 Since version 3.0 samba can update the non-samba (LDAP) password stored with an account. When
1251 using pam_ldap, this allows changing both unix and windows passwords at once.
1254 <para>The <parameter>ldap passwd sync</parameter> options can have the following values:</para>
1259 <listitem><para>When the user changes his password, update
1260 <constant>ntPassword</constant>, <constant>lmPassword</constant>
1261 and the <constant>password</constant> fields.</para></listitem>
1266 <listitem><para>Only update <constant>ntPassword</constant> and <constant>lmPassword</constant>.</para></listitem>
1271 <listitem><para>Only update the LDAP password and let the LDAP server worry
1272 about the other fields. This option is only available when the LDAP server supports LDAP_EXOP_X_MODIFY_PASSWD. </para></listitem>
1276 <para>More information can be found in the <ulink url="smb.conf.5.html#LDAPPASSWDSYNC">smb.conf</ulink> manpage.
1284 <title>MySQL</title>
1287 Every so often someone will come along with a great new idea. Storing of user accounts in an
1288 SQL backend is one of them. Those who want to do this are in the best position to know what the
1289 specific benefits are to them. This may sound like a cop-out, but in truth we can not attempt
1290 to document every nitty little detail why certain things of marginal utility to the bulk of
1291 Samba users might make sense to the rest. In any case, the following instructions should help
1292 the determined SQL user to implement a working system.
1296 <title>Creating the database</title>
1299 You either can set up your own table and specify the field names to pdb_mysql (see below
1300 for the column names) or use the default table. The file <filename>examples/pdb/mysql/mysql.dump</filename>
1301 contains the correct queries to create the required tables. Use the command :
1303 <screen><prompt>$ </prompt><userinput>mysql -u<replaceable>username</replaceable> -h<replaceable>hostname</replaceable> -p<replaceable>password</replaceable> \
1304 <replaceable>databasename</replaceable> < <filename>/path/to/samba/examples/pdb/mysql/mysql.dump</filename></userinput></screen>
1309 <title>Configuring</title>
1311 <para>This plugin lacks some good documentation, but here is some short info:</para>
1313 <para>Add a the following to the <parameter>passdb backend</parameter> variable in your &smb.conf;:
1315 passdb backend = [other-plugins] mysql:identifier [other-plugins]
1319 <para>The identifier can be any string you like, as long as it doesn't collide with
1320 the identifiers of other plugins or other instances of pdb_mysql. If you
1321 specify multiple pdb_mysql.so entries in <parameter>passdb backend</parameter>, you also need to
1322 use different identifiers!
1326 Additional options can be given through the &smb.conf; file in the <parameter>[global]</parameter> section.
1331 <title>Basic smb.conf options for MySQL passdb backend</title>
1332 <tgroup cols="2" align="left">
1334 <row><entry>Field</entry><entry>Contents</entry></row>
1337 <row><entry>identifier:mysql host</entry><entry>host name, defaults to 'localhost'</entry></row>
1338 <row><entry>identifier:mysql password</entry><entry></entry></row>
1339 <row><entry>identifier:mysql user</entry><entry>defaults to 'samba'</entry></row>
1340 <row><entry>identifier:mysql database</entry><entry>defaults to 'samba'</entry></row>
1341 <row><entry>identifier:mysql port</entry><entry>defaults to 3306</entry></row>
1342 <row><entry>identifier:table</entry><entry>Name of the table containing users</entry></row>
1350 Since the password for the MySQL user is stored in the
1351 &smb.conf; file, you should make the the &smb.conf; file
1352 readable only to the user that runs Samba This is considered a security
1353 bug and will be fixed soon.
1357 <para>Names of the columns in this table (I've added column types those columns should have first):</para>
1361 <title>MySQL field names for MySQL passdb backend</title>
1362 <tgroup cols="3" align="left">
1364 <row><entry>Field</entry><entry>Type</entry><entry>Contents</entry></row>
1367 <row><entry>identifier:logon time column</entry><entry>int(9)</entry><entry></entry></row>
1368 <row><entry>identifier:logoff time column</entry><entry>int(9)</entry><entry></entry></row>
1369 <row><entry>identifier:kickoff time column</entry><entry>int(9)</entry><entry></entry></row>
1370 <row><entry>identifier:pass last set time column</entry><entry>int(9)</entry><entry></entry></row>
1371 <row><entry>identifier:pass can change time column</entry><entry>int(9)</entry><entry></entry></row>
1372 <row><entry>identifier:pass must change time column</entry><entry>int(9)</entry><entry></entry></row>
1373 <row><entry>identifier:username column</entry><entry>varchar(255)</entry><entry>unix username</entry></row>
1374 <row><entry>identifier:domain column</entry><entry>varchar(255)</entry><entry>NT domain user is part of</entry></row>
1375 <row><entry>identifier:nt username column</entry><entry>varchar(255)</entry><entry>NT username</entry></row>
1376 <row><entry>identifier:fullname column</entry><entry>varchar(255)</entry><entry>Full name of user</entry></row>
1377 <row><entry>identifier:home dir column</entry><entry>varchar(255)</entry><entry>Unix homedir path</entry></row>
1378 <row><entry>identifier:dir drive column</entry><entry>varchar(2)</entry><entry>Directory drive path (eg: 'H:')</entry></row>
1379 <row><entry>identifier:logon script column</entry><entry>varchar(255)</entry><entry>Batch file to run on client side when logging on</entry></row>
1380 <row><entry>identifier:profile path column</entry><entry>varchar(255)</entry><entry>Path of profile</entry></row>
1381 <row><entry>identifier:acct desc column</entry><entry>varchar(255)</entry><entry>Some ASCII NT user data</entry></row>
1382 <row><entry>identifier:workstations column</entry><entry>varchar(255)</entry><entry>Workstations user can logon to (or NULL for all)</entry></row>
1383 <row><entry>identifier:unknown string column</entry><entry>varchar(255)</entry><entry>unknown string</entry></row>
1384 <row><entry>identifier:munged dial column</entry><entry>varchar(255)</entry><entry>?</entry></row>
1385 <row><entry>identifier:user sid column</entry><entry>varchar(255)</entry><entry>NT user SID</entry></row>
1386 <row><entry>identifier:group sid column</entry><entry>varchar(255)</entry><entry>NT group ID</entry></row>
1387 <row><entry>identifier:lanman pass column</entry><entry>varchar(255)</entry><entry>encrypted lanman password</entry></row>
1388 <row><entry>identifier:nt pass column</entry><entry>varchar(255)</entry><entry>encrypted nt passwd</entry></row>
1389 <row><entry>identifier:plain pass column</entry><entry>varchar(255)</entry><entry>plaintext password</entry></row>
1390 <row><entry>identifier:acct control column</entry><entry>int(9)</entry><entry>nt user data</entry></row>
1391 <row><entry>identifier:unknown 3 column</entry><entry>int(9)</entry><entry>unknown</entry></row>
1392 <row><entry>identifier:logon divs column</entry><entry>int(9)</entry><entry>?</entry></row>
1393 <row><entry>identifier:hours len column</entry><entry>int(9)</entry><entry>?</entry></row>
1394 <row><entry>identifier:unknown 5 column</entry><entry>int(9)</entry><entry>unknown</entry></row>
1395 <row><entry>identifier:unknown 6 column</entry><entry>int(9)</entry><entry>unknown</entry></row>
1401 Eventually, you can put a colon (:) after the name of each column, which
1402 should specify the column to update when updating the table. You can also
1403 specify nothing behind the colon - then the data from the field will not be
1410 <title>Using plaintext passwords or encrypted password</title>
1413 I strongly discourage the use of plaintext passwords, however, you can use them:
1417 If you would like to use plaintext passwords, set
1418 'identifier:lanman pass column' and 'identifier:nt pass column' to
1419 'NULL' (without the quotes) and 'identifier:plain pass column' to the
1420 name of the column containing the plaintext passwords.
1424 If you use encrypted passwords, set the 'identifier:plain pass
1425 column' to 'NULL' (without the quotes). This is the default.
1431 <title>Getting non-column data from the table</title>
1434 It is possible to have not all data in the database and making some 'constant'.
1438 For example, you can set 'identifier:fullname column' to :
1439 <command>CONCAT(First_name,' ',Sur_name)</command>
1443 Or, set 'identifier:workstations column' to :
1444 <command>NULL</command></para>
1446 <para>See the MySQL documentation for more language constructs.</para>
1451 <sect2 id="XMLpassdb">
1454 <para>This module requires libxml2 to be installed.</para>
1456 <para>The usage of pdb_xml is pretty straightforward. To export data, use:
1460 <prompt>$ </prompt> <userinput>pdbedit -e xml:filename</userinput>
1464 (where filename is the name of the file to put the data in)
1468 To import data, use:
1469 <prompt>$ </prompt> <userinput>pdbedit -i xml:filename</userinput>
1475 <title>Common Errors</title>
1478 <title>Users can not logon - Users not in Samba SAM</title>
1481 People forget to put their users in their backend and then complain Samba won't authorize them.
1487 <title>Users are being added to the wrong backend database</title>
1490 A few complaints have been received from users that just moved to Samba-3. The following
1491 &smb.conf; file entries were causing problems, new accounts were being added to the old
1492 smbpasswd file, not to the tdbsam passdb.tdb file:
1499 passdb backend = smbpasswd, tdbsam, guest
1505 Samba will add new accounts to the first entry in the <emphasis>passdb backend</emphasis>
1506 parameter entry. If you want to update to the tdbsam, then change the entry to:
1513 passdb backend = tdbsam, smbpasswd, guest
1521 <title>auth methods does not work</title>
1524 If you explicitly set an 'auth methods' parameter, guest must be specified as the first
1525 entry on the line. Eg: <parameter>auth methods = guest sam</parameter>.
1529 This is the exact opposite of the requirement for the <parameter>passdb backed</parameter>
1530 option, where it must be the <emphasis>LAST</emphasis> parameter on the line.