docs-xml/smbdotconf/winbind/idmapconfig.xml

   1 <samba:parameter name="idmap config:OPTION"
   2                  context="G"
   3                  type="string"
   4                  advanced="1" developer="1" hide="1"
   5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   6 <description>
   7
   8         <para>
   9         ID mapping in Samba is the mapping between Windows SIDs and Unix user
  10         and group IDs. This is performed by Winbindd with a configurable plugin
  11         interface. Samba's ID mapping is configured by options starting with the
  12         <smbconfoption name="idmap config"/> prefix.
  13         An idmap option consists of the <smbconfoption name="idmap config"/>
  14         prefix, followed by a domain name or the asterisk character (*),
  15         a colon, and the name of an idmap setting for the chosen domain.
  16         </para>
  17
  18         <para>
  19         The idmap configuration is hence divided into groups, one group
  20         for each domain to be configured, and one group with the the
  21         asterisk instead of a proper domain name, which specifies the
  22         default configuration that is used to catch all domains that do
  23         not have an explicit idmap configuration of their own.
  24         </para>
  25
  26         <para>
  27         There are three general options available:
  28         </para>
  29
  30         <variablelist>
  31                 <varlistentry>
  32                 <term>backend = backend_name</term>
  33                 <listitem><para>
  34                 This specifies the name of the idmap plugin to use as the
  35                 SID/uid/gid backend for this domain. The standard backends are
  36                 tdb
  37                 (<citerefentry><refentrytitle>idmap_tdb</refentrytitle> <manvolnum>8</manvolnum> </citerefentry>),
  38                 tdb2
  39                 (<citerefentry><refentrytitle>idmap_tdb2</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
  40                 ldap
  41                 (<citerefentry><refentrytitle>idmap_ldap</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
  42                 ,
  43                 rid
  44                 (<citerefentry><refentrytitle>idmap_rid</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
  45                 ,
  46                 hash
  47                 (<citerefentry><refentrytitle>idmap_hash</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
  48                 ,
  49                 autorid
  50                 (<citerefentry><refentrytitle>idmap_autorid</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
  51                 ,
  52                 ad
  53                 (<citerefentry><refentrytitle>idmap_ad</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
  54                 ,
  55                 and nss.
  56                 (<citerefentry><refentrytitle>idmap_nss</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
  57                 The corresponding manual pages contain the details, but
  58                 here is a summary.
  59                 </para>
  60                 <para>
  61                 The first three of these create mappings of their own using
  62                 internal unixid counters and store the mappings in a database.
  63                 These are suitable for use in the default idmap configuration.
  64                 The rid and hash backends use a pure algorithmic calculation
  65                 to determine the unixid for a SID. The autorid module is a
  66                 mixture of the tdb and rid backend. It creates ranges for
  67                 each domain encountered and then uses the rid algorithm for each
  68                 of these automatically configured domains individually.
  69                 The ad backend usees unix IDs stored in Active Directory via
  70                 the standard schema extensions. The nss backend reverses
  71                 the standard winbindd setup and gets the unixids via names
  72                 from nsswitch which can be useful in an ldap setup.
  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. For allocating backends, this also
  81                 defines the start and the end of the range for allocating
  82                 new unique IDs.
  83                 </para>
  84                 <para>
  85                 winbind uses this parameter to find the backend that is
  86                 authoritative for a unix ID to SID mapping, so it must be set
  87                 for each individually configured domain and for the default
  88                 configuration. The configured ranges must be mutually disjoint.
  89                 </para></listitem>
  90                 </varlistentry>
  91
  92                 <varlistentry>
  93                 <term>read only = yes|no</term>
  94                 <listitem><para>
  95                 This option can be used to turn the writing backends
  96                 tdb, tdb2, and ldap into read only mode. This can be useful
  97                 e.g. in cases where a pre-filled database exists that should
  98                 not be extended automatically.
  99                 </para></listitem>
 100                 </varlistentry>
 101         </variablelist>
 102
 103         <para>
 104         The following example illustrates how to configure the <citerefentry>
 105         <refentrytitle>idmap_ad</refentrytitle> <manvolnum>8</manvolnum>
 106         </citerefentry> backend for the CORP domain and the
 107         <citerefentry><refentrytitle>idmap_tdb</refentrytitle>
 108         <manvolnum>8</manvolnum></citerefentry> backend for all other
 109         domains. This configuration assumes that the admin of CORP assigns
 110         unix ids below 1000000 via the SFU extensions, and winbind is supposed
 111         to use the next million entries for its own mappings from trusted
 112         domains and for local groups for example.
 113         </para>
 114
 115         <programlisting>
 116         idmap config * : backend = tdb
 117         idmap config * : range = 1000000-1999999
 118
 119         idmap config CORP : backend  = ad
 120         idmap config CORP : range = 1000-999999
 121         </programlisting>
 122
 123 </description>
 124 </samba:parameter>