trying to get HEAD building again. If you want the code
[ira/wip.git] / docs / htmldocs / passdb.html
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 11. Account Information Databases</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"><link rel="home" href="index.html" title="SAMBA Project Documentation"><link rel="up" href="optional.html" title="Part III. Advanced Configuration"><link rel="previous" href="NetworkBrowsing.html" title="Chapter 10. Samba / MS Windows Network Browsing Guide"><link rel="next" href="groupmapping.html" title="Chapter 12. Mapping MS Windows and Unix Groups"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 11. Account Information Databases</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="NetworkBrowsing.html">Prev</a> </td><th width="60%" align="center">Part III. Advanced Configuration</th><td width="20%" align="right"> <a accesskey="n" href="groupmapping.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="passdb"></a>Chapter 11. Account Information Databases</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Jelmer</span> <span class="othername">R.</span> <span class="surname">Vernooij</span></h3><div class="affiliation"><span class="orgname">The Samba Team<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:jelmer@samba.org">jelmer@samba.org</a>&gt;</tt></p></div></div></div></div><div><div class="author"><h3 class="author"><span class="firstname">Gerald</span> <span class="othername">(Jerry)</span> <span class="surname">Carter</span></h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:jerry@samba.org">jerry@samba.org</a>&gt;</tt></p></div></div></div></div><div><div class="author"><h3 class="author"><span class="firstname">Jeremy</span> <span class="surname">Allison</span></h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:jra@samba.org">jra@samba.org</a>&gt;</tt></p></div></div></div></div><div><div class="author"><h3 class="author"><span class="firstname">John</span> <span class="othername">H.</span> <span class="surname">Terpstra</span></h3><div class="affiliation"><span class="orgname">Samba Team<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:jht@samba.org">jht@samba.org</a>&gt;</tt></p></div></div></div></div><div><div class="author"><h3 class="author"><span class="firstname">Olivier (lem)</span> <span class="surname">Lemaire</span></h3><div class="affiliation"><span class="orgname">IDEALX<br></span><div class="address"><p><tt class="email">&lt;<a href="mailto:olem@IDEALX.org">olem@IDEALX.org</a>&gt;</tt></p></div></div></div></div><div><p class="pubdate">May 24, 2003</p></div></div><div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="passdb.html#id2910308">Features and Benefits</a></dt><dt><a href="passdb.html#id2910636">Technical Information</a></dt><dd><dl><dt><a href="passdb.html#id2910700">Important Notes About Security</a></dt><dt><a href="passdb.html#id2910954">Mapping User Identifiers between MS Windows and Unix</a></dt></dl></dd><dt><a href="passdb.html#id2911009">Account Management Tools</a></dt><dd><dl><dt><a href="passdb.html#id2911041">The smbpasswd Command</a></dt><dt><a href="passdb.html#id2911306">The pdbedit Command</a></dt></dl></dd><dt><a href="passdb.html#id2911458">Password Backends</a></dt><dd><dl><dt><a href="passdb.html#id2911494">Plain Text</a></dt><dt><a href="passdb.html#id2911534">smbpasswd - Encrypted Password Database</a></dt><dt><a href="passdb.html#id2911641">tdbsam</a></dt><dt><a href="passdb.html#id2911668">ldapsam</a></dt><dt><a href="passdb.html#id2913185">MySQL</a></dt><dt><a href="passdb.html#XMLpassdb">XML</a></dt></dl></dd><dt><a href="passdb.html#id2913989">Common Errors</a></dt><dd><dl><dt><a href="passdb.html#id2913997">Users can not logon - Users not in Samba SAM</a></dt><dt><a href="passdb.html#id2914012">Users are being added to the wrong backend database</a></dt><dt><a href="passdb.html#id2914072">auth methods does not work</a></dt></dl></dd></dl></div><p>
2 Samba-3 implements a new capability to work concurrently with multiple account backends.
3 The possible new combinations of password backends allows Samba-3 a degree of flexibility
4 and scalability that previously could be achieved only with MS Windows Active Directory.
5 This chapter describes the new functionality and how to get the most out of it.
6 </p><p>
7 In the course of development of Samba-3, a number of requests were received to provide the
8 ability to migrate MS Windows NT4 SAM accounts to Samba-3 without the need to provide
9 matching Unix/Linux accounts. We called this the <span class="emphasis"><em>Non Unix Accounts (NUA)</em></span>
10 capability. The intent was that an administrator could decide to use the <span class="emphasis"><em>tdbsam</em></span>
11 backend and by simply specifying <span class="emphasis"><em>&quot;passdb backend = tdbsam_nua, guest&quot;</em></span>
12 this would allow Samba-3 to implement a solution that did not use Unix accounts per se. Late
13 in the development cycle, the team doing this work hit upon some obstacles that prevents this
14 solution from being used. Given the delays with Samba-3 release a decision was made to NOT
15 deliver this functionality until a better method of recognising NT Group SIDs from NT User
16 SIDs could be found. This feature may thus return during the life cycle for the Samba-3 series.
17 </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
18 Samba-3.0.0 does NOT support Non-Unix Account (NUA) operation.
19 </p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2910308"></a>Features and Benefits</h2></div></div><div></div></div><p>
20 Samba-3 provides for complete backwards compatibility with Samba-2.2.x functionality
21 as follows:
22 </p><div class="variablelist"><p class="title"><b>Backwards Compatibility Backends</b></p><dl><dt><span class="term">Plain Text:</span></dt><dd><p>
23                         This option uses nothing but the Unix/Linux <tt class="filename">/etc/passwd</tt>
24                         style back end. On systems that have PAM (Pluggable Authentication Modules)
25                         support all PAM modules are supported. The behaviour is just as it was with
26                         Samba-2.2.x, and the protocol limitations imposed by MS Windows clients
27                         apply likewise.
28                         </p></dd><dt><span class="term">smbpasswd:</span></dt><dd><p>
29                         This option allows continues use of the <tt class="filename">smbpasswd</tt>
30                         file that maintains a plain ASCII (text) layout that includes the MS Windows
31                         LanMan and NT encrypted passwords as well as a field that stores some
32                         account information. This form of password backend does NOT store any of
33                         the MS Windows NT/200x SAM (Security Account Manager) information needed to
34                         provide the extended controls that are needed for more comprehensive 
35                         interoperation with MS Windows NT4 / 200x servers.
36                         </p><p>
37                         This backend should be used only for backwards compatibility with older
38                         versions of Samba. It may be deprecated in future releases.
39                         </p></dd><dt><span class="term">ldapsam_compat (Samba-2.2 LDAP Compatibility):</span></dt><dd><p>
40                         There is a password backend option that allows continued operation with
41                         a existing OpenLDAP backend that uses the Samba-2.2.x LDAP schema extension.
42                         This option is provided primarily as a migration tool, although there is
43                         no reason to force migration at this time. Note that this tool will eventually
44                         be deprecated.
45                         </p></dd></dl></div><p>
46 Samba-3 introduces the following new password backend capabilities:
47 </p><div class="variablelist"><p class="title"><b>New Backends</b></p><dl><dt><span class="term">guest:</span></dt><dd><p>
48                         This is <span class="emphasis"><em>always</em></span> required as the last backend specified.
49                         It provides the ability to handle guest account requirements for access to
50                         resources like <i class="parameter"><tt>IPC$</tt></i> which is used for browsing.
51                         </p></dd><dt><span class="term">tdbsam:</span></dt><dd><p>
52                         This backend provides a rich database backend for local servers. This
53                         backend is NOT suitable for multiple domain controller (ie: PDC + one
54                         or more BDC) installations.
55                         </p><p>
56                         The <span class="emphasis"><em>tdbsam</em></span> password backend stores the old <span class="emphasis"><em>
57                         smbpasswd</em></span> information PLUS the extended MS Windows NT / 200x
58                         SAM information into a binary format TDB (trivial database) file.
59                         The inclusion of the extended information makes it possible for Samba-3
60                         to implement the same account and system access controls that are possible
61                         with MS Windows NT4 and MS Windows 200x based systems.
62                         </p><p>
63                         The inclusion of the <span class="emphasis"><em>tdbsam</em></span> capability is a direct
64                         response to user requests to allow simple site operation without the overhead
65                         of the complexities of running OpenLDAP. It is recommended to use this only
66                         for sites that have fewer than 250 users. For larger sites or implementations
67                         the use of OpenLDAP or of Active Directory integration is strongly recommended.
68                         </p></dd><dt><span class="term">ldapsam:</span></dt><dd><p>
69                         This provides a rich directory backend for distributed account installation.    
70                         </p><p>
71                         Samba-3 has a new and extended LDAP implementation that requires configuration
72                         of OpenLDAP with a new format samba schema. The new format schema file is
73                         included in the <tt class="filename">examples/LDAP</tt> directory of the Samba distribution.
74                         </p><p>
75                         The new LDAP implementation significantly expands the control abilities that
76                         were possible with prior versions of Samba. It is now possible to specify
77                         &quot;per user&quot; profile settings, home directories, account access controls, and
78                         much more. Corporate sites will see that the Samba-Team has listened to their
79                         requests both for capability and to allow greater scalability.
80                         </p></dd><dt><span class="term">mysqlsam (MySQL based backend):</span></dt><dd><p>
81                         It is expected that the MySQL based SAM will be very popular in some corners.
82                         This database backend will be on considerable interest to sites that want to
83                         leverage existing MySQL technology.
84                         </p></dd><dt><span class="term">xmlsam (XML based datafile):</span></dt><dd><p>
85                         Allows the account and password data to be stored in an XML format
86                         data file. This backend can not be used for normal operation, it can only 
87                         be used in conjunction with <b class="command">pdbedit</b>'s pdb2pdb 
88                         functionality. The DTD that is used might be subject to changes in the future.
89                         </p><p>
90                         The xmlsam option can be useful for account migration between database
91                         backends or backups. Use of this tool will allow the data to be edited before migration
92                         into another backend format.
93                         </p></dd><dt><span class="term">nisplussam:</span></dt><dd><p>
94                         The  NIS+ based passdb backend. Takes name NIS domain as an
95                         optional argument. Only works with Sun NIS+ servers.
96                         </p></dd></dl></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2910636"></a>Technical Information</h2></div></div><div></div></div><p>
97         Old windows clients send plain text passwords over the wire. Samba can check these
98         passwords by crypting them and comparing them to the hash stored in the unix user database.
99         </p><p>
100         Newer windows clients send encrypted passwords (so-called Lanman and NT hashes) over 
101         the wire, instead of plain text passwords. The newest clients will send only encrypted
102         passwords and refuse to send plain text passwords, unless their registry is tweaked.
103         </p><p>
104         These passwords can't be converted to unix style encrypted passwords. Because of that,
105         you can't use the standard unix user database, and you have to store the Lanman and NT
106         hashes somewhere else.
107         </p><p>
108         In addition to differently encrypted passwords, windows also stores certain data for each
109         user that is not stored in a unix user database. e.g: workstations the user may logon from,
110         the location where the users' profile is stored, and so on. Samba retrieves and stores this
111         information using a <i class="parameter"><tt>passdb backend</tt></i>.  Commonly available backends are LDAP, plain text
112         file, MySQL and nisplus.  For more information, see the man page for <tt class="filename">smb.conf</tt> regarding the 
113         <i class="parameter"><tt>passdb backend</tt></i> parameter.
114         </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2910700"></a>Important Notes About Security</h3></div></div><div></div></div><p>
115                 The unix and SMB password encryption techniques seem similar on the surface. This
116                 similarity is, however, only skin deep. The unix scheme typically sends clear text
117                 passwords over the network when logging in. This is bad. The SMB encryption scheme
118                 never sends the cleartext password over the network but it does store the 16 byte 
119                 hashed values on disk. This is also bad. Why? Because the 16 byte hashed values
120                 are a &quot;password equivalent&quot;. You cannot derive the user's password from them, but
121                 they could potentially be used in a modified client to gain access to a server.
122                 This would require considerable technical knowledge on behalf of the attacker but
123                 is perfectly possible. You should thus treat the data stored in whatever passdb
124                 backend you use (smbpasswd file, ldap, mysql) as though it contained the cleartext
125                 passwords of all your users. Its contents must be kept secret, and the file should
126                 be protected accordingly.
127                 </p><p>
128                 Ideally we would like a password scheme that involves neither plain text passwords
129                 on the net nor on disk. Unfortunately this is not available as Samba is stuck with
130                 having to be compatible with other SMB systems (WinNT, WfWg, Win95 etc).
131                 </p><p>
132                 Windows NT 4.0 Service pack 3 changed the default setting so that plaintext passwords
133                 are disabled from being sent over the wire. This mandates either the use of encrypted
134                 password support or edit the Windows NT registry to re-enable plaintext passwords.
135                 </p><p>
136                 The following versions of MS Windows do not support full domain security protocols,
137                 although they may log onto a domain environment:
138                 </p><table class="simplelist" border="0" summary="Simple list"><tr><td>MS DOS Network client 3.0 with the basic network redirector installed</td></tr><tr><td>Windows 95 with the network redirector update installed</td></tr><tr><td>Windows 98 [se]</td></tr><tr><td>Windows Me</td></tr></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
139                 MS Windows XP Home does not have facilities to become a domain member and it can
140                 not participate in domain logons.
141                 </p></div><p>
142                 The following versions of MS Windows fully support domain security protocols.
143                 </p><table class="simplelist" border="0" summary="Simple list"><tr><td>Windows NT 3.5x</td></tr><tr><td>Windows NT 4.0</td></tr><tr><td>Windows 2000 Professional</td></tr><tr><td>Windows 200x Server/Advanced Server</td></tr><tr><td>Windows XP Professional</td></tr></table><p>
144                 All current release of Microsoft SMB/CIFS clients support authentication via the
145                 SMB Challenge/Response mechanism described here. Enabling clear text authentication
146                 does not disable the ability of the client to participate in encrypted authentication.
147                 Instead, it allows the client to negotiate either plain text _or_ encrypted password
148                 handling.
149                 </p><p>
150                 MS Windows clients will cache the encrypted password alone. Where plain text passwords
151                 are re-enabled, through the appropriate registry change, the plain text password is NEVER
152                 cached. This means that in the event that a network connections should become disconnected
153                 (broken) only the cached (encrypted) password will be sent to the resource server to
154                 affect a auto-reconnect. If the resource server does not support encrypted passwords the
155                 auto-reconnect will fail. <span class="emphasis"><em>USE OF ENCRYPTED PASSWORDS IS STRONGLY ADVISED.</em></span>
156                 </p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2910863"></a>Advantages of Encrypted Passwords</h4></div></div><div></div></div><div class="itemizedlist"><ul type="disc"><li><p>Plain text passwords are not passed across 
157                                 the network. Someone using a network sniffer cannot just 
158                                 record passwords going to the SMB server.</p></li><li><p>Plain text passwords are not stored anywhere in
159                                 memory or on disk.</p></li><li><p>WinNT doesn't like talking to a server 
160                                 that does not support encrypted passwords. It will refuse 
161                                 to browse the server if the server is also in user level 
162                                 security mode. It will insist on prompting the user for the 
163                                 password on each connection, which is very annoying. The
164                                 only things you can do to stop this is to use SMB encryption.
165                                 </p></li><li><p>Encrypted password support allows automatic share
166                                 (resource) reconnects.</p></li><li><p>Encrypted passwords are essential for PDC/BDC
167                                 operation.</p></li></ul></div></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2910917"></a>Advantages of non-encrypted passwords</h4></div></div><div></div></div><div class="itemizedlist"><ul type="disc"><li><p>Plain text passwords are not kept 
168                                 on disk, and are NOT cached in memory. </p></li><li><p>Uses same password file as other unix 
169                                 services such as login and ftp</p></li><li><p>Use of other services (such as telnet and ftp) which
170                                 send plain text passwords over the net, so sending them for SMB
171                                 isn't such a big deal.</p></li></ul></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2910954"></a>Mapping User Identifiers between MS Windows and Unix</h3></div></div><div></div></div><p>
172         Every operation in Unix/Linux requires a user identifier (UID), just as in
173         MS Windows NT4 / 200x this requires a Security Identifier (SID). Samba provides
174         two means for mapping an MS Windows user to a Unix/Linux UID.
175         </p><p>
176         Firstly, all Samba SAM (Security Account Manager database) accounts require
177         a Unix/Linux UID that the account will map to. As users are added to the account
178         information database, Samba-3 will call the <i class="parameter"><tt>add user script</tt></i>
179         interface to add the account to the Samba host OS. In essence, all accounts in
180         the local SAM require a local user account.
181         </p><p>
182         The second way to affect Windows SID to Unix UID mapping is via the
183         <span class="emphasis"><em>idmap uid, idmap gid</em></span> parameters in <tt class="filename">smb.conf</tt>.
184         Please refer to the man page for information about these parameters.
185         These parameters are essential when mapping users from a remote SAM server.
186         </p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2911009"></a>Account Management Tools</h2></div></div><div></div></div><p>
187 Samba-3 provides two (2) tools for management of User and machine accounts. These tools are
188 called <b class="command">smbpasswd</b> and <b class="command">pdbedit</b>. A third tool is under
189 development but is NOT expected to ship in time for Samba-3.0.0. The new tool will be a TCL/TK
190 GUI tool that looks much like the MS Windows NT4 Domain User Manager - hopefully this will
191 be announced in time for the Samba-3.0.1 release.
192 </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2911041"></a>The <span class="emphasis"><em>smbpasswd</em></span> Command</h3></div></div><div></div></div><p>
193                 The smbpasswd utility is a utility similar to the <b class="command">passwd</b>
194                 or <b class="command">yppasswd</b> programs.  It maintains the two 32 byte password
195                 fields in the passdb backend.
196                 </p><p>
197                 <b class="command">smbpasswd</b> works in a client-server mode where it contacts the
198                 local smbd to change the user's password on its behalf. This has enormous benefits
199                 as follows:
200                 </p><p>
201                 <b class="command">smbpasswd</b> has the capability to change passwords on Windows NT
202                 servers (this only works when the request is sent to the NT Primary Domain Controller
203                 if changing an NT Domain user's password).
204                 </p><p>
205                 <b class="command">smbpasswd</b> can be used to:
206                 </p><table class="simplelist" border="0" summary="Simple list"><tr><td><span class="emphasis"><em>add</em></span> user or machine accounts</td></tr><tr><td><span class="emphasis"><em>delete</em></span> user or machine accounts</td></tr><tr><td><span class="emphasis"><em>enable</em></span> user or machine accounts</td></tr><tr><td><span class="emphasis"><em>disable</em></span> user or machine accounts</td></tr><tr><td><span class="emphasis"><em>set to NULL</em></span> user passwords</td></tr><tr><td><span class="emphasis"><em>manage interdomain trust accounts</em></span></td></tr></table><p>
207                 To run smbpasswd as a normal user just type:
208                 </p><p>
209                 </p><pre class="screen">
210                 <tt class="prompt">$ </tt><b class="userinput"><tt>smbpasswd</tt></b>
211                 <tt class="prompt">Old SMB password: </tt><b class="userinput"><tt><i class="replaceable"><tt>secret</tt></i></tt></b>
212                 </pre><p>
213                 For <i class="replaceable"><tt>secret</tt></i> type old value here - or hit return if
214                 there was no old password
215                 </p><pre class="screen">
216                 <tt class="prompt">New SMB Password: </tt><b class="userinput"><tt><i class="replaceable"><tt>new secret</tt></i></tt></b>
217                 <tt class="prompt">Repeat New SMB Password: </tt><b class="userinput"><tt><i class="replaceable"><tt>new secret</tt></i></tt></b>
218                 </pre><p>
219                 </p><p>
220                 If the old value does not match the current value stored for that user, or the two
221                 new values do not match each other, then the password will not be changed.
222                 </p><p>
223                 When invoked by an ordinary user it will only allow change of their own
224                 SMB password.
225                 </p><p>
226                 When run by root smbpasswd may take an optional argument, specifying
227                 the user name whose SMB password you wish to change. When run as root, smbpasswd
228                 does not prompt for or check the old password value, thus allowing root to set passwords 
229                 for users who have forgotten their passwords.
230                 </p><p>
231                 <b class="command">smbpasswd</b> is designed to work in the way familiar to UNIX
232                 users who use the <b class="command">passwd</b> or <b class="command">yppasswd</b> commands.
233                 While designed for administrative use, this tool provides essential user level
234                 password change capabilities.
235                 </p><p>
236                 For more details on using <b class="command">smbpasswd</b> refer to the man page (the
237                 definitive reference).
238                 </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2911306"></a>The <span class="emphasis"><em>pdbedit</em></span> Command</h3></div></div><div></div></div><p>
239                 <b class="command">pdbedit</b> is a tool that can be used only by root. It is used to
240                 manage the passdb backend. <b class="command">pdbedit</b> can be used to:
241                 </p><table class="simplelist" border="0" summary="Simple list"><tr><td>add, remove or modify user accounts</td></tr><tr><td>listing user accounts</td></tr><tr><td>migrate user accounts</td></tr></table><p>
242                 The <b class="command">pdbedit</b> tool is the only one that can manage the account
243                 security and policy settings. It is capable of all operations that smbpasswd can
244                 do as well as a super set of them.
245                 </p><p>
246                 One particularly important purpose of the <b class="command">pdbedit</b> is to allow
247                 the migration of account information from one passdb backend to another. See the
248                 <a href="passdb.html#XMLpassdb" title="XML">XML</a> password backend section of this chapter.
249                 </p><p>
250                 The following is an example of the user account information that is stored in
251                 a tdbsam password backend. This listing was produced by running:
252                 </p><pre class="screen">
253                 <tt class="prompt">$ </tt><b class="userinput"><tt>pdbedit -Lv met</tt></b>
254                 Unix username:        met
255                 NT username:
256                 Account Flags:        [UX         ]
257                 User SID:             S-1-5-21-1449123459-1407424037-3116680435-2004
258                 Primary Group SID:    S-1-5-21-1449123459-1407424037-3116680435-1201
259                 Full Name:            Melissa E Terpstra
260                 Home Directory:       \\frodo\met\Win9Profile
261                 HomeDir Drive:        H:
262                 Logon Script:         scripts\logon.bat
263                 Profile Path:         \\frodo\Profiles\met
264                 Domain:               MIDEARTH
265                 Account desc:
266                 Workstations:         melbelle
267                 Munged dial:
268                 Logon time:           0
269                 Logoff time:          Mon, 18 Jan 2038 20:14:07 GMT
270                 Kickoff time:         Mon, 18 Jan 2038 20:14:07 GMT
271                 Password last set:    Sat, 14 Dec 2002 14:37:03 GMT
272                 Password can change:  Sat, 14 Dec 2002 14:37:03 GMT
273                 Password must change: Mon, 18 Jan 2038 20:14:07 GMT
274                 </pre></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2911458"></a>Password Backends</h2></div></div><div></div></div><p>
275 Samba-3 offers the greatest flexibility in backend account database design of any SMB/CIFS server
276 technology available today. The flexibility is immediately obvious as one begins to explore this
277 capability.
278 </p><p>
279 It is possible to specify not only multiple different password backends, but even multiple
280 backends of the same type. For example, to use two different tdbsam databases:
281 </p><p>
282 </p><pre class="programlisting">
283 [globals]
284                 passdb backend = tdbsam:/etc/samba/passdb.tdb, \
285                 tdbsam:/etc/samba/old-passdb.tdb, guest
286 </pre><p>
287 </p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2911494"></a>Plain Text</h3></div></div><div></div></div><p>
288                 Older versions of Samba retrieved user information from the unix user database 
289                 and eventually some other fields from the file <tt class="filename">/etc/samba/smbpasswd</tt>
290                 or <tt class="filename">/etc/smbpasswd</tt>. When password encryption is disabled, no 
291                 SMB specific data is stored at all. Instead all operations are conducted via the way
292                 that the Samba host OS will access its <tt class="filename">/etc/passwd</tt> database.
293                 eg: On Linux systems that is done via PAM.
294                 </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2911534"></a>smbpasswd - Encrypted Password Database</h3></div></div><div></div></div><p>
295                 Traditionally, when configuring <a href="smb.conf.5.html#ENCRYPTPASSWORDS" target="_top">encrypt
296                 passwords = yes</a> in Samba's <tt class="filename">smb.conf</tt> file, user account
297                 information such as username, LM/NT password hashes, password change times, and account
298                 flags have been stored in the <tt class="filename">smbpasswd(5)</tt> file.  There are several
299                 disadvantages to this approach for sites with very large numbers of users (counted
300                 in the thousands).
301                 </p><div class="itemizedlist"><ul type="disc"><li><p>
302                 The first is that all lookups must be performed sequentially.  Given that
303                 there are approximately two lookups per domain logon (one for a normal
304                 session connection such as when mapping a network drive or printer), this
305                 is a performance bottleneck for large sites.  What is needed is an indexed approach
306                 such as is used in databases.
307                 </p></li><li><p>
308                 The second problem is that administrators who desire to replicate a smbpasswd file
309                 to more than one Samba server were left to use external tools such as
310                 <b class="command">rsync(1)</b> and <b class="command">ssh(1)</b> and wrote custom,
311                 in-house scripts.
312                 </p></li><li><p>
313                 And finally, the amount of information which is stored in an smbpasswd entry leaves
314                 no room for additional attributes such as a home directory, password expiration time,
315                 or even a Relative Identifier (RID).
316                 </p></li></ul></div><p>
317                 As a result of these deficiencies, a more robust means of storing user attributes
318                 used by smbd was developed.  The API which defines access to user accounts
319                 is commonly referred to as the samdb interface (previously this was called the passdb
320                 API, and is still so named in the Samba CVS trees). 
321                 </p><p>
322                 Samba-3 provides an enhanced set of passdb backends that overcome the deficiencies
323                 of the smbpasswd plain text database. These are tdbsam, ldapsam, and xmlsam.
324                 Of these ldapsam will be of most interest to large corporate or enterprise sites.
325                 </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2911641"></a>tdbsam</h3></div></div><div></div></div><p>Samba can store user and machine account data in a &quot;TDB&quot; (Trivial Database).
326                 Using this backend doesn't require any additional configuration. This backend is
327                 recommended for new installations that do not require LDAP.
328                 </p><p>
329                 As a general guide the Samba-Team does NOT recommend using the tdbsam backend for sites
330                 that have 250 or more users. Additionally, tdbsam is not capable of scaling for use
331                 in sites that require PDB/BDC implementations that requires replication of the account
332                 database. Clearly, for reason of scalability, the use of ldapsam should be encouraged.
333                 </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2911668"></a>ldapsam</h3></div></div><div></div></div><p>
334                 There are a few points to stress that the ldapsam does not provide. The LDAP
335                 support referred to in the this documentation does not include:
336                 </p><div class="itemizedlist"><ul type="disc"><li><p>A means of retrieving user account information from
337                         an Windows 200x Active Directory server.</p></li><li><p>A means of replacing /etc/passwd.</p></li></ul></div><p>
338                 The second item can be accomplished by using LDAP NSS and PAM modules.  LGPL
339                 versions of these libraries can be obtained from PADL Software
340                 (<a href="http://www.padl.com/" target="_top">http://www.padl.com/</a>). More
341                 information about the configuration of these packages may be found at &quot;LDAP,
342                 System Administration; Gerald Carter, O'Reilly; Chapter 6: Replacing NIS&quot;.
343                 Refer to <a href="http://safari.oreilly.com/?XmlId=1-56592-491-6" target="_top">
344                 http://safari.oreilly.com/?XmlId=1-56592-491-6</a> for those who might wish to know
345                 more about configuration and administration of an OpenLDAP server.
346                 </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
347                 This section is outdated for Samba-3 schema. Samba-3 introduces a new schema
348                 that has not been documented at the time of this publication.
349                 </p></div><p>
350                 This document describes how to use an LDAP directory for storing Samba user
351                 account information traditionally stored in the smbpasswd(5) file.  It is
352                 assumed that the reader already has a basic understanding of LDAP concepts
353                 and has a working directory server already installed.  For more information
354                 on LDAP architectures and Directories, please refer to the following sites.
355                 </p><div class="itemizedlist"><ul type="disc"><li><p>OpenLDAP - <a href="http://www.openldap.org/" target="_top">http://www.openldap.org/</a></p></li><li><p>iPlanet Directory Server -
356                          <a href="http://iplanet.netscape.com/directory" target="_top">http://iplanet.netscape.com/directory</a></p></li></ul></div><p>
357                 Two additional Samba resources which may prove to be helpful are
358                 </p><div class="itemizedlist"><ul type="disc"><li><p>The <a href="http://www.unav.es/cti/ldap-smb/ldap-smb-3-howto.html" target="_top">Samba-PDC-LDAP-HOWTO</a>
359                         maintained by Ignacio Coupeau.</p></li><li><p>The NT migration scripts from <a href="http://samba.idealx.org/" target="_top">IDEALX</a> that are
360                         geared to manage users and group in such a Samba-LDAP Domain Controller configuration.
361                         </p></li></ul></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2911821"></a>Supported LDAP Servers</h4></div></div><div></div></div><p>
362                         The LDAP ldapsam code has been developed and tested using the OpenLDAP 2.0 and 2.1 server and
363                         client libraries.  The same code should work with Netscape's Directory Server and client SDK.
364                         However, there are bound to be compile errors and bugs. These should not be hard to fix.
365                         Please submit fixes via <a href="bugreport.html" title="Chapter 35. Reporting Bugs">Bug reporting facility</a>.
366                         </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2911847"></a>Schema and Relationship to the RFC 2307 posixAccount</h4></div></div><div></div></div><p>
367                         Samba 3.0 includes the necessary schema file for OpenLDAP 2.0 in
368                         <tt class="filename">examples/LDAP/samba.schema</tt>.  The sambaSamAccount objectclass is given here:
369                         </p><p>
370 </p><pre class="programlisting">
371 objectclass ( 1.3.6.1.4.1.7165.2.2.3 NAME 'sambaSamAccount' SUP top AUXILIARY
372     DESC 'Samba Auxiliary Account'
373     MUST ( uid $ rid )
374     MAY  ( cn $ lmPassword $ ntPassword $ pwdLastSet $ logonTime $
375            logoffTime $ kickoffTime $ pwdCanChange $ pwdMustChange $ acctFlags $
376            displayName $ smbHome $ homeDrive $ scriptPath $ profilePath $
377            description $ userWorkstations $ primaryGroupID $ domain ))
378 </pre><p>
379 </p><p>
380                         The <tt class="filename">samba.schema</tt> file has been formatted for OpenLDAP 2.0/2.1.
381                         The OID's are owned by the Samba Team and as such is legal to be openly published.
382                         If you translate the schema to be used with Netscape DS, please
383                         submit the modified schema file as a patch to
384                         <a href="mailto:jerry@samba.org" target="_top">jerry@samba.org</a>.
385                         </p><p>
386                         Just as the smbpasswd file is meant to store information which supplements a
387                         user's <tt class="filename">/etc/passwd</tt> entry, so is the sambaSamAccount object
388                         meant to supplement the UNIX user account information.  A sambaSamAccount is a
389                         <tt class="constant">STRUCTURAL</tt> objectclass so it can be stored individually
390                         in the directory.  However, there are several fields (e.g. uid) which overlap
391                         with the posixAccount objectclass outlined in RFC2307.  This is by design.
392                         </p><p>
393                         In order to store all user account information (UNIX and Samba) in the directory,
394                         it is necessary to use the sambaSamAccount and posixAccount objectclasses in
395                         combination.  However, smbd will still obtain the user's UNIX account
396                         information via the standard C library calls (e.g. getpwnam(), et. al.).
397                         This means that the Samba server must also have the LDAP NSS library installed
398                         and functioning correctly.  This division of information makes it possible to
399                         store all Samba account information in LDAP, but still maintain UNIX account
400                         information in NIS while the network is transitioning to a full LDAP infrastructure.
401                         </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2911953"></a>OpenLDAP configuration</h4></div></div><div></div></div><p>
402                         To include support for the sambaSamAccount object in an OpenLDAP directory
403                         server, first copy the samba.schema file to slapd's configuration directory.
404                         The samba.schema file can be found in the directory <tt class="filename">examples/LDAP</tt>
405                         in the samba source distribution.
406                         </p><p>
407 </p><pre class="screen">
408 <tt class="prompt">root# </tt><b class="userinput"><tt>cp samba.schema /etc/openldap/schema/</tt></b>
409 </pre><p>
410 </p><p>
411                         Next, include the <tt class="filename">samba.schema</tt> file in <tt class="filename">slapd.conf</tt>.
412                         The sambaSamAccount object contains two attributes which depend upon other schema
413                         files.  The 'uid' attribute is defined in <tt class="filename">cosine.schema</tt> and
414                         the 'displayName' attribute is defined in the <tt class="filename">inetorgperson.schema</tt>
415                         file.  Both of these must be included before the <tt class="filename">samba.schema</tt> file.
416                         </p><p>
417 </p><pre class="programlisting">
418 ## /etc/openldap/slapd.conf
419
420 ## schema files (core.schema is required by default)
421 include            /etc/openldap/schema/core.schema
422
423 ## needed for sambaSamAccount
424 include            /etc/openldap/schema/cosine.schema
425 include            /etc/openldap/schema/inetorgperson.schema
426 include            /etc/openldap/schema/samba.schema
427 include            /etc/openldap/schema/nis.schema
428 ....
429 </pre><p>
430 </p><p>
431                 It is recommended that you maintain some indices on some of the most useful attributes,
432                 like in the following example, to speed up searches made on sambaSamAccount objectclasses
433                 (and possibly posixAccount and posixGroup as well).
434                 </p><p>
435 </p><pre class="screen">
436 # Indices to maintain
437 ## required by OpenLDAP
438 index objectclass             eq
439
440 index cn                      pres,sub,eq
441 index sn                      pres,sub,eq
442 ## required to support pdb_getsampwnam
443 index uid                     pres,sub,eq
444 ## required to support pdb_getsambapwrid()
445 index displayName             pres,sub,eq
446
447 ## uncomment these if you are storing posixAccount and
448 ## posixGroup entries in the directory as well
449 ##index uidNumber               eq
450 ##index gidNumber               eq
451 ##index memberUid               eq
452
453 index   sambaSID              eq
454 index   sambaPrimaryGroupSID  eq
455 index   sambaDomainName       eq
456 index   default               sub
457 </pre><p>
458 </p><p>
459                 Create the new index by executing:
460                 </p><p>
461 </p><pre class="screen">
462 ./sbin/slapindex -f slapd.conf
463 </pre><p>
464 </p><p>
465                 Remember to restart slapd after making these changes:
466                 </p><p>
467 </p><pre class="screen">
468 <tt class="prompt">root# </tt><b class="userinput"><tt>/etc/init.d/slapd restart</tt></b>
469 </pre><p>
470 </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2912141"></a>Initialise the LDAP database</h4></div></div><div></div></div><p>
471                 Before you can add accounts to the LDAP database you must create the account containers
472                 that they will be stored in. The following LDIF file should be modified to match your
473                 needs (ie: Your DNS entries, etc.).
474                 </p><p>
475 </p><pre class="screen">
476 # Organization for Samba Base
477 dn: dc=plainjoe,dc=org
478 objectclass: dcObject
479 objectclass: organization
480 dc: plainjoe
481 o: Terpstra Org Network
482 description: The Samba-3 Network LDAP Example
483
484 # Organizational Role for Directory Management
485 dn: cn=Manager,dc=plainjoe,dc=org
486 objectclass: organizationalRole
487 cn: Manager
488 description: Directory Manager
489
490 # Setting up container for users
491 dn: ou=People,dc=plainjoe,dc=org
492 objectclass: top
493 objectclass: organizationalUnit
494 ou: People
495
496 # Setting up admin handle for People OU
497 dn: cn=admin,ou=People,dc=plainjoe,dc=org
498 cn: admin
499 objectclass: top
500 objectclass: organizationalRole
501 objectclass: simpleSecurityObject
502 userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz
503 </pre><p>
504 </p><p>
505                 The userPassword shown above should be generated using <b class="command">slappasswd</b>.
506                 </p><p>
507                 The following command will then load the contents of the LDIF file into the LDAP
508                 database.
509                 </p><p>
510 </p><pre class="screen">
511 <tt class="prompt">$ </tt><b class="userinput"><tt>slapadd -v -l initldap.dif</tt></b>
512 </pre><p>
513 </p><p>
514                 Do not forget to secure your LDAP server with an adequate access control list,
515                 as well as an admin password.
516                 </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
517                 Before Samba can access the LDAP server you need to store the LDAP admin password
518                 into the Samba-3 <tt class="filename">secrets.tdb</tt> database by:
519                 </p><pre class="screen">
520 <tt class="prompt">root# </tt> <b class="userinput"><tt>smbpasswd -w <i class="replaceable"><tt>secret</tt></i></tt></b>
521                 </pre><p>
522                 </p></div></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2912270"></a>Configuring Samba</h4></div></div><div></div></div><p>
523                         The following parameters are available in smb.conf only if your
524                         version of samba was built with LDAP support. Samba automatically builds with LDAP support if the
525                         LDAP libraries are found.
526                         </p><div class="itemizedlist"><ul type="disc"><li><p><a href="smb.conf.5.html#PASSDBBACKEND" target="_top">passdb backend = ldapsam:url</a></p></li><li><p><a href="smb.conf.5.html#LDAPSSL" target="_top">ldap ssl</a></p></li><li><p><a href="smb.conf.5.html#LDAPADMINDN" target="_top">ldap admin dn</a></p></li><li><p><a href="smb.conf.5.html#LDAPSUFFIX" target="_top">ldap suffix</a></p></li><li><p><a href="smb.conf.5.html#LDAPFILTER" target="_top">ldap filter</a></p></li><li><p><a href="smb.conf.5.html#LDAPMACHINSUFFIX" target="_top">ldap machine suffix</a></p></li><li><p><a href="smb.conf.5.html#LDAPUSERSUFFIX" target="_top">ldap user suffix</a></p></li><li><p><a href="smb.conf.5.html#LDAPDELETEDN" target="_top">ldap delete dn</a></p></li><li><p><a href="smb.conf.5.html#LDAPPASSWDSYNC" target="_top">ldap passwd sync</a></p></li><li><p><a href="smb.conf.5.html#LDAPTRUSTIDS" target="_top">ldap trust ids</a></p></li></ul></div><p>
527                         These are described in the <tt class="filename">smb.conf</tt> man
528                         page and so will not be repeated here.  However, a sample smb.conf file for
529                         use with an LDAP directory could appear as
530                         </p><p>
531 </p><pre class="programlisting">
532 ## /usr/local/samba/lib/smb.conf
533 [global]
534      security = user
535      encrypt passwords = yes
536
537      netbios name = TASHTEGO
538      workgroup = NARNIA
539
540      # ldap related parameters
541
542      # define the DN to use when binding to the directory servers
543      # The password for this DN is not stored in smb.conf.  Rather it
544      # must be set by using 'smbpasswd -w <i class="replaceable"><tt>secretpw</tt></i>' to store the
545      # passphrase in the secrets.tdb file.  If the &quot;ldap admin dn&quot; values
546      # change, this password will need to be reset.
547      ldap admin dn = &quot;cn=Samba Manager,ou=people,dc=samba,dc=org&quot;
548
549      # Define the SSL option when connecting to the directory
550      # ('off', 'start tls', or 'on' (default))
551      ldap ssl = start tls
552
553      # syntax: passdb backend = ldapsam:ldap://server-name[:port]
554      passdb backend = ldapsam:ldap://funball.samba.org, guest
555
556      # smbpasswd -x delete the entire dn-entry
557      ldap delete dn = no
558
559      # the machine and user suffix added to the base suffix
560      # wrote WITHOUT quotes. NULL suffixes by default
561      ldap user suffix = ou=People
562      ldap machine suffix = ou=Systems
563
564      # Trust unix account information in LDAP
565      #  (see the smb.conf manpage for details)
566      ldap trust ids = Yes
567
568      # specify the base DN to use when searching the directory
569      ldap suffix = &quot;ou=people,dc=samba,dc=org&quot;
570
571      # generally the default ldap search filter is ok
572      # ldap filter = &quot;(&amp;(uid=%u)(objectclass=sambaSamAccount))&quot;
573 </pre><p>
574 </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2912468"></a>Accounts and Groups management</h4></div></div><div></div></div><p>
575                         As users accounts are managed through the sambaSamAccount objectclass, you should
576                         modify your existing administration tools to deal with sambaSamAccount attributes.
577                         </p><p>
578                         Machines accounts are managed with the sambaSamAccount objectclass, just
579                         like users accounts. However, it's up to you to store those accounts
580                         in a different tree of your LDAP namespace: you should use
581                         &quot;ou=Groups,dc=plainjoe,dc=org&quot; to store groups and
582                         &quot;ou=People,dc=plainjoe,dc=org&quot; to store users. Just configure your
583                         NSS and PAM accordingly (usually, in the /etc/ldap.conf configuration
584                         file).
585                         </p><p>
586                         In Samba release 3.0, the group management system is based on POSIX
587                         groups. This means that Samba makes use of the posixGroup objectclass.
588                         For now, there is no NT-like group system management (global and local
589                         groups).
590                         </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2912505"></a>Security and sambaSamAccount</h4></div></div><div></div></div><p>
591                         There are two important points to remember when discussing the security
592                         of sambaSamAccount entries in the directory.
593                         </p><div class="itemizedlist"><ul type="disc"><li><p><span class="emphasis"><em>Never</em></span> retrieve the lmPassword or
594                                 ntPassword attribute values over an unencrypted LDAP session.</p></li><li><p><span class="emphasis"><em>Never</em></span> allow non-admin users to
595                                 view the lmPassword or ntPassword attribute values.</p></li></ul></div><p>
596                         These password hashes are clear text equivalents and can be used to impersonate
597                         the user without deriving the original clear text strings.  For more information
598                         on the details of LM/NT password hashes, refer to the
599                         <a href="passdb.html" title="Chapter 11. Account Information Databases">Account Information Database</a> section of this chapter.
600                         </p><p>
601                                 To remedy the first security issue, the <i class="parameter"><tt>ldap ssl</tt></i> <tt class="filename">smb.conf</tt> parameter defaults
602                         to require an encrypted session (<i class="parameter"><tt>ldap ssl = on</tt></i>) using
603                         the default port of <tt class="constant">636</tt>
604                         when contacting the directory server.  When using an OpenLDAP server, it
605                         is possible to use the use the StartTLS LDAP extended  operation in the place of
606                         LDAPS.  In either case, you are strongly discouraged to disable this security
607                         (<i class="parameter"><tt>ldap ssl = off</tt></i>).
608                         </p><p>
609                         Note that the LDAPS protocol is deprecated in favor of the LDAPv3 StartTLS
610                         extended operation.  However, the OpenLDAP library still provides support for
611                         the older method of securing communication between clients and servers.
612                         </p><p>
613                         The second security precaution is to prevent non-administrative users from
614                         harvesting password hashes from the directory.  This can be done using the
615                         following ACL in <tt class="filename">slapd.conf</tt>:
616                         </p><p>
617 </p><pre class="programlisting">
618 ## allow the &quot;ldap admin dn&quot; access, but deny everyone else
619 access to attrs=lmPassword,ntPassword
620      by dn=&quot;cn=Samba Admin,ou=people,dc=plainjoe,dc=org&quot; write
621      by * none
622 </pre><p>
623 </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2912642"></a>LDAP special attributes for sambaSamAccounts</h4></div></div><div></div></div><p>
624                         The sambaSamAccount objectclass is composed of the following attributes:
625                         </p><p>
626                         </p><div class="table"><a name="id2912659"></a><p class="title"><b>Table 11.1. Attributes in the sambaSamAccount objectclass (LDAP)</b></p><table summary="Attributes in the sambaSamAccount objectclass (LDAP)" border="1"><colgroup><col><col></colgroup><tbody><tr><td align="left"><tt class="constant">lmPassword</tt></td><td align="left">the LANMAN password 16-byte hash stored as a character
627                                                 representation of a hexadecimal string.</td></tr><tr><td align="left"><tt class="constant">ntPassword</tt></td><td align="left">the NT password hash 16-byte stored as a character
628                                                 representation of a hexadecimal string.</td></tr><tr><td align="left"><tt class="constant">pwdLastSet</tt></td><td align="left">The integer time in seconds since 1970 when the
629                                 <tt class="constant">lmPassword</tt> and <tt class="constant">ntPassword</tt> attributes were last set.
630                                 </td></tr><tr><td align="left"><tt class="constant">acctFlags</tt></td><td align="left">string of 11 characters surrounded by square brackets []
631                                                 representing account flags such as U (user), W(workstation), X(no password expiration),
632                                                 I(Domain trust account), H(Home dir required), S(Server trust account),
633                                                 and D(disabled).</td></tr><tr><td align="left"><tt class="constant">logonTime</tt></td><td align="left">Integer value currently unused</td></tr><tr><td align="left"><tt class="constant">logoffTime</tt></td><td align="left">Integer value currently unused</td></tr><tr><td align="left"><tt class="constant">kickoffTime</tt></td><td align="left">Integer value currently unused</td></tr><tr><td align="left"><tt class="constant">pwdCanChange</tt></td><td align="left">Integer value currently unused</td></tr><tr><td align="left"><tt class="constant">pwdMustChange</tt></td><td align="left">Integer value currently unused</td></tr><tr><td align="left"><tt class="constant">homeDrive</tt></td><td align="left">specifies the drive letter to which to map the
634                                 UNC path specified by homeDirectory. The drive letter must be specified in the form &quot;X:&quot;
635                                 where X is the letter of the drive to map. Refer to the &quot;logon drive&quot; parameter in the
636                                 smb.conf(5) man page for more information.</td></tr><tr><td align="left"><tt class="constant">scriptPath</tt></td><td align="left">The scriptPath property specifies the path of
637                                 the user's logon script, .CMD, .EXE, or .BAT file. The string can be null. The path
638                                 is relative to the netlogon share.  Refer to the &quot;logon script&quot; parameter in the
639                                 smb.conf(5) man page for more information.</td></tr><tr><td align="left"><tt class="constant">profilePath</tt></td><td align="left">specifies a path to the user's profile.
640                                 This value can be a null string, a local absolute path, or a UNC path.  Refer to the
641                                 &quot;logon path&quot; parameter in the smb.conf(5) man page for more information.</td></tr><tr><td align="left"><tt class="constant">smbHome</tt></td><td align="left">The homeDirectory property specifies the path of
642                                 the home directory for the user. The string can be null. If homeDrive is set and specifies
643                                 a drive letter, homeDirectory should be a UNC path. The path must be a network
644                                 UNC path of the form <tt class="filename">\\server\share\directory</tt>. This value can be a null string.
645                                 Refer to the <b class="command">logon home</b> parameter in the <tt class="filename">smb.conf</tt> man page for more information.
646                                 </td></tr><tr><td align="left"><tt class="constant">userWorkstation</tt></td><td align="left">character string value currently unused.
647                                 </td></tr><tr><td align="left"><tt class="constant">rid</tt></td><td align="left">the integer representation of the user's relative identifier
648                                 (RID).</td></tr><tr><td align="left"><tt class="constant">primaryGroupID</tt></td><td align="left">the relative identifier (RID) of the primary group
649                                 of the user.</td></tr><tr><td align="left"><tt class="constant">domain</tt></td><td align="left">domain the user is part of.</td></tr></tbody></table></div><p>
650                         </p><p>
651                         The majority of these parameters are only used when Samba is acting as a PDC of
652                         a domain (refer to the <a href="samba-pdc.html" title="Chapter 5. Domain Control">Samba as a primary domain controller</a> chapter for details on
653                         how to configure Samba as a Primary Domain Controller). The following four attributes
654                         are only stored with the sambaSamAccount entry if the values are non-default values:
655                         </p><table class="simplelist" border="0" summary="Simple list"><tr><td>smbHome</td></tr><tr><td>scriptPath</td></tr><tr><td>logonPath</td></tr><tr><td>homeDrive</td></tr></table><p>
656                         These attributes are only stored with the sambaSamAccount entry if
657                         the values are non-default values.  For example, assume TASHTEGO has now been
658                         configured as a PDC and that <i class="parameter"><tt>logon home = \\%L\%u</tt></i> was defined in
659                         its <tt class="filename">smb.conf</tt> file. When a user named &quot;becky&quot; logons to the domain,
660                         the <i class="parameter"><tt>logon home</tt></i> string is expanded to \\TASHTEGO\becky.
661                         If the smbHome attribute exists in the entry &quot;uid=becky,ou=people,dc=samba,dc=org&quot;,
662                         this value is used.  However, if this attribute does not exist, then the value
663                         of the <i class="parameter"><tt>logon home</tt></i> parameter is used in its place.  Samba
664                         will only write the attribute value to the directory entry if the value is
665                         something other than the default (e.g. <tt class="filename">\\MOBY\becky</tt>).
666                         </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2913008"></a>Example LDIF Entries for a sambaSamAccount</h4></div></div><div></div></div><p>
667                         The following is a working LDIF with the inclusion of the posixAccount objectclass:
668                         </p><p>
669         </p><pre class="programlisting">
670         dn: uid=guest2, ou=people,dc=plainjoe,dc=org
671         ntPassword: 878D8014606CDA29677A44EFA1353FC7
672         pwdMustChange: 2147483647
673         primaryGroupID: 1201
674         lmPassword: 552902031BEDE9EFAAD3B435B51404EE
675         pwdLastSet: 1010179124
676         logonTime: 0
677         objectClass: sambaSamAccount
678         uid: guest2
679         kickoffTime: 2147483647
680         acctFlags: [UX         ]
681         logoffTime: 2147483647
682         rid: 19006
683         pwdCanChange: 0
684         </pre><p>
685         </p><p>
686                         The following is an LDIF entry for using both the sambaSamAccount and
687                         posixAccount objectclasses:
688                         </p><p>
689         </p><pre class="programlisting">
690         dn: uid=gcarter, ou=people,dc=plainjoe,dc=org
691         logonTime: 0
692         displayName: Gerald Carter
693         lmPassword: 552902031BEDE9EFAAD3B435B51404EE
694         primaryGroupID: 1201
695         objectClass: posixAccount
696         objectClass: sambaSamAccount
697         acctFlags: [UX         ]
698         userPassword: {crypt}BpM2ej8Rkzogo
699         uid: gcarter
700         uidNumber: 9000
701         cn: Gerald Carter
702         loginShell: /bin/bash
703         logoffTime: 2147483647
704         gidNumber: 100
705         kickoffTime: 2147483647
706         pwdLastSet: 1010179230
707         rid: 19000
708         homeDirectory: /home/tashtego/gcarter
709         pwdCanChange: 0
710         pwdMustChange: 2147483647
711         ntPassword: 878D8014606CDA29677A44EFA1353FC7
712 </pre><p>
713         </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2913071"></a>Password synchronisation</h4></div></div><div></div></div><p>
714                 Since version 3.0 samba can update the non-samba (LDAP) password stored with an account. When
715                 using pam_ldap, this allows changing both unix and windows passwords at once.
716                 </p><p>The <i class="parameter"><tt>ldap passwd sync</tt></i> options can have the following values:</p><div class="variablelist"><dl><dt><span class="term">yes</span></dt><dd><p>When the user changes his password, update
717                                                <tt class="constant">ntPassword</tt>, <tt class="constant">lmPassword</tt>
718                                                and the <tt class="constant">password</tt> fields.</p></dd><dt><span class="term">no</span></dt><dd><p>Only update <tt class="constant">ntPassword</tt> and <tt class="constant">lmPassword</tt>.</p></dd><dt><span class="term">only</span></dt><dd><p>Only update the LDAP password and let the LDAP server worry
719                                                about the other fields. This option is only available when the LDAP server supports LDAP_EXOP_X_MODIFY_PASSWD. </p></dd></dl></div><p>More information can be found in the <a href="smb.conf.5.html#LDAPPASSWDSYNC" target="_top">smb.conf</a> manpage.
720                 </p></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2913185"></a>MySQL</h3></div></div><div></div></div><p>
721         Every so often someone will come along with a great new idea. Storing of user accounts in an
722         SQL backend is one of them. Those who want to do this are in the best position to know what the
723         specific benefits are to them. This may sound like a cop-out, but in truth we can not attempt
724         to document every nitty little detail why certain things of marginal utility to the bulk of
725         Samba users might make sense to the rest. In any case, the following instructions should help
726         the determined SQL user to implement a working system.
727         </p><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2913204"></a>Creating the database</h4></div></div><div></div></div><p>
728                         You either can set up your own table and specify the field names to pdb_mysql (see below
729                         for the column names) or use the default table. The file <tt class="filename">examples/pdb/mysql/mysql.dump</tt> 
730                         contains the correct queries to create the required tables. Use the command :
731
732                         </p><pre class="screen"><tt class="prompt">$ </tt><b class="userinput"><tt>mysql -u<i class="replaceable"><tt>username</tt></i> -h<i class="replaceable"><tt>hostname</tt></i> -p<i class="replaceable"><tt>password</tt></i> \
733 <i class="replaceable"><tt>databasename</tt></i> &lt; <tt class="filename">/path/to/samba/examples/pdb/mysql/mysql.dump</tt></tt></b></pre><p>
734                         </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2913268"></a>Configuring</h4></div></div><div></div></div><p>This plugin lacks some good documentation, but here is some short info:</p><p>Add a the following to the <i class="parameter"><tt>passdb backend</tt></i> variable in your <tt class="filename">smb.conf</tt>:
735                         </p><pre class="programlisting">
736                         passdb backend = [other-plugins] mysql:identifier [other-plugins]
737                         </pre><p>
738                         </p><p>The identifier can be any string you like, as long as it doesn't collide with 
739                         the identifiers of other plugins or other instances of pdb_mysql. If you 
740                         specify multiple pdb_mysql.so entries in <i class="parameter"><tt>passdb backend</tt></i>, you also need to 
741                         use different identifiers!
742                         </p><p>
743                                 Additional options can be given through the <tt class="filename">smb.conf</tt> file in the <i class="parameter"><tt>[global]</tt></i> section.
744                         </p><p>
745                         </p><div class="table"><a name="id2913346"></a><p class="title"><b>Table 11.2. Basic smb.conf options for MySQL passdb backend</b></p><table summary="Basic smb.conf options for MySQL passdb backend" border="1"><colgroup><col><col></colgroup><thead><tr><th align="left">Field</th><th align="left">Contents</th></tr></thead><tbody><tr><td align="left">identifier:mysql host</td><td align="left">host name, defaults to 'localhost'</td></tr><tr><td align="left">identifier:mysql password</td><td align="left"> </td></tr><tr><td align="left">identifier:mysql user</td><td align="left">defaults to 'samba'</td></tr><tr><td align="left">identifier:mysql database</td><td align="left">defaults to 'samba'</td></tr><tr><td align="left">identifier:mysql port</td><td align="left">defaults to 3306</td></tr><tr><td align="left">identifier:table</td><td align="left">Name of the table containing users</td></tr></tbody></table></div><p>
746                 </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>
747                         Since the password for the MySQL user is stored in the 
748                         <tt class="filename">smb.conf</tt> file, you should make the the <tt class="filename">smb.conf</tt> file 
749                         readable only to the user that runs Samba This is considered a security 
750                         bug and will be fixed soon.
751                         </p></div><p>Names of the columns in this table (I've added column types those columns should have first):</p><p>
752                         </p><div class="table"><a name="id2913471"></a><p class="title"><b>Table 11.3. MySQL field names for MySQL passdb backend</b></p><table summary="MySQL field names for MySQL passdb backend" border="1"><colgroup><col><col><col></colgroup><thead><tr><th align="left">Field</th><th align="left">Type</th><th align="left">Contents</th></tr></thead><tbody><tr><td align="left">identifier:logon time column</td><td align="left">int(9)</td><td align="left"> </td></tr><tr><td align="left">identifier:logoff time column</td><td align="left">int(9)</td><td align="left"> </td></tr><tr><td align="left">identifier:kickoff time column</td><td align="left">int(9)</td><td align="left"> </td></tr><tr><td align="left">identifier:pass last set time column</td><td align="left">int(9)</td><td align="left"> </td></tr><tr><td align="left">identifier:pass can change time column</td><td align="left">int(9)</td><td align="left"> </td></tr><tr><td align="left">identifier:pass must change time column</td><td align="left">int(9)</td><td align="left"> </td></tr><tr><td align="left">identifier:username column</td><td align="left">varchar(255)</td><td align="left">unix username</td></tr><tr><td align="left">identifier:domain column</td><td align="left">varchar(255)</td><td align="left">NT domain user is part of</td></tr><tr><td align="left">identifier:nt username column</td><td align="left">varchar(255)</td><td align="left">NT username</td></tr><tr><td align="left">identifier:fullname column</td><td align="left">varchar(255)</td><td align="left">Full name of user</td></tr><tr><td align="left">identifier:home dir column</td><td align="left">varchar(255)</td><td align="left">Unix homedir path</td></tr><tr><td align="left">identifier:dir drive column</td><td align="left">varchar(2)</td><td align="left">Directory drive path (eg: 'H:')</td></tr><tr><td align="left">identifier:logon script column</td><td align="left">varchar(255)</td><td align="left">Batch file to run on client side when logging on</td></tr><tr><td align="left">identifier:profile path column</td><td align="left">varchar(255)</td><td align="left">Path of profile</td></tr><tr><td align="left">identifier:acct desc column</td><td align="left">varchar(255)</td><td align="left">Some ASCII NT user data</td></tr><tr><td align="left">identifier:workstations column</td><td align="left">varchar(255)</td><td align="left">Workstations user can logon to (or NULL for all)</td></tr><tr><td align="left">identifier:unknown string column</td><td align="left">varchar(255)</td><td align="left">unknown string</td></tr><tr><td align="left">identifier:munged dial column</td><td align="left">varchar(255)</td><td align="left">?</td></tr><tr><td align="left">identifier:user sid column</td><td align="left">varchar(255)</td><td align="left">NT user SID</td></tr><tr><td align="left">identifier:group sid column</td><td align="left">varchar(255)</td><td align="left">NT group ID</td></tr><tr><td align="left">identifier:lanman pass column</td><td align="left">varchar(255)</td><td align="left">encrypted lanman password</td></tr><tr><td align="left">identifier:nt pass column</td><td align="left">varchar(255)</td><td align="left">encrypted nt passwd</td></tr><tr><td align="left">identifier:plain pass column</td><td align="left">varchar(255)</td><td align="left">plaintext password</td></tr><tr><td align="left">identifier:acct control column</td><td align="left">int(9)</td><td align="left">nt user data</td></tr><tr><td align="left">identifier:unknown 3 column</td><td align="left">int(9)</td><td align="left">unknown</td></tr><tr><td align="left">identifier:logon divs column</td><td align="left">int(9)</td><td align="left">?</td></tr><tr><td align="left">identifier:hours len column</td><td align="left">int(9)</td><td align="left">?</td></tr><tr><td align="left">identifier:unknown 5 column</td><td align="left">int(9)</td><td align="left">unknown</td></tr><tr><td align="left">identifier:unknown 6 column</td><td align="left">int(9)</td><td align="left">unknown</td></tr></tbody></table></div><p>
753                 </p><p>
754                         Eventually, you can put a colon (:) after the name of each column, which 
755                         should specify the column to update when updating the table. You can also
756                         specify nothing behind the colon - then the data from the field will not be 
757                         updated. 
758                         </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2913850"></a>Using plaintext passwords or encrypted password</h4></div></div><div></div></div><p>
759                         I strongly discourage the use of plaintext passwords, however, you can use them:
760                         </p><p>
761                         If you would like to use plaintext passwords, set
762                         'identifier:lanman pass column' and 'identifier:nt pass column' to
763                         'NULL' (without the quotes) and 'identifier:plain pass column' to the
764                         name of the column containing the plaintext passwords. 
765                         </p><p>
766                         If you use encrypted passwords, set the 'identifier:plain pass
767                         column' to 'NULL' (without the quotes). This is the default.
768                         </p></div><div class="sect3" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2913881"></a>Getting non-column data from the table</h4></div></div><div></div></div><p>
769                         It is possible to have not all data in the database and making some 'constant'.
770                         </p><p>
771                         For example, you can set 'identifier:fullname column' to : 
772                         <b class="command">CONCAT(First_name,' ',Sur_name)</b>
773                         </p><p>
774                         Or, set 'identifier:workstations column' to :
775                         <b class="command">NULL</b></p><p>See the MySQL documentation for more language constructs.</p></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="XMLpassdb"></a>XML</h3></div></div><div></div></div><p>This module requires libxml2 to be installed.</p><p>The usage of pdb_xml is pretty straightforward. To export data, use:
776                 </p><p>
777                         <tt class="prompt">$ </tt> <b class="userinput"><tt>pdbedit -e xml:filename</tt></b>
778                 </p><p>
779                 (where filename is the name of the file to put the data in)
780                 </p><p>
781                 To import data, use:
782                 <tt class="prompt">$ </tt> <b class="userinput"><tt>pdbedit -i xml:filename</tt></b>
783                 </p></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2913989"></a>Common Errors</h2></div></div><div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2913997"></a>Users can not logon - Users not in Samba SAM</h3></div></div><div></div></div><p>
784         People forget to put their users in their backend and then complain Samba won't authorize them.
785         </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2914012"></a>Users are being added to the wrong backend database</h3></div></div><div></div></div><p>
786         A few complaints have been received from users that just moved to Samba-3. The following
787         <tt class="filename">smb.conf</tt> file entries were causing problems, new accounts were being added to the old
788         smbpasswd file, not to the tdbsam passdb.tdb file:
789         </p><p>
790         </p><pre class="programlisting">
791         [globals]
792                 ...
793                 passdb backend = smbpasswd, tdbsam, guest
794                 ...
795         </pre><p>
796         </p><p>
797         Samba will add new accounts to the first entry in the <span class="emphasis"><em>passdb backend</em></span>
798         parameter entry. If you want to update to the tdbsam, then change the entry to:
799         </p><p>
800         </p><pre class="programlisting">
801         [globals]
802                 ...
803                 passdb backend = tdbsam, smbpasswd, guest
804                 ...
805         </pre><p>
806         </p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2914072"></a>auth methods does not work</h3></div></div><div></div></div><p>
807         If you explicitly set an 'auth methods' parameter, guest must be specified as the first
808         entry on the line. Eg: <i class="parameter"><tt>auth methods = guest sam</tt></i>.
809         </p><p>
810         This is the exact opposite of the requirement for the <i class="parameter"><tt>passdb backed</tt></i>
811         option, where it must be the <span class="emphasis"><em>LAST</em></span> parameter on the line.
812         </p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="NetworkBrowsing.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="optional.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="groupmapping.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 10. Samba / MS Windows Network Browsing Guide </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 12. Mapping MS Windows and Unix Groups</td></tr></table></div></body></html>