1 .TH SLAPD.ACCESS 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2005 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 If no access controls are present, the default policy
56 allows anyone and everyone to read anything but restricts
57 updates to rootdn. (e.g., "access to * by * read").
58 The rootdn can always read and write EVERYTHING!
60 For entries not held in any backend (such as a root DSE), the
61 directives of the first backend (and any global directives) are
64 Arguments that should be replaced by actual text are shown in
66 .SH THE ACCESS DIRECTIVE
67 The structure of the access control directives is
69 .B access to <what> "[ by <who> <access> [ <control> ] ]+"
70 Grant access (specified by
72 to a set of entries and/or attributes (specified by
74 by one or more requestors (specified by
79 specifies the entity the access control directive applies to.
83 [dn[.<dnstyle>]=]<dnpattern>
85 attrs=<attrlist>[ val[.<attrstyle>]=<attrval>]
91 <dnstyle>={{exact|base(object)}|regex
92 |one(level)|sub(tree)|children}
93 <attrlist>={<attr>|[{!|@}]<objectClass>}[,<attrlist>]
94 <attrstyle>={{exact|base(object)}|regex
95 |one(level)|sub(tree)|children}
100 selects the entries based on their naming context.
106 is a string representation of the entry's DN.
109 stands for all the entries, and it is implied if no
115 is also optional; however, it is recommended to specify both the
119 to avoid ambiguities.
128 indicates the entry whose DN is equal to the
133 indicates all the entries immediately below the
138 indicates all entries in the subtree at the
141 indicates all the entries below (subordinate to) the
150 is a POSIX (''extended'') regular expression pattern,
155 matching a normalized string representation of the entry's DN.
156 The regex form of the pattern does not (yet) support UTF\-8.
159 .B filter=<ldapfilter>
160 selects the entries based on a valid LDAP filter as described in RFC 2254.
169 selects the attributes the access control rule applies to.
170 It is a comma-separated list of attribute types, plus the special names
172 indicating access to the entry itself, and
174 indicating access to the entry's children. ObjectClass names may also
175 be specified in this list, which will affect all the attributes that
176 are required and/or allowed by that objectClass.
181 are directly treated as objectClass names. A name prefixed by
183 is also treated as an objectClass, but in this case the access rule
184 affects the attributes that are not required nor allowed
189 .B attrs=@extensibleObject
190 is implied, i.e. all attributes are addressed.
193 .B attrs=<attr> val[.<attrstyle>]=<attrval>
194 specifies access to a particular value of a single attribute.
195 In this case, only a single attribute type may be given. The
198 (the default) uses the attribute's equality matching rule to compare the
203 the provided value is used as a POSIX (''extended'') regular
204 expression pattern. If the attribute has DN syntax, the
212 resulting in base, onelevel, subtree or children match, respectively.
214 The dn, filter, and attrs statements are additive; they can be used in sequence
215 to select entities the access rule applies to based on naming context,
216 value and attribute type simultaneously.
220 indicates whom the access rules apply to.
223 statements can appear in an access control statement, indicating the
224 different access privileges to the same resource that apply to different
226 It can have the forms
234 dn[.<dnstyle>[,<modifier>]]=<DN>
236 group[/<objectclass>[/<attrname>]]
237 [.<groupstyle>]=<group>
238 peername[.<peernamestyle>]=<peername>
239 sockname[.<style>]=<sockname>
240 domain[.<domainstyle>[,<modifier>]]=<domain>
241 sockurl[.<style>]=<sockurl>
242 set[.<setstyle>]=<pattern>
255 <style>={exact|regex|expand}
256 <selfstyle>={level{<n>}}
257 <dnstyle>={{exact|base(object)}|regex
258 |one(level)|sub(tree)|children|level{<n>}}
259 <groupstyle>={exact|expand}
260 <peernamestyle>={<style>|ip|path}
261 <domainstyle>={exact|regex|sub(tree)}
262 <setstyle>={exact|regex}
266 They may be specified in combination.
277 means access is granted to unauthenticated clients; it is mostly used
278 to limit access to authentication resources (e.g. the
280 attribute) to unauthenticated clients for authentication purposes.
284 means access is granted to authenticated clients.
288 means access to an entry is allowed to the entry itself (e.g. the entry
289 being accessed and the requesting entry must be the same).
292 style, where \fI<n>\fP indicates what ancestor of the DN
293 is to be used in matches.
294 A positive value indicates that the <n>-th ancestor of the user's DN
295 is to be considered; a negative value indicates that the <n>-th ancestor
296 of the target is to be considered.
297 For example, a "\fIby self.level{1} ...\fP" clause would match
298 when the object "\fIdc=example,dc=com\fP" is accessed
299 by "\fIcn=User,dc=example,dc=com\fP".
300 A "\fIby self.level{-1} ...\fP" clause would match when the same user
301 accesses the object "\fIou=Address Book,cn=User,dc=example,dc=com\fP".
305 means that access is granted to the matching DN.
306 The optional style qualifier
308 allows the same choices of the dn form of the
310 field. In addition, the
312 style can exploit substring substitution of submatches in the
314 dn.regex clause by using the form
318 ranging from 0 to 9 (where 0 matches the entire string),
321 for submatches higher than 9.
322 Since the dollar character is used to indicate a substring replacement,
323 the dollar character that is used to indicate match up to the end of
324 the string must be escaped by a second dollar character, e.g.
327 access to dn.regex="^(.+,)?uid=([^,]+),dc=[^,]+,dc=com$"
328 by dn.regex="^uid=$2,dc=[^,]+,dc=com$$" write
334 At present, the only type allowed is
336 which causes substring substitution of submatches to take place
343 dnstyle in the above example may be of use only if the
345 clause needs to be a regex; otherwise, if the
346 value of the second (from the right)
348 portion of the DN in the above example were fixed, the form
351 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$"
352 by dn.exact,expand="uid=$2,dc=example,dc=com" write
355 could be used; if it had to match the value in the
360 access to dn.regex="^(.+,)?uid=([^,]+),dc=([^,]+),dc=com$"
361 by dn.exact,expand="uid=$2,dc=$3,dc=com" write
368 clause other than regex may provide submatches as well.
379 as the match of the entire string.
388 as the match of the rightmost part of the DN as defined in the
391 This may be useful, for instance, to provide access to all the
392 ancestors of a user by defining
395 access to dn.subtree="dc=com"
396 by dn.subtree,expand="$1" read
399 which means that only access to entries that appear in the DN of the
405 form is an extension and a generalization of the
407 form, which matches all DNs whose <n>-th ancestor is the pattern.
408 So, \fIlevel{1}\fP is equivalent to \fIonelevel\fP,
409 and \fIlevel{0}\fP is equivalent to \fIbase\fP.
411 It is perfectly useless to give any access privileges to a DN
412 that exactly matches the
414 of the database the ACLs apply to, because it implicitly
415 possesses write privileges for the entire tree of that database.
416 Actually, access control is bypassed for the
418 to solve the intrinsic chicken-and-egg problem.
422 means that access is granted to requests whose DN is listed in the
423 entry being accessed under the
429 means that access is granted to requests whose DN is listed
430 in the group entry whose DN is given by
432 The optional parameters
436 define the objectClass and the member attributeType of the group entry.
437 The optional style qualifier
443 will be expanded as a replacement string (but not as a regular expression)
450 which means that exact match will be used.
451 If the style of the DN portion of the
453 clause is regex, the submatches are made available according to
457 other styles provide limited submatches as discussed above about
462 For static groups, the specified attributeType must have
465 .B NameAndOptionalUID
466 syntax. For dynamic groups the attributeType must
469 attributeType. Only LDAP URIs of the form
470 .B ldap:///<base>??<scope>?<filter>
471 will be evaluated in a dynamic group, by searching the local server only.
474 .BR peername=<peername> ,
475 .BR sockname=<sockname> ,
476 .BR domain=<domain> ,
478 .BR sockurl=<sockurl>
479 mean that the contacting host IP (in the form
480 .BR "IP=<ip>:<port>" )
481 or the contacting host named pipe file name (in the form
483 if connecting through a named pipe) for
485 the named pipe file name for
487 the contacting host name for
489 and the contacting URL for
496 rules for pattern match described for the
500 style, which implies submatch
502 and regex match of the corresponding connection parameters.
507 clause (the default) implies a case-exact match on the client's
511 prefix and the trailing
517 prefix if connecting through a named pipe.
520 style interprets the pattern as
521 .BR <peername>=<ip>[%<mask>][{<n>}] ,
526 are dotted digit representations of the IP and the mask, while
528 delimited by curly brackets, is an optional port.
529 When checking access privileges, the IP portion of the
531 is extracted, eliminating the
535 part, and it is compared against the
537 portion of the pattern after masking with
540 .B peername.ip=127.0.0.1
541 allows connections only from localhost,
542 .B peername.ip=192.168.1.0%255.255.255.0
543 allows connections from any IP in the 192.168.1 class C domain, and
544 .B peername.ip=192.168.1.16%255.255.255.240{9009}
545 allows connections from any IP in the 192.168.1.[16-31] range
546 of the same domain, only if port 9009 is used.
553 when connecting through a named pipe, and performs an exact match
554 on the given pattern.
557 clause also allows the
559 style, which succeeds when a fully qualified name exactly matches the
561 pattern, or its trailing part, after a
568 style is allowed, implying an
570 match with submatch expansion; the use of
572 as a style modifier is considered more appropriate.
574 .B domain.subtree=example.com
575 will match www.example.com, but will not match www.anotherexample.com.
578 of the contacting host is determined by performing a DNS reverse lookup.
579 As this lookup can easily be spoofed, use of the
581 statement is strongly discouraged. By default, reverse lookups are disabled.
588 option; the only value currently supported is
590 which causes substring substitution of submatches to take place even if
595 much like the analogous usage in
605 means that the access control is determined by the values in the
608 ACIs are experimental; they must be enabled at compile time.
612 .BR transport_ssf=<n> ,
616 set the minimum required Security Strength Factor (ssf) needed
617 to grant access. The value should be positive integer.
618 .SH THE <ACCESS> FIELD
620 .B <access> ::= [self]{<level>|<priv>}
621 determines the access level or the specific access privileges the
624 Its component are defined as
627 <level> ::= none|disclose|auth|compare|search|read|write
628 <priv> ::= {=|+|-}{w|r|s|c|x|d|0}+
633 allows special operations like having a certain access level or privilege
634 only in case the operation involves the name of the user that's requesting
636 It implies the user that requests access is bound.
639 access to the member attribute of a group, which allows one to add/delete
640 its own DN from the member list of a group, without affecting other members.
644 access model relies on an incremental interpretation of the access
646 The possible levels are
655 Each access level implies all the preceding ones, thus
657 access will imply all accesses.
661 access level disallows all access including disclosure on error.
665 access level allows disclorure of information on error.
669 access level means that one is allowed access to an attribute to perform
670 authentication/authorization operations (e.g.
672 with no other access.
673 This is useful to grant unauthenticated clients the least possible
674 access level to critical resources, like passwords.
678 access model relies on the explicit setting of access privileges
682 sign resets previously defined accesses; as a consequence, the final
683 access privileges will be only those defined by the clause.
688 signs add/remove access privileges to the existing ones.
699 for authentication, and
702 More than one of the above privileges can be added in one statement.
704 indicates no privileges and is used only by itself (e.g., +0).
705 If no access is given, it defaults to
707 .SH THE <CONTROL> FIELD
710 controls the flow of access rule application.
711 It can have the forms
721 the default, means access checking stops in case of match.
722 The other two forms are used to keep on processing access clauses.
725 form allows for other
729 clause to be considered, so that they may result in incrementally altering
730 the privileges, while the
732 form allows for other
734 clauses that match the same target to be processed.
735 Consider the (silly) example
738 access to dn.subtree="dc=example,dc=com" attrs=cn
741 access to dn.subtree="ou=People,dc=example,dc=com"
745 which allows search and compare privileges to everybody under
746 the "dc=example,dc=com" tree, with the second rule allowing
747 also read in the "ou=People" subtree,
748 or the (even more silly) example
751 access to dn.subtree="dc=example,dc=com" attrs=cn
756 which grants everybody search and compare privileges, and adds read
757 privileges to authenticated clients.
758 .SH OPERATION REQUIREMENTS
759 Operations require different privileges on different portions of entries.
760 The following summary applies to primary database backends such as
761 the LDBM, BDB, and HDB backends. Requirements for other backends may
762 (and often do) differ.
768 privileges on the pseudo-attribute
770 of the entry being added, and
772 privileges on the pseudo-attribute
774 of the entry's parent.
778 operation, when credentials are stored in the directory, requires
780 privileges on the attribute the credentials are stored in (usually
787 privileges on the attribute that is being compared.
793 privileges on the pseudo-attribute
795 of the entry being deleted, and
799 pseudo-attribute of the entry's parent.
805 privileges on the attibutes being modified.
811 privileges on the pseudo-attribute
813 of the entry whose relative DN is being modified,
815 privileges on the pseudo-attribute
817 of the old and new entry's parents, and
819 privileges on the attributes that are present in the new relative DN.
821 privileges are also required on the attributes that are present
822 in the old relative DN if
832 pseudo-attribute of the searchBase (NOTE: this was introduced with 2.3).
833 Then, for each entry, it requires
835 privileges on the attributes that are defined in the filter.
836 The resulting entries are finally tested for
838 privileges on the pseudo-attribute
840 (for read access to the entry itself)
843 access on each value of each attribute that is requested.
846 object used in generating continuation references, the operation requires
848 access on the pseudo-attribute
850 (for read access to the referral object itself),
853 access to the attribute holding the referral information
858 Some internal operations and some
860 require specific access privileges.
867 privileges on all the attributes that are present in the search filter
868 of the URI regexp maps (the right-hand side of the
872 privileges are also required on the
874 attribute of the authorizing identity and/or on the
876 attribute of the authorized identity.
878 It is strongly recommended to explicitly use the most appropriate
884 clauses, to avoid possible incorrect specifications of the access rules
885 as well as for performance (avoid unrequired regex matching when an exact
886 match suffices) reasons.
888 An administrator might create a rule of the form:
891 access to dn.regex="dc=example,dc=com"
895 expecting it to match all entries in the subtree "dc=example,dc=com".
896 However, this rule actually matches any DN which contains anywhere
897 the substring "dc=example,dc=com". That is, the rule matches both
898 "uid=joe,dc=example,dc=com" and "dc=example,dc=com,uid=joe".
900 To match the desired subtree, the rule would be more precisely
904 access to dn.regex="^(.+,)?dc=example,dc=com$"
908 For performance reasons, it would be better to use the subtree style.
911 access to dn.subtree="dc=example,dc=com"
915 When writing submatch rules, it may be convenient to avoid unnecessary
918 use; for instance, to allow access to the subtree of the user
921 clause, one could use
924 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$"
925 by dn.regex="^uid=$2,dc=example,dc=com$$" write
929 However, since all that is required in the
931 clause is substring expansion, a more efficient solution is
934 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$"
935 by dn.exact,expand="uid=$2,dc=example,dc=com" write
943 implies substring expansion,
945 as well as all the other DN specific
947 values, does not, so it must be explicitly requested.
952 default slapd configuration file
959 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
962 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
964 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob