git.sur5r.net Git - openldap/blob - doc/man/man5/slapo-dynlist.5

   1 .TH SLAPO-DYNLIST 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 1998-2012 The OpenLDAP Foundation, All Rights Reserved.
   3 .\" Copying restrictions apply.  See the COPYRIGHT file.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo\-dynlist \- Dynamic List overlay to slapd
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The
  11 .B dynlist
  12 overlay to
  13 .BR slapd (8)
  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
  19 entry.
  20 No recursion is allowed, to avoid potential infinite loops.
  21 The resulting entry must comply with the LDAP data model, so constraints
  22 are enforced.
  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.
  29
  30 .SH CONFIGURATION
  31 The config directives that are specific to the
  32 .B dynlist
  33 overlay must be prefixed by
  34 .BR dynlist\- ,
  35 to avoid potential conflicts with directives specific to the underlying
  36 database or to other stacked overlays.
  37
  38 .TP
  39 .B overlay dynlist
  40 This directive adds the dynlist overlay to the current database,
  41 or to the frontend, if used before any database instantiation; see
  42 .BR slapd.conf (5)
  43 for details.
  44
  45 .LP
  46 This
  47 .B slapd.conf
  48 configuration option is defined for the dynlist overlay. It may have multiple
  49 occurrences, and it must appear after the
  50 .B overlay
  51 directive.
  52 .TP
  53 .B dynlist\-attrset <group-oc> [<URI>] <URL-ad> [[<mapped-ad>:]<member-ad> ...]
  54 The value
  55 .B group\-oc
  56 is the name of the objectClass that triggers the dynamic expansion of the
  57 data.
  58
  59 The optional
  60 .B URI
  61 restricts expansion only to entries matching the \fIDN\fP,
  62 the \fIscope\fP and the \fIfilter\fP portions of the URI.
  63
  64 The value
  65 .B URL-ad
  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.
  72
  73 The value
  74 .B member-ad
  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
  78 .B URL-ad
  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
  83 .B member-ad
  84 attribute of entries with
  85 .B group-oc
  86 objectClass apply as if the DN of the entries resulting from the expansion
  87 of the URI were present in the
  88 .B group-oc
  89 entry as values of the
  90 .B member-ad
  91 attribute.
  92
  93 Alternatively,
  94 .B mapped-ad
  95 can be used to remap attributes obtained through expansion.
  96 .B member-ad
  97 attributes are not filled by expanded DN, but are remapped as
  98 .B mapped-ad
  99 attributes.  Multiple mapping statements can be used.
 100
 101 .LP
 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.
 107
 108 .SH AUTHORIZATION
 109 By default the expansions are performed using the identity of the current
 110 LDAP user.
 111 This identity may be overridden by setting the
 112 .B dgIdentity
 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
 118 .B dyngroup
 119 schema, and this schema must be loaded before the dgIdentity
 120 authorization feature may be used.
 121 If the
 122 .B dgAuthz
 123 attribute is also present in the group's entry, its values are used
 124 to determine what identities are authorized to use the
 125 .B dgIdentity
 126 to expand the group.
 127 Values of the
 128 .B dgAuthz
 129 attribute must conform to the (experimental) \fIOpenLDAP authz\fP syntax.
 130
 131 .SH EXAMPLE
 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:
 134
 135 .LP
 136 .nf
 137     include /path/to/dyngroup.schema
 138     # ...
 139
 140     database <database>
 141     # ...
 142
 143     overlay dynlist
 144     dynlist\-attrset groupOfURLs memberURL
 145 .fi
 146 .LP
 147 and that slapd loads dynlist.la, if compiled as a run-time module;
 148 then add to the database an entry like
 149 .LP
 150 .nf
 151     dn: cn=Dynamic List,ou=Groups,dc=example,dc=com
 152     objectClass: groupOfURLs
 153     cn: Dynamic List
 154     memberURL: ldap:///ou=People,dc=example,dc=com?mail?sub?(objectClass=person)
 155 .fi
 156
 157 If no <attrs> are provided in the URI, all (non-operational) attributes are
 158 collected.
 159
 160 This example implements the dynamic group feature on the
 161 .B member
 162 attribute:
 163
 164 .LP
 165 .nf
 166     include /path/to/dyngroup.schema
 167     # ...
 168
 169     database <database>
 170     # ...
 171
 172     overlay dynlist
 173     dynlist\-attrset groupOfURLs memberURL member
 174 .fi
 175 .LP
 176
 177 A dynamic group with dgIdentity authorization could be created with an
 178 entry like
 179 .LP
 180 .nf
 181     dn: cn=Dynamic Group,ou=Groups,dc=example,dc=com
 182     objectClass: groupOfURLs
 183     objectClass: dgIdentityAux
 184     cn: Dynamic Group
 185     memberURL: ldap:///ou=People,dc=example,dc=com??sub?(objectClass=person)
 186     dgIdentity: cn=Group Proxy,ou=Services,dc=example,dc=com
 187 .fi
 188
 189 .SH FILES
 190 .TP
 191 ETCDIR/slapd.conf
 192 default slapd configuration file
 193 .SH SEE ALSO
 194 .BR slapd.conf (5),
 195 .BR slapd\-config (5),
 196 .BR slapd (8).
 197 The
 198 .BR slapo\-dynlist (5)
 199 overlay supports dynamic configuration via
 200 .BR back-config .
 201 .SH ACKNOWLEDGEMENTS
 202 .P
 203 This module was written in 2004 by Pierangelo Masarati for SysNet s.n.c.
 204 .P
 205 Attribute remapping was contributed in 2008 by Emmanuel Dreyfus.