git.sur5r.net Git - openldap/blob - contrib/slapd-modules/autogroup/README

   1 autogroup overlay Readme
   2
   3 DESCRIPTION
   4     The autogroup overlay allows automated updates of group memberships which
   5     meet the requirements of any filter contained in the group definition.
   6     The filters are built from LDAP URI-valued attributes. Any time an object
   7     is added/deleted/updated, it is tested for compliance with the filters,
   8     and its membership is accordingly updated. For searches and compares
   9     it behaves like a static group.
  10     If the attribute part of the URI is filled, the group entry is populated
  11     by the values of this attribute in the entries resulting from the search.
  12
  13 BUILDING
  14     A Makefile is included.
  15
  16 CONFIGURATION
  17     # dyngroup.schema:
  18         The dyngroup schema must be modified, adding the 'member' attribute
  19         to the MAY clause of the groupOfURLs object class, i.e.:
  20
  21         objectClass ( NetscapeLDAPobjectClass:33
  22         NAME 'groupOfURLs'
  23         SUP top STRUCTURAL
  24         MUST cn
  25         MAY ( memberURL $ businessCategory $ description $ o $ ou $
  26                 owner $ seeAlso $ member) )
  27
  28
  29     # slapd.conf:
  30
  31     moduleload /path/to/autogroup.so
  32         Loads the overlay (OpenLDAP must be built with --enable-modules).
  33
  34     overlay autogroup
  35         This directive adds the autogroup overlay to the current database.
  36
  37     autogroup-attrset <group-oc> <URL-ad> <member-ad>
  38         This configuration option is defined for the autogroup overlay.
  39         It may have multiple occurrences, and it must appear after the
  40         overlay directive.
  41
  42         The value <group-oc> is the name of the objectClass that represents
  43         the group.
  44
  45         The value <URL-ad> is the name of the attributeDescription that
  46         contains the URI that is converted to the filters. If no URI is
  47         present, there will be no members in that group. It must be a subtype
  48         of labeledURI.
  49
  50         The value <member-ad> is the name of the attributeDescription that
  51         specifies the member attribute. User modification of this attribute
  52         is disabled for consistency.
  53
  54
  55 EXAMPLE
  56     ### slapd.conf
  57     include /path/to/dyngroup.schema
  58     # ...
  59     moduleload /path/to/autogroup.so
  60     # ...
  61
  62     database <database>
  63     # ...
  64
  65     overlay autogroup
  66     autogroup-attrset groupOfURLs memberURL member
  67     ### end slapd.conf
  68
  69 CAVEATS
  70     As with static groups, update operations on groups with a large number
  71     of members may be slow.
  72     If the attribute part of the URI is specified, modify and delete operations
  73     are more difficult to handle. In these cases the overlay will try to detect
  74     if groups have been modified and then simply refresh them. This can cause
  75     performance hits if the search specified by the URI deals with a significant
  76     number of entries.
  77
  78 ACKNOWLEDGEMENTS
  79     This module was originally written in 2007 by Michał Szulczyński.
  80
  81 ---
  82 Copyright 1998-2010 The OpenLDAP Foundation.
  83 Portions Copyright (C) 2007 Michał Szulczyński.
  84 All rights reserved.
  85
  86 Redistribution and use in source and binary forms, with or without
  87 modification, are permitted only as authorized by the OpenLDAP
  88 Public License.
  89
  90 A copy of this license is available in file LICENSE in the
  91 top-level directory of the distribution or, alternatively, at
  92 http://www.OpenLDAP.org/license.html.