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.6</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         </para>
  26
  27         <para>
  28         In contrast to read only backends like idmap_rid, it is an allocating
  29         backend: This means that it needs to allocate new user and group IDs in
  30         order to create new mappings.
  31         </para>
  32
  33 </refsynopsisdiv>
  34
  35 <refsect1>
  36         <title>IDMAP OPTIONS</title>
  37
  38         <variablelist>
  39                 <varlistentry>
  40                 <term>ldap_base_dn = DN</term>
  41                 <listitem><para>
  42                         Defines the directory base suffix to use for
  43                         SID/uid/gid mapping entries.  If not defined, idmap_ldap will default
  44                         to using the &quot;ldap idmap suffix&quot; option from smb.conf.
  45                 </para></listitem>
  46                 </varlistentry>
  47
  48                 <varlistentry>
  49                 <term>ldap_user_dn = DN</term>
  50                 <listitem><para>
  51                         Defines the user DN to be used for authentication. If absent an
  52                         anonymous bind will be performed.
  53                 </para></listitem>
  54                 </varlistentry>
  55
  56                 <varlistentry>
  57                 <term>ldap_url = ldap://server/</term>
  58                 <listitem><para>
  59                         Specifies the LDAP server to use for
  60                         SID/uid/gid map entries. If not defined, idmap_ldap will
  61                         assume that ldap://localhost/ should be used.
  62                 </para></listitem>
  63                 </varlistentry>
  64
  65                 <varlistentry>
  66                 <term>range = low - high</term>
  67                 <listitem><para>
  68                         Defines the available matching uid and gid range for which the
  69                         backend is authoritative.
  70                         If the parameter is absent, Winbind fails over to use the
  71                         &quot;idmap uid&quot; and &quot;idmap gid&quot; options
  72                         from smb.conf.
  73                 </para></listitem>
  74                 </varlistentry>
  75         </variablelist>
  76 </refsect1>
  77
  78 <refsect1>
  79         <title>EXAMPLES</title>
  80
  81         <para>
  82         The following example shows how an ldap directory is used as the
  83         default idmap backend. It also configures the idmap range and base
  84         directory suffix.
  85         </para>
  86
  87         <programlisting>
  88         [global]
  89         idmap config * : backend      = ldap
  90         idmap config * : range        = 1000000-1999999
  91         idmap config * : ldap_url     = ldap://localhost/
  92         idmap config * : ldap_base_dn = ou=idmap,dc=example,dc=com
  93         </programlisting>
  94 </refsect1>
  95
  96 <refsynopsisdiv>
  97         <title>NOTE</title>
  98
  99         <para>In order to use authentication against ldap servers you may
 100         need to provide a DN and a password. To avoid exposing the password
 101         in plain text in the configuration file we store it into a security
 102         store. The &quot;net idmap &quot; command is used to store a secret
 103         for the DN specified in a specific idmap domain.
 104         </para>
 105 </refsynopsisdiv>
 106
 107 <refsect1>
 108         <title>AUTHOR</title>
 109
 110         <para>
 111         The original Samba software and related utilities
 112         were created by Andrew Tridgell. Samba is now developed
 113         by the Samba Team as an Open Source project similar
 114         to the way the Linux kernel is developed.
 115         </para>
 116 </refsect1>
 117
 118 </refentry>