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[.<style>]=<pattern>
205 <dnstyle>={{exact|base}|regex|sub(tree)|one(level)|children}
206 <groupstyle>={exact|expand}
207 <style>={exact|regex}
208 <peernamestyle>={exact|regex|ip|path}
209 <domainstyle>={exact|regex|sub(tree)}
213 They may be specified in combination.
224 means access is granted to unauthenticated clients; it is mostly used
225 to limit access to authentication resources (e.g. the
227 attribute) to unauthenticated clients for authentication purposes.
231 means access is granted to authenticated clients.
235 means access to an entry is allowed to the entry itself (e.g. the entry
236 being accessed and the requesting entry must be the same).
240 means that access is granted to the matching DN.
241 The optional style qualifier
243 allows the same choices of the dn form of the
245 field. In addition, the
247 style can exploit substring substitution of submatches in the
249 dn.regex clause by using the form
257 At present, the only type allowed is
259 which causes substring substitution of submatches to take place
264 It is perfectly useless to give any access privileges to a DN
265 that exactly matches the
267 of the database the ACLs apply to, because it implicitly
268 possesses write privileges for the entire tree of that database.
272 means that access is granted to requests whose DN is listed in the
273 entry being accessed under the
279 means that access is granted to requests whose DN is listed
280 in the group entry whose DN is given by
282 The optional parameters
286 define the objectClass and the member attributeType of the group entry.
287 The optional style qualifier
293 will be expanded as a replacement string (but not as a regular expression)
294 according to regex (7), and
296 which means that exact match will be used.
298 For static groups, the specified attributeType must have
301 .B NameAndOptionalUID
302 syntax. For dynamic groups the attributeType must
305 attributeType. Only LDAP URIs of the form
306 .B ldap:///<base>??<scope>?<filter>
307 will be evaluated in a dynamic group, by searching the local server only.
310 .BR peername=<peername> ,
311 .BR sockname=<sockname> ,
312 .BR domain=<domain> ,
314 .BR sockurl=<sockurl>
315 mean that the contacting host IP (in the form
316 .BR "IP=<ip>:<port>" )
317 or the contacting host named pipe file name (in the form
319 if connecting through a named pipe) for
321 the named pipe file name for
323 the contacting host name for
325 and the contacting URL for
332 rules for pattern match described for the
339 clause (the default) implies a case-exact match on the client's
343 prefix and the trailing
349 prefix if connecting through a named pipe.
352 style interprets the pattern as
353 .BR <peername>=<ip>[%<mask>][{<n>}] ,
358 are dotted digit representations of the IP and the mask, while
360 delimited by curly brackets, is an optional port.
361 When checking access privileges, the IP portion of the
363 is extracted, eliminating the
367 part, and it is compared against the
369 portion of the pattern after masking with
372 .B peername.ip=127.0.0.1
373 alows connections only from localhost,
374 .B peername.ip=192.168.1.0%255.255.255.0
375 allows connections from any IP in the 192.168.1 class C domain, and
376 .B peername.ip=192.168.1.16%255.255.255.240{9009}
377 allows connections from any IP in the 192.168.1.[16-31] range
378 of the same domain, only if port 9009 is used.
385 when connecting through a named pipe, and performs an exact match
386 on the given pattern.
389 clause also allows the
391 style, which succeeds when a fully qualified name exactly matches the
393 pattern, or its trailing part, after a
399 .B domain.subtree=example.com
400 will match www.example.com, but will not match www.anotherexample.com.
403 of the contacting host is determined by performing a DNS reverse lookup.
404 As this lookup can easily be spoofed, use of the
406 statement is strongly discouraged. By default, reverse lookups are disabled.
413 option; the only value currently supported is
415 which causes substring substitution of submatches to take place even if
420 much like the analogous usage in
430 means that the access control is determined by the values in the
433 ACIs are experimental; they must be enabled at compile time.
437 .BR transport_ssf=<n> ,
441 set the required Security Strength Factor (ssf) required to grant access.
442 .SH THE <ACCESS> FIELD
444 .B <access> ::= [self]{<level>|<priv>}
445 determines the access level or the specific access privileges the
448 Its component are defined as
451 <level> ::= none|auth|compare|search|read|write
452 <priv> ::= {=|+|-}{w|r|s|c|x|0}+
457 allows special operations like having a certain access level or privilege
458 only in case the operation involves the name of the user that's requesting
460 It implies the user that requests access is bound.
463 access to the member attribute of a group, which allows one to add/delete
464 its own DN from the member list of a group, without affecting other members.
468 access model relies on an incremental interpretation of the access
470 The possible levels are
478 Each access level implies all the preceding ones, thus
480 access will imply all accesses.
485 access means that one is allowed access to an attribute to perform
486 authentication/authorization operations (e.g.
488 with no other access.
489 This is useful to grant unauthenticated clients the least possible
490 access level to critical resources, like passwords.
494 access model relies on the explicit setting of access privileges
498 sign resets previously defined accesses; as a consequence, the final
499 access privileges will be only those defined by the clause.
504 signs add/remove access privileges to the existing ones.
516 More than one of the above privileges can be added in one statement.
518 indicates no privileges and is used only by itself (e.g., +0).
522 controls the flow of access rule application.
523 It can have the forms
533 the default, means access checking stops in case of match.
534 The other two forms are used to keep on processing access clauses.
537 form allows for other
541 clause to be considered, so that they may result in incrementally altering
542 the privileges, while the
544 form allows for other
546 clauses that match the same target to be processed.
547 Consider the (silly) example
550 access to dn.subtree="dc=example,dc=com" attrs=cn
553 access to dn.subtree="ou=People,dc=example,dc=com"
557 which allows search and compare privileges to everybody under
558 the "dc=example,dc=com" tree, with the second rule allowing
559 also read in the "ou=People" subtree,
560 or the (even more silly) example
563 access to dn.subtree="dc=example,dc=com" attrs=cn
568 which grants everybody search and compare privileges, and adds read
569 privileges to authenticated clients.
570 .SH OPERATION REQUIREMENTS
571 Operations require different privileges on different portions of entries.
572 The following summary applies to primary database backends such as
573 the LDBM, BDB, and HDB backends. Requirements for other backends may
574 (and often do) differ.
580 privileges on the pseudo-attribute
582 of the entry being added, and
584 privileges on the pseudo-attribute
586 of the entry's parent.
590 operation, when credentials are stored in the directory, requires
592 privileges on the attribute the credentials are stored in (usually
599 privileges on the attribute that is being compared.
605 privileges on the pseudo-attribute
607 of the entry being deleted, and
611 pseudo-attribute of the entry's parent.
617 privileges on the attibutes being modified.
623 privileges on the pseudo-attribute
625 of the entry whose relative DN is being modified,
627 privileges on the pseudo-attribute
629 of the old and new entry's parents, and
631 privileges on the attributes that are present in the new relative DN.
633 privileges are also required on the attributes that are present
634 in the old relative DN if
640 operation, for each entry, requires
642 privileges on the attributes that are defined in the filter.
643 Then, the resulting entries are tested for
645 privileges on the pseudo-attribute
647 (for read access to the entry itself)
650 access on each value of each attribute that is requested.
653 object used in generating continuation references, the operation requires
655 access on the pseudo-attribute
657 (for read access to the referral object itself),
660 access to the attribute holding the referral information
667 require specific access privileges.
672 privileges on all the attributes that are present in the search filter
673 of the URI regexp maps (the right-hand side of the
680 attribute of the authorizing identity and/or on the
682 attribute of the authorized identity.
684 It is strongly recommended to explicitly use the most appropriate
686 to avoid possible incorrect specifications of the access rules as well
687 as for performance (avoid unrequired regex matching when an exact
688 match suffices) reasons.
690 An administrator might create a rule of the form:
693 access to dn.regex="dc=example,dc=com"
697 expecting it to match all entries in the subtree "dc=example,dc=com".
698 However, this rule actually matches any DN which contains anywhere
699 the substring "dc=example,dc=com". That is, the rule matches both
700 "uid=joe,dc=example,dc=com" and "dc=example,dc=com,uid=joe".
702 To match the desired subtree, the rule would be more precisely
706 access to dn.regex="^(.+,)?dc=example,dc=com$$"
710 For performance reasons, it would be better to use the subtree style.
713 access to dn.subtree="dc=example,dc=com"
717 When writing submatch rules, it may be convenient to avoid unnecessary
720 use; for instance, to allow access to the subtree of the user
723 clause, one could use
726 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$$"
727 by dn.regex="^uid=$1,dc=example,dc=com$$" write
731 However, since all that is required in the
733 clause is substring expansion, a more efficient solution is
736 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$$"
737 by dn.exact,expand="uid=$1,dc=example,dc=com" write
745 implies substring expansion,
747 as well as all the other DN specific
749 values, does not, so it must be explicitly requested.
754 default slapd configuration file
758 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
761 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
763 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob