slapo-dynlist.5 6.68 KB
Newer Older
1
.TH SLAPO-DYNLIST 5 "RELEASEDATE" "OpenLDAP LDVERSION"
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
2
.\" Copyright 1998-2020 The OpenLDAP Foundation, All Rights Reserved.
3
4
5
.\" Copying restrictions apply.  See the COPYRIGHT file.
.\" $OpenLDAP$
.SH NAME
Howard Chu's avatar
Howard Chu committed
6
slapo\-dynlist \- Dynamic List overlay to slapd
7
8
9
10
11
12
13
14
.SH SYNOPSIS
ETCDIR/slapd.conf
.SH DESCRIPTION
The
.B dynlist
overlay to
.BR slapd (8)
allows expansion of dynamic groups and more.
15
16
Any time an entry with a specific objectClass (defined in the overlay configuration) is being returned,
the LDAP URI-valued occurrences of a specific attribute (also defined in the overlay configuration) are
17
18
19
expanded into the corresponding entries, and the values
of the attributes listed in the URI are added to the original
entry.
20
No recursion is allowed, to avoid potential infinite loops.
21

22
23
The resulting entry must comply with the LDAP data model, so constraints
are enforced.
Howard Chu's avatar
Howard Chu committed
24
For example, if a \fISINGLE\-VALUE\fP attribute is listed,
25
only the first value found during the list expansion appears in the final entry.
Howard Chu's avatar
Howard Chu committed
26
All dynamic behavior is disabled when the \fImanageDSAit\fP
27
28
29
control (RFC 3296) is used.
In that case, the contents of the dynamic group entry is returned;
namely, the URLs are returned instead of being expanded.
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

.SH CONFIGURATION
The config directives that are specific to the
.B dynlist
overlay must be prefixed by
.BR dynlist\- ,
to avoid potential conflicts with directives specific to the underlying 
database or to other stacked overlays.

.TP
.B overlay dynlist
This directive adds the dynlist overlay to the current database,
or to the frontend, if used before any database instantiation; see
.BR slapd.conf (5)
for details.

.LP
47
This
48
.B slapd.conf
Pierangelo Masarati's avatar
typo    
Pierangelo Masarati committed
49
configuration option is defined for the dynlist overlay. It may have multiple 
50
occurrences, and it must appear after the
51
52
53
.B overlay
directive.
.TP
Howard Chu's avatar
Howard Chu committed
54
.B dynlist\-attrset <group-oc> [<URI>] <URL-ad> [[<mapped-ad>:]<member-ad>[@<memberOf-ad] ...]
55
The value 
Howard Chu's avatar
Howard Chu committed
56
.B group\-oc
57
58
59
is the name of the objectClass that triggers the dynamic expansion of the
data.

60
61
62
63
64
The optional
.B URI
restricts expansion only to entries matching the \fIDN\fP,
the \fIscope\fP and the \fIfilter\fP portions of the URI.

65
The value
66
.B URL-ad
Gavin Henry's avatar
Gavin Henry committed
67
is the name of the attributeDescription that contains the URI that is 
68
69
70
71
72
73
74
expanded by the overlay; if none is present, no expansion occurs.
If the intersection of the attributes requested by the search operation 
(or the asserted attribute for compares) and the attributes listed 
in the URI is empty, no expansion occurs for that specific URI.
It must be a subtype of \fIlabeledURI\fP.

The value
75
.B member-ad
76
77
is optional; if present, the overlay behaves as a dynamic group: this
attribute will list the DN of the entries resulting from the internal search.
78
79
80
81
In this case, the \fIattrs\fP portion of the URIs in the
.B URL-ad
attribute must be absent, and the \fIDN\fPs 
of all the entries resulting from the expansion of the URIs are listed
82
83
as values of this attribute.
Compares that assert the value of the
84
.B member-ad
85
attribute of entries with 
86
.B group-oc
87
88
objectClass apply as if the DN of the entries resulting from the expansion 
of the URI were present in the 
89
.B group-oc 
90
entry as values of the
91
.B member-ad
92
attribute.
Howard Chu's avatar
Howard Chu committed
93
94
95
96
If the optional
.B memberOf-ad
attribute is also specified, then it will be populated with the DNs of the
dynamic groups that an entry is a member of.
97
98

Alternatively, 
99
.B mapped-ad
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
100
can be used to remap attributes obtained through expansion. 
101
.B member-ad
102
attributes are not filled by expanded DN, but are remapped as
103
.B mapped-ad 
Howard Chu's avatar
Howard Chu committed
104
105
106
attributes.  Multiple mapping statements can be used. The
.B memberOf-ad
option is not used in this case.
107

108
109
110
111
112
113
114
.LP
The dynlist overlay may be used with any backend, but it is mainly 
intended for use with local storage backends.
In case the URI expansion is very resource-intensive and occurs frequently
with well-defined patterns, one should consider adding a proxycache
later on in the overlay stack.

Howard Chu's avatar
Howard Chu committed
115
116
.SH AUTHORIZATION
By default the expansions are performed using the identity of the current
117
118
LDAP user.
This identity may be overridden by setting the
Howard Chu's avatar
Howard Chu committed
119
.B dgIdentity
120
121
122
123
124
attribute in the group's entry to the DN of another LDAP user.
In that case the dgIdentity will be used when expanding the URIs in the object.
Setting the dgIdentity to a zero-length string will cause the expansions
to be performed anonymously.
Note that the dgIdentity attribute is defined in the
Howard Chu's avatar
Howard Chu committed
125
126
127
.B dyngroup
schema, and this schema must be loaded before the dgIdentity
authorization feature may be used.
128
129
130
131
132
133
134
135
136
If the
.B dgAuthz
attribute is also present in the group's entry, its values are used
to determine what identities are authorized to use the
.B dgIdentity
to expand the group.
Values of the 
.B dgAuthz
attribute must conform to the (experimental) \fIOpenLDAP authz\fP syntax.
Howard Chu's avatar
Howard Chu committed
137

138
139
140
141
142
143
144
145
146
147
148
149
150
.SH EXAMPLE
This example collects all the email addresses of a database into a single
entry; first of all, make sure that slapd.conf contains the directives:

.LP
.nf
    include /path/to/dyngroup.schema
    # ...

    database <database>
    # ...

    overlay dynlist
Howard Chu's avatar
Howard Chu committed
151
    dynlist\-attrset groupOfURLs memberURL
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
.fi
.LP
and that slapd loads dynlist.la, if compiled as a run-time module;
then add to the database an entry like
.LP
.nf
    dn: cn=Dynamic List,ou=Groups,dc=example,dc=com
    objectClass: groupOfURLs
    cn: Dynamic List
    memberURL: ldap:///ou=People,dc=example,dc=com?mail?sub?(objectClass=person)
.fi

If no <attrs> are provided in the URI, all (non-operational) attributes are
collected.

167
168
169
170
171
172
173
174
175
176
177
178
179
This example implements the dynamic group feature on the 
.B member
attribute:

.LP
.nf
    include /path/to/dyngroup.schema
    # ...

    database <database>
    # ...

    overlay dynlist
Howard Chu's avatar
Howard Chu committed
180
    dynlist\-attrset groupOfURLs memberURL member
181
182
.fi
.LP
183

Howard Chu's avatar
Howard Chu committed
184
185
186
187
188
189
190
191
192
193
194
195
A dynamic group with dgIdentity authorization could be created with an
entry like
.LP
.nf
    dn: cn=Dynamic Group,ou=Groups,dc=example,dc=com
    objectClass: groupOfURLs
    objectClass: dgIdentityAux
    cn: Dynamic Group
    memberURL: ldap:///ou=People,dc=example,dc=com??sub?(objectClass=person)
    dgIdentity: cn=Group Proxy,ou=Services,dc=example,dc=com
.fi

196
197
198
199
.SH FILES
.TP
ETCDIR/slapd.conf
default slapd configuration file
200
201
202
203
204
205
206
207
208
.SH BACKWARD COMPATIBILITY
The dyngroup overlay has been reworked with the 2.5 release to use
a consistent namespace as with other overlays. As a side-effect the
following cn=config parameters are deprecated and will be removed in
a future release:
.B olcDlAttrSet
is replaced with olcDynListAttrSet
.B olcDynamicList
is replaced with olcDynListConfig
209
210
.SH SEE ALSO
.BR slapd.conf (5),
211
.BR slapd\-config (5),
212
.BR slapd (8).
213
The
Howard Chu's avatar
Howard Chu committed
214
.BR slapo\-dynlist (5)
215
216
overlay supports dynamic configuration via
.BR back-config .
Pierangelo Masarati's avatar
Pierangelo Masarati committed
217
218
219
.SH ACKNOWLEDGEMENTS
.P
This module was written in 2004 by Pierangelo Masarati for SysNet s.n.c.
220
221
.P
Attribute remapping was contributed in 2008 by Emmanuel Dreyfus.