git.sur5r.net Git - openldap/blob - contrib/slapd-modules/cloak/slapo-cloak.5

   1 .TH SLAPO-CLOAK 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 1998-2017 The OpenLDAP Foundation, All Rights Reserved.
   3 .\" Copying restrictions apply.  See the COPYRIGHT file.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo-cloak \- Attribute cloak overlay to slapd
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The
  11 .B cloak
  12 overlay to
  13 .BR slapd (8)
  14 allows the server to hide specific attributes, unless explicitly requested
  15 by the client. This improve performance when a client requests all attributes
  16 and get a huge binary attribute that is of no interest for it.
  17 This behavior is disabled when the \fImanageDSAit\fP
  18 control (RFC 3296) is used.
  19
  20 .SH CONFIGURATION
  21 The config directives that are specific to the
  22 .B cloak
  23 overlay must be prefixed by
  24 .BR cloak\- ,
  25 to avoid potential conflicts with directives specific to the underlying
  26 database or to other stacked overlays.
  27
  28 .TP
  29 .B overlay cloak
  30 This directive adds the cloak overlay to the current database,
  31 or to the frontend, if used before any database instantiation; see
  32 .BR slapd.conf (5)
  33 for details.
  34
  35 .LP
  36 This
  37 .B slapd.conf
  38 configuration option is defined for the cloak overlay. It may have multiple
  39 occurrences, and it must appear after the
  40 .B overlay
  41 directive:
  42 .TP
  43 .B cloak-attr <attribute> [<class>]
  44 The value
  45 .B <attribute>
  46 is the name of the attribute that will be cloaked.
  47
  48 The optional
  49 .B <class>
  50 restricts cloaking only to entries of the named
  51 .B <class>.
  52
  53 .SH EXAMPLE
  54 This example hide the
  55 .B jpegPhoto
  56 attribute. Add the following to slapd.conf:
  57
  58 .LP
  59 .nf
  60     database <database>
  61     # ...
  62
  63     overlay cloak
  64     cloak-attr jpegPhoto
  65 .fi
  66 .LP
  67 and that slapd loads cloak.la, if compiled as a run-time module;
  68
  69 .SH FILES
  70 .TP
  71 ETCDIR/slapd.conf
  72 default slapd configuration file
  73 .SH SEE ALSO
  74 .BR slapd.conf (5),
  75 .BR slapd (8).
  76 The
  77 .BR slapo-cloak (5)
  78 overlay supports dynamic configuration via
  79 .BR back-config .
  80 .SH ACKNOWLEDGEMENTS
  81 .P
  82 This module was originally written in 2008 by Emmanuel Dreyfus.