← Back to branch summary

~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to docs-xml/manpages-3/idmap_rid.8.xml

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.4</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 a UID or a GID,
 
46
                        and to rebase the UID or GID to be obtained from a SID.
 
47
                        This means SIDs with a RID less than the base rid are filtered.
 
48
                        The default is not to restrict the allowed rids at all,
 
49
                        i.e. a base_rid value of 0.
 
50
                        A good value for the base_rid can be 1000, since user
 
51
                        RIDs by default start at 1000 (512 hexadecimal).
 
52
                </para>
 
53
                <para>
 
54
                        Use of this parameter is deprecated.
 
55
                </para></listitem>
 
56
                </varlistentry>
 
57
        </variablelist>
 
58
</refsect1>
 
59
 
 
60
<refsect1>
 
61
        <title>THE MAPPING FORMULAS</title>
 
62
        <para>
 
63
                The Unix ID for a RID is calculated this way:
 
64
                <programlisting>
 
65
                        ID = RID - BASE_RID + LOW_RANGE_ID.
 
66
                </programlisting>
 
67
        </para>
 
68
        <para>
 
69
                Correspondingly, the formula for calculating the RID for a
 
70
                given Unix ID is this:
 
71
                <programlisting>
 
72
                        RID = ID + BASE_RID - LOW_RANGE_ID.
 
73
                </programlisting>
 
74
        </para>
 
75
</refsect1>
 
76
 
 
77
<refsect1>
 
78
        <title>EXAMPLES</title>
 
79
        <para>
 
80
                This example shows how to configure two domains with idmap_rid,
 
81
                the principal domain and a trusted domain, leaving the default
 
82
                id mapping scheme at tdb. The example also demonstrates the use
 
83
                of the base_rid parameter for the trusted domain.
 
84
        </para>
 
85
 
 
86
        <programlisting>
 
87
        [global]
 
88
        security = domain
 
89
        workgroup = MAIN
 
90
 
 
91
        idmap backend = tdb
 
92
        idmap uid = 1000000-1999999
 
93
        idmap gid = 1000000-1999999
 
94
 
 
95
        idmap config MAIN : backend     = rid
 
96
        idmap config MAIN : range       = 10000 - 49999
 
97
 
 
98
        idmap config TRUSTED : backend  = rid
 
99
        idmap config TRUSTED : range    = 50000 - 99999
 
100
        idmap config TRUSTED : base_rid = 1000
 
101
        </programlisting>
 
102
</refsect1>
 
103
 
 
104
<refsect1>
 
105
        <title>AUTHOR</title>
 
106
 
 
107
        <para>
 
108
        The original Samba software and related utilities
 
109
        were created by Andrew Tridgell. Samba is now developed
 
110
        by the Samba Team as an Open Source project similar
 
111
        to the way the Linux kernel is developed.
 
112
        </para>
 
113
</refsect1>
 
114
 
 
115
</refentry>