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.
134 .B attrs=<attr> val[.<style>]=<value>
135 specifies access to a particular value of a single attribute.
136 In this case, only a single attribute type may be given. A value
140 (the default) uses the attribute's equality matching rule to compare the
145 the provided value is used as a regular expression pattern.
146 If the attribute has DN syntax, the value
154 resulting in base, onelevel, subtree or children match, respectively.
156 The dn, filter, and attrs statements are additive; they can be used in sequence
157 to select entities the access rule applies to based on naming context,
158 value and attribute type simultaneously.
162 indicates whom the access rules apply to.
165 statements can appear in an access control statement, indicating the
166 different access privileges to the same resource that apply to different
168 It can have the forms
176 dn[.<dnstyle>[,<modifier>]]=<DN>
178 group[/<objectclass>[/<attrname>]]
180 peername[.<style>]=<peername>
181 sockname[.<style>]=<sockname>
182 domain[.<domainstyle>[,<modifier>]]=<domain>
183 sockurl[.<style>]=<sockurl>
184 set[.<style>]=<pattern>
194 They may be specified in combination.
205 means access is granted to unauthenticated clients; it is mostly used
206 to limit access to authentication resources (e.g. the
208 attribute) to unauthenticated clients for authentication purposes.
212 means access is granted to authenticated clients.
216 means access to an entry is allowed to the entry itself (e.g. the entry
217 being accessed and the requesting entry must be the same).
221 means that access is granted to the matching DN.
222 The optional style qualifier
224 allows the same choices of the dn form of the
226 field. In addition, the
228 style can exploit substring substitution of submatches in the
230 dn.regex clause by using the form
238 At present, the only type allowed is
240 which causes substring substitution of submatches to take place
248 means that access is granted to requests whose DN is listed in the
249 entry being accessed under the
255 means that access is granted to requests whose DN is listed
256 in the group entry whose DN is given by
258 The optional parameters
262 define the objectClass and the member attributeType of the group entry.
263 The optional style qualifier
269 will be expanded as a replacement string (but not as a regular expression)
270 according to regex (7), and
276 which means that exact match will be used.
278 For static groups, the specified attributeType must have
281 .B NameAndOptionalUID
282 syntax. For dynamic groups the attributeType must
285 attributeType. Only LDAP URIs of the form
286 .B ldap:///<base>??<scope>?<filter>
287 will be evaluated in a dynamic group.
290 .BR peername=<peername> ,
291 .BR sockname=<sockname> ,
292 .BR domain=<domain> ,
294 .BR sockurl=<sockurl>
295 mean that the contacting host IP for
297 the named pipe file name for
299 the contacting host name for
301 and the contacting URL for
308 rules for pattern match described for the
313 clause also allows the
315 style, which succeeds when a fully qualified name exactly matches the
317 pattern, or its trailing part, after a
324 of the contacting host is determined by performing a DNS reverse lookup.
325 As this lookup can easily be spoofed, use of the
327 statement is strongly discouraged. By default, reverse lookups are disabled.
334 option; the only value currently supported is
336 which causes substring substitution of submatches to take place even if
341 much like the analogous usage in
351 means that the access control is determined by the values in the
354 ACIs are experimental; they must be enabled at compile time.
358 .BR transport_ssf=<n> ,
362 set the required Security Strength Factor (ssf) required to grant access.
363 .SH THE <ACCESS> FIELD
365 .B <access> ::= [self]{<level>|<priv>}
366 determines the access level or the specific access privileges the
369 Its component are defined as
372 <level> ::= none|auth|compare|search|read|write
373 <priv> ::= {=|+|-}{w|r|s|c|x}+
378 allows special operations like having a certain access level or privilege
379 only in case the operation involves the name of the user that's requesting
381 It implies the user that requests access is bound.
384 access to the member attribute of a group, which allows one to add/delete
385 its own DN from the member list of a group, without affecting other members.
389 access model relies on an incremental interpretation of the access
391 The possible levels are
399 Each access level implies all the preceding ones, thus
401 access will imply all accesses.
406 access means that one is allowed access to an attribute to perform
407 authentication/authorization operations (e.g.
409 with no other access.
410 This is useful to grant unauthenticated clients the least possible
411 access level to critical resources, like passwords.
415 access model relies on the explicit setting of access privileges
419 sign resets previously defined accesses; as a consequence, the final
420 access privileges will be only those defined by the clause.
425 signs add/remove access privileges to the existing ones.
437 More than one privilege can be added in one statement.
441 controls the flow of access rule application.
442 It can have the forms
452 the default, means access checking stops in case of match.
453 The other two forms are used to keep on processing access clauses.
456 form allows for other
460 clause to be considered, so that they may result in incrementally altering
461 the privileges, while the
463 form allows for other
465 clauses that match the same target to be processed.
466 Consider the (silly) example
469 access to dn.subtree="dc=example,dc=com" attrs=cn
472 access to dn.subtree="ou=People,dc=example,dc=com"
476 which allows search and compare privileges to everybody under
477 the "dc=example,dc=com" tree, with the second rule allowing
478 also read in the "ou=People" subtree,
479 or the (even more silly) example
482 access to dn.subtree="dc=example,dc=com" attrs=cn
487 which grants everybody search and compare privileges, and adds read
488 privileges to authenticated clients.
489 .SH OPERATION REQUIREMENTS
490 Operations require different privileges on different portions of entries.
491 The following summary applies to primary database backends such as
492 the LDBM, BDB, and HDB backends. Requirements for other backends may
493 (and often do) differ.
499 privileges on the pseudo-attribute
501 of the entry being added, and
503 privileges on the pseudo-attribute
505 of the entry's parent.
509 operation, when credentials are stored in the directory, requires
511 privileges on the attribute the credentials are stored in (usually
518 privileges on the attribute that is being compared.
524 privileges on the pseudo-attribute
526 of the entry being deleted, and
530 pseudo-attribute of the entry's parent.
536 privileges on the attibutes being modified.
542 privileges on the pseudo-attribute
544 of the entry whose relative DN is being modified,
546 privileges on the pseudo-attribute
548 of the old and new entry's parents, and
550 privileges on the attributes that are present in the new relative DN.
552 privileges are also required on the attributes that are present
553 in the old relative DN if
559 operation, for each entry, requires
561 privileges on the attributes that are defined in the filter.
562 Then, the resulting entries are tested for
564 privileges on the pseudo-attribute
566 (for read access to the entry itself)
569 access on each value of each attribute that is requested.
572 object used in generating continuation references, the operation requires
574 access on the pseudo-attribute
576 (for read access to the referral object itself),
579 access to the attribute holding the referral information
584 It is strongly recommended to explicitly use the most appropriate
586 to avoid possible incorrect specifications of the access rules as well
587 as for performance (avoid unrequired regex matching when an exact
588 match suffices) reasons.
590 An adminisistrator might create a rule of the form:
593 access to dn.regex="dc=example,dc=com"
597 expecting it to match all entries in the subtree "dc=example,dc=com".
598 However, this rule actually matches any DN which contains anywhere
599 the substring "dc=example,dc=com". That is, the rule matches both
600 "uid=joe,dc=example,dc=com" and "dc=example,dc=com,uid=joe".
602 To match the desired subtree, the rule would be more precisely
606 access to dn.regex="^(.+,)?dc=example,dc=com$$"
610 For performance reasons, it would be better to use the subtree style.
613 access to dn.subtree="dc=example,dc=com"
617 When writing submatch rules, it may be convenient to avoid unnecessary
620 use; for instance, to allow access to the subtree of the user
623 clause, one could use
626 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$$"
627 by dn.regex="^uid=$1,dc=example,dc=com$$" write
631 However, since all that is required in the
633 clause is substring expansion, a more efficient solution is
636 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$$"
637 by dn.exact,expand="uid=$1,dc=example,dc=com" write
645 implies substring expansion,
647 as well as all the other DN specific
649 values, does not, so it must be explicitly requested.
654 default slapd configuration file
658 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
661 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
663 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob