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