1 .TH SLAPD.ACCESS 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2006 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
78 Lists of access directives are evaluated in the order they appear
82 clause matches the datum whose access is being evaluated, its
84 clause list is checked.
87 clause matches the accessor's properties, its
91 clauses are evaluated.
92 Access control checking stops at the first match of the
96 clause, unless otherwise dictated by the
101 clause list is implicitly terminated by a
107 clause that results in stopping the access control with no access
111 clause list is implicitly terminated by a
118 clause that results in granting no access privileges to an otherwise
123 specifies the entity the access control directive applies to.
124 It can have the forms
127 [dn[.<dnstyle>]=]<dnpattern>
129 attrs=<attrlist>[ val[/matchingRule][.<attrstyle>]=<attrval>]
135 <dnstyle>={{exact|base(object)}|regex
136 |one(level)|sub(tree)|children}
137 <attrlist>={<attr>|[{!|@}]<objectClass>}[,<attrlist>]
138 <attrstyle>={{exact|base(object)}|regex
139 |one(level)|sub(tree)|children}
144 selects the entries based on their naming context.
150 is a string representation of the entry's DN.
153 stands for all the entries, and it is implied if no
159 is also optional; however, it is recommended to specify both the
163 to avoid ambiguities.
172 indicates the entry whose DN is equal to the
177 indicates all the entries immediately below the
182 indicates all entries in the subtree at the
185 indicates all the entries below (subordinate to) the
194 is a POSIX (''extended'') regular expression pattern,
199 matching a normalized string representation of the entry's DN.
200 The regex form of the pattern does not (yet) support UTF\-8.
203 .B filter=<ldapfilter>
204 selects the entries based on a valid LDAP filter as described in RFC 2254.
213 selects the attributes the access control rule applies to.
214 It is a comma-separated list of attribute types, plus the special names
216 indicating access to the entry itself, and
218 indicating access to the entry's children. ObjectClass names may also
219 be specified in this list, which will affect all the attributes that
220 are required and/or allowed by that objectClass.
225 are directly treated as objectClass names. A name prefixed by
227 is also treated as an objectClass, but in this case the access rule
228 affects the attributes that are not required nor allowed
233 .B attrs=@extensibleObject
234 is implied, i.e. all attributes are addressed.
237 .B attrs=<attr> val[/matchingRule][.<attrstyle>]=<attrval>
238 specifies access to a particular value of a single attribute.
239 In this case, only a single attribute type may be given. The
242 (the default) uses the attribute's equality matching rule to compare the
243 value, unless a different (and compatible) matching rule is specified. If the
247 the provided value is used as a POSIX (''extended'') regular
248 expression pattern. If the attribute has DN syntax, the
256 resulting in base, onelevel, subtree or children match, respectively.
258 The dn, filter, and attrs statements are additive; they can be used in sequence
259 to select entities the access rule applies to based on naming context,
260 value and attribute type simultaneously.
264 indicates whom the access rules apply to.
267 statements can appear in an access control statement, indicating the
268 different access privileges to the same resource that apply to different
270 It can have the forms
278 dn[.<dnstyle>[,<modifier>]]=<DN>
283 realself[.<selfstyle>]
285 realdn[.<dnstyle>[,<modifier>]]=<DN>
286 realdnattr=<attrname>
288 group[/<objectclass>[/<attrname>]]
289 [.<groupstyle>]=<group>
290 peername[.<peernamestyle>]=<peername>
291 sockname[.<style>]=<sockname>
292 domain[.<domainstyle>[,<modifier>]]=<domain>
293 sockurl[.<style>]=<sockurl>
294 set[.<setstyle>]=<pattern>
301 dynacl/<name>[/<options>][.<dynstyle>][=<pattern>]
307 <style>={exact|regex|expand}
308 <selfstyle>={level{<n>}}
309 <dnstyle>={{exact|base(object)}|regex
310 |one(level)|sub(tree)|children|level{<n>}}
311 <groupstyle>={exact|expand}
312 <peernamestyle>={<style>|ip|path}
313 <domainstyle>={exact|regex|sub(tree)}
314 <setstyle>={exact|regex}
316 <name>=aci <pattern>=<attrname>]
319 They may be specified in combination.
328 The keywords prefixed by
330 act as their counterparts without prefix; the checking respectively occurs
331 with the \fIauthentication\fP DN and the \fIauthorization\fP DN.
335 means access is granted to unauthenticated clients; it is mostly used
336 to limit access to authentication resources (e.g. the
338 attribute) to unauthenticated clients for authentication purposes.
342 means access is granted to authenticated clients.
346 means access to an entry is allowed to the entry itself (e.g. the entry
347 being accessed and the requesting entry must be the same).
350 style, where \fI<n>\fP indicates what ancestor of the DN
351 is to be used in matches.
352 A positive value indicates that the <n>-th ancestor of the user's DN
353 is to be considered; a negative value indicates that the <n>-th ancestor
354 of the target is to be considered.
355 For example, a "\fIby self.level{1} ...\fP" clause would match
356 when the object "\fIdc=example,dc=com\fP" is accessed
357 by "\fIcn=User,dc=example,dc=com\fP".
358 A "\fIby self.level{-1} ...\fP" clause would match when the same user
359 accesses the object "\fIou=Address Book,cn=User,dc=example,dc=com\fP".
363 means that access is granted to the matching DN.
364 The optional style qualifier
366 allows the same choices of the dn form of the
368 field. In addition, the
370 style can exploit substring substitution of submatches in the
372 dn.regex clause by using the form
376 ranging from 0 to 9 (where 0 matches the entire string),
379 for submatches higher than 9.
380 Since the dollar character is used to indicate a substring replacement,
381 the dollar character that is used to indicate match up to the end of
382 the string must be escaped by a second dollar character, e.g.
385 access to dn.regex="^(.+,)?uid=([^,]+),dc=[^,]+,dc=com$"
386 by dn.regex="^uid=$2,dc=[^,]+,dc=com$$" write
392 At present, the only type allowed is
394 which causes substring substitution of submatches to take place
401 dnstyle in the above example may be of use only if the
403 clause needs to be a regex; otherwise, if the
404 value of the second (from the right)
406 portion of the DN in the above example were fixed, the form
409 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$"
410 by dn.exact,expand="uid=$2,dc=example,dc=com" write
413 could be used; if it had to match the value in the
418 access to dn.regex="^(.+,)?uid=([^,]+),dc=([^,]+),dc=com$"
419 by dn.exact,expand="uid=$2,dc=$3,dc=com" write
426 clause other than regex may provide submatches as well.
437 as the match of the entire string.
446 as the match of the rightmost part of the DN as defined in the
449 This may be useful, for instance, to provide access to all the
450 ancestors of a user by defining
453 access to dn.subtree="dc=com"
454 by dn.subtree,expand="$1" read
457 which means that only access to entries that appear in the DN of the
463 form is an extension and a generalization of the
465 form, which matches all DNs whose <n>-th ancestor is the pattern.
466 So, \fIlevel{1}\fP is equivalent to \fIonelevel\fP,
467 and \fIlevel{0}\fP is equivalent to \fIbase\fP.
469 It is perfectly useless to give any access privileges to a DN
470 that exactly matches the
472 of the database the ACLs apply to, because it implicitly
473 possesses write privileges for the entire tree of that database.
474 Actually, access control is bypassed for the
476 to solve the intrinsic chicken-and-egg problem.
480 means that access is granted to requests whose DN is listed in the
481 entry being accessed under the
487 means that access is granted to requests whose DN is listed
488 in the group entry whose DN is given by
490 The optional parameters
494 define the objectClass and the member attributeType of the group entry.
500 The optional style qualifier
506 will be expanded as a replacement string (but not as a regular expression)
513 which means that exact match will be used.
514 If the style of the DN portion of the
516 clause is regex, the submatches are made available according to
520 other styles provide limited submatches as discussed above about
525 For static groups, the specified attributeType must have
528 .B NameAndOptionalUID
529 syntax. For dynamic groups the attributeType must
532 attributeType. Only LDAP URIs of the form
533 .B ldap:///<base>??<scope>?<filter>
534 will be evaluated in a dynamic group, by searching the local server only.
537 .BR peername=<peername> ,
538 .BR sockname=<sockname> ,
539 .BR domain=<domain> ,
541 .BR sockurl=<sockurl>
542 mean that the contacting host IP (in the form
543 .BR "IP=<ip>:<port>" )
544 or the contacting host named pipe file name (in the form
546 if connecting through a named pipe) for
548 the named pipe file name for
550 the contacting host name for
552 and the contacting URL for
559 rules for pattern match described for the
563 style, which implies submatch
565 and regex match of the corresponding connection parameters.
570 clause (the default) implies a case-exact match on the client's
574 prefix and the trailing
580 prefix if connecting through a named pipe.
583 style interprets the pattern as
584 .BR <peername>=<ip>[%<mask>][{<n>}] ,
589 are dotted digit representations of the IP and the mask, while
591 delimited by curly brackets, is an optional port.
592 When checking access privileges, the IP portion of the
594 is extracted, eliminating the
598 part, and it is compared against the
600 portion of the pattern after masking with
603 .B peername.ip=127.0.0.1
604 allows connections only from localhost,
605 .B peername.ip=192.168.1.0%255.255.255.0
606 allows connections from any IP in the 192.168.1 class C domain, and
607 .B peername.ip=192.168.1.16%255.255.255.240{9009}
608 allows connections from any IP in the 192.168.1.[16-31] range
609 of the same domain, only if port 9009 is used.
616 when connecting through a named pipe, and performs an exact match
617 on the given pattern.
620 clause also allows the
622 style, which succeeds when a fully qualified name exactly matches the
624 pattern, or its trailing part, after a
631 style is allowed, implying an
633 match with submatch expansion; the use of
635 as a style modifier is considered more appropriate.
637 .B domain.subtree=example.com
638 will match www.example.com, but will not match www.anotherexample.com.
641 of the contacting host is determined by performing a DNS reverse lookup.
642 As this lookup can easily be spoofed, use of the
644 statement is strongly discouraged. By default, reverse lookups are disabled.
651 option; the only value currently supported is
653 which causes substring substitution of submatches to take place even if
658 much like the analogous usage in
667 .B dynacl/<name>[/<options>][.<dynstyle>][=<pattern>]
668 means that access checking is delegated to the admin-defined method
671 which can be registered at run-time by means of the
679 are optional, and are directly passed to the registered parsing routine.
680 Dynacl is experimental; it must be enabled at compile time.
683 .B dynacl/aci[=<attrname>]
684 means that the access control is determined by the values in the
689 indicates what attributeType holds the ACI information in the entry.
692 operational attribute is used.
693 ACIs are experimental; they must be enabled at compile time.
697 .BR transport_ssf=<n> ,
701 set the minimum required Security Strength Factor (ssf) needed
702 to grant access. The value should be positive integer.
703 .SH THE <ACCESS> FIELD
705 .B <access> ::= [[real]self]{<level>|<priv>}
706 determines the access level or the specific access privileges the
709 Its component are defined as
712 <level> ::= none|disclose|auth|compare|search|read|write|manage
713 <priv> ::= {=|+|-}{m|w|r|s|c|x|d|0}+
718 allows special operations like having a certain access level or privilege
719 only in case the operation involves the name of the user that's requesting
721 It implies the user that requests access is authorized.
724 refers to the authenticated DN as opposed to the authorized DN of the
729 access to the member attribute of a group, which allows one to add/delete
730 its own DN from the member list of a group, without affecting other members.
734 access model relies on an incremental interpretation of the access
736 The possible levels are
745 Each access level implies all the preceding ones, thus
747 grants all access including administrative access,
751 access level disallows all access including disclosure on error.
755 access level allows disclosure of information on error.
759 access level means that one is allowed access to an attribute to perform
760 authentication/authorization operations (e.g.
762 with no other access.
763 This is useful to grant unauthenticated clients the least possible
764 access level to critical resources, like passwords.
768 access model relies on the explicit setting of access privileges
772 sign resets previously defined accesses; as a consequence, the final
773 access privileges will be only those defined by the clause.
778 signs add/remove access privileges to the existing ones.
791 for authentication, and
794 More than one of the above privileges can be added in one statement.
796 indicates no privileges and is used only by itself (e.g., +0).
798 If no access is given, it defaults to
800 .SH THE <CONTROL> FIELD
803 controls the flow of access rule application.
804 It can have the forms
814 the default, means access checking stops in case of match.
815 The other two forms are used to keep on processing access clauses.
818 form allows for other
822 clause to be considered, so that they may result in incrementally altering
823 the privileges, while the
825 form allows for other
827 clauses that match the same target to be processed.
828 Consider the (silly) example
831 access to dn.subtree="dc=example,dc=com" attrs=cn
834 access to dn.subtree="ou=People,dc=example,dc=com"
838 which allows search and compare privileges to everybody under
839 the "dc=example,dc=com" tree, with the second rule allowing
840 also read in the "ou=People" subtree,
841 or the (even more silly) example
844 access to dn.subtree="dc=example,dc=com" attrs=cn
849 which grants everybody search and compare privileges, and adds read
850 privileges to authenticated clients.
852 One useful application is to easily grant write privileges to an
854 that is different from the
856 In this case, since the
858 needs write access to (almost) all data, one can use
862 by dn.exact="cn=The Update DN,dc=example,dc=com" write
866 as the first access rule.
867 As a consequence, unless the operation is performed with the
869 identity, control is passed straight to the subsequent rules.
870 .SH OPERATION REQUIREMENTS
871 Operations require different privileges on different portions of entries.
872 The following summary applies to primary database backends such as
873 the BDB and HDB backends. Requirements for other backends may
874 (and often do) differ.
880 privileges on the pseudo-attribute
882 of the entry being added, and
884 privileges on the pseudo-attribute
886 of the entry's parent.
890 operation, when credentials are stored in the directory, requires
892 privileges on the attribute the credentials are stored in (usually
899 privileges on the attribute that is being compared.
905 privileges on the pseudo-attribute
907 of the entry being deleted, and
911 pseudo-attribute of the entry's parent.
917 privileges on the attributes being modified.
923 privileges on the pseudo-attribute
925 of the entry whose relative DN is being modified,
927 privileges on the pseudo-attribute
929 of the old and new entry's parents, and
931 privileges on the attributes that are present in the new relative DN.
933 privileges are also required on the attributes that are present
934 in the old relative DN if
944 pseudo-attribute of the searchBase (NOTE: this was introduced with 2.3).
945 Then, for each entry, it requires
947 privileges on the attributes that are defined in the filter.
948 The resulting entries are finally tested for
950 privileges on the pseudo-attribute
952 (for read access to the entry itself)
955 access on each value of each attribute that is requested.
958 object used in generating continuation references, the operation requires
960 access on the pseudo-attribute
962 (for read access to the referral object itself),
965 access to the attribute holding the referral information
970 Some internal operations and some
972 require specific access privileges.
979 privileges on all the attributes that are present in the search filter
980 of the URI regexp maps (the right-hand side of the
984 privileges are also required on the
986 attribute of the authorizing identity and/or on the
988 attribute of the authorized identity.
991 Access control to search entries is checked by the frontend,
992 so it is fully honored by all backends; for all other operations
993 and for the discovery phase of the search operation,
994 full ACL semantics is only supported by the primary backends, i.e.
999 Some other backend, like
1001 may fully support them; others may only support a portion of the
1002 described semantics, or even differ in some aspects.
1003 The relevant details are described in the backend-specific man pages.
1006 It is strongly recommended to explicitly use the most appropriate
1012 clauses, to avoid possible incorrect specifications of the access rules
1013 as well as for performance (avoid unnecessary regex matching when an exact
1014 match suffices) reasons.
1016 An administrator might create a rule of the form:
1019 access to dn.regex="dc=example,dc=com"
1023 expecting it to match all entries in the subtree "dc=example,dc=com".
1024 However, this rule actually matches any DN which contains anywhere
1025 the substring "dc=example,dc=com". That is, the rule matches both
1026 "uid=joe,dc=example,dc=com" and "dc=example,dc=com,uid=joe".
1028 To match the desired subtree, the rule would be more precisely
1032 access to dn.regex="^(.+,)?dc=example,dc=com$"
1036 For performance reasons, it would be better to use the subtree style.
1039 access to dn.subtree="dc=example,dc=com"
1043 When writing submatch rules, it may be convenient to avoid unnecessary
1046 use; for instance, to allow access to the subtree of the user
1049 clause, one could use
1052 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$"
1053 by dn.regex="^uid=$2,dc=example,dc=com$$" write
1057 However, since all that is required in the
1059 clause is substring expansion, a more efficient solution is
1062 access to dn.regex="^(.+,)?uid=([^,]+),dc=example,dc=com$"
1063 by dn.exact,expand="uid=$2,dc=example,dc=com" write
1071 implies substring expansion,
1073 as well as all the other DN specific
1075 values, does not, so it must be explicitly requested.
1080 default slapd configuration file
1088 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1089 .SH ACKNOWLEDGEMENTS
1091 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1093 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob