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
27 file consists of a series of global configuration options that apply to
29 as a whole (including all backends), followed by zero or more database
30 backend definitions that contain information specific to a backend
38 # comment - these options apply to every database
39 <global configuration options>
40 # first database definition & configuration options
41 database <backend 1 type>
42 <configuration options specific to backend 1>
43 # subsequent database definitions & configuration options
47 Both the global configuration and each backend-specific section can
48 contain access information. Backend-specific access control
49 directives are used for those entries that belong to the backend,
50 according to their naming context. In case no access control
51 directives are defined for a backend or those which are defined are
52 not applicable, the directives from the global configuration section
55 For entries not held in any backend (such as a root DSE), the
56 directives of the first backend (and any global directives) are
59 Arguments that should be replaced by actual text are shown in
61 .SH THE ACCESS DIRECTIVE
62 The structure of the access control directives is
64 .B access to <what> "[ by <who> <access> [ <control> ] ]+"
65 Grant access (specified by
67 to a set of entries and/or attributes (specified by
69 by one or more requestors (specified by
74 specifies the entity the access control directive applies to.
81 [attrs=<attrlist>[ val[.<style>]=<attrval>]]
86 stands for all the entries.
90 selects the entries based on their naming context.
91 The pattern is a string representation of the entry's DN.
98 indicates the entry whose DN is equal to the pattern;
102 indicates all the entries immediately below the
107 indicates all entries in the subtree at the pattern,
109 indicates all the entries below (subordinate to) the pattern.
115 then the value is a regular expression pattern,
118 matching a normalized string representation of the entry's DN.
119 The regex form of the pattern does not (yet) support UTF-8.
122 .B filter=<ldapfilter>
123 selects the entries based on a valid LDAP filter as described in RFC 2254.
127 selects the attributes the access control rule applies to.
128 It is a comma-separated list of attribute types, plus the special names
130 indicating access to the entry itself, and
132 indicating access to the entry's children. ObjectClass names may also
133 be specified in this list, which will affect all the attributes that
134 are required and/or allowed by that objectClass.
139 are directly treated as objectClass names. A name prefixed by
141 is also treated as an objectClass, but in this case the access rule
142 affects the attributes that are not required nor allowed
146 .B attrs=<attr> val[.<style>]=<value>
147 specifies access to a particular value of a single attribute.
148 In this case, only a single attribute type may be given. A value
152 (the default) uses the attribute's equality matching rule to compare the
157 the provided value is used as a regular expression pattern.
158 If the attribute has DN syntax, the value
166 resulting in base, onelevel, subtree or children match, respectively.
168 The dn, filter, and attrs statements are additive; they can be used in sequence
169 to select entities the access rule applies to based on naming context,
170 value and attribute type simultaneously.
174 indicates whom the access rules apply to.
177 statements can appear in an access control statement, indicating the
178 different access privileges to the same resource that apply to different
180 It can have the forms
188 dn[.<dnstyle>[,<modifier>]]=<DN>
190 group[/<objectclass>[/<attrname>]]
191 [.<groupstyle>]=<group>
192 peername[.<peernamestyle>]=<peername>
193 sockname[.<style>]=<sockname>
194 domain[.<domainstyle>[,<modifier>]]=<domain>
195 sockurl[.<style>]=<sockurl>
196 set[.<setstyle>]=<pattern>
209 <dnstyle>={{exact|base}|regex|sub(tree)|one(level)|children}
210 <groupstyle>={exact|expand}
211 <style>={exact|regex|expand}
212 <peernamestyle>={<style>|ip|path}
213 <domainstyle>={exact|regex|sub(tree)}
214 <setstyle>={exact|regex}
218 They may be specified in combination.
229 means access is granted to unauthenticated clients; it is mostly used
230 to limit access to authentication resources (e.g. the
232 attribute) to unauthenticated clients for authentication purposes.
236 means access is granted to authenticated clients.
240 means access to an entry is allowed to the entry itself (e.g. the entry
241 being accessed and the requesting entry must be the same).
245 means that access is granted to the matching DN.
246 The optional style qualifier
248 allows the same choices of the dn form of the
250 field. In addition, the
252 style can exploit substring substitution of submatches in the
254 dn.regex clause by using the form
259 Since the dollar character is used to indicate a substring replacement,
260 the dollar character that is used to indicate match up to the end of
261 the string must be escaped by a second dollar character, e.g.
264 access to dn.regex="^(.*,)?uid=([^,]+),dc=example,dc=com$"
265 by dn.regex="^uid=$1,dc=example,dc=com$$" write
271 At present, the only type allowed is
273 which causes substring substitution of submatches to take place
279 It is perfectly useless to give any access privileges to a DN
280 that exactly matches the
282 of the database the ACLs apply to, because it implicitly
283 possesses write privileges for the entire tree of that database.
284 Actually, access control is bypassed for the
286 to solve the intrinsic chicken-and-egg problem.
290 means that access is granted to requests whose DN is listed in the
291 entry being accessed under the
297 means that access is granted to requests whose DN is listed
298 in the group entry whose DN is given by
300 The optional parameters
304 define the objectClass and the member attributeType of the group entry.
305 The optional style qualifier
311 will be expanded as a replacement string (but not as a regular expression)
312 according to regex (7), and
314 which means that exact match will be used.
316 For static groups, the specified attributeType must have
319 .B NameAndOptionalUID
320 syntax. For dynamic groups the attributeType must
323 attributeType. Only LDAP URIs of the form
324 .B ldap:///<base>??<scope>?<filter>
325 will be evaluated in a dynamic group, by searching the local server only.
328 .BR peername=<peername> ,
329 .BR sockname=<sockname> ,
330 .BR domain=<domain> ,
332 .BR sockurl=<sockurl>
333 mean that the contacting host IP (in the form
334 .BR "IP=<ip>:<port>" )
335 or the contacting host named pipe file name (in the form
337 if connecting through a named pipe) for
339 the named pipe file name for
341 the contacting host name for
343 and the contacting URL for
350 rules for pattern match described for the
354 style, which implies submatch
358 match of the corresponding connection parameters.
363 clause (the default) implies a case-exact match on the client's
367 prefix and the trailing
373 prefix if connecting through a named pipe.
376 style interprets the pattern as
377 .BR <peername>=<ip>[%<mask>][{<n>}] ,
382 are dotted digit representations of the IP and the mask, while
384 delimited by curly brackets, is an optional port.
385 When checking access privileges, the IP portion of the
387 is extracted, eliminating the
391 part, and it is compared against the
393 portion of the pattern after masking with
396 .B peername.ip=127.0.0.1
397 alows connections only from localhost,
398 .B peername.ip=192.168.1.0%255.255.255.0
399 allows connections from any IP in the 192.168.1 class C domain, and
400 .B peername.ip=192.168.1.16%255.255.255.240{9009}
401 allows connections from any IP in the 192.168.1.[16-31] range
402 of the same domain, only if port 9009 is used.
409 when connecting through a named pipe, and performs an exact match
410 on the given pattern.
413 clause also allows the
415 style, which succeeds when a fully qualified name exactly matches the
417 pattern, or its trailing part, after a
424 style is allowed, implying an
426 match with submatch expansion; the use of
428 as a style modifier is considered more appropriate.
430 .B domain.subtree=example.com
431 will match www.example.com, but will not match www.anotherexample.com.
434 of the contacting host is determined by performing a DNS reverse lookup.
435 As this lookup can easily be spoofed, use of the
437 statement is strongly discouraged. By default, reverse lookups are disabled.
444 option; the only value currently supported is
446 which causes substring substitution of submatches to take place even if
451 much like the analogous usage in
461 means that the access control is determined by the values in the
464 ACIs are experimental; they must be enabled at compile time.
468 .BR transport_ssf=<n> ,
472 set the required Security Strength Factor (ssf) required to grant access.
473 .SH THE <ACCESS> FIELD
475 .B <access> ::= [self]{<level>|<priv>}
476 determines the access level or the specific access privileges the
479 Its component are defined as
482 <level> ::= none|auth|compare|search|read|write
483 <priv> ::= {=|+|-}{w|r|s|c|x|0}+
488 allows special operations like having a certain access level or privilege
489 only in case the operation involves the name of the user that's requesting
491 It implies the user that requests access is bound.
494 access to the member attribute of a group, which allows one to add/delete
495 its own DN from the member list of a group, without affecting other members.
499 access model relies on an incremental interpretation of the access
501 The possible levels are
509 Each access level implies all the preceding ones, thus
511 access will imply all accesses.
516 access means that one is allowed access to an attribute to perform
517 authentication/authorization operations (e.g.
519 with no other access.
520 This is useful to grant unauthenticated clients the least possible
521 access level to critical resources, like passwords.
525 access model relies on the explicit setting of access privileges
529 sign resets previously defined accesses; as a consequence, the final
530 access privileges will be only those defined by the clause.
535 signs add/remove access privileges to the existing ones.
547 More than one of the above privileges can be added in one statement.
549 indicates no privileges and is used only by itself (e.g., +0).
553 controls the flow of access rule application.
554 It can have the forms
564 the default, means access checking stops in case of match.
565 The other two forms are used to keep on processing access clauses.
568 form allows for other
572 clause to be considered, so that they may result in incrementally altering
573 the privileges, while the
575 form allows for other
577 clauses that match the same target to be processed.
578 Consider the (silly) example
581 access to dn.subtree="dc=example,dc=com" attrs=cn
584 access to dn.subtree="ou=People,dc=example,dc=com"
588 which allows search and compare privileges to everybody under
589 the "dc=example,dc=com" tree, with the second rule allowing
590 also read in the "ou=People" subtree,
591 or the (even more silly) example
594 access to dn.subtree="dc=example,dc=com" attrs=cn
599 which grants everybody search and compare privileges, and adds read
600 privileges to authenticated clients.
601 .SH OPERATION REQUIREMENTS
602 Operations require different privileges on different portions of entries.
603 The following summary applies to primary database backends such as
604 the LDBM, BDB, and HDB backends. Requirements for other backends may
605 (and often do) differ.
611 privileges on the pseudo-attribute
613 of the entry being added, and
615 privileges on the pseudo-attribute
617 of the entry's parent.
621 operation, when credentials are stored in the directory, requires
623 privileges on the attribute the credentials are stored in (usually
630 privileges on the attribute that is being compared.
636 privileges on the pseudo-attribute
638 of the entry being deleted, and
642 pseudo-attribute of the entry's parent.
648 privileges on the attibutes being modified.
654 privileges on the pseudo-attribute
656 of the entry whose relative DN is being modified,
658 privileges on the pseudo-attribute
660 of the old and new entry's parents, and
662 privileges on the attributes that are present in the new relative DN.
664 privileges are also required on the attributes that are present
665 in the old relative DN if
671 operation, for each entry, requires
673 privileges on the attributes that are defined in the filter.
674 Then, the resulting entries are tested for
676 privileges on the pseudo-attribute
678 (for read access to the entry itself)
681 access on each value of each attribute that is requested.
684 object used in generating continuation references, the operation requires
686 access on the pseudo-attribute
688 (for read access to the referral object itself),
691 access to the attribute holding the referral information
696 Some internal operations and some
698 require specific access privileges.
705 privileges on all the attributes that are present in the search filter
706 of the URI regexp maps (the right-hand side of the
710 privileges are also required on the
712 attribute of the authorizing identity and/or on the
714 attribute of the authorized identity.
716 It is strongly recommended to explicitly use the most appropriate
722 clauses, to avoid possible incorrect specifications of the access rules
723 as well as for performance (avoid unrequired regex matching when an exact
724 match suffices) reasons.
726 An administrator might create a rule of the form:
729 access to dn.regex="dc=example,dc=com"
733 expecting it to match all entries in the subtree "dc=example,dc=com".
734 However, this rule actually matches any DN which contains anywhere
735 the substring "dc=example,dc=com". That is, the rule matches both
736 "uid=joe,dc=example,dc=com" and "dc=example,dc=com,uid=joe".
738 To match the desired subtree, the rule would be more precisely
742 access to dn.regex="^(.+,)?dc=example,dc=com$"
746 For performance reasons, it would be better to use the subtree style.
749 access to dn.subtree="dc=example,dc=com"
753 When writing submatch rules, it may be convenient to avoid unnecessary
756 use; for instance, to allow access to the subtree of the user
759 clause, one could use
762 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$"
763 by dn.regex="^uid=$1,dc=example,dc=com$$" write
767 However, since all that is required in the
769 clause is substring expansion, a more efficient solution is
772 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$"
773 by dn.exact,expand="uid=$1,dc=example,dc=com" write
781 implies substring expansion,
783 as well as all the other DN specific
785 values, does not, so it must be explicitly requested.
790 default slapd configuration file
795 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
798 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
800 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob