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

   1 This directory contains a slapd overlay, "allowed".
   2
   3     --- o --- o --- o ---
   4
   5 It adds to entries returned by search operations the value of attributes
   6
   7 "allowedAttributes"
   8         <http://msdn.microsoft.com/en-us/library/ms675217(VS.85).aspx>
   9
  10 "allowedAttributesEffective"
  11         <http://msdn.microsoft.com/en-us/library/ms675218(VS.85).aspx>
  12
  13 "allowedChildClasses"
  14         <http://msdn.microsoft.com/en-us/library/ms675219(VS.85).aspx>
  15
  16 "allowedChildClassesEffective"
  17         <http://msdn.microsoft.com/en-us/library/ms675220(VS.85).aspx>
  18
  19 No other use is made of those attributes: they cannot be compared,
  20 they cannot be used in search filters, they cannot be used in ACLs, ...
  21
  22     --- o --- o --- o ---
  23
  24 Usage: add to slapd.conf(5)
  25
  26
  27 moduleload      path/to/allowed.so
  28 overlay         allowed
  29
  30 or add
  31
  32 dn: olcOverlay={0}allowed,olcDatabase={1}bdb,cn=config
  33 objectClass: olcOverlayConfig
  34 olcOverlay: {0}allowed
  35
  36 as a child of the database that's intended to support this feature
  37 (replace "olcDatabase={1}bdb,cn=config" with the appropriate parent);
  38 or use
  39
  40 dn: olcOverlay={0}allowed,olcDatabase={-1}frontend,cn=config
  41 objectClass: olcOverlayConfig
  42 olcOverlay: {0}allowed
  43
  44 if it's supposed to be global.
  45
  46     --- o --- o --- o ---
  47
  48 Use Makefile to compile this plugin or use a command line similar to:
  49
  50 gcc -shared -I../../../include -I../../../servers/slapd -Wall -g \
  51         -o allowed.so allowed.c
  52
  53 ---
  54 This work is part of OpenLDAP Software <http://www.openldap.org/>.
  55
  56 Copyright 2006-2018 The OpenLDAP Foundation. All rights reserved.
  57
  58 Redistribution and use in source and binary forms, with or without
  59 modification, are permitted only as authorized by the OpenLDAP
  60 Public License.
  61
  62 Redistribution and use in source and binary forms, with or without
  63 modification, are permitted only as authorized by the OpenLDAP
  64 Public License.
  65
  66 A copy of this license is available in the file LICENSE in the
  67 top-level directory of the distribution or, alternatively, at
  68 <http://www.OpenLDAP.org/license.html>.
  69
  70 ACKNOWLEDGEMENTS:
  71 This work was initially developed by Pierangelo Masarati for inclusion in
  72 OpenLDAP Software.
  73