1 .TH SLAPO-ACCESSLOG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 2005-2006 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapo-accesslog \- Access Logging overlay
10 The Access Logging overlay can be used to record all accesses to a given
11 backend database on another database. This allows all of the activity on
12 a given database to be reviewed using arbitrary LDAP queries, instead of
13 just logging to local flat text files. Configuration options are available
14 for selecting a subset of operation types to log, and to automatically
15 prune older log records from the logging database. Log records are stored
16 with audit schema (see below) to assure their readability whether viewed
17 as LDIF or in raw form.
21 options apply to the Access Logging overlay.
22 They should appear after the
27 Specify the suffix of a database to be used for storing the log records.
28 The specified database must have already been configured in a prior section
29 of the config file. The suffix entry of the log database will be created
30 automatically by this overlay. The log entries will be generated as the
31 immediate children of the suffix entry.
33 .B logops <operations>
34 Specify which types of operations to log. The valid operation types are
35 abandon, add, bind, compare, delete, extended, modify, modrdn, search,
36 and unbind. Aliases for common sets of operations are also available:
40 add, delete, modify, modrdn
53 Specify a filter for matching against Deleted and Modified entries. If
54 the entry matches the filter, the old contents of the entry will be
55 logged along with the current request.
57 .B logoldattr <attr> ...
58 Specify a list of attributes whose old contents are always logged in
59 Modify and ModRDN requests. Usually only the contents of attributes that were
60 actually modified will be logged; by default no old attributes are logged
63 .B logpurge <age> <interval>
64 Specify the maximum age for log entries to be retained in the database,
65 and how often to scan the database for old entries. Both the
69 are specified as a time span in days, hours, minutes, and seconds. The
70 time format is [ddd+]hh:mm[:ss] i.e., the days and seconds components are
71 optional but hours and minutes are required. Except for days, which can
72 be up to 5 digits, each numeric field must be exactly two digits. For example
77 logpurge 2+00:00 1+00:00
80 would specify that the log database should be scanned every day for old
81 entries, and entries older than two days should be deleted. When using a
82 log database that supports ordered indexing on generalizedTime attributes,
83 specifying an eq index on the
85 attribute will greatly benefit the performance of the purge operation.
88 .B logsuccess TRUE | FALSE
89 If set to TRUE then log records will only be generated for successful
90 requests, i.e., requests that produce a result code of 0 (LDAP_SUCCESS).
91 If FALSE, log records are generated for all requests whether they
92 succeed or not. The default is FALSE.
103 suffix dc=example,dc=com
108 logold (objectclass=person)
114 overlay utilizes the "audit" schema described herein.
115 This schema is specifically designed for
117 auditing and is not intended to be used otherwise. It is also
118 noted that the schema described here is
121 and hence subject to change without notice.
122 The schema is loaded automatically by the overlay.
124 The schema includes a number of object classes and associated
125 attribute types as described below.
130 class from which two additional classes,
134 are derived. Object classes for each type of LDAP operation are further
135 derived from these classes. This object class hierarchy is designed to
136 allow flexible yet efficient searches of the log based on either a specific
137 operation type's class, or on more general classifications. The definition
143 ( 1.3.6.1.4.1.4203.666.11.5.2.1
145 DESC 'OpenLDAP request auditing'
147 MUST ( reqStart $ reqType $ reqSession )
148 MAY ( reqDN $ reqAuthzID $ reqControls $ reqRespControls $
149 reqEnd $ reqResult $ reqMessage $ reqReferral ) )
152 Note that all of the OIDs used in the logging schema currently reside
153 under the OpenLDAP Experimental branch. It is anticipated that they
154 will migrate to a Standard branch in the future.
156 An overview of the attributes follows:
160 provide the start and end time of the operation, respectively. They use
161 generalizedTime syntax. The
163 attribute is also used as the RDN for each log entry.
167 attribute is a simple string containing the type of operation
172 etc. For extended operations, the type also includes the OID of the
173 extended operation, e.g.
178 attribute is an implementation-specific identifier that is common to
179 all the operations associated with the same LDAP session. Currently this
180 is slapd's internal connection ID, stored in decimal.
184 attribute is the distinguishedName of the target of the operation. E.g., for
185 a Bind request, this is the Bind DN. For an Add request, this is the DN
186 of the entry being added. For a Search request, this is the base DN of
191 attribute is the distinguishedName of the user that performed the operation.
192 This will usually be the same name as was established at the start of a
193 session by a Bind request (if any) but may be altered in various
200 attributes carry any controls sent by the client on the request and returned
201 by the server in the response, respectively. The attribute values are just
202 uninterpreted octet strings.
206 attribute is the numeric LDAP result code of the operation, indicating
207 either success or a particular LDAP error code. An error code may be
208 accompanied by a text error message which will be recorded in the
214 attribute carries any referrals that were returned with the result of the
217 Operation-specific classes are defined with additional attributes to carry
218 all of the relevant parameters associated with the operation:
222 ( 1.3.6.1.4.1.4203.666.11.5.2.4
224 DESC 'Abandon operation'
225 SUP auditObject STRUCTURAL
233 attribute contains the message ID of the request that was abandoned.
237 ( 1.3.6.1.4.1.4203.666.11.5.2.5
240 SUP auditWriteObject STRUCTURAL
246 class inherits from the
248 class. The Add and Modify classes are very similar. The
250 attribute carries all of the attributes of the original entry being added.
251 (Or in the case of a Modify operation, all of the modifications being
252 performed.) The values are formatted as
256 attribute:<+|-|=|#> [ value]
260 Where '+' indicates an Add of a value, '-' for Delete, '=' for Replace,
261 and '#' for Increment. In an Add operation, all of the reqMod values will
262 have the '+' designator.
266 ( 1.3.6.1.4.1.4203.666.11.5.2.6
268 DESC 'Bind operation'
269 SUP auditObject STRUCTURAL
270 MUST ( reqVersion $ reqMethod ) )
277 attribute which contains the LDAP protocol version specified in the Bind
280 attribute which contains the Bind Method used in the Bind. This will be
283 for LDAP Simple Binds or
286 Note that unless configured as a global overlay, only Simple Binds using
287 DNs that reside in the current database will be logged.
291 ( 1.3.6.1.4.1.4203.666.11.5.2.7
293 DESC 'Compare operation'
294 SUP auditObject STRUCTURAL
302 attribute carries the Attribute Value Assertion used in the compare request.
306 ( 1.3.6.1.4.1.4203.666.11.5.2.8
308 DESC 'Delete operation'
309 SUP auditWriteObject STRUCTURAL
315 operation needs no further parameters. However, the
317 attribute may optionally be used to record the contents of the entry prior
318 to its deletion. The values are formatted as
327 attribute is only populated if the entry being deleted matches the
334 ( 1.3.6.1.4.1.4203.666.11.5.2.9
336 DESC 'Modify operation'
337 SUP auditWriteObject STRUCTURAL
338 MAY reqOld MUST reqMod )
343 operation contains a description of modifications in the
345 attribute, which was already described above in the Add operation. It may
346 optionally contain the previous contents of any modified attributes in the
348 attribute, using the same format as described above for the Delete operation.
351 attribute is only populated if the entry being modified matches the
358 ( 1.3.6.1.4.1.4203.666.11.5.2.10
360 DESC 'ModRDN operation'
361 SUP auditWriteObject STRUCTURAL
362 MUST ( reqNewRDN $ reqDeleteOldRDN )
363 MAY ( reqNewSuperior $ reqOld ) )
370 attribute to carry the new RDN of the request.
373 attribute is a Boolean value showing
375 if the old RDN was deleted from the entry, or
377 if the old RDN was preserved.
380 attribute carries the DN of the new parent entry if the request specified
384 attribute is only populated if the entry being modified matches the
387 filter and contains attributes in the
393 ( 1.3.6.1.4.1.4203.666.11.5.2.11
395 DESC 'Search operation'
396 SUP auditReadObject STRUCTURAL
397 MUST ( reqScope $ reqDerefAliases $ reqAttrsOnly )
398 MAY ( reqFilter $ reqAttr $ reqEntries $ reqSizeLimit $
406 attribute contains the scope of the original search request, using the
407 values specified for the LDAP URL format. I.e.
421 denoting how aliases will be processed during the search.
424 attribute is a Boolean value showing
426 if only attribute names were requested, or
428 if attributes and their values were requested.
431 attribute carries the filter used in the search request.
434 attribute lists the requested attributes if specific attributes were
438 attribute is the integer count of how many entries were returned by
444 attributes indicate what limits were requested on the search operation.
448 ( 1.3.6.1.4.1.4203.666.11.5.2.12
450 DESC 'Extended operation'
451 SUP auditObject STRUCTURAL
457 class represents an LDAP Extended Operation. As noted above, the actual OID of
458 the operation is included in the
460 attribute of the parent class. If any optional data was provided with the
461 request, it will be contained in the
463 attribute as an uninterpreted octet string.
466 The Access Log implemented by this overlay may be used for a variety of
467 other tasks, e.g. as a ChangeLog for a replication mechanism, as well
468 as for security/audit logging purposes.
473 default slapd configuration file
479 This module was written in 2005 by Howard Chu of Symas Corporation.
projects / openldap / blob