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">
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>
15 <refname>idmap_ldap</refname>
16 <refpurpose>Samba's idmap_ldap Backend for Winbind</refpurpose>
20 <title>DESCRIPTION</title>
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
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.
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 "idmap uid" and "idmap gid".
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.
47 <title>IDMAP OPTIONS</title>
51 <term>ldap_base_dn = DN</term>
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 "ldap idmap suffix" option from smb.conf.
60 <term>ldap_user_dn = DN</term>
62 Defines the user DN to be used for authentication. If absent an
63 anonymous bind will be performed.
68 <term>ldap_url = ldap://server/</term>
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.
77 <term>range = low - high</term>
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 "idmap uid" and "idmap gid" options
90 <title>IDMAP ALLOC OPTIONS</title>
94 <term>ldap_base_dn = DN</term>
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 "ldap idmap suffix" option from smb.conf.
103 <term>ldap_user_dn = DN</term>
105 Defines the user DN to be used for authentication. If absent an
106 anonymous bind will be performed.
111 <term>ldap_url = ldap://server/</term>
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/
122 <title>EXAMPLES</title>
125 The follow sets of a LDAP configuration which uses two LDAP
126 directories, one for storing the ID mappings and one for retrieving
132 idmap backend = ldap:ldap://localhost/
133 idmap uid = 1000000-1999999
134 idmap gid = 1000000-1999999
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
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 "net idmap " command is used to store a secret
149 for the DN specified in a specific idmap domain.
154 <title>AUTHOR</title>
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.