summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/security/passdbbackend.xml
blob: 1555af1d48f619205125ca0444f4daf7540575ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<samba:parameter name="passdb backend"
                 context="G"
		 type="list"
                 advanced="1" developer="1"
		 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>

    <para>This option allows the administrator to chose which backend
    will be used for storing user and possibly group information.  This allows 
    you to swap between dfferent storage mechanisms without recompile. </para>

    <para>The parameter value is divided into two parts, the backend's name, and a 'location'
    string that has meaning only to that particular backed.  These are separated
    by a : character.</para>

    <para>Available backends can include:
	<itemizedlist>
	    <listitem>
		<para><command moreinfo="none">smbpasswd</command> - The default smbpasswd
		backend. Takes a path to the smbpasswd file as an optional argument.
		</para>
	    </listitem>
			
	    <listitem>
		<para><command moreinfo="none">tdbsam</command> - The TDB based password storage
                backend.  Takes a path to the TDB as an optional argument (defaults to passdb.tdb 
                in the <smbconfoption name="private dir"/> directory.</para>
	    </listitem>
			
	    <listitem>
		<para><command moreinfo="none">ldapsam</command> - The LDAP based passdb 
                backend.  Takes an LDAP URL as an optional argument (defaults to 
                <command moreinfo="none">ldap://localhost</command>)</para>
			
		<para>LDAP connections should be secured where possible.  This may be done using either
                Start-TLS (see <smbconfoption name="ldap ssl"/>) or by
                specifying <parameter moreinfo="none">ldaps://</parameter> in
                the URL argument. </para>

                <para>Multiple servers may also be specified in double-quotes, if your
                LDAP libraries supports the LDAP URL notation.
                (OpenLDAP does).   
		</para>

	    </listitem>
	</itemizedlist>

    </para>
	Examples of use are:
<programlisting>
passdb backend = tdbsam:/etc/samba/private/passdb.tdb 

or

passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
</programlisting>
</description>

<value type="default">smbpasswd</value>
</samba:parameter>