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, while names that
132 do not correspond to an attribute type are also searched
133 in the objectclass set.
134 This latter behavior is deprecated and might not be supported
138 is also treated as an objectClass, but in this case the access rule
139 affects the attributes that are not required nor allowed
143 .B attrs=<attr> val[.<style>]=<value>
144 specifies access to a particular value of a single attribute.
145 In this case, only a single attribute type may be given. A value
149 (the default) uses the attribute's equality matching rule to compare the
154 the provided value is used as a regular expression pattern.
155 If the attribute has DN syntax, the value
163 resulting in base, onelevel, subtree or children match, respectively.
165 The dn, filter, and attrs statements are additive; they can be used in sequence
166 to select entities the access rule applies to based on naming context,
167 value and attribute type simultaneously.
171 indicates whom the access rules apply to.
174 statements can appear in an access control statement, indicating the
175 different access privileges to the same resource that apply to different
177 It can have the forms
185 dn[.<dnstyle>[,<modifier>]]=<DN>
187 group[/<objectclass>[/<attrname>]]
189 peername[.<style>]=<peername>
190 sockname[.<style>]=<sockname>
191 domain[.<domainstyle>[,<modifier>]]=<domain>
192 sockurl[.<style>]=<sockurl>
193 set[.<style>]=<pattern>
203 They may be specified in combination.
214 means access is granted to unauthenticated clients; it is mostly used
215 to limit access to authentication resources (e.g. the
217 attribute) to unauthenticated clients for authentication purposes.
221 means access is granted to authenticated clients.
225 means access to an entry is allowed to the entry itself (e.g. the entry
226 being accessed and the requesting entry must be the same).
230 means that access is granted to the matching DN.
231 The optional style qualifier
233 allows the same choices of the dn form of the
235 field. In addition, the
237 style can exploit substring substitution of submatches in the
239 dn.regex clause by using the form
247 At present, the only type allowed is
249 which causes substring substitution of submatches to take place
257 means that access is granted to requests whose DN is listed in the
258 entry being accessed under the
264 means that access is granted to requests whose DN is listed
265 in the group entry whose DN is given by
267 The optional parameters
271 define the objectClass and the member attributeType of the group entry.
272 The optional style qualifier
278 will be expanded as a replacement string (but not as a regular expression)
279 according to regex (7), and
285 which means that exact match will be used.
287 For static groups, the specified attributeType must have
290 .B NameAndOptionalUID
291 syntax. For dynamic groups the attributeType must
294 attributeType. Only LDAP URIs of the form
295 .B ldap:///<base>??<scope>?<filter>
296 will be evaluated in a dynamic group.
299 .BR peername=<peername> ,
300 .BR sockname=<sockname> ,
301 .BR domain=<domain> ,
303 .BR sockurl=<sockurl>
304 mean that the contacting host IP for
306 the named pipe file name for
308 the contacting host name for
310 and the contacting URL for
317 rules for pattern match described for the
322 clause also allows the
324 style, which succeeds when a fully qualified name exactly matches the
326 pattern, or its trailing part, after a
333 of the contacting host is determined by performing a DNS reverse lookup.
334 As this lookup can easily be spoofed, use of the
336 statement is strongly discouraged. By default, reverse lookups are disabled.
343 option; the only value currently supported is
345 which causes substring substitution of submatches to take place even if
350 much like the analogous usage in
360 means that the access control is determined by the values in the
363 ACIs are experimental; they must be enabled at compile time.
367 .BR transport_ssf=<n> ,
371 set the required Security Strength Factor (ssf) required to grant access.
372 .SH THE <ACCESS> FIELD
374 .B <access> ::= [self]{<level>|<priv>}
375 determines the access level or the specific access privileges the
378 Its component are defined as
381 <level> ::= none|auth|compare|search|read|write
382 <priv> ::= {=|+|-}{w|r|s|c|x}+
387 allows special operations like having a certain access level or privilege
388 only in case the operation involves the name of the user that's requesting
390 It implies the user that requests access is bound.
393 access to the member attribute of a group, which allows one to add/delete
394 its own DN from the member list of a group, without affecting other members.
398 access model relies on an incremental interpretation of the access
400 The possible levels are
408 Each access level implies all the preceding ones, thus
410 access will imply all accesses.
415 access means that one is allowed access to an attribute to perform
416 authentication/authorization operations (e.g.
418 with no other access.
419 This is useful to grant unauthenticated clients the least possible
420 access level to critical resources, like passwords.
424 access model relies on the explicit setting of access privileges
428 sign resets previously defined accesses; as a consequence, the final
429 access privileges will be only those defined by the clause.
434 signs add/remove access privileges to the existing ones.
446 More than one privilege can be added in one statement.
450 controls the flow of access rule application.
451 It can have the forms
461 the default, means access checking stops in case of match.
462 The other two forms are used to keep on processing access clauses.
465 form allows for other
469 clause to be considered, so that they may result in incrementally altering
470 the privileges, while the
472 form allows for other
474 clauses that match the same target to be processed.
475 Consider the (silly) example
478 access to dn.subtree="dc=example,dc=com" attrs=cn
481 access to dn.subtree="ou=People,dc=example,dc=com"
485 which allows search and compare privileges to everybody under
486 the "dc=example,dc=com" tree, with the second rule allowing
487 also read in the "ou=People" subtree,
488 or the (even more silly) example
491 access to dn.subtree="dc=example,dc=com" attrs=cn
496 which grants everybody search and compare privileges, and adds read
497 privileges to authenticated clients.
498 .SH OPERATION REQUIREMENTS
499 Operations require different privileges on different portions of entries.
500 The following summary applies to primary database backends such as
501 the LDBM, BDB, and HDB backends. Requirements for other backends may
502 (and often do) differ.
508 privileges on the pseudo-attribute
510 of the entry being added, and
512 privileges on the pseudo-attribute
514 of the entry's parent.
518 operation, when credentials are stored in the directory, requires
520 privileges on the attribute the credentials are stored in (usually
527 privileges on the attribute that is being compared.
533 privileges on the pseudo-attribute
535 of the entry being deleted, and
539 pseudo-attribute of the entry's parent.
545 privileges on the attibutes being modified.
551 privileges on the pseudo-attribute
553 of the entry whose relative DN is being modified,
555 privileges on the pseudo-attribute
557 of the old and new entry's parents, and
559 privileges on the attributes that are present in the new relative DN.
561 privileges are also required on the attributes that are present
562 in the old relative DN if
568 operation, for each entry, requires
570 privileges on the attributes that are defined in the filter.
571 Then, the resulting entries are tested for
573 privileges on the pseudo-attribute
575 (for read access to the entry itself)
578 access on each value of each attribute that is requested.
581 object used in generating continuation references, the operation requires
583 access on the pseudo-attribute
585 (for read access to the referral object itself),
588 access to the attribute holding the referral information
593 It is strongly recommended to explicitly use the most appropriate
596 to avoid possible incorrect specifications of the access rules as well
597 as for performance (avoid unrequired regex matching when an exact
598 match suffices) reasons.
600 An adminisistrator might create a rule of the form:
603 access to dn.regex="dc=example,dc=com"
607 expecting it to match all entries in the subtree "dc=example,dc=com".
608 However, this rule actually matches any DN which contains anywhere
609 the substring "dc=example,dc=com". That is, the rule matches both
610 "uid=joe,dc=example,dc=com" and "dc=example,dc=com,uid=joe".
612 To match the desired subtree, the rule would be more precisely
616 access to dn.regex="^(.+,)?dc=example,dc=com$$"
620 For performance reasons, it would be better to use the subtree style.
623 access to dn.subtree="dc=example,dc=com"
630 default slapd configuration file
634 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
637 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
639 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob