manpages-3/idmap_rid.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_rid.8">
   4
   5 <refmeta>
   6         <refentrytitle>idmap_rid</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>idmap_rid</refname>
  13         <refpurpose>Samba's idmap_rid Backend for Winbind</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <title>DESCRIPTION</title>
  18         <para>The idmap_rid backend provides a way to use an algorithmic
  19         mapping scheme to map UIDs/GIDs and SIDs. No database is required
  20         in this case as the mapping is deterministic.</para>
  21 </refsynopsisdiv>
  22
  23 <refsect1>
  24         <title>IDMAP OPTIONS</title>
  25
  26         <variablelist>
  27                 <varlistentry>
  28                 <term>range = low - high</term>
  29                 <listitem><para>
  30                         Defines the available matching uid and gid range for which the
  31                         backend is authoritative. Note that the range acts as a filter.
  32                         If algorithmically determined UID or GID fall outside the
  33                         range, they are ignored and the corresponding map is discarded.
  34                         It is intended as a way to avoid accidental UID/GID overlaps
  35                         between local and remotely defined IDs.
  36                 </para></listitem>
  37                 </varlistentry>
  38
  39                 <varlistentry>
  40                 <term>base_rid = INTEGER</term>
  41                 <listitem><para>
  42                         Defines the base integer used to build SIDs out of an UID or a GID,
  43                         and to rebase the UID or GID to be obtained from a SID. User RIDs
  44                         by default start at 1000 (512 hexadecimal), this means a good value
  45                         for base_rid can be 1000 as the resulting ID is calculated this way:
  46                         ID = RID - BASE_RID + LOW RANGE ID.
  47                 </para></listitem>
  48                 </varlistentry>
  49         </variablelist>
  50 </refsect1>
  51
  52 <refsect1>
  53         <title>EXAMPLES</title>
  54         <para>This example shows how to configure 2 domains with idmap_rid</para>
  55
  56         <programlisting>
  57         [global]
  58             idmap domains = MAIN TRUSTED1
  59
  60             idmap config MAIN:backend      = rid
  61             idmap config MAIN:base_rid     = 0
  62             idmap config MAIN:range        = 10000 - 49999
  63
  64             idmap config TRUSTED1:backend  = rid
  65             idmap config TRUSTED1:base_rid = 1000
  66             idmap config TRUSTED1:range    = 50000 - 99999
  67         </programlisting>
  68 </refsect1>
  69
  70 <refsect1>
  71         <title>AUTHOR</title>
  72
  73         <para>
  74         The original Samba software and related utilities
  75         were created by Andrew Tridgell. Samba is now developed
  76         by the Samba Team as an Open Source project similar
  77         to the way the Linux kernel is developed.
  78         </para>
  79 </refsect1>
  80
  81 </refentry>