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.  The module implements both the &quot;idmap&quot; and
  25         &quot;idmap alloc&quot; APIs.
  26         </para>
  27 </refsynopsisdiv>
  28
  29 <refsect1>
  30         <title>IDMAP OPTIONS</title>
  31
  32         <variablelist>
  33                 <varlistentry>
  34                 <term>ldap_base_dn = DN</term>
  35                 <listitem><para>
  36                         Defines the directory base suffix to use when searching for
  37                         SID/uid/gid mapping entries.  If not defined, idmap_ldap will default
  38                         to using the &quot;ldap idmap suffix&quot; option from smb.conf.
  39                 </para></listitem>
  40                 </varlistentry>
  41
  42                 <varlistentry>
  43                 <term>ldap_user_dn = DN</term>
  44                 <listitem><para>
  45                         Defines the user DN to be used for authentication. If absent an
  46                         anonymous bind will be performed.
  47                 </para></listitem>
  48                 </varlistentry>
  49
  50                 <varlistentry>
  51                 <term>ldap_url = ldap://server/</term>
  52                 <listitem><para>
  53                         Specifies the LDAP server to use when searching for existing
  54                         SID/uid/gid map entries. If not defined, idmap_ldap will
  55                         assume that ldap://localhost/ should be used.
  56                 </para></listitem>
  57                 </varlistentry>
  58
  59                 <varlistentry>
  60                 <term>range = low - high</term>
  61                 <listitem><para>
  62                         Defines the available matching uid and gid range for which the
  63                         backend is authoritative.  Note that the range commonly matches
  64                         the allocation range due to the fact that the same backend will
  65                         store and retrieve SID/uid/gid mapping entries.  If the parameter
  66                         is absent, Winbind fail over to use the &quot;idmap uid&quot; and
  67                         &quot;idmap gid&quot; options from smb.conf.
  68                 </para></listitem>
  69                 </varlistentry>
  70         </variablelist>
  71 </refsect1>
  72
  73 <refsect1>
  74         <title>IDMAP ALLOC OPTIONS</title>
  75
  76         <variablelist>
  77                 <varlistentry>
  78                 <term>ldap_base_dn = DN</term>
  79                 <listitem><para>
  80                         Defines the directory base suffix under which new SID/uid/gid mapping
  81                         entries should be stored.  If not defined, idmap_ldap will default
  82                         to using the &quot;ldap idmap suffix&quot; option from smb.conf.
  83                 </para></listitem>
  84                 </varlistentry>
  85
  86                 <varlistentry>
  87                 <term>ldap_user_dn = DN</term>
  88                 <listitem><para>
  89                         Defines the user DN to be used for authentication. If absent an
  90                         anonymous bind will be performed.
  91                 </para></listitem>
  92                 </varlistentry>
  93
  94                 <varlistentry>
  95                 <term>ldap_url = ldap://server/</term>
  96                 <listitem><para>
  97                         Specifies the LDAP server to which modify/add/delete requests should
  98                         be sent.  If not defined, idmap_ldap will assume that ldap://localhost/
  99                         should be used.
 100                 </para></listitem>
 101                 </varlistentry>
 102         </variablelist>
 103 </refsect1>
 104
 105 <refsect1>
 106         <title>EXAMPLES</title>
 107
 108         <para>
 109         The follow sets of a LDAP configuration which uses two LDAP
 110         directories, one for storing the ID mappings and one for retrieving
 111         new IDs.
 112         </para>
 113
 114         <programlisting>
 115         [global]
 116         idmap backend = ldap:ldap://localhost/
 117         idmap uid = 1000000-1999999
 118         idmap gid = 1000000-1999999
 119
 120         idmap alloc backend = ldap
 121         idmap alloc config : ldap_url   = ldap://id-master/
 122         idmap alloc config : ldap_base_dn = ou=idmap,dc=example,dc=com
 123         </programlisting>
 124 </refsect1>
 125
 126 <refsynopsisdiv>
 127         <title>NOTE</title>
 128
 129         <para>In order to use authentication against ldap servers you may
 130         need to provide a DN and a password. To avoid exposing the password
 131         in plain text in the configuration file we store it into a security
 132         store. The &quot;net idmap &quot; command is used to store a secret
 133         for the DN specified in a specific idmap domain.
 134         </para>
 135 </refsynopsisdiv>
 136
 137 <refsect1>
 138         <title>AUTHOR</title>
 139
 140         <para>
 141         The original Samba software and related utilities
 142         were created by Andrew Tridgell. Samba is now developed
 143         by the Samba Team as an Open Source project similar
 144         to the way the Linux kernel is developed.
 145         </para>
 146 </refsect1>
 147
 148 </refentry>