docs: Update idmap_rid manpage
[kai/samba-autobuild/.git] / docs-xml / manpages / 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">4.7</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
25         <para>
26         Currently, there should to be an explicit idmap configuration for each
27         domain that should use the idmap_rid backend, using disjoint ranges.
28         </para>
29
30         <para>
31         NOTE: The idmap_rid backend can NOT bet used as the default backend.
32         One usually needs to define a writeable default idmap range, using
33         a backend like <parameter>tdb</parameter> or <parameter>ldap</parameter>
34         that can create unix ids, in order to be able to map the BUILTIN sids
35         and other domains, and also in order to be able to create group mappings.
36         See the example below.
37         </para>
38 </refsynopsisdiv>
39
40 <refsect1>
41         <title>IDMAP OPTIONS</title>
42
43         <variablelist>
44                 <varlistentry>
45                 <term>range = low - high</term>
46                 <listitem><para>
47                         Defines the available matching uid and gid range for which the
48                         backend is authoritative. Note that the range acts as a filter.
49                         If algorithmically determined UID or GID fall outside the
50                         range, they are ignored and the corresponding map is discarded.
51                         It is intended as a way to avoid accidental UID/GID overlaps
52                         between local and remotely defined IDs.
53                 </para></listitem>
54                 </varlistentry>
55
56                 <varlistentry>
57                 <term>base_rid = INTEGER</term>
58                 <listitem><para>
59                         Defines the base integer used to build SIDs out of a UID or a GID,
60                         and to rebase the UID or GID to be obtained from a SID.
61                         This means SIDs with a RID less than the base rid are filtered.
62                         The default is not to restrict the allowed rids at all,
63                         i.e. a base_rid value of 0.
64                 </para>
65                 <para>
66                         Use of this parameter is deprecated.
67                 </para></listitem>
68                 </varlistentry>
69         </variablelist>
70 </refsect1>
71
72 <refsect1>
73         <title>THE MAPPING FORMULAS</title>
74         <para>
75                 The Unix ID for a RID is calculated this way:
76                 <programlisting>
77                         ID = RID - BASE_RID + LOW_RANGE_ID.
78                 </programlisting>
79         </para>
80         <para>
81                 Correspondingly, the formula for calculating the RID for a
82                 given Unix ID is this:
83                 <programlisting>
84                         RID = ID + BASE_RID - LOW_RANGE_ID.
85                 </programlisting>
86         </para>
87 </refsect1>
88
89 <refsect1>
90         <title>EXAMPLES</title>
91         <para>
92                 This example shows how to configure two domains with idmap_rid,
93                 the principal domain and a trusted domain, leaving the default
94                 id mapping scheme at tdb. The example also demonstrates the use
95                 of the base_rid parameter for the trusted domain.
96         </para>
97
98         <programlisting>
99         [global]
100         security = domain
101         workgroup = MAIN
102
103         idmap config * : backend        = tdb
104         idmap config * : range          = 1000000-1999999
105
106         idmap config MAIN : backend     = rid
107         idmap config MAIN : range       = 10000 - 49999
108
109         idmap config TRUSTED : backend  = rid
110         idmap config TRUSTED : range    = 50000 - 99999
111         </programlisting>
112 </refsect1>
113
114 <refsect1>
115         <title>AUTHOR</title>
116
117         <para>
118         The original Samba software and related utilities
119         were created by Andrew Tridgell. Samba is now developed
120         by the Samba Team as an Open Source project similar
121         to the way the Linux kernel is developed.
122         </para>
123 </refsect1>
124
125 </refentry>