1 /* op.c - relay backend operations */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2004-2009 The OpenLDAP Foundation.
6 * Portions Copyright 2004 Pierangelo Masarati.
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 Pierangelo Masarati for inclusion
19 * in OpenLDAP Software.
27 #include "back-relay.h"
29 /* Results when no real database (.rf_bd) or operation handler (.rf_op) */
30 static const struct relay_fail_modes_s {
31 slap_mask_t rf_bd, rf_op;
32 #define RB_ERR_MASK 0x0000FFFFU /* bitmask for default return value */
33 #define RB_BDERR 0x80000000U /* use .rf_bd's default return value */
34 #define RB_OPERR 0x40000000U /* set rs->sr_err = .rf_op return value */
35 #define RB_REF 0x20000000U /* use default_referral if available */
36 #define RB_SEND 0x10000000U /* send result; RB_??ERR is also set */
37 #define RB_SENDREF 0/*unused*/ /* like RB_SEND when referral found */
38 #define RB_NO_BIND (RB_OPERR | LDAP_INVALID_CREDENTIALS)
39 #define RB_NOT_SUPP (RB_OPERR | LDAP_UNWILLING_TO_PERFORM)
40 #define RB_NO_OBJ (RB_REF | LDAP_NO_SUCH_OBJECT)
41 #define RB_CHK_REF (RB_REF | RB_SENDREF | LDAP_SUCCESS)
42 } relay_fail_modes[relay_op_last] = {
43 /* .rf_bd is unused when zero, otherwise both fields have RB_BDERR */
44 # define RB_OP(b, o) { (b) | RB_BD2ERR(b), (o) | RB_BD2ERR(b) }
45 # define RB_BD2ERR(b) ((b) ? RB_BDERR : 0)
46 /* indexed by slap_operation_t: */
47 RB_OP(RB_NO_BIND|RB_SEND, RB_NO_BIND |RB_SEND), /* Bind */
48 RB_OP(0, LDAP_SUCCESS), /* Unbind: unused */
49 RB_OP(RB_NO_OBJ |RB_SEND, RB_NOT_SUPP |RB_SEND), /* Search */
50 RB_OP(RB_NO_OBJ |RB_SEND, SLAP_CB_CONTINUE), /* Compare */
51 RB_OP(RB_NO_OBJ |RB_SEND, RB_NOT_SUPP |RB_SEND), /* Modify */
52 RB_OP(RB_NO_OBJ |RB_SEND, RB_NOT_SUPP |RB_SEND), /* Modrdn */
53 RB_OP(RB_NO_OBJ |RB_SEND, RB_NOT_SUPP |RB_SEND), /* Add */
54 RB_OP(RB_NO_OBJ |RB_SEND, RB_NOT_SUPP |RB_SEND), /* Delete */
55 RB_OP(0, LDAP_SUCCESS), /* Abandon:unused */
56 RB_OP(RB_NO_OBJ, RB_NOT_SUPP), /* Extended */
57 RB_OP(0, SLAP_CB_CONTINUE), /* Cancel: unused */
58 RB_OP(0, LDAP_SUCCESS), /* operational */
59 RB_OP(RB_CHK_REF, LDAP_SUCCESS), /* chk_referrals:unused*/
60 RB_OP(0, SLAP_CB_CONTINUE),/* chk_controls:unused */
61 /* additional relay_operation_t indexes from back-relay.h: */
62 RB_OP(0, 0/*unused*/), /* entry_get = op_last */
63 RB_OP(0, 0/*unused*/), /* entry_release */
64 RB_OP(0, 0/*unused*/), /* has_subordinates */
68 * Callbacks: Caller changed op->o_bd from Relay to underlying
69 * BackendDB. sc_response sets it to Relay BackendDB, sc_cleanup puts
70 * back underlying BackendDB. Caller will restore Relay BackendDB.
73 typedef struct relay_callback {
79 relay_back_cleanup_cb( Operation *op, SlapReply *rs )
81 op->o_bd = ((relay_callback *) op->o_callback)->rcb_bd;
82 return SLAP_CB_CONTINUE;
86 relay_back_response_cb( Operation *op, SlapReply *rs )
88 relay_callback *rcb = (relay_callback *) op->o_callback;
90 rcb->rcb_sc.sc_cleanup = relay_back_cleanup_cb;
91 rcb->rcb_bd = op->o_bd;
92 op->o_bd = op->o_callback->sc_private;
93 return SLAP_CB_CONTINUE;
96 #define relay_back_add_cb( rcb, op, bd ) \
98 (rcb)->rcb_sc.sc_next = (op)->o_callback; \
99 (rcb)->rcb_sc.sc_response = relay_back_response_cb; \
100 (rcb)->rcb_sc.sc_cleanup = 0; \
101 (rcb)->rcb_sc.sc_private = (op)->o_bd; \
102 (op)->o_callback = (slap_callback *) (rcb); \
106 * Select the backend database with the operation's DN. On failure,
107 * set/send results depending on operation type <which>'s fail_modes.
110 relay_back_select_backend( Operation *op, SlapReply *rs, int which )
113 char *key = (char *) op->o_bd->be_private;
114 BackendDB *bd = ((relay_back_info *) key)->ri_bd;
115 slap_mask_t fail_mode = relay_fail_modes[which].rf_bd;
116 int useDN = 0, rc = ( fail_mode & RB_ERR_MASK );
118 if ( bd == NULL && !BER_BVISNULL( &op->o_req_ndn ) ) {
120 bd = select_backend( &op->o_req_ndn, 1 );
124 key += which; /* <relay, op type> key from RELAY_WRAP_OP() */
125 LDAP_SLIST_FOREACH( oex, &op->o_extra, oe_next ) {
126 if ( oex->oe_key == key )
133 Debug( LDAP_DEBUG_ANY,
134 "%s: back-relay for DN=\"%s\" would call self.\n",
135 op->o_log_prefix, op->o_req_dn.bv_val, 0 );
137 } else if ( useDN && ( fail_mode & RB_REF ) && default_referral ) {
140 /* if we set sr_err to LDAP_REFERRAL, we must provide one */
141 rs->sr_ref = referral_rewrite(
142 default_referral, NULL, &op->o_req_dn,
143 op->o_tag == LDAP_REQ_SEARCH ?
144 op->ors_scope : LDAP_SCOPE_DEFAULT );
145 if ( rs->sr_ref != NULL ) {
146 rs->sr_flags |= REP_REF_MUSTBEFREED;
148 rs->sr_ref = default_referral;
151 if ( fail_mode & RB_SENDREF )
152 fail_mode = (RB_BDERR | RB_SEND);
155 if ( fail_mode & RB_BDERR ) {
157 if ( fail_mode & RB_SEND ) {
158 send_ldap_result( op, rs );
166 * Forward <act> on <op> to database <bd>, with <relay, op type>-specific
167 * key in op->o_extra so relay_back_select_backend() can catch recursion.
169 #define RELAY_WRAP_OP( op, bd, which, act ) { \
170 OpExtraDB wrap_oex; \
171 BackendDB *const wrap_bd = (op)->o_bd; \
172 wrap_oex.oe_db = wrap_bd; \
173 wrap_oex.oe.oe_key = (char *) wrap_bd->be_private + (which); \
174 LDAP_SLIST_INSERT_HEAD( &(op)->o_extra, &wrap_oex.oe, oe_next ); \
177 (op)->o_bd = wrap_bd; \
178 LDAP_SLIST_REMOVE( &(op)->o_extra, &wrap_oex.oe, OpExtra, oe_next ); \
182 * Forward backend function #<which> on <op> to operation DN's database
183 * like RELAY_WRAP_OP, after setting up callbacks. If no database or no
184 * backend function, set/send results depending on <which>'s fail_modes.
187 relay_back_op( Operation *op, SlapReply *rs, int which )
191 slap_mask_t fail_mode = relay_fail_modes[which].rf_op;
192 int rc = ( fail_mode & RB_ERR_MASK );
194 bd = relay_back_select_backend( op, rs, which );
196 if ( fail_mode & RB_BDERR )
197 return rs->sr_err; /* sr_err was set above */
199 } else if ( (func = (&bd->be_bind)[which]) != 0 ) {
202 relay_back_add_cb( &rcb, op, bd );
204 RELAY_WRAP_OP( op, bd, which, {
208 if ( op->o_callback == (slap_callback *) &rcb ) {
209 op->o_callback = op->o_callback->sc_next;
212 } else if ( fail_mode & RB_OPERR ) {
214 if ( rc == LDAP_UNWILLING_TO_PERFORM ) {
215 rs->sr_text = "operation not supported within naming context";
218 if ( fail_mode & RB_SEND ) {
219 send_ldap_result( op, rs );
228 relay_back_op_bind( Operation *op, SlapReply *rs )
230 /* allow rootdn as a means to auth without the need to actually
231 * contact the proxied DSA */
232 switch ( be_rootdn_bind( op, rs ) ) {
233 case SLAP_CB_CONTINUE:
240 return relay_back_op( op, rs, op_bind );
243 #define RELAY_DEFOP(func, which) \
244 int func( Operation *op, SlapReply *rs ) \
245 { return relay_back_op( op, rs, which ); }
247 RELAY_DEFOP( relay_back_op_search, op_search )
248 RELAY_DEFOP( relay_back_op_compare, op_compare )
249 RELAY_DEFOP( relay_back_op_modify, op_modify )
250 RELAY_DEFOP( relay_back_op_modrdn, op_modrdn )
251 RELAY_DEFOP( relay_back_op_add, op_add )
252 RELAY_DEFOP( relay_back_op_delete, op_delete )
253 RELAY_DEFOP( relay_back_op_extended, op_extended )
254 RELAY_DEFOP( relay_back_operational, op_aux_operational )
256 /* Abandon, Cancel, Unbind and some DN-less calls like be_connection_init
257 * need no extra handling: slapd already calls them for all databases.
262 relay_back_entry_release_rw( Operation *op, Entry *e, int rw )
265 int rc = LDAP_UNWILLING_TO_PERFORM;
267 bd = relay_back_select_backend( op, NULL, relay_op_entry_release );
268 if ( bd && bd->be_release ) {
269 RELAY_WRAP_OP( op, bd, relay_op_entry_release, {
270 rc = bd->be_release( op, e, rw );
272 } else if ( e->e_private == NULL ) {
281 relay_back_entry_get_rw( Operation *op, struct berval *ndn,
282 ObjectClass *oc, AttributeDescription *at, int rw, Entry **e )
285 int rc = LDAP_NO_SUCH_OBJECT;
287 bd = relay_back_select_backend( op, NULL, relay_op_entry_get );
288 if ( bd && bd->be_fetch ) {
289 RELAY_WRAP_OP( op, bd, relay_op_entry_get, {
290 rc = bd->be_fetch( op, ndn, oc, at, rw, e );
297 #if 0 /* Give the RB_SENDREF flag a nonzero value if implementing this */
299 * NOTE: even the existence of this function is questionable: we cannot
300 * pass the bi_chk_referrals() call thru the rwm overlay because there
301 * is no way to rewrite the req_dn back; but then relay_back_chk_referrals()
302 * is passing the target database a DN that likely does not belong to its
303 * naming context... mmmh.
305 RELAY_DEFOP( relay_back_chk_referrals, op_aux_chk_referrals )
309 relay_back_has_subordinates( Operation *op, Entry *e, int *hasSubs )
314 bd = relay_back_select_backend( op, NULL, relay_op_has_subordinates );
315 if ( bd && bd->be_has_subordinates ) {
316 RELAY_WRAP_OP( op, bd, relay_op_has_subordinates, {
317 rc = bd->be_has_subordinates( op, e, hasSubs );
326 * FIXME: must implement tools as well