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.
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.
131 are directly treated as objectClass names. A name prefixed by
133 is also treated as an objectClass, but in this case the access rule
134 affects the attributes that are not required nor allowed
138 .B attrs=<attr> val[.<style>]=<value>
139 specifies access to a particular value of a single attribute.
140 In this case, only a single attribute type may be given. A value
144 (the default) uses the attribute's equality matching rule to compare the
149 the provided value is used as a regular expression pattern.
150 If the attribute has DN syntax, the value
158 resulting in base, onelevel, subtree or children match, respectively.
160 The dn, filter, and attrs statements are additive; they can be used in sequence
161 to select entities the access rule applies to based on naming context,
162 value and attribute type simultaneously.
166 indicates whom the access rules apply to.
169 statements can appear in an access control statement, indicating the
170 different access privileges to the same resource that apply to different
172 It can have the forms
180 dn[.<dnstyle>[,<modifier>]]=<DN>
182 group[/<objectclass>[/<attrname>]]
184 peername[.<style>]=<peername>
185 sockname[.<style>]=<sockname>
186 domain[.<domainstyle>[,<modifier>]]=<domain>
187 sockurl[.<style>]=<sockurl>
188 set[.<style>]=<pattern>
198 They may be specified in combination.
209 means access is granted to unauthenticated clients; it is mostly used
210 to limit access to authentication resources (e.g. the
212 attribute) to unauthenticated clients for authentication purposes.
216 means access is granted to authenticated clients.
220 means access to an entry is allowed to the entry itself (e.g. the entry
221 being accessed and the requesting entry must be the same).
225 means that access is granted to the matching DN.
226 The optional style qualifier
228 allows the same choices of the dn form of the
230 field. In addition, the
232 style can exploit substring substitution of submatches in the
234 dn.regex clause by using the form
242 At present, the only type allowed is
244 which causes substring substitution of submatches to take place
252 means that access is granted to requests whose DN is listed in the
253 entry being accessed under the
259 means that access is granted to requests whose DN is listed
260 in the group entry whose DN is given by
262 The optional parameters
266 define the objectClass and the member attributeType of the group entry.
267 The optional style qualifier
273 will be expanded as a replacement string (but not as a regular expression)
274 according to regex (7), and
280 which means that exact match will be used.
282 For static groups, the specified attributeType must have
285 .B NameAndOptionalUID
286 syntax. For dynamic groups the attributeType must
289 attributeType. Only LDAP URIs of the form
290 .B ldap:///<base>??<scope>?<filter>
291 will be evaluated in a dynamic group.
294 .BR peername=<peername> ,
295 .BR sockname=<sockname> ,
296 .BR domain=<domain> ,
298 .BR sockurl=<sockurl>
299 mean that the contacting host IP for
301 the named pipe file name for
303 the contacting host name for
305 and the contacting URL for
312 rules for pattern match described for the
317 clause also allows the
319 style, which succeeds when a fully qualified name exactly matches the
321 pattern, or its trailing part, after a
328 of the contacting host is determined by performing a DNS reverse lookup.
329 As this lookup can easily be spoofed, use of the
331 statement is strongly discouraged. By default, reverse lookups are disabled.
338 option; the only value currently supported is
340 which causes substring substitution of submatches to take place even if
345 much like the analogous usage in
355 means that the access control is determined by the values in the
358 ACIs are experimental; they must be enabled at compile time.
362 .BR transport_ssf=<n> ,
366 set the required Security Strength Factor (ssf) required to grant access.
367 .SH THE <ACCESS> FIELD
369 .B <access> ::= [self]{<level>|<priv>}
370 determines the access level or the specific access privileges the
373 Its component are defined as
376 <level> ::= none|auth|compare|search|read|write
377 <priv> ::= {=|+|-}{w|r|s|c|x|0}+
382 allows special operations like having a certain access level or privilege
383 only in case the operation involves the name of the user that's requesting
385 It implies the user that requests access is bound.
388 access to the member attribute of a group, which allows one to add/delete
389 its own DN from the member list of a group, without affecting other members.
393 access model relies on an incremental interpretation of the access
395 The possible levels are
403 Each access level implies all the preceding ones, thus
405 access will imply all accesses.
410 access means that one is allowed access to an attribute to perform
411 authentication/authorization operations (e.g.
413 with no other access.
414 This is useful to grant unauthenticated clients the least possible
415 access level to critical resources, like passwords.
419 access model relies on the explicit setting of access privileges
423 sign resets previously defined accesses; as a consequence, the final
424 access privileges will be only those defined by the clause.
429 signs add/remove access privileges to the existing ones.
441 More than one of the above privileges can be added in one statement.
443 indicates no privileges and is used only by itself (e.g., +0).
447 controls the flow of access rule application.
448 It can have the forms
458 the default, means access checking stops in case of match.
459 The other two forms are used to keep on processing access clauses.
462 form allows for other
466 clause to be considered, so that they may result in incrementally altering
467 the privileges, while the
469 form allows for other
471 clauses that match the same target to be processed.
472 Consider the (silly) example
475 access to dn.subtree="dc=example,dc=com" attrs=cn
478 access to dn.subtree="ou=People,dc=example,dc=com"
482 which allows search and compare privileges to everybody under
483 the "dc=example,dc=com" tree, with the second rule allowing
484 also read in the "ou=People" subtree,
485 or the (even more silly) example
488 access to dn.subtree="dc=example,dc=com" attrs=cn
493 which grants everybody search and compare privileges, and adds read
494 privileges to authenticated clients.
495 .SH OPERATION REQUIREMENTS
496 Operations require different privileges on different portions of entries.
497 The following summary applies to primary database backends such as
498 the LDBM, BDB, and HDB backends. Requirements for other backends may
499 (and often do) differ.
505 privileges on the pseudo-attribute
507 of the entry being added, and
509 privileges on the pseudo-attribute
511 of the entry's parent.
515 operation, when credentials are stored in the directory, requires
517 privileges on the attribute the credentials are stored in (usually
524 privileges on the attribute that is being compared.
530 privileges on the pseudo-attribute
532 of the entry being deleted, and
536 pseudo-attribute of the entry's parent.
542 privileges on the attibutes being modified.
548 privileges on the pseudo-attribute
550 of the entry whose relative DN is being modified,
552 privileges on the pseudo-attribute
554 of the old and new entry's parents, and
556 privileges on the attributes that are present in the new relative DN.
558 privileges are also required on the attributes that are present
559 in the old relative DN if
565 operation, for each entry, requires
567 privileges on the attributes that are defined in the filter.
568 Then, the resulting entries are tested for
570 privileges on the pseudo-attribute
572 (for read access to the entry itself)
575 access on each value of each attribute that is requested.
578 object used in generating continuation references, the operation requires
580 access on the pseudo-attribute
582 (for read access to the referral object itself),
585 access to the attribute holding the referral information
592 require specific access privileges.
597 privileges on all the attributes that are present in the search filter
598 of the URI regexp maps (the right-hand side of the
605 attribute of the authorizing identity and/or on the
607 attribute of the authorized identity.
609 It is strongly recommended to explicitly use the most appropriate
611 to avoid possible incorrect specifications of the access rules as well
612 as for performance (avoid unrequired regex matching when an exact
613 match suffices) reasons.
615 An adminisistrator might create a rule of the form:
618 access to dn.regex="dc=example,dc=com"
622 expecting it to match all entries in the subtree "dc=example,dc=com".
623 However, this rule actually matches any DN which contains anywhere
624 the substring "dc=example,dc=com". That is, the rule matches both
625 "uid=joe,dc=example,dc=com" and "dc=example,dc=com,uid=joe".
627 To match the desired subtree, the rule would be more precisely
631 access to dn.regex="^(.+,)?dc=example,dc=com$$"
635 For performance reasons, it would be better to use the subtree style.
638 access to dn.subtree="dc=example,dc=com"
642 When writing submatch rules, it may be convenient to avoid unnecessary
645 use; for instance, to allow access to the subtree of the user
648 clause, one could use
651 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$$"
652 by dn.regex="^uid=$1,dc=example,dc=com$$" write
656 However, since all that is required in the
658 clause is substring expansion, a more efficient solution is
661 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$$"
662 by dn.exact,expand="uid=$1,dc=example,dc=com" write
670 implies substring expansion,
672 as well as all the other DN specific
674 values, does not, so it must be explicitly requested.
679 default slapd configuration file
683 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
686 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
688 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob