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 op->o_tag = rdc->rdc_tag;
206 if ( rs->sr_type == REP_SEARCH ) {
207 ber_tag_t o_tag = op->o_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 switch ( rs->sr_err ) {
221 case LDAP_NO_SUCH_OBJECT:
222 /* in case of noSuchObject, stop the internal search
223 * for in-directory error stuff */
224 if ( !op->o_abandon ) {
225 rdc->rdc_flags = SLAP_CB_CONTINUE;
230 return SLAP_CB_CONTINUE;
234 retcode_op_internal( Operation *op, SlapReply *rs )
236 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
239 BackendDB db = *op->o_bd;
240 slap_callback sc = { 0 };
245 op2.o_tag = LDAP_REQ_SEARCH;
246 op2.ors_scope = LDAP_SCOPE_BASE;
247 op2.ors_deref = LDAP_DEREF_NEVER;
248 op2.ors_tlimit = SLAP_NO_LIMIT;
249 op2.ors_slimit = SLAP_NO_LIMIT;
250 op2.ors_limit = NULL;
251 op2.ors_attrsonly = 0;
252 op2.ors_attrs = slap_anlist_all_attributes;
254 ber_str2bv_x( "(objectClass=errAbsObject)",
255 STRLENOF( "(objectClass=errAbsObject)" ),
256 1, &op2.ors_filterstr, op2.o_tmpmemctx );
257 op2.ors_filter = str2filter_x( &op2, op2.ors_filterstr.bv_val );
259 db.bd_info = on->on_info->oi_orig;
262 rdc.rdc_info = on->on_info->oi_orig;
263 rdc.rdc_flags = RETCODE_FINDIR;
264 if ( op->o_tag == LDAP_REQ_SEARCH ) {
265 rdc.rdc_attrs = op->ors_attrs;
267 rdc.rdc_tag = op->o_tag;
268 sc.sc_response = retcode_cb_response;
269 sc.sc_private = &rdc;
270 op2.o_callback = ≻
272 rc = op2.o_bd->be_search( &op2, rs );
273 op->o_abandon = op2.o_abandon;
275 filter_free_x( &op2, op2.ors_filter );
276 ber_memfree_x( op2.ors_filterstr.bv_val, op2.o_tmpmemctx );
278 if ( rdc.rdc_flags == SLAP_CB_CONTINUE ) {
279 return SLAP_CB_CONTINUE;
286 retcode_op_func( Operation *op, SlapReply *rs )
288 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
289 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
292 struct berval nrdn, npdn;
294 slap_callback *cb = NULL;
296 /* sleep as required */
297 retcode_sleep( rd->rd_sleep );
299 if ( !dnIsSuffix( &op->o_req_ndn, &rd->rd_npdn ) ) {
300 if ( RETCODE_INDIR( rd ) ) {
301 switch ( op->o_tag ) {
303 return retcode_op_add( op, rs );
307 if ( be_isroot_pw( op ) ) {
310 return retcode_op_internal( op, rs );
312 case LDAP_REQ_SEARCH:
313 if ( op->ors_scope == LDAP_SCOPE_BASE ) {
314 rs->sr_err = retcode_op_internal( op, rs );
315 switch ( rs->sr_err ) {
316 case SLAP_CB_CONTINUE:
317 if ( rs->sr_nentries == 0 ) {
320 rs->sr_err = LDAP_SUCCESS;
324 send_ldap_result( op, rs );
331 case LDAP_REQ_MODIFY:
332 case LDAP_REQ_DELETE:
333 case LDAP_REQ_MODRDN:
334 case LDAP_REQ_COMPARE:
335 return retcode_op_internal( op, rs );
339 return SLAP_CB_CONTINUE;
342 if ( op->o_tag == LDAP_REQ_SEARCH
343 && op->ors_scope != LDAP_SCOPE_BASE
344 && op->o_req_ndn.bv_len == rd->rd_npdn.bv_len )
346 return retcode_send_onelevel( op, rs );
349 dnParent( &op->o_req_ndn, &npdn );
350 if ( npdn.bv_len != rd->rd_npdn.bv_len ) {
351 rs->sr_err = LDAP_NO_SUCH_OBJECT;
352 rs->sr_matched = rd->rd_pdn.bv_val;
353 send_ldap_result( op, rs );
354 rs->sr_matched = NULL;
358 dnRdn( &op->o_req_ndn, &nrdn );
360 for ( rdi = rd->rd_item; rdi != NULL; rdi = rdi->rdi_next ) {
361 struct berval rdi_nrdn;
363 dnRdn( &rdi->rdi_ndn, &rdi_nrdn );
364 if ( dn_match( &nrdn, &rdi_nrdn ) ) {
369 if ( rdi != NULL && rdi->rdi_mask != SN_DG_OP_ALL ) {
370 retcode_op_e o_tag = SN_DG_OP_NONE;
372 switch ( op->o_tag ) {
374 o_tag = SN_DG_OP_ADD;
378 o_tag = SN_DG_OP_BIND;
381 case LDAP_REQ_COMPARE:
382 o_tag = SN_DG_OP_COMPARE;
385 case LDAP_REQ_DELETE:
386 o_tag = SN_DG_OP_DELETE;
389 case LDAP_REQ_MODIFY:
390 o_tag = SN_DG_OP_MODIFY;
393 case LDAP_REQ_MODRDN:
394 o_tag = SN_DG_OP_RENAME;
397 case LDAP_REQ_SEARCH:
398 o_tag = SN_DG_OP_SEARCH;
401 case LDAP_REQ_EXTENDED:
402 o_tag = SN_DG_EXTENDED;
406 /* Should not happen */
410 if ( !( o_tag & rdi->rdi_mask ) ) {
411 return SLAP_CB_CONTINUE;
416 rs->sr_matched = rd->rd_pdn.bv_val;
417 rs->sr_err = LDAP_NO_SUCH_OBJECT;
418 rs->sr_text = "retcode not found";
421 if ( rdi->rdi_flags & RDI_PRE_DISCONNECT ) {
422 return rs->sr_err = SLAPD_DISCONNECT;
425 rs->sr_err = rdi->rdi_err;
426 rs->sr_text = rdi->rdi_text.bv_val;
427 rs->sr_matched = rdi->rdi_matched.bv_val;
429 /* FIXME: we only honor the rdi_ref field in case rdi_err
430 * is LDAP_REFERRAL otherwise send_ldap_result() bails out */
431 if ( rs->sr_err == LDAP_REFERRAL ) {
434 if ( rdi->rdi_ref != NULL ) {
437 ref = default_referral;
441 rs->sr_ref = referral_rewrite( ref,
442 NULL, &op->o_req_dn, LDAP_SCOPE_DEFAULT );
445 rs->sr_err = LDAP_OTHER;
446 rs->sr_text = "bad referral object";
450 retcode_sleep( rdi->rdi_sleeptime );
453 switch ( op->o_tag ) {
454 case LDAP_REQ_EXTENDED:
458 cb = ( slap_callback * )ch_malloc( sizeof( slap_callback ) );
459 memset( cb, 0, sizeof( slap_callback ) );
460 cb->sc_cleanup = retcode_cleanup_cb;
465 if ( rdi && !BER_BVISNULL( &rdi->rdi_unsolicited_oid ) ) {
466 ber_int_t msgid = op->o_msgid;
468 /* RFC 4511 unsolicited response */
471 if ( strcmp( rdi->rdi_unsolicited_oid.bv_val, "0" ) == 0 ) {
472 send_ldap_result( op, rs );
475 ber_tag_t tag = op->o_tag;
477 op->o_tag = LDAP_REQ_EXTENDED;
478 rs->sr_rspoid = rdi->rdi_unsolicited_oid.bv_val;
479 if ( !BER_BVISNULL( &rdi->rdi_unsolicited_data ) ) {
480 rs->sr_rspdata = &rdi->rdi_unsolicited_data;
482 send_ldap_extended( op, rs );
483 rs->sr_rspoid = NULL;
484 rs->sr_rspdata = NULL;
491 send_ldap_result( op, rs );
494 if ( rs->sr_ref != NULL ) {
495 ber_bvarray_free( rs->sr_ref );
498 rs->sr_matched = NULL;
501 if ( rdi && rdi->rdi_flags & RDI_POST_DISCONNECT ) {
502 return rs->sr_err = SLAPD_DISCONNECT;
511 retcode_op2str( ber_tag_t op, struct berval *bv )
515 BER_BVSTR( bv, "bind" );
518 BER_BVSTR( bv, "add" );
520 case LDAP_REQ_DELETE:
521 BER_BVSTR( bv, "delete" );
523 case LDAP_REQ_MODRDN:
524 BER_BVSTR( bv, "modrdn" );
526 case LDAP_REQ_MODIFY:
527 BER_BVSTR( bv, "modify" );
529 case LDAP_REQ_COMPARE:
530 BER_BVSTR( bv, "compare" );
532 case LDAP_REQ_SEARCH:
533 BER_BVSTR( bv, "search" );
535 case LDAP_REQ_EXTENDED:
536 BER_BVSTR( bv, "extended" );
543 retcode_entry_response( Operation *op, SlapReply *rs, BackendInfo *bi, Entry *e )
550 if ( get_manageDSAit( op ) ) {
551 return SLAP_CB_CONTINUE;
554 if ( !is_entry_objectclass_or_sub( e, oc_errAbsObject ) ) {
555 return SLAP_CB_CONTINUE;
559 a = attr_find( e->e_attrs, ad_errOp );
563 struct berval bv = BER_BVNULL;
565 (void)retcode_op2str( op->o_tag, &bv );
567 if ( BER_BVISNULL( &bv ) ) {
568 return SLAP_CB_CONTINUE;
571 for ( i = 0; !BER_BVISNULL( &a->a_nvals[ i ] ); i++ ) {
572 if ( bvmatch( &a->a_nvals[ i ], &bv ) ) {
579 return SLAP_CB_CONTINUE;
584 a = attr_find( e->e_attrs, ad_errDisconnect );
586 if ( bvmatch( &a->a_nvals[ 0 ], &slap_true_bv ) ) {
587 return rs->sr_err = SLAPD_DISCONNECT;
593 a = attr_find( e->e_attrs, ad_errCode );
595 return SLAP_CB_CONTINUE;
597 err = strtol( a->a_nvals[ 0 ].bv_val, &next, 0 );
598 if ( next == a->a_nvals[ 0 ].bv_val || next[ 0 ] != '\0' ) {
599 return SLAP_CB_CONTINUE;
604 a = attr_find( e->e_attrs, ad_errSleepTime );
605 if ( a != NULL && a->a_nvals[ 0 ].bv_val[ 0 ] != '-' ) {
608 if ( lutil_atoi( &sleepTime, a->a_nvals[ 0 ].bv_val ) == 0 ) {
609 retcode_sleep( sleepTime );
613 if ( rs->sr_err != LDAP_SUCCESS && !LDAP_API_ERROR( rs->sr_err )) {
614 BackendDB db = *op->o_bd,
616 void *o_callback = op->o_callback;
619 a = attr_find( e->e_attrs, ad_errText );
621 rs->sr_text = a->a_vals[ 0 ].bv_val;
625 a = attr_find( e->e_attrs, ad_errMatchedDN );
627 rs->sr_matched = a->a_vals[ 0 ].bv_val;
631 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
633 bi = on->on_info->oi_orig;
638 op->o_callback = NULL;
641 if ( rs->sr_err == LDAP_REFERRAL ) {
642 BerVarray refs = default_referral;
644 a = attr_find( e->e_attrs, slap_schema.si_ad_ref );
648 rs->sr_ref = referral_rewrite( refs,
649 NULL, &op->o_req_dn, op->oq_search.rs_scope );
651 send_search_reference( op, rs );
652 ber_bvarray_free( rs->sr_ref );
656 a = attr_find( e->e_attrs, ad_errUnsolicitedOID );
658 struct berval oid = BER_BVNULL,
660 ber_int_t msgid = op->o_msgid;
662 /* RFC 4511 unsolicited response */
666 oid = a->a_nvals[ 0 ];
668 a = attr_find( e->e_attrs, ad_errUnsolicitedData );
670 data = a->a_nvals[ 0 ];
673 if ( strcmp( oid.bv_val, "0" ) == 0 ) {
674 send_ldap_result( op, rs );
677 ber_tag_t tag = op->o_tag;
679 op->o_tag = LDAP_REQ_EXTENDED;
680 rs->sr_rspoid = oid.bv_val;
681 if ( !BER_BVISNULL( &data ) ) {
682 rs->sr_rspdata = &data;
684 send_ldap_extended( op, rs );
685 rs->sr_rspoid = NULL;
686 rs->sr_rspdata = NULL;
692 send_ldap_result( op, rs );
697 rs->sr_matched = NULL;
699 op->o_callback = o_callback;
702 if ( rs->sr_err != LDAP_SUCCESS ) {
704 return rs->sr_err = SLAPD_DISCONNECT;
711 return SLAP_CB_CONTINUE;
715 retcode_response( Operation *op, SlapReply *rs )
717 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
718 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
720 if ( rs->sr_type != REP_SEARCH || !RETCODE_INDIR( rd ) ) {
721 return SLAP_CB_CONTINUE;
724 return retcode_entry_response( op, rs, NULL, rs->sr_entry );
728 retcode_db_init( BackendDB *be )
730 slap_overinst *on = (slap_overinst *)be->bd_info;
735 rd = (retcode_t *)ch_malloc( sizeof( retcode_t ) );
736 memset( rd, 0, sizeof( retcode_t ) );
738 on->on_bi.bi_private = (void *)rd;
751 slap_overinst *on = (slap_overinst *)be->bd_info;
752 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
754 char *argv0 = argv[ 0 ] + STRLENOF( "retcode-" );
756 if ( strncasecmp( argv[ 0 ], "retcode-", STRLENOF( "retcode-" ) ) != 0 ) {
757 return SLAP_CONF_UNKNOWN;
760 if ( strcasecmp( argv0, "parent" ) == 0 ) {
765 fprintf( stderr, "%s: line %d: retcode: "
766 "\"retcode-parent <DN>\": missing <DN>\n",
771 if ( !BER_BVISNULL( &rd->rd_pdn ) ) {
772 fprintf( stderr, "%s: line %d: retcode: "
773 "parent already defined.\n", fname, lineno );
777 ber_str2bv( argv[ 1 ], 0, 0, &dn );
779 rc = dnPrettyNormal( NULL, &dn, &rd->rd_pdn, &rd->rd_npdn, NULL );
780 if ( rc != LDAP_SUCCESS ) {
781 fprintf( stderr, "%s: line %d: retcode: "
782 "unable to normalize parent DN \"%s\": %d\n",
783 fname, lineno, argv[ 1 ], rc );
787 } else if ( strcasecmp( argv0, "item" ) == 0 ) {
788 retcode_item_t rdi = { BER_BVNULL }, **rdip;
789 struct berval bv, rdn, nrdn;
794 fprintf( stderr, "%s: line %d: retcode: "
795 "\"retcode-item <RDN> <retcode> [<text>]\": "
801 ber_str2bv( argv[ 1 ], 0, 0, &bv );
803 rc = dnPrettyNormal( NULL, &bv, &rdn, &nrdn, NULL );
804 if ( rc != LDAP_SUCCESS ) {
805 fprintf( stderr, "%s: line %d: retcode: "
806 "unable to normalize RDN \"%s\": %d\n",
807 fname, lineno, argv[ 1 ], rc );
811 if ( !dnIsOneLevelRDN( &nrdn ) ) {
812 fprintf( stderr, "%s: line %d: retcode: "
813 "value \"%s\" is not a RDN\n",
814 fname, lineno, argv[ 1 ] );
818 if ( BER_BVISNULL( &rd->rd_npdn ) ) {
819 /* FIXME: we use the database suffix */
820 if ( be->be_nsuffix == NULL ) {
821 fprintf( stderr, "%s: line %d: retcode: "
822 "either \"retcode-parent\" "
823 "or \"suffix\" must be defined.\n",
828 ber_dupbv( &rd->rd_pdn, &be->be_suffix[ 0 ] );
829 ber_dupbv( &rd->rd_npdn, &be->be_nsuffix[ 0 ] );
832 build_new_dn( &rdi.rdi_dn, &rd->rd_pdn, &rdn, NULL );
833 build_new_dn( &rdi.rdi_ndn, &rd->rd_npdn, &nrdn, NULL );
835 ch_free( rdn.bv_val );
836 ch_free( nrdn.bv_val );
838 rdi.rdi_err = strtol( argv[ 2 ], &next, 0 );
839 if ( next == argv[ 2 ] || next[ 0 ] != '\0' ) {
840 fprintf( stderr, "%s: line %d: retcode: "
841 "unable to parse return code \"%s\"\n",
842 fname, lineno, argv[ 2 ] );
846 rdi.rdi_mask = SN_DG_OP_ALL;
851 for ( i = 3; i < argc; i++ ) {
852 if ( strncasecmp( argv[ i ], "op=", STRLENOF( "op=" ) ) == 0 )
857 ops = ldap_str2charray( &argv[ i ][ STRLENOF( "op=" ) ], "," );
858 assert( ops != NULL );
860 rdi.rdi_mask = SN_DG_OP_NONE;
862 for ( j = 0; ops[ j ] != NULL; j++ ) {
863 if ( strcasecmp( ops[ j ], "add" ) == 0 ) {
864 rdi.rdi_mask |= SN_DG_OP_ADD;
866 } else if ( strcasecmp( ops[ j ], "bind" ) == 0 ) {
867 rdi.rdi_mask |= SN_DG_OP_BIND;
869 } else if ( strcasecmp( ops[ j ], "compare" ) == 0 ) {
870 rdi.rdi_mask |= SN_DG_OP_COMPARE;
872 } else if ( strcasecmp( ops[ j ], "delete" ) == 0 ) {
873 rdi.rdi_mask |= SN_DG_OP_DELETE;
875 } else if ( strcasecmp( ops[ j ], "modify" ) == 0 ) {
876 rdi.rdi_mask |= SN_DG_OP_MODIFY;
878 } else if ( strcasecmp( ops[ j ], "rename" ) == 0
879 || strcasecmp( ops[ j ], "modrdn" ) == 0 )
881 rdi.rdi_mask |= SN_DG_OP_RENAME;
883 } else if ( strcasecmp( ops[ j ], "search" ) == 0 ) {
884 rdi.rdi_mask |= SN_DG_OP_SEARCH;
886 } else if ( strcasecmp( ops[ j ], "extended" ) == 0 ) {
887 rdi.rdi_mask |= SN_DG_EXTENDED;
889 } else if ( strcasecmp( ops[ j ], "auth" ) == 0 ) {
890 rdi.rdi_mask |= SN_DG_OP_AUTH;
892 } else if ( strcasecmp( ops[ j ], "read" ) == 0 ) {
893 rdi.rdi_mask |= SN_DG_OP_READ;
895 } else if ( strcasecmp( ops[ j ], "write" ) == 0 ) {
896 rdi.rdi_mask |= SN_DG_OP_WRITE;
898 } else if ( strcasecmp( ops[ j ], "all" ) == 0 ) {
899 rdi.rdi_mask |= SN_DG_OP_ALL;
902 fprintf( stderr, "retcode: unknown op \"%s\"\n",
904 ldap_charray_free( ops );
909 ldap_charray_free( ops );
911 } else if ( strncasecmp( argv[ i ], "text=", STRLENOF( "text=" ) ) == 0 )
913 if ( !BER_BVISNULL( &rdi.rdi_text ) ) {
914 fprintf( stderr, "%s: line %d: retcode: "
915 "\"text\" already provided.\n",
919 ber_str2bv( &argv[ i ][ STRLENOF( "text=" ) ], 0, 1, &rdi.rdi_text );
921 } else if ( strncasecmp( argv[ i ], "matched=", STRLENOF( "matched=" ) ) == 0 )
925 if ( !BER_BVISNULL( &rdi.rdi_matched ) ) {
926 fprintf( stderr, "%s: line %d: retcode: "
927 "\"matched\" already provided.\n",
931 ber_str2bv( &argv[ i ][ STRLENOF( "matched=" ) ], 0, 0, &dn );
932 if ( dnPretty( NULL, &dn, &rdi.rdi_matched, NULL ) != LDAP_SUCCESS ) {
933 fprintf( stderr, "%s: line %d: retcode: "
934 "unable to prettify matched DN \"%s\".\n",
935 fname, lineno, &argv[ i ][ STRLENOF( "matched=" ) ] );
939 } else if ( strncasecmp( argv[ i ], "ref=", STRLENOF( "ref=" ) ) == 0 )
944 if ( rdi.rdi_ref != NULL ) {
945 fprintf( stderr, "%s: line %d: retcode: "
946 "\"ref\" already provided.\n",
951 if ( rdi.rdi_err != LDAP_REFERRAL ) {
952 fprintf( stderr, "%s: line %d: retcode: "
953 "providing \"ref\"\n"
954 "\talong with a non-referral "
955 "resultCode may cause slapd failures\n"
956 "\trelated to internal checks.\n",
960 refs = ldap_str2charray( &argv[ i ][ STRLENOF( "ref=" ) ], " " );
961 assert( refs != NULL );
963 for ( j = 0; refs[ j ] != NULL; j++ ) {
966 ber_str2bv( refs[ j ], 0, 1, &bv );
967 ber_bvarray_add( &rdi.rdi_ref, &bv );
970 ldap_charray_free( refs );
972 } else if ( strncasecmp( argv[ i ], "sleeptime=", STRLENOF( "sleeptime=" ) ) == 0 )
974 if ( rdi.rdi_sleeptime != 0 ) {
975 fprintf( stderr, "%s: line %d: retcode: "
976 "\"sleeptime\" already provided.\n",
981 if ( lutil_atoi( &rdi.rdi_sleeptime, &argv[ i ][ STRLENOF( "sleeptime=" ) ] ) ) {
982 fprintf( stderr, "%s: line %d: retcode: "
983 "unable to parse \"sleeptime=%s\".\n",
984 fname, lineno, &argv[ i ][ STRLENOF( "sleeptime=" ) ] );
988 } else if ( strncasecmp( argv[ i ], "unsolicited=", STRLENOF( "unsolicited=" ) ) == 0 )
992 if ( !BER_BVISNULL( &rdi.rdi_unsolicited_oid ) ) {
993 fprintf( stderr, "%s: line %d: retcode: "
994 "\"unsolicited\" already provided.\n",
999 data = strchr( &argv[ i ][ STRLENOF( "unsolicited=" ) ], ':' );
1000 if ( data != NULL ) {
1003 if ( ldif_parse_line2( &argv[ i ][ STRLENOF( "unsolicited=" ) ],
1004 &oid, &rdi.rdi_unsolicited_data, NULL ) )
1006 fprintf( stderr, "%s: line %d: retcode: "
1007 "unable to parse \"unsolicited\".\n",
1012 ber_dupbv( &rdi.rdi_unsolicited_oid, &oid );
1015 ber_str2bv( &argv[ i ][ STRLENOF( "unsolicited=" ) ], 0, 1,
1016 &rdi.rdi_unsolicited_oid );
1019 } else if ( strncasecmp( argv[ i ], "flags=", STRLENOF( "flags=" ) ) == 0 )
1021 char *arg = &argv[ i ][ STRLENOF( "flags=" ) ];
1022 if ( strcasecmp( arg, "disconnect" ) == 0 ) {
1023 rdi.rdi_flags |= RDI_PRE_DISCONNECT;
1025 } else if ( strcasecmp( arg, "pre-disconnect" ) == 0 ) {
1026 rdi.rdi_flags |= RDI_PRE_DISCONNECT;
1028 } else if ( strcasecmp( arg, "post-disconnect" ) == 0 ) {
1029 rdi.rdi_flags |= RDI_POST_DISCONNECT;
1032 fprintf( stderr, "%s: line %d: retcode: "
1033 "unknown flag \"%s\".\n",
1034 fname, lineno, arg );
1039 fprintf( stderr, "%s: line %d: retcode: "
1040 "unknown option \"%s\".\n",
1041 fname, lineno, argv[ i ] );
1047 for ( rdip = &rd->rd_item; *rdip; rdip = &(*rdip)->rdi_next )
1051 *rdip = ( retcode_item_t * )ch_malloc( sizeof( retcode_item_t ) );
1054 } else if ( strcasecmp( argv0, "indir" ) == 0 ) {
1055 rd->rd_flags |= RETCODE_FINDIR;
1057 } else if ( strcasecmp( argv0, "sleep" ) == 0 ) {
1060 fprintf( stderr, "%s: line %d: retcode: "
1061 "\"retcode-sleep <time>\": missing <time>\n",
1069 fprintf( stderr, "%s: line %d: retcode: "
1070 "\"retcode-sleep <time>\": extra cruft after <time>\n",
1075 if ( lutil_atoi( &rd->rd_sleep, argv[ 1 ] ) != 0 ) {
1076 fprintf( stderr, "%s: line %d: retcode: "
1077 "\"retcode-sleep <time>\": unable to parse <time>\n",
1083 return SLAP_CONF_UNKNOWN;
1090 retcode_db_open( BackendDB *be )
1092 slap_overinst *on = (slap_overinst *)be->bd_info;
1093 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
1095 retcode_item_t *rdi;
1097 for ( rdi = rd->rd_item; rdi; rdi = rdi->rdi_next ) {
1101 struct berval val[ 3 ];
1102 char buf[ SLAP_TEXT_BUFLEN ];
1105 rdi->rdi_e.e_name = rdi->rdi_dn;
1106 rdi->rdi_e.e_nname = rdi->rdi_ndn;
1109 val[ 0 ] = oc_errObject->soc_cname;
1110 val[ 1 ] = slap_schema.si_oc_extensibleObject->soc_cname;
1111 BER_BVZERO( &val[ 2 ] );
1113 attr_merge( &rdi->rdi_e, slap_schema.si_ad_objectClass, val, NULL );
1116 rc = ldap_bv2rdn( &rdi->rdi_dn, &rdn, (char **) &p,
1117 LDAP_DN_FORMAT_LDAP );
1119 assert( rc == LDAP_SUCCESS );
1121 for ( j = 0; rdn[ j ]; j++ ) {
1122 LDAPAVA *ava = rdn[ j ];
1123 AttributeDescription *ad = NULL;
1126 rc = slap_bv2ad( &ava->la_attr, &ad, &text );
1127 assert( rc == LDAP_SUCCESS );
1129 attr_merge_normalize_one( &rdi->rdi_e, ad,
1130 &ava->la_value, NULL );
1133 ldap_rdnfree( rdn );
1136 snprintf( buf, sizeof( buf ), "%d", rdi->rdi_err );
1137 ber_str2bv( buf, 0, 0, &val[ 0 ] );
1139 attr_merge_one( &rdi->rdi_e, ad_errCode, &val[ 0 ], NULL );
1141 if ( rdi->rdi_ref != NULL ) {
1142 attr_merge_normalize( &rdi->rdi_e, slap_schema.si_ad_ref,
1143 rdi->rdi_ref, NULL );
1147 if ( !BER_BVISNULL( &rdi->rdi_text ) ) {
1148 val[ 0 ] = rdi->rdi_text;
1150 attr_merge_normalize_one( &rdi->rdi_e, ad_errText, &val[ 0 ], NULL );
1154 if ( !BER_BVISNULL( &rdi->rdi_matched ) ) {
1155 val[ 0 ] = rdi->rdi_matched;
1157 attr_merge_normalize_one( &rdi->rdi_e, ad_errMatchedDN, &val[ 0 ], NULL );
1161 if ( rdi->rdi_sleeptime ) {
1162 snprintf( buf, sizeof( buf ), "%d", rdi->rdi_sleeptime );
1163 ber_str2bv( buf, 0, 0, &val[ 0 ] );
1165 attr_merge_one( &rdi->rdi_e, ad_errSleepTime, &val[ 0 ], NULL );
1169 if ( rdi->rdi_mask & SN_DG_OP_ADD ) {
1170 BER_BVSTR( &val[ 0 ], "add" );
1171 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1174 if ( rdi->rdi_mask & SN_DG_OP_BIND ) {
1175 BER_BVSTR( &val[ 0 ], "bind" );
1176 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1179 if ( rdi->rdi_mask & SN_DG_OP_COMPARE ) {
1180 BER_BVSTR( &val[ 0 ], "compare" );
1181 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1184 if ( rdi->rdi_mask & SN_DG_OP_DELETE ) {
1185 BER_BVSTR( &val[ 0 ], "delete" );
1186 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1189 if ( rdi->rdi_mask & SN_DG_EXTENDED ) {
1190 BER_BVSTR( &val[ 0 ], "extended" );
1191 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1194 if ( rdi->rdi_mask & SN_DG_OP_MODIFY ) {
1195 BER_BVSTR( &val[ 0 ], "modify" );
1196 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1199 if ( rdi->rdi_mask & SN_DG_OP_RENAME ) {
1200 BER_BVSTR( &val[ 0 ], "rename" );
1201 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1204 if ( rdi->rdi_mask & SN_DG_OP_SEARCH ) {
1205 BER_BVSTR( &val[ 0 ], "search" );
1206 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1214 retcode_db_destroy( BackendDB *be )
1216 slap_overinst *on = (slap_overinst *)be->bd_info;
1217 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
1220 retcode_item_t *rdi, *next;
1222 for ( rdi = rd->rd_item; rdi != NULL; rdi = next ) {
1223 ber_memfree( rdi->rdi_dn.bv_val );
1224 ber_memfree( rdi->rdi_ndn.bv_val );
1226 if ( !BER_BVISNULL( &rdi->rdi_text ) ) {
1227 ber_memfree( rdi->rdi_text.bv_val );
1230 if ( !BER_BVISNULL( &rdi->rdi_matched ) ) {
1231 ber_memfree( rdi->rdi_matched.bv_val );
1234 if ( rdi->rdi_ref ) {
1235 ber_bvarray_free( rdi->rdi_ref );
1238 BER_BVZERO( &rdi->rdi_e.e_name );
1239 BER_BVZERO( &rdi->rdi_e.e_nname );
1241 entry_clean( &rdi->rdi_e );
1243 next = rdi->rdi_next;
1248 if ( !BER_BVISNULL( &rd->rd_pdn ) ) {
1249 ber_memfree( rd->rd_pdn.bv_val );
1252 if ( !BER_BVISNULL( &rd->rd_npdn ) ) {
1253 ber_memfree( rd->rd_npdn.bv_val );
1262 #if SLAPD_OVER_RETCODE == SLAPD_MOD_DYNAMIC
1264 #endif /* SLAPD_OVER_RETCODE == SLAPD_MOD_DYNAMIC */
1266 retcode_initialize( void )
1272 AttributeDescription **ad;
1274 { "( 1.3.6.1.4.1.4203.666.11.4.1.1 "
1275 "NAME ( 'errCode' ) "
1276 "DESC 'LDAP error code' "
1277 "EQUALITY integerMatch "
1278 "ORDERING integerOrderingMatch "
1279 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
1282 { "( 1.3.6.1.4.1.4203.666.11.4.1.2 "
1284 "DESC 'Operations the errObject applies to' "
1285 "EQUALITY caseIgnoreMatch "
1286 "SUBSTR caseIgnoreSubstringsMatch "
1287 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 )",
1289 { "( 1.3.6.1.4.1.4203.666.11.4.1.3 "
1290 "NAME ( 'errText' ) "
1291 "DESC 'LDAP error textual description' "
1292 "EQUALITY caseIgnoreMatch "
1293 "SUBSTR caseIgnoreSubstringsMatch "
1294 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 "
1297 { "( 1.3.6.1.4.1.4203.666.11.4.1.4 "
1298 "NAME ( 'errSleepTime' ) "
1299 "DESC 'Time to wait before returning the error' "
1300 "EQUALITY integerMatch "
1301 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
1304 { "( 1.3.6.1.4.1.4203.666.11.4.1.5 "
1305 "NAME ( 'errMatchedDN' ) "
1306 "DESC 'Value to be returned as matched DN' "
1307 "EQUALITY distinguishedNameMatch "
1308 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.12 "
1311 { "( 1.3.6.1.4.1.4203.666.11.4.1.6 "
1312 "NAME ( 'errUnsolicitedOID' ) "
1313 "DESC 'OID to be returned within unsolicited response' "
1314 "EQUALITY objectIdentifierMatch "
1315 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.38 "
1317 &ad_errUnsolicitedOID },
1318 { "( 1.3.6.1.4.1.4203.666.11.4.1.7 "
1319 "NAME ( 'errUnsolicitedData' ) "
1320 "DESC 'Data to be returned within unsolicited response' "
1321 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.40 "
1323 &ad_errUnsolicitedData },
1324 { "( 1.3.6.1.4.1.4203.666.11.4.1.8 "
1325 "NAME ( 'errDisconnect' ) "
1326 "DESC 'Disconnect without notice' "
1327 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.7 "
1329 &ad_errDisconnect },
1337 { "( 1.3.6.1.4.1.4203.666.11.4.3.0 "
1338 "NAME ( 'errAbsObject' ) "
1348 "$ errUnsolicitedOID "
1349 "$ errUnsolicitedData "
1353 { "( 1.3.6.1.4.1.4203.666.11.4.3.1 "
1354 "NAME ( 'errObject' ) "
1355 "SUP errAbsObject STRUCTURAL "
1358 { "( 1.3.6.1.4.1.4203.666.11.4.3.2 "
1359 "NAME ( 'errAuxObject' ) "
1360 "SUP errAbsObject AUXILIARY "
1367 for ( i = 0; retcode_at[ i ].desc != NULL; i++ ) {
1368 code = register_at( retcode_at[ i ].desc, retcode_at[ i ].ad, 0 );
1370 Debug( LDAP_DEBUG_ANY,
1371 "retcode: register_at failed\n", 0, 0, 0 );
1376 for ( i = 0; retcode_oc[ i ].desc != NULL; i++ ) {
1377 code = register_oc( retcode_oc[ i ].desc, retcode_oc[ i ].oc, 0 );
1379 Debug( LDAP_DEBUG_ANY,
1380 "retcode: register_oc failed\n", 0, 0, 0 );
1385 retcode.on_bi.bi_type = "retcode";
1387 retcode.on_bi.bi_db_init = retcode_db_init;
1388 retcode.on_bi.bi_db_config = retcode_db_config;
1389 retcode.on_bi.bi_db_open = retcode_db_open;
1390 retcode.on_bi.bi_db_destroy = retcode_db_destroy;
1392 retcode.on_bi.bi_op_add = retcode_op_func;
1393 retcode.on_bi.bi_op_bind = retcode_op_func;
1394 retcode.on_bi.bi_op_compare = retcode_op_func;
1395 retcode.on_bi.bi_op_delete = retcode_op_func;
1396 retcode.on_bi.bi_op_modify = retcode_op_func;
1397 retcode.on_bi.bi_op_modrdn = retcode_op_func;
1398 retcode.on_bi.bi_op_search = retcode_op_func;
1400 retcode.on_bi.bi_extended = retcode_op_func;
1402 retcode.on_response = retcode_response;
1404 return overlay_register( &retcode );
1407 #if SLAPD_OVER_RETCODE == SLAPD_MOD_DYNAMIC
1409 init_module( int argc, char *argv[] )
1411 return retcode_initialize();
1413 #endif /* SLAPD_OVER_RETCODE == SLAPD_MOD_DYNAMIC */
1415 #endif /* SLAPD_OVER_RETCODE */