1 /* slapi_overlay.c - SLAPI overlay */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2001-2005 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
17 * This work was initially developed by Luke Howard for inclusion
18 * in OpenLDAP Software.
25 #include <ac/string.h>
26 #include <ac/socket.h>
33 static slap_overinst slapi;
35 static int slapi_over_response( Operation *op, SlapReply *rs );
36 static int slapi_over_cleanup( Operation *op, SlapReply *rs );
39 slapi_over_pblock_new ( Operation *op )
43 pb = slapi_pblock_new();
49 pb->pconn = op->o_conn;
52 PBLOCK_ASSERT_OP( pb, 0 );
58 slapi_op_internal_p( Operation *op, slap_callback *cb )
61 Slapi_PBlock *pb = NULL;
65 * Abstraction violating check for SLAPI internal operations
66 * allows pblock to remain consistent when invoking internal
69 for ( pcb = op->o_callback; pcb != NULL; pcb = pcb->sc_next ) {
70 if ( pcb->sc_response == slapi_int_response ) {
71 pb = (Slapi_PBlock *)pcb->sc_private;
72 PBLOCK_ASSERT_INTOP( pb, 0 );
80 pb = slapi_over_pblock_new( op );
83 cb->sc_response = slapi_over_response;
84 cb->sc_cleanup = slapi_over_cleanup;
86 cb->sc_next = op->o_callback;
94 slapi_over_compute_output(
95 computed_attr_context *c,
96 Slapi_Attr *attribute,
101 AttributeDescription *desc;
102 SlapReply *rs = (SlapReply *)c->cac_private;
104 if ( c == NULL || attribute == NULL || entry == NULL ) {
108 assert( rs->sr_entry == entry );
110 desc = attribute->a_desc;
112 if ( rs->sr_attrs == NULL ) {
113 /* All attrs request, skip operational attributes */
114 if ( is_at_operational( desc->ad_type ) ) {
118 /* Specific attributes requested */
119 if ( is_at_operational( desc->ad_type ) ) {
120 if ( !SLAP_OPATTRS( rs->sr_attr_flags ) &&
121 !ad_inlist( desc, rs->sr_attrs ) ) {
125 if ( !SLAP_USERATTRS( rs->sr_attr_flags ) &&
126 !ad_inlist( desc, rs->sr_attrs ) ) {
132 /* XXX perhaps we should check for existing attributes and merge */
133 for ( a = &rs->sr_operational_attrs; *a != NULL; a = &(*a)->a_next )
136 *a = slapi_attr_dup( attribute );
142 slapi_over_aux_operational( Operation *op, SlapReply *rs )
144 /* Support for computed attribute plugins */
145 computed_attr_context ctx;
148 if ( slapi_op_internal_p( op, NULL ) ) {
149 return SLAP_CB_CONTINUE;
152 ctx.cac_pb = slapi_over_pblock_new( op );
154 ctx.cac_private = rs;
156 if ( rs->sr_entry != NULL ) {
158 * For each client requested attribute, call the plugins.
160 if ( rs->sr_attrs != NULL ) {
161 for ( anp = rs->sr_attrs; anp->an_name.bv_val != NULL; anp++ ) {
162 if ( compute_evaluator( &ctx, anp->an_name.bv_val,
163 rs->sr_entry, slapi_over_compute_output ) == 1 ) {
169 * Technically we shouldn't be returning operational attributes
170 * when the user requested only user attributes. We'll let the
171 * plugin decide whether to be naughty or not.
173 compute_evaluator( &ctx, "*", rs->sr_entry, slapi_over_compute_output );
177 slapi_pblock_destroy( ctx.cac_pb );
179 return SLAP_CB_CONTINUE;
183 slapi_over_search( Operation *op, SlapReply *rs, int type )
188 assert( rs->sr_type == REP_SEARCH || rs->sr_type == REP_SEARCHREF );
190 /* create a new pblock to not trample on result controls */
191 pb = slapi_over_pblock_new( op );
193 rc = slapi_int_call_plugins( op->o_bd, type, pb );
194 if ( rc >= 0 ) /* 1 means no plugins called */
195 rc = SLAP_CB_CONTINUE;
197 rc = LDAP_SUCCESS; /* confusing: don't abort, but don't send */
199 slapi_pblock_destroy(pb);
205 * Call pre- and post-result plugins
208 slapi_over_result( Operation *op, SlapReply *rs, int type )
210 Slapi_PBlock *pb = SLAPI_OPERATION_PBLOCK( op );
212 assert( rs->sr_type == REP_RESULT );
214 slapi_int_call_plugins( op->o_bd, type, pb );
216 return SLAP_CB_CONTINUE;
221 slapi_op_bind_callback( Operation *op, SlapReply *rs, int prc )
224 case SLAPI_BIND_SUCCESS:
225 /* Continue with backend processing */
227 case SLAPI_BIND_FAIL:
228 /* Failure, frontend (that's us) sends result */
229 rs->sr_err = LDAP_INVALID_CREDENTIALS;
230 send_ldap_result( op, rs );
233 case SLAPI_BIND_ANONYMOUS: /* undocumented */
234 default: /* plugin sent result or no plugins called */
235 BER_BVZERO( &op->orb_edn );
237 if ( rs->sr_err == LDAP_SUCCESS ) {
239 * Plugin will have called slapi_pblock_set(LDAP_CONN_DN) which
240 * will have set conn->c_dn and conn->c_ndn
242 if ( BER_BVISNULL( &op->o_conn->c_ndn ) && prc == 1 ) {
243 /* No plugins were called; continue processing */
246 ldap_pvt_thread_mutex_lock( &op->o_conn->c_mutex );
247 if ( !BER_BVISEMPTY( &op->o_conn->c_ndn ) ) {
248 ber_len_t max = sockbuf_max_incoming_auth;
249 ber_sockbuf_ctrl( op->o_conn->c_sb,
250 LBER_SB_OPT_SET_MAX_INCOMING, &max );
252 ldap_pvt_thread_mutex_unlock( &op->o_conn->c_mutex );
254 /* log authorization identity */
255 Statslog( LDAP_DEBUG_STATS,
256 "%s BIND dn=\"%s\" mech=%s (SLAPI) ssf=0\n",
258 BER_BVISNULL( &op->o_conn->c_dn )
259 ? "<empty>" : op->o_conn->c_dn.bv_val,
260 op->orb_tmp_mech.bv_val, 0, 0 );
271 slapi_op_search_callback( Operation *op, SlapReply *rs, int prc )
273 Slapi_PBlock *pb = SLAPI_OPERATION_PBLOCK( op );
275 /* check preoperation result code */
280 rs->sr_err = LDAP_SUCCESS;
282 if ( slapi_int_call_plugins( op->o_bd, SLAPI_PLUGIN_COMPUTE_SEARCH_REWRITER_FN, pb ) == 0 ) {
284 * The plugin can set the SLAPI_SEARCH_FILTER.
285 * SLAPI_SEARCH_STRFILER is not normative.
287 op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
288 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
294 struct slapi_op_info {
295 int soi_preop; /* preoperation plugin parameter */
296 int soi_postop; /* postoperation plugin parameter */
297 int soi_internal_preop; /* internal preoperation plugin parameter */
298 int soi_internal_postop; /* internal postoperation plugin parameter */
299 int (*soi_callback)(Operation *, SlapReply *, int); /* preoperation result handler */
300 } slapi_op_dispatch_table[] = {
302 SLAPI_PLUGIN_PRE_BIND_FN,
303 SLAPI_PLUGIN_POST_BIND_FN,
306 slapi_op_bind_callback
309 SLAPI_PLUGIN_PRE_UNBIND_FN,
310 SLAPI_PLUGIN_POST_UNBIND_FN,
316 SLAPI_PLUGIN_PRE_SEARCH_FN,
317 SLAPI_PLUGIN_POST_SEARCH_FN,
320 slapi_op_search_callback
323 SLAPI_PLUGIN_PRE_COMPARE_FN,
324 SLAPI_PLUGIN_POST_COMPARE_FN,
330 SLAPI_PLUGIN_PRE_MODIFY_FN,
331 SLAPI_PLUGIN_POST_MODIFY_FN,
332 SLAPI_PLUGIN_INTERNAL_PRE_MODIFY_FN,
333 SLAPI_PLUGIN_INTERNAL_POST_MODIFY_FN,
337 SLAPI_PLUGIN_PRE_MODRDN_FN,
338 SLAPI_PLUGIN_POST_MODRDN_FN,
339 SLAPI_PLUGIN_INTERNAL_PRE_MODRDN_FN,
340 SLAPI_PLUGIN_INTERNAL_POST_MODRDN_FN,
344 SLAPI_PLUGIN_PRE_ADD_FN,
345 SLAPI_PLUGIN_POST_ADD_FN,
346 SLAPI_PLUGIN_INTERNAL_PRE_ADD_FN,
347 SLAPI_PLUGIN_INTERNAL_POST_ADD_FN,
351 SLAPI_PLUGIN_PRE_DELETE_FN,
352 SLAPI_PLUGIN_POST_DELETE_FN,
353 SLAPI_PLUGIN_INTERNAL_PRE_DELETE_FN,
354 SLAPI_PLUGIN_INTERNAL_POST_DELETE_FN,
358 SLAPI_PLUGIN_PRE_ABANDON_FN,
359 SLAPI_PLUGIN_POST_ABANDON_FN,
374 slapi_tag2op( ber_tag_t tag )
385 case LDAP_REQ_DELETE:
388 case LDAP_REQ_MODRDN:
391 case LDAP_REQ_MODIFY:
394 case LDAP_REQ_COMPARE:
397 case LDAP_REQ_SEARCH:
400 case LDAP_REQ_UNBIND:
411 /* Add SLAPI_RESCONTROLS to rs->sr_ctrls, with care, because
412 * rs->sr_ctrls could be allocated on the stack */
414 slapi_over_merge_controls( Operation *op, SlapReply *rs )
416 Slapi_PBlock *pb = SLAPI_OPERATION_PBLOCK( op );
417 LDAPControl **ctrls = NULL;
418 LDAPControl **slapi_ctrls = NULL;
419 size_t n_slapi_ctrls = 0;
420 size_t n_rs_ctrls = 0;
423 slapi_pblock_get( pb, SLAPI_RESCONTROLS, (void **)&slapi_ctrls );
425 n_slapi_ctrls = slapi_int_count_controls( slapi_ctrls );
426 n_rs_ctrls = slapi_int_count_controls( rs->sr_ctrls );
428 slapi_pblock_set( pb, SLAPI_X_OLD_RESCONTROLS, (void *)rs->sr_ctrls );
430 if ( n_slapi_ctrls == 0 )
431 return LDAP_SUCCESS; /* no SLAPI controls */
433 ctrls = (LDAPControl **) op->o_tmpalloc(
434 ( n_slapi_ctrls + n_rs_ctrls + 1 ) * sizeof(LDAPControl *),
437 for ( i = 0; i < n_slapi_ctrls; i++ ) {
438 ctrls[i] = slapi_ctrls[i];
440 if ( rs->sr_ctrls != NULL ) {
441 for ( i = 0; i < n_rs_ctrls; i++ ) {
442 ctrls[n_slapi_ctrls + i] = rs->sr_ctrls[i];
446 rs->sr_ctrls = ctrls;
452 slapi_over_unmerge_controls( Operation *op, SlapReply *rs )
454 Slapi_PBlock *pb = SLAPI_OPERATION_PBLOCK( op );
455 LDAPControl **rs_ctrls = NULL;
457 slapi_pblock_get( pb, SLAPI_X_OLD_RESCONTROLS, (void **)&rs_ctrls );
459 if ( rs->sr_ctrls == NULL || rs->sr_ctrls == rs_ctrls ) {
460 /* no copying done */
464 op->o_tmpfree( rs->sr_ctrls, op->o_tmpmemctx );
465 rs->sr_ctrls = rs_ctrls;
471 slapi_over_response( Operation *op, SlapReply *rs )
473 Slapi_PBlock *pb = SLAPI_OPERATION_PBLOCK( op );
474 int rc = SLAP_CB_CONTINUE;
476 if ( pb->internal_op == 0 ) {
477 switch ( rs->sr_type ) {
479 rc = slapi_over_result( op, rs, SLAPI_PLUGIN_PRE_RESULT_FN );
482 rc = slapi_over_search( op, rs, SLAPI_PLUGIN_PRE_ENTRY_FN );
485 rc = slapi_over_search( op, rs, SLAPI_PLUGIN_PRE_REFERRAL_FN );
492 slapi_over_merge_controls( op, rs );
498 slapi_over_cleanup( Operation *op, SlapReply *rs )
500 Slapi_PBlock *pb = SLAPI_OPERATION_PBLOCK( op );
501 int rc = SLAP_CB_CONTINUE;
503 slapi_over_unmerge_controls( op, rs );
505 if ( pb->internal_op == 0 ) {
506 switch ( rs->sr_type ) {
508 rc = slapi_over_result( op, rs, SLAPI_PLUGIN_POST_RESULT_FN );
511 rc = slapi_over_search( op, rs, SLAPI_PLUGIN_POST_ENTRY_FN );
514 rc = slapi_over_search( op, rs, SLAPI_PLUGIN_POST_REFERRAL_FN );
525 slapi_op_func( Operation *op, SlapReply *rs )
528 slap_operation_t which;
529 struct slapi_op_info *opinfo;
535 int preop_type, postop_type;
537 if ( !slapi_plugins_used )
538 return SLAP_CB_CONTINUE;
541 * Find the SLAPI operation information for this LDAP
542 * operation; this will contain the preop and postop
543 * plugin types, as well as optional callbacks for
544 * setting up the SLAPI environment.
546 which = slapi_tag2op( op->o_tag );
547 if ( which >= op_last ) {
548 /* invalid operation, but let someone else deal with it */
549 return SLAP_CB_CONTINUE;
552 opinfo = &slapi_op_dispatch_table[which];
553 if ( opinfo == NULL ) {
554 /* no SLAPI plugin types for this operation */
555 return SLAP_CB_CONTINUE;
558 internal_op = slapi_op_internal_p( op, &cb );
561 preop_type = opinfo->soi_internal_preop;
562 postop_type = opinfo->soi_internal_postop;
564 preop_type = opinfo->soi_preop;
565 postop_type = opinfo->soi_postop;
568 if ( preop_type == 0 ) {
569 /* no SLAPI plugin types for this operation */
570 rc = SLAP_CB_CONTINUE;
574 pb = SLAPI_OPERATION_PBLOCK( op );
576 rc = slapi_int_call_plugins( op->o_bd, preop_type, pb );
579 * soi_callback is responsible for examining the result code
580 * of the preoperation plugin and determining whether to
581 * abort. This is needed because of special SLAPI behaviour
582 e with bind preoperation plugins.
584 * The soi_callback function is also used to reset any values
585 * returned from the preoperation plugin before calling the
586 * backend (for the success case).
588 if ( opinfo->soi_callback == NULL ) {
589 /* default behaviour is preop plugin can abort operation */
595 rc = (opinfo->soi_callback)( op, rs, rc );
601 * Call actual backend (or next overlay in stack). We need to
602 * do this rather than returning SLAP_CB_CONTINUE and calling
603 * postoperation plugins in a response handler to match the
604 * behaviour of SLAPI in OpenLDAP 2.2, where postoperation
605 * plugins are called after the backend has completely
606 * finished processing the operation.
608 on = (slap_overinst *)op->o_bd->bd_info;
611 rc = overlay_op_walk( op, rs, which, oi, on->on_next );
614 * Call postoperation plugins
616 slapi_int_call_plugins( op->o_bd, postop_type, pb );
619 if ( !internal_op ) {
620 slapi_pblock_destroy(pb);
621 cb.sc_private = NULL;
624 op->o_callback = cb.sc_next;
630 slapi_over_extended( Operation *op, SlapReply *rs )
638 slapi_int_get_extop_plugin( &op->ore_reqoid, &callback );
639 if ( callback == NULL ) {
640 return SLAP_CB_CONTINUE;
643 internal_op = slapi_op_internal_p( op, &cb );
645 return SLAP_CB_CONTINUE;
648 pb = SLAPI_OPERATION_PBLOCK( op );
650 rc = (*callback)( pb );
651 if ( rc == SLAPI_PLUGIN_EXTENDED_SENT_RESULT ) {
652 slapi_pblock_destroy( pb );
654 } else if ( rc == SLAPI_PLUGIN_EXTENDED_NOT_HANDLED ) {
655 slapi_pblock_destroy( pb );
656 return SLAP_CB_CONTINUE;
659 assert( rs->sr_rspoid != NULL );
661 send_ldap_extended( op, rs );
664 slapi_ch_free_string( (char **)&rs->sr_rspoid );
667 if ( rs->sr_rspdata != NULL )
668 ber_bvfree( rs->sr_rspdata );
670 slapi_pblock_destroy( pb );
676 slapi_over_access_allowed(
679 AttributeDescription *desc,
681 slap_access_t access,
682 AccessControlState *state,
690 internal_op = slapi_op_internal_p( op, &cb );
692 cb.sc_response = NULL;
693 cb.sc_cleanup = NULL;
695 pb = SLAPI_OPERATION_PBLOCK( op );
697 rc = slapi_int_access_allowed( op, e, desc, val, access, state );
699 rc = SLAP_CB_CONTINUE;
702 op->o_callback = cb.sc_next;
705 slapi_pblock_destroy( pb );
711 slapi_over_acl_group(
714 struct berval *gr_ndn,
715 struct berval *op_ndn,
716 ObjectClass *group_oc,
717 AttributeDescription *group_at )
722 BackendDB *be = op->o_bd;
725 op->o_bd = select_backend( gr_ndn, 0, 0 );
727 for ( g = op->o_groups; g; g = g->ga_next ) {
728 if ( g->ga_be != op->o_bd || g->ga_oc != group_oc ||
729 g->ga_at != group_at || g->ga_len != gr_ndn->bv_len )
733 if ( strcmp( g->ga_ndn, gr_ndn->bv_val ) == 0 ) {
742 if ( target != NULL && dn_match( &target->e_nname, gr_ndn ) ) {
746 rc = be_entry_get_rw( op, gr_ndn, group_oc, group_at, 0, &e );
752 internal_op = slapi_op_internal_p( op, &cb );
754 cb.sc_response = NULL;
755 cb.sc_cleanup = NULL;
757 pb = SLAPI_OPERATION_PBLOCK( op );
759 slapi_pblock_set( pb, SLAPI_X_GROUP_ENTRY, (void *)e );
760 slapi_pblock_set( pb, SLAPI_X_GROUP_OPERATION_DN, (void *)op_ndn->bv_val );
761 slapi_pblock_set( pb, SLAPI_X_GROUP_ATTRIBUTE, (void *)group_at->ad_cname.bv_val );
762 slapi_pblock_set( pb, SLAPI_X_GROUP_TARGET_ENTRY, (void *)target );
764 rc = slapi_int_call_plugins( op->o_bd, SLAPI_X_PLUGIN_PRE_GROUP_FN, pb );
765 if ( rc >= 0 ) /* 1 means no plugins called */
766 rc = SLAP_CB_CONTINUE;
770 slapi_pblock_delete_param( pb, SLAPI_X_GROUP_ENTRY );
771 slapi_pblock_delete_param( pb, SLAPI_X_GROUP_OPERATION_DN );
772 slapi_pblock_delete_param( pb, SLAPI_X_GROUP_ATTRIBUTE );
773 slapi_pblock_delete_param( pb, SLAPI_X_GROUP_TARGET_ENTRY );
776 slapi_pblock_destroy( pb );
779 be_entry_release_r( op, e );
782 rc = LDAP_NO_SUCH_OBJECT; /* return SLAP_CB_CONTINUE for correctness? */
785 if ( op->o_tag != LDAP_REQ_BIND && !op->o_do_not_cache &&
786 rc != SLAP_CB_CONTINUE ) {
787 g = op->o_tmpalloc( sizeof( GroupAssertion ) + gr_ndn->bv_len,
793 g->ga_len = gr_ndn->bv_len;
794 strcpy( g->ga_ndn, gr_ndn->bv_val );
795 g->ga_next = op->o_groups;
799 * XXX don't call POST_GROUP_FN, I have no idea what the point of
800 * that plugin function was anyway
808 slapi_int_overlay_init()
810 memset( &slapi, 0, sizeof(slapi) );
812 slapi.on_bi.bi_type = SLAPI_OVERLAY_NAME;
814 slapi.on_bi.bi_op_bind = slapi_op_func;
815 slapi.on_bi.bi_op_unbind = slapi_op_func;
816 slapi.on_bi.bi_op_search = slapi_op_func;
817 slapi.on_bi.bi_op_compare = slapi_op_func;
818 slapi.on_bi.bi_op_modify = slapi_op_func;
819 slapi.on_bi.bi_op_modrdn = slapi_op_func;
820 slapi.on_bi.bi_op_add = slapi_op_func;
821 slapi.on_bi.bi_op_delete = slapi_op_func;
822 slapi.on_bi.bi_op_abandon = slapi_op_func;
823 slapi.on_bi.bi_op_cancel = slapi_op_func;
825 slapi.on_bi.bi_extended = slapi_over_extended;
826 slapi.on_bi.bi_access_allowed = slapi_over_access_allowed;
827 slapi.on_bi.bi_operational = slapi_over_aux_operational;
828 slapi.on_bi.bi_acl_group = slapi_over_acl_group;
830 return overlay_register( &slapi );
833 #endif /* LDAP_SLAPI */