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.
77 [attrs=<attrlist>[ val[.<style>]=<attrval>]]
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;
98 indicates all the entries immediately below the
103 indicates all entries in the subtree at the pattern,
105 indicates all the entries below (subordinate to) the pattern.
111 then the value is a regular expression pattern,
114 matching a normalized string representation of the entry's DN.
115 The regex form of the pattern does not (yet) support UTF-8.
118 .B filter=<ldapfilter>
119 selects the entries based on a valid LDAP filter as described in RFC 2254.
123 selects the attributes the access control rule applies to.
124 It is a comma-separated list of attribute types, plus the special names
126 indicating access to the entry itself, and
128 indicating access to the entry's children. ObjectClass names may also
129 be specified in this list, which will affect all the attributes that
130 are required and/or allowed by that objectClass.
135 are directly treated as objectClass names. A name prefixed by
137 is also treated as an objectClass, but in this case the access rule
138 affects the attributes that are not required nor allowed
142 .B attrs=<attr> val[.<style>]=<value>
143 specifies access to a particular value of a single attribute.
144 In this case, only a single attribute type may be given. A value
148 (the default) uses the attribute's equality matching rule to compare the
153 the provided value is used as a regular expression pattern.
154 If the attribute has DN syntax, the value
162 resulting in base, onelevel, subtree or children match, respectively.
164 The dn, filter, and attrs statements are additive; they can be used in sequence
165 to select entities the access rule applies to based on naming context,
166 value and attribute type simultaneously.
170 indicates whom the access rules apply to.
173 statements can appear in an access control statement, indicating the
174 different access privileges to the same resource that apply to different
176 It can have the forms
184 dn[.<dnstyle>[,<modifier>]]=<DN>
186 group[/<objectclass>[/<attrname>]]
188 peername[.<style>]=<peername>
189 sockname[.<style>]=<sockname>
190 domain[.<domainstyle>[,<modifier>]]=<domain>
191 sockurl[.<style>]=<sockurl>
192 set[.<style>]=<pattern>
202 They may be specified in combination.
213 means access is granted to unauthenticated clients; it is mostly used
214 to limit access to authentication resources (e.g. the
216 attribute) to unauthenticated clients for authentication purposes.
220 means access is granted to authenticated clients.
224 means access to an entry is allowed to the entry itself (e.g. the entry
225 being accessed and the requesting entry must be the same).
229 means that access is granted to the matching DN.
230 The optional style qualifier
232 allows the same choices of the dn form of the
234 field. In addition, the
236 style can exploit substring substitution of submatches in the
238 dn.regex clause by using the form
246 At present, the only type allowed is
248 which causes substring substitution of submatches to take place
256 means that access is granted to requests whose DN is listed in the
257 entry being accessed under the
263 means that access is granted to requests whose DN is listed
264 in the group entry whose DN is given by
266 The optional parameters
270 define the objectClass and the member attributeType of the group entry.
271 The optional style qualifier
277 will be expanded as a replacement string (but not as a regular expression)
278 according to regex (7), and
284 which means that exact match will be used.
286 For static groups, the specified attributeType must have
289 .B NameAndOptionalUID
290 syntax. For dynamic groups the attributeType must
293 attributeType. Only LDAP URIs of the form
294 .B ldap:///<base>??<scope>?<filter>
295 will be evaluated in a dynamic group.
298 .BR peername=<peername> ,
299 .BR sockname=<sockname> ,
300 .BR domain=<domain> ,
302 .BR sockurl=<sockurl>
303 mean that the contacting host IP for
305 the named pipe file name for
307 the contacting host name for
309 and the contacting URL for
316 rules for pattern match described for the
321 clause also allows the
323 style, which succeeds when a fully qualified name exactly matches the
325 pattern, or its trailing part, after a
332 of the contacting host is determined by performing a DNS reverse lookup.
333 As this lookup can easily be spoofed, use of the
335 statement is strongly discouraged. By default, reverse lookups are disabled.
342 option; the only value currently supported is
344 which causes substring substitution of submatches to take place even if
349 much like the analogous usage in
359 means that the access control is determined by the values in the
362 ACIs are experimental; they must be enabled at compile time.
366 .BR transport_ssf=<n> ,
370 set the required Security Strength Factor (ssf) required to grant access.
371 .SH THE <ACCESS> FIELD
373 .B <access> ::= [self]{<level>|<priv>}
374 determines the access level or the specific access privileges the
377 Its component are defined as
380 <level> ::= none|auth|compare|search|read|write
381 <priv> ::= {=|+|-}{w|r|s|c|x|0}+
386 allows special operations like having a certain access level or privilege
387 only in case the operation involves the name of the user that's requesting
389 It implies the user that requests access is bound.
392 access to the member attribute of a group, which allows one to add/delete
393 its own DN from the member list of a group, without affecting other members.
397 access model relies on an incremental interpretation of the access
399 The possible levels are
407 Each access level implies all the preceding ones, thus
409 access will imply all accesses.
414 access means that one is allowed access to an attribute to perform
415 authentication/authorization operations (e.g.
417 with no other access.
418 This is useful to grant unauthenticated clients the least possible
419 access level to critical resources, like passwords.
423 access model relies on the explicit setting of access privileges
427 sign resets previously defined accesses; as a consequence, the final
428 access privileges will be only those defined by the clause.
433 signs add/remove access privileges to the existing ones.
445 More than one of the above privileges can be added in one statement.
447 indicates no privileges and is used only by itself (e.g., +0).
451 controls the flow of access rule application.
452 It can have the forms
462 the default, means access checking stops in case of match.
463 The other two forms are used to keep on processing access clauses.
466 form allows for other
470 clause to be considered, so that they may result in incrementally altering
471 the privileges, while the
473 form allows for other
475 clauses that match the same target to be processed.
476 Consider the (silly) example
479 access to dn.subtree="dc=example,dc=com" attrs=cn
482 access to dn.subtree="ou=People,dc=example,dc=com"
486 which allows search and compare privileges to everybody under
487 the "dc=example,dc=com" tree, with the second rule allowing
488 also read in the "ou=People" subtree,
489 or the (even more silly) example
492 access to dn.subtree="dc=example,dc=com" attrs=cn
497 which grants everybody search and compare privileges, and adds read
498 privileges to authenticated clients.
499 .SH OPERATION REQUIREMENTS
500 Operations require different privileges on different portions of entries.
501 The following summary applies to primary database backends such as
502 the LDBM, BDB, and HDB backends. Requirements for other backends may
503 (and often do) differ.
509 privileges on the pseudo-attribute
511 of the entry being added, and
513 privileges on the pseudo-attribute
515 of the entry's parent.
519 operation, when credentials are stored in the directory, requires
521 privileges on the attribute the credentials are stored in (usually
528 privileges on the attribute that is being compared.
534 privileges on the pseudo-attribute
536 of the entry being deleted, and
540 pseudo-attribute of the entry's parent.
546 privileges on the attibutes being modified.
552 privileges on the pseudo-attribute
554 of the entry whose relative DN is being modified,
556 privileges on the pseudo-attribute
558 of the old and new entry's parents, and
560 privileges on the attributes that are present in the new relative DN.
562 privileges are also required on the attributes that are present
563 in the old relative DN if
569 operation, for each entry, requires
571 privileges on the attributes that are defined in the filter.
572 Then, the resulting entries are tested for
574 privileges on the pseudo-attribute
576 (for read access to the entry itself)
579 access on each value of each attribute that is requested.
582 object used in generating continuation references, the operation requires
584 access on the pseudo-attribute
586 (for read access to the referral object itself),
589 access to the attribute holding the referral information
596 require specific access privileges.
601 privileges on all the attributes that are present in the search filter
602 of the URI regexp maps (the right-hand side of the
609 attribute of the authorizing identity and/or on the
611 attribute of the authorized identity.
613 It is strongly recommended to explicitly use the most appropriate
615 to avoid possible incorrect specifications of the access rules as well
616 as for performance (avoid unrequired regex matching when an exact
617 match suffices) reasons.
619 An adminisistrator might create a rule of the form:
622 access to dn.regex="dc=example,dc=com"
626 expecting it to match all entries in the subtree "dc=example,dc=com".
627 However, this rule actually matches any DN which contains anywhere
628 the substring "dc=example,dc=com". That is, the rule matches both
629 "uid=joe,dc=example,dc=com" and "dc=example,dc=com,uid=joe".
631 To match the desired subtree, the rule would be more precisely
635 access to dn.regex="^(.+,)?dc=example,dc=com$$"
639 For performance reasons, it would be better to use the subtree style.
642 access to dn.subtree="dc=example,dc=com"
646 When writing submatch rules, it may be convenient to avoid unnecessary
649 use; for instance, to allow access to the subtree of the user
652 clause, one could use
655 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$$"
656 by dn.regex="^uid=$1,dc=example,dc=com$$" write
660 However, since all that is required in the
662 clause is substring expansion, a more efficient solution is
665 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$$"
666 by dn.exact,expand="uid=$1,dc=example,dc=com" write
674 implies substring expansion,
676 as well as all the other DN specific
678 values, does not, so it must be explicitly requested.
683 default slapd configuration file
687 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
690 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
692 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob