1 .TH SLAPO-ACCESSLOG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 2005-2007 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapo-accesslog \- Access Logging overlay to slapd
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 be defined elsewhere in the configuration.
30 on the log database should prevent general 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.
99 suffix dc=example,dc=com
104 logold (objectclass=person)
111 by dn.base="cn=admin,dc=example,dc=com" read
117 overlay utilizes the "audit" schema described herein.
118 This schema is specifically designed for
120 auditing and is not intended to be used otherwise. It is also
121 noted that the schema described here is
124 and hence subject to change without notice.
125 The schema is loaded automatically by the overlay.
127 The schema includes a number of object classes and associated
128 attribute types as described below.
133 class from which two additional classes,
137 are derived. Object classes for each type of LDAP operation are further
138 derived from these classes. This object class hierarchy is designed to
139 allow flexible yet efficient searches of the log based on either a specific
140 operation type's class, or on more general classifications. The definition
146 ( 1.3.6.1.4.1.4203.666.11.5.2.1
148 DESC 'OpenLDAP request auditing'
150 MUST ( reqStart $ reqType $ reqSession )
151 MAY ( reqDN $ reqAuthzID $ reqControls $ reqRespControls $
152 reqEnd $ reqResult $ reqMessage $ reqReferral ) )
155 Note that all of the OIDs used in the logging schema currently reside
156 under the OpenLDAP Experimental branch. It is anticipated that they
157 will migrate to a Standard branch in the future.
159 An overview of the attributes follows:
163 provide the start and end time of the operation, respectively. They use
164 generalizedTime syntax. The
166 attribute is also used as the RDN for each log entry.
170 attribute is a simple string containing the type of operation
175 etc. For extended operations, the type also includes the OID of the
176 extended operation, e.g.
181 attribute is an implementation-specific identifier that is common to
182 all the operations associated with the same LDAP session. Currently this
183 is slapd's internal connection ID, stored in decimal.
187 attribute is the distinguishedName of the target of the operation. E.g., for
188 a Bind request, this is the Bind DN. For an Add request, this is the DN
189 of the entry being added. For a Search request, this is the base DN of
194 attribute is the distinguishedName of the user that performed the operation.
195 This will usually be the same name as was established at the start of a
196 session by a Bind request (if any) but may be altered in various
203 attributes carry any controls sent by the client on the request and returned
204 by the server in the response, respectively. The attribute values are just
205 uninterpreted octet strings.
209 attribute is the numeric LDAP result code of the operation, indicating
210 either success or a particular LDAP error code. An error code may be
211 accompanied by a text error message which will be recorded in the
217 attribute carries any referrals that were returned with the result of the
220 Operation-specific classes are defined with additional attributes to carry
221 all of the relevant parameters associated with the operation:
225 ( 1.3.6.1.4.1.4203.666.11.5.2.4
227 DESC 'Abandon operation'
228 SUP auditObject STRUCTURAL
236 attribute contains the message ID of the request that was abandoned.
240 ( 1.3.6.1.4.1.4203.666.11.5.2.5
243 SUP auditWriteObject STRUCTURAL
249 class inherits from the
251 class. The Add and Modify classes are very similar. The
253 attribute carries all of the attributes of the original entry being added.
254 (Or in the case of a Modify operation, all of the modifications being
255 performed.) The values are formatted as
259 attribute:<+|-|=|#> [ value]
263 Where '+' indicates an Add of a value, '-' for Delete, '=' for Replace,
264 and '#' for Increment. In an Add operation, all of the reqMod values will
265 have the '+' designator.
269 ( 1.3.6.1.4.1.4203.666.11.5.2.6
271 DESC 'Bind operation'
272 SUP auditObject STRUCTURAL
273 MUST ( reqVersion $ reqMethod ) )
280 attribute which contains the LDAP protocol version specified in the Bind
283 attribute which contains the Bind Method used in the Bind. This will be
286 for LDAP Simple Binds or
289 Note that unless configured as a global overlay, only Simple Binds using
290 DNs that reside in the current database will be logged.
294 ( 1.3.6.1.4.1.4203.666.11.5.2.7
296 DESC 'Compare operation'
297 SUP auditObject STRUCTURAL
305 attribute carries the Attribute Value Assertion used in the compare request.
309 ( 1.3.6.1.4.1.4203.666.11.5.2.8
311 DESC 'Delete operation'
312 SUP auditWriteObject STRUCTURAL
318 operation needs no further parameters. However, the
320 attribute may optionally be used to record the contents of the entry prior
321 to its deletion. The values are formatted as
330 attribute is only populated if the entry being deleted matches the
337 ( 1.3.6.1.4.1.4203.666.11.5.2.9
339 DESC 'Modify operation'
340 SUP auditWriteObject STRUCTURAL
341 MAY reqOld MUST reqMod )
346 operation contains a description of modifications in the
348 attribute, which was already described above in the Add operation. It may
349 optionally contain the previous contents of any modified attributes in the
351 attribute, using the same format as described above for the Delete operation.
354 attribute is only populated if the entry being modified matches the
361 ( 1.3.6.1.4.1.4203.666.11.5.2.10
363 DESC 'ModRDN operation'
364 SUP auditWriteObject STRUCTURAL
365 MUST ( reqNewRDN $ reqDeleteOldRDN )
366 MAY ( reqNewSuperior $ reqOld ) )
373 attribute to carry the new RDN of the request.
376 attribute is a Boolean value showing
378 if the old RDN was deleted from the entry, or
380 if the old RDN was preserved.
383 attribute carries the DN of the new parent entry if the request specified
387 attribute is only populated if the entry being modified matches the
390 filter and contains attributes in the
396 ( 1.3.6.1.4.1.4203.666.11.5.2.11
398 DESC 'Search operation'
399 SUP auditReadObject STRUCTURAL
400 MUST ( reqScope $ reqDerefAliases $ reqAttrsOnly )
401 MAY ( reqFilter $ reqAttr $ reqEntries $ reqSizeLimit $
409 attribute contains the scope of the original search request, using the
410 values specified for the LDAP URL format. I.e.
424 denoting how aliases will be processed during the search.
427 attribute is a Boolean value showing
429 if only attribute names were requested, or
431 if attributes and their values were requested.
434 attribute carries the filter used in the search request.
437 attribute lists the requested attributes if specific attributes were
441 attribute is the integer count of how many entries were returned by
447 attributes indicate what limits were requested on the search operation.
451 ( 1.3.6.1.4.1.4203.666.11.5.2.12
453 DESC 'Extended operation'
454 SUP auditObject STRUCTURAL
460 class represents an LDAP Extended Operation. As noted above, the actual OID of
461 the operation is included in the
463 attribute of the parent class. If any optional data was provided with the
464 request, it will be contained in the
466 attribute as an uninterpreted octet string.
469 The Access Log implemented by this overlay may be used for a variety of
470 other tasks, e.g. as a ChangeLog for a replication mechanism, as well
471 as for security/audit logging purposes.
476 default slapd configuration file
482 This module was written in 2005 by Howard Chu of Symas Corporation.
projects / openldap / blob