1 .TH SLAPD.ACCESS 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2003 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
5 slapd.access \- access configuration for slapd, the stand-alone LDAP daemon
11 file contains configuration information for the
13 daemon. This configuration file is also used by the
15 replication daemon and by the SLAPD tools
23 file consists of a series of global configuration options that apply to
25 as a whole (including all backends), followed by zero or more database
26 backend definitions that contain information specific to a backend
34 # comment - these options apply to every database
35 <global configuration options>
36 # first database definition & configuration options
37 database <backend 1 type>
38 <configuration options specific to backend 1>
39 # subsequent database definitions & configuration options
43 Both the global configuration and each backend-specific section can
44 contain access information. Backend-specific access control
45 directives are used for those entries that belong to the backend,
46 according to their naming context. In case no access control
47 directives are defined for a backend or those which are defined are
48 not applicable, the directives from the global configuration section
51 For entries not held in any backend (such as a root DSE), the
52 directives of the first backend (and any global directives) are
55 Arguments that should be replaced by actual text are shown in
57 .SH THE ACCESS DIRECTIVE
58 The structure of the access control directives is
60 .B access to <what> "[ by <who> <access> [ <control> ] ]+"
61 Grant access (specified by
63 to a set of entries and/or attributes (specified by
65 by one or more requestors (specified by
70 specifies the entity the access control directive applies to.
82 stands for all the entries.
86 selects the entries based on their naming context.
87 The pattern is a string representation of the entry's DN.
94 indicates the entry whose DN is equal to the pattern.
96 indicates all the entries immediately below the
99 indicates all entries in the subtree at the pattern,
101 indicates all the entries below (subordinate to) the pattern.
107 then the value is a regular expression pattern,
110 matching a normalized string representation of the entry's DN.
111 The regex form of the pattern does not (yet) support UTF-8.
114 .B filter=<ldapfilter>
115 selects the entries based on a valid LDAP filter as described in RFC 2254.
119 selects the attributes the access control rule applies to.
120 It is a comma-separated list of attribute types, plus the special names
122 indicating access to the entry itself, and
124 indicating access to the entry's children. ObjectClass names may also
125 be specified in this list, which will affect all the attributes that
126 are required and/or allowed by that objectClass.
129 .B attrs=<attr> val[.<style>]=<value>
130 specifies access to a particular value of a single attribute.
131 In this case, only a single attribute type may be given. A value
135 (the default) uses the attribute's equality matching rule to compare the
140 the provided value is used as a regular expression pattern.
142 The dn, filter, and attrs statements are additive; they can be used in sequence
143 to select entities the access rule applies to based on naming context,
144 value and attribute type simultaneously.
148 indicates whom the access rules apply to.
151 statements can appear in an access control statement, indicating the
152 different access privileges to the same resource that apply to different
154 It can have the forms
162 dn[.<dnstyle>[,<modifier>]]=<DN>
164 group[/<objectclass>[/<attrname>]]
166 peername[.<style>]=<peername>
167 sockname[.<style>]=<sockname>
168 domain[.<domainstyle>[,<modifier>]]=<domain>
169 sockurl[.<style>]=<sockurl>
170 set[.<style>]=<pattern>
180 They may be specified in combination.
191 means access is granted to unauthenticated clients; it is mostly used
192 to limit access to authentication resources (e.g. the
194 attribute) to unauthenticated clients for authentication purposes.
198 means access is granted to authenticated clients.
202 means access to an entry is allowed to the entry itself (e.g. the entry
203 being accessed and the requesting entry must be the same).
207 means that access is granted to the matching DN.
208 The optional style qualifier
210 allows the same choices of the dn form of the
212 field. In addition, the
214 style can exploit substring substitution of submatches in the
216 dn.regex clause by using the form
224 At present, the only type allowed is
226 which causes substring substitution of submatches to take place
234 means that access is granted to requests whose DN is listed in the
235 entry being accessed under the
241 means that access is granted to requests whose DN is listed
242 in the group entry whose DN is given by
244 The optional parameters
248 define the objectClass and the member attributeType of the group entry.
249 The optional style qualifier
255 will be expanded as a replacement string (but not as a regular expression)
256 according to regex (7), and
262 which means that exact match will be used.
264 For static groups, the specified attributeType must have
267 .B NameAndOptionalUID
268 syntax. For dynamic groups the attributeType must
271 attributeType. Only LDAP URIs of the form
272 .B ldap:///<base>??<scope>?<filter>
273 will be evaluated in a dynamic group.
276 .BR peername=<peername> ,
277 .BR sockname=<sockname> ,
278 .BR domain=<domain> ,
280 .BR sockurl=<sockurl>
281 mean that the contacting host IP for
283 the named pipe file name for
285 the contacting host name for
287 and the contacting URL for
294 rules for pattern match described for the
299 clause also allows the
301 style, which succeeds when a fully qualified name exactly matches the
303 pattern, or its trailing part, after a
310 of the contacting host is determined by performing a DNS reverse lookup.
311 As this lookup can easily be spoofed, use of the
313 statement is strongly discouraged. By default, reverse lookups are disabled.
320 option; the only value currently supported is
322 which causes substring substitution of submatches to take place even if
327 much like the analogous usage in
337 means that the access control is determined by the values in the
340 ACIs are experimental; they must be enabled at compile time.
344 .BR transport_ssf=<n> ,
348 set the required Security Strength Factor (ssf) required to grant access.
349 .SH THE <ACCESS> FIELD
351 .B <access> ::= [self]{<level>|<priv>}
352 determines the access level or the specific access privileges the
355 Its component are defined as
358 <level> ::= none|auth|compare|search|read|write
359 <priv> ::= {=|+|-}{w|r|s|c|x}+
364 allows special operations like having a certain access level or privilege
365 only in case the operation involves the name of the user that's requesting
367 It implies the user that requests access is bound.
370 access to the member attribute of a group, which allows one to add/delete
371 its own DN from the member list of a group, without affecting other members.
375 access model relies on an incremental interpretation of the access
377 The possible levels are
385 Each access level implies all the preceding ones, thus
387 access will imply all accesses.
392 access means that one is allowed access to an attribute to perform
393 authentication/authorization operations (e.g.
395 with no other access.
396 This is useful to grant unauthenticated clients the least possible
397 access level to critical resources, like passwords.
401 access model relies on the explicit setting of access privileges
405 sign resets previously defined accesses; as a consequence, the final
406 access privileges will be only those defined by the clause.
411 signs add/remove access privileges to the existing ones.
423 More than one privilege can be added in one statement.
427 controls the flow of access rule application.
428 It can have the forms
438 the default, means access checking stops in case of match.
439 The other two forms are used to keep on processing access clauses.
442 form allows for other
446 clause to be considered, so that they may result in incrementally altering
447 the privileges, while the
449 form allows for other
451 clauses that match the same target to be processed.
452 Consider the (silly) example
455 access to dn.subtree="dc=example,dc=com" attrs=cn
458 access to dn.subtree="ou=People,dc=example,dc=com"
462 which allows search and compare privileges to everybody under
463 the "dc=example,dc=com" tree, with the second rule allowing
464 also read in the "ou=People" subtree,
465 or the (even more silly) example
468 access to dn.subtree="dc=example,dc=com" attrs=cn
473 which grants everybody search and compare privileges, and adds read
474 privileges to authenticated clients.
475 .SH OPERATION REQUIREMENTS
476 Operations require different privileges on different portions of entries.
477 The following summary applies to primary database backends such as
478 the LDBM, BDB, and HDB backends. Requirements for other backends may
479 (and often do) differ.
485 privileges on the pseudo-attribute
487 of the entry being added, and
489 privileges on the pseudo-attribute
491 of the entry's parent.
495 operation, when credentials are stored in the directory, requires
497 privileges on the attribute the credentials are stored in (usually
504 privileges on the attribute that is being compared.
510 privileges on the pseudo-attribute
512 of the entry being deleted, and
516 pseudo-attribute of the entry's parent.
522 privileges on the attibutes being modified.
528 privileges on the pseudo-attribute
530 of the entry whose relative DN is being modified,
532 privileges on the pseudo-attribute
534 of the old and new entry's parents, and
536 privileges on the attributes that are present in the new relative DN.
538 privileges are also required on the attributes that are present
539 in the old relative DN if
545 operation, for each entry, requires
547 privileges on the attributes that are defined in the filter.
548 Then, the resulting entries are tested for
550 privileges on the pseudo-attribute
552 (for read access to the entry itself)
555 access on each value of each attribute that is requested.
558 object used in generating continuation references, the operation requires
560 access on the pseudo-attribute
562 (for read access to the referral object itself),
565 access to the attribute holding the referral information
570 It is strongly recommended to explicitly use the most appropriate
573 to avoid possible incorrect specifications of the access rules as well
574 as for performance (avoid unrequired regex matching when an exact
575 match suffices) reasons.
577 An adminisistrator might create a rule of the form:
580 access to dn.regex="dc=example,dc=com"
584 expecting it to match all entries in the subtree "dc=example,dc=com".
585 However, this rule actually matches any DN which contains anywhere
586 the substring "dc=example,dc=com". That is, the rule matches both
587 "uid=joe,dc=example,dc=com" and "dc=example,dc=com,uid=joe".
589 To match the desired subtree, the rule would be more precisely
593 access to dn.regex="^(.+,)?dc=example,dc=com$$"
597 For performance reasons, it would be better to use the subtree style.
600 access to dn.subtree="dc=example,dc=com"
607 default slapd configuration file
611 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
614 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
616 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob