Home | History | Annotate | Line # | Download | only in emptyds 
      1 emptyds Overlay README
      2 
      3 DESCRIPTION
      4     This package contains an OpenLDAP overlay called "emptyds" (empty
      5     directory string) that eliminates empty values of type directory string
      6     (OID 1.3.6.1.4.1.1466.115.121.1.15) from the list of the values in the
      7     following manner:
      8     
      9     - add: All empty attribute values will be removed before the add request
     10       is executed
     11     - mod-replace: A replace with empty values will be modified to a replace
     12       without values. As result the attribute will be deleted
     13     - mod-add: All empty attribute values will be removed before the mod-add
     14       request is executed
     15     - mod-delete: All empty attribute values will be removed before the
     16       mod-delete request is executed
     17     
     18     If removing all empty values from a modification makes it a no-op, that
     19     modification is removed from the list.
     20     
     21     At module load time the emptyds overlay manipulates the syntax checking
     22     so that it intercepts the syntax check and allows empty values for
     23     attributes of type directory string only. Non-empty values continue to
     24     go through the normal check routines. It is therefore very important to
     25     configure the overlays in a way that ensures that the emptyds overlay gets
     26     the control over the operation before any other overlay. Otherwise it
     27     could come to the situation with empty attribute values in the data base.
     28     
     29     David Hawes' addpartial overlay has been used as starting point for this
     30     overlay.
     31      
     32 BUILDING
     33     A Makefile is included, please set your LDAP_SRC directory properly.
     34 
     35 INSTALLATION
     36     After compiling the emptyds overlay, add the following to your
     37     slapd.conf:
     38 
     39     ### slapd.conf
     40     ...
     41     moduleload emptyds.la
     42     ...
     43     overlay emptyds
     44     ...
     45     # before database directive...
     46     # this overlay must be the last overlay in the config file to ensure that
     47     # requests are modified before other overlays get them.
     48     ...
     49     ### end slapd.conf
     50 
     51 CAVEATS
     52     - In order to ensure that emptyds does what it needs to do, it must be
     53       the last overlay configured so it will run before the other overlays.
     54 
     55 ---
     56 Copyright 2014-2024 The OpenLDAP Foundation.
     57 Portions Copyright (C) DAASI International GmbH, Tamim Ziai.
     58 All rights reserved.
     59 
     60 Redistribution and use in source and binary forms, with or without
     61 modification, are permitted only as authorized by the OpenLDAP
     62 Public License.
     63 
     64 A copy of this license is available in file LICENSE in the
     65 top-level directory of the distribution or, alternatively, at
     66 http://www.OpenLDAP.org/license.html.
     67