ea9e5bf07ea69229972af34398dbc6ea99dba9fe
[ira/wip.git] / docs-xml / manpages-3 / idmap_ldap.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="idmap_ldap.8">
4
5 <refmeta>
6         <refentrytitle>idmap_ldap</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">3.2</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>idmap_ldap</refname>
16         <refpurpose>Samba's idmap_ldap Backend for Winbind</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <title>DESCRIPTION</title>
21
22         <para>The idmap_ldap plugin provides a means for Winbind to
23         store and retrieve SID/uid/gid mapping tables in an LDAP directory
24         service.
25         In contrast to read only backends like idmap_rid, it is an allocating
26         backend: This means that it needs to allocate new user and group IDs to
27         create new mappings as requests to yet unmapped users are answered.
28         </para>
29
30         <para>
31         Note that in order for this (or any other allocating) backend to
32         function at all, the default backend needs to be writeable.
33         The ranges used for uid and gid allocation are the default ranges
34         configured by &quot;idmap uid&quot; and &quot;idmap gid&quot;.
35         </para>
36
37         <para>
38         Furthermore, since there is only one global allocating backend
39         responsible for all domains using writeable idmap backends,
40         any explicitly configured domain with idmap backend ldap
41         should have the same range as the default range, since it needs
42         to use the global uid / gid allocator. See the example below.
43         </para>
44 </refsynopsisdiv>
45
46 <refsect1>
47         <title>IDMAP OPTIONS</title>
48
49         <variablelist>
50                 <varlistentry>
51                 <term>ldap_base_dn = DN</term>
52                 <listitem><para>
53                         Defines the directory base suffix to use when searching for
54                         SID/uid/gid mapping entries.  If not defined, idmap_ldap will default
55                         to using the &quot;ldap idmap suffix&quot; option from smb.conf.
56                 </para></listitem>
57                 </varlistentry>
58
59                 <varlistentry>
60                 <term>ldap_user_dn = DN</term>
61                 <listitem><para>
62                         Defines the user DN to be used for authentication. If absent an
63                         anonymous bind will be performed.
64                 </para></listitem>
65                 </varlistentry>
66
67                 <varlistentry>
68                 <term>ldap_url = ldap://server/</term>
69                 <listitem><para>
70                         Specifies the LDAP server to use when searching for existing
71                         SID/uid/gid map entries. If not defined, idmap_ldap will
72                         assume that ldap://localhost/ should be used.
73                 </para></listitem>
74                 </varlistentry>
75
76                 <varlistentry>
77                 <term>range = low - high</term>
78                 <listitem><para>
79                         Defines the available matching uid and gid range for which the
80                         backend is authoritative.
81                         If the parameter is absent, Winbind fails over to use the
82                         &quot;idmap uid&quot; and &quot;idmap gid&quot; options
83                         from smb.conf.
84                 </para></listitem>
85                 </varlistentry>
86         </variablelist>
87 </refsect1>
88
89 <refsect1>
90         <title>IDMAP ALLOC OPTIONS</title>
91
92         <variablelist>
93                 <varlistentry>
94                 <term>ldap_base_dn = DN</term>
95                 <listitem><para>
96                         Defines the directory base suffix under which new SID/uid/gid mapping
97                         entries should be stored.  If not defined, idmap_ldap will default
98                         to using the &quot;ldap idmap suffix&quot; option from smb.conf.
99                 </para></listitem>
100                 </varlistentry>
101
102                 <varlistentry>
103                 <term>ldap_user_dn = DN</term>
104                 <listitem><para>
105                         Defines the user DN to be used for authentication. If absent an
106                         anonymous bind will be performed.
107                 </para></listitem>
108                 </varlistentry>
109
110                 <varlistentry>
111                 <term>ldap_url = ldap://server/</term>
112                 <listitem><para>
113                         Specifies the LDAP server to which modify/add/delete requests should
114                         be sent.  If not defined, idmap_ldap will assume that ldap://localhost/
115                         should be used.
116                 </para></listitem>
117                 </varlistentry>
118         </variablelist>
119 </refsect1>
120
121 <refsect1>
122         <title>EXAMPLES</title>
123
124         <para>
125         The follow sets of a LDAP configuration which uses two LDAP
126         directories, one for storing the ID mappings and one for retrieving
127         new IDs.
128         </para>
129
130         <programlisting>
131         [global]
132         idmap backend = ldap:ldap://localhost/
133         idmap uid = 1000000-1999999
134         idmap gid = 1000000-1999999
135
136         idmap alloc backend = ldap
137         idmap alloc config : ldap_url   = ldap://id-master/
138         idmap alloc config : ldap_base_dn = ou=idmap,dc=example,dc=com
139         </programlisting>
140 </refsect1>
141
142 <refsynopsisdiv>
143         <title>NOTE</title>
144
145         <para>In order to use authentication against ldap servers you may
146         need to provide a DN and a password. To avoid exposing the password
147         in plain text in the configuration file we store it into a security
148         store. The &quot;net idmap &quot; command is used to store a secret
149         for the DN specified in a specific idmap domain.
150         </para>
151 </refsynopsisdiv>
152
153 <refsect1>
154         <title>AUTHOR</title>
155
156         <para>
157         The original Samba software and related utilities
158         were created by Andrew Tridgell. Samba is now developed
159         by the Samba Team as an Open Source project similar
160         to the way the Linux kernel is developed.
161         </para>
162 </refsect1>
163
164 </refentry>