Debian Codegraph @

upstream/fedora-44/man5/idmapd.conf.5

raw
1 .\"
2 .\" idmapd.conf(5)
3 .\"
4 .\" COPYRIGHT (c) 2008
5 .\" The Regents of the University of Michigan
6 .\" ALL RIGHTS RESERVED
7 .\"
8 .\" Permission is granted to use, copy, create derivative works
9 .\" and redistribute this software and such derivative works
10 .\" for any purpose, so long as the name of The University of
11 .\" Michigan is not used in any advertising or publicity
12 .\" pertaining to the use of distribution of this software
13 .\" without specific, written prior authorization. If the
14 .\" above copyright notice or any other identification of the
15 .\" University of Michigan is included in any copy of any
16 .\" portion of this software, then the disclaimer below must
17 .\" also be included.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION
20 .\" FROM THE UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY
21 .\" PURPOSE, AND WITHOUT WARRANTY BY THE UNIVERSITY OF
22 .\" MICHIGAN OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
23 .\" WITHOUT LIMITATION THE IMPLIED WARRANTIES OF
24 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
25 .\" REGENTS OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE LIABLE
26 .\" FOR ANY DAMAGES, INCLUDING SPECIAL, INDIRECT, INCIDENTAL, OR
27 .\" CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM ARISING
28 .\" OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN
29 .\" IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGES.
31 .\"
32 .TH idmapd.conf 5 "19 Nov 2008"
33 .SH NAME
34 idmapd.conf \- configuration file for libnfsidmap
35 .SH SYNOPSIS
36 Configuration file for libnfsidmap. Used by idmapd and svcgssd to map NFSv4 name to and from ids.
37 .SH DESCRIPTION
38 The
39 .B idmapd.conf
40 configuration files consists of several sections, initiated by strings of the
41 form [General] and [Mapping]. Each section may contain lines of the form
42 .nf
43 variable = value
44 .fi
45 The recognized sections and their recognized variables are as follows:
46 .\"
47 .\" -------------------------------------------------------------------
48 .\" The [General] section
49 .\" -------------------------------------------------------------------
50 .\"
51 .SS "[General] section variables"
52 .nf
53
54
55 .fi
56 .TP
57 .B Verbosity
58 Verbosity level of debugging
59 (Default: 0)
60 .TP
61 .B Domain
62 The local NFSv4 domain name. An NFSv4 domain is a namespace with
63 a unique username<->UID and groupname<->GID mapping.
64 (Default: Host's fully-qualified DNS domain name)
65 .TP
66 .B No-Strip
67 In multi-domain environments, some NFS servers will append the identity
68 management domain to the owner and owner_group in lieu of a true NFSv4
69 domain. This option can facilitate lookups in such environments. If
70 set to a value other than "none", the nsswitch plugin will first pass
71 the name to the password/group lookup function without stripping the
72 domain off. If that mapping fails then the plugin will try again using
73 the old method (comparing the domain in the string to the Domain value,
74 stripping it if it matches, and passing the resulting short name to the
75 lookup function). Valid values are "user", "group", "both", and
76 "none".
77 (Default: "none")
78 .TP
79 .B Reformat-Group
80 Winbind has a quirk whereby doing a group lookup in UPN format
81 (e.g. [email protected]) will cause the group to be
82 displayed prefixed with the full domain in uppercase
83 (e.g. AMERICAS.EXAMPLE.COM\\staff) instead of in the familiar netbios
84 name format (e.g. AMERICAS\\staff). Setting this option to true
85 causes the name to be reformatted before passing it to the group
86 lookup function in order to work around this. This setting is
87 ignored unless No-Strip is set to either "both" or "group".
88 (Default: "false")
89 .TP
90 .B Local-Realms
91 A comma-separated list of Kerberos realm names that may be considered equivalent to the
92 local realm name. For example, users [email protected] and [email protected]
93 may be considered to be the same user in the specified
94 .B Domain.
95 (Default: the host's default realm name)
96 .br
97 .B Note:
98 If a value is specified here, the default local realm must be included as well.
99 .\"
100 .\" -------------------------------------------------------------------
101 .\" The [Mapping] section
102 .\" -------------------------------------------------------------------
103 .\"
104 .SS "[Mapping] section variables"
105 .nf
106
107 .fi
108 .TP
109 .B Nobody-User
110 Local user name to be used when a mapping cannot be completed.
111 .TP
112 .B Nobody-Group
113 Local group name to be used when a mapping cannot be completed.
114 .\"
115 .\" -------------------------------------------------------------------
116 .\" The [Translation] section
117 .\" -------------------------------------------------------------------
118 .\"
119 .SS "[Translation] section variables"
120 .nf
121
122 .fi
123 .TP
124 .B Method
125 A comma-separated, ordered list of mapping methods (plug-ins)
126 to use when mapping between NFSv4 names and local IDs. Each
127 specified method is tried in order until a mapping is found,
128 or there are no more methods to try. The methods included in
129 the default distribution include "nsswitch", "umich_ldap", and
130 "static".
131 (Default: nsswitch)
132 .TP
133 .B GSS-Methods
134 An optional comma-separated, ordered list of mapping methods (plug-ins)
135 to use when mapping between GSS Authenticated names and local IDs.
136 (Default: the same list as specified for
137 .B Method)
138 .\"
139 .\" -------------------------------------------------------------------
140 .\" The [Static] section
141 .\" -------------------------------------------------------------------
142 .\"
143 .SS "[Static] section variables"
144 .nf
145
146 .fi
147 The "static" translation method uses a static list of GSS-Authenticated
148 names to local user names. Entries in the list are of the form:
149 .nf
150 principal@REALM = localusername
151 .fi
152 .\"
153 .\" -------------------------------------------------------------------
154 .\" The [REGEX] section
155 .\" -------------------------------------------------------------------
156 .\"
157 .SS "[REGEX] section variables"
158 .nf
159
160 .fi
161 If the "regex" translation method is specified, the following
162 variables within the [REGEX] section are used to map between NFS4 names and local IDs.
163 .TP
164 .B User-Regex
165 Case-insensitive regular expression that extracts the local user name from an NFSv4 name. Multiple expressions may be concatenated with '|'. The first match will be used.
166 There is no default. A basic regular expression for domain DOMAIN.ORG and realm MY.DOMAIN.ORG would be:
167 .nf
168 ^DOMAIN\\([^@]+)@MY.DOMAIN.ORG$
169 .fi
170 .TP
171 .B Group-Regex
172 Case-insensitive regular expression that extracts the local group name from an NFSv4 name. Multiple expressions may be concatenated with '|'. The first match will be used.
173 There is no default. A basic regular expression for domain DOMAIN.ORG and realm MY.DOMAIN.ORG would be:
174 .nf
175 ^([^@]+)@[email protected]$|^DOMAIN\\([^@]+)@MY.DOMAIN.ORG$
176 .fi
177 .TP
178 .B Prepend-Before-User
179 Constant string to put before a local user name when building an NFSv4 name. Usually this is the short domain name followed by '\'.
180 (Default: none)
181 .TP
182 .B Append-After-User
183 Constant string to put after a local user name when building an NFSv4 name. Usually this is '@' followed by the default realm.
184 (Default: none)
185 .TP
186 .B Prepend-Before-Group
187 Constant string to put before a local group name when building an NFSv4 name. Usually not used.
188 (Default: none)
189 .TP
190 .B Append-After-Group
191 Constant string to put before a local group name when building an NFSv4 name. Usually this is '@' followed by the domain name followed by another '@' and the default realm.
192 (Default: none)
193 .TP
194 .B Group-Name-Prefix
195 Constant string that is prepended to a local group name when converting it to an NFSv4 name. If an NFSv4 group name has this prefix it is removed when converting it to a local group name.
196 With this group names of a central directory can be shortened for an isolated organizational unit if all groups have a common prefix.
197 (Default: none)
198 .TP
199 .B Group-Name-No-Prefix-Regex
200 Case-insensitive regular expression to exclude groups from adding and removing the prefix set by
201 .BR Group-Name-Prefix .
202 The regular expression must match both the remote and local group names. Multiple expressions may be concatenated with '|'.
203 (Default: none)
204 .\"
205 .\" -------------------------------------------------------------------
206 .\" The [UMICH_SCHEMA] section
207 .\" -------------------------------------------------------------------
208 .\"
209 .SS "[UMICH_SCHEMA] section variables"
210 .nf
211
212 .fi
213 If the "umich_ldap" translation method is specified, the following
214 variables within the [UMICH_SCHEMA] section are used.
215 .TP
216 .B LDAP_server
217 LDAP server name or address
218 (Required if using UMICH_LDAP)
219 .TP
220 .B LDAP_base
221 Absolute LDAP search base.
222 (Required if using UMICH_LDAP)
223 .TP
224 .B LDAP_people_base
225 Absolute LDAP search base for people accounts.
226 (Default: The
227 .B LDAP_base
228 value)
229 .TP
230 .B LDAP_group_base
231 Absolute LDAP search base for group accounts.
232 (Default: The
233 .B LDAP_base
234 value)
235 .TP
236 .B LDAP_canonicalize_name
237 Whether or not to perform name canonicalization on the
238 name given as
239 .B LDAP_server
240 (Default: "true")
241 .TP
242 .B LDAP_follow_referrals
243 Whether or not to follow ldap referrals. (Default: "true")
244 .TP
245 .B LDAP_use_ssl
246 Set to "true" to enable SSL communication with the LDAP server.
247 (Default: "false")
248 .TP
249 .B LDAP_ca_cert
250 Location of a trusted CA certificate used when SSL is enabled
251 (Required if
252 .B LDAP_use_ssl
253 is true and
254 .B LDAP_tls_reqcert
255 is not set to never)
256 .TP
257 .B LDAP_tls_reqcert
258 Controls the LDAP server certificate validation behavior.
259 It can take the same values as ldap.conf(5)'s
260 .B TLS_REQCERT
261 tunable.
262 (Default: "hard")
263 .TP
264 .B LDAP_timeout_seconds
265 Number of seconds before timing out an LDAP request
266 (Default: 4)
267 .TP
268 .B LDAP_sasl_mech
269 SASL mechanism to be used for sasl authentication. Required
270 if SASL auth is to be used (Default: None)
271 .TP
272 .B LDAP_realm
273 SASL realm to be used for sasl authentication. (Default: None)
274 .TP
275 .B LDAP_sasl_authcid
276 Authentication identity to be used for sasl authentication. (Default: None)
277 .TP
278 .B LDAP_sasl_authzid
279 Authorization identity to be used for sasl authentication. (Default: None)
280 .TP
281 .B LDAP_sasl_secprops
282 Cyrus SASL security properties. It can the same values as ldap.conf(5)'s
283 sasl_secprops.
284 .TP
285 .B LDAP_sasl_canonicalize
286 Specifies whether the LDAP server hostname should be canonicalised.
287 If set to yes LDAP lib with do a reverse hostname lookup.
288 If this is not set the LDAP library's default will be used. (Default:
289 None)
290 .TP
291 .B LDAP_sasl_krb5_ccname
292 Path to kerberos credential cache. If it is not set then the value
293 of environment variable KRB5CCNAME will be used. If the environment
294 variable is not set then the default mechanism of kerberos library
295 will be used.
296 .TP
297 .B NFSv4_person_objectclass
298 The object class name for people accounts in your local LDAP schema
299 (Default: NFSv4RemotePerson)
300 .TP
301 .B NFSv4_name_attr
302 Your local schema's attribute name to be used for NFSv4 user names
303 (Default: NFSv4Name)
304 .TP
305 .B NFSv4_uid_attr
306 Your local schema's attribute name to be used for uidNumber
307 (Default: uidNumber)
308 .TP
309 .B GSS_principal_attr
310 Your local schema's attribute name for GSSAPI Principal names
311 (Default: GSSAuthName)
312 .TP
313 .B NFSv4_acctname_attr
314 Your local schema's attribute name to be used for account names
315 (Default: uid)
316 .TP
317 .B NFSv4_group_objectclass
318 The object class name for group accounts in your local LDAP schema
319 (Default: NFSv4RemoteGroup)
320 .TP
321 .B NFSv4_gid_attr
322 Your local schema's attribute name to be used for gidNumber
323 (Default: gidNumber)
324 .TP
325 .B NFSv4_group_attr
326 Your local schema's attribute name to be used for NFSv4 group names
327 (Default: NFSv4Name)
328 .TP
329 .B LDAP_use_memberof_for_groups
330 Some LDAP servers do a better job with indexing where searching
331 through all the groups searching for the user in the memberuid
332 list. Others like SunOne directory that search can takes minutes
333 if there are thousands of groups. So setting
334 .B LDAP_use_memberof_for_groups
335 to true in the configuration file will use the memberof lists of
336 the account and search through only those groups to obtain gids.
337 (Default: false)
338 .TP
339 .B NFSv4_member_attr
340 If
341 .B LDAP_use_memberof_for_groups
342 is true, this is the attribute to be searched for.
343 (Default: memberUid)
344 .TP
345 .B NFSv4_grouplist_filter
346 An optional search filter for determining group membership.
347 (No Default)
348 .\"
349 .\" -------------------------------------------------------------------
350 .\" An Example
351 .\" -------------------------------------------------------------------
352 .\"
353 .SH EXAMPLES
354 An example
355 .I /etc/idmapd.conf
356 file:
357 .nf
358
359
360 [General]
361
362 Verbosity = 0
363 Domain = domain.org
364 Local-Realms = DOMAIN.ORG,MY.DOMAIN.ORG,YOUR.DOMAIN.ORG
365
366 [Mapping]
367
368 Nobody-User = nfsnobody
369 Nobody-Group = nfsnobody
370
371 [Translation]
372
373 Method = umich_ldap,regex,nsswitch
374 GSS-Methods = umich_ldap,regex,static
375
376 [Static]
377
378 [email protected] = johnny
379
380 [Regex]
381
382 User-Regex = ^DOMAIN\\([^@]+)@DOMAIN.ORG$
383 Group-Regex = ^([^@]+)@[email protected]$|^DOMAIN\\([^@]+)@DOMAIN.ORG$
384 Prepend-Before-User = DOMAIN\
385 Append-After-User = @DOMAIN.ORG
386 Append-After-Group = @[email protected]
387 Group-Name-Prefix = sales-
388 Group-Name-No-Prefix-Regex = -personal-group$
389
390 [UMICH_SCHEMA]
391
392 LDAP_server = ldap.domain.org
393 LDAP_base = dc=org,dc=domain
394
395 .fi
396 .\"
397 .\" -------------------------------------------------------------------
398 .\" Additional sections
399 .\" -------------------------------------------------------------------
400 .\"
401 .SH FILES
402 .I /usr/etc/idmapd.conf
403 .br
404 .I /usr/etc/idmapd.conf.d/*.conf
405 .br
406 .I /etc/idmapd.conf
407 .br
408 .I /etc/idmapd.conf.d/*.conf
409 .br
410 .IP
411 Files are read in the order listed. Later settings override earlier
412 settings.
413
414 .SH SEE ALSO
415 .BR idmapd (8)
416 .BR svcgssd (8)
417 .\".SH COMPATIBILITY
418 .\".SH STANDARDS
419 .\".SH ACKNOWLEDGEMENTS
420 .\".SH AUTHORS
421 .\".SH HISTORY
422 .SH BUGS
423 Report bugs to <[email protected]>
424 .\".SH CAVEATS