1 /* accesslog.c - log operations for audit/history purposes */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2005 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_info {
63 static ConfigDriver log_cf_gen;
72 static ConfigTable log_cfats[] = {
73 { "logdb", "suffix", 2, 2, 0, ARG_DN|ARG_MAGIC|LOG_DB,
74 log_cf_gen, "( OLcfgOvAt:4.1 NAME 'olcAccessLogDB' "
75 "DESC 'Suffix of database for log content' "
76 "SUP distinguishedName SINGLE-VALUE )", NULL, NULL },
77 { "logops", "op|writes|reads|session|all", 2, 0, 0,
79 log_cf_gen, "( OLcfgOvAt:4.2 NAME 'olcAccessLogOps' "
80 "DESC 'Operation types to log' "
81 "EQUALITY caseIgnoreMatch "
82 "SYNTAX OMsDirectoryString )", NULL, NULL },
83 { "logpurge", "age> <interval", 3, 3, 0, ARG_MAGIC|LOG_PURGE,
84 log_cf_gen, "( OLcfgOvAt:4.3 NAME 'olcAccessLogPurge' "
85 "DESC 'Log cleanup parameters' "
86 "SYNTAX OMsDirectoryString SINGLE-VALUE )", NULL, NULL },
87 { "logsuccess", NULL, 2, 2, 0, ARG_MAGIC|ARG_ON_OFF|LOG_SUCCESS,
88 log_cf_gen, "( OLcfgOvAt:4.4 NAME 'olcAccessLogSuccess' "
89 "DESC 'Log successful ops only' "
90 "SYNTAX OMsBoolean SINGLE-VALUE )", NULL, NULL },
94 static ConfigOCs log_cfocs[] = {
96 "NAME 'olcAccessLogConfig' "
97 "DESC 'Access log configuration' "
98 "SUP olcOverlayConfig "
99 "MUST olcAccessLogDB "
100 "MAY ( olcAccessLogOps $ olcAccessLogPurge $ olcAccessLogSuccess ) )",
101 Cft_Overlay, log_cfats },
105 static slap_verbmasks logops[] = {
106 { BER_BVC("all"), LOG_OP_ALL },
107 { BER_BVC("writes"), LOG_OP_WRITES },
108 { BER_BVC("session"), LOG_OP_SESSION },
109 { BER_BVC("reads"), LOG_OP_READS },
110 { BER_BVC("add"), LOG_OP_ADD },
111 { BER_BVC("delete"), LOG_OP_DELETE },
112 { BER_BVC("modify"), LOG_OP_MODIFY },
113 { BER_BVC("modrdn"), LOG_OP_MODRDN },
114 { BER_BVC("compare"), LOG_OP_COMPARE },
115 { BER_BVC("search"), LOG_OP_SEARCH },
116 { BER_BVC("bind"), LOG_OP_BIND },
117 { BER_BVC("unbind"), LOG_OP_UNBIND },
118 { BER_BVC("abandon"), LOG_OP_ABANDON },
119 { BER_BVC("extended"), LOG_OP_EXTENDED },
120 { BER_BVC("unknown"), LOG_OP_UNKNOWN },
124 /* Start with "add" in logops */
142 static ObjectClass *log_ocs[LOG_EN__COUNT];
144 #define LOG_SCHEMA_ROOT "1.3.6.1.4.1.4203.666.11.5"
146 #define LOG_SCHEMA_AT LOG_SCHEMA_ROOT ".1"
147 #define LOG_SCHEMA_OC LOG_SCHEMA_ROOT ".2"
149 static AttributeDescription *ad_reqDN, *ad_reqStart, *ad_reqEnd, *ad_reqType,
150 *ad_reqSession, *ad_reqResult, *ad_reqAuthzID, *ad_reqControls,
151 *ad_reqRespControls, *ad_reqMethod, *ad_reqAssertion, *ad_reqNewRDN,
152 *ad_reqNewSuperior, *ad_reqDeleteOldRDN, *ad_reqMod,
153 *ad_reqScope, *ad_reqFilter, *ad_reqAttr, *ad_reqEntries,
154 *ad_reqSizeLimit, *ad_reqTimeLimit, *ad_reqAttrsOnly, *ad_reqData,
155 *ad_reqId, *ad_reqMessage;
157 static AttributeDescription *ad_oldest;
162 AttributeDescription **ad;
164 { "( " LOG_SCHEMA_AT ".1 NAME 'reqDN' "
165 "DESC 'Target DN of request' "
166 "EQUALITY distinguishedNameMatch "
168 "SINGLE-VALUE )", &ad_reqDN },
169 { "( " LOG_SCHEMA_AT ".2 NAME 'reqStart' "
170 "DESC 'Start time of request' "
171 "EQUALITY generalizedTimeMatch "
172 "ORDERING generalizedTimeOrderingMatch "
173 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.24 "
174 "SINGLE-VALUE )", &ad_reqStart },
175 { "( " LOG_SCHEMA_AT ".3 NAME 'reqEnd' "
176 "DESC 'End time of request' "
177 "EQUALITY generalizedTimeMatch "
178 "ORDERING generalizedTimeOrderingMatch "
179 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.24 "
180 "SINGLE-VALUE )", &ad_reqEnd },
181 { "( " LOG_SCHEMA_AT ".4 NAME 'reqType' "
182 "DESC 'Type of request' "
183 "EQUALITY caseIgnoreMatch "
184 "SYNTAX OMsDirectoryString "
185 "SINGLE-VALUE )", &ad_reqType },
186 { "( " LOG_SCHEMA_AT ".5 NAME 'reqSession' "
187 "DESC 'Session ID of request' "
188 "EQUALITY caseIgnoreMatch "
189 "SYNTAX OMsDirectoryString "
190 "SINGLE-VALUE )", &ad_reqSession },
191 { "( " LOG_SCHEMA_AT ".6 NAME 'reqResult' "
192 "DESC 'Result code of request' "
193 "EQUALITY integerMatch "
195 "SINGLE-VALUE )", &ad_reqResult },
196 { "( " LOG_SCHEMA_AT ".7 NAME 'reqAuthzID' "
197 "DESC 'Authorization ID of requestor' "
198 "EQUALITY distinguishedNameMatch "
200 "SINGLE-VALUE )", &ad_reqAuthzID },
201 { "( " LOG_SCHEMA_AT ".8 NAME 'reqControls' "
202 "DESC 'Request controls' "
203 "SYNTAX OMsOctetString )", &ad_reqControls },
204 { "( " LOG_SCHEMA_AT ".9 NAME 'reqRespControls' "
205 "DESC 'Response controls of request' "
206 "SYNTAX OMsOctetString )", &ad_reqRespControls },
207 { "( " LOG_SCHEMA_AT ".10 NAME 'reqMethod' "
208 "DESC 'Bind method of request' "
209 "EQUALITY caseIgnoreMatch "
210 "SYNTAX OMsDirectoryString "
211 "SINGLE-VALUE )", &ad_reqMethod },
212 { "( " LOG_SCHEMA_AT ".11 NAME 'reqAssertion' "
213 "DESC 'Compare Assertion of request' "
214 "SYNTAX OMsDirectoryString "
215 "SINGLE-VALUE )", &ad_reqAssertion },
216 { "( " LOG_SCHEMA_AT ".12 NAME 'reqNewRDN' "
217 "DESC 'New RDN of request' "
218 "EQUALITY distinguishedNameMatch "
220 "SINGLE-VALUE )", &ad_reqNewRDN },
221 { "( " LOG_SCHEMA_AT ".13 NAME 'reqNewSuperior' "
222 "DESC 'New superior DN of request' "
223 "EQUALITY distinguishedNameMatch "
225 "SINGLE-VALUE )", &ad_reqNewSuperior },
226 { "( " LOG_SCHEMA_AT ".14 NAME 'reqDeleteOldRDN' "
227 "DESC 'Delete old RDN' "
229 "SINGLE-VALUE )", &ad_reqDeleteOldRDN },
230 { "( " LOG_SCHEMA_AT ".15 NAME 'reqMod' "
231 "DESC 'Modifications of request' "
232 "SYNTAX OMsDirectoryString "
233 "EQUALITY caseIgnoreMatch "
234 "SUBSTR caseIgnoreSubstringsMatch )", &ad_reqMod },
235 { "( " LOG_SCHEMA_AT ".16 NAME 'reqScope' "
236 "DESC 'Scope of request' "
237 "SYNTAX OMsDirectoryString "
238 "SINGLE-VALUE )", &ad_reqScope },
239 { "( " LOG_SCHEMA_AT ".17 NAME 'reqFilter' "
240 "DESC 'Filter of request' "
241 "SYNTAX OMsDirectoryString "
242 "SINGLE-VALUE )", &ad_reqFilter },
243 { "( " LOG_SCHEMA_AT ".18 NAME 'reqAttr' "
244 "DESC 'Attributes of request' "
245 "SYNTAX OMsDirectoryString )", &ad_reqAttr },
246 { "( " LOG_SCHEMA_AT ".19 NAME 'reqEntries' "
247 "DESC 'Number of entries returned' "
249 "SINGLE-VALUE )", &ad_reqEntries },
250 { "( " LOG_SCHEMA_AT ".20 NAME 'reqSizeLimit' "
251 "DESC 'Size limit of request' "
253 "SINGLE-VALUE )", &ad_reqSizeLimit },
254 { "( " LOG_SCHEMA_AT ".21 NAME 'reqTimeLimit' "
255 "DESC 'Time limit of request' "
257 "SINGLE-VALUE )", &ad_reqTimeLimit },
258 { "( " LOG_SCHEMA_AT ".22 NAME 'reqAttrsOnly' "
259 "DESC 'Attributes and values of request' "
261 "SINGLE-VALUE )", &ad_reqAttrsOnly },
262 { "( " LOG_SCHEMA_AT ".23 NAME 'reqData' "
263 "DESC 'Data of extended request' "
264 "SYNTAX OMsOctetString "
265 "SINGLE-VALUE )", &ad_reqData },
266 { "( " LOG_SCHEMA_AT ".24 NAME 'reqId' "
267 "DESC 'ID of Request to Abandon' "
269 "SINGLE-VALUE )", &ad_reqId },
270 { "( " LOG_SCHEMA_AT ".25 NAME 'reqMessage' "
271 "DESC 'Error text of request' "
272 "SYNTAX OMsDirectoryString "
273 "SINGLE-VALUE )", &ad_reqMessage },
275 { "( " LOG_SCHEMA_AT ".26 NAME 'auditOldest' "
276 "DESC 'Oldest record in this branch' "
277 "EQUALITY generalizedTimeMatch "
278 "ORDERING generalizedTimeOrderingMatch "
279 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.24 "
280 "SINGLE-VALUE )", &ad_oldest },
290 { "( " LOG_SCHEMA_OC ".0 NAME 'auditContainer' "
291 "SUP top STRUCTURAL "
293 "MAY cn )", &oc_container },
295 { "( " LOG_SCHEMA_OC ".1 NAME 'auditObject' "
296 "DESC 'OpenLDAP request auditing' "
297 "SUP top STRUCTURAL "
298 "MUST ( reqStart $ reqType $ reqSession ) "
299 "MAY ( reqDN $ reqAuthzID $ reqControls $ reqRespControls $ reqEnd $ "
300 "reqResult $ reqMessage ) )", &log_ocs[LOG_EN_UNBIND] },
301 { "( " LOG_SCHEMA_OC ".2 NAME 'auditReadObject' "
302 "DESC 'OpenLDAP read request record' "
303 "SUP auditObject STRUCTURAL )", NULL },
304 { "( " LOG_SCHEMA_OC ".3 NAME 'auditWriteObject' "
305 "DESC 'OpenLDAP write request record' "
306 "SUP auditObject STRUCTURAL )", &log_ocs[LOG_EN_DELETE] },
307 { "( " LOG_SCHEMA_OC ".4 NAME 'auditAbandon' "
308 "DESC 'Abandon operation' "
309 "SUP auditObject STRUCTURAL "
310 "MUST reqId )", &log_ocs[LOG_EN_ABANDON] },
311 { "( " LOG_SCHEMA_OC ".5 NAME 'auditAdd' "
312 "DESC 'Add operation' "
313 "SUP auditWriteObject STRUCTURAL "
314 "MUST reqMod )", &log_ocs[LOG_EN_ADD] },
315 { "( " LOG_SCHEMA_OC ".6 NAME 'auditBind' "
316 "DESC 'Bind operation' "
317 "SUP auditObject STRUCTURAL "
318 "MUST reqMethod )", &log_ocs[LOG_EN_BIND] },
319 { "( " LOG_SCHEMA_OC ".7 NAME 'auditCompare' "
320 "DESC 'Compare operation' "
321 "SUP auditReadObject STRUCTURAL "
322 "MUST reqAssertion )", &log_ocs[LOG_EN_COMPARE] },
323 { "( " LOG_SCHEMA_OC ".8 NAME 'auditModify' "
324 "DESC 'Modify operation' "
325 "SUP auditWriteObject STRUCTURAL "
326 "MUST reqMod )", &log_ocs[LOG_EN_MODIFY] },
327 { "( " LOG_SCHEMA_OC ".9 NAME 'auditModRDN' "
328 "DESC 'ModRDN operation' "
329 "SUP auditWriteObject STRUCTURAL "
330 "MUST ( reqNewRDN $ reqDeleteOldRDN ) "
331 "MAY reqNewSuperior )", &log_ocs[LOG_EN_MODRDN] },
332 { "( " LOG_SCHEMA_OC ".10 NAME 'auditSearch' "
333 "DESC 'Search operation' "
334 "SUP auditReadObject STRUCTURAL "
335 "MUST ( reqScope $ reqAttrsonly ) "
336 "MAY ( reqFilter $ reqAttr $ reqEntries $ reqSizeLimit $ "
337 "reqTimeLimit ) )", &log_ocs[LOG_EN_SEARCH] },
338 { "( " LOG_SCHEMA_OC ".11 NAME 'auditExtended' "
339 "DESC 'Extended operation' "
340 "SUP auditObject STRUCTURAL "
341 "MAY reqData )", &log_ocs[LOG_EN_EXTENDED] },
345 #define RDNEQ "reqStart="
347 /* Our time intervals are of the form [dd+]hh:mm[:ss]
348 * If a field is present, it must be two digits. We assume no one
349 * will want to keep log records for longer than 99 days.
352 log_age_parse(char *agestr)
358 /* Is there a days delimiter? */
359 if ( agestr[2] == '+' ) {
362 } else if ( agestr[2] != ':' ) {
363 /* No valid delimiter found, fail */
370 /* if there's a delimiter, it can only be a colon */
371 if ( agestr[2] && agestr[2] != ':' )
374 /* If we're at the end of the string, and we started with days,
375 * fail because we expected to find minutes too.
377 if ( gotdays && !agestr[2] )
389 /* last field can only be seconds */
390 if ( agestr[2] && ( agestr[2] != ':' || !gotdays ))
400 t1 += atoi( agestr );
406 log_age_unparse( int age, struct berval *agebv )
422 ptr += sprintf( ptr, "%02d+", dd );
423 ptr += sprintf( ptr, "%02d:%02d", hh, mm );
425 ptr += sprintf( ptr, ":%02d", ss );
427 agebv->bv_len = ptr - agebv->bv_val;
430 static slap_callback nullsc = { NULL, NULL, NULL, NULL };
432 #define PURGE_INCREMENT 100
434 typedef struct purge_data {
442 log_old_lookup( Operation *op, SlapReply *rs )
444 purge_data *pd = op->o_callback->sc_private;
446 if ( rs->sr_type != REP_SEARCH) return 0;
448 if ( pd->used >= pd->slots ) {
449 pd->slots += PURGE_INCREMENT;
450 pd->dn = ch_realloc( pd->dn, pd->slots * sizeof( struct berval ));
451 pd->ndn = ch_realloc( pd->ndn, pd->slots * sizeof( struct berval ));
453 ber_dupbv( &pd->dn[pd->used], &rs->sr_entry->e_name );
454 ber_dupbv( &pd->ndn[pd->used], &rs->sr_entry->e_nname );
459 /* Periodically search for old entries in the log database and delete them */
461 accesslog_purge( void *ctx, void *arg )
463 struct re_s *rtask = arg;
464 struct log_info *li = rtask->arg;
466 Connection conn = {0};
467 char opbuf[OPERATION_BUFFER_SIZE];
468 Operation *op = (Operation *)opbuf;
469 SlapReply rs = {REP_RESULT};
470 slap_callback cb = { NULL, log_old_lookup, NULL, NULL };
472 AttributeAssertion ava = {0};
474 char timebuf[LDAP_LUTIL_GENTIME_BUFSIZE];
475 time_t old = slap_get_time();
477 connection_fake_init( &conn, op, ctx );
479 f.f_choice = LDAP_FILTER_LE;
483 ava.aa_desc = ad_reqStart;
484 ava.aa_value.bv_val = timebuf;
485 ava.aa_value.bv_len = sizeof(timebuf);
488 slap_timestamp( &old, &ava.aa_value );
490 op->o_tag = LDAP_REQ_SEARCH;
491 op->o_bd = li->li_db;
492 op->o_dn = li->li_db->be_rootdn;
493 op->o_ndn = li->li_db->be_rootndn;
494 op->o_req_dn = li->li_db->be_suffix[0];
495 op->o_req_ndn = li->li_db->be_nsuffix[0];
496 op->o_callback = &cb;
497 op->ors_scope = LDAP_SCOPE_ONELEVEL;
498 op->ors_deref = LDAP_DEREF_NEVER;
499 op->ors_tlimit = SLAP_NO_LIMIT;
500 op->ors_slimit = SLAP_NO_LIMIT;
502 filter2bv_x( op, &f, &op->ors_filterstr );
503 op->ors_attrs = slap_anlist_no_attrs;
504 op->ors_attrsonly = 1;
508 op->o_bd->be_search( op, &rs );
509 op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
514 op->o_tag = LDAP_REQ_DELETE;
515 op->o_callback = &nullsc;
517 for (i=0; i<pd.used; i++) {
518 op->o_req_dn = pd.dn[i];
519 op->o_req_ndn = pd.ndn[i];
520 op->o_bd->be_delete( op, &rs );
521 ch_free( pd.ndn[i].bv_val );
522 ch_free( pd.dn[i].bv_val );
528 ldap_pvt_thread_mutex_lock( &slapd_rq.rq_mutex );
529 ldap_pvt_runqueue_stoptask( &slapd_rq, rtask );
530 ldap_pvt_thread_mutex_unlock( &slapd_rq.rq_mutex );
536 log_cf_gen(ConfigArgs *c)
538 slap_overinst *on = (slap_overinst *)c->bi;
539 struct log_info *li = on->on_bi.bi_private;
541 slap_mask_t tmask = 0;
542 char agebuf[2*STRLENOF("dd+hh:mm:ss ")];
543 struct berval agebv, cyclebv;
546 case SLAP_CONFIG_EMIT:
549 value_add( &c->rvalue_vals, li->li_db->be_suffix );
550 value_add( &c->rvalue_nvals, li->li_db->be_nsuffix );
553 rc = mask_to_verbs( logops, li->li_ops, &c->rvalue_vals );
556 agebv.bv_val = agebuf;
557 log_age_unparse( li->li_age, &agebv );
558 agebv.bv_val[agebv.bv_len] = ' ';
560 cyclebv.bv_val = agebv.bv_val + agebv.bv_len;
561 log_age_unparse( li->li_cycle, &cyclebv );
562 agebv.bv_len += cyclebv.bv_len;
563 value_add_one( &c->rvalue_vals, &agebv );
566 if ( li->li_success )
567 c->value_int = li->li_success;
573 case LDAP_MOD_DELETE:
576 /* noop. this should always be a valid backend. */
582 rc = verbs_to_mask( 1, &c->line, logops, &tmask );
584 li->li_ops &= ~tmask;
589 struct re_s *re = li->li_task;
591 if ( ldap_pvt_runqueue_isrunning( &slapd_rq, re ))
592 ldap_pvt_runqueue_stoptask( &slapd_rq, re );
593 ldap_pvt_runqueue_remove( &slapd_rq, re );
606 li->li_db = select_backend( &c->value_ndn, 0, 0 );
608 sprintf( c->msg, "<%s> no matching backend found for suffix",
610 Debug( LDAP_DEBUG_ANY, "%s: %s \"%s\"\n",
611 c->log, c->msg, c->value_dn.bv_val );
614 ch_free( c->value_dn.bv_val );
615 ch_free( c->value_ndn.bv_val );
618 rc = verbs_to_mask( c->argc, c->argv, logops, &tmask );
623 li->li_age = log_age_parse( c->argv[1] );
624 if ( li->li_age == -1 ) {
627 li->li_cycle = log_age_parse( c->argv[2] );
628 if ( li->li_cycle == -1 ) {
630 } else if ( slapMode & SLAP_SERVER_MODE ) {
631 struct re_s *re = li->li_task;
633 re->interval.tv_sec = li->li_cycle;
635 li->li_task = ldap_pvt_runqueue_insert( &slapd_rq,
636 li->li_cycle, accesslog_purge, li,
637 "accesslog_purge", li->li_db ?
638 li->li_db->be_suffix[0].bv_val :
639 c->be->be_suffix[0].bv_val );
644 li->li_success = c->value_int;
652 static Entry *accesslog_entry( Operation *op, int logop ) {
653 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
654 log_info *li = on->on_bi.bi_private;
656 char rdnbuf[STRLENOF(RDNEQ)+LDAP_LUTIL_GENTIME_BUFSIZE+8];
657 struct berval rdn, timestamp, bv;
658 slap_verbmasks *lo = logops+logop+EN_OFFSET;
660 Entry *e = ch_calloc( 1, sizeof(Entry) );
662 strcpy( rdnbuf, RDNEQ );
665 timestamp.bv_val = rdnbuf+STRLENOF(RDNEQ);
666 timestamp.bv_len = sizeof(rdnbuf) - STRLENOF(RDNEQ);
667 slap_timestamp( &op->o_time, ×tamp );
669 sprintf( timestamp.bv_val + timestamp.bv_len-1, ".%06dZ", op->o_tincr );
670 timestamp.bv_len += 7;
672 rdn.bv_len = STRLENOF(RDNEQ)+timestamp.bv_len;
673 build_new_dn( &e->e_name, li->li_db->be_suffix, &rdn, NULL );
674 build_new_dn( &e->e_nname, li->li_db->be_nsuffix, &rdn, NULL );
676 attr_merge_one( e, slap_schema.si_ad_objectClass,
677 &log_ocs[logop]->soc_cname, NULL );
678 attr_merge_one( e, slap_schema.si_ad_structuralObjectClass,
679 &log_ocs[logop]->soc_cname, NULL );
680 attr_merge_one( e, ad_reqStart, ×tamp, NULL );
682 /* Exops have OID appended */
683 if ( logop == LOG_EN_EXTENDED ) {
684 bv.bv_len = lo->word.bv_len + op->ore_reqoid.bv_len + 2;
685 bv.bv_val = ch_malloc( bv.bv_len + 1 );
686 AC_MEMCPY( bv.bv_val, lo->word.bv_val, lo->word.bv_len );
687 bv.bv_val[lo->word.bv_len] = '{';
688 AC_MEMCPY( bv.bv_val+lo->word.bv_len+1, op->ore_reqoid.bv_val,
689 op->ore_reqoid.bv_len );
690 bv.bv_val[bv.bv_len-1] = '}';
691 bv.bv_val[bv.bv_len] = '\0';
692 attr_merge_one( e, ad_reqType, &bv, NULL );
694 attr_merge_one( e, ad_reqType, &lo->word, NULL );
697 rdn.bv_len = sprintf( rdn.bv_val, "%lu", op->o_connid );
698 attr_merge_one( e, ad_reqSession, &rdn, NULL );
700 if ( BER_BVISNULL( &op->o_dn ))
701 attr_merge_one( e, ad_reqAuthzID, (struct berval *)&slap_empty_bv,
702 (struct berval *)&slap_empty_bv );
704 attr_merge_one( e, ad_reqAuthzID, &op->o_dn, &op->o_ndn );
706 /* FIXME: need to add reqControls and reqRespControls */
711 static struct berval scopes[] = {
715 BER_BVC("subordinate")
718 static struct berval simple = BER_BVC("SIMPLE");
720 static int accesslog_response(Operation *op, SlapReply *rs) {
721 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
722 log_info *li = on->on_bi.bi_private;
723 Attribute *a, *last_attr;
731 char timebuf[LDAP_LUTIL_GENTIME_BUFSIZE];
736 SlapReply rs2 = {REP_RESULT};
738 if ( rs->sr_type != REP_RESULT && rs->sr_type != REP_EXTENDED )
739 return SLAP_CB_CONTINUE;
741 if ( li->li_success && rs->sr_err != LDAP_SUCCESS )
742 return SLAP_CB_CONTINUE;
744 switch ( op->o_tag ) {
745 case LDAP_REQ_ADD: logop = LOG_EN_ADD; break;
746 case LDAP_REQ_DELETE: logop = LOG_EN_DELETE; break;
747 case LDAP_REQ_MODIFY: logop = LOG_EN_MODIFY; break;
748 case LDAP_REQ_MODRDN: logop = LOG_EN_MODRDN; break;
749 case LDAP_REQ_COMPARE: logop = LOG_EN_COMPARE; break;
750 case LDAP_REQ_SEARCH: logop = LOG_EN_SEARCH; break;
751 case LDAP_REQ_BIND: logop = LOG_EN_BIND; break;
752 case LDAP_REQ_EXTENDED: logop = LOG_EN_EXTENDED; break;
753 default: /* unknown operation type */
754 logop = LOG_EN_UNKNOWN; break;
755 } /* Unbind and Abandon never reach here */
757 lo = logops+logop+EN_OFFSET;
758 if ( !( li->li_ops & lo->mask ))
759 return SLAP_CB_CONTINUE;
761 endtime = slap_get_time();
763 e = accesslog_entry( op, logop );
766 bv.bv_len = sizeof(timebuf);
767 slap_timestamp( &endtime, &bv );
769 attr_merge_one( e, ad_reqEnd, &bv, NULL );
771 attr_merge_one( e, ad_reqDN, &op->o_req_dn, &op->o_req_ndn );
774 ber_str2bv( rs->sr_text, 0, 0, &bv );
775 attr_merge_one( e, ad_reqMessage, &bv, NULL );
777 bv.bv_len = sprintf( timebuf, "%d", rs->sr_err );
780 attr_merge_one( e, ad_reqResult, &bv, NULL );
782 last_attr = attr_find( e->e_attrs, ad_reqResult );
786 /* count all the vals */
788 for ( a=op->ora_e->e_attrs; a; a=a->a_next ) {
790 for (b=a->a_vals; !BER_BVISNULL( b ); b++) {
795 vals = ch_malloc( (i+1) * sizeof( struct berval ));
797 for ( a=op->ora_e->e_attrs; a; a=a->a_next ) {
799 for (b=a->a_vals; !BER_BVISNULL( b ); b++,i++) {
800 vals[i].bv_len = a->a_desc->ad_cname.bv_len + b->bv_len +3;
801 vals[i].bv_val = ch_malloc( vals[i].bv_len+1 );
802 ptr = lutil_strcopy( vals[i].bv_val,
803 a->a_desc->ad_cname.bv_val );
807 AC_MEMCPY( ptr, b->bv_val, b->bv_len );
808 vals[i].bv_val[vals[i].bv_len] = '\0';
812 vals[i].bv_val = NULL;
814 a = attr_alloc( ad_reqMod );
817 last_attr->a_next = a;
821 /* needs nothing else */
825 /* count all the mods */
827 for ( m=op->orm_modlist; m; m=m->sml_next ) {
828 if ( m->sml_values ) {
829 for (b=m->sml_values; !BER_BVISNULL( b ); b++) {
832 } else if ( m->sml_op == LDAP_MOD_DELETE ) {
836 vals = ch_malloc( (i+1) * sizeof( struct berval ));
838 for ( m=op->orm_modlist; m; m=m->sml_next ) {
839 if ( m->sml_values ) {
840 for (b=m->sml_values; !BER_BVISNULL( b ); b++,i++) {
842 vals[i].bv_len = m->sml_desc->ad_cname.bv_len + b->bv_len +3;
843 vals[i].bv_val = ch_malloc( vals[i].bv_len+1 );
844 ptr = lutil_strcopy( vals[i].bv_val,
845 m->sml_desc->ad_cname.bv_val );
847 switch( m->sml_op ) {
848 case LDAP_MOD_ADD: c_op = '+'; break;
849 case LDAP_MOD_DELETE: c_op = '-'; break;
850 case LDAP_MOD_REPLACE: c_op = '='; break;
851 case LDAP_MOD_INCREMENT: c_op = '#'; break;
853 /* unknown op. there shouldn't be any of these. we
854 * don't know what to do with it, but we shouldn't just
857 default: c_op = '?'; break;
861 AC_MEMCPY( ptr, b->bv_val, b->bv_len );
862 vals[i].bv_val[vals[i].bv_len] = '\0';
864 } else if ( m->sml_op == LDAP_MOD_DELETE ) {
865 vals[i].bv_len = m->sml_desc->ad_cname.bv_len + 2;
866 vals[i].bv_val = ch_malloc( vals[i].bv_len+1 );
867 ptr = lutil_strcopy( vals[i].bv_val,
868 m->sml_desc->ad_cname.bv_val );
875 vals[i].bv_val = NULL;
877 a = attr_alloc( ad_reqMod );
880 last_attr->a_next = a;
884 attr_merge_one( e, ad_reqNewRDN, &op->orr_newrdn, &op->orr_nnewrdn );
885 attr_merge_one( e, ad_reqDeleteOldRDN, op->orr_deleteoldrdn ?
886 (struct berval *)&slap_true_bv : (struct berval *)&slap_false_bv,
888 if ( op->orr_newSup ) {
889 attr_merge_one( e, ad_reqNewSuperior, op->orr_newSup, op->orr_nnewSup );
894 bv.bv_len = op->orc_ava->aa_desc->ad_cname.bv_len + 1 +
895 op->orc_ava->aa_value.bv_len;
896 bv.bv_val = op->o_tmpalloc( bv.bv_len+1, op->o_tmpmemctx );
897 ptr = lutil_strcopy( bv.bv_val, op->orc_ava->aa_desc->ad_cname.bv_val );
899 AC_MEMCPY( ptr, op->orc_ava->aa_value.bv_val, op->orc_ava->aa_value.bv_len );
900 bv.bv_val[bv.bv_len] = '\0';
901 attr_merge_one( e, ad_reqAssertion, &bv, NULL );
902 op->o_tmpfree( bv.bv_val, op->o_tmpmemctx );
906 attr_merge_one( e, ad_reqScope, &scopes[op->ors_scope], NULL );
907 attr_merge_one( e, ad_reqAttrsOnly, op->ors_attrsonly ?
908 (struct berval *)&slap_true_bv : (struct berval *)&slap_false_bv,
910 if ( !BER_BVISEMPTY( &op->ors_filterstr ))
911 attr_merge_one( e, ad_reqFilter, &op->ors_filterstr, NULL );
912 if ( op->ors_attrs ) {
914 for (i=0; !BER_BVISNULL(&op->ors_attrs[i].an_name );i++)
916 vals = op->o_tmpalloc( (i+1) * sizeof(struct berval),
918 for (i=0; !BER_BVISNULL(&op->ors_attrs[i].an_name );i++)
919 vals[i] = op->ors_attrs[i].an_name;
920 vals[i].bv_val = NULL;
922 attr_merge( e, ad_reqAttr, vals, NULL );
923 op->o_tmpfree( vals, op->o_tmpmemctx );
926 bv.bv_len = sprintf( bv.bv_val, "%d", rs->sr_nentries );
927 attr_merge_one( e, ad_reqEntries, &bv, NULL );
929 bv.bv_len = sprintf( bv.bv_val, "%d", op->ors_tlimit );
930 attr_merge_one( e, ad_reqTimeLimit, &bv, NULL );
931 /* FIXME: slimit was zeroed by the backends */
935 if ( op->orb_method == LDAP_AUTH_SIMPLE ) {
936 attr_merge_one( e, ad_reqMethod, &simple, NULL );
938 bv.bv_len = STRLENOF("SASL()") + op->orb_tmp_mech.bv_len;
939 bv.bv_val = op->o_tmpalloc( bv.bv_len + 1, op->o_tmpmemctx );
940 ptr = lutil_strcopy( bv.bv_val, "SASL(" );
941 ptr = lutil_strcopy( ptr, op->orb_tmp_mech.bv_val );
944 attr_merge_one( e, ad_reqMethod, &bv, NULL );
945 op->o_tmpfree( bv.bv_val, op->o_tmpmemctx );
949 case LOG_EN_EXTENDED:
950 if ( op->ore_reqdata ) {
951 attr_merge_one( e, ad_reqData, op->ore_reqdata, NULL );
956 /* we don't know its parameters, don't add any */
960 op2.o_hdr = op->o_hdr;
961 op2.o_tag = LDAP_REQ_ADD;
962 op2.o_time = endtime;
964 op2.o_bd = li->li_db;
965 op2.o_dn = li->li_db->be_rootdn;
966 op2.o_ndn = li->li_db->be_rootndn;
967 op2.o_req_dn = e->e_name;
968 op2.o_req_ndn = e->e_nname;
970 op2.o_callback = &nullsc;
972 if ( lo->mask & LOG_OP_WRITES ) {
973 slap_get_commit_csn( op, NULL, &bv );
974 attr_merge_one( e, slap_schema.si_ad_entryCSN, &bv, NULL );
975 slap_queue_csn( &op2, &bv );
978 op2.o_bd->be_add( &op2, &rs2 );
979 slap_graduate_commit_csn( &op2 );
982 return SLAP_CB_CONTINUE;
985 /* unbinds are broadcast to all backends; we only log it if this
986 * backend was used for the original bind.
989 accesslog_unbind( Operation *op, SlapReply *rs )
991 if ( op->o_conn->c_authz_backend == op->o_bd ) {
992 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
993 log_info *li = on->on_bi.bi_private;
995 SlapReply rs2 = {REP_RESULT};
998 if ( !( li->li_ops & LOG_OP_UNBIND ))
999 return SLAP_CB_CONTINUE;
1001 e = accesslog_entry( op, LOG_EN_UNBIND );
1002 op2.o_hdr = op->o_hdr;
1003 op2.o_tag = LDAP_REQ_ADD;
1004 op2.o_time = op->o_time;
1006 op2.o_bd = li->li_db;
1007 op2.o_dn = li->li_db->be_rootdn;
1008 op2.o_ndn = li->li_db->be_rootndn;
1009 op2.o_req_dn = e->e_name;
1010 op2.o_req_ndn = e->e_nname;
1012 op2.o_callback = &nullsc;
1014 op2.o_bd->be_add( &op2, &rs2 );
1017 return SLAP_CB_CONTINUE;
1021 accesslog_abandon( Operation *op, SlapReply *rs )
1023 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
1024 log_info *li = on->on_bi.bi_private;
1026 SlapReply rs2 = {REP_RESULT};
1031 if ( !op->o_time || !( li->li_ops & LOG_OP_ABANDON ))
1032 return SLAP_CB_CONTINUE;
1034 e = accesslog_entry( op, LOG_EN_ABANDON );
1036 bv.bv_len = sprintf( buf, "%d", op->orn_msgid );
1037 attr_merge_one( e, ad_reqId, &bv, NULL );
1039 op2.o_hdr = op->o_hdr;
1040 op2.o_tag = LDAP_REQ_ADD;
1041 op2.o_time = op->o_time;
1043 op2.o_bd = li->li_db;
1044 op2.o_dn = li->li_db->be_rootdn;
1045 op2.o_ndn = li->li_db->be_rootndn;
1046 op2.o_req_dn = e->e_name;
1047 op2.o_req_ndn = e->e_nname;
1049 op2.o_callback = &nullsc;
1051 op2.o_bd->be_add( &op2, &rs2 );
1054 return SLAP_CB_CONTINUE;
1057 static slap_overinst accesslog;
1064 slap_overinst *on = (slap_overinst *)be->bd_info;
1065 log_info *li = ch_calloc(1, sizeof(log_info));
1067 on->on_bi.bi_private = li;
1072 accesslog_db_destroy(
1076 slap_overinst *on = (slap_overinst *)be->bd_info;
1077 log_info *li = on->on_bi.bi_private;
1080 return LDAP_SUCCESS;
1083 int accesslog_init()
1087 accesslog.on_bi.bi_type = "accesslog";
1088 accesslog.on_bi.bi_db_init = accesslog_db_init;
1089 accesslog.on_bi.bi_db_destroy = accesslog_db_destroy;
1091 accesslog.on_bi.bi_op_unbind = accesslog_unbind;
1092 accesslog.on_bi.bi_op_abandon = accesslog_abandon;
1093 accesslog.on_response = accesslog_response;
1095 accesslog.on_bi.bi_cf_ocs = log_cfocs;
1097 nullsc.sc_response = slap_null_cb;
1099 rc = config_register_schema( log_cfats, log_cfocs );
1100 if ( rc ) return rc;
1102 /* log schema integration */
1103 for ( i=0; lattrs[i].at; i++ ) {
1104 LDAPAttributeType *lat;
1109 lat = ldap_str2attributetype( lattrs[i].at, &code, &err,
1110 LDAP_SCHEMA_ALLOW_ALL );
1112 Debug( LDAP_DEBUG_ANY, "accesslog_init: "
1113 "ldap_str2attributetype failed on %d: %s, %s\n",
1114 i, ldap_scherr2str(code), err );
1117 code = at_add( lat, 0, &at, &err );
1118 ldap_memfree( lat );
1120 Debug( LDAP_DEBUG_ANY, "log_back_initialize: "
1121 "at_add failed on %d: %s\n",
1122 i, scherr2str(code), 0 );
1125 if ( slap_bv2ad( &at->sat_cname, lattrs[i].ad, &err )) {
1126 Debug( LDAP_DEBUG_ANY, "accesslog_init: "
1127 "slap_bv2ad failed on %d: %s\n",
1132 for ( i=0; locs[i].ot; i++ ) {
1133 LDAPObjectClass *loc;
1138 loc = ldap_str2objectclass( locs[i].ot, &code, &err,
1139 LDAP_SCHEMA_ALLOW_ALL );
1141 Debug( LDAP_DEBUG_ANY, "accesslog_init: "
1142 "ldap_str2objectclass failed on %d: %s, %s\n",
1143 i, ldap_scherr2str(code), err );
1147 code = oc_add( loc, 0, &oc, &err );
1148 ldap_memfree( loc );
1150 Debug( LDAP_DEBUG_ANY, "accesslog_init: "
1151 "oc_add failed on %d: %s\n",
1152 i, scherr2str(code), 0 );
1159 return overlay_register(&accesslog);
1162 #if SLAPD_OVER_ACCESSLOG == SLAPD_MOD_DYNAMIC
1163 int init_module( int argc, char *argv[]) {
1164 return accesslog_init();
1168 #endif /* SLAPD_OVER_ACCESSLOG */