source: vendor/current/docs/manpages/idmap_rid.8@ 740

Last change on this file since 740 was 740, checked in by Silvan Scherrer, 12 years ago

Samba Server: update vendor to 3.6.0

File size: 3.9 KB
Line 
1'\" t
2.\" Title: idmap_rid
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5.\" Date: 08/08/2011
6.\" Manual: System Administration tools
7.\" Source: Samba 3.6
8.\" Language: English
9.\"
10.TH "IDMAP_RID" "8" "08/08/2011" "Samba 3\&.6" "System Administration tools"
11.\" -----------------------------------------------------------------
12.\" * set default formatting
13.\" -----------------------------------------------------------------
14.\" disable hyphenation
15.nh
16.\" disable justification (adjust text to left margin only)
17.ad l
18.\" -----------------------------------------------------------------
19.\" * MAIN CONTENT STARTS HERE *
20.\" -----------------------------------------------------------------
21.SH "NAME"
22idmap_rid \- Samba\'s idmap_rid Backend for Winbind
23.SH "DESCRIPTION"
24.PP
25The idmap_rid backend provides a way to use an algorithmic mapping scheme to map UIDs/GIDs and SIDs\&. No database is required in this case as the mapping is deterministic\&.
26.PP
27Note that the idmap_rid module has changed considerably since Samba versions 3\&.0\&. and 3\&.2\&. Currently, there should to be an explicit idmap configuration for each domain that should use the idmap_rid backend, using disjoint ranges\&. One usually needs to define a writeable default idmap range, using a backent like
28\fItdb\fR
29or
30\fIldap\fR
31that can create unix ids, in order to be able to map the BUILTIN sids and other domains, and also in order to be able to create group mappings\&. See the example below\&.
32.PP
33Note that the old syntax
34\fIidmap backend = rid:"DOM1=range DOM2=range2 \&.\&.\&."\fR
35is not supported any more since Samba version 3\&.0\&.25\&.
36.SH "IDMAP OPTIONS"
37.PP
38range = low \- high
39.RS 4
40Defines the available matching uid and gid range for which the backend is authoritative\&. Note that the range acts as a filter\&. If algorithmically determined UID or GID fall outside the range, they are ignored and the corresponding map is discarded\&. It is intended as a way to avoid accidental UID/GID overlaps between local and remotely defined IDs\&.
41.RE
42.PP
43base_rid = INTEGER
44.RS 4
45Defines the base integer used to build SIDs out of a UID or a GID, and to rebase the UID or GID to be obtained from a SID\&. This means SIDs with a RID less than the base rid are filtered\&. The default is not to restrict the allowed rids at all, i\&.e\&. a base_rid value of 0\&. A good value for the base_rid can be 1000, since user RIDs by default start at 1000 (512 hexadecimal)\&.
46.sp
47Use of this parameter is deprecated\&.
48.RE
49.SH "THE MAPPING FORMULAS"
50.PP
51The Unix ID for a RID is calculated this way:
52.sp
53.if n \{\
54.RS 4
55.\}
56.nf
57 ID = RID \- BASE_RID + LOW_RANGE_ID\&.
58
59.fi
60.if n \{\
61.RE
62.\}
63.PP
64Correspondingly, the formula for calculating the RID for a given Unix ID is this:
65.sp
66.if n \{\
67.RS 4
68.\}
69.nf
70 RID = ID + BASE_RID \- LOW_RANGE_ID\&.
71
72.fi
73.if n \{\
74.RE
75.\}
76.sp
77.SH "EXAMPLES"
78.PP
79This example shows how to configure two domains with idmap_rid, the principal domain and a trusted domain, leaving the default id mapping scheme at tdb\&. The example also demonstrates the use of the base_rid parameter for the trusted domain\&.
80.sp
81.if n \{\
82.RS 4
83.\}
84.nf
85 [global]
86 security = domain
87 workgroup = MAIN
88
89 idmap config * : backend = tdb
90 idmap config * : range = 1000000\-1999999
91
92 idmap config MAIN : backend = rid
93 idmap config MAIN : range = 10000 \- 49999
94
95 idmap config TRUSTED : backend = rid
96 idmap config TRUSTED : range = 50000 \- 99999
97 idmap config TRUSTED : base_rid = 1000
98
99.fi
100.if n \{\
101.RE
102.\}
103.SH "AUTHOR"
104.PP
105The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
Note: See TracBrowser for help on using the repository browser.