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

Last change on this file was 989, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.7

File size: 4.1 KB
Line 
1'\" t
2.\" Title: idmap_rid
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 10/25/2016
6.\" Manual: System Administration tools
7.\" Source: Samba 4.4
8.\" Language: English
9.\"
10.TH "IDMAP_RID" "8" "10/25/2016" "Samba 4\&.4" "System Administration tools"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31idmap_rid \- Samba\*(Aqs idmap_rid Backend for Winbind
32.SH "DESCRIPTION"
33.PP
34The 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\&.
35.PP
36Note 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 backend like
37\fItdb\fR
38or
39\fIldap\fR
40that 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\&.
41.PP
42Note that the old syntax
43\fIidmap backend = rid:"DOM1=range DOM2=range2 \&.\&.\&."\fR
44is not supported any more since Samba version 3\&.0\&.25\&.
45.SH "IDMAP OPTIONS"
46.PP
47range = low \- high
48.RS 4
49Defines 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\&.
50.RE
51.PP
52base_rid = INTEGER
53.RS 4
54Defines 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\&.
55.sp
56Use of this parameter is deprecated\&.
57.RE
58.SH "THE MAPPING FORMULAS"
59.PP
60The Unix ID for a RID is calculated this way:
61.sp
62.if n \{\
63.RS 4
64.\}
65.nf
66 ID = RID \- BASE_RID + LOW_RANGE_ID\&.
67
68.fi
69.if n \{\
70.RE
71.\}
72.PP
73Correspondingly, the formula for calculating the RID for a given Unix ID is this:
74.sp
75.if n \{\
76.RS 4
77.\}
78.nf
79 RID = ID + BASE_RID \- LOW_RANGE_ID\&.
80
81.fi
82.if n \{\
83.RE
84.\}
85.sp
86.SH "EXAMPLES"
87.PP
88This 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\&.
89.sp
90.if n \{\
91.RS 4
92.\}
93.nf
94 [global]
95 security = domain
96 workgroup = MAIN
97
98 idmap config * : backend = tdb
99 idmap config * : range = 1000000\-1999999
100
101 idmap config MAIN : backend = rid
102 idmap config MAIN : range = 10000 \- 49999
103
104 idmap config TRUSTED : backend = rid
105 idmap config TRUSTED : range = 50000 \- 99999
106
107.fi
108.if n \{\
109.RE
110.\}
111.SH "AUTHOR"
112.PP
113The 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.