1 .TH SLAPO-DYNLIST 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2011 The OpenLDAP Foundation, All Rights Reserved.
3 .\" Copying restrictions apply. See the COPYRIGHT file.
6 slapo\-dynlist \- Dynamic List overlay to slapd
14 allows expansion of dynamic groups and more.
15 Any time an entry with a specific objectClass is being returned,
16 the LDAP URI-valued occurrences of a specific attribute are
17 expanded into the corresponding entries, and the values
18 of the attributes listed in the URI are added to the original
20 No recursion is allowed, to avoid potential infinite loops.
21 The resulting entry must comply with the LDAP data model, so constraints
23 For example, if a \fISINGLE\-VALUE\fP attribute is listed,
24 only the first value results in the final entry.
25 The above described behavior is disabled when the \fImanageDSAit\fP
26 control (RFC 3296) is used.
27 In that case, the contents of the dynamic group entry is returned;
28 namely, the URLs are returned instead of being expanded.
31 The config directives that are specific to the
33 overlay must be prefixed by
35 to avoid potential conflicts with directives specific to the underlying
36 database or to other stacked overlays.
40 This directive adds the dynlist overlay to the current database,
41 or to the frontend, if used before any database instantiation; see
48 configuration option is defined for the dynlist overlay. It may have multiple
49 occurrences, and it must appear after the
53 .B dynlist\-attrset <group-oc> [<URI>] <URL-ad> [[<mapped-ad>:]<member-ad> ...]
56 is the name of the objectClass that triggers the dynamic expansion of the
61 restricts expansion only to entries matching the \fIDN\fP,
62 the \fIscope\fP and the \fIfilter\fP portions of the URI.
66 is the name of the attributeDescription that contains the URI that is
67 expanded by the overlay; if none is present, no expansion occurs.
68 If the intersection of the attributes requested by the search operation
69 (or the asserted attribute for compares) and the attributes listed
70 in the URI is empty, no expansion occurs for that specific URI.
71 It must be a subtype of \fIlabeledURI\fP.
75 is optional; if present, the overlay behaves as a dynamic group: this
76 attribute will list the DN of the entries resulting from the internal search.
77 In this case, the \fIattrs\fP portion of the URIs in the
79 attribute must be absent, and the \fIDN\fPs
80 of all the entries resulting from the expansion of the URIs are listed
81 as values of this attribute.
82 Compares that assert the value of the
84 attribute of entries with
86 objectClass apply as if the DN of the entries resulting from the expansion
87 of the URI were present in the
89 entry as values of the
95 can be used to remap attributes obtained through expansion.
97 attributes are not filled by expanded DN, but are remapped as
99 attributes. Multiple mapping statements can be used.
102 The dynlist overlay may be used with any backend, but it is mainly
103 intended for use with local storage backends.
104 In case the URI expansion is very resource-intensive and occurs frequently
105 with well-defined patterns, one should consider adding a proxycache
106 later on in the overlay stack.
109 By default the expansions are performed using the identity of the current
111 This identity may be overridden by setting the
113 attribute in the group's entry to the DN of another LDAP user.
114 In that case the dgIdentity will be used when expanding the URIs in the object.
115 Setting the dgIdentity to a zero-length string will cause the expansions
116 to be performed anonymously.
117 Note that the dgIdentity attribute is defined in the
119 schema, and this schema must be loaded before the dgIdentity
120 authorization feature may be used.
123 attribute is also present in the group's entry, its values are used
124 to determine what identities are authorized to use the
129 attribute must conform to the (experimental) \fIOpenLDAP authz\fP syntax.
132 This example collects all the email addresses of a database into a single
133 entry; first of all, make sure that slapd.conf contains the directives:
137 include /path/to/dyngroup.schema
144 dynlist\-attrset groupOfURLs memberURL
147 and that slapd loads dynlist.la, if compiled as a run-time module;
148 then add to the database an entry like
151 dn: cn=Dynamic List,ou=Groups,dc=example,dc=com
152 objectClass: groupOfURLs
154 memberURL: ldap:///ou=People,dc=example,dc=com?mail?sub?(objectClass=person)
157 If no <attrs> are provided in the URI, all (non-operational) attributes are
160 This example implements the dynamic group feature on the
166 include /path/to/dyngroup.schema
173 dynlist\-attrset groupOfURLs memberURL member
177 A dynamic group with dgIdentity authorization could be created with an
181 dn: cn=Dynamic Group,ou=Groups,dc=example,dc=com
182 objectClass: groupOfURLs
183 objectClass: dgIdentityAux
185 memberURL: ldap:///ou=People,dc=example,dc=com??sub?(objectClass=person)
186 dgIdentity: cn=Group Proxy,ou=Services,dc=example,dc=com
192 default slapd configuration file
195 .BR slapd\-config (5),
198 .BR slapo\-dynlist (5)
199 overlay supports dynamic configuration via
203 This module was written in 2004 by Pierangelo Masarati for SysNet s.n.c.
205 Attribute remapping was contributed in 2008 by Emmanuel Dreyfus.