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 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
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 log database will be created
32 automatically by this overlay. The log entries will be generated as the
33 immediate children of the suffix entry.
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.
79 .B logsuccess TRUE | FALSE
80 If set to TRUE then log records will only be generated for successful
81 requests, i.e., requests that produce a result code of 0 (LDAP_SUCCESS).
82 If FALSE, log records are generated for all requests whether they
83 succeed or not. The default is FALSE.
94 suffix dc=example,dc=com
104 overlay utilizes the "audit" schema described herein.
105 This schema is specifically designed for
107 auditing and is not intended to be used otherwise. It is also
108 noted that the schema describe here is
111 and hence subject to change without notice.
112 The schema is loaded automatically by the overlay.
114 The schema includes a number of object classes and associated
115 attribute types as described below.
120 class from which two additional classes,
124 are derived. Object classes for each type of LDAP operation are further
125 derived from these classes. This object class hierarchy is designed to
126 allow flexible yet efficient searches of the log based on either a specific
127 operation type's class, or on more general classifications. The definition
133 ( 1.3.6.1.4.1.4203.666.11.5.2.1
135 DESC 'OpenLDAP request auditing'
137 MUST ( reqStart $ reqType $ reqSession )
138 MAY ( reqDN $ reqAuthzID $ reqControls $ reqRespControls $
139 reqEnd $ reqResult $ reqMessage $ reqReferral ) )
142 Note that all of the OIDs used in the logging schema currently reside
143 under the OpenLDAP Experimental branch. It is anticipated that they
144 will migrate to a Standard branch in the future.
146 An overview of the attributes follows:
150 provide the start and end time of the operation, respectively. They use
151 generalizedTime syntax. The
153 attribute is also used as the RDN for each log entry.
157 attribute is a simple string containing the type of operation
162 etc. For extended operations, the type also includes the OID of the
163 extended operation, e.g.
168 attribute is an implementation-specific identifier that is common to
169 all the operations associated with the same LDAP session. Currently this
170 is slapd's internal connection ID, stored in decimal.
174 attribute is the distinguishedName of the target of the operation. E.g., for
175 a Bind request, this is the Bind DN. For an Add request, this is the DN
176 of the entry being added. For a Search request, this is the base DN of
181 attribute is the distinguishedName of the user that performed the operation.
182 This will usually be the same name as was established at the start of a
183 session by a Bind request (if any) but may be altered in various
190 attributes carry any controls sent by the client on the request and returned
191 by the server in the response, respectively. The attribute values are just
192 uninterpreted octet strings.
196 attribute is the numeric LDAP result code of the operation, indicating
197 either success or a particular LDAP error code. An error code may be
198 accompanied by a text error message which will be recorded in the
204 attribute carries any referrals that were returned with the result of the
207 Operation-specific classes are defined with additional attributes to carry
208 all of the relevant parameters associated with the operation:
212 ( 1.3.6.1.4.1.4203.666.11.5.2.4
214 DESC 'Abandon operation'
215 SUP auditObject STRUCTURAL
223 attribute contains the message ID of the request that was abandoned.
227 ( 1.3.6.1.4.1.4203.666.11.5.2.5
230 SUP auditWriteObject STRUCTURAL
236 class inherits from the
238 class. The Add and Modify classes are very similar. The
240 attribute carries all of the attributes of the original entry being added.
241 (Or in the case of a Modify operation, all of the modifications being
242 performed.) The values are formatted as
246 attribute:<+|-|=|#> [ value]
250 Where '+' indicates an Add of a value, '-' for Delete, '=' for Replace,
251 and '#' for Increment. In an Add operation, all of the reqMod values will
252 have the '+' designator.
256 ( 1.3.6.1.4.1.4203.666.11.5.2.6
258 DESC 'Bind operation'
259 SUP auditObject STRUCTURAL
260 MUST ( reqVersion $ reqMethod ) )
267 attribute which contains the LDAP protocol version specified in the Bind
270 attribute which contains the Bind Method used in the Bind. This will be
273 for LDAP Simple Binds or
276 Note that unless configured as a global overlay, only Simple Binds using
277 DNs that reside in the current database will be logged.
281 ( 1.3.6.1.4.1.4203.666.11.5.2.7
283 DESC 'Compare operation'
284 SUP auditObject STRUCTURAL
292 attribute carries the Attribute Value Assertion used in the compare request.
296 ( 1.3.6.1.4.1.4203.666.11.5.2.8
298 DESC 'Delete operation'
299 SUP auditWriteObject STRUCTURAL
305 operation needs no further parameters. However, the
307 attribute may optionally be used to record the contents of the entry prior
308 to its deletion. The values are formatted as
315 This option is not yet implemented.
319 ( 1.3.6.1.4.1.4203.666.11.5.2.9
321 DESC 'Modify operation'
322 SUP auditWriteObject STRUCTURAL
323 MAY reqOld MUST reqMod )
328 operation contains a description of modifications in the
330 attribute, which was already described above in the Add operation. It may
331 optionally contain the previous contents of any modified attributes in the
333 attribute, using the same format as described above for the Delete operation.
334 This option is not yet implemented.
338 ( 1.3.6.1.4.1.4203.666.11.5.2.10
340 DESC 'ModRDN operation'
341 SUP auditWriteObject STRUCTURAL
342 MUST ( reqNewRDN $ reqDeleteOldRDN )
350 attribute to carry the new RDN of the request.
353 attribute is a Boolean value showing
355 if the old RDN was deleted from the entry, or
357 if the old RDN was preserved.
360 attribute carries the DN of the new parent entry if the request specified
365 ( 1.3.6.1.4.1.4203.666.11.5.2.11
367 DESC 'Search operation'
368 SUP auditReadObject STRUCTURAL
369 MUST ( reqScope $ reqDerefAliases $ reqAttrsOnly )
370 MAY ( reqFilter $ reqAttr $ reqEntries $ reqSizeLimit $
378 attribute contains the scope of the original search request, using the
379 values specified for the LDAP URL format. I.e.
393 denoting how aliases will be processed during the search.
396 attribute is a Boolean value showing
398 if only attribute names were requested, or
400 if attributes and their values were requested.
403 attribute carries the filter used in the search request.
406 attribute lists the requested attributes if specific attributes were
410 attribute is the integer count of how many entries were returned by
416 attributes indicate what limits were requested on the search operation.
420 ( 1.3.6.1.4.1.4203.666.11.5.2.12
422 DESC 'Extended operation'
423 SUP auditObject STRUCTURAL
429 class represents an LDAP Extended Operation. As noted above, the actual OID of
430 the operation is included in the
432 attribute of the parent class. If any optional data was provided with the
433 request, it will be contained in the
435 attribute as an uninterpreted octet string.
438 The Access Log implemented by this overlay may be used for a variety of
439 other tasks, e.g. as a ChangeLog for a replication mechanism, as well
440 as for security/audit logging purposes.
445 default slapd configuration file
451 This module was written in 2005 by Howard Chu of Symas Corporation.
projects / openldap / blob