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 logpurge <age> <interval>
58 Specify the maximum age for log entries to be retained in the database,
59 and how often to scan the database for old entries. Both the
63 are specified as a time span in days, hours, minutes, and seconds. The
64 time format is [ddd+]hh:mm[:ss] i.e., the days and seconds components are
65 optional but hours and minutes are required. Except for days, which can
66 be up to 5 digits, each numeric field must be exactly two digits. For example
71 logpurge 2+00:00 1+00:00
74 would specify that the log database should be scanned every day for old
75 entries, and entries older than two days should be deleted. When using a
76 log database that supports ordered indexing on generalizedTime attributes,
77 specifying an eq index on the
79 attribute will greatly benefit the performance of the purge operation.
82 .B logsuccess TRUE | FALSE
83 If set to TRUE then log records will only be generated for successful
84 requests, i.e., requests that produce a result code of 0 (LDAP_SUCCESS).
85 If FALSE, log records are generated for all requests whether they
86 succeed or not. The default is FALSE.
97 suffix dc=example,dc=com
102 logold (objectclass=person)
108 overlay utilizes the "audit" schema described herein.
109 This schema is specifically designed for
111 auditing and is not intended to be used otherwise. It is also
112 noted that the schema describe here is
115 and hence subject to change without notice.
116 The schema is loaded automatically by the overlay.
118 The schema includes a number of object classes and associated
119 attribute types as described below.
124 class from which two additional classes,
128 are derived. Object classes for each type of LDAP operation are further
129 derived from these classes. This object class hierarchy is designed to
130 allow flexible yet efficient searches of the log based on either a specific
131 operation type's class, or on more general classifications. The definition
137 ( 1.3.6.1.4.1.4203.666.11.5.2.1
139 DESC 'OpenLDAP request auditing'
141 MUST ( reqStart $ reqType $ reqSession )
142 MAY ( reqDN $ reqAuthzID $ reqControls $ reqRespControls $
143 reqEnd $ reqResult $ reqMessage $ reqReferral ) )
146 Note that all of the OIDs used in the logging schema currently reside
147 under the OpenLDAP Experimental branch. It is anticipated that they
148 will migrate to a Standard branch in the future.
150 An overview of the attributes follows:
154 provide the start and end time of the operation, respectively. They use
155 generalizedTime syntax. The
157 attribute is also used as the RDN for each log entry.
161 attribute is a simple string containing the type of operation
166 etc. For extended operations, the type also includes the OID of the
167 extended operation, e.g.
172 attribute is an implementation-specific identifier that is common to
173 all the operations associated with the same LDAP session. Currently this
174 is slapd's internal connection ID, stored in decimal.
178 attribute is the distinguishedName of the target of the operation. E.g., for
179 a Bind request, this is the Bind DN. For an Add request, this is the DN
180 of the entry being added. For a Search request, this is the base DN of
185 attribute is the distinguishedName of the user that performed the operation.
186 This will usually be the same name as was established at the start of a
187 session by a Bind request (if any) but may be altered in various
194 attributes carry any controls sent by the client on the request and returned
195 by the server in the response, respectively. The attribute values are just
196 uninterpreted octet strings.
200 attribute is the numeric LDAP result code of the operation, indicating
201 either success or a particular LDAP error code. An error code may be
202 accompanied by a text error message which will be recorded in the
208 attribute carries any referrals that were returned with the result of the
211 Operation-specific classes are defined with additional attributes to carry
212 all of the relevant parameters associated with the operation:
216 ( 1.3.6.1.4.1.4203.666.11.5.2.4
218 DESC 'Abandon operation'
219 SUP auditObject STRUCTURAL
227 attribute contains the message ID of the request that was abandoned.
231 ( 1.3.6.1.4.1.4203.666.11.5.2.5
234 SUP auditWriteObject STRUCTURAL
240 class inherits from the
242 class. The Add and Modify classes are very similar. The
244 attribute carries all of the attributes of the original entry being added.
245 (Or in the case of a Modify operation, all of the modifications being
246 performed.) The values are formatted as
250 attribute:<+|-|=|#> [ value]
254 Where '+' indicates an Add of a value, '-' for Delete, '=' for Replace,
255 and '#' for Increment. In an Add operation, all of the reqMod values will
256 have the '+' designator.
260 ( 1.3.6.1.4.1.4203.666.11.5.2.6
262 DESC 'Bind operation'
263 SUP auditObject STRUCTURAL
264 MUST ( reqVersion $ reqMethod ) )
271 attribute which contains the LDAP protocol version specified in the Bind
274 attribute which contains the Bind Method used in the Bind. This will be
277 for LDAP Simple Binds or
280 Note that unless configured as a global overlay, only Simple Binds using
281 DNs that reside in the current database will be logged.
285 ( 1.3.6.1.4.1.4203.666.11.5.2.7
287 DESC 'Compare operation'
288 SUP auditObject STRUCTURAL
296 attribute carries the Attribute Value Assertion used in the compare request.
300 ( 1.3.6.1.4.1.4203.666.11.5.2.8
302 DESC 'Delete operation'
303 SUP auditWriteObject STRUCTURAL
309 operation needs no further parameters. However, the
311 attribute may optionally be used to record the contents of the entry prior
312 to its deletion. The values are formatted as
321 attribute is only populated if the entry being deleted matches the
328 ( 1.3.6.1.4.1.4203.666.11.5.2.9
330 DESC 'Modify operation'
331 SUP auditWriteObject STRUCTURAL
332 MAY reqOld MUST reqMod )
337 operation contains a description of modifications in the
339 attribute, which was already described above in the Add operation. It may
340 optionally contain the previous contents of any modified attributes in the
342 attribute, using the same format as described above for the Delete operation.
345 attribute is only populated if the entry being modified matches the
352 ( 1.3.6.1.4.1.4203.666.11.5.2.10
354 DESC 'ModRDN operation'
355 SUP auditWriteObject STRUCTURAL
356 MUST ( reqNewRDN $ reqDeleteOldRDN )
364 attribute to carry the new RDN of the request.
367 attribute is a Boolean value showing
369 if the old RDN was deleted from the entry, or
371 if the old RDN was preserved.
374 attribute carries the DN of the new parent entry if the request specified
379 ( 1.3.6.1.4.1.4203.666.11.5.2.11
381 DESC 'Search operation'
382 SUP auditReadObject STRUCTURAL
383 MUST ( reqScope $ reqDerefAliases $ reqAttrsOnly )
384 MAY ( reqFilter $ reqAttr $ reqEntries $ reqSizeLimit $
392 attribute contains the scope of the original search request, using the
393 values specified for the LDAP URL format. I.e.
407 denoting how aliases will be processed during the search.
410 attribute is a Boolean value showing
412 if only attribute names were requested, or
414 if attributes and their values were requested.
417 attribute carries the filter used in the search request.
420 attribute lists the requested attributes if specific attributes were
424 attribute is the integer count of how many entries were returned by
430 attributes indicate what limits were requested on the search operation.
434 ( 1.3.6.1.4.1.4203.666.11.5.2.12
436 DESC 'Extended operation'
437 SUP auditObject STRUCTURAL
443 class represents an LDAP Extended Operation. As noted above, the actual OID of
444 the operation is included in the
446 attribute of the parent class. If any optional data was provided with the
447 request, it will be contained in the
449 attribute as an uninterpreted octet string.
452 The Access Log implemented by this overlay may be used for a variety of
453 other tasks, e.g. as a ChangeLog for a replication mechanism, as well
454 as for security/audit logging purposes.
459 default slapd configuration file
465 This module was written in 2005 by Howard Chu of Symas Corporation.
projects / openldap / blob