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, SlapReply *rs )
43 pb = slapi_pblock_new();
45 pb->pb_conn = op->o_conn;
49 PBLOCK_ASSERT_OP( pb, op->o_tag );
55 slapi_op_internal_p( Operation *op, SlapReply *rs, slap_callback *cb )
58 Slapi_PBlock *pb = NULL;
62 * Abstraction violating check for SLAPI internal operations
63 * allows pblock to remain consistent when invoking internal
66 for ( pcb = op->o_callback; pcb != NULL; pcb = pcb->sc_next ) {
67 if ( pcb->sc_response == slapi_int_response ) {
68 pb = (Slapi_PBlock *)pcb->sc_private;
69 PBLOCK_ASSERT_INTOP( pb, 0 );
77 pb = slapi_over_pblock_new( op, rs );
80 cb->sc_response = slapi_over_response;
81 cb->sc_cleanup = slapi_over_cleanup;
83 cb->sc_next = op->o_callback;
91 slapi_over_compute_output(
92 computed_attr_context *c,
93 Slapi_Attr *attribute,
98 AttributeDescription *desc;
99 SlapReply *rs = (SlapReply *)c->cac_private;
101 if ( c == NULL || attribute == NULL || entry == NULL ) {
105 assert( rs->sr_entry == entry );
107 desc = attribute->a_desc;
109 if ( rs->sr_attrs == NULL ) {
110 /* All attrs request, skip operational attributes */
111 if ( is_at_operational( desc->ad_type ) ) {
115 /* Specific attributes requested */
116 if ( is_at_operational( desc->ad_type ) ) {
117 if ( !SLAP_OPATTRS( rs->sr_attr_flags ) &&
118 !ad_inlist( desc, rs->sr_attrs ) ) {
122 if ( !SLAP_USERATTRS( rs->sr_attr_flags ) &&
123 !ad_inlist( desc, rs->sr_attrs ) ) {
129 /* XXX perhaps we should check for existing attributes and merge */
130 for ( a = &rs->sr_operational_attrs; *a != NULL; a = &(*a)->a_next )
133 *a = slapi_attr_dup( attribute );
139 slapi_over_aux_operational( Operation *op, SlapReply *rs )
141 /* Support for computed attribute plugins */
142 computed_attr_context ctx;
145 if ( slapi_op_internal_p( op, rs, NULL ) ) {
146 return SLAP_CB_CONTINUE;
149 ctx.cac_pb = slapi_over_pblock_new( op, rs );
151 ctx.cac_private = rs;
153 if ( rs->sr_entry != NULL ) {
155 * For each client requested attribute, call the plugins.
157 if ( rs->sr_attrs != NULL ) {
158 for ( anp = rs->sr_attrs; anp->an_name.bv_val != NULL; anp++ ) {
159 if ( compute_evaluator( &ctx, anp->an_name.bv_val,
160 rs->sr_entry, slapi_over_compute_output ) == 1 ) {
166 * Technically we shouldn't be returning operational attributes
167 * when the user requested only user attributes. We'll let the
168 * plugin decide whether to be naughty or not.
170 compute_evaluator( &ctx, "*", rs->sr_entry, slapi_over_compute_output );
174 slapi_pblock_destroy( ctx.cac_pb );
176 return SLAP_CB_CONTINUE;
180 slapi_over_search( Operation *op, SlapReply *rs, int type )
185 assert( rs->sr_type == REP_SEARCH || rs->sr_type == REP_SEARCHREF );
187 /* create a new pblock to not trample on result controls */
188 pb = slapi_over_pblock_new( op, rs );
190 rc = slapi_int_call_plugins( op->o_bd, type, pb );
191 if ( rc >= 0 ) /* 1 means no plugins called */
192 rc = SLAP_CB_CONTINUE;
194 rc = LDAP_SUCCESS; /* confusing: don't abort, but don't send */
196 slapi_pblock_destroy(pb);
202 * Call pre- and post-result plugins
205 slapi_over_result( Operation *op, SlapReply *rs, int type )
207 Slapi_PBlock *pb = SLAPI_OPERATION_PBLOCK( op );
209 assert( rs->sr_type == REP_RESULT );
211 slapi_int_call_plugins( op->o_bd, type, pb );
213 return SLAP_CB_CONTINUE;
218 slapi_op_bind_callback( Operation *op, SlapReply *rs, int prc )
221 case SLAPI_BIND_SUCCESS:
222 /* Continue with backend processing */
224 case SLAPI_BIND_FAIL:
225 /* Failure, frontend (that's us) sends result */
226 rs->sr_err = LDAP_INVALID_CREDENTIALS;
227 send_ldap_result( op, rs );
230 case SLAPI_BIND_ANONYMOUS: /* undocumented */
231 default: /* plugin sent result or no plugins called */
232 BER_BVZERO( &op->orb_edn );
234 if ( rs->sr_err == LDAP_SUCCESS ) {
236 * Plugin will have called slapi_pblock_set(LDAP_CONN_DN) which
237 * will have set conn->c_dn and conn->c_ndn
239 if ( BER_BVISNULL( &op->o_conn->c_ndn ) && prc == 1 ) {
240 /* No plugins were called; continue processing */
243 ldap_pvt_thread_mutex_lock( &op->o_conn->c_mutex );
244 if ( !BER_BVISEMPTY( &op->o_conn->c_ndn ) ) {
245 ber_len_t max = sockbuf_max_incoming_auth;
246 ber_sockbuf_ctrl( op->o_conn->c_sb,
247 LBER_SB_OPT_SET_MAX_INCOMING, &max );
249 ldap_pvt_thread_mutex_unlock( &op->o_conn->c_mutex );
251 /* log authorization identity */
252 Statslog( LDAP_DEBUG_STATS,
253 "%s BIND dn=\"%s\" mech=%s (SLAPI) ssf=0\n",
255 BER_BVISNULL( &op->o_conn->c_dn )
256 ? "<empty>" : op->o_conn->c_dn.bv_val,
257 op->orb_tmp_mech.bv_val, 0, 0 );
268 slapi_op_search_callback( Operation *op, SlapReply *rs, int prc )
270 Slapi_PBlock *pb = SLAPI_OPERATION_PBLOCK( op );
272 /* check preoperation result code */
277 rs->sr_err = LDAP_SUCCESS;
279 if ( slapi_int_call_plugins( op->o_bd, SLAPI_PLUGIN_COMPUTE_SEARCH_REWRITER_FN, pb ) == 0 ) {
281 * The plugin can set the SLAPI_SEARCH_FILTER.
282 * SLAPI_SEARCH_STRFILER is not normative.
284 op->o_tmpfree( op->ors_filterstr.bv_val, op->o_tmpmemctx );
285 filter2bv_x( op, op->ors_filter, &op->ors_filterstr );
291 struct slapi_op_info {
292 int soi_preop; /* preoperation plugin parameter */
293 int soi_postop; /* postoperation plugin parameter */
294 int soi_internal_preop; /* internal preoperation plugin parameter */
295 int soi_internal_postop; /* internal postoperation plugin parameter */
296 int (*soi_callback)(Operation *, SlapReply *, int); /* preoperation result handler */
297 } slapi_op_dispatch_table[] = {
299 SLAPI_PLUGIN_PRE_BIND_FN,
300 SLAPI_PLUGIN_POST_BIND_FN,
303 slapi_op_bind_callback
306 SLAPI_PLUGIN_PRE_UNBIND_FN,
307 SLAPI_PLUGIN_POST_UNBIND_FN,
313 SLAPI_PLUGIN_PRE_SEARCH_FN,
314 SLAPI_PLUGIN_POST_SEARCH_FN,
317 slapi_op_search_callback
320 SLAPI_PLUGIN_PRE_COMPARE_FN,
321 SLAPI_PLUGIN_POST_COMPARE_FN,
327 SLAPI_PLUGIN_PRE_MODIFY_FN,
328 SLAPI_PLUGIN_POST_MODIFY_FN,
329 SLAPI_PLUGIN_INTERNAL_PRE_MODIFY_FN,
330 SLAPI_PLUGIN_INTERNAL_POST_MODIFY_FN,
334 SLAPI_PLUGIN_PRE_MODRDN_FN,
335 SLAPI_PLUGIN_POST_MODRDN_FN,
336 SLAPI_PLUGIN_INTERNAL_PRE_MODRDN_FN,
337 SLAPI_PLUGIN_INTERNAL_POST_MODRDN_FN,
341 SLAPI_PLUGIN_PRE_ADD_FN,
342 SLAPI_PLUGIN_POST_ADD_FN,
343 SLAPI_PLUGIN_INTERNAL_PRE_ADD_FN,
344 SLAPI_PLUGIN_INTERNAL_POST_ADD_FN,
348 SLAPI_PLUGIN_PRE_DELETE_FN,
349 SLAPI_PLUGIN_POST_DELETE_FN,
350 SLAPI_PLUGIN_INTERNAL_PRE_DELETE_FN,
351 SLAPI_PLUGIN_INTERNAL_POST_DELETE_FN,
355 SLAPI_PLUGIN_PRE_ABANDON_FN,
356 SLAPI_PLUGIN_POST_ABANDON_FN,
371 slapi_tag2op( ber_tag_t tag )
382 case LDAP_REQ_DELETE:
385 case LDAP_REQ_MODRDN:
388 case LDAP_REQ_MODIFY:
391 case LDAP_REQ_COMPARE:
394 case LDAP_REQ_SEARCH:
397 case LDAP_REQ_UNBIND:
408 /* Add SLAPI_RESCONTROLS to rs->sr_ctrls, with care, because
409 * rs->sr_ctrls could be allocated on the stack */
411 slapi_over_merge_controls( Operation *op, SlapReply *rs )
413 Slapi_PBlock *pb = SLAPI_OPERATION_PBLOCK( op );
414 LDAPControl **ctrls = NULL;
415 LDAPControl **slapi_ctrls = NULL;
416 size_t n_slapi_ctrls = 0;
417 size_t n_rs_ctrls = 0;
420 slapi_pblock_get( pb, SLAPI_RESCONTROLS, (void **)&slapi_ctrls );
422 n_slapi_ctrls = slapi_int_count_controls( slapi_ctrls );
423 n_rs_ctrls = slapi_int_count_controls( rs->sr_ctrls );
425 slapi_pblock_set( pb, SLAPI_X_OLD_RESCONTROLS, (void *)rs->sr_ctrls );
427 if ( n_slapi_ctrls == 0 )
428 return LDAP_SUCCESS; /* no SLAPI controls */
430 ctrls = (LDAPControl **) op->o_tmpalloc(
431 ( n_slapi_ctrls + n_rs_ctrls + 1 ) * sizeof(LDAPControl *),
434 for ( i = 0; i < n_slapi_ctrls; i++ ) {
435 ctrls[i] = slapi_ctrls[i];
437 if ( rs->sr_ctrls != NULL ) {
438 for ( i = 0; i < n_rs_ctrls; i++ ) {
439 ctrls[n_slapi_ctrls + i] = rs->sr_ctrls[i];
443 rs->sr_ctrls = ctrls;
449 slapi_over_unmerge_controls( Operation *op, SlapReply *rs )
451 Slapi_PBlock *pb = SLAPI_OPERATION_PBLOCK( op );
452 LDAPControl **rs_ctrls = NULL;
454 slapi_pblock_get( pb, SLAPI_X_OLD_RESCONTROLS, (void **)&rs_ctrls );
456 if ( rs->sr_ctrls == NULL || rs->sr_ctrls == rs_ctrls ) {
457 /* no copying done */
461 op->o_tmpfree( rs->sr_ctrls, op->o_tmpmemctx );
462 rs->sr_ctrls = rs_ctrls;
468 slapi_over_response( Operation *op, SlapReply *rs )
470 Slapi_PBlock *pb = SLAPI_OPERATION_PBLOCK( op );
471 int rc = SLAP_CB_CONTINUE;
473 if ( pb->pb_intop == 0 ) {
474 switch ( rs->sr_type ) {
476 rc = slapi_over_result( op, rs, SLAPI_PLUGIN_PRE_RESULT_FN );
479 rc = slapi_over_search( op, rs, SLAPI_PLUGIN_PRE_ENTRY_FN );
482 rc = slapi_over_search( op, rs, SLAPI_PLUGIN_PRE_REFERRAL_FN );
489 slapi_over_merge_controls( op, rs );
495 slapi_over_cleanup( Operation *op, SlapReply *rs )
497 Slapi_PBlock *pb = SLAPI_OPERATION_PBLOCK( op );
498 int rc = SLAP_CB_CONTINUE;
500 slapi_over_unmerge_controls( op, rs );
502 if ( pb->pb_intop == 0 ) {
503 switch ( rs->sr_type ) {
505 rc = slapi_over_result( op, rs, SLAPI_PLUGIN_POST_RESULT_FN );
508 rc = slapi_over_search( op, rs, SLAPI_PLUGIN_POST_ENTRY_FN );
511 rc = slapi_over_search( op, rs, SLAPI_PLUGIN_POST_REFERRAL_FN );
522 slapi_op_func( Operation *op, SlapReply *rs )
525 slap_operation_t which;
526 struct slapi_op_info *opinfo;
532 int preop_type, postop_type;
534 if ( !slapi_plugins_used )
535 return SLAP_CB_CONTINUE;
538 * Find the SLAPI operation information for this LDAP
539 * operation; this will contain the preop and postop
540 * plugin types, as well as optional callbacks for
541 * setting up the SLAPI environment.
543 which = slapi_tag2op( op->o_tag );
544 if ( which >= op_last ) {
545 /* invalid operation, but let someone else deal with it */
546 return SLAP_CB_CONTINUE;
549 opinfo = &slapi_op_dispatch_table[which];
550 if ( opinfo == NULL ) {
551 /* no SLAPI plugin types for this operation */
552 return SLAP_CB_CONTINUE;
555 internal_op = slapi_op_internal_p( op, rs, &cb );
558 preop_type = opinfo->soi_internal_preop;
559 postop_type = opinfo->soi_internal_postop;
561 preop_type = opinfo->soi_preop;
562 postop_type = opinfo->soi_postop;
565 if ( preop_type == 0 ) {
566 /* no SLAPI plugin types for this operation */
568 rc = SLAP_CB_CONTINUE;
572 pb = SLAPI_OPERATION_PBLOCK( op );
574 rc = slapi_int_call_plugins( op->o_bd, preop_type, pb );
577 * soi_callback is responsible for examining the result code
578 * of the preoperation plugin and determining whether to
579 * abort. This is needed because of special SLAPI behaviour
580 e with bind preoperation plugins.
582 * The soi_callback function is also used to reset any values
583 * returned from the preoperation plugin before calling the
584 * backend (for the success case).
586 if ( opinfo->soi_callback == NULL ) {
587 /* default behaviour is preop plugin can abort operation */
593 rc = (opinfo->soi_callback)( op, rs, rc );
599 * Call actual backend (or next overlay in stack). We need to
600 * do this rather than returning SLAP_CB_CONTINUE and calling
601 * postoperation plugins in a response handler to match the
602 * behaviour of SLAPI in OpenLDAP 2.2, where postoperation
603 * plugins are called after the backend has completely
604 * finished processing the operation.
606 on = (slap_overinst *)op->o_bd->bd_info;
609 rc = overlay_op_walk( op, rs, which, oi, on->on_next );
612 * Call postoperation plugins
614 slapi_int_call_plugins( op->o_bd, postop_type, pb );
617 if ( !internal_op ) {
618 slapi_pblock_destroy(pb);
619 cb.sc_private = NULL;
622 op->o_callback = cb.sc_next;
628 slapi_over_extended( Operation *op, SlapReply *rs )
636 slapi_int_get_extop_plugin( &op->ore_reqoid, &callback );
637 if ( callback == NULL ) {
638 return SLAP_CB_CONTINUE;
641 internal_op = slapi_op_internal_p( op, rs, &cb );
643 return SLAP_CB_CONTINUE;
646 pb = SLAPI_OPERATION_PBLOCK( op );
648 rc = (*callback)( pb );
649 if ( rc == SLAPI_PLUGIN_EXTENDED_SENT_RESULT ) {
650 slapi_pblock_destroy( pb );
652 } else if ( rc == SLAPI_PLUGIN_EXTENDED_NOT_HANDLED ) {
653 slapi_pblock_destroy( pb );
654 return SLAP_CB_CONTINUE;
657 assert( rs->sr_rspoid != NULL );
659 send_ldap_extended( op, rs );
662 slapi_ch_free_string( (char **)&rs->sr_rspoid );
665 if ( rs->sr_rspdata != NULL )
666 ber_bvfree( rs->sr_rspdata );
668 slapi_pblock_destroy( pb );
674 slapi_over_access_allowed(
677 AttributeDescription *desc,
679 slap_access_t access,
680 AccessControlState *state,
687 SlapReply rs = { REP_RESULT };
689 internal_op = slapi_op_internal_p( op, &rs, &cb );
691 cb.sc_response = NULL;
692 cb.sc_cleanup = NULL;
694 pb = SLAPI_OPERATION_PBLOCK( op );
696 rc = slapi_int_access_allowed( op, e, desc, val, access, state );
698 rc = SLAP_CB_CONTINUE;
701 op->o_callback = cb.sc_next;
704 slapi_pblock_destroy( pb );
710 slapi_over_acl_group(
713 struct berval *gr_ndn,
714 struct berval *op_ndn,
715 ObjectClass *group_oc,
716 AttributeDescription *group_at )
721 BackendDB *be = op->o_bd;
723 SlapReply rs = { REP_RESULT };
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, &rs, &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;
768 rc = pb->pb_rs->sr_err;
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 */