1 .TH SLAPD.ACCESS 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2004 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>]]
187 [.<groupstyle>]=<group>
188 peername[.<peernamestyle>]=<peername>
189 sockname[.<style>]=<sockname>
190 domain[.<domainstyle>[,<modifier>]]=<domain>
191 sockurl[.<style>]=<sockurl>
192 set[.<setstyle>]=<pattern>
205 <dnstyle>={{exact|base}|regex|sub(tree)|one(level)|children}
206 <groupstyle>={exact|expand}
207 <style>={exact|regex|expand}
208 <peernamestyle>={<style>|ip|path}
209 <domainstyle>={exact|regex|sub(tree)}
210 <setstyle>={exact|regex}
214 They may be specified in combination.
225 means access is granted to unauthenticated clients; it is mostly used
226 to limit access to authentication resources (e.g. the
228 attribute) to unauthenticated clients for authentication purposes.
232 means access is granted to authenticated clients.
236 means access to an entry is allowed to the entry itself (e.g. the entry
237 being accessed and the requesting entry must be the same).
241 means that access is granted to the matching DN.
242 The optional style qualifier
244 allows the same choices of the dn form of the
246 field. In addition, the
248 style can exploit substring substitution of submatches in the
250 dn.regex clause by using the form
258 At present, the only type allowed is
260 which causes substring substitution of submatches to take place
265 It is perfectly useless to give any access privileges to a DN
266 that exactly matches the
268 of the database the ACLs apply to, because it implicitly
269 possesses write privileges for the entire tree of that database.
273 means that access is granted to requests whose DN is listed in the
274 entry being accessed under the
280 means that access is granted to requests whose DN is listed
281 in the group entry whose DN is given by
283 The optional parameters
287 define the objectClass and the member attributeType of the group entry.
288 The optional style qualifier
294 will be expanded as a replacement string (but not as a regular expression)
295 according to regex (7), and
297 which means that exact match will be used.
299 For static groups, the specified attributeType must have
302 .B NameAndOptionalUID
303 syntax. For dynamic groups the attributeType must
306 attributeType. Only LDAP URIs of the form
307 .B ldap:///<base>??<scope>?<filter>
308 will be evaluated in a dynamic group, by searching the local server only.
311 .BR peername=<peername> ,
312 .BR sockname=<sockname> ,
313 .BR domain=<domain> ,
315 .BR sockurl=<sockurl>
316 mean that the contacting host IP (in the form
317 .BR "IP=<ip>:<port>" )
318 or the contacting host named pipe file name (in the form
320 if connecting through a named pipe) for
322 the named pipe file name for
324 the contacting host name for
326 and the contacting URL for
333 rules for pattern match described for the
337 style, which implies submatch
341 match of the corresponding connection parameters.
346 clause (the default) implies a case-exact match on the client's
350 prefix and the trailing
356 prefix if connecting through a named pipe.
359 style interprets the pattern as
360 .BR <peername>=<ip>[%<mask>][{<n>}] ,
365 are dotted digit representations of the IP and the mask, while
367 delimited by curly brackets, is an optional port.
368 When checking access privileges, the IP portion of the
370 is extracted, eliminating the
374 part, and it is compared against the
376 portion of the pattern after masking with
379 .B peername.ip=127.0.0.1
380 alows connections only from localhost,
381 .B peername.ip=192.168.1.0%255.255.255.0
382 allows connections from any IP in the 192.168.1 class C domain, and
383 .B peername.ip=192.168.1.16%255.255.255.240{9009}
384 allows connections from any IP in the 192.168.1.[16-31] range
385 of the same domain, only if port 9009 is used.
392 when connecting through a named pipe, and performs an exact match
393 on the given pattern.
396 clause also allows the
398 style, which succeeds when a fully qualified name exactly matches the
400 pattern, or its trailing part, after a
407 style is allowed, implying an
409 match with submatch expansion; the use of
411 as a style modifier is considered more appropriate.
413 .B domain.subtree=example.com
414 will match www.example.com, but will not match www.anotherexample.com.
417 of the contacting host is determined by performing a DNS reverse lookup.
418 As this lookup can easily be spoofed, use of the
420 statement is strongly discouraged. By default, reverse lookups are disabled.
427 option; the only value currently supported is
429 which causes substring substitution of submatches to take place even if
434 much like the analogous usage in
444 means that the access control is determined by the values in the
447 ACIs are experimental; they must be enabled at compile time.
451 .BR transport_ssf=<n> ,
455 set the required Security Strength Factor (ssf) required to grant access.
456 .SH THE <ACCESS> FIELD
458 .B <access> ::= [self]{<level>|<priv>}
459 determines the access level or the specific access privileges the
462 Its component are defined as
465 <level> ::= none|auth|compare|search|read|write
466 <priv> ::= {=|+|-}{w|r|s|c|x|0}+
471 allows special operations like having a certain access level or privilege
472 only in case the operation involves the name of the user that's requesting
474 It implies the user that requests access is bound.
477 access to the member attribute of a group, which allows one to add/delete
478 its own DN from the member list of a group, without affecting other members.
482 access model relies on an incremental interpretation of the access
484 The possible levels are
492 Each access level implies all the preceding ones, thus
494 access will imply all accesses.
499 access means that one is allowed access to an attribute to perform
500 authentication/authorization operations (e.g.
502 with no other access.
503 This is useful to grant unauthenticated clients the least possible
504 access level to critical resources, like passwords.
508 access model relies on the explicit setting of access privileges
512 sign resets previously defined accesses; as a consequence, the final
513 access privileges will be only those defined by the clause.
518 signs add/remove access privileges to the existing ones.
530 More than one of the above privileges can be added in one statement.
532 indicates no privileges and is used only by itself (e.g., +0).
536 controls the flow of access rule application.
537 It can have the forms
547 the default, means access checking stops in case of match.
548 The other two forms are used to keep on processing access clauses.
551 form allows for other
555 clause to be considered, so that they may result in incrementally altering
556 the privileges, while the
558 form allows for other
560 clauses that match the same target to be processed.
561 Consider the (silly) example
564 access to dn.subtree="dc=example,dc=com" attrs=cn
567 access to dn.subtree="ou=People,dc=example,dc=com"
571 which allows search and compare privileges to everybody under
572 the "dc=example,dc=com" tree, with the second rule allowing
573 also read in the "ou=People" subtree,
574 or the (even more silly) example
577 access to dn.subtree="dc=example,dc=com" attrs=cn
582 which grants everybody search and compare privileges, and adds read
583 privileges to authenticated clients.
584 .SH OPERATION REQUIREMENTS
585 Operations require different privileges on different portions of entries.
586 The following summary applies to primary database backends such as
587 the LDBM, BDB, and HDB backends. Requirements for other backends may
588 (and often do) differ.
594 privileges on the pseudo-attribute
596 of the entry being added, and
598 privileges on the pseudo-attribute
600 of the entry's parent.
604 operation, when credentials are stored in the directory, requires
606 privileges on the attribute the credentials are stored in (usually
613 privileges on the attribute that is being compared.
619 privileges on the pseudo-attribute
621 of the entry being deleted, and
625 pseudo-attribute of the entry's parent.
631 privileges on the attibutes being modified.
637 privileges on the pseudo-attribute
639 of the entry whose relative DN is being modified,
641 privileges on the pseudo-attribute
643 of the old and new entry's parents, and
645 privileges on the attributes that are present in the new relative DN.
647 privileges are also required on the attributes that are present
648 in the old relative DN if
654 operation, for each entry, requires
656 privileges on the attributes that are defined in the filter.
657 Then, the resulting entries are tested for
659 privileges on the pseudo-attribute
661 (for read access to the entry itself)
664 access on each value of each attribute that is requested.
667 object used in generating continuation references, the operation requires
669 access on the pseudo-attribute
671 (for read access to the referral object itself),
674 access to the attribute holding the referral information
681 require specific access privileges.
686 privileges on all the attributes that are present in the search filter
687 of the URI regexp maps (the right-hand side of the
694 attribute of the authorizing identity and/or on the
696 attribute of the authorized identity.
698 It is strongly recommended to explicitly use the most appropriate
700 to avoid possible incorrect specifications of the access rules as well
701 as for performance (avoid unrequired regex matching when an exact
702 match suffices) reasons.
704 An administrator might create a rule of the form:
707 access to dn.regex="dc=example,dc=com"
711 expecting it to match all entries in the subtree "dc=example,dc=com".
712 However, this rule actually matches any DN which contains anywhere
713 the substring "dc=example,dc=com". That is, the rule matches both
714 "uid=joe,dc=example,dc=com" and "dc=example,dc=com,uid=joe".
716 To match the desired subtree, the rule would be more precisely
720 access to dn.regex="^(.+,)?dc=example,dc=com$$"
724 For performance reasons, it would be better to use the subtree style.
727 access to dn.subtree="dc=example,dc=com"
731 When writing submatch rules, it may be convenient to avoid unnecessary
734 use; for instance, to allow access to the subtree of the user
737 clause, one could use
740 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$$"
741 by dn.regex="^uid=$1,dc=example,dc=com$$" write
745 However, since all that is required in the
747 clause is substring expansion, a more efficient solution is
750 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$$"
751 by dn.exact,expand="uid=$1,dc=example,dc=com" write
759 implies substring expansion,
761 as well as all the other DN specific
763 values, does not, so it must be explicitly requested.
768 default slapd configuration file
772 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
775 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
777 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob