summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man8/idmap_rid.8
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/archlinux/man8/idmap_rid.8')
-rw-r--r--upstream/archlinux/man8/idmap_rid.8112
1 files changed, 112 insertions, 0 deletions
diff --git a/upstream/archlinux/man8/idmap_rid.8 b/upstream/archlinux/man8/idmap_rid.8
new file mode 100644
index 00000000..154cd8ce
--- /dev/null
+++ b/upstream/archlinux/man8/idmap_rid.8
@@ -0,0 +1,112 @@
+'\" t
+.\" Title: idmap_rid
+.\" Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 02/19/2024
+.\" Manual: System Administration tools
+.\" Source: Samba 4.19.5
+.\" Language: English
+.\"
+.TH "IDMAP_RID" "8" "02/19/2024" "Samba 4\&.19\&.5" "System Administration tools"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+idmap_rid \- Samba\*(Aqs idmap_rid Backend for Winbind
+.SH "DESCRIPTION"
+.PP
+The 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\&.
+.PP
+Currently, there should to be an explicit idmap configuration for each domain that should use the idmap_rid backend, using disjoint ranges\&.
+.PP
+NOTE: The idmap_rid backend can NOT be used as the default backend\&. One usually needs to define a writeable default idmap range, using a backend like
+\fItdb\fR
+or
+\fIldap\fR
+that 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\&.
+.SH "IDMAP OPTIONS"
+.PP
+range = low \- high
+.RS 4
+Defines 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\&.
+.RE
+.PP
+base_rid = INTEGER
+.RS 4
+Defines 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\&.
+.sp
+Use of this parameter is deprecated\&.
+.RE
+.SH "THE MAPPING FORMULAS"
+.PP
+The Unix ID for a RID is calculated this way:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+ ID = RID \- BASE_RID + LOW_RANGE_ID\&.
+
+.fi
+.if n \{\
+.RE
+.\}
+.PP
+Correspondingly, the formula for calculating the RID for a given Unix ID is this:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+ RID = ID + BASE_RID \- LOW_RANGE_ID\&.
+
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+.SH "EXAMPLES"
+.PP
+This 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\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+ [global]
+ security = domain
+ workgroup = MAIN
+
+ idmap config * : backend = tdb
+ idmap config * : range = 1000000\-1999999
+
+ idmap config MAIN : backend = rid
+ idmap config MAIN : range = 10000 \- 49999
+
+ idmap config TRUSTED : backend = rid
+ idmap config TRUSTED : range = 50000 \- 99999
+ idmap config TRUSTED : base_rid = 500000
+
+.fi
+.if n \{\
+.RE
+.\}
+.SH "AUTHOR"
+.PP
+The 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\&.