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, and it must have a rootDN configured. The access controls
30 on the log database should prevent general write access. The suffix entry
31 of the log database will be created automatically by this overlay. The log
32 entries will be generated as the immediate children of the suffix entry.
34 .B logops <operations>
35 Specify which types of operations to log. The valid operation types are
36 abandon, add, bind, compare, delete, extended, modify, modrdn, search,
37 and unbind. Aliases for common sets of operations are also available:
41 add, delete, modify, modrdn
54 Specify a filter for matching against Deleted and Modified entries. If
55 the entry matches the filter, the old contents of the entry will be
56 logged along with the current request.
58 .B logoldattr <attr> ...
59 Specify a list of attributes whose old contents are always logged in
60 Modify and ModRDN requests. Usually only the contents of attributes that were
61 actually modified will be logged; by default no old attributes are logged
64 .B logpurge <age> <interval>
65 Specify the maximum age for log entries to be retained in the database,
66 and how often to scan the database for old entries. Both the
70 are specified as a time span in days, hours, minutes, and seconds. The
71 time format is [ddd+]hh:mm[:ss] i.e., the days and seconds components are
72 optional but hours and minutes are required. Except for days, which can
73 be up to 5 digits, each numeric field must be exactly two digits. For example
78 logpurge 2+00:00 1+00:00
81 would specify that the log database should be scanned every day for old
82 entries, and entries older than two days should be deleted. When using a
83 log database that supports ordered indexing on generalizedTime attributes,
84 specifying an eq index on the
86 attribute will greatly benefit the performance of the purge operation.
89 .B logsuccess TRUE | FALSE
90 If set to TRUE then log records will only be generated for successful
91 requests, i.e., requests that produce a result code of 0 (LDAP_SUCCESS).
92 If FALSE, log records are generated for all requests whether they
93 succeed or not. The default is FALSE.
104 suffix dc=example,dc=com
109 logold (objectclass=person)
115 overlay utilizes the "audit" schema described herein.
116 This schema is specifically designed for
118 auditing and is not intended to be used otherwise. It is also
119 noted that the schema described here is
122 and hence subject to change without notice.
123 The schema is loaded automatically by the overlay.
125 The schema includes a number of object classes and associated
126 attribute types as described below.
131 class from which two additional classes,
135 are derived. Object classes for each type of LDAP operation are further
136 derived from these classes. This object class hierarchy is designed to
137 allow flexible yet efficient searches of the log based on either a specific
138 operation type's class, or on more general classifications. The definition
144 ( 1.3.6.1.4.1.4203.666.11.5.2.1
146 DESC 'OpenLDAP request auditing'
148 MUST ( reqStart $ reqType $ reqSession )
149 MAY ( reqDN $ reqAuthzID $ reqControls $ reqRespControls $
150 reqEnd $ reqResult $ reqMessage $ reqReferral ) )
153 Note that all of the OIDs used in the logging schema currently reside
154 under the OpenLDAP Experimental branch. It is anticipated that they
155 will migrate to a Standard branch in the future.
157 An overview of the attributes follows:
161 provide the start and end time of the operation, respectively. They use
162 generalizedTime syntax. The
164 attribute is also used as the RDN for each log entry.
168 attribute is a simple string containing the type of operation
173 etc. For extended operations, the type also includes the OID of the
174 extended operation, e.g.
179 attribute is an implementation-specific identifier that is common to
180 all the operations associated with the same LDAP session. Currently this
181 is slapd's internal connection ID, stored in decimal.
185 attribute is the distinguishedName of the target of the operation. E.g., for
186 a Bind request, this is the Bind DN. For an Add request, this is the DN
187 of the entry being added. For a Search request, this is the base DN of
192 attribute is the distinguishedName of the user that performed the operation.
193 This will usually be the same name as was established at the start of a
194 session by a Bind request (if any) but may be altered in various
201 attributes carry any controls sent by the client on the request and returned
202 by the server in the response, respectively. The attribute values are just
203 uninterpreted octet strings.
207 attribute is the numeric LDAP result code of the operation, indicating
208 either success or a particular LDAP error code. An error code may be
209 accompanied by a text error message which will be recorded in the
215 attribute carries any referrals that were returned with the result of the
218 Operation-specific classes are defined with additional attributes to carry
219 all of the relevant parameters associated with the operation:
223 ( 1.3.6.1.4.1.4203.666.11.5.2.4
225 DESC 'Abandon operation'
226 SUP auditObject STRUCTURAL
234 attribute contains the message ID of the request that was abandoned.
238 ( 1.3.6.1.4.1.4203.666.11.5.2.5
241 SUP auditWriteObject STRUCTURAL
247 class inherits from the
249 class. The Add and Modify classes are very similar. The
251 attribute carries all of the attributes of the original entry being added.
252 (Or in the case of a Modify operation, all of the modifications being
253 performed.) The values are formatted as
257 attribute:<+|-|=|#> [ value]
261 Where '+' indicates an Add of a value, '-' for Delete, '=' for Replace,
262 and '#' for Increment. In an Add operation, all of the reqMod values will
263 have the '+' designator.
267 ( 1.3.6.1.4.1.4203.666.11.5.2.6
269 DESC 'Bind operation'
270 SUP auditObject STRUCTURAL
271 MUST ( reqVersion $ reqMethod ) )
278 attribute which contains the LDAP protocol version specified in the Bind
281 attribute which contains the Bind Method used in the Bind. This will be
284 for LDAP Simple Binds or
287 Note that unless configured as a global overlay, only Simple Binds using
288 DNs that reside in the current database will be logged.
292 ( 1.3.6.1.4.1.4203.666.11.5.2.7
294 DESC 'Compare operation'
295 SUP auditObject STRUCTURAL
303 attribute carries the Attribute Value Assertion used in the compare request.
307 ( 1.3.6.1.4.1.4203.666.11.5.2.8
309 DESC 'Delete operation'
310 SUP auditWriteObject STRUCTURAL
316 operation needs no further parameters. However, the
318 attribute may optionally be used to record the contents of the entry prior
319 to its deletion. The values are formatted as
328 attribute is only populated if the entry being deleted matches the
335 ( 1.3.6.1.4.1.4203.666.11.5.2.9
337 DESC 'Modify operation'
338 SUP auditWriteObject STRUCTURAL
339 MAY reqOld MUST reqMod )
344 operation contains a description of modifications in the
346 attribute, which was already described above in the Add operation. It may
347 optionally contain the previous contents of any modified attributes in the
349 attribute, using the same format as described above for the Delete operation.
352 attribute is only populated if the entry being modified matches the
359 ( 1.3.6.1.4.1.4203.666.11.5.2.10
361 DESC 'ModRDN operation'
362 SUP auditWriteObject STRUCTURAL
363 MUST ( reqNewRDN $ reqDeleteOldRDN )
364 MAY ( reqNewSuperior $ reqOld ) )
371 attribute to carry the new RDN of the request.
374 attribute is a Boolean value showing
376 if the old RDN was deleted from the entry, or
378 if the old RDN was preserved.
381 attribute carries the DN of the new parent entry if the request specified
385 attribute is only populated if the entry being modified matches the
388 filter and contains attributes in the
394 ( 1.3.6.1.4.1.4203.666.11.5.2.11
396 DESC 'Search operation'
397 SUP auditReadObject STRUCTURAL
398 MUST ( reqScope $ reqDerefAliases $ reqAttrsOnly )
399 MAY ( reqFilter $ reqAttr $ reqEntries $ reqSizeLimit $
407 attribute contains the scope of the original search request, using the
408 values specified for the LDAP URL format. I.e.
422 denoting how aliases will be processed during the search.
425 attribute is a Boolean value showing
427 if only attribute names were requested, or
429 if attributes and their values were requested.
432 attribute carries the filter used in the search request.
435 attribute lists the requested attributes if specific attributes were
439 attribute is the integer count of how many entries were returned by
445 attributes indicate what limits were requested on the search operation.
449 ( 1.3.6.1.4.1.4203.666.11.5.2.12
451 DESC 'Extended operation'
452 SUP auditObject STRUCTURAL
458 class represents an LDAP Extended Operation. As noted above, the actual OID of
459 the operation is included in the
461 attribute of the parent class. If any optional data was provided with the
462 request, it will be contained in the
464 attribute as an uninterpreted octet string.
467 The Access Log implemented by this overlay may be used for a variety of
468 other tasks, e.g. as a ChangeLog for a replication mechanism, as well
469 as for security/audit logging purposes.
474 default slapd configuration file
480 This module was written in 2005 by Howard Chu of Symas Corporation.
projects / openldap / blob