1 /* retcode.c - customizable response for client testing purposes */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2005-2007 The OpenLDAP Foundation.
6 * Portions Copyright 2005 Pierangelo Masarati <ando@sys-net.it>
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.
24 #ifdef SLAPD_OVER_RETCODE
28 #include <ac/unistd.h>
29 #include <ac/string.h>
31 #include <ac/socket.h>
37 static slap_overinst retcode;
39 static AttributeDescription *ad_errCode;
40 static AttributeDescription *ad_errText;
41 static AttributeDescription *ad_errOp;
42 static AttributeDescription *ad_errSleepTime;
43 static AttributeDescription *ad_errMatchedDN;
44 static AttributeDescription *ad_errUnsolicitedOID;
45 static AttributeDescription *ad_errUnsolicitedData;
46 static AttributeDescription *ad_errDisconnect;
48 static ObjectClass *oc_errAbsObject;
49 static ObjectClass *oc_errObject;
50 static ObjectClass *oc_errAuxObject;
52 typedef enum retcode_op_e {
53 SN_DG_OP_NONE = 0x0000,
54 SN_DG_OP_ADD = 0x0001,
55 SN_DG_OP_BIND = 0x0002,
56 SN_DG_OP_COMPARE = 0x0004,
57 SN_DG_OP_DELETE = 0x0008,
58 SN_DG_OP_MODIFY = 0x0010,
59 SN_DG_OP_RENAME = 0x0020,
60 SN_DG_OP_SEARCH = 0x0040,
61 SN_DG_EXTENDED = 0x0080,
62 SN_DG_OP_AUTH = SN_DG_OP_BIND,
63 SN_DG_OP_READ = (SN_DG_OP_COMPARE|SN_DG_OP_SEARCH),
64 SN_DG_OP_WRITE = (SN_DG_OP_ADD|SN_DG_OP_DELETE|SN_DG_OP_MODIFY|SN_DG_OP_RENAME),
65 SN_DG_OP_ALL = (SN_DG_OP_AUTH|SN_DG_OP_READ|SN_DG_OP_WRITE|SN_DG_EXTENDED)
68 typedef struct retcode_item_t {
70 struct berval rdi_ndn;
71 struct berval rdi_text;
72 struct berval rdi_matched;
78 struct berval rdi_unsolicited_oid;
79 struct berval rdi_unsolicited_data;
82 #define RDI_PRE_DISCONNECT (0x1U)
83 #define RDI_POST_DISCONNECT (0x2U)
85 struct retcode_item_t *rdi_next;
88 typedef struct retcode_t {
90 struct berval rd_npdn;
94 retcode_item_t *rd_item;
97 #define RETCODE_FNONE 0x00
98 #define RETCODE_FINDIR 0x01
99 #define RETCODE_INDIR( rd ) ( (rd)->rd_flags & RETCODE_FINDIR )
103 retcode_entry_response( Operation *op, SlapReply *rs, BackendInfo *bi, Entry *e );
106 retcode_sleep( int s )
110 /* sleep as required */
112 #if 0 /* use high-order bits for better randomness (Numerical Recipes in "C") */
115 r = ((double)(-s))*rand()/(RAND_MAX + 1.0);
116 } else if ( s > 0 ) {
127 retcode_cleanup_cb( Operation *op, SlapReply *rs )
129 rs->sr_matched = NULL;
132 if ( rs->sr_ref != NULL ) {
133 ber_bvarray_free( rs->sr_ref );
137 ch_free( op->o_callback );
138 op->o_callback = NULL;
140 return SLAP_CB_CONTINUE;
144 retcode_send_onelevel( Operation *op, SlapReply *rs )
146 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
147 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
151 for ( rdi = rd->rd_item; rdi != NULL; rdi = rdi->rdi_next ) {
152 if ( op->o_abandon ) {
153 return rs->sr_err = SLAPD_ABANDON;
156 rs->sr_err = test_filter( op, &rdi->rdi_e, op->ors_filter );
157 if ( rs->sr_err == LDAP_COMPARE_TRUE ) {
159 rs->sr_attrs = op->ors_attrs;
160 rs->sr_operational_attrs = NULL;
163 rs->sr_err = LDAP_SUCCESS;
164 rs->sr_entry = &rdi->rdi_e;
166 rs->sr_err = send_search_entry( op, rs );
169 switch ( rs->sr_err ) {
170 case LDAP_UNAVAILABLE: /* connection closed */
171 rs->sr_err = LDAP_OTHER;
173 case LDAP_SIZELIMIT_EXCEEDED:
177 rs->sr_err = LDAP_SUCCESS;
182 send_ldap_result( op, rs );
188 retcode_op_add( Operation *op, SlapReply *rs )
190 return retcode_entry_response( op, rs, NULL, op->ora_e );
193 typedef struct retcode_cb_t {
194 BackendInfo *rdc_info;
197 AttributeName *rdc_attrs;
201 retcode_cb_response( Operation *op, SlapReply *rs )
203 retcode_cb_t *rdc = (retcode_cb_t *)op->o_callback->sc_private;
205 if ( rs->sr_type == REP_SEARCH ) {
206 ber_tag_t o_tag = op->o_tag;
209 op->o_tag = rdc->rdc_tag;
210 if ( op->o_tag == LDAP_REQ_SEARCH ) {
211 rs->sr_attrs = rdc->rdc_attrs;
213 rc = retcode_entry_response( op, rs, rdc->rdc_info, rs->sr_entry );
219 if ( rs->sr_err == LDAP_SUCCESS ) {
220 if ( !op->o_abandon ) {
221 rdc->rdc_flags = SLAP_CB_CONTINUE;
226 return SLAP_CB_CONTINUE;
230 retcode_op_internal( Operation *op, SlapReply *rs )
232 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
235 BackendDB db = *op->o_bd;
236 slap_callback sc = { 0 };
241 op2.o_tag = LDAP_REQ_SEARCH;
242 op2.ors_scope = LDAP_SCOPE_BASE;
243 op2.ors_deref = LDAP_DEREF_NEVER;
244 op2.ors_tlimit = SLAP_NO_LIMIT;
245 op2.ors_slimit = SLAP_NO_LIMIT;
246 op2.ors_limit = NULL;
247 op2.ors_attrsonly = 0;
248 op2.ors_attrs = slap_anlist_all_attributes;
250 ber_str2bv_x( "(objectClass=errAbsObject)",
251 STRLENOF( "(objectClass=errAbsObject)" ),
252 1, &op2.ors_filterstr, op2.o_tmpmemctx );
253 op2.ors_filter = str2filter_x( &op2, op2.ors_filterstr.bv_val );
255 db.bd_info = on->on_info->oi_orig;
258 rdc.rdc_info = on->on_info->oi_orig;
259 rdc.rdc_flags = RETCODE_FINDIR;
260 if ( op->o_tag == LDAP_REQ_SEARCH ) {
261 rdc.rdc_attrs = op->ors_attrs;
263 rdc.rdc_tag = op->o_tag;
264 sc.sc_response = retcode_cb_response;
265 sc.sc_private = &rdc;
266 op2.o_callback = ≻
268 rc = op2.o_bd->be_search( &op2, rs );
269 op->o_abandon = op2.o_abandon;
271 filter_free_x( &op2, op2.ors_filter );
272 ber_memfree_x( op2.ors_filterstr.bv_val, op2.o_tmpmemctx );
274 if ( rdc.rdc_flags == SLAP_CB_CONTINUE ) {
275 return SLAP_CB_CONTINUE;
282 retcode_op_func( Operation *op, SlapReply *rs )
284 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
285 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
288 struct berval nrdn, npdn;
290 slap_callback *cb = NULL;
292 /* sleep as required */
293 retcode_sleep( rd->rd_sleep );
295 if ( !dnIsSuffix( &op->o_req_ndn, &rd->rd_npdn ) ) {
296 if ( RETCODE_INDIR( rd ) ) {
297 switch ( op->o_tag ) {
299 return retcode_op_add( op, rs );
303 if ( be_isroot_pw( op ) ) {
304 return SLAP_CB_CONTINUE;
306 return retcode_op_internal( op, rs );
308 case LDAP_REQ_SEARCH:
309 if ( op->ors_scope == LDAP_SCOPE_BASE ) {
310 rs->sr_err = retcode_op_internal( op, rs );
311 switch ( rs->sr_err ) {
312 case SLAP_CB_CONTINUE:
313 if ( rs->sr_nentries == 0 ) {
316 rs->sr_err = LDAP_SUCCESS;
320 send_ldap_result( op, rs );
327 case LDAP_REQ_MODIFY:
328 case LDAP_REQ_DELETE:
329 case LDAP_REQ_MODRDN:
330 case LDAP_REQ_COMPARE:
331 return retcode_op_internal( op, rs );
335 return SLAP_CB_CONTINUE;
338 if ( op->o_tag == LDAP_REQ_SEARCH
339 && op->ors_scope != LDAP_SCOPE_BASE
340 && op->o_req_ndn.bv_len == rd->rd_npdn.bv_len )
342 return retcode_send_onelevel( op, rs );
345 dnParent( &op->o_req_ndn, &npdn );
346 if ( npdn.bv_len != rd->rd_npdn.bv_len ) {
347 rs->sr_err = LDAP_NO_SUCH_OBJECT;
348 rs->sr_matched = rd->rd_pdn.bv_val;
349 send_ldap_result( op, rs );
350 rs->sr_matched = NULL;
354 dnRdn( &op->o_req_ndn, &nrdn );
356 for ( rdi = rd->rd_item; rdi != NULL; rdi = rdi->rdi_next ) {
357 struct berval rdi_nrdn;
359 dnRdn( &rdi->rdi_ndn, &rdi_nrdn );
360 if ( dn_match( &nrdn, &rdi_nrdn ) ) {
365 if ( rdi != NULL && rdi->rdi_mask != SN_DG_OP_ALL ) {
366 retcode_op_e o_tag = SN_DG_OP_NONE;
368 switch ( op->o_tag ) {
370 o_tag = SN_DG_OP_ADD;
374 o_tag = SN_DG_OP_BIND;
377 case LDAP_REQ_COMPARE:
378 o_tag = SN_DG_OP_COMPARE;
381 case LDAP_REQ_DELETE:
382 o_tag = SN_DG_OP_DELETE;
385 case LDAP_REQ_MODIFY:
386 o_tag = SN_DG_OP_MODIFY;
389 case LDAP_REQ_MODRDN:
390 o_tag = SN_DG_OP_RENAME;
393 case LDAP_REQ_SEARCH:
394 o_tag = SN_DG_OP_SEARCH;
397 case LDAP_REQ_EXTENDED:
398 o_tag = SN_DG_EXTENDED;
402 /* Should not happen */
406 if ( !( o_tag & rdi->rdi_mask ) ) {
407 return SLAP_CB_CONTINUE;
412 rs->sr_matched = rd->rd_pdn.bv_val;
413 rs->sr_err = LDAP_NO_SUCH_OBJECT;
414 rs->sr_text = "retcode not found";
417 if ( rdi->rdi_flags & RDI_PRE_DISCONNECT ) {
418 return rs->sr_err = SLAPD_DISCONNECT;
421 rs->sr_err = rdi->rdi_err;
422 rs->sr_text = rdi->rdi_text.bv_val;
423 rs->sr_matched = rdi->rdi_matched.bv_val;
425 /* FIXME: we only honor the rdi_ref field in case rdi_err
426 * is LDAP_REFERRAL otherwise send_ldap_result() bails out */
427 if ( rs->sr_err == LDAP_REFERRAL ) {
430 if ( rdi->rdi_ref != NULL ) {
433 ref = default_referral;
437 rs->sr_ref = referral_rewrite( ref,
438 NULL, &op->o_req_dn, LDAP_SCOPE_DEFAULT );
441 rs->sr_err = LDAP_OTHER;
442 rs->sr_text = "bad referral object";
446 retcode_sleep( rdi->rdi_sleeptime );
449 switch ( op->o_tag ) {
450 case LDAP_REQ_EXTENDED:
454 cb = ( slap_callback * )ch_malloc( sizeof( slap_callback ) );
455 memset( cb, 0, sizeof( slap_callback ) );
456 cb->sc_cleanup = retcode_cleanup_cb;
461 if ( rdi && !BER_BVISNULL( &rdi->rdi_unsolicited_oid ) ) {
462 ber_int_t msgid = op->o_msgid;
464 /* RFC 4511 unsolicited response */
467 if ( strcmp( rdi->rdi_unsolicited_oid.bv_val, "0" ) == 0 ) {
468 send_ldap_result( op, rs );
471 ber_tag_t tag = op->o_tag;
473 op->o_tag = LDAP_REQ_EXTENDED;
474 rs->sr_rspoid = rdi->rdi_unsolicited_oid.bv_val;
475 if ( !BER_BVISNULL( &rdi->rdi_unsolicited_data ) ) {
476 rs->sr_rspdata = &rdi->rdi_unsolicited_data;
478 send_ldap_extended( op, rs );
479 rs->sr_rspoid = NULL;
480 rs->sr_rspdata = NULL;
487 send_ldap_result( op, rs );
490 if ( rs->sr_ref != NULL ) {
491 ber_bvarray_free( rs->sr_ref );
494 rs->sr_matched = NULL;
497 if ( rdi && rdi->rdi_flags & RDI_POST_DISCONNECT ) {
498 return rs->sr_err = SLAPD_DISCONNECT;
507 retcode_op2str( ber_tag_t op, struct berval *bv )
511 BER_BVSTR( bv, "bind" );
514 BER_BVSTR( bv, "add" );
516 case LDAP_REQ_DELETE:
517 BER_BVSTR( bv, "delete" );
519 case LDAP_REQ_MODRDN:
520 BER_BVSTR( bv, "modrdn" );
522 case LDAP_REQ_MODIFY:
523 BER_BVSTR( bv, "modify" );
525 case LDAP_REQ_COMPARE:
526 BER_BVSTR( bv, "compare" );
528 case LDAP_REQ_SEARCH:
529 BER_BVSTR( bv, "search" );
531 case LDAP_REQ_EXTENDED:
532 BER_BVSTR( bv, "extended" );
539 retcode_entry_response( Operation *op, SlapReply *rs, BackendInfo *bi, Entry *e )
546 if ( get_manageDSAit( op ) ) {
547 return SLAP_CB_CONTINUE;
550 if ( !is_entry_objectclass_or_sub( e, oc_errAbsObject ) ) {
551 return SLAP_CB_CONTINUE;
555 a = attr_find( e->e_attrs, ad_errOp );
559 struct berval bv = BER_BVNULL;
561 (void)retcode_op2str( op->o_tag, &bv );
563 if ( BER_BVISNULL( &bv ) ) {
564 return SLAP_CB_CONTINUE;
567 for ( i = 0; !BER_BVISNULL( &a->a_nvals[ i ] ); i++ ) {
568 if ( bvmatch( &a->a_nvals[ i ], &bv ) ) {
575 return SLAP_CB_CONTINUE;
580 a = attr_find( e->e_attrs, ad_errDisconnect );
582 if ( bvmatch( &a->a_nvals[ 0 ], &slap_true_bv ) ) {
583 return rs->sr_err = SLAPD_DISCONNECT;
589 a = attr_find( e->e_attrs, ad_errCode );
591 return SLAP_CB_CONTINUE;
593 err = strtol( a->a_nvals[ 0 ].bv_val, &next, 0 );
594 if ( next == a->a_nvals[ 0 ].bv_val || next[ 0 ] != '\0' ) {
595 return SLAP_CB_CONTINUE;
600 a = attr_find( e->e_attrs, ad_errSleepTime );
601 if ( a != NULL && a->a_nvals[ 0 ].bv_val[ 0 ] != '-' ) {
604 if ( lutil_atoi( &sleepTime, a->a_nvals[ 0 ].bv_val ) == 0 ) {
605 retcode_sleep( sleepTime );
609 if ( rs->sr_err != LDAP_SUCCESS && !LDAP_API_ERROR( rs->sr_err )) {
610 BackendDB db = *op->o_bd,
612 void *o_callback = op->o_callback;
615 a = attr_find( e->e_attrs, ad_errText );
617 rs->sr_text = a->a_vals[ 0 ].bv_val;
621 a = attr_find( e->e_attrs, ad_errMatchedDN );
623 rs->sr_matched = a->a_vals[ 0 ].bv_val;
627 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
629 bi = on->on_info->oi_orig;
634 op->o_callback = NULL;
637 if ( rs->sr_err == LDAP_REFERRAL ) {
638 BerVarray refs = default_referral;
640 a = attr_find( e->e_attrs, slap_schema.si_ad_ref );
644 rs->sr_ref = referral_rewrite( refs,
645 NULL, &op->o_req_dn, op->oq_search.rs_scope );
647 send_search_reference( op, rs );
648 ber_bvarray_free( rs->sr_ref );
652 a = attr_find( e->e_attrs, ad_errUnsolicitedOID );
654 struct berval oid = BER_BVNULL,
656 ber_int_t msgid = op->o_msgid;
658 /* RFC 4511 unsolicited response */
662 oid = a->a_nvals[ 0 ];
664 a = attr_find( e->e_attrs, ad_errUnsolicitedData );
666 data = a->a_nvals[ 0 ];
669 if ( strcmp( oid.bv_val, "0" ) == 0 ) {
670 send_ldap_result( op, rs );
673 ber_tag_t tag = op->o_tag;
675 op->o_tag = LDAP_REQ_EXTENDED;
676 rs->sr_rspoid = oid.bv_val;
677 if ( !BER_BVISNULL( &data ) ) {
678 rs->sr_rspdata = &data;
680 send_ldap_extended( op, rs );
681 rs->sr_rspoid = NULL;
682 rs->sr_rspdata = NULL;
688 send_ldap_result( op, rs );
693 rs->sr_matched = NULL;
695 op->o_callback = o_callback;
698 if ( rs->sr_err != LDAP_SUCCESS ) {
700 return rs->sr_err = SLAPD_DISCONNECT;
707 return SLAP_CB_CONTINUE;
711 retcode_response( Operation *op, SlapReply *rs )
713 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
714 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
716 if ( rs->sr_type != REP_SEARCH || !RETCODE_INDIR( rd ) ) {
717 return SLAP_CB_CONTINUE;
720 return retcode_entry_response( op, rs, NULL, rs->sr_entry );
724 retcode_db_init( BackendDB *be )
726 slap_overinst *on = (slap_overinst *)be->bd_info;
731 rd = (retcode_t *)ch_malloc( sizeof( retcode_t ) );
732 memset( rd, 0, sizeof( retcode_t ) );
734 on->on_bi.bi_private = (void *)rd;
747 slap_overinst *on = (slap_overinst *)be->bd_info;
748 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
750 char *argv0 = argv[ 0 ] + STRLENOF( "retcode-" );
752 if ( strncasecmp( argv[ 0 ], "retcode-", STRLENOF( "retcode-" ) ) != 0 ) {
753 return SLAP_CONF_UNKNOWN;
756 if ( strcasecmp( argv0, "parent" ) == 0 ) {
761 fprintf( stderr, "%s: line %d: retcode: "
762 "\"retcode-parent <DN>\": missing <DN>\n",
767 if ( !BER_BVISNULL( &rd->rd_pdn ) ) {
768 fprintf( stderr, "%s: line %d: retcode: "
769 "parent already defined.\n", fname, lineno );
773 ber_str2bv( argv[ 1 ], 0, 0, &dn );
775 rc = dnPrettyNormal( NULL, &dn, &rd->rd_pdn, &rd->rd_npdn, NULL );
776 if ( rc != LDAP_SUCCESS ) {
777 fprintf( stderr, "%s: line %d: retcode: "
778 "unable to normalize parent DN \"%s\": %d\n",
779 fname, lineno, argv[ 1 ], rc );
783 } else if ( strcasecmp( argv0, "item" ) == 0 ) {
784 retcode_item_t rdi = { BER_BVNULL }, **rdip;
785 struct berval bv, rdn, nrdn;
790 fprintf( stderr, "%s: line %d: retcode: "
791 "\"retcode-item <RDN> <retcode> [<text>]\": "
797 ber_str2bv( argv[ 1 ], 0, 0, &bv );
799 rc = dnPrettyNormal( NULL, &bv, &rdn, &nrdn, NULL );
800 if ( rc != LDAP_SUCCESS ) {
801 fprintf( stderr, "%s: line %d: retcode: "
802 "unable to normalize RDN \"%s\": %d\n",
803 fname, lineno, argv[ 1 ], rc );
807 if ( !dnIsOneLevelRDN( &nrdn ) ) {
808 fprintf( stderr, "%s: line %d: retcode: "
809 "value \"%s\" is not a RDN\n",
810 fname, lineno, argv[ 1 ] );
814 if ( BER_BVISNULL( &rd->rd_npdn ) ) {
815 /* FIXME: we use the database suffix */
816 if ( be->be_nsuffix == NULL ) {
817 fprintf( stderr, "%s: line %d: retcode: "
818 "either \"retcode-parent\" "
819 "or \"suffix\" must be defined.\n",
824 ber_dupbv( &rd->rd_pdn, &be->be_suffix[ 0 ] );
825 ber_dupbv( &rd->rd_npdn, &be->be_nsuffix[ 0 ] );
828 build_new_dn( &rdi.rdi_dn, &rd->rd_pdn, &rdn, NULL );
829 build_new_dn( &rdi.rdi_ndn, &rd->rd_npdn, &nrdn, NULL );
831 ch_free( rdn.bv_val );
832 ch_free( nrdn.bv_val );
834 rdi.rdi_err = strtol( argv[ 2 ], &next, 0 );
835 if ( next == argv[ 2 ] || next[ 0 ] != '\0' ) {
836 fprintf( stderr, "%s: line %d: retcode: "
837 "unable to parse return code \"%s\"\n",
838 fname, lineno, argv[ 2 ] );
842 rdi.rdi_mask = SN_DG_OP_ALL;
847 for ( i = 3; i < argc; i++ ) {
848 if ( strncasecmp( argv[ i ], "op=", STRLENOF( "op=" ) ) == 0 )
853 ops = ldap_str2charray( &argv[ i ][ STRLENOF( "op=" ) ], "," );
854 assert( ops != NULL );
856 rdi.rdi_mask = SN_DG_OP_NONE;
858 for ( j = 0; ops[ j ] != NULL; j++ ) {
859 if ( strcasecmp( ops[ j ], "add" ) == 0 ) {
860 rdi.rdi_mask |= SN_DG_OP_ADD;
862 } else if ( strcasecmp( ops[ j ], "bind" ) == 0 ) {
863 rdi.rdi_mask |= SN_DG_OP_BIND;
865 } else if ( strcasecmp( ops[ j ], "compare" ) == 0 ) {
866 rdi.rdi_mask |= SN_DG_OP_COMPARE;
868 } else if ( strcasecmp( ops[ j ], "delete" ) == 0 ) {
869 rdi.rdi_mask |= SN_DG_OP_DELETE;
871 } else if ( strcasecmp( ops[ j ], "modify" ) == 0 ) {
872 rdi.rdi_mask |= SN_DG_OP_MODIFY;
874 } else if ( strcasecmp( ops[ j ], "rename" ) == 0
875 || strcasecmp( ops[ j ], "modrdn" ) == 0 )
877 rdi.rdi_mask |= SN_DG_OP_RENAME;
879 } else if ( strcasecmp( ops[ j ], "search" ) == 0 ) {
880 rdi.rdi_mask |= SN_DG_OP_SEARCH;
882 } else if ( strcasecmp( ops[ j ], "extended" ) == 0 ) {
883 rdi.rdi_mask |= SN_DG_EXTENDED;
885 } else if ( strcasecmp( ops[ j ], "auth" ) == 0 ) {
886 rdi.rdi_mask |= SN_DG_OP_AUTH;
888 } else if ( strcasecmp( ops[ j ], "read" ) == 0 ) {
889 rdi.rdi_mask |= SN_DG_OP_READ;
891 } else if ( strcasecmp( ops[ j ], "write" ) == 0 ) {
892 rdi.rdi_mask |= SN_DG_OP_WRITE;
894 } else if ( strcasecmp( ops[ j ], "all" ) == 0 ) {
895 rdi.rdi_mask |= SN_DG_OP_ALL;
898 fprintf( stderr, "retcode: unknown op \"%s\"\n",
900 ldap_charray_free( ops );
905 ldap_charray_free( ops );
907 } else if ( strncasecmp( argv[ i ], "text=", STRLENOF( "text=" ) ) == 0 )
909 if ( !BER_BVISNULL( &rdi.rdi_text ) ) {
910 fprintf( stderr, "%s: line %d: retcode: "
911 "\"text\" already provided.\n",
915 ber_str2bv( &argv[ i ][ STRLENOF( "text=" ) ], 0, 1, &rdi.rdi_text );
917 } else if ( strncasecmp( argv[ i ], "matched=", STRLENOF( "matched=" ) ) == 0 )
921 if ( !BER_BVISNULL( &rdi.rdi_matched ) ) {
922 fprintf( stderr, "%s: line %d: retcode: "
923 "\"matched\" already provided.\n",
927 ber_str2bv( &argv[ i ][ STRLENOF( "matched=" ) ], 0, 0, &dn );
928 if ( dnPretty( NULL, &dn, &rdi.rdi_matched, NULL ) != LDAP_SUCCESS ) {
929 fprintf( stderr, "%s: line %d: retcode: "
930 "unable to prettify matched DN \"%s\".\n",
931 fname, lineno, &argv[ i ][ STRLENOF( "matched=" ) ] );
935 } else if ( strncasecmp( argv[ i ], "ref=", STRLENOF( "ref=" ) ) == 0 )
940 if ( rdi.rdi_ref != NULL ) {
941 fprintf( stderr, "%s: line %d: retcode: "
942 "\"ref\" already provided.\n",
947 if ( rdi.rdi_err != LDAP_REFERRAL ) {
948 fprintf( stderr, "%s: line %d: retcode: "
949 "providing \"ref\"\n"
950 "\talong with a non-referral "
951 "resultCode may cause slapd failures\n"
952 "\trelated to internal checks.\n",
956 refs = ldap_str2charray( &argv[ i ][ STRLENOF( "ref=" ) ], " " );
957 assert( refs != NULL );
959 for ( j = 0; refs[ j ] != NULL; j++ ) {
962 ber_str2bv( refs[ j ], 0, 1, &bv );
963 ber_bvarray_add( &rdi.rdi_ref, &bv );
966 ldap_charray_free( refs );
968 } else if ( strncasecmp( argv[ i ], "sleeptime=", STRLENOF( "sleeptime=" ) ) == 0 )
970 if ( rdi.rdi_sleeptime != 0 ) {
971 fprintf( stderr, "%s: line %d: retcode: "
972 "\"sleeptime\" already provided.\n",
977 if ( lutil_atoi( &rdi.rdi_sleeptime, &argv[ i ][ STRLENOF( "sleeptime=" ) ] ) ) {
978 fprintf( stderr, "%s: line %d: retcode: "
979 "unable to parse \"sleeptime=%s\".\n",
980 fname, lineno, &argv[ i ][ STRLENOF( "sleeptime=" ) ] );
984 } else if ( strncasecmp( argv[ i ], "unsolicited=", STRLENOF( "unsolicited=" ) ) == 0 )
988 if ( !BER_BVISNULL( &rdi.rdi_unsolicited_oid ) ) {
989 fprintf( stderr, "%s: line %d: retcode: "
990 "\"unsolicited\" already provided.\n",
995 data = strchr( &argv[ i ][ STRLENOF( "unsolicited=" ) ], ':' );
996 if ( data != NULL ) {
999 if ( ldif_parse_line2( &argv[ i ][ STRLENOF( "unsolicited=" ) ],
1000 &oid, &rdi.rdi_unsolicited_data, NULL ) )
1002 fprintf( stderr, "%s: line %d: retcode: "
1003 "unable to parse \"unsolicited\".\n",
1008 ber_dupbv( &rdi.rdi_unsolicited_oid, &oid );
1011 ber_str2bv( &argv[ i ][ STRLENOF( "unsolicited=" ) ], 0, 1,
1012 &rdi.rdi_unsolicited_oid );
1015 } else if ( strncasecmp( argv[ i ], "flags=", STRLENOF( "flags=" ) ) == 0 )
1017 char *arg = &argv[ i ][ STRLENOF( "flags=" ) ];
1018 if ( strcasecmp( arg, "disconnect" ) == 0 ) {
1019 rdi.rdi_flags |= RDI_PRE_DISCONNECT;
1021 } else if ( strcasecmp( arg, "pre-disconnect" ) == 0 ) {
1022 rdi.rdi_flags |= RDI_PRE_DISCONNECT;
1024 } else if ( strcasecmp( arg, "post-disconnect" ) == 0 ) {
1025 rdi.rdi_flags |= RDI_POST_DISCONNECT;
1028 fprintf( stderr, "%s: line %d: retcode: "
1029 "unknown flag \"%s\".\n",
1030 fname, lineno, arg );
1035 fprintf( stderr, "%s: line %d: retcode: "
1036 "unknown option \"%s\".\n",
1037 fname, lineno, argv[ i ] );
1043 for ( rdip = &rd->rd_item; *rdip; rdip = &(*rdip)->rdi_next )
1047 *rdip = ( retcode_item_t * )ch_malloc( sizeof( retcode_item_t ) );
1050 } else if ( strcasecmp( argv0, "indir" ) == 0 ) {
1051 rd->rd_flags |= RETCODE_FINDIR;
1053 } else if ( strcasecmp( argv0, "sleep" ) == 0 ) {
1056 fprintf( stderr, "%s: line %d: retcode: "
1057 "\"retcode-sleep <time>\": missing <time>\n",
1065 fprintf( stderr, "%s: line %d: retcode: "
1066 "\"retcode-sleep <time>\": extra cruft after <time>\n",
1071 if ( lutil_atoi( &rd->rd_sleep, argv[ 1 ] ) != 0 ) {
1072 fprintf( stderr, "%s: line %d: retcode: "
1073 "\"retcode-sleep <time>\": unable to parse <time>\n",
1079 return SLAP_CONF_UNKNOWN;
1086 retcode_db_open( BackendDB *be )
1088 slap_overinst *on = (slap_overinst *)be->bd_info;
1089 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
1091 retcode_item_t *rdi;
1093 for ( rdi = rd->rd_item; rdi; rdi = rdi->rdi_next ) {
1097 struct berval val[ 3 ];
1098 char buf[ SLAP_TEXT_BUFLEN ];
1101 rdi->rdi_e.e_name = rdi->rdi_dn;
1102 rdi->rdi_e.e_nname = rdi->rdi_ndn;
1105 val[ 0 ] = oc_errObject->soc_cname;
1106 val[ 1 ] = slap_schema.si_oc_extensibleObject->soc_cname;
1107 BER_BVZERO( &val[ 2 ] );
1109 attr_merge( &rdi->rdi_e, slap_schema.si_ad_objectClass, val, NULL );
1112 rc = ldap_bv2rdn( &rdi->rdi_dn, &rdn, (char **) &p,
1113 LDAP_DN_FORMAT_LDAP );
1115 assert( rc == LDAP_SUCCESS );
1117 for ( j = 0; rdn[ j ]; j++ ) {
1118 LDAPAVA *ava = rdn[ j ];
1119 AttributeDescription *ad = NULL;
1122 rc = slap_bv2ad( &ava->la_attr, &ad, &text );
1123 assert( rc == LDAP_SUCCESS );
1125 attr_merge_normalize_one( &rdi->rdi_e, ad,
1126 &ava->la_value, NULL );
1129 ldap_rdnfree( rdn );
1132 snprintf( buf, sizeof( buf ), "%d", rdi->rdi_err );
1133 ber_str2bv( buf, 0, 0, &val[ 0 ] );
1135 attr_merge_one( &rdi->rdi_e, ad_errCode, &val[ 0 ], NULL );
1137 if ( rdi->rdi_ref != NULL ) {
1138 attr_merge_normalize( &rdi->rdi_e, slap_schema.si_ad_ref,
1139 rdi->rdi_ref, NULL );
1143 if ( !BER_BVISNULL( &rdi->rdi_text ) ) {
1144 val[ 0 ] = rdi->rdi_text;
1146 attr_merge_normalize_one( &rdi->rdi_e, ad_errText, &val[ 0 ], NULL );
1150 if ( !BER_BVISNULL( &rdi->rdi_matched ) ) {
1151 val[ 0 ] = rdi->rdi_matched;
1153 attr_merge_normalize_one( &rdi->rdi_e, ad_errMatchedDN, &val[ 0 ], NULL );
1157 if ( rdi->rdi_sleeptime ) {
1158 snprintf( buf, sizeof( buf ), "%d", rdi->rdi_sleeptime );
1159 ber_str2bv( buf, 0, 0, &val[ 0 ] );
1161 attr_merge_one( &rdi->rdi_e, ad_errSleepTime, &val[ 0 ], NULL );
1165 if ( rdi->rdi_mask & SN_DG_OP_ADD ) {
1166 BER_BVSTR( &val[ 0 ], "add" );
1167 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1170 if ( rdi->rdi_mask & SN_DG_OP_BIND ) {
1171 BER_BVSTR( &val[ 0 ], "bind" );
1172 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1175 if ( rdi->rdi_mask & SN_DG_OP_COMPARE ) {
1176 BER_BVSTR( &val[ 0 ], "compare" );
1177 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1180 if ( rdi->rdi_mask & SN_DG_OP_DELETE ) {
1181 BER_BVSTR( &val[ 0 ], "delete" );
1182 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1185 if ( rdi->rdi_mask & SN_DG_EXTENDED ) {
1186 BER_BVSTR( &val[ 0 ], "extended" );
1187 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1190 if ( rdi->rdi_mask & SN_DG_OP_MODIFY ) {
1191 BER_BVSTR( &val[ 0 ], "modify" );
1192 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1195 if ( rdi->rdi_mask & SN_DG_OP_RENAME ) {
1196 BER_BVSTR( &val[ 0 ], "rename" );
1197 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1200 if ( rdi->rdi_mask & SN_DG_OP_SEARCH ) {
1201 BER_BVSTR( &val[ 0 ], "search" );
1202 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1210 retcode_db_destroy( BackendDB *be )
1212 slap_overinst *on = (slap_overinst *)be->bd_info;
1213 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
1216 retcode_item_t *rdi, *next;
1218 for ( rdi = rd->rd_item; rdi != NULL; rdi = next ) {
1219 ber_memfree( rdi->rdi_dn.bv_val );
1220 ber_memfree( rdi->rdi_ndn.bv_val );
1222 if ( !BER_BVISNULL( &rdi->rdi_text ) ) {
1223 ber_memfree( rdi->rdi_text.bv_val );
1226 if ( !BER_BVISNULL( &rdi->rdi_matched ) ) {
1227 ber_memfree( rdi->rdi_matched.bv_val );
1230 if ( rdi->rdi_ref ) {
1231 ber_bvarray_free( rdi->rdi_ref );
1234 BER_BVZERO( &rdi->rdi_e.e_name );
1235 BER_BVZERO( &rdi->rdi_e.e_nname );
1237 entry_clean( &rdi->rdi_e );
1239 next = rdi->rdi_next;
1244 if ( !BER_BVISNULL( &rd->rd_pdn ) ) {
1245 ber_memfree( rd->rd_pdn.bv_val );
1248 if ( !BER_BVISNULL( &rd->rd_npdn ) ) {
1249 ber_memfree( rd->rd_npdn.bv_val );
1258 #if SLAPD_OVER_RETCODE == SLAPD_MOD_DYNAMIC
1260 #endif /* SLAPD_OVER_RETCODE == SLAPD_MOD_DYNAMIC */
1262 retcode_initialize( void )
1268 AttributeDescription **ad;
1270 { "( 1.3.6.1.4.1.4203.666.11.4.1.1 "
1271 "NAME ( 'errCode' ) "
1272 "DESC 'LDAP error code' "
1273 "EQUALITY integerMatch "
1274 "ORDERING integerOrderingMatch "
1275 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
1278 { "( 1.3.6.1.4.1.4203.666.11.4.1.2 "
1280 "DESC 'Operations the errObject applies to' "
1281 "EQUALITY caseIgnoreMatch "
1282 "SUBSTR caseIgnoreSubstringsMatch "
1283 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 )",
1285 { "( 1.3.6.1.4.1.4203.666.11.4.1.3 "
1286 "NAME ( 'errText' ) "
1287 "DESC 'LDAP error textual description' "
1288 "EQUALITY caseIgnoreMatch "
1289 "SUBSTR caseIgnoreSubstringsMatch "
1290 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 "
1293 { "( 1.3.6.1.4.1.4203.666.11.4.1.4 "
1294 "NAME ( 'errSleepTime' ) "
1295 "DESC 'Time to wait before returning the error' "
1296 "EQUALITY integerMatch "
1297 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
1300 { "( 1.3.6.1.4.1.4203.666.11.4.1.5 "
1301 "NAME ( 'errMatchedDN' ) "
1302 "DESC 'Value to be returned as matched DN' "
1303 "EQUALITY distinguishedNameMatch "
1304 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.12 "
1307 { "( 1.3.6.1.4.1.4203.666.11.4.1.6 "
1308 "NAME ( 'errUnsolicitedOID' ) "
1309 "DESC 'OID to be returned within unsolicited response' "
1310 "EQUALITY objectIdentifierMatch "
1311 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.38 "
1313 &ad_errUnsolicitedOID },
1314 { "( 1.3.6.1.4.1.4203.666.11.4.1.7 "
1315 "NAME ( 'errUnsolicitedData' ) "
1316 "DESC 'Data to be returned within unsolicited response' "
1317 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.40 "
1319 &ad_errUnsolicitedData },
1320 { "( 1.3.6.1.4.1.4203.666.11.4.1.8 "
1321 "NAME ( 'errDisconnect' ) "
1322 "DESC 'Disconnect without notice' "
1323 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.7 "
1325 &ad_errDisconnect },
1333 { "( 1.3.6.1.4.1.4203.666.11.4.3.0 "
1334 "NAME ( 'errAbsObject' ) "
1344 "$ errUnsolicitedOID "
1345 "$ errUnsolicitedData "
1349 { "( 1.3.6.1.4.1.4203.666.11.4.3.1 "
1350 "NAME ( 'errObject' ) "
1351 "SUP errAbsObject STRUCTURAL "
1354 { "( 1.3.6.1.4.1.4203.666.11.4.3.2 "
1355 "NAME ( 'errAuxObject' ) "
1356 "SUP errAbsObject AUXILIARY "
1363 for ( i = 0; retcode_at[ i ].desc != NULL; i++ ) {
1364 code = register_at( retcode_at[ i ].desc, retcode_at[ i ].ad, 0 );
1366 Debug( LDAP_DEBUG_ANY,
1367 "retcode: register_at failed\n", 0, 0, 0 );
1372 for ( i = 0; retcode_oc[ i ].desc != NULL; i++ ) {
1373 code = register_oc( retcode_oc[ i ].desc, retcode_oc[ i ].oc, 0 );
1375 Debug( LDAP_DEBUG_ANY,
1376 "retcode: register_oc failed\n", 0, 0, 0 );
1381 retcode.on_bi.bi_type = "retcode";
1383 retcode.on_bi.bi_db_init = retcode_db_init;
1384 retcode.on_bi.bi_db_config = retcode_db_config;
1385 retcode.on_bi.bi_db_open = retcode_db_open;
1386 retcode.on_bi.bi_db_destroy = retcode_db_destroy;
1388 retcode.on_bi.bi_op_add = retcode_op_func;
1389 retcode.on_bi.bi_op_bind = retcode_op_func;
1390 retcode.on_bi.bi_op_compare = retcode_op_func;
1391 retcode.on_bi.bi_op_delete = retcode_op_func;
1392 retcode.on_bi.bi_op_modify = retcode_op_func;
1393 retcode.on_bi.bi_op_modrdn = retcode_op_func;
1394 retcode.on_bi.bi_op_search = retcode_op_func;
1396 retcode.on_bi.bi_extended = retcode_op_func;
1398 retcode.on_response = retcode_response;
1400 return overlay_register( &retcode );
1403 #if SLAPD_OVER_RETCODE == SLAPD_MOD_DYNAMIC
1405 init_module( int argc, char *argv[] )
1407 return retcode_initialize();
1409 #endif /* SLAPD_OVER_RETCODE == SLAPD_MOD_DYNAMIC */
1411 #endif /* SLAPD_OVER_RETCODE */