1 /* accesslog.c - log operations for audit/history purposes */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2005-2010 The OpenLDAP Foundation.
6 * Portions copyright 2004-2005 Symas Corporation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in the file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by Howard Chu for inclusion in
24 #ifdef SLAPD_OVER_ACCESSLOG
28 #include <ac/string.h>
36 #define LOG_OP_ADD 0x001
37 #define LOG_OP_DELETE 0x002
38 #define LOG_OP_MODIFY 0x004
39 #define LOG_OP_MODRDN 0x008
40 #define LOG_OP_COMPARE 0x010
41 #define LOG_OP_SEARCH 0x020
42 #define LOG_OP_BIND 0x040
43 #define LOG_OP_UNBIND 0x080
44 #define LOG_OP_ABANDON 0x100
45 #define LOG_OP_EXTENDED 0x200
46 #define LOG_OP_UNKNOWN 0x400
48 #define LOG_OP_WRITES (LOG_OP_ADD|LOG_OP_DELETE|LOG_OP_MODIFY|LOG_OP_MODRDN)
49 #define LOG_OP_READS (LOG_OP_COMPARE|LOG_OP_SEARCH)
50 #define LOG_OP_SESSION (LOG_OP_BIND|LOG_OP_UNBIND|LOG_OP_ABANDON)
51 #define LOG_OP_ALL (LOG_OP_READS|LOG_OP_WRITES|LOG_OP_SESSION| \
52 LOG_OP_EXTENDED|LOG_OP_UNKNOWN)
54 typedef struct log_attr {
55 struct log_attr *next;
56 AttributeDescription *attr;
59 typedef struct log_info {
61 struct berval li_db_suffix;
68 log_attr *li_oldattrs;
70 ldap_pvt_thread_rmutex_t li_op_rmutex;
71 ldap_pvt_thread_mutex_t li_log_mutex;
74 static ConfigDriver log_cf_gen;
85 static ConfigTable log_cfats[] = {
86 { "logdb", "suffix", 2, 2, 0, ARG_DN|ARG_MAGIC|LOG_DB,
87 log_cf_gen, "( OLcfgOvAt:4.1 NAME 'olcAccessLogDB' "
88 "DESC 'Suffix of database for log content' "
89 "SUP distinguishedName SINGLE-VALUE )", NULL, NULL },
90 { "logops", "op|writes|reads|session|all", 2, 0, 0,
92 log_cf_gen, "( OLcfgOvAt:4.2 NAME 'olcAccessLogOps' "
93 "DESC 'Operation types to log' "
94 "EQUALITY caseIgnoreMatch "
95 "SYNTAX OMsDirectoryString )", NULL, NULL },
96 { "logpurge", "age> <interval", 3, 3, 0, ARG_MAGIC|LOG_PURGE,
97 log_cf_gen, "( OLcfgOvAt:4.3 NAME 'olcAccessLogPurge' "
98 "DESC 'Log cleanup parameters' "
99 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
100 { "logsuccess", NULL, 2, 2, 0, ARG_MAGIC|ARG_ON_OFF|LOG_SUCCESS,
101 log_cf_gen, "( OLcfgOvAt:4.4 NAME 'olcAccessLogSuccess' "
102 "DESC 'Log successful ops only' "
103 "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
104 { "logold", "filter", 2, 2, 0, ARG_MAGIC|LOG_OLD,
105 log_cf_gen, "( OLcfgOvAt:4.5 NAME 'olcAccessLogOld' "
106 "DESC 'Log old values when modifying entries matching the filter' "
107 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
108 { "logoldattr", "attrs", 2, 0, 0, ARG_MAGIC|LOG_OLDATTR,
109 log_cf_gen, "( OLcfgOvAt:4.6 NAME 'olcAccessLogOldAttr' "
110 "DESC 'Log old values of these attributes even if unmodified' "
111 "EQUALITY caseIgnoreMatch "
112 "SYNTAX OMsDirectoryString )", NULL, NULL },
116 static ConfigOCs log_cfocs[] = {
118 "NAME 'olcAccessLogConfig' "
119 "DESC 'Access log configuration' "
120 "SUP olcOverlayConfig "
121 "MUST olcAccessLogDB "
122 "MAY ( olcAccessLogOps $ olcAccessLogPurge $ olcAccessLogSuccess $ "
123 "olcAccessLogOld $ olcAccessLogOldAttr ) )",
124 Cft_Overlay, log_cfats },
128 static slap_verbmasks logops[] = {
129 { BER_BVC("all"), LOG_OP_ALL },
130 { BER_BVC("writes"), LOG_OP_WRITES },
131 { BER_BVC("session"), LOG_OP_SESSION },
132 { BER_BVC("reads"), LOG_OP_READS },
133 { BER_BVC("add"), LOG_OP_ADD },
134 { BER_BVC("delete"), LOG_OP_DELETE },
135 { BER_BVC("modify"), LOG_OP_MODIFY },
136 { BER_BVC("modrdn"), LOG_OP_MODRDN },
137 { BER_BVC("compare"), LOG_OP_COMPARE },
138 { BER_BVC("search"), LOG_OP_SEARCH },
139 { BER_BVC("bind"), LOG_OP_BIND },
140 { BER_BVC("unbind"), LOG_OP_UNBIND },
141 { BER_BVC("abandon"), LOG_OP_ABANDON },
142 { BER_BVC("extended"), LOG_OP_EXTENDED },
143 { BER_BVC("unknown"), LOG_OP_UNKNOWN },
147 /* Start with "add" in logops */
165 static ObjectClass *log_ocs[LOG_EN__COUNT], *log_container,
166 *log_oc_read, *log_oc_write;
168 #define LOG_SCHEMA_ROOT "1.3.6.1.4.1.4203.666.11.5"
170 #define LOG_SCHEMA_AT LOG_SCHEMA_ROOT ".1"
171 #define LOG_SCHEMA_OC LOG_SCHEMA_ROOT ".2"
172 #define LOG_SCHEMA_SYN LOG_SCHEMA_ROOT ".3"
174 static AttributeDescription *ad_reqDN, *ad_reqStart, *ad_reqEnd, *ad_reqType,
175 *ad_reqSession, *ad_reqResult, *ad_reqAuthzID, *ad_reqControls,
176 *ad_reqRespControls, *ad_reqMethod, *ad_reqAssertion, *ad_reqNewRDN,
177 *ad_reqNewSuperior, *ad_reqDeleteOldRDN, *ad_reqMod,
178 *ad_reqScope, *ad_reqFilter, *ad_reqAttr, *ad_reqEntries,
179 *ad_reqSizeLimit, *ad_reqTimeLimit, *ad_reqAttrsOnly, *ad_reqData,
180 *ad_reqId, *ad_reqMessage, *ad_reqVersion, *ad_reqDerefAliases,
181 *ad_reqReferral, *ad_reqOld, *ad_auditContext;
184 logSchemaControlValidate(
186 struct berval *val );
188 char *mrControl[] = {
189 "objectIdentifierFirstComponentMatch",
195 slap_syntax_defs_rec syn;
198 { LOG_SCHEMA_SYN ".1" ,
199 { "( " LOG_SCHEMA_SYN ".1 DESC 'Control' )",
202 logSchemaControlValidate,
210 AttributeDescription **ad;
212 { "( " LOG_SCHEMA_AT ".1 NAME 'reqDN' "
213 "DESC 'Target DN of request' "
214 "EQUALITY distinguishedNameMatch "
216 "SINGLE-VALUE )", &ad_reqDN },
217 { "( " LOG_SCHEMA_AT ".2 NAME 'reqStart' "
218 "DESC 'Start time of request' "
219 "EQUALITY generalizedTimeMatch "
220 "ORDERING generalizedTimeOrderingMatch "
221 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.24 "
222 "SINGLE-VALUE )", &ad_reqStart },
223 { "( " LOG_SCHEMA_AT ".3 NAME 'reqEnd' "
224 "DESC 'End time of request' "
225 "EQUALITY generalizedTimeMatch "
226 "ORDERING generalizedTimeOrderingMatch "
227 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.24 "
228 "SINGLE-VALUE )", &ad_reqEnd },
229 { "( " LOG_SCHEMA_AT ".4 NAME 'reqType' "
230 "DESC 'Type of request' "
231 "EQUALITY caseIgnoreMatch "
232 "SYNTAX OMsDirectoryString "
233 "SINGLE-VALUE )", &ad_reqType },
234 { "( " LOG_SCHEMA_AT ".5 NAME 'reqSession' "
235 "DESC 'Session ID of request' "
236 "EQUALITY caseIgnoreMatch "
237 "SYNTAX OMsDirectoryString "
238 "SINGLE-VALUE )", &ad_reqSession },
239 { "( " LOG_SCHEMA_AT ".6 NAME 'reqAuthzID' "
240 "DESC 'Authorization ID of requestor' "
241 "EQUALITY distinguishedNameMatch "
243 "SINGLE-VALUE )", &ad_reqAuthzID },
244 { "( " LOG_SCHEMA_AT ".7 NAME 'reqResult' "
245 "DESC 'Result code of request' "
246 "EQUALITY integerMatch "
247 "ORDERING integerOrderingMatch "
249 "SINGLE-VALUE )", &ad_reqResult },
250 { "( " LOG_SCHEMA_AT ".8 NAME 'reqMessage' "
251 "DESC 'Error text of request' "
252 "EQUALITY caseIgnoreMatch "
253 "SUBSTR caseIgnoreSubstringsMatch "
254 "SYNTAX OMsDirectoryString "
255 "SINGLE-VALUE )", &ad_reqMessage },
256 { "( " LOG_SCHEMA_AT ".9 NAME 'reqReferral' "
257 "DESC 'Referrals returned for request' "
258 "SUP labeledURI )", &ad_reqReferral },
259 { "( " LOG_SCHEMA_AT ".10 NAME 'reqControls' "
260 "DESC 'Request controls' "
261 "EQUALITY objectIdentifierFirstComponentMatch "
262 "SYNTAX " LOG_SCHEMA_SYN ".1 "
263 "X-ORDERED 'VALUES' )", &ad_reqControls },
264 { "( " LOG_SCHEMA_AT ".11 NAME 'reqRespControls' "
265 "DESC 'Response controls of request' "
266 "EQUALITY objectIdentifierFirstComponentMatch "
267 "SYNTAX " LOG_SCHEMA_SYN ".1 "
268 "X-ORDERED 'VALUES' )", &ad_reqRespControls },
269 { "( " LOG_SCHEMA_AT ".12 NAME 'reqId' "
270 "DESC 'ID of Request to Abandon' "
271 "EQUALITY integerMatch "
272 "ORDERING integerOrderingMatch "
274 "SINGLE-VALUE )", &ad_reqId },
275 { "( " LOG_SCHEMA_AT ".13 NAME 'reqVersion' "
276 "DESC 'Protocol version of Bind request' "
277 "EQUALITY integerMatch "
278 "ORDERING integerOrderingMatch "
280 "SINGLE-VALUE )", &ad_reqVersion },
281 { "( " LOG_SCHEMA_AT ".14 NAME 'reqMethod' "
282 "DESC 'Bind method of request' "
283 "EQUALITY caseIgnoreMatch "
284 "SYNTAX OMsDirectoryString "
285 "SINGLE-VALUE )", &ad_reqMethod },
286 { "( " LOG_SCHEMA_AT ".15 NAME 'reqAssertion' "
287 "DESC 'Compare Assertion of request' "
288 "SYNTAX OMsDirectoryString "
289 "SINGLE-VALUE )", &ad_reqAssertion },
290 { "( " LOG_SCHEMA_AT ".16 NAME 'reqMod' "
291 "DESC 'Modifications of request' "
292 "EQUALITY octetStringMatch "
293 "SUBSTR octetStringSubstringsMatch "
294 "SYNTAX OMsOctetString )", &ad_reqMod },
295 { "( " LOG_SCHEMA_AT ".17 NAME 'reqOld' "
296 "DESC 'Old values of entry before request completed' "
297 "EQUALITY octetStringMatch "
298 "SUBSTR octetStringSubstringsMatch "
299 "SYNTAX OMsOctetString )", &ad_reqOld },
300 { "( " LOG_SCHEMA_AT ".18 NAME 'reqNewRDN' "
301 "DESC 'New RDN of request' "
302 "EQUALITY distinguishedNameMatch "
304 "SINGLE-VALUE )", &ad_reqNewRDN },
305 { "( " LOG_SCHEMA_AT ".19 NAME 'reqDeleteOldRDN' "
306 "DESC 'Delete old RDN' "
307 "EQUALITY booleanMatch "
309 "SINGLE-VALUE )", &ad_reqDeleteOldRDN },
310 { "( " LOG_SCHEMA_AT ".20 NAME 'reqNewSuperior' "
311 "DESC 'New superior DN of request' "
312 "EQUALITY distinguishedNameMatch "
314 "SINGLE-VALUE )", &ad_reqNewSuperior },
315 { "( " LOG_SCHEMA_AT ".21 NAME 'reqScope' "
316 "DESC 'Scope of request' "
317 "EQUALITY caseIgnoreMatch "
318 "SYNTAX OMsDirectoryString "
319 "SINGLE-VALUE )", &ad_reqScope },
320 { "( " LOG_SCHEMA_AT ".22 NAME 'reqDerefAliases' "
321 "DESC 'Disposition of Aliases in request' "
322 "EQUALITY caseIgnoreMatch "
323 "SYNTAX OMsDirectoryString "
324 "SINGLE-VALUE )", &ad_reqDerefAliases },
325 { "( " LOG_SCHEMA_AT ".23 NAME 'reqAttrsOnly' "
326 "DESC 'Attributes and values of request' "
327 "EQUALITY booleanMatch "
329 "SINGLE-VALUE )", &ad_reqAttrsOnly },
330 { "( " LOG_SCHEMA_AT ".24 NAME 'reqFilter' "
331 "DESC 'Filter of request' "
332 "EQUALITY caseIgnoreMatch "
333 "SUBSTR caseIgnoreSubstringsMatch "
334 "SYNTAX OMsDirectoryString "
335 "SINGLE-VALUE )", &ad_reqFilter },
336 { "( " LOG_SCHEMA_AT ".25 NAME 'reqAttr' "
337 "DESC 'Attributes of request' "
338 "EQUALITY caseIgnoreMatch "
339 "SYNTAX OMsDirectoryString )", &ad_reqAttr },
340 { "( " LOG_SCHEMA_AT ".26 NAME 'reqSizeLimit' "
341 "DESC 'Size limit of request' "
342 "EQUALITY integerMatch "
343 "ORDERING integerOrderingMatch "
345 "SINGLE-VALUE )", &ad_reqSizeLimit },
346 { "( " LOG_SCHEMA_AT ".27 NAME 'reqTimeLimit' "
347 "DESC 'Time limit of request' "
348 "EQUALITY integerMatch "
349 "ORDERING integerOrderingMatch "
351 "SINGLE-VALUE )", &ad_reqTimeLimit },
352 { "( " LOG_SCHEMA_AT ".28 NAME 'reqEntries' "
353 "DESC 'Number of entries returned' "
354 "EQUALITY integerMatch "
355 "ORDERING integerOrderingMatch "
357 "SINGLE-VALUE )", &ad_reqEntries },
358 { "( " LOG_SCHEMA_AT ".29 NAME 'reqData' "
359 "DESC 'Data of extended request' "
360 "EQUALITY octetStringMatch "
361 "SUBSTR octetStringSubstringsMatch "
362 "SYNTAX OMsOctetString "
363 "SINGLE-VALUE )", &ad_reqData },
366 * from <draft-chu-ldap-logschema-01.txt>:
369 ( LOG_SCHEMA_AT .30 NAME 'auditContext'
370 DESC 'DN of auditContainer'
371 EQUALITY distinguishedNameMatch
372 SYNTAX 1.3.6.1.4.1.1466.115.121.1.12
373 SINGLE-VALUE NO-USER-MODIFICATION USAGE directoryOperation )
375 * - removed EQUALITY matchingRule
376 * - changed directoryOperation in dSAOperation
378 { "( " LOG_SCHEMA_AT ".30 NAME 'auditContext' "
379 "DESC 'DN of auditContainer' "
380 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.12 "
382 "NO-USER-MODIFICATION "
383 "USAGE dSAOperation )", &ad_auditContext },
391 { "( " LOG_SCHEMA_OC ".0 NAME 'auditContainer' "
392 "DESC 'AuditLog container' "
393 "SUP top STRUCTURAL "
394 "MAY ( cn $ reqStart $ reqEnd ) )", &log_container },
395 { "( " LOG_SCHEMA_OC ".1 NAME 'auditObject' "
396 "DESC 'OpenLDAP request auditing' "
397 "SUP top STRUCTURAL "
398 "MUST ( reqStart $ reqType $ reqSession ) "
399 "MAY ( reqDN $ reqAuthzID $ reqControls $ reqRespControls $ reqEnd $ "
400 "reqResult $ reqMessage $ reqReferral ) )",
401 &log_ocs[LOG_EN_UNBIND] },
402 { "( " LOG_SCHEMA_OC ".2 NAME 'auditReadObject' "
403 "DESC 'OpenLDAP read request record' "
404 "SUP auditObject STRUCTURAL )", &log_oc_read },
405 { "( " LOG_SCHEMA_OC ".3 NAME 'auditWriteObject' "
406 "DESC 'OpenLDAP write request record' "
407 "SUP auditObject STRUCTURAL )", &log_oc_write },
408 { "( " LOG_SCHEMA_OC ".4 NAME 'auditAbandon' "
409 "DESC 'Abandon operation' "
410 "SUP auditObject STRUCTURAL "
411 "MUST reqId )", &log_ocs[LOG_EN_ABANDON] },
412 { "( " LOG_SCHEMA_OC ".5 NAME 'auditAdd' "
413 "DESC 'Add operation' "
414 "SUP auditWriteObject STRUCTURAL "
415 "MUST reqMod )", &log_ocs[LOG_EN_ADD] },
416 { "( " LOG_SCHEMA_OC ".6 NAME 'auditBind' "
417 "DESC 'Bind operation' "
418 "SUP auditObject STRUCTURAL "
419 "MUST ( reqVersion $ reqMethod ) )", &log_ocs[LOG_EN_BIND] },
420 { "( " LOG_SCHEMA_OC ".7 NAME 'auditCompare' "
421 "DESC 'Compare operation' "
422 "SUP auditReadObject STRUCTURAL "
423 "MUST reqAssertion )", &log_ocs[LOG_EN_COMPARE] },
424 { "( " LOG_SCHEMA_OC ".8 NAME 'auditDelete' "
425 "DESC 'Delete operation' "
426 "SUP auditWriteObject STRUCTURAL "
427 "MAY reqOld )", &log_ocs[LOG_EN_DELETE] },
428 { "( " LOG_SCHEMA_OC ".9 NAME 'auditModify' "
429 "DESC 'Modify operation' "
430 "SUP auditWriteObject STRUCTURAL "
431 "MAY reqOld MUST reqMod )", &log_ocs[LOG_EN_MODIFY] },
432 { "( " LOG_SCHEMA_OC ".10 NAME 'auditModRDN' "
433 "DESC 'ModRDN operation' "
434 "SUP auditWriteObject STRUCTURAL "
435 "MUST ( reqNewRDN $ reqDeleteOldRDN ) "
436 "MAY ( reqNewSuperior $ reqMod $ reqOld ) )", &log_ocs[LOG_EN_MODRDN] },
437 { "( " LOG_SCHEMA_OC ".11 NAME 'auditSearch' "
438 "DESC 'Search operation' "
439 "SUP auditReadObject STRUCTURAL "
440 "MUST ( reqScope $ reqDerefAliases $ reqAttrsonly ) "
441 "MAY ( reqFilter $ reqAttr $ reqEntries $ reqSizeLimit $ "
442 "reqTimeLimit ) )", &log_ocs[LOG_EN_SEARCH] },
443 { "( " LOG_SCHEMA_OC ".12 NAME 'auditExtended' "
444 "DESC 'Extended operation' "
445 "SUP auditObject STRUCTURAL "
446 "MAY reqData )", &log_ocs[LOG_EN_EXTENDED] },
450 #define RDNEQ "reqStart="
452 /* Our time intervals are of the form [ddd+]hh:mm[:ss]
453 * If a field is present, it must be two digits. (Except for
454 * days, which can be arbitrary width.)
457 log_age_parse(char *agestr)
463 t1 = strtol( agestr, &endptr, 10 );
464 /* Is there a days delimiter? */
465 if ( *endptr == '+' ) {
466 /* 32 bit time only covers about 68 years */
467 if ( t1 < 0 || t1 > 25000 )
473 if ( agestr[2] != ':' ) {
474 /* No valid delimiter found, fail */
485 /* if there's a delimiter, it can only be a colon */
486 if ( agestr[2] != ':' )
489 /* If we're at the end of the string, and we started with days,
490 * fail because we expected to find minutes too.
492 return gotdays ? -1 : t1 * 60;
498 /* last field can only be seconds */
499 if ( agestr[2] && ( agestr[2] != ':' || !gotdays ))
509 t1 += atoi( agestr );
510 } else if ( gotdays ) {
511 /* only got days+hh:mm */
518 log_age_unparse( int age, struct berval *agebv, size_t size )
520 int dd, hh, mm, ss, len;
536 len = snprintf( ptr, size, "%d+", dd );
537 assert( len >= 0 && (unsigned) len < size );
541 len = snprintf( ptr, size, "%02d:%02d", hh, mm );
542 assert( len >= 0 && (unsigned) len < size );
546 len = snprintf( ptr, size, ":%02d", ss );
547 assert( len >= 0 && (unsigned) len < size );
552 agebv->bv_len = ptr - agebv->bv_val;
555 static slap_callback nullsc = { NULL, NULL, NULL, NULL };
557 #define PURGE_INCREMENT 100
559 typedef struct purge_data {
564 struct berval csn; /* an arbitrary old CSN */
568 log_old_lookup( Operation *op, SlapReply *rs )
570 purge_data *pd = op->o_callback->sc_private;
573 if ( rs->sr_type != REP_SEARCH) return 0;
575 if ( slapd_shutdown ) return 0;
577 /* Remember max CSN: should always be the last entry
578 * seen, since log entries are ordered chronologically...
580 a = attr_find( rs->sr_entry->e_attrs,
581 slap_schema.si_ad_entryCSN );
583 ber_len_t len = a->a_nvals[0].bv_len;
584 /* Paranoid len check, normalized CSNs are always the same length */
585 if ( len > LDAP_PVT_CSNSTR_BUFSIZE )
586 len = LDAP_PVT_CSNSTR_BUFSIZE;
587 if ( memcmp( a->a_nvals[0].bv_val, pd->csn.bv_val, len ) > 0 ) {
588 AC_MEMCPY( pd->csn.bv_val, a->a_nvals[0].bv_val, len );
589 pd->csn.bv_len = len;
592 if ( pd->used >= pd->slots ) {
593 pd->slots += PURGE_INCREMENT;
594 pd->dn = ch_realloc( pd->dn, pd->slots * sizeof( struct berval ));
595 pd->ndn = ch_realloc( pd->ndn, pd->slots * sizeof( struct berval ));
597 ber_dupbv( &pd->dn[pd->used], &rs->sr_entry->e_name );
598 ber_dupbv( &pd->ndn[pd->used], &rs->sr_entry->e_nname );
603 /* Periodically search for old entries in the log database and delete them */
605 accesslog_purge( void *ctx, void *arg )
607 struct re_s *rtask = arg;
608 struct log_info *li = rtask->arg;
610 Connection conn = {0};
611 OperationBuffer opbuf;
613 SlapReply rs = {REP_RESULT};
614 slap_callback cb = { NULL, log_old_lookup, NULL, NULL };
616 AttributeAssertion ava = ATTRIBUTEASSERTION_INIT;
618 char timebuf[LDAP_LUTIL_GENTIME_BUFSIZE];
619 char csnbuf[LDAP_PVT_CSNSTR_BUFSIZE];
620 time_t old = slap_get_time();
622 connection_fake_init( &conn, &opbuf, ctx );
625 f.f_choice = LDAP_FILTER_LE;
629 ava.aa_desc = ad_reqStart;
630 ava.aa_value.bv_val = timebuf;
631 ava.aa_value.bv_len = sizeof(timebuf);
634 slap_timestamp( &old, &ava.aa_value );
636 op->o_tag = LDAP_REQ_SEARCH;
637 op->o_bd = li->li_db;
638 op->o_dn = li->li_db->be_rootdn;
639 op->o_ndn = li->li_db->be_rootndn;
640 op->o_req_dn = li->li_db->be_suffix[0];
641 op->o_req_ndn = li->li_db->be_nsuffix[0];
642 op->o_callback = &cb;
643 op->ors_scope = LDAP_SCOPE_ONELEVEL;
644 op->ors_deref = LDAP_DEREF_NEVER;
645 op->ors_tlimit = SLAP_NO_LIMIT;
646 op->ors_slimit = SLAP_NO_LIMIT;
648 filter2bv_x( op, &f, &op->ors_filterstr );
649 op->ors_attrs = slap_anlist_no_attrs;
650 op->ors_attrsonly = 1;
652 pd.csn.bv_len = sizeof( csnbuf );
653 pd.csn.bv_val = csnbuf;
657 op->o_bd->be_search( op, &rs );
658 op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
663 /* delete the expired entries */
664 op->o_tag = LDAP_REQ_DELETE;
665 op->o_callback = &nullsc;
667 op->o_dont_replicate = 1;
669 for (i=0; i<pd.used; i++) {
670 op->o_req_dn = pd.dn[i];
671 op->o_req_ndn = pd.ndn[i];
672 if ( !slapd_shutdown ) {
673 rs_reinit( &rs, REP_RESULT );
674 op->o_bd->be_delete( op, &rs );
676 ch_free( pd.ndn[i].bv_val );
677 ch_free( pd.dn[i].bv_val );
685 rs_reinit( &rs, REP_RESULT );
686 /* update context's entryCSN to reflect oldest CSN */
691 mod.sml_nvalues = NULL;
692 mod.sml_desc = slap_schema.si_ad_entryCSN;
693 mod.sml_op = LDAP_MOD_REPLACE;
694 mod.sml_flags = SLAP_MOD_INTERNAL;
697 op->o_tag = LDAP_REQ_MODIFY;
698 op->orm_modlist = &mod;
699 op->orm_no_opattrs = 1;
700 op->o_req_dn = li->li_db->be_suffix[0];
701 op->o_req_ndn = li->li_db->be_nsuffix[0];
702 op->o_no_schema_check = 1;
703 op->o_managedsait = SLAP_CONTROL_NONCRITICAL;
704 op->o_bd->be_modify( op, &rs );
705 if ( mod.sml_next ) {
706 slap_mods_free( mod.sml_next, 1 );
711 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
712 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
713 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
719 log_cf_gen(ConfigArgs *c)
721 slap_overinst *on = (slap_overinst *)c->bi;
722 struct log_info *li = on->on_bi.bi_private;
724 slap_mask_t tmask = 0;
725 char agebuf[2*STRLENOF("ddddd+hh:mm:ss ")];
726 struct berval agebv, cyclebv;
729 case SLAP_CONFIG_EMIT:
732 if ( !BER_BVISEMPTY( &li->li_db_suffix )) {
733 value_add_one( &c->rvalue_vals, &li->li_db_suffix );
734 value_add_one( &c->rvalue_nvals, &li->li_db_suffix );
735 } else if ( li->li_db ) {
736 value_add_one( &c->rvalue_vals, li->li_db->be_suffix );
737 value_add_one( &c->rvalue_nvals, li->li_db->be_nsuffix );
739 snprintf( c->cr_msg, sizeof( c->cr_msg ),
740 "accesslog: \"logdb <suffix>\" must be specified" );
741 Debug( LDAP_DEBUG_ANY, "%s: %s \"%s\"\n",
742 c->log, c->cr_msg, c->value_dn.bv_val );
748 rc = mask_to_verbs( logops, li->li_ops, &c->rvalue_vals );
755 agebv.bv_val = agebuf;
756 log_age_unparse( li->li_age, &agebv, sizeof( agebuf ) );
757 agebv.bv_val[agebv.bv_len] = ' ';
759 cyclebv.bv_val = agebv.bv_val + agebv.bv_len;
760 log_age_unparse( li->li_cycle, &cyclebv, sizeof( agebuf ) - agebv.bv_len );
761 agebv.bv_len += cyclebv.bv_len;
762 value_add_one( &c->rvalue_vals, &agebv );
765 if ( li->li_success )
766 c->value_int = li->li_success;
772 filter2bv( li->li_oldf, &agebv );
773 ber_bvarray_add( &c->rvalue_vals, &agebv );
779 if ( li->li_oldattrs ) {
782 for ( la = li->li_oldattrs; la; la=la->next )
783 value_add_one( &c->rvalue_vals, &la->attr->ad_cname );
790 case LDAP_MOD_DELETE:
793 /* noop. this should always be a valid backend. */
799 rc = verbs_to_mask( 1, &c->line, logops, &tmask );
801 li->li_ops &= ~tmask;
806 struct re_s *re = li->li_task;
808 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
809 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ))
810 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
811 ldap_pvt_runqueue_remove( &slapd_rq, re );
812 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
822 filter_free( li->li_oldf );
830 for ( la = li->li_oldattrs; la; la = ln ) {
835 log_attr *la = NULL, **lp;
838 for ( lp = &li->li_oldattrs, i=0; i < c->valx; i++ ) {
851 if ( CONFIG_ONLINE_ADD( c )) {
852 li->li_db = select_backend( &c->value_ndn, 0 );
854 snprintf( c->cr_msg, sizeof( c->cr_msg ),
855 "<%s> no matching backend found for suffix",
857 Debug( LDAP_DEBUG_ANY, "%s: %s \"%s\"\n",
858 c->log, c->cr_msg, c->value_dn.bv_val );
861 ch_free( c->value_ndn.bv_val );
863 li->li_db_suffix = c->value_ndn;
865 ch_free( c->value_dn.bv_val );
868 rc = verbs_to_mask( c->argc, c->argv, logops, &tmask );
873 li->li_age = log_age_parse( c->argv[1] );
874 if ( li->li_age < 1 ) {
877 li->li_cycle = log_age_parse( c->argv[2] );
878 if ( li->li_cycle < 1 ) {
880 } else if ( slapMode & SLAP_SERVER_MODE ) {
881 struct re_s *re = li->li_task;
883 re->interval.tv_sec = li->li_cycle;
885 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
886 li->li_task = ldap_pvt_runqueue_insert( &slapd_rq,
887 li->li_cycle, accesslog_purge, li,
888 "accesslog_purge", li->li_db ?
889 li->li_db->be_suffix[0].bv_val :
890 c->be->be_suffix[0].bv_val );
891 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
897 li->li_success = c->value_int;
900 li->li_oldf = str2filter( c->argv[1] );
901 if ( !li->li_oldf ) {
902 snprintf( c->cr_msg, sizeof( c->cr_msg ), "bad filter!" );
908 AttributeDescription *ad;
911 for ( i=1; i< c->argc; i++ ) {
913 if ( slap_str2ad( c->argv[i], &ad, &text ) == LDAP_SUCCESS ) {
914 log_attr *la = ch_malloc( sizeof( log_attr ));
916 la->next = li->li_oldattrs;
917 li->li_oldattrs = la;
919 snprintf( c->cr_msg, sizeof( c->cr_msg ), "%s <%s>: %s",
920 c->argv[0], c->argv[i], text );
921 Debug( LDAP_DEBUG_CONFIG|LDAP_DEBUG_NONE,
922 "%s: %s\n", c->log, c->cr_msg, 0 );
936 logSchemaControlValidate(
938 struct berval *valp )
940 struct berval val, bv;
942 int rc = LDAP_SUCCESS;
944 assert( valp != NULL );
948 /* check minimal size */
949 if ( val.bv_len < STRLENOF( "{*}" ) ) {
950 return LDAP_INVALID_SYNTAX;
955 /* check SEQUENCE boundaries */
956 if ( val.bv_val[ 0 ] != '{' /*}*/ ||
957 val.bv_val[ val.bv_len ] != /*{*/ '}' )
959 return LDAP_INVALID_SYNTAX;
962 /* extract and check OID */
963 for ( i = 1; i < val.bv_len; i++ ) {
964 if ( !ASCII_SPACE( val.bv_val[ i ] ) ) {
969 bv.bv_val = &val.bv_val[ i ];
971 for ( i++; i < val.bv_len; i++ ) {
972 if ( ASCII_SPACE( val.bv_val[ i ] ) )
978 bv.bv_len = &val.bv_val[ i ] - bv.bv_val;
980 rc = numericoidValidate( NULL, &bv );
981 if ( rc != LDAP_SUCCESS ) {
985 if ( i == val.bv_len ) {
989 if ( val.bv_val[ i ] != ' ' ) {
990 return LDAP_INVALID_SYNTAX;
993 for ( i++; i < val.bv_len; i++ ) {
994 if ( !ASCII_SPACE( val.bv_val[ i ] ) ) {
999 if ( i == val.bv_len ) {
1000 return LDAP_SUCCESS;
1003 /* extract and check criticality */
1004 if ( strncasecmp( &val.bv_val[ i ], "criticality ", STRLENOF( "criticality " ) ) == 0 )
1006 i += STRLENOF( "criticality " );
1007 for ( ; i < val.bv_len; i++ ) {
1008 if ( !ASCII_SPACE( val.bv_val[ i ] ) ) {
1013 if ( i == val.bv_len ) {
1014 return LDAP_INVALID_SYNTAX;
1017 bv.bv_val = &val.bv_val[ i ];
1019 for ( ; i < val.bv_len; i++ ) {
1020 if ( ASCII_SPACE( val.bv_val[ i ] ) ) {
1025 bv.bv_len = &val.bv_val[ i ] - bv.bv_val;
1027 if ( !bvmatch( &bv, &slap_true_bv ) && !bvmatch( &bv, &slap_false_bv ) )
1029 return LDAP_INVALID_SYNTAX;
1032 if ( i == val.bv_len ) {
1033 return LDAP_SUCCESS;
1036 if ( val.bv_val[ i ] != ' ' ) {
1037 return LDAP_INVALID_SYNTAX;
1040 for ( i++; i < val.bv_len; i++ ) {
1041 if ( !ASCII_SPACE( val.bv_val[ i ] ) ) {
1046 if ( i == val.bv_len ) {
1047 return LDAP_SUCCESS;
1051 /* extract and check controlValue */
1052 if ( strncasecmp( &val.bv_val[ i ], "controlValue ", STRLENOF( "controlValue " ) ) == 0 )
1054 i += STRLENOF( "controlValue " );
1055 for ( ; i < val.bv_len; i++ ) {
1056 if ( !ASCII_SPACE( val.bv_val[ i ] ) ) {
1061 if ( i == val.bv_len ) {
1062 return LDAP_INVALID_SYNTAX;
1065 if ( val.bv_val[ i ] != '"' ) {
1066 return LDAP_INVALID_SYNTAX;
1069 for ( i++; i < val.bv_len; i++ ) {
1070 if ( val.bv_val[ i ] == '"' ) {
1074 if ( !ASCII_HEX( val.bv_val[ i ] ) ) {
1075 return LDAP_INVALID_SYNTAX;
1079 if ( val.bv_val[ i ] != '"' ) {
1080 return LDAP_INVALID_SYNTAX;
1083 for ( i++; i < val.bv_len; i++ ) {
1084 if ( !ASCII_SPACE( val.bv_val[ i ] ) ) {
1089 if ( i == val.bv_len ) {
1090 return LDAP_SUCCESS;
1094 return LDAP_INVALID_SYNTAX;
1099 LDAPControl **ctrls,
1106 assert( valsp != NULL );
1107 assert( ctrls != NULL );
1112 for ( i = 0; ctrls[ i ] != NULL; i++ ) {
1120 if ( ctrls[ i ]->ldctl_oid == NULL ) {
1121 return LDAP_PROTOCOL_ERROR;
1124 idx.bv_len = snprintf( buf, sizeof( buf ), "{%ld}", i );
1127 ber_str2bv( ctrls[ i ]->ldctl_oid, 0, 0, &oid );
1128 noid.bv_len = idx.bv_len + oid.bv_len;
1129 ptr = noid.bv_val = ber_memalloc_x( noid.bv_len + 1, memctx );
1130 ptr = lutil_strcopy( ptr, idx.bv_val );
1131 ptr = lutil_strcopy( ptr, oid.bv_val );
1133 bv.bv_len = idx.bv_len + STRLENOF( "{}" ) + oid.bv_len;
1135 if ( ctrls[ i ]->ldctl_iscritical ) {
1136 bv.bv_len += STRLENOF( " criticality TRUE" );
1139 if ( !BER_BVISNULL( &ctrls[ i ]->ldctl_value ) ) {
1140 bv.bv_len += STRLENOF( " controlValue \"\"" )
1141 + 2 * ctrls[ i ]->ldctl_value.bv_len;
1144 ptr = bv.bv_val = ber_memalloc_x( bv.bv_len + 1, memctx );
1145 if ( ptr == NULL ) {
1146 ber_bvarray_free( *valsp );
1148 ber_bvarray_free( *nvalsp );
1153 ptr = lutil_strcopy( ptr, idx.bv_val );
1155 *ptr++ = '{' /*}*/ ;
1156 ptr = lutil_strcopy( ptr, oid.bv_val );
1158 if ( ctrls[ i ]->ldctl_iscritical ) {
1159 ptr = lutil_strcopy( ptr, " criticality TRUE" );
1162 if ( !BER_BVISNULL( &ctrls[ i ]->ldctl_value ) ) {
1165 ptr = lutil_strcopy( ptr, " controlValue \"" );
1166 for ( j = 0; j < ctrls[ i ]->ldctl_value.bv_len; j++ )
1170 o = ( ( ctrls[ i ]->ldctl_value.bv_val[ j ] >> 4 ) & 0xF );
1178 o = ( ctrls[ i ]->ldctl_value.bv_val[ j ] & 0xF );
1193 ber_bvarray_add_x( valsp, &bv, memctx );
1194 ber_bvarray_add_x( nvalsp, &noid, memctx );
1201 static Entry *accesslog_entry( Operation *op, SlapReply *rs, int logop,
1203 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1204 log_info *li = on->on_bi.bi_private;
1206 char rdnbuf[STRLENOF(RDNEQ)+LDAP_LUTIL_GENTIME_BUFSIZE+8];
1207 char nrdnbuf[STRLENOF(RDNEQ)+LDAP_LUTIL_GENTIME_BUFSIZE+8];
1209 struct berval rdn, nrdn, timestamp, ntimestamp, bv;
1210 slap_verbmasks *lo = logops+logop+EN_OFFSET;
1212 Entry *e = entry_alloc();
1214 strcpy( rdnbuf, RDNEQ );
1215 rdn.bv_val = rdnbuf;
1216 strcpy( nrdnbuf, RDNEQ );
1217 nrdn.bv_val = nrdnbuf;
1219 timestamp.bv_val = rdnbuf+STRLENOF(RDNEQ);
1220 timestamp.bv_len = sizeof(rdnbuf) - STRLENOF(RDNEQ);
1221 slap_timestamp( &op->o_time, ×tamp );
1222 snprintf( timestamp.bv_val + timestamp.bv_len-1, sizeof(".123456Z"), ".%06dZ", op->o_tincr );
1223 timestamp.bv_len += STRLENOF(".123456");
1225 rdn.bv_len = STRLENOF(RDNEQ)+timestamp.bv_len;
1226 ad_reqStart->ad_type->sat_equality->smr_normalize(
1227 SLAP_MR_VALUE_OF_ASSERTION_SYNTAX, ad_reqStart->ad_type->sat_syntax,
1228 ad_reqStart->ad_type->sat_equality, ×tamp, &ntimestamp,
1231 strcpy( nrdn.bv_val + STRLENOF(RDNEQ), ntimestamp.bv_val );
1232 nrdn.bv_len = STRLENOF(RDNEQ)+ntimestamp.bv_len;
1233 build_new_dn( &e->e_name, li->li_db->be_suffix, &rdn, NULL );
1234 build_new_dn( &e->e_nname, li->li_db->be_nsuffix, &nrdn, NULL );
1236 attr_merge_one( e, slap_schema.si_ad_objectClass,
1237 &log_ocs[logop]->soc_cname, NULL );
1238 attr_merge_one( e, slap_schema.si_ad_structuralObjectClass,
1239 &log_ocs[logop]->soc_cname, NULL );
1240 attr_merge_one( e, ad_reqStart, ×tamp, &ntimestamp );
1241 op->o_tmpfree( ntimestamp.bv_val, op->o_tmpmemctx );
1243 slap_op_time( &op2->o_time, &op2->o_tincr );
1245 timestamp.bv_len = sizeof(rdnbuf) - STRLENOF(RDNEQ);
1246 slap_timestamp( &op2->o_time, ×tamp );
1247 snprintf( timestamp.bv_val + timestamp.bv_len-1, sizeof(".123456Z"), ".%06dZ", op2->o_tincr );
1248 timestamp.bv_len += STRLENOF(".123456");
1250 attr_merge_normalize_one( e, ad_reqEnd, ×tamp, op->o_tmpmemctx );
1252 /* Exops have OID appended */
1253 if ( logop == LOG_EN_EXTENDED ) {
1254 bv.bv_len = lo->word.bv_len + op->ore_reqoid.bv_len + 2;
1255 bv.bv_val = ch_malloc( bv.bv_len + 1 );
1256 AC_MEMCPY( bv.bv_val, lo->word.bv_val, lo->word.bv_len );
1257 bv.bv_val[lo->word.bv_len] = '{';
1258 AC_MEMCPY( bv.bv_val+lo->word.bv_len+1, op->ore_reqoid.bv_val,
1259 op->ore_reqoid.bv_len );
1260 bv.bv_val[bv.bv_len-1] = '}';
1261 bv.bv_val[bv.bv_len] = '\0';
1262 attr_merge_one( e, ad_reqType, &bv, NULL );
1264 attr_merge_one( e, ad_reqType, &lo->word, NULL );
1267 rdn.bv_len = snprintf( rdn.bv_val, sizeof( rdnbuf ), "%lu", op->o_connid );
1268 if ( rdn.bv_len < sizeof( rdnbuf ) ) {
1269 attr_merge_one( e, ad_reqSession, &rdn, NULL );
1272 if ( BER_BVISNULL( &op->o_dn ) ) {
1273 attr_merge_one( e, ad_reqAuthzID, (struct berval *)&slap_empty_bv,
1274 (struct berval *)&slap_empty_bv );
1276 attr_merge_one( e, ad_reqAuthzID, &op->o_dn, &op->o_ndn );
1279 /* FIXME: need to add reqControls and reqRespControls */
1280 if ( op->o_ctrls ) {
1281 BerVarray vals = NULL,
1284 if ( accesslog_ctrls( op->o_ctrls, &vals, &nvals,
1285 op->o_tmpmemctx ) == LDAP_SUCCESS && vals )
1287 attr_merge( e, ad_reqControls, vals, nvals );
1288 ber_bvarray_free_x( vals, op->o_tmpmemctx );
1289 ber_bvarray_free_x( nvals, op->o_tmpmemctx );
1293 if ( rs->sr_ctrls ) {
1294 BerVarray vals = NULL,
1297 if ( accesslog_ctrls( rs->sr_ctrls, &vals, &nvals,
1298 op->o_tmpmemctx ) == LDAP_SUCCESS && vals )
1300 attr_merge( e, ad_reqRespControls, vals, nvals );
1301 ber_bvarray_free_x( vals, op->o_tmpmemctx );
1302 ber_bvarray_free_x( nvals, op->o_tmpmemctx );
1310 static struct berval scopes[] = {
1317 static struct berval derefs[] = {
1319 BER_BVC("searching"),
1324 static struct berval simple = BER_BVC("SIMPLE");
1326 static void accesslog_val2val(AttributeDescription *ad, struct berval *val,
1327 char c_op, struct berval *dst) {
1330 dst->bv_len = ad->ad_cname.bv_len + val->bv_len + 2;
1331 if ( c_op ) dst->bv_len++;
1333 dst->bv_val = ch_malloc( dst->bv_len+1 );
1335 ptr = lutil_strcopy( dst->bv_val, ad->ad_cname.bv_val );
1340 AC_MEMCPY( ptr, val->bv_val, val->bv_len );
1341 dst->bv_val[dst->bv_len] = '\0';
1344 static int accesslog_response(Operation *op, SlapReply *rs) {
1345 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1346 log_info *li = on->on_bi.bi_private;
1347 Attribute *a, *last_attr;
1353 Entry *e = NULL, *old = NULL;
1354 char timebuf[LDAP_LUTIL_GENTIME_BUFSIZE+8];
1358 Operation op2 = {0};
1359 SlapReply rs2 = {REP_RESULT};
1361 if ( rs->sr_type != REP_RESULT && rs->sr_type != REP_EXTENDED )
1362 return SLAP_CB_CONTINUE;
1364 switch ( op->o_tag ) {
1365 case LDAP_REQ_ADD: logop = LOG_EN_ADD; break;
1366 case LDAP_REQ_DELETE: logop = LOG_EN_DELETE; break;
1367 case LDAP_REQ_MODIFY: logop = LOG_EN_MODIFY; break;
1368 case LDAP_REQ_MODRDN: logop = LOG_EN_MODRDN; break;
1369 case LDAP_REQ_COMPARE: logop = LOG_EN_COMPARE; break;
1370 case LDAP_REQ_SEARCH: logop = LOG_EN_SEARCH; break;
1371 case LDAP_REQ_BIND: logop = LOG_EN_BIND; break;
1372 case LDAP_REQ_EXTENDED: logop = LOG_EN_EXTENDED; break;
1373 default: /* unknown operation type */
1374 logop = LOG_EN_UNKNOWN; break;
1375 } /* Unbind and Abandon never reach here */
1377 lo = logops+logop+EN_OFFSET;
1378 if ( !( li->li_ops & lo->mask ))
1379 return SLAP_CB_CONTINUE;
1381 if ( lo->mask & LOG_OP_WRITES ) {
1384 /* These internal ops are not logged */
1385 if ( op->o_dont_replicate && op->orm_no_opattrs )
1386 return SLAP_CB_CONTINUE;
1388 ldap_pvt_thread_mutex_lock( &li->li_log_mutex );
1391 /* Disarm mod_cleanup */
1392 for ( cb = op->o_callback; cb; cb = cb->sc_next ) {
1393 if ( cb->sc_private == (void *)on ) {
1394 cb->sc_private = NULL;
1398 ldap_pvt_thread_rmutex_unlock( &li->li_op_rmutex, op->o_tid );
1401 if ( li->li_success && rs->sr_err != LDAP_SUCCESS )
1404 e = accesslog_entry( op, rs, logop, &op2 );
1406 attr_merge_one( e, ad_reqDN, &op->o_req_dn, &op->o_req_ndn );
1408 if ( rs->sr_text ) {
1409 ber_str2bv( rs->sr_text, 0, 0, &bv );
1410 attr_merge_one( e, ad_reqMessage, &bv, NULL );
1412 bv.bv_len = snprintf( timebuf, sizeof( timebuf ), "%d", rs->sr_err );
1413 if ( bv.bv_len < sizeof( timebuf ) ) {
1414 bv.bv_val = timebuf;
1415 attr_merge_one( e, ad_reqResult, &bv, NULL );
1418 last_attr = attr_find( e->e_attrs, ad_reqResult );
1422 case LOG_EN_DELETE: {
1426 if ( logop == LOG_EN_ADD ) {
1435 /* count all the vals */
1437 for ( a=e2->e_attrs; a; a=a->a_next ) {
1440 vals = ch_malloc( (i+1) * sizeof( struct berval ));
1442 for ( a=e2->e_attrs; a; a=a->a_next ) {
1444 for (b=a->a_vals; !BER_BVISNULL( b ); b++,i++) {
1445 accesslog_val2val( a->a_desc, b, c_op, &vals[i] );
1449 vals[i].bv_val = NULL;
1451 a = attr_alloc( logop == LOG_EN_ADD ? ad_reqMod : ad_reqOld );
1455 last_attr->a_next = a;
1461 /* count all the mods */
1463 for ( m = op->orm_modlist; m; m = m->sml_next ) {
1464 if ( m->sml_values ) {
1465 i += m->sml_numvals;
1466 } else if ( m->sml_op == LDAP_MOD_DELETE ||
1467 m->sml_op == LDAP_MOD_REPLACE )
1472 vals = ch_malloc( (i+1) * sizeof( struct berval ));
1475 /* init flags on old entry */
1477 for ( a = old->e_attrs; a; a = a->a_next ) {
1481 /* look for attrs that are always logged */
1482 for ( la = li->li_oldattrs; la; la = la->next ) {
1483 if ( a->a_desc == la->attr ) {
1490 for ( m = op->orm_modlist; m; m = m->sml_next ) {
1491 /* Mark this attribute as modified */
1493 a = attr_find( old->e_attrs, m->sml_desc );
1499 /* don't log the RDN mods; they're explicitly logged later */
1500 if ( logop == LOG_EN_MODRDN &&
1501 ( m->sml_op == SLAP_MOD_SOFTADD ||
1502 m->sml_op == LDAP_MOD_DELETE ) )
1507 if ( m->sml_values ) {
1508 for ( b = m->sml_values; !BER_BVISNULL( b ); b++, i++ ) {
1511 switch ( m->sml_op ) {
1512 case LDAP_MOD_ADD: c_op = '+'; break;
1513 case LDAP_MOD_DELETE: c_op = '-'; break;
1514 case LDAP_MOD_REPLACE: c_op = '='; break;
1515 case LDAP_MOD_INCREMENT: c_op = '#'; break;
1517 /* unknown op. there shouldn't be any of these. we
1518 * don't know what to do with it, but we shouldn't just
1521 default: c_op = '?'; break;
1523 accesslog_val2val( m->sml_desc, b, c_op, &vals[i] );
1525 } else if ( m->sml_op == LDAP_MOD_DELETE ||
1526 m->sml_op == LDAP_MOD_REPLACE )
1528 vals[i].bv_len = m->sml_desc->ad_cname.bv_len + 2;
1529 vals[i].bv_val = ch_malloc( vals[i].bv_len + 1 );
1530 ptr = lutil_strcopy( vals[i].bv_val,
1531 m->sml_desc->ad_cname.bv_val );
1533 if ( m->sml_op == LDAP_MOD_DELETE ) {
1544 BER_BVZERO( &vals[i] );
1545 a = attr_alloc( ad_reqMod );
1549 last_attr->a_next = a;
1557 /* count all the vals */
1559 for ( a = old->e_attrs; a != NULL; a = a->a_next ) {
1560 if ( a->a_vals && a->a_flags ) {
1565 vals = ch_malloc( (i + 1) * sizeof( struct berval ) );
1567 for ( a=old->e_attrs; a; a=a->a_next ) {
1568 if ( a->a_vals && a->a_flags ) {
1569 for (b=a->a_vals; !BER_BVISNULL( b ); b++,i++) {
1570 accesslog_val2val( a->a_desc, b, 0, &vals[i] );
1574 vals[i].bv_val = NULL;
1576 a = attr_alloc( ad_reqOld );
1580 last_attr->a_next = a;
1583 if ( logop == LOG_EN_MODIFY ) {
1587 /* Now log the actual modRDN info */
1588 attr_merge_one( e, ad_reqNewRDN, &op->orr_newrdn, &op->orr_nnewrdn );
1589 attr_merge_one( e, ad_reqDeleteOldRDN, op->orr_deleteoldrdn ?
1590 (struct berval *)&slap_true_bv : (struct berval *)&slap_false_bv,
1592 if ( op->orr_newSup ) {
1593 attr_merge_one( e, ad_reqNewSuperior, op->orr_newSup, op->orr_nnewSup );
1597 case LOG_EN_COMPARE:
1598 bv.bv_len = op->orc_ava->aa_desc->ad_cname.bv_len + 1 +
1599 op->orc_ava->aa_value.bv_len;
1600 bv.bv_val = op->o_tmpalloc( bv.bv_len+1, op->o_tmpmemctx );
1601 ptr = lutil_strcopy( bv.bv_val, op->orc_ava->aa_desc->ad_cname.bv_val );
1603 AC_MEMCPY( ptr, op->orc_ava->aa_value.bv_val, op->orc_ava->aa_value.bv_len );
1604 bv.bv_val[bv.bv_len] = '\0';
1605 attr_merge_one( e, ad_reqAssertion, &bv, NULL );
1606 op->o_tmpfree( bv.bv_val, op->o_tmpmemctx );
1610 attr_merge_one( e, ad_reqScope, &scopes[op->ors_scope], NULL );
1611 attr_merge_one( e, ad_reqDerefAliases, &derefs[op->ors_deref], NULL );
1612 attr_merge_one( e, ad_reqAttrsOnly, op->ors_attrsonly ?
1613 (struct berval *)&slap_true_bv : (struct berval *)&slap_false_bv,
1615 if ( !BER_BVISEMPTY( &op->ors_filterstr ))
1616 attr_merge_one( e, ad_reqFilter, &op->ors_filterstr, NULL );
1617 if ( op->ors_attrs ) {
1619 for (i=0; !BER_BVISNULL(&op->ors_attrs[i].an_name );i++)
1621 vals = op->o_tmpalloc( (i+1) * sizeof(struct berval),
1623 for (i=0; !BER_BVISNULL(&op->ors_attrs[i].an_name );i++)
1624 vals[i] = op->ors_attrs[i].an_name;
1625 vals[i].bv_val = NULL;
1627 attr_merge( e, ad_reqAttr, vals, NULL );
1628 op->o_tmpfree( vals, op->o_tmpmemctx );
1630 bv.bv_val = timebuf;
1631 bv.bv_len = snprintf( bv.bv_val, sizeof( timebuf ), "%d", rs->sr_nentries );
1632 if ( bv.bv_len < sizeof( timebuf ) ) {
1633 attr_merge_one( e, ad_reqEntries, &bv, NULL );
1636 bv.bv_len = snprintf( bv.bv_val, sizeof( timebuf ), "%d", op->ors_tlimit );
1637 if ( bv.bv_len < sizeof( timebuf ) ) {
1638 attr_merge_one( e, ad_reqTimeLimit, &bv, NULL );
1641 bv.bv_len = snprintf( bv.bv_val, sizeof( timebuf ), "%d", op->ors_slimit );
1642 if ( bv.bv_len < sizeof( timebuf ) ) {
1643 attr_merge_one( e, ad_reqSizeLimit, &bv, NULL );
1648 bv.bv_val = timebuf;
1649 bv.bv_len = snprintf( bv.bv_val, sizeof( timebuf ), "%d", op->o_protocol );
1650 if ( bv.bv_len < sizeof( timebuf ) ) {
1651 attr_merge_one( e, ad_reqVersion, &bv, NULL );
1653 if ( op->orb_method == LDAP_AUTH_SIMPLE ) {
1654 attr_merge_one( e, ad_reqMethod, &simple, NULL );
1656 bv.bv_len = STRLENOF("SASL()") + op->orb_mech.bv_len;
1657 bv.bv_val = op->o_tmpalloc( bv.bv_len + 1, op->o_tmpmemctx );
1658 ptr = lutil_strcopy( bv.bv_val, "SASL(" );
1659 ptr = lutil_strcopy( ptr, op->orb_mech.bv_val );
1662 attr_merge_one( e, ad_reqMethod, &bv, NULL );
1663 op->o_tmpfree( bv.bv_val, op->o_tmpmemctx );
1668 case LOG_EN_EXTENDED:
1669 if ( op->ore_reqdata ) {
1670 attr_merge_one( e, ad_reqData, op->ore_reqdata, NULL );
1674 case LOG_EN_UNKNOWN:
1675 /* we don't know its parameters, don't add any */
1679 op2.o_hdr = op->o_hdr;
1680 op2.o_tag = LDAP_REQ_ADD;
1681 op2.o_bd = li->li_db;
1682 op2.o_dn = li->li_db->be_rootdn;
1683 op2.o_ndn = li->li_db->be_rootndn;
1684 op2.o_req_dn = e->e_name;
1685 op2.o_req_ndn = e->e_nname;
1687 op2.o_callback = &nullsc;
1689 if (( lo->mask & LOG_OP_WRITES ) && !BER_BVISEMPTY( &op->o_csn )) {
1690 slap_queue_csn( &op2, &op->o_csn );
1693 op2.o_bd->be_add( &op2, &rs2 );
1694 if ( e == op2.ora_e ) entry_free( e );
1698 if ( lo->mask & LOG_OP_WRITES )
1699 ldap_pvt_thread_mutex_unlock( &li->li_log_mutex );
1700 if ( old ) entry_free( old );
1701 return SLAP_CB_CONTINUE;
1704 /* Since Bind success is sent by the frontend, it won't normally enter
1705 * the overlay response callback. Add another callback to make sure it
1709 accesslog_bind_resp( Operation *op, SlapReply *rs )
1718 db.bd_info = op->o_callback->sc_private;
1719 rc = accesslog_response( op, rs );
1721 sc = op->o_callback;
1722 op->o_callback = sc->sc_next;
1723 op->o_tmpfree( sc, op->o_tmpmemctx );
1728 accesslog_op_bind( Operation *op, SlapReply *rs )
1732 sc = op->o_tmpcalloc( 1, sizeof(slap_callback), op->o_tmpmemctx );
1733 sc->sc_response = accesslog_bind_resp;
1734 sc->sc_private = op->o_bd->bd_info;
1736 if ( op->o_callback ) {
1737 sc->sc_next = op->o_callback->sc_next;
1738 op->o_callback->sc_next = sc;
1740 op->o_callback = sc;
1742 return SLAP_CB_CONTINUE;
1746 accesslog_mod_cleanup( Operation *op, SlapReply *rs )
1748 slap_callback *sc = op->o_callback;
1749 slap_overinst *on = sc->sc_private;
1750 op->o_callback = sc->sc_next;
1752 op->o_tmpfree( sc, op->o_tmpmemctx );
1755 BackendInfo *bi = op->o_bd->bd_info;
1756 op->o_bd->bd_info = (BackendInfo *)on;
1757 accesslog_response( op, rs );
1758 op->o_bd->bd_info = bi;
1764 accesslog_op_mod( Operation *op, SlapReply *rs )
1766 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1767 log_info *li = on->on_bi.bi_private;
1769 /* These internal ops are not logged */
1770 if ( op->o_dont_replicate && op->orm_no_opattrs )
1771 return SLAP_CB_CONTINUE;
1773 if ( li->li_ops & LOG_OP_WRITES ) {
1774 slap_callback *cb = op->o_tmpalloc( sizeof( slap_callback ), op->o_tmpmemctx ), *cb2;
1775 cb->sc_cleanup = accesslog_mod_cleanup;
1776 cb->sc_response = NULL;
1777 cb->sc_private = on;
1779 for ( cb2 = op->o_callback; cb2->sc_next; cb2 = cb2->sc_next );
1782 ldap_pvt_thread_rmutex_lock( &li->li_op_rmutex, op->o_tid );
1783 if ( li->li_oldf && ( op->o_tag == LDAP_REQ_DELETE ||
1784 op->o_tag == LDAP_REQ_MODIFY ||
1785 ( op->o_tag == LDAP_REQ_MODRDN && li->li_oldattrs ))) {
1789 op->o_bd->bd_info = (BackendInfo *)on->on_info;
1790 rc = be_entry_get_rw( op, &op->o_req_ndn, NULL, NULL, 0, &e );
1792 if ( test_filter( op, e, li->li_oldf ) == LDAP_COMPARE_TRUE )
1793 li->li_old = entry_dup( e );
1794 be_entry_release_rw( op, e, 0 );
1796 op->o_bd->bd_info = (BackendInfo *)on;
1799 return SLAP_CB_CONTINUE;
1802 /* unbinds are broadcast to all backends; we only log it if this
1803 * backend was used for the original bind.
1806 accesslog_unbind( Operation *op, SlapReply *rs )
1808 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1809 if ( op->o_conn->c_authz_backend == on->on_info->oi_origdb ) {
1810 log_info *li = on->on_bi.bi_private;
1811 Operation op2 = {0};
1812 void *cids[SLAP_MAX_CIDS];
1813 SlapReply rs2 = {REP_RESULT};
1816 if ( !( li->li_ops & LOG_OP_UNBIND ))
1817 return SLAP_CB_CONTINUE;
1819 e = accesslog_entry( op, rs, LOG_EN_UNBIND, &op2 );
1820 op2.o_hdr = op->o_hdr;
1821 op2.o_tag = LDAP_REQ_ADD;
1822 op2.o_bd = li->li_db;
1823 op2.o_dn = li->li_db->be_rootdn;
1824 op2.o_ndn = li->li_db->be_rootndn;
1825 op2.o_req_dn = e->e_name;
1826 op2.o_req_ndn = e->e_nname;
1828 op2.o_callback = &nullsc;
1829 op2.o_controls = cids;
1830 memset(cids, 0, sizeof( cids ));
1832 op2.o_bd->be_add( &op2, &rs2 );
1833 if ( e == op2.ora_e )
1836 return SLAP_CB_CONTINUE;
1840 accesslog_abandon( Operation *op, SlapReply *rs )
1842 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1843 log_info *li = on->on_bi.bi_private;
1844 Operation op2 = {0};
1845 void *cids[SLAP_MAX_CIDS];
1846 SlapReply rs2 = {REP_RESULT};
1851 if ( !op->o_time || !( li->li_ops & LOG_OP_ABANDON ))
1852 return SLAP_CB_CONTINUE;
1854 e = accesslog_entry( op, rs, LOG_EN_ABANDON, &op2 );
1856 bv.bv_len = snprintf( buf, sizeof( buf ), "%d", op->orn_msgid );
1857 if ( bv.bv_len < sizeof( buf ) ) {
1858 attr_merge_one( e, ad_reqId, &bv, NULL );
1861 op2.o_hdr = op->o_hdr;
1862 op2.o_tag = LDAP_REQ_ADD;
1863 op2.o_bd = li->li_db;
1864 op2.o_dn = li->li_db->be_rootdn;
1865 op2.o_ndn = li->li_db->be_rootndn;
1866 op2.o_req_dn = e->e_name;
1867 op2.o_req_ndn = e->e_nname;
1869 op2.o_callback = &nullsc;
1870 op2.o_controls = cids;
1871 memset(cids, 0, sizeof( cids ));
1873 op2.o_bd->be_add( &op2, &rs2 );
1874 if ( e == op2.ora_e )
1877 return SLAP_CB_CONTINUE;
1881 accesslog_operational( Operation *op, SlapReply *rs )
1883 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1884 log_info *li = on->on_bi.bi_private;
1886 if ( op->o_sync != SLAP_CONTROL_NONE )
1887 return SLAP_CB_CONTINUE;
1889 if ( rs->sr_entry != NULL
1890 && dn_match( &op->o_bd->be_nsuffix[0], &rs->sr_entry->e_nname ) )
1894 for ( ap = &rs->sr_operational_attrs; *ap; ap = &(*ap)->a_next )
1897 if ( SLAP_OPATTRS( rs->sr_attr_flags ) ||
1898 ad_inlist( ad_auditContext, rs->sr_attrs ) )
1900 *ap = attr_alloc( ad_auditContext );
1902 &li->li_db->be_suffix[0],
1903 &li->li_db->be_nsuffix[0], 1 );
1907 return SLAP_CB_CONTINUE;
1910 static slap_overinst accesslog;
1918 slap_overinst *on = (slap_overinst *)be->bd_info;
1919 log_info *li = ch_calloc(1, sizeof(log_info));
1921 on->on_bi.bi_private = li;
1922 ldap_pvt_thread_rmutex_init( &li->li_op_rmutex );
1923 ldap_pvt_thread_mutex_init( &li->li_log_mutex );
1928 accesslog_db_destroy(
1933 slap_overinst *on = (slap_overinst *)be->bd_info;
1934 log_info *li = on->on_bi.bi_private;
1938 filter_free( li->li_oldf );
1939 for ( la=li->li_oldattrs; la; la=li->li_oldattrs ) {
1940 li->li_oldattrs = la->next;
1943 ldap_pvt_thread_mutex_destroy( &li->li_log_mutex );
1944 ldap_pvt_thread_rmutex_destroy( &li->li_op_rmutex );
1946 return LDAP_SUCCESS;
1949 /* Create the logdb's root entry if it's missing */
1955 struct re_s *rtask = arg;
1956 slap_overinst *on = rtask->arg;
1957 log_info *li = on->on_bi.bi_private;
1959 Connection conn = {0};
1960 OperationBuffer opbuf;
1966 connection_fake_init( &conn, &opbuf, ctx );
1968 op->o_bd = li->li_db;
1969 op->o_dn = li->li_db->be_rootdn;
1970 op->o_ndn = li->li_db->be_rootndn;
1971 rc = be_entry_get_rw( op, li->li_db->be_nsuffix, NULL, NULL, 0, &e );
1974 be_entry_release_rw( op, e, 0 );
1977 SlapReply rs = {REP_RESULT};
1978 struct berval rdn, nrdn, attr;
1980 AttributeDescription *ad = NULL;
1981 const char *text = NULL;
1985 ber_dupbv( &e->e_name, li->li_db->be_suffix );
1986 ber_dupbv( &e->e_nname, li->li_db->be_nsuffix );
1988 attr_merge_one( e, slap_schema.si_ad_objectClass,
1989 &log_container->soc_cname, NULL );
1991 dnRdn( &e->e_name, &rdn );
1992 dnRdn( &e->e_nname, &nrdn );
1993 ptr = ber_bvchr( &rdn, '=' );
1995 assert( ptr != NULL );
1997 attr.bv_val = rdn.bv_val;
1998 attr.bv_len = ptr - rdn.bv_val;
2000 slap_bv2ad( &attr, &ad, &text );
2003 rdn.bv_len -= attr.bv_len + 1;
2004 ptr = ber_bvchr( &nrdn, '=' );
2005 nrdn.bv_len -= ptr - nrdn.bv_val + 1;
2006 nrdn.bv_val = ptr+1;
2007 attr_merge_one( e, ad, &rdn, &nrdn );
2009 /* Get contextCSN from main DB */
2010 op->o_bd = on->on_info->oi_origdb;
2011 rc = be_entry_get_rw( op, op->o_bd->be_nsuffix, NULL,
2012 slap_schema.si_ad_contextCSN, 0, &e_ctx );
2017 a = attr_find( e_ctx->e_attrs, slap_schema.si_ad_contextCSN );
2019 /* FIXME: contextCSN could have multiple values!
2020 * should select the one with the server's SID */
2021 attr_merge_one( e, slap_schema.si_ad_entryCSN,
2022 &a->a_vals[0], &a->a_nvals[0] );
2023 attr_merge( e, a->a_desc, a->a_vals, a->a_nvals );
2025 be_entry_release_rw( op, e_ctx, 0 );
2027 op->o_bd = li->li_db;
2030 op->o_req_dn = e->e_name;
2031 op->o_req_ndn = e->e_nname;
2032 op->o_callback = &nullsc;
2033 SLAP_DBFLAGS( op->o_bd ) |= SLAP_DBFLAG_NOLASTMOD;
2034 rc = op->o_bd->be_add( op, &rs );
2035 SLAP_DBFLAGS( op->o_bd ) ^= SLAP_DBFLAG_NOLASTMOD;
2036 if ( e == op->ora_e )
2039 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2040 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
2041 ldap_pvt_runqueue_remove( &slapd_rq, rtask );
2042 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2053 slap_overinst *on = (slap_overinst *)be->bd_info;
2054 log_info *li = on->on_bi.bi_private;
2057 if ( !BER_BVISEMPTY( &li->li_db_suffix )) {
2058 li->li_db = select_backend( &li->li_db_suffix, 0 );
2059 ch_free( li->li_db_suffix.bv_val );
2060 BER_BVZERO( &li->li_db_suffix );
2062 if ( li->li_db == NULL ) {
2063 Debug( LDAP_DEBUG_ANY,
2064 "accesslog: \"logdb <suffix>\" missing or invalid.\n",
2069 if ( slapMode & SLAP_TOOL_MODE )
2072 if ( BER_BVISEMPTY( &li->li_db->be_rootndn )) {
2073 ber_dupbv( &li->li_db->be_rootdn, li->li_db->be_suffix );
2074 ber_dupbv( &li->li_db->be_rootndn, li->li_db->be_nsuffix );
2077 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
2078 ldap_pvt_runqueue_insert( &slapd_rq, 3600, accesslog_db_root, on,
2079 "accesslog_db_root", li->li_db->be_suffix[0].bv_val );
2080 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
2085 int accesslog_initialize()
2089 accesslog.on_bi.bi_type = "accesslog";
2090 accesslog.on_bi.bi_db_init = accesslog_db_init;
2091 accesslog.on_bi.bi_db_destroy = accesslog_db_destroy;
2092 accesslog.on_bi.bi_db_open = accesslog_db_open;
2094 accesslog.on_bi.bi_op_add = accesslog_op_mod;
2095 accesslog.on_bi.bi_op_bind = accesslog_op_bind;
2096 accesslog.on_bi.bi_op_delete = accesslog_op_mod;
2097 accesslog.on_bi.bi_op_modify = accesslog_op_mod;
2098 accesslog.on_bi.bi_op_modrdn = accesslog_op_mod;
2099 accesslog.on_bi.bi_op_unbind = accesslog_unbind;
2100 accesslog.on_bi.bi_op_abandon = accesslog_abandon;
2101 accesslog.on_bi.bi_operational = accesslog_operational;
2102 accesslog.on_response = accesslog_response;
2104 accesslog.on_bi.bi_cf_ocs = log_cfocs;
2106 nullsc.sc_response = slap_null_cb;
2108 rc = config_register_schema( log_cfats, log_cfocs );
2109 if ( rc ) return rc;
2111 /* log schema integration */
2112 for ( i=0; lsyntaxes[i].oid; i++ ) {
2115 code = register_syntax( &lsyntaxes[ i ].syn );
2117 Debug( LDAP_DEBUG_ANY,
2118 "accesslog_init: register_syntax failed\n",
2123 if ( lsyntaxes[i].mrs != NULL ) {
2124 code = mr_make_syntax_compat_with_mrs(
2125 lsyntaxes[i].oid, lsyntaxes[i].mrs );
2127 Debug( LDAP_DEBUG_ANY,
2129 "mr_make_syntax_compat_with_mrs "
2137 for ( i=0; lattrs[i].at; i++ ) {
2140 code = register_at( lattrs[i].at, lattrs[i].ad, 0 );
2142 Debug( LDAP_DEBUG_ANY,
2143 "accesslog_init: register_at failed\n",
2148 (*lattrs[i].ad)->ad_type->sat_flags |= SLAP_AT_HIDE;
2152 for ( i=0; locs[i].ot; i++ ) {
2155 code = register_oc( locs[i].ot, locs[i].oc, 0 );
2157 Debug( LDAP_DEBUG_ANY,
2158 "accesslog_init: register_oc failed\n",
2163 (*locs[i].oc)->soc_flags |= SLAP_OC_HIDE;
2167 return overlay_register(&accesslog);
2170 #if SLAPD_OVER_ACCESSLOG == SLAPD_MOD_DYNAMIC
2172 init_module( int argc, char *argv[] )
2174 return accesslog_initialize();
2178 #endif /* SLAPD_OVER_ACCESSLOG */