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

   1 .TH SLAPO-DYNLIST 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 1998-2007 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> <URL-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 value
  60 .B <URL-ad>
  61 is the name of the attributeDescription that contains the URI that is
  62 expanded by the overlay; if none is present, no expansion occurs.
  63 If the intersection of the attributes requested by the search operation
  64 (or the asserted attribute for compares) and the attributes listed
  65 in the URI is empty, no expansion occurs for that specific URI.
  66 It must be a subtype of \fIlabeledURI\fP.
  67
  68 The value
  69 .B <member-ad>
  70 is optional; if present, the overlay behaves as a dynamic group: this
  71 attribute will list the DN of the entries resulting from the internal search.
  72 In this case, the <attrs> portion of the URI must be absent, and the DNs
  73 of all the entries resulting from the expansion of the URI are listed
  74 as values of this attribute.
  75 Compares that assert the value of the
  76 .B <member-ad>
  77 attribute of entries with
  78 .B <group-oc>
  79 objectClass apply as if the DN of the entries resulting from the expansion
  80 of the URI were present in the
  81 .B <group-oc>
  82 entry as values of the
  83 .B <member-ad>
  84 attribute.
  85 .LP
  86 The dynlist overlay may be used with any backend, but it is mainly
  87 intended for use with local storage backends.
  88 In case the URI expansion is very resource-intensive and occurs frequently
  89 with well-defined patterns, one should consider adding a proxycache
  90 later on in the overlay stack.
  91
  92 .SH AUTHORIZATION
  93 By default the expansions are performed using the identity of the current
  94 LDAP user. This identity may be overridden by setting the
  95 .B dgIdentity
  96 attribute to the DN of another LDAP user. In that case the dgIdentity
  97 will be used when expanding the URIs in the object. Setting the dgIdentity
  98 to a zero-length string will cause the expansions to be performed
  99 anonymously. Note that the dgIdentity attribute is defined in the
 100 .B dyngroup
 101 schema, and this schema must be loaded before the dgIdentity
 102 authorization feature may be used.
 103
 104 .SH EXAMPLE
 105 This example collects all the email addresses of a database into a single
 106 entry; first of all, make sure that slapd.conf contains the directives:
 107
 108 .LP
 109 .nf
 110     include /path/to/dyngroup.schema
 111     # ...
 112
 113     database <database>
 114     # ...
 115
 116     overlay dynlist
 117     dynlist-attrset groupOfURLs memberURL
 118 .fi
 119 .LP
 120 and that slapd loads dynlist.la, if compiled as a run-time module;
 121 then add to the database an entry like
 122 .LP
 123 .nf
 124     dn: cn=Dynamic List,ou=Groups,dc=example,dc=com
 125     objectClass: groupOfURLs
 126     cn: Dynamic List
 127     memberURL: ldap:///ou=People,dc=example,dc=com?mail?sub?(objectClass=person)
 128 .fi
 129
 130 If no <attrs> are provided in the URI, all (non-operational) attributes are
 131 collected.
 132
 133 This example implements the dynamic group feature on the
 134 .B member
 135 attribute:
 136
 137 .LP
 138 .nf
 139     include /path/to/dyngroup.schema
 140     # ...
 141
 142     database <database>
 143     # ...
 144
 145     overlay dynlist
 146     dynlist-attrset groupOfURLs memberURL member
 147 .fi
 148 .LP
 149
 150 A dynamic group with dgIdentity authorization could be created with an
 151 entry like
 152 .LP
 153 .nf
 154     dn: cn=Dynamic Group,ou=Groups,dc=example,dc=com
 155     objectClass: groupOfURLs
 156     objectClass: dgIdentityAux
 157     cn: Dynamic Group
 158     memberURL: ldap:///ou=People,dc=example,dc=com??sub?(objectClass=person)
 159     dgIdentity: cn=Group Proxy,ou=Services,dc=example,dc=com
 160 .fi
 161
 162 .SH FILES
 163 .TP
 164 ETCDIR/slapd.conf
 165 default slapd configuration file
 166 .SH SEE ALSO
 167 .BR slapd.conf (5),
 168 .BR slapd (8).
 169 The
 170 .BR slapo-dynlist (5)
 171 overlay supports dynamic configuration via
 172 .BR back-config .
 173 .SH ACKNOWLEDGEMENTS
 174 .P
 175 This module was written in 2004 by Pierangelo Masarati for SysNet s.n.c.