1 .TH SLAPO-ACCESSLOG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 2005 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 a custom schema to assure their readability whether viewed as LDIF
21 options apply to the Access Logging overlay.
22 They should appear after the
24 directive and before any subsequent
29 Specify the suffix of a database to be used for storing the log records.
30 The specified database must have already been configured in a prior section
31 of the config file. The suffix entry of the database must also already
32 exist. The log entries will be generated as the immediate children of the
35 .B logops <operations>
36 Specify which types of operations to log. The valid operation types are
37 abandon, add, bind, compare, delete, extended, modify, modrdn, search,
38 and unbind. Aliases for common sets of operations are also available:
42 add, delete, modify, modrdn
54 .B logpurge <age> <interval>
55 Specify the maximum age for log entries to be retained in the database,
56 and how often to scan the database for old entries. Both the
60 are specified as a time span in days, hours, minutes, and seconds. The
61 time format is [ddd+]hh:mm[:ss] i.e., the days and seconds components are
62 optional but hours and minutes are required. Except for days, which can
63 be up to 5 digits, each numeric field must be exactly two digits. For example
68 logpurge 2+00:00 1+00:00
71 would specify that the log database should be scanned every day for old
72 entries, and entries older than two days should be deleted. When using a
73 log database that supports ordered indexing on generalizedTime attributes,
74 specifying an eq index on the
76 attribute will greatly benefit the performance of the purge operation.
78 .B logsuccess TRUE | FALSE
79 If set to TRUE then log records will only be generated for successful
80 requests, i.e., requests that produce a result code of 0 (LDAP_SUCCESS).
81 If FALSE, log records are generated for all requests whether they
82 succeed or not. The default is FALSE.
93 suffix dc=example,dc=com
103 overlay defines a number of object classes for use in the logs. There is
106 class from which two additional classes,
110 are derived. Object classes for each type of LDAP operation are further
111 derived from these classes. This object class hierarchy is designed to
112 allow flexible yet efficient searches of the log based on either a specific
113 operation type's class, or on more general classifications. The definition
119 ( 1.3.6.1.4.1.4203.666.11.5.2.1
121 DESC 'OpenLDAP request auditing'
123 MUST ( reqStart $ reqType $ reqSession )
124 MAY ( reqDN $ reqAuthzID $ reqControls $ reqRespControls $
125 reqEnd $ reqResult $ reqMessage $ reqReferral ) )
128 Note that all of the OIDs used in the logging schema currently reside
129 under the OpenLDAP Experimental branch. It is anticipated that they
130 will migrate to a Standard branch in the future.
132 An overview of the attributes follows:
136 provide the start and end time of the operation, respectively. They use
137 generalizedTime syntax. The
139 attribute is also used as the RDN for each log entry.
143 attribute is a simple string containing the type of operation
148 etc. For extended operations, the type also includes the OID of the
149 extended operation, e.g.
150 .B extended(1.2.3.4.1)
154 attribute is an implementation-specific identifier that is common to
155 all the operations associated with the same LDAP session. Currently this
156 is slapd's internal connection ID, stored in decimal.
160 attribute is the distinguishedName of the target of the operation. E.g., for
161 a Bind request, this is the Bind DN. For an Add request, this is the DN
162 of the entry being added. For a Search request, this is the base DN of
167 attribute is the distinguishedName of the user that performed the operation.
168 This will usually be the same name as was established at the start of a
169 session by a Bind request (if any) but may be altered in various
176 attributes carry any controls sent by the client on the request and returned
177 by the server in the response, respectively. The attribute values are just
178 uninterpreted octet strings.
182 attribute is the numeric LDAP result code of the operation, indicating
183 either success or a particular LDAP error code. An error code may be
184 accompanied by a text error message which will be recorded in the
190 attribute carries any referrals that were returned with the result of the
193 Operation-specific classes are defined with additional attributes to carry
194 all of the relevant parameters associated with the operation:
198 ( 1.3.6.1.4.1.4203.666.11.5.2.4
200 DESC 'Abandon operation'
201 SUP auditObject STRUCTURAL
209 attribute contains the message ID of the request that was abandoned.
213 ( 1.3.6.1.4.1.4203.666.11.5.2.5
216 SUP auditWriteObject STRUCTURAL
222 class inherits from the
224 class. The Add and Modify classes are very similar. The
226 attribute carries all of the attributes of the original entry being added.
227 (Or in the case of a Modify operation, all of the modifications being
228 performed.) The values are formatted as
233 attribute:<+|-|=|#> [ value]
236 Where '+' indicates an Add of a value, '-' for Delete, '=' for Replace,
237 and '#' for Increment. In an Add operation, all of the reqMod values will
238 have the '+' designator.
244 ( 1.3.6.1.4.1.4203.666.11.5.2.6
246 DESC 'Bind operation'
247 SUP auditObject STRUCTURAL
248 MUST ( reqVersion $ reqMethod ) )
255 attribute which contains the LDAP protocol version specified in the Bind
258 attribute which contains the Bind Method used in the Bind. This will be
261 for LDAP Simple Binds or
264 Note that unless configured as a global overlay, only Simple Binds using
265 DNs that reside in the current database will be logged.
269 ( 1.3.6.1.4.1.4203.666.11.5.2.7
271 DESC 'Compare operation'
272 SUP auditObject STRUCTURAL
280 attribute carries the Attribute Value Assertion used in the compare request.
284 ( 1.3.6.1.4.1.4203.666.11.5.2.8
286 DESC 'Delete operation'
287 SUP auditWriteObject STRUCTURAL
293 operation needs no further parameters. However, the
295 attribute may optionally be used to record the contents of the entry prior
296 to its deletion. The values are formatted as
304 This option is not yet implemented.
308 ( 1.3.6.1.4.1.4203.666.11.5.2.9
310 DESC 'Modify operation'
311 SUP auditWriteObject STRUCTURAL
312 MAY reqOld MUST reqMod )
317 operation contains a description of modifications in the
319 attribute, which was already described above in the Add operation. It may
320 optionally contain the previous contents of any modified attributes in the
322 attribute, using the same format as described above for the Delete operation.
323 This option is not yet implemented.
327 ( 1.3.6.1.4.1.4203.666.11.5.2.10
329 DESC 'ModRDN operation'
330 SUP auditWriteObject STRUCTURAL
331 MUST ( reqNewRDN $ reqDeleteOldRDN )
339 attribute to carry the new RDN of the request.
342 attribute is a Boolean value showing
344 if the old RDN was deleted from the entry, or
346 if the old RDN was preserved.
349 attribute carries the DN of the new parent entry if the request specified
354 ( 1.3.6.1.4.1.4203.666.11.5.2.11
356 DESC 'Search operation'
357 SUP auditReadObject STRUCTURAL
358 MUST ( reqScope $ reqDerefAliases $ reqAttrsOnly )
359 MAY ( reqFilter $ reqAttr $ reqEntries $ reqSizeLimit $
367 attribute contains the scope of the original search request, using the
368 values specified for the LDAP URL format. I.e.
382 denoting how aliases will be processed during the search.
385 attribute is a Boolean value showing
387 if only attribute names were requested, or
389 if attributes and their values were requested.
392 attribute carries the filter used in the search request.
395 attribute lists the requested attributes if specific attributes were
399 attribute is the integer count of how many entries were returned by
405 attributes indicate what limits were requested on the search operation.
409 ( 1.3.6.1.4.1.4203.666.11.5.2.12
411 DESC 'Extended operation'
412 SUP auditObject STRUCTURAL
418 class represents an LDAP Extended Operation. As noted above, the actual OID of
419 the operation is included in the
421 attribute of the parent class. If any optional data was provided with the
422 request, it will be contained in the
424 attribute as an uninterpreted octet string.
427 The Access Log implemented by this overlay may be used for a variety of
428 other tasks, e.g. as a ChangeLog for a replication mechanism, as well
429 as for security/audit logging purposes.
434 default slapd configuration file
440 This module was written in 2005 by Howard Chu of Symas Corporation.