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
255 Since the dollar character is used to indicate a substring replacement,
256 the dollar character that is used to indicate match up to the end of
257 the string must be escaped by a second dollar character, e.g.
260 access to dn.regex="^(.*,)?uid=([^,]+),dc=example,dc=com$"
261 by dn.regex="^uid=$1,dc=example,dc=com$$" write
267 At present, the only type allowed is
269 which causes substring substitution of submatches to take place
275 It is perfectly useless to give any access privileges to a DN
276 that exactly matches the
278 of the database the ACLs apply to, because it implicitly
279 possesses write privileges for the entire tree of that database.
280 Actually, access control is bypassed for the
282 to solve the intrinsic chicken-and-egg problem.
286 means that access is granted to requests whose DN is listed in the
287 entry being accessed under the
293 means that access is granted to requests whose DN is listed
294 in the group entry whose DN is given by
296 The optional parameters
300 define the objectClass and the member attributeType of the group entry.
301 The optional style qualifier
307 will be expanded as a replacement string (but not as a regular expression)
308 according to regex (7), and
310 which means that exact match will be used.
312 For static groups, the specified attributeType must have
315 .B NameAndOptionalUID
316 syntax. For dynamic groups the attributeType must
319 attributeType. Only LDAP URIs of the form
320 .B ldap:///<base>??<scope>?<filter>
321 will be evaluated in a dynamic group, by searching the local server only.
324 .BR peername=<peername> ,
325 .BR sockname=<sockname> ,
326 .BR domain=<domain> ,
328 .BR sockurl=<sockurl>
329 mean that the contacting host IP (in the form
330 .BR "IP=<ip>:<port>" )
331 or the contacting host named pipe file name (in the form
333 if connecting through a named pipe) for
335 the named pipe file name for
337 the contacting host name for
339 and the contacting URL for
346 rules for pattern match described for the
350 style, which implies submatch
354 match of the corresponding connection parameters.
359 clause (the default) implies a case-exact match on the client's
363 prefix and the trailing
369 prefix if connecting through a named pipe.
372 style interprets the pattern as
373 .BR <peername>=<ip>[%<mask>][{<n>}] ,
378 are dotted digit representations of the IP and the mask, while
380 delimited by curly brackets, is an optional port.
381 When checking access privileges, the IP portion of the
383 is extracted, eliminating the
387 part, and it is compared against the
389 portion of the pattern after masking with
392 .B peername.ip=127.0.0.1
393 alows connections only from localhost,
394 .B peername.ip=192.168.1.0%255.255.255.0
395 allows connections from any IP in the 192.168.1 class C domain, and
396 .B peername.ip=192.168.1.16%255.255.255.240{9009}
397 allows connections from any IP in the 192.168.1.[16-31] range
398 of the same domain, only if port 9009 is used.
405 when connecting through a named pipe, and performs an exact match
406 on the given pattern.
409 clause also allows the
411 style, which succeeds when a fully qualified name exactly matches the
413 pattern, or its trailing part, after a
420 style is allowed, implying an
422 match with submatch expansion; the use of
424 as a style modifier is considered more appropriate.
426 .B domain.subtree=example.com
427 will match www.example.com, but will not match www.anotherexample.com.
430 of the contacting host is determined by performing a DNS reverse lookup.
431 As this lookup can easily be spoofed, use of the
433 statement is strongly discouraged. By default, reverse lookups are disabled.
440 option; the only value currently supported is
442 which causes substring substitution of submatches to take place even if
447 much like the analogous usage in
457 means that the access control is determined by the values in the
460 ACIs are experimental; they must be enabled at compile time.
464 .BR transport_ssf=<n> ,
468 set the required Security Strength Factor (ssf) required to grant access.
469 .SH THE <ACCESS> FIELD
471 .B <access> ::= [self]{<level>|<priv>}
472 determines the access level or the specific access privileges the
475 Its component are defined as
478 <level> ::= none|auth|compare|search|read|write
479 <priv> ::= {=|+|-}{w|r|s|c|x|0}+
484 allows special operations like having a certain access level or privilege
485 only in case the operation involves the name of the user that's requesting
487 It implies the user that requests access is bound.
490 access to the member attribute of a group, which allows one to add/delete
491 its own DN from the member list of a group, without affecting other members.
495 access model relies on an incremental interpretation of the access
497 The possible levels are
505 Each access level implies all the preceding ones, thus
507 access will imply all accesses.
512 access means that one is allowed access to an attribute to perform
513 authentication/authorization operations (e.g.
515 with no other access.
516 This is useful to grant unauthenticated clients the least possible
517 access level to critical resources, like passwords.
521 access model relies on the explicit setting of access privileges
525 sign resets previously defined accesses; as a consequence, the final
526 access privileges will be only those defined by the clause.
531 signs add/remove access privileges to the existing ones.
543 More than one of the above privileges can be added in one statement.
545 indicates no privileges and is used only by itself (e.g., +0).
549 controls the flow of access rule application.
550 It can have the forms
560 the default, means access checking stops in case of match.
561 The other two forms are used to keep on processing access clauses.
564 form allows for other
568 clause to be considered, so that they may result in incrementally altering
569 the privileges, while the
571 form allows for other
573 clauses that match the same target to be processed.
574 Consider the (silly) example
577 access to dn.subtree="dc=example,dc=com" attrs=cn
580 access to dn.subtree="ou=People,dc=example,dc=com"
584 which allows search and compare privileges to everybody under
585 the "dc=example,dc=com" tree, with the second rule allowing
586 also read in the "ou=People" subtree,
587 or the (even more silly) example
590 access to dn.subtree="dc=example,dc=com" attrs=cn
595 which grants everybody search and compare privileges, and adds read
596 privileges to authenticated clients.
597 .SH OPERATION REQUIREMENTS
598 Operations require different privileges on different portions of entries.
599 The following summary applies to primary database backends such as
600 the LDBM, BDB, and HDB backends. Requirements for other backends may
601 (and often do) differ.
607 privileges on the pseudo-attribute
609 of the entry being added, and
611 privileges on the pseudo-attribute
613 of the entry's parent.
617 operation, when credentials are stored in the directory, requires
619 privileges on the attribute the credentials are stored in (usually
626 privileges on the attribute that is being compared.
632 privileges on the pseudo-attribute
634 of the entry being deleted, and
638 pseudo-attribute of the entry's parent.
644 privileges on the attibutes being modified.
650 privileges on the pseudo-attribute
652 of the entry whose relative DN is being modified,
654 privileges on the pseudo-attribute
656 of the old and new entry's parents, and
658 privileges on the attributes that are present in the new relative DN.
660 privileges are also required on the attributes that are present
661 in the old relative DN if
667 operation, for each entry, requires
669 privileges on the attributes that are defined in the filter.
670 Then, the resulting entries are tested for
672 privileges on the pseudo-attribute
674 (for read access to the entry itself)
677 access on each value of each attribute that is requested.
680 object used in generating continuation references, the operation requires
682 access on the pseudo-attribute
684 (for read access to the referral object itself),
687 access to the attribute holding the referral information
692 Some internal operations and some
694 require specific access privileges.
701 privileges on all the attributes that are present in the search filter
702 of the URI regexp maps (the right-hand side of the
706 privileges are also required on the
708 attribute of the authorizing identity and/or on the
710 attribute of the authorized identity.
712 It is strongly recommended to explicitly use the most appropriate
718 clauses, to avoid possible incorrect specifications of the access rules
719 as well as for performance (avoid unrequired regex matching when an exact
720 match suffices) reasons.
722 An administrator might create a rule of the form:
725 access to dn.regex="dc=example,dc=com"
729 expecting it to match all entries in the subtree "dc=example,dc=com".
730 However, this rule actually matches any DN which contains anywhere
731 the substring "dc=example,dc=com". That is, the rule matches both
732 "uid=joe,dc=example,dc=com" and "dc=example,dc=com,uid=joe".
734 To match the desired subtree, the rule would be more precisely
738 access to dn.regex="^(.+,)?dc=example,dc=com$"
742 For performance reasons, it would be better to use the subtree style.
745 access to dn.subtree="dc=example,dc=com"
749 When writing submatch rules, it may be convenient to avoid unnecessary
752 use; for instance, to allow access to the subtree of the user
755 clause, one could use
758 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$"
759 by dn.regex="^uid=$1,dc=example,dc=com$$" write
763 However, since all that is required in the
765 clause is substring expansion, a more efficient solution is
768 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$"
769 by dn.exact,expand="uid=$1,dc=example,dc=com" write
777 implies substring expansion,
779 as well as all the other DN specific
781 values, does not, so it must be explicitly requested.
786 default slapd configuration file
790 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
793 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
795 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob