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_DISCONNECT (0x1U)
84 struct retcode_item_t *rdi_next;
87 typedef struct retcode_t {
89 struct berval rd_npdn;
93 retcode_item_t *rd_item;
96 #define RETCODE_FNONE 0x00
97 #define RETCODE_FINDIR 0x01
98 #define RETCODE_INDIR( rd ) ( (rd)->rd_flags & RETCODE_FINDIR )
102 retcode_entry_response( Operation *op, SlapReply *rs, BackendInfo *bi, Entry *e );
105 retcode_sleep( int s )
109 /* sleep as required */
111 #if 0 /* use high-order bits for better randomness (Numerical Recipes in "C") */
114 r = ((double)(-s))*rand()/(RAND_MAX + 1.0);
115 } else if ( s > 0 ) {
126 retcode_cleanup_cb( Operation *op, SlapReply *rs )
128 rs->sr_matched = NULL;
131 if ( rs->sr_ref != NULL ) {
132 ber_bvarray_free( rs->sr_ref );
136 ch_free( op->o_callback );
137 op->o_callback = NULL;
139 return SLAP_CB_CONTINUE;
143 retcode_send_onelevel( Operation *op, SlapReply *rs )
145 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
146 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
150 for ( rdi = rd->rd_item; rdi != NULL; rdi = rdi->rdi_next ) {
151 if ( op->o_abandon ) {
152 return rs->sr_err = SLAPD_ABANDON;
155 rs->sr_err = test_filter( op, &rdi->rdi_e, op->ors_filter );
156 if ( rs->sr_err == LDAP_COMPARE_TRUE ) {
158 rs->sr_attrs = op->ors_attrs;
159 rs->sr_operational_attrs = NULL;
162 rs->sr_err = LDAP_SUCCESS;
163 rs->sr_entry = &rdi->rdi_e;
165 rs->sr_err = send_search_entry( op, rs );
168 switch ( rs->sr_err ) {
169 case LDAP_UNAVAILABLE: /* connection closed */
170 rs->sr_err = LDAP_OTHER;
172 case LDAP_SIZELIMIT_EXCEEDED:
176 rs->sr_err = LDAP_SUCCESS;
181 send_ldap_result( op, rs );
187 retcode_op_add( Operation *op, SlapReply *rs )
189 return retcode_entry_response( op, rs, NULL, op->ora_e );
192 typedef struct retcode_cb_t {
193 BackendInfo *rdc_info;
196 AttributeName *rdc_attrs;
200 retcode_cb_response( Operation *op, SlapReply *rs )
202 retcode_cb_t *rdc = (retcode_cb_t *)op->o_callback->sc_private;
204 if ( rs->sr_type == REP_SEARCH ) {
205 ber_tag_t o_tag = op->o_tag;
208 op->o_tag = rdc->rdc_tag;
209 if ( op->o_tag == LDAP_REQ_SEARCH ) {
210 rs->sr_attrs = rdc->rdc_attrs;
212 rc = retcode_entry_response( op, rs, rdc->rdc_info, rs->sr_entry );
218 if ( rs->sr_err == LDAP_SUCCESS ) {
219 if ( !op->o_abandon ) {
220 rdc->rdc_flags = SLAP_CB_CONTINUE;
225 return SLAP_CB_CONTINUE;
229 retcode_op_internal( Operation *op, SlapReply *rs )
231 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
234 BackendDB db = *op->o_bd;
235 slap_callback sc = { 0 };
240 op2.o_tag = LDAP_REQ_SEARCH;
241 op2.ors_scope = LDAP_SCOPE_BASE;
242 op2.ors_deref = LDAP_DEREF_NEVER;
243 op2.ors_tlimit = SLAP_NO_LIMIT;
244 op2.ors_slimit = SLAP_NO_LIMIT;
245 op2.ors_limit = NULL;
246 op2.ors_attrsonly = 0;
247 op2.ors_attrs = slap_anlist_all_attributes;
249 ber_str2bv_x( "(objectClass=errAbsObject)",
250 STRLENOF( "(objectClass=errAbsObject)" ),
251 1, &op2.ors_filterstr, op2.o_tmpmemctx );
252 op2.ors_filter = str2filter_x( &op2, op2.ors_filterstr.bv_val );
254 db.bd_info = on->on_info->oi_orig;
257 rdc.rdc_info = on->on_info->oi_orig;
258 rdc.rdc_flags = RETCODE_FINDIR;
259 if ( op->o_tag == LDAP_REQ_SEARCH ) {
260 rdc.rdc_attrs = op->ors_attrs;
262 rdc.rdc_tag = op->o_tag;
263 sc.sc_response = retcode_cb_response;
264 sc.sc_private = &rdc;
265 op2.o_callback = ≻
267 rc = op2.o_bd->be_search( &op2, rs );
268 op->o_abandon = op2.o_abandon;
270 filter_free_x( &op2, op2.ors_filter );
271 ber_memfree_x( op2.ors_filterstr.bv_val, op2.o_tmpmemctx );
273 if ( rdc.rdc_flags == SLAP_CB_CONTINUE ) {
274 return SLAP_CB_CONTINUE;
281 retcode_op_func( Operation *op, SlapReply *rs )
283 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
284 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
287 struct berval nrdn, npdn;
289 slap_callback *cb = NULL;
291 /* sleep as required */
292 retcode_sleep( rd->rd_sleep );
294 if ( !dnIsSuffix( &op->o_req_ndn, &rd->rd_npdn ) ) {
295 if ( RETCODE_INDIR( rd ) ) {
296 switch ( op->o_tag ) {
298 return retcode_op_add( op, rs );
302 if ( be_isroot_pw( op ) ) {
303 return SLAP_CB_CONTINUE;
305 return retcode_op_internal( op, rs );
307 case LDAP_REQ_SEARCH:
308 if ( op->ors_scope == LDAP_SCOPE_BASE ) {
309 rs->sr_err = retcode_op_internal( op, rs );
310 switch ( rs->sr_err ) {
311 case SLAP_CB_CONTINUE:
312 if ( rs->sr_nentries == 0 ) {
315 rs->sr_err = LDAP_SUCCESS;
319 send_ldap_result( op, rs );
326 case LDAP_REQ_MODIFY:
327 case LDAP_REQ_DELETE:
328 case LDAP_REQ_MODRDN:
329 case LDAP_REQ_COMPARE:
330 return retcode_op_internal( op, rs );
334 return SLAP_CB_CONTINUE;
337 if ( op->o_tag == LDAP_REQ_SEARCH
338 && op->ors_scope != LDAP_SCOPE_BASE
339 && op->o_req_ndn.bv_len == rd->rd_npdn.bv_len )
341 return retcode_send_onelevel( op, rs );
344 dnParent( &op->o_req_ndn, &npdn );
345 if ( npdn.bv_len != rd->rd_npdn.bv_len ) {
346 rs->sr_err = LDAP_NO_SUCH_OBJECT;
347 rs->sr_matched = rd->rd_pdn.bv_val;
348 send_ldap_result( op, rs );
349 rs->sr_matched = NULL;
353 dnRdn( &op->o_req_ndn, &nrdn );
355 for ( rdi = rd->rd_item; rdi != NULL; rdi = rdi->rdi_next ) {
356 struct berval rdi_nrdn;
358 dnRdn( &rdi->rdi_ndn, &rdi_nrdn );
359 if ( dn_match( &nrdn, &rdi_nrdn ) ) {
364 if ( rdi != NULL && rdi->rdi_mask != SN_DG_OP_ALL ) {
365 retcode_op_e o_tag = SN_DG_OP_NONE;
367 switch ( op->o_tag ) {
369 o_tag = SN_DG_OP_ADD;
373 o_tag = SN_DG_OP_BIND;
376 case LDAP_REQ_COMPARE:
377 o_tag = SN_DG_OP_COMPARE;
380 case LDAP_REQ_DELETE:
381 o_tag = SN_DG_OP_DELETE;
384 case LDAP_REQ_MODIFY:
385 o_tag = SN_DG_OP_MODIFY;
388 case LDAP_REQ_MODRDN:
389 o_tag = SN_DG_OP_RENAME;
392 case LDAP_REQ_SEARCH:
393 o_tag = SN_DG_OP_SEARCH;
396 case LDAP_REQ_EXTENDED:
397 o_tag = SN_DG_EXTENDED;
401 /* Should not happen */
405 if ( !( o_tag & rdi->rdi_mask ) ) {
406 return SLAP_CB_CONTINUE;
411 rs->sr_matched = rd->rd_pdn.bv_val;
412 rs->sr_err = LDAP_NO_SUCH_OBJECT;
413 rs->sr_text = "retcode not found";
416 if ( rdi->rdi_flags & RDI_DISCONNECT ) {
417 return rs->sr_err = SLAPD_DISCONNECT;
420 rs->sr_err = rdi->rdi_err;
421 rs->sr_text = rdi->rdi_text.bv_val;
422 rs->sr_matched = rdi->rdi_matched.bv_val;
424 /* FIXME: we only honor the rdi_ref field in case rdi_err
425 * is LDAP_REFERRAL otherwise send_ldap_result() bails out */
426 if ( rs->sr_err == LDAP_REFERRAL ) {
429 if ( rdi->rdi_ref != NULL ) {
432 ref = default_referral;
436 rs->sr_ref = referral_rewrite( ref,
437 NULL, &op->o_req_dn, LDAP_SCOPE_DEFAULT );
440 rs->sr_err = LDAP_OTHER;
441 rs->sr_text = "bad referral object";
445 retcode_sleep( rdi->rdi_sleeptime );
448 switch ( op->o_tag ) {
449 case LDAP_REQ_EXTENDED:
453 cb = ( slap_callback * )ch_malloc( sizeof( slap_callback ) );
454 memset( cb, 0, sizeof( slap_callback ) );
455 cb->sc_cleanup = retcode_cleanup_cb;
460 if ( rdi && !BER_BVISNULL( &rdi->rdi_unsolicited_oid ) ) {
461 ber_int_t msgid = op->o_msgid;
463 /* RFC 4511 unsolicited response */
466 if ( strcmp( rdi->rdi_unsolicited_oid.bv_val, "0" ) == 0 ) {
467 send_ldap_result( op, rs );
470 ber_tag_t tag = op->o_tag;
472 op->o_tag = LDAP_REQ_EXTENDED;
473 rs->sr_rspoid = rdi->rdi_unsolicited_oid.bv_val;
474 if ( !BER_BVISNULL( &rdi->rdi_unsolicited_data ) ) {
475 rs->sr_rspdata = &rdi->rdi_unsolicited_data;
477 send_ldap_extended( op, rs );
478 rs->sr_rspoid = NULL;
479 rs->sr_rspdata = NULL;
486 send_ldap_result( op, rs );
489 if ( rs->sr_ref != NULL ) {
490 ber_bvarray_free( rs->sr_ref );
493 rs->sr_matched = NULL;
502 retcode_op2str( ber_tag_t op, struct berval *bv )
506 BER_BVSTR( bv, "bind" );
509 BER_BVSTR( bv, "add" );
511 case LDAP_REQ_DELETE:
512 BER_BVSTR( bv, "delete" );
514 case LDAP_REQ_MODRDN:
515 BER_BVSTR( bv, "modrdn" );
517 case LDAP_REQ_MODIFY:
518 BER_BVSTR( bv, "modify" );
520 case LDAP_REQ_COMPARE:
521 BER_BVSTR( bv, "compare" );
523 case LDAP_REQ_SEARCH:
524 BER_BVSTR( bv, "search" );
526 case LDAP_REQ_EXTENDED:
527 BER_BVSTR( bv, "extended" );
534 retcode_entry_response( Operation *op, SlapReply *rs, BackendInfo *bi, Entry *e )
540 if ( get_manageDSAit( op ) ) {
541 return SLAP_CB_CONTINUE;
544 if ( !is_entry_objectclass_or_sub( e, oc_errAbsObject ) ) {
545 return SLAP_CB_CONTINUE;
549 a = attr_find( e->e_attrs, ad_errOp );
553 struct berval bv = BER_BVNULL;
555 (void)retcode_op2str( op->o_tag, &bv );
557 if ( BER_BVISNULL( &bv ) ) {
558 return SLAP_CB_CONTINUE;
561 for ( i = 0; !BER_BVISNULL( &a->a_nvals[ i ] ); i++ ) {
562 if ( bvmatch( &a->a_nvals[ i ], &bv ) ) {
569 return SLAP_CB_CONTINUE;
574 a = attr_find( e->e_attrs, ad_errDisconnect );
575 if ( a != NULL && bvmatch( &a->a_nvals[ 0 ], &slap_true_bv ) ) {
576 return rs->sr_err = SLAPD_DISCONNECT;
580 a = attr_find( e->e_attrs, ad_errCode );
582 return SLAP_CB_CONTINUE;
584 err = strtol( a->a_nvals[ 0 ].bv_val, &next, 0 );
585 if ( next == a->a_nvals[ 0 ].bv_val || next[ 0 ] != '\0' ) {
586 return SLAP_CB_CONTINUE;
591 a = attr_find( e->e_attrs, ad_errSleepTime );
592 if ( a != NULL && a->a_nvals[ 0 ].bv_val[ 0 ] != '-' ) {
595 if ( lutil_atoi( &sleepTime, a->a_nvals[ 0 ].bv_val ) == 0 ) {
596 retcode_sleep( sleepTime );
600 if ( rs->sr_err != LDAP_SUCCESS && !LDAP_API_ERROR( rs->sr_err )) {
601 BackendDB db = *op->o_bd,
603 void *o_callback = op->o_callback;
606 a = attr_find( e->e_attrs, ad_errText );
608 rs->sr_text = a->a_vals[ 0 ].bv_val;
612 a = attr_find( e->e_attrs, ad_errMatchedDN );
614 rs->sr_matched = a->a_vals[ 0 ].bv_val;
618 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
620 bi = on->on_info->oi_orig;
625 op->o_callback = NULL;
628 if ( rs->sr_err == LDAP_REFERRAL ) {
629 BerVarray refs = default_referral;
631 a = attr_find( e->e_attrs, slap_schema.si_ad_ref );
635 rs->sr_ref = referral_rewrite( refs,
636 NULL, &op->o_req_dn, op->oq_search.rs_scope );
638 send_search_reference( op, rs );
639 ber_bvarray_free( rs->sr_ref );
643 a = attr_find( e->e_attrs, ad_errUnsolicitedOID );
645 struct berval oid = BER_BVNULL,
647 ber_int_t msgid = op->o_msgid;
649 /* RFC 4511 unsolicited response */
653 oid = a->a_nvals[ 0 ];
655 a = attr_find( e->e_attrs, ad_errUnsolicitedData );
657 data = a->a_nvals[ 0 ];
660 if ( strcmp( oid.bv_val, "0" ) == 0 ) {
661 send_ldap_result( op, rs );
664 ber_tag_t tag = op->o_tag;
666 op->o_tag = LDAP_REQ_EXTENDED;
667 rs->sr_rspoid = oid.bv_val;
668 if ( !BER_BVISNULL( &data ) ) {
669 rs->sr_rspdata = &data;
671 send_ldap_extended( op, rs );
672 rs->sr_rspoid = NULL;
673 rs->sr_rspdata = NULL;
679 send_ldap_result( op, rs );
684 rs->sr_matched = NULL;
686 op->o_callback = o_callback;
689 if ( rs->sr_err != LDAP_SUCCESS ) {
694 return SLAP_CB_CONTINUE;
698 retcode_response( Operation *op, SlapReply *rs )
700 slap_overinst *on = (slap_overinst *)op->o_bd->bd_info;
701 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
703 if ( rs->sr_type != REP_SEARCH || !RETCODE_INDIR( rd ) ) {
704 return SLAP_CB_CONTINUE;
707 return retcode_entry_response( op, rs, NULL, rs->sr_entry );
711 retcode_db_init( BackendDB *be )
713 slap_overinst *on = (slap_overinst *)be->bd_info;
718 rd = (retcode_t *)ch_malloc( sizeof( retcode_t ) );
719 memset( rd, 0, sizeof( retcode_t ) );
721 on->on_bi.bi_private = (void *)rd;
734 slap_overinst *on = (slap_overinst *)be->bd_info;
735 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
737 char *argv0 = argv[ 0 ] + STRLENOF( "retcode-" );
739 if ( strncasecmp( argv[ 0 ], "retcode-", STRLENOF( "retcode-" ) ) != 0 ) {
740 return SLAP_CONF_UNKNOWN;
743 if ( strcasecmp( argv0, "parent" ) == 0 ) {
748 fprintf( stderr, "%s: line %d: retcode: "
749 "\"retcode-parent <DN>\": missing <DN>\n",
754 if ( !BER_BVISNULL( &rd->rd_pdn ) ) {
755 fprintf( stderr, "%s: line %d: retcode: "
756 "parent already defined.\n", fname, lineno );
760 ber_str2bv( argv[ 1 ], 0, 0, &dn );
762 rc = dnPrettyNormal( NULL, &dn, &rd->rd_pdn, &rd->rd_npdn, NULL );
763 if ( rc != LDAP_SUCCESS ) {
764 fprintf( stderr, "%s: line %d: retcode: "
765 "unable to normalize parent DN \"%s\": %d\n",
766 fname, lineno, argv[ 1 ], rc );
770 } else if ( strcasecmp( argv0, "item" ) == 0 ) {
771 retcode_item_t rdi = { BER_BVNULL }, **rdip;
772 struct berval bv, rdn, nrdn;
777 fprintf( stderr, "%s: line %d: retcode: "
778 "\"retcode-item <RDN> <retcode> [<text>]\": "
784 ber_str2bv( argv[ 1 ], 0, 0, &bv );
786 rc = dnPrettyNormal( NULL, &bv, &rdn, &nrdn, NULL );
787 if ( rc != LDAP_SUCCESS ) {
788 fprintf( stderr, "%s: line %d: retcode: "
789 "unable to normalize RDN \"%s\": %d\n",
790 fname, lineno, argv[ 1 ], rc );
794 if ( !dnIsOneLevelRDN( &nrdn ) ) {
795 fprintf( stderr, "%s: line %d: retcode: "
796 "value \"%s\" is not a RDN\n",
797 fname, lineno, argv[ 1 ] );
801 if ( BER_BVISNULL( &rd->rd_npdn ) ) {
802 /* FIXME: we use the database suffix */
803 if ( be->be_nsuffix == NULL ) {
804 fprintf( stderr, "%s: line %d: retcode: "
805 "either \"retcode-parent\" "
806 "or \"suffix\" must be defined.\n",
811 ber_dupbv( &rd->rd_pdn, &be->be_suffix[ 0 ] );
812 ber_dupbv( &rd->rd_npdn, &be->be_nsuffix[ 0 ] );
815 build_new_dn( &rdi.rdi_dn, &rd->rd_pdn, &rdn, NULL );
816 build_new_dn( &rdi.rdi_ndn, &rd->rd_npdn, &nrdn, NULL );
818 ch_free( rdn.bv_val );
819 ch_free( nrdn.bv_val );
821 rdi.rdi_err = strtol( argv[ 2 ], &next, 0 );
822 if ( next == argv[ 2 ] || next[ 0 ] != '\0' ) {
823 fprintf( stderr, "%s: line %d: retcode: "
824 "unable to parse return code \"%s\"\n",
825 fname, lineno, argv[ 2 ] );
829 rdi.rdi_mask = SN_DG_OP_ALL;
834 for ( i = 3; i < argc; i++ ) {
835 if ( strncasecmp( argv[ i ], "op=", STRLENOF( "op=" ) ) == 0 )
840 ops = ldap_str2charray( &argv[ i ][ STRLENOF( "op=" ) ], "," );
841 assert( ops != NULL );
843 rdi.rdi_mask = SN_DG_OP_NONE;
845 for ( j = 0; ops[ j ] != NULL; j++ ) {
846 if ( strcasecmp( ops[ j ], "add" ) == 0 ) {
847 rdi.rdi_mask |= SN_DG_OP_ADD;
849 } else if ( strcasecmp( ops[ j ], "bind" ) == 0 ) {
850 rdi.rdi_mask |= SN_DG_OP_BIND;
852 } else if ( strcasecmp( ops[ j ], "compare" ) == 0 ) {
853 rdi.rdi_mask |= SN_DG_OP_COMPARE;
855 } else if ( strcasecmp( ops[ j ], "delete" ) == 0 ) {
856 rdi.rdi_mask |= SN_DG_OP_DELETE;
858 } else if ( strcasecmp( ops[ j ], "modify" ) == 0 ) {
859 rdi.rdi_mask |= SN_DG_OP_MODIFY;
861 } else if ( strcasecmp( ops[ j ], "rename" ) == 0
862 || strcasecmp( ops[ j ], "modrdn" ) == 0 )
864 rdi.rdi_mask |= SN_DG_OP_RENAME;
866 } else if ( strcasecmp( ops[ j ], "search" ) == 0 ) {
867 rdi.rdi_mask |= SN_DG_OP_SEARCH;
869 } else if ( strcasecmp( ops[ j ], "extended" ) == 0 ) {
870 rdi.rdi_mask |= SN_DG_EXTENDED;
872 } else if ( strcasecmp( ops[ j ], "auth" ) == 0 ) {
873 rdi.rdi_mask |= SN_DG_OP_AUTH;
875 } else if ( strcasecmp( ops[ j ], "read" ) == 0 ) {
876 rdi.rdi_mask |= SN_DG_OP_READ;
878 } else if ( strcasecmp( ops[ j ], "write" ) == 0 ) {
879 rdi.rdi_mask |= SN_DG_OP_WRITE;
881 } else if ( strcasecmp( ops[ j ], "all" ) == 0 ) {
882 rdi.rdi_mask |= SN_DG_OP_ALL;
885 fprintf( stderr, "retcode: unknown op \"%s\"\n",
887 ldap_charray_free( ops );
892 ldap_charray_free( ops );
894 } else if ( strncasecmp( argv[ i ], "text=", STRLENOF( "text=" ) ) == 0 )
896 if ( !BER_BVISNULL( &rdi.rdi_text ) ) {
897 fprintf( stderr, "%s: line %d: retcode: "
898 "\"text\" already provided.\n",
902 ber_str2bv( &argv[ i ][ STRLENOF( "text=" ) ], 0, 1, &rdi.rdi_text );
904 } else if ( strncasecmp( argv[ i ], "matched=", STRLENOF( "matched=" ) ) == 0 )
908 if ( !BER_BVISNULL( &rdi.rdi_matched ) ) {
909 fprintf( stderr, "%s: line %d: retcode: "
910 "\"matched\" already provided.\n",
914 ber_str2bv( &argv[ i ][ STRLENOF( "matched=" ) ], 0, 0, &dn );
915 if ( dnPretty( NULL, &dn, &rdi.rdi_matched, NULL ) != LDAP_SUCCESS ) {
916 fprintf( stderr, "%s: line %d: retcode: "
917 "unable to prettify matched DN \"%s\".\n",
918 fname, lineno, &argv[ i ][ STRLENOF( "matched=" ) ] );
922 } else if ( strncasecmp( argv[ i ], "ref=", STRLENOF( "ref=" ) ) == 0 )
927 if ( rdi.rdi_ref != NULL ) {
928 fprintf( stderr, "%s: line %d: retcode: "
929 "\"ref\" already provided.\n",
934 if ( rdi.rdi_err != LDAP_REFERRAL ) {
935 fprintf( stderr, "%s: line %d: retcode: "
936 "providing \"ref\"\n"
937 "\talong with a non-referral "
938 "resultCode may cause slapd failures\n"
939 "\trelated to internal checks.\n",
943 refs = ldap_str2charray( &argv[ i ][ STRLENOF( "ref=" ) ], " " );
944 assert( refs != NULL );
946 for ( j = 0; refs[ j ] != NULL; j++ ) {
949 ber_str2bv( refs[ j ], 0, 1, &bv );
950 ber_bvarray_add( &rdi.rdi_ref, &bv );
953 ldap_charray_free( refs );
955 } else if ( strncasecmp( argv[ i ], "sleeptime=", STRLENOF( "sleeptime=" ) ) == 0 )
957 if ( rdi.rdi_sleeptime != 0 ) {
958 fprintf( stderr, "%s: line %d: retcode: "
959 "\"sleeptime\" already provided.\n",
964 if ( lutil_atoi( &rdi.rdi_sleeptime, &argv[ i ][ STRLENOF( "sleeptime=" ) ] ) ) {
965 fprintf( stderr, "%s: line %d: retcode: "
966 "unable to parse \"sleeptime=%s\".\n",
967 fname, lineno, &argv[ i ][ STRLENOF( "sleeptime=" ) ] );
971 } else if ( strncasecmp( argv[ i ], "unsolicited=", STRLENOF( "unsolicited=" ) ) == 0 )
975 if ( !BER_BVISNULL( &rdi.rdi_unsolicited_oid ) ) {
976 fprintf( stderr, "%s: line %d: retcode: "
977 "\"unsolicited\" already provided.\n",
982 data = strchr( &argv[ i ][ STRLENOF( "unsolicited=" ) ], ':' );
983 if ( data != NULL ) {
986 if ( ldif_parse_line2( &argv[ i ][ STRLENOF( "unsolicited=" ) ],
987 &oid, &rdi.rdi_unsolicited_data, NULL ) )
989 fprintf( stderr, "%s: line %d: retcode: "
990 "unable to parse \"unsolicited\".\n",
995 ber_dupbv( &rdi.rdi_unsolicited_oid, &oid );
998 ber_str2bv( &argv[ i ][ STRLENOF( "unsolicited=" ) ], 0, 1,
999 &rdi.rdi_unsolicited_oid );
1002 } else if ( strncasecmp( argv[ i ], "flags=", STRLENOF( "flags=" ) ) == 0 )
1004 if ( strcasecmp( &argv[ i ][ STRLENOF( "flags=" ) ], "disconnect" ) == 0 ) {
1005 rdi.rdi_flags |= RDI_DISCONNECT;
1008 fprintf( stderr, "%s: line %d: retcode: "
1009 "unknown flag \"%s\".\n",
1010 fname, lineno, &argv[ i ][ STRLENOF( "flags=" ) ] );
1015 fprintf( stderr, "%s: line %d: retcode: "
1016 "unknown option \"%s\".\n",
1017 fname, lineno, argv[ i ] );
1023 for ( rdip = &rd->rd_item; *rdip; rdip = &(*rdip)->rdi_next )
1027 *rdip = ( retcode_item_t * )ch_malloc( sizeof( retcode_item_t ) );
1030 } else if ( strcasecmp( argv0, "indir" ) == 0 ) {
1031 rd->rd_flags |= RETCODE_FINDIR;
1033 } else if ( strcasecmp( argv0, "sleep" ) == 0 ) {
1036 fprintf( stderr, "%s: line %d: retcode: "
1037 "\"retcode-sleep <time>\": missing <time>\n",
1045 fprintf( stderr, "%s: line %d: retcode: "
1046 "\"retcode-sleep <time>\": extra cruft after <time>\n",
1051 if ( lutil_atoi( &rd->rd_sleep, argv[ 1 ] ) != 0 ) {
1052 fprintf( stderr, "%s: line %d: retcode: "
1053 "\"retcode-sleep <time>\": unable to parse <time>\n",
1059 return SLAP_CONF_UNKNOWN;
1066 retcode_db_open( BackendDB *be )
1068 slap_overinst *on = (slap_overinst *)be->bd_info;
1069 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
1071 retcode_item_t *rdi;
1073 for ( rdi = rd->rd_item; rdi; rdi = rdi->rdi_next ) {
1077 struct berval val[ 3 ];
1078 char buf[ SLAP_TEXT_BUFLEN ];
1081 rdi->rdi_e.e_name = rdi->rdi_dn;
1082 rdi->rdi_e.e_nname = rdi->rdi_ndn;
1085 val[ 0 ] = oc_errObject->soc_cname;
1086 val[ 1 ] = slap_schema.si_oc_extensibleObject->soc_cname;
1087 BER_BVZERO( &val[ 2 ] );
1089 attr_merge( &rdi->rdi_e, slap_schema.si_ad_objectClass, val, NULL );
1092 rc = ldap_bv2rdn( &rdi->rdi_dn, &rdn, (char **) &p,
1093 LDAP_DN_FORMAT_LDAP );
1095 assert( rc == LDAP_SUCCESS );
1097 for ( j = 0; rdn[ j ]; j++ ) {
1098 LDAPAVA *ava = rdn[ j ];
1099 AttributeDescription *ad = NULL;
1102 rc = slap_bv2ad( &ava->la_attr, &ad, &text );
1103 assert( rc == LDAP_SUCCESS );
1105 attr_merge_normalize_one( &rdi->rdi_e, ad,
1106 &ava->la_value, NULL );
1109 ldap_rdnfree( rdn );
1112 snprintf( buf, sizeof( buf ), "%d", rdi->rdi_err );
1113 ber_str2bv( buf, 0, 0, &val[ 0 ] );
1115 attr_merge_one( &rdi->rdi_e, ad_errCode, &val[ 0 ], NULL );
1117 if ( rdi->rdi_ref != NULL ) {
1118 attr_merge_normalize( &rdi->rdi_e, slap_schema.si_ad_ref,
1119 rdi->rdi_ref, NULL );
1123 if ( !BER_BVISNULL( &rdi->rdi_text ) ) {
1124 val[ 0 ] = rdi->rdi_text;
1126 attr_merge_normalize_one( &rdi->rdi_e, ad_errText, &val[ 0 ], NULL );
1130 if ( !BER_BVISNULL( &rdi->rdi_matched ) ) {
1131 val[ 0 ] = rdi->rdi_matched;
1133 attr_merge_normalize_one( &rdi->rdi_e, ad_errMatchedDN, &val[ 0 ], NULL );
1137 if ( rdi->rdi_sleeptime ) {
1138 snprintf( buf, sizeof( buf ), "%d", rdi->rdi_sleeptime );
1139 ber_str2bv( buf, 0, 0, &val[ 0 ] );
1141 attr_merge_one( &rdi->rdi_e, ad_errSleepTime, &val[ 0 ], NULL );
1145 if ( rdi->rdi_mask & SN_DG_OP_ADD ) {
1146 BER_BVSTR( &val[ 0 ], "add" );
1147 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1150 if ( rdi->rdi_mask & SN_DG_OP_BIND ) {
1151 BER_BVSTR( &val[ 0 ], "bind" );
1152 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1155 if ( rdi->rdi_mask & SN_DG_OP_COMPARE ) {
1156 BER_BVSTR( &val[ 0 ], "compare" );
1157 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1160 if ( rdi->rdi_mask & SN_DG_OP_DELETE ) {
1161 BER_BVSTR( &val[ 0 ], "delete" );
1162 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1165 if ( rdi->rdi_mask & SN_DG_EXTENDED ) {
1166 BER_BVSTR( &val[ 0 ], "extended" );
1167 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1170 if ( rdi->rdi_mask & SN_DG_OP_MODIFY ) {
1171 BER_BVSTR( &val[ 0 ], "modify" );
1172 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1175 if ( rdi->rdi_mask & SN_DG_OP_RENAME ) {
1176 BER_BVSTR( &val[ 0 ], "rename" );
1177 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1180 if ( rdi->rdi_mask & SN_DG_OP_SEARCH ) {
1181 BER_BVSTR( &val[ 0 ], "search" );
1182 attr_merge_normalize_one( &rdi->rdi_e, ad_errOp, &val[ 0 ], NULL );
1190 retcode_db_destroy( BackendDB *be )
1192 slap_overinst *on = (slap_overinst *)be->bd_info;
1193 retcode_t *rd = (retcode_t *)on->on_bi.bi_private;
1196 retcode_item_t *rdi, *next;
1198 for ( rdi = rd->rd_item; rdi != NULL; rdi = next ) {
1199 ber_memfree( rdi->rdi_dn.bv_val );
1200 ber_memfree( rdi->rdi_ndn.bv_val );
1202 if ( !BER_BVISNULL( &rdi->rdi_text ) ) {
1203 ber_memfree( rdi->rdi_text.bv_val );
1206 if ( !BER_BVISNULL( &rdi->rdi_matched ) ) {
1207 ber_memfree( rdi->rdi_matched.bv_val );
1210 if ( rdi->rdi_ref ) {
1211 ber_bvarray_free( rdi->rdi_ref );
1214 BER_BVZERO( &rdi->rdi_e.e_name );
1215 BER_BVZERO( &rdi->rdi_e.e_nname );
1217 entry_clean( &rdi->rdi_e );
1219 next = rdi->rdi_next;
1224 if ( !BER_BVISNULL( &rd->rd_pdn ) ) {
1225 ber_memfree( rd->rd_pdn.bv_val );
1228 if ( !BER_BVISNULL( &rd->rd_npdn ) ) {
1229 ber_memfree( rd->rd_npdn.bv_val );
1238 #if SLAPD_OVER_RETCODE == SLAPD_MOD_DYNAMIC
1240 #endif /* SLAPD_OVER_RETCODE == SLAPD_MOD_DYNAMIC */
1242 retcode_initialize( void )
1248 AttributeDescription **ad;
1250 { "( 1.3.6.1.4.1.4203.666.11.4.1.1 "
1251 "NAME ( 'errCode' ) "
1252 "DESC 'LDAP error code' "
1253 "EQUALITY integerMatch "
1254 "ORDERING integerOrderingMatch "
1255 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
1258 { "( 1.3.6.1.4.1.4203.666.11.4.1.2 "
1260 "DESC 'Operations the errObject applies to' "
1261 "EQUALITY caseIgnoreMatch "
1262 "SUBSTR caseIgnoreSubstringsMatch "
1263 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 )",
1265 { "( 1.3.6.1.4.1.4203.666.11.4.1.3 "
1266 "NAME ( 'errText' ) "
1267 "DESC 'LDAP error textual description' "
1268 "EQUALITY caseIgnoreMatch "
1269 "SUBSTR caseIgnoreSubstringsMatch "
1270 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 "
1273 { "( 1.3.6.1.4.1.4203.666.11.4.1.4 "
1274 "NAME ( 'errSleepTime' ) "
1275 "DESC 'Time to wait before returning the error' "
1276 "EQUALITY integerMatch "
1277 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 "
1280 { "( 1.3.6.1.4.1.4203.666.11.4.1.5 "
1281 "NAME ( 'errMatchedDN' ) "
1282 "DESC 'Value to be returned as matched DN' "
1283 "EQUALITY distinguishedNameMatch "
1284 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.12 "
1287 { "( 1.3.6.1.4.1.4203.666.11.4.1.6 "
1288 "NAME ( 'errUnsolicitedOID' ) "
1289 "DESC 'OID to be returned within unsolicited response' "
1290 "EQUALITY objectIdentifierMatch "
1291 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.38 "
1293 &ad_errUnsolicitedOID },
1294 { "( 1.3.6.1.4.1.4203.666.11.4.1.7 "
1295 "NAME ( 'errUnsolicitedData' ) "
1296 "DESC 'Data to be returned within unsolicited response' "
1297 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.40 "
1299 &ad_errUnsolicitedData },
1300 { "( 1.3.6.1.4.1.4203.666.11.4.1.8 "
1301 "NAME ( 'errDisconnect' ) "
1302 "DESC 'Disconnect without notice' "
1303 "SYNTAX 1.3.6.1.4.1.1466.115.121.1.7 "
1305 &ad_errDisconnect },
1313 { "( 1.3.6.1.4.1.4203.666.11.4.3.0 "
1314 "NAME ( 'errAbsObject' ) "
1324 "$ errUnsolicitedOID "
1325 "$ errUnsolicitedData "
1329 { "( 1.3.6.1.4.1.4203.666.11.4.3.1 "
1330 "NAME ( 'errObject' ) "
1331 "SUP errAbsObject STRUCTURAL "
1334 { "( 1.3.6.1.4.1.4203.666.11.4.3.2 "
1335 "NAME ( 'errAuxObject' ) "
1336 "SUP errAbsObject AUXILIARY "
1343 for ( i = 0; retcode_at[ i ].desc != NULL; i++ ) {
1344 code = register_at( retcode_at[ i ].desc, retcode_at[ i ].ad, 0 );
1346 Debug( LDAP_DEBUG_ANY,
1347 "retcode: register_at failed\n", 0, 0, 0 );
1352 for ( i = 0; retcode_oc[ i ].desc != NULL; i++ ) {
1353 code = register_oc( retcode_oc[ i ].desc, retcode_oc[ i ].oc, 0 );
1355 Debug( LDAP_DEBUG_ANY,
1356 "retcode: register_oc failed\n", 0, 0, 0 );
1361 retcode.on_bi.bi_type = "retcode";
1363 retcode.on_bi.bi_db_init = retcode_db_init;
1364 retcode.on_bi.bi_db_config = retcode_db_config;
1365 retcode.on_bi.bi_db_open = retcode_db_open;
1366 retcode.on_bi.bi_db_destroy = retcode_db_destroy;
1368 retcode.on_bi.bi_op_add = retcode_op_func;
1369 retcode.on_bi.bi_op_bind = retcode_op_func;
1370 retcode.on_bi.bi_op_compare = retcode_op_func;
1371 retcode.on_bi.bi_op_delete = retcode_op_func;
1372 retcode.on_bi.bi_op_modify = retcode_op_func;
1373 retcode.on_bi.bi_op_modrdn = retcode_op_func;
1374 retcode.on_bi.bi_op_search = retcode_op_func;
1376 retcode.on_bi.bi_extended = retcode_op_func;
1378 retcode.on_response = retcode_response;
1380 return overlay_register( &retcode );
1383 #if SLAPD_OVER_RETCODE == SLAPD_MOD_DYNAMIC
1385 init_module( int argc, char *argv[] )
1387 return retcode_initialize();
1389 #endif /* SLAPD_OVER_RETCODE == SLAPD_MOD_DYNAMIC */
1391 #endif /* SLAPD_OVER_RETCODE */