docs/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 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>idmap_ldap</refname>
  13         <refpurpose>Samba's idmap_ldap Backend for Winbind</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <title>DESCRIPTION</title>
  18
  19         <para>The idmap_ldap plugin provides a means for Winbind to
  20         store and retrieve SID/uid/gid mapping tables in an LDAP directory
  21         service.  The module implements both the &quot;idmap&quot; and
  22         &quot;idmap alloc&quot; APIs.
  23         </para>
  24 </refsynopsisdiv>
  25
  26 <refsect1>
  27         <title>IDMAP OPTIONS</title>
  28
  29         <variablelist>
  30                 <varlistentry>
  31                 <term>ldap_base_dn = DN</term>
  32                 <listitem><para>
  33                         Defines the directory base suffix to use when searching for
  34                         SID/uid/gid mapping entries.  If not defined, idmap_ldap will default
  35                         to using the &quot;ldap idmap suffix&quot; option from smb.conf.
  36                 </para></listitem>
  37                 </varlistentry>
  38
  39                 <varlistentry>
  40                 <term>ldap_user_dn = DN</term>
  41                 <listitem><para>
  42                         Defines the user DN to be used for authentication. If absent an
  43                         anonymous bind will be performed.
  44                 </para></listitem>
  45                 </varlistentry>
  46
  47                 <varlistentry>
  48                 <term>ldap_url = ldap://server/</term>
  49                 <listitem><para>
  50                         Specifies the LDAP server to use when searching for existing
  51                         SID/uid/gid map entries. If not defined, idmap_ldap will
  52                         assume that ldap://localhost/ should be used.
  53                 </para></listitem>
  54                 </varlistentry>
  55
  56                 <varlistentry>
  57                 <term>range = low - high</term>
  58                 <listitem><para>
  59                         Defines the available matching uid and gid range for which the
  60                         backend is authoritative.  Note that the range commonly matches
  61                         the allocation range due to the fact that the same backend will
  62                         store and retrieve SID/uid/gid mapping entries.  If the parameter
  63                         is absent, Winbind fail over to use the &quot;idmap uid&quot; and
  64                         &quot;idmap gid&quot; options from smb.conf.
  65                 </para></listitem>
  66                 </varlistentry>
  67         </variablelist>
  68 </refsect1>
  69
  70 <refsect1>
  71         <title>IDMAP ALLOC OPTIONS</title>
  72
  73         <variablelist>
  74                 <varlistentry>
  75                 <term>ldap_base_dn = DN</term>
  76                 <listitem><para>
  77                         Defines the directory base suffix under which new SID/uid/gid mapping
  78                         entries should be stored.  If not defined, idmap_ldap will default
  79                         to using the &quot;ldap idmap suffix&quot; option from smb.conf.
  80                 </para></listitem>
  81                 </varlistentry>
  82
  83                 <varlistentry>
  84                 <term>ldap_user_dn = DN</term>
  85                 <listitem><para>
  86                         Defines the user DN to be used for authentication. If absent an
  87                         anonymous bind will be performed.
  88                 </para></listitem>
  89                 </varlistentry>
  90
  91                 <varlistentry>
  92                 <term>ldap_url = ldap://server/</term>
  93                 <listitem><para>
  94                         Specifies the LDAP server to which modify/add/delete requests should
  95                         be sent.  If not defined, idmap_ldap will assume that ldap://localhost/
  96                         should be used.
  97                 </para></listitem>
  98                 </varlistentry>
  99
 100                 <varlistentry>
 101                 <term>range = low - high</term>
 102                 <listitem><para>
 103                         Defines the available matching uid and gid range from which
 104                         winbindd can allocate for users and groups.  If the parameter
 105                         is absent, Winbind fail over to use the &quot;idmap uid&quot;
 106                         and &quot;idmap gid&quot; options from smb.conf.
 107                 </para></listitem>
 108                 </varlistentry>
 109         </variablelist>
 110 </refsect1>
 111
 112 <refsect1>
 113         <title>EXAMPLES</title>
 114
 115         <para>
 116         The follow sets of a LDAP configuration which uses a slave server
 117         running on localhost for fast fetching SID/gid/uid mappings, it
 118         implies correct configuration of referrals.
 119         The idmap alloc backend is pointed directly to the master to skip
 120         the referral (and consequent reconnection to the master) that the
 121         slave would return as allocation requires writing on the master.
 122         </para>
 123
 124         <programlisting>
 125         [global]
 126             idmap domains = ALLDOMAINS
 127             idmap config ALLDOMAINS:default      = yes
 128             idmap config ALLDOMAINS:backend      = ldap
 129             idmap config ALLDOMAINS:ldap_base_dn = ou=idmap,dc=example,dc=com
 130             idmap config ALLDOMAINS:ldap_url     = ldap://localhost/
 131             idmap config ALLDOMAINS:range        = 10000 - 50000
 132
 133             idmap alloc backend = ldap
 134             idmap alloc config:ldap_base_dn = ou=idmap,dc=example,dc=com
 135             idmap alloc config:ldap_url     = ldap://master.example.com/
 136             idmap alloc config:range        = 10000 - 50000
 137         </programlisting>
 138 </refsect1>
 139
 140 <refsynopsisdiv>
 141         <title>NOTE</title>
 142
 143         <para>In order to use authentication against ldap servers you may
 144         need to provide a DN and a password. To avoid exposing the password
 145         in plain text in the configuration file we store it into a security
 146         store. The &quot;net idmap &quot; command is used to store a secret
 147         for the DN specified in a specific idmap domain.
 148         </para>
 149 </refsynopsisdiv>
 150
 151 <refsect1>
 152         <title>AUTHOR</title>
 153
 154         <para>
 155         The original Samba software and related utilities
 156         were created by Andrew Tridgell. Samba is now developed
 157         by the Samba Team as an Open Source project similar
 158         to the way the Linux kernel is developed.
 159         </para>
 160 </refsect1>
 161
 162 </refentry>