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

   1 .TH SLAPO-LASTBIND 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2009 Jonathan Clarke, All Rights Reserved.
   3 .\" $OpenLDAP$
   4 .SH NAME
   5 slapo-lastbind \- lastbind overlay to slapd
   6 .SH SYNOPSIS
   7 ETCDIR/slapd.conf
   8 .SH DESCRIPTION
   9 The
  10 .B lastbind
  11 overlay to
  12 .BR slapd (8)
  13 allows recording the timestamp of the last successful bind to entries
  14 in the directory, in the
  15 .B authTimestamp
  16 attribute.
  17 The overlay can be configured to update this timestamp only if it is
  18 older than a given value, thus avoiding large numbers of write
  19 operations penalizing performance.
  20 One sample use for this overlay would be to detect unused accounts.
  21
  22 .SH CONFIGURATION
  23 The config directives that are specific to the
  24 .B lastbind
  25 overlay must be prefixed by
  26 .BR lastbind\- ,
  27 to avoid potential conflicts with directives specific to the underlying
  28 database or to other stacked overlays.
  29
  30 .TP
  31 .B overlay lastbind
  32 This directive adds the
  33 .B lastbind
  34 overlay to the current database, see
  35 .BR slapd.conf (5)
  36 for details.
  37
  38 .LP
  39 This
  40 .B slapd.conf
  41 configuration option is defined for the lastbind overlay. It must
  42 appear after the
  43 .B overlay
  44 directive:
  45 .TP
  46 .B lastbind-precision <seconds>
  47 The value
  48 .B <seconds>
  49 is the number of seconds after which to update the
  50 .B authTimestamp
  51 attribute in an entry. If the existing value of
  52 .B authTimestamp
  53 is less than
  54 .B <seconds>
  55 old, it will not be changed.
  56 If this configuration option is omitted, the
  57 .B authTimestamp
  58 attribute is updated on each successful bind operation.
  59 .TP
  60 .B lastbind_forward_updates
  61 Specify that updates of the authTimestamp attribute
  62 on a consumer should be forwarded
  63 to a master instead of being written directly into the consumer's local
  64 database. This setting is only useful on a replication consumer, and
  65 also requires the
  66 .B updateref
  67 setting and
  68 .B chain
  69 overlay to be appropriately configured.
  70
  71 .SH EXAMPLE
  72 This example configures the
  73 .B lastbind
  74 overlay to store
  75 .B authTimestamp
  76 in all entries in a database, with a 1 week precision.
  77 Add the following to
  78 .BR slapd.conf (5):
  79
  80 .LP
  81 .nf
  82     database <database>
  83     # ...
  84
  85     overlay lastbind
  86     lastbind-precision 604800
  87 .fi
  88 .LP
  89 .B slapd
  90 must also load
  91 .B lastbind.la,
  92 if compiled as a run-time module;
  93
  94 .SH FILES
  95 .TP
  96 ETCDIR/slapd.conf
  97 default slapd configuration file
  98 .SH SEE ALSO
  99 .BR slapd.conf (5),
 100 .BR slapd (8).
 101 The
 102 .BR slapo-lastbind (5)
 103 overlay supports dynamic configuration via
 104 .BR back-config.
 105 .SH ACKNOWLEDGEMENTS
 106 .P
 107 This module was written in 2009 by Jonathan Clarke. It is loosely
 108 derived from the password policy overlay.