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