git.sur5r.net Git - openldap/blob - servers/slapd/back-meta/conn.c

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1999-2005 The OpenLDAP Foundation.
   5  * Portions Copyright 2001-2003 Pierangelo Masarati.
   6  * Portions Copyright 1999-2003 Howard Chu.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted only as authorized by the OpenLDAP
  11  * Public License.
  12  *
  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>.
  16  */
  17 /* ACKNOWLEDGEMENTS:
  18  * This work was initially developed by the Howard Chu for inclusion
  19  * in OpenLDAP Software and subsequently enhanced by Pierangelo
  20  * Masarati.
  21  */
  22
  23 #include "portable.h"
  24
  25 #include <stdio.h>
  26
  27 #include <ac/errno.h>
  28 #include <ac/socket.h>
  29 #include <ac/string.h>
  30
  31
  32 #define AVL_INTERNAL
  33 #include "slap.h"
  34 #include "../back-ldap/back-ldap.h"
  35 #include "back-meta.h"
  36
  37 /*
  38  * Set PRINT_CONNTREE larger than 0 to dump the connection tree (debug only)
  39  */
  40 #define PRINT_CONNTREE 0
  41
  42 /*
  43  * meta_back_conn_cmp
  44  *
  45  * compares two struct metaconn based on the value of the conn pointer;
  46  * used by avl stuff
  47  */
  48 int
  49 meta_back_conn_cmp(
  50         const void *c1,
  51         const void *c2 )
  52 {
  53         metaconn_t      *mc1 = ( metaconn_t * )c1;
  54         metaconn_t      *mc2 = ( metaconn_t * )c2;
  55         int             rc;
  56
  57         /* If local DNs don't match, it is definitely not a match */
  58         rc = ber_bvcmp( &mc1->mc_local_ndn, &mc2->mc_local_ndn );
  59         if ( rc ) {
  60                 return rc;
  61         }
  62
  63         /* For shared sessions, conn is NULL. Only explicitly
  64          * bound sessions will have non-NULL conn.
  65          */
  66         return SLAP_PTRCMP( mc1->mc_conn, mc2->mc_conn );
  67 }
  68
  69 /*
  70  * meta_back_conn_dup
  71  *
  72  * returns -1 in case a duplicate struct metaconn has been inserted;
  73  * used by avl stuff
  74  */
  75 int
  76 meta_back_conn_dup(
  77         void *c1,
  78         void *c2 )
  79 {
  80         metaconn_t      *mc1 = ( metaconn_t * )c1;
  81         metaconn_t      *mc2 = ( metaconn_t * )c2;
  82
  83         /* Cannot have more than one shared session with same DN */
  84         if ( dn_match( &mc1->mc_local_ndn, &mc2->mc_local_ndn ) &&
  85                         mc1->mc_conn == mc2->mc_conn )
  86         {
  87                 return -1;
  88         }
  89
  90         return 0;
  91 }
  92
  93 /*
  94  * Debug stuff (got it from libavl)
  95  */
  96 #if PRINT_CONNTREE > 0
  97 static void
  98 ravl_print( Avlnode *root, int depth )
  99 {
 100         int             i;
 101         metaconn_t      *mc = (metaconn_t *)root->avl_data;
 102
 103         if ( root == 0 ) {
 104                 return;
 105         }
 106
 107         ravl_print( root->avl_right, depth + 1 );
 108
 109         for ( i = 0; i < depth; i++ ) {
 110                 printf( "    " );
 111         }
 112
 113         printf( "c(%d%s%s) %d\n",
 114                 LDAP_BACK_PCONN_ID( mc->mc_conn ),
 115                 BER_BVISNULL( &mc->mc_local_ndn ) ? "" : ": ",
 116                 BER_BVISNULL( &mc->mc_local_ndn ) ? "" : mc->mc_local_ndn.bv_val,
 117                 root->avl_bf );
 118
 119         ravl_print( root->avl_left, depth + 1 );
 120 }
 121
 122 static void
 123 myprint( Avlnode *root )
 124 {
 125         printf( "********\n" );
 126
 127         if ( root == 0 ) {
 128                 printf( "\tNULL\n" );
 129         } else {
 130                 ravl_print( root, 0 );
 131         }
 132
 133         printf( "********\n" );
 134 }
 135 #endif /* PRINT_CONNTREE */
 136 /*
 137  * End of debug stuff
 138  */
 139
 140 /*
 141  * metaconn_alloc
 142  *
 143  * Allocates a connection structure, making room for all the referenced targets
 144  */
 145 static metaconn_t *
 146 metaconn_alloc(
 147         Operation               *op )
 148 {
 149         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
 150         metaconn_t      *mc;
 151         int             i, ntargets = mi->mi_ntargets;
 152
 153         assert( ntargets > 0 );
 154
 155         /* malloc all in one */
 156         mc = ( metaconn_t * )ch_malloc( sizeof( metaconn_t )
 157                         + sizeof( metasingleconn_t ) * ntargets );
 158         if ( mc == NULL ) {
 159                 return NULL;
 160         }
 161
 162         for ( i = 0; i < ntargets; i++ ) {
 163                 mc->mc_conns[ i ].msc_ld = NULL;
 164                 BER_BVZERO( &mc->mc_conns[ i ].msc_bound_ndn );
 165                 BER_BVZERO( &mc->mc_conns[ i ].msc_cred );
 166                 LDAP_BACK_CONN_ISBOUND_CLEAR( &mc->mc_conns[ i ] );
 167                 mc->mc_conns[ i ].msc_info = mi;
 168         }
 169
 170         BER_BVZERO( &mc->mc_local_ndn );
 171         mc->msc_mscflags = 0;
 172         mc->mc_authz_target = META_BOUND_NONE;
 173         ldap_pvt_thread_mutex_init( &mc->mc_mutex );
 174         mc->mc_refcnt = 1;
 175         mc->mc_tainted = 0;
 176
 177         return mc;
 178 }
 179
 180 static void
 181 meta_back_freeconn(
 182         Operation       *op,
 183         metaconn_t      *mc )
 184 {
 185         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
 186
 187         assert( mc != NULL );
 188
 189         ldap_pvt_thread_mutex_lock( &mi->mi_conn_mutex );
 190
 191         if ( --mc->mc_refcnt == 0 ) {
 192                 meta_back_conn_free( mc );
 193         }
 194
 195         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
 196 }
 197
 198 /*
 199  * meta_back_init_one_conn
 200  *
 201  * Initializes one connection
 202  */
 203 int
 204 meta_back_init_one_conn(
 205         Operation               *op,
 206         SlapReply               *rs,
 207         metatarget_t            *mt,
 208         metaconn_t              *mc,
 209         metasingleconn_t        *msc,
 210         int                     ispriv,
 211         int                     isauthz,
 212         ldap_back_send_t        sendok )
 213 {
 214         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
 215         int             vers;
 216         dncookie        dc;
 217
 218         /*
 219          * Already init'ed
 220          */
 221         if ( msc->msc_ld != NULL ) {
 222                 return rs->sr_err = LDAP_SUCCESS;
 223         }
 224
 225         /*
 226          * Attempts to initialize the connection to the target ds
 227          */
 228         rs->sr_err = ldap_initialize( &msc->msc_ld, mt->mt_uri );
 229         if ( rs->sr_err != LDAP_SUCCESS ) {
 230                 goto error_return;
 231         }
 232
 233         /*
 234          * Set LDAP version. This will always succeed: If the client
 235          * bound with a particular version, then so can we.
 236          */
 237         vers = op->o_conn->c_protocol;
 238         ldap_set_option( msc->msc_ld, LDAP_OPT_PROTOCOL_VERSION, &vers );
 239
 240         /* automatically chase referrals ("chase-referrals"/"dont-chase-referrals" statement) */
 241         if ( LDAP_BACK_CHASE_REFERRALS( mi ) ) {
 242                 ldap_set_option( msc->msc_ld, LDAP_OPT_REFERRALS, LDAP_OPT_ON );
 243         }
 244
 245 #ifdef HAVE_TLS
 246         /* start TLS ("tls [try-]{start|propagate}" statement) */
 247         if ( ( LDAP_BACK_USE_TLS( mi ) || ( op->o_conn->c_is_tls && LDAP_BACK_PROPAGATE_TLS( mi ) ) )
 248                         && !ldap_is_ldaps_url( mt->mt_uri ) )
 249         {
 250 #ifdef SLAP_STARTTLS_ASYNCHRONOUS
 251                 /*
 252                  * use asynchronous StartTLS; in case, chase referral
 253                  * FIXME: OpenLDAP does not return referral on StartTLS yet
 254                  */
 255                 int             msgid;
 256
 257                 rs->sr_err = ldap_start_tls( msc->msc_ld, NULL, NULL, &msgid );
 258                 if ( rs->sr_err == LDAP_SUCCESS ) {
 259                         LDAPMessage     *res = NULL;
 260                         int             rc, nretries = mt->mt_nretries;
 261                         struct timeval  tv;
 262
 263                         LDAP_BACK_TV_SET( &tv );
 264
 265 retry:;
 266                         rc = ldap_result( msc->msc_ld, msgid, LDAP_MSG_ALL, &tv, &res );
 267                         if ( rc < 0 ) {
 268                                 rs->sr_err = LDAP_OTHER;
 269
 270                         } else if ( rc == 0 ) {
 271                                 if ( nretries != 0 ) {
 272                                         if ( nretries > 0 ) {
 273                                                 nretries--;
 274                                         }
 275                                         LDAP_BACK_TV_SET( &tv );
 276                                         goto retry;
 277                                 }
 278                                 rs->sr_err = LDAP_OTHER;
 279
 280                         } else if ( rc == LDAP_RES_EXTENDED ) {
 281                                 struct berval   *data = NULL;
 282
 283                                 rs->sr_err = ldap_parse_extended_result( msc->msc_ld, res,
 284                                                 NULL, &data, 0 );
 285                                 if ( rs->sr_err == LDAP_SUCCESS ) {
 286                                         rs->sr_err = ldap_result2error( msc->msc_ld, res, 1 );
 287                                         res = NULL;
 288
 289                                         /* FIXME: in case a referral
 290                                          * is returned, should we try
 291                                          * using it instead of the
 292                                          * configured URI? */
 293                                         if ( rs->sr_err == LDAP_SUCCESS ) {
 294                                                 ldap_install_tls( msc->msc_ld );
 295
 296                                         } else if ( rs->sr_err == LDAP_REFERRAL ) {
 297                                                 rs->sr_err = LDAP_OTHER;
 298                                                 rs->sr_text = "unwilling to chase referral returned by Start TLS exop";
 299                                         }
 300
 301                                         if ( data ) {
 302                                                 if ( data->bv_val ) {
 303                                                         ber_memfree( data->bv_val );
 304                                                 }
 305                                                 ber_memfree( data );
 306                                         }
 307                                 }
 308
 309                         } else {
 310                                 rs->sr_err = LDAP_OTHER;
 311                         }
 312
 313                         if ( res != NULL ) {
 314                                 ldap_msgfree( res );
 315                         }
 316                 }
 317 #else /* ! SLAP_STARTTLS_ASYNCHRONOUS */
 318                 /*
 319                  * use synchronous StartTLS
 320                  */
 321                 rs->sr_err = ldap_start_tls_s( msc->msc_ld, NULL, NULL );
 322 #endif /* ! SLAP_STARTTLS_ASYNCHRONOUS */
 323
 324                 /* if StartTLS is requested, only attempt it if the URL
 325                  * is not "ldaps://"; this may occur not only in case
 326                  * of misconfiguration, but also when used in the chain
 327                  * overlay, where the "uri" can be parsed out of a referral */
 328                 if ( rs->sr_err == LDAP_SERVER_DOWN
 329                                 || ( rs->sr_err != LDAP_SUCCESS && LDAP_BACK_TLS_CRITICAL( mi ) ) )
 330                 {
 331                         ldap_unbind_ext_s( msc->msc_ld, NULL, NULL );
 332                         goto error_return;
 333                 }
 334         }
 335 #endif /* HAVE_TLS */
 336
 337         /*
 338          * Set the network timeout if set
 339          */
 340         if ( mi->mi_network_timeout != 0 ) {
 341                 struct timeval  network_timeout;
 342
 343                 network_timeout.tv_usec = 0;
 344                 network_timeout.tv_sec = mi->mi_network_timeout;
 345
 346                 ldap_set_option( msc->msc_ld, LDAP_OPT_NETWORK_TIMEOUT,
 347                                 (void *)&network_timeout );
 348         }
 349
 350         /*
 351          * If the connection DN is not null, an attempt to rewrite it is made
 352          */
 353
 354         if ( ispriv ) {
 355                 if ( !BER_BVISNULL( &mt->mt_pseudorootdn ) ) {
 356                         ber_dupbv( &msc->msc_bound_ndn, &mt->mt_pseudorootdn );
 357                         if ( !BER_BVISNULL( &mt->mt_pseudorootpw ) ) {
 358                                 ber_dupbv( &msc->msc_cred, &mt->mt_pseudorootpw );
 359                         }
 360
 361                 } else {
 362                         ber_str2bv( "", 0, 1, &msc->msc_bound_ndn );
 363                 }
 364
 365                 LDAP_BACK_CONN_ISPRIV_SET( msc );
 366
 367         } else {
 368                 BER_BVZERO( &msc->msc_cred );
 369                 BER_BVZERO( &msc->msc_bound_ndn );
 370                 if ( !BER_BVISEMPTY( &op->o_ndn )
 371                         && SLAP_IS_AUTHZ_BACKEND( op )
 372                         && isauthz )
 373                 {
 374                         dc.target = mt;
 375                         dc.conn = op->o_conn;
 376                         dc.rs = rs;
 377                         dc.ctx = "bindDN";
 378
 379                         /*
 380                          * Rewrite the bind dn if needed
 381                          */
 382                         if ( ldap_back_dn_massage( &dc, &op->o_conn->c_dn,
 383                                                 &msc->msc_bound_ndn ) )
 384                         {
 385                                 ldap_unbind_ext_s( msc->msc_ld, NULL, NULL );
 386                                 goto error_return;
 387                         }
 388
 389                         /* copy the DN idf needed */
 390                         if ( msc->msc_bound_ndn.bv_val == op->o_conn->c_dn.bv_val ) {
 391                                 ber_dupbv( &msc->msc_bound_ndn, &op->o_conn->c_dn );
 392                         }
 393
 394                 } else {
 395                         ber_str2bv( "", 0, 1, &msc->msc_bound_ndn );
 396                 }
 397         }
 398
 399         assert( !BER_BVISNULL( &msc->msc_bound_ndn ) );
 400
 401         LDAP_BACK_CONN_ISBOUND_CLEAR( msc );
 402
 403 error_return:;
 404         if ( rs->sr_err == LDAP_SUCCESS ) {
 405                 /*
 406                  * Sets a cookie for the rewrite session
 407                  */
 408                 ( void )rewrite_session_init( mt->mt_rwmap.rwm_rw, op->o_conn );
 409
 410         } else {
 411                 rs->sr_err = slap_map_api2result( rs );
 412                 if ( sendok & LDAP_BACK_SENDERR ) {
 413                         send_ldap_result( op, rs );
 414                         rs->sr_text = NULL;
 415                 }
 416         }
 417
 418         return rs->sr_err;
 419 }
 420
 421 /*
 422  * meta_back_retry
 423  *
 424  * Retries one connection
 425  */
 426 int
 427 meta_back_retry(
 428         Operation               *op,
 429         SlapReply               *rs,
 430         metaconn_t              *mc,
 431         int                     candidate,
 432         ldap_back_send_t        sendok )
 433 {
 434         metainfo_t              *mi = ( metainfo_t * )op->o_bd->be_private;
 435         metatarget_t            *mt = &mi->mi_targets[ candidate ];
 436         int                     rc = LDAP_UNAVAILABLE;
 437         metasingleconn_t        *msc = &mc->mc_conns[ candidate ];
 438
 439 retry_lock:;
 440         ldap_pvt_thread_mutex_lock( &mi->mi_conn_mutex );
 441
 442         assert( mc->mc_refcnt > 0 );
 443
 444         if ( mc->mc_refcnt == 1 ) {
 445                 while ( ldap_pvt_thread_mutex_trylock( &mc->mc_mutex ) ) {
 446                         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
 447                         ldap_pvt_thread_yield();
 448                         goto retry_lock;
 449                 }
 450
 451                 Debug( LDAP_DEBUG_ANY, "%s meta_back_retry: retrying uri=\"%s\" DN=\"%s\"\n",
 452                         op->o_log_prefix, mt->mt_uri,
 453                         BER_BVISNULL( &msc->msc_bound_ndn ) ? "" : msc->msc_bound_ndn.bv_val );
 454
 455                 meta_clear_one_candidate( msc );
 456                 LDAP_BACK_CONN_ISBOUND_CLEAR( msc );
 457
 458                 ( void )rewrite_session_delete( mt->mt_rwmap.rwm_rw, op->o_conn );
 459
 460                 /* mc here must be the regular mc, reset and ready for init */
 461                 rc = meta_back_init_one_conn( op, rs, mt, mc, msc,
 462                         LDAP_BACK_CONN_ISPRIV( mc ),
 463                         candidate == mc->mc_authz_target, sendok );
 464
 465                 if ( rc == LDAP_SUCCESS ) {
 466                         rc = meta_back_single_dobind( op, rs, mc, candidate,
 467                                         sendok, mt->mt_nretries, 0 );
 468                 }
 469
 470                 ldap_pvt_thread_mutex_unlock( &mc->mc_mutex );
 471         }
 472
 473         if ( rc != LDAP_SUCCESS ) {
 474                 mc->mc_tainted = 1;
 475         }
 476
 477         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
 478
 479         return rc == LDAP_SUCCESS ? 1 : 0;
 480 }
 481
 482 /*
 483  * callback for unique candidate selection
 484  */
 485 static int
 486 meta_back_conn_cb( Operation *op, SlapReply *rs )
 487 {
 488         assert( op->o_tag == LDAP_REQ_SEARCH );
 489
 490         switch ( rs->sr_type ) {
 491         case REP_SEARCH:
 492                 ((long *)op->o_callback->sc_private)[0] = (long)op->o_private;
 493                 break;
 494
 495         case REP_SEARCHREF:
 496         case REP_RESULT:
 497                 break;
 498
 499         default:
 500                 return rs->sr_err;
 501         }
 502
 503         return 0;
 504 }
 505
 506
 507 static int
 508 meta_back_get_candidate(
 509         Operation       *op,
 510         SlapReply       *rs,
 511         struct berval   *ndn )
 512 {
 513         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
 514         long            candidate;
 515
 516         /*
 517          * tries to get a unique candidate
 518          * (takes care of default target)
 519          */
 520         candidate = meta_back_select_unique_candidate( mi, ndn );
 521
 522         /*
 523          * if any is found, inits the connection
 524          */
 525         if ( candidate == META_TARGET_NONE ) {
 526                 rs->sr_err = LDAP_NO_SUCH_OBJECT;
 527                 rs->sr_text = "no suitable candidate target found";
 528
 529         } else if ( candidate == META_TARGET_MULTIPLE ) {
 530                 Filter          f = { 0 };
 531                 Operation       op2 = *op;
 532                 SlapReply       rs2 = { 0 };
 533                 slap_callback   cb2 = { 0 };
 534                 int             rc;
 535
 536                 /* try to get a unique match for the request ndn
 537                  * among the multiple candidates available */
 538                 op2.o_tag = LDAP_REQ_SEARCH;
 539                 op2.o_req_dn = *ndn;
 540                 op2.o_req_ndn = *ndn;
 541                 op2.ors_scope = LDAP_SCOPE_BASE;
 542                 op2.ors_deref = LDAP_DEREF_NEVER;
 543                 op2.ors_attrs = slap_anlist_no_attrs;
 544                 op2.ors_attrsonly = 0;
 545                 op2.ors_limit = NULL;
 546                 op2.ors_slimit = 1;
 547                 op2.ors_tlimit = SLAP_NO_LIMIT;
 548
 549                 f.f_choice = LDAP_FILTER_PRESENT;
 550                 f.f_desc = slap_schema.si_ad_objectClass;
 551                 op2.ors_filter = &f;
 552                 BER_BVSTR( &op2.ors_filterstr, "(objectClass=*)" );
 553
 554                 op2.o_callback = &cb2;
 555                 cb2.sc_response = meta_back_conn_cb;
 556                 cb2.sc_private = (void *)&candidate;
 557
 558                 rc = op->o_bd->be_search( &op2, &rs2 );
 559
 560                 switch ( rs2.sr_err ) {
 561                 case LDAP_SUCCESS:
 562                 default:
 563                         rs->sr_err = rs2.sr_err;
 564                         break;
 565
 566                 case LDAP_SIZELIMIT_EXCEEDED:
 567                         /* if multiple candidates can serve the operation,
 568                          * and a default target is defined, and it is
 569                          * a candidate, try using it (FIXME: YMMV) */
 570                         if ( mi->mi_defaulttarget != META_DEFAULT_TARGET_NONE
 571                                 && meta_back_is_candidate( &mi->mi_targets[ mi->mi_defaulttarget ].mt_nsuffix,
 572                                                 mi->mi_targets[ mi->mi_defaulttarget ].mt_scope,
 573                                                 ndn, op->o_tag == LDAP_REQ_SEARCH ? op->ors_scope : LDAP_SCOPE_BASE ) )
 574                         {
 575                                 candidate = mi->mi_defaulttarget;
 576                                 rs->sr_err = LDAP_SUCCESS;
 577                                 rs->sr_text = NULL;
 578
 579                         } else {
 580                                 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
 581                                 rs->sr_text = "cannot select unique candidate target";
 582                         }
 583                         break;
 584                 }
 585
 586         } else {
 587                 rs->sr_err = LDAP_SUCCESS;
 588         }
 589
 590         return candidate;
 591 }
 592
 593 static void     *meta_back_candidates_dummy;
 594
 595 static void
 596 meta_back_candidates_keyfree(
 597         void            *key,
 598         void            *data )
 599 {
 600         metacandidates_t        *mc = (metacandidates_t *)data;
 601
 602         ber_memfree_x( mc->mc_candidates, NULL );
 603         ber_memfree_x( data, NULL );
 604 }
 605
 606 SlapReply *
 607 meta_back_candidates_get( Operation *op )
 608 {
 609         metainfo_t              *mi = ( metainfo_t * )op->o_bd->be_private;
 610         metacandidates_t        *mc;
 611
 612         if ( op->o_threadctx ) {
 613                 void            *data = NULL;
 614
 615                 ldap_pvt_thread_pool_getkey( op->o_threadctx,
 616                                 &meta_back_candidates_dummy, &data, NULL );
 617                 mc = (metacandidates_t *)data;
 618
 619         } else {
 620                 mc = mi->mi_candidates;
 621         }
 622
 623         if ( mc == NULL ) {
 624                 mc = ch_calloc( sizeof( metacandidates_t ), 1 );
 625                 mc->mc_ntargets = mi->mi_ntargets;
 626                 mc->mc_candidates = ch_calloc( sizeof( SlapReply ), mc->mc_ntargets );
 627                 if ( op->o_threadctx ) {
 628                         void            *data = NULL;
 629
 630                         data = (void *)mc;
 631                         ldap_pvt_thread_pool_setkey( op->o_threadctx,
 632                                         &meta_back_candidates_dummy, data,
 633                                         meta_back_candidates_keyfree );
 634
 635                 } else {
 636                         mi->mi_candidates = mc;
 637                 }
 638
 639         } else if ( mc->mc_ntargets < mi->mi_ntargets ) {
 640                 /* NOTE: in the future, may want to allow back-config
 641                  * to add/remove targets from back-meta... */
 642                 mc->mc_ntargets = mi->mi_ntargets;
 643                 mc->mc_candidates = ch_realloc( mc->mc_candidates,
 644                                 sizeof( SlapReply ) * mc->mc_ntargets );
 645         }
 646
 647         return mc->mc_candidates;
 648 }
 649
 650 /*
 651  * meta_back_getconn
 652  *
 653  * Prepares the connection structure
 654  *
 655  * RATIONALE:
 656  *
 657  * - determine what DN is being requested:
 658  *
 659  *      op      requires candidate      checks
 660  *
 661  *      add     unique                  parent of o_req_ndn
 662  *      bind    unique^*[/all]          o_req_ndn [no check]
 663  *      compare unique^+                o_req_ndn
 664  *      delete  unique                  o_req_ndn
 665  *      modify  unique                  o_req_ndn
 666  *      search  any                     o_req_ndn
 667  *      modrdn  unique[, unique]        o_req_ndn[, orr_nnewSup]
 668  *
 669  * - for ops that require the candidate to be unique, in case of multiple
 670  *   occurrences an internal search with sizeLimit=1 is performed
 671  *   if a unique candidate can actually be determined.  If none is found,
 672  *   the operation aborts; if multiple are found, the default target
 673  *   is used if defined and candidate; otherwise the operation aborts.
 674  *
 675  * *^note: actually, the bind operation is handled much like a search;
 676  *   i.e. the bind is broadcast to all candidate targets.
 677  *
 678  * +^note: actually, the compare operation is handled much like a search;
 679  *   i.e. the compare is broadcast to all candidate targets, while checking
 680  *   that exactly none (noSuchObject) or one (TRUE/FALSE/UNDEFINED) is
 681  *   returned.
 682  */
 683 metaconn_t *
 684 meta_back_getconn(
 685         Operation               *op,
 686         SlapReply               *rs,
 687         int                     *candidate,
 688         ldap_back_send_t        sendok )
 689 {
 690         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
 691         metaconn_t      *mc = NULL,
 692                         mc_curr = { 0 };
 693         int             cached = META_TARGET_NONE,
 694                         i = META_TARGET_NONE,
 695                         err = LDAP_SUCCESS,
 696                         new_conn = 0,
 697                         ncandidates = 0;
 698
 699
 700         meta_op_type    op_type = META_OP_REQUIRE_SINGLE;
 701         int             parent = 0,
 702                         newparent = 0;
 703         struct berval   ndn = op->o_req_ndn,
 704                         pndn;
 705
 706         SlapReply       *candidates = meta_back_candidates_get( op );
 707
 708         /* Internal searches are privileged and shared. So is root. */
 709         /* FIXME: there seem to be concurrency issues */
 710         if ( op->o_do_not_cache || be_isroot( op ) ) {
 711                 mc_curr.mc_local_ndn = op->o_bd->be_rootndn;
 712                 LDAP_BACK_CONN_ISPRIV_SET( &mc_curr );
 713                 mc_curr.mc_conn = LDAP_BACK_PCONN_SET( op );
 714
 715         } else {
 716                 mc_curr.mc_local_ndn = op->o_ndn;
 717
 718                 /* Explicit binds must not be shared */
 719                 if ( op->o_tag == LDAP_REQ_BIND || SLAP_IS_AUTHZ_BACKEND( op ) ) {
 720                         mc_curr.mc_conn = op->o_conn;
 721
 722                 } else {
 723                         mc_curr.mc_conn = LDAP_BACK_PCONN_SET( op );
 724                 }
 725         }
 726
 727         /* Searches for a metaconn in the avl tree */
 728         ldap_pvt_thread_mutex_lock( &mi->mi_conn_mutex );
 729         mc = (metaconn_t *)avl_find( mi->mi_conntree,
 730                 (caddr_t)&mc_curr, meta_back_conn_cmp );
 731         if ( mc ) {
 732                 if ( mc->mc_tainted ) {
 733                         rs->sr_err = LDAP_UNAVAILABLE;
 734                         rs->sr_text = "remote server unavailable";
 735                         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
 736                         return NULL;
 737                 }
 738
 739                 mc->mc_refcnt++;
 740         }
 741         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
 742
 743         switch ( op->o_tag ) {
 744         case LDAP_REQ_ADD:
 745                 /* if we go to selection, the entry must not exist,
 746                  * and we must be able to resolve the parent */
 747                 parent = 1;
 748                 dnParent( &ndn, &pndn );
 749                 break;
 750
 751         case LDAP_REQ_MODRDN:
 752                 /* if nnewSuperior is not NULL, it must resolve
 753                  * to the same candidate as the req_ndn */
 754                 if ( op->orr_nnewSup ) {
 755                         newparent = 1;
 756                 }
 757                 break;
 758
 759         case LDAP_REQ_BIND:
 760                 /* if bound as rootdn, the backend must bind to all targets
 761                  * with the administrative identity */
 762                 if ( op->orb_method == LDAP_AUTH_SIMPLE && be_isroot_pw( op ) ) {
 763                         op_type = META_OP_REQUIRE_ALL;
 764                 }
 765                 break;
 766
 767         case LDAP_REQ_DELETE:
 768         case LDAP_REQ_MODIFY:
 769                 /* just a unique candidate */
 770                 break;
 771
 772         case LDAP_REQ_COMPARE:
 773         case LDAP_REQ_SEARCH:
 774                 /* allow multiple candidates for the searchBase */
 775                 op_type = META_OP_ALLOW_MULTIPLE;
 776                 break;
 777
 778         default:
 779                 /* right now, just break (exop?) */
 780                 break;
 781         }
 782
 783         /*
 784          * require all connections ...
 785          */
 786         if ( op_type == META_OP_REQUIRE_ALL ) {
 787
 788                 /* Looks like we didn't get a bind. Open a new session... */
 789                 if ( mc == NULL ) {
 790                         mc = metaconn_alloc( op );
 791                         mc->mc_conn = mc_curr.mc_conn;
 792                         ber_dupbv( &mc->mc_local_ndn, &mc_curr.mc_local_ndn );
 793                         new_conn = 1;
 794                 }
 795
 796                 for ( i = 0; i < mi->mi_ntargets; i++ ) {
 797                         metatarget_t            *mt = &mi->mi_targets[ i ];
 798                         metasingleconn_t        *msc = &mc->mc_conns[ i ];
 799
 800                         /*
 801                          * The target is activated; if needed, it is
 802                          * also init'd
 803                          */
 804                         candidates[ i ].sr_err = meta_back_init_one_conn( op,
 805                                 rs, mt, mc, msc,
 806                                 LDAP_BACK_CONN_ISPRIV( &mc_curr ),
 807                                 i == mc->mc_authz_target, sendok );
 808                         if ( candidates[ i ].sr_err == LDAP_SUCCESS ) {
 809                                 candidates[ i ].sr_tag = META_CANDIDATE;
 810                                 ncandidates++;
 811
 812                         } else {
 813
 814                                 /*
 815                                  * FIXME: in case one target cannot
 816                                  * be init'd, should the other ones
 817                                  * be tried?
 818                                  */
 819                                 candidates[ i ].sr_tag = META_NOT_CANDIDATE;
 820                                 err = candidates[ i ].sr_err;
 821                                 continue;
 822                         }
 823                 }
 824
 825                 if ( ncandidates == 0 ) {
 826                         if ( new_conn ) {
 827                                 meta_back_freeconn( op, mc );
 828
 829                         } else {
 830                                 meta_back_release_conn( op, mc );
 831                         }
 832
 833                         rs->sr_err = LDAP_NO_SUCH_OBJECT;
 834                         rs->sr_text = "Unable to select valid candidates";
 835
 836                         if ( sendok & LDAP_BACK_SENDERR ) {
 837                                 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
 838                                         rs->sr_matched = op->o_bd->be_suffix[ 0 ].bv_val;
 839                                 }
 840                                 send_ldap_result( op, rs );
 841                                 rs->sr_text = NULL;
 842                                 rs->sr_matched = NULL;
 843                         }
 844
 845                         return NULL;
 846                 }
 847
 848                 goto done;
 849         }
 850
 851         /*
 852          * looks in cache, if any
 853          */
 854         if ( mi->mi_cache.ttl != META_DNCACHE_DISABLED ) {
 855                 cached = i = meta_dncache_get_target( &mi->mi_cache, &op->o_req_ndn );
 856         }
 857
 858         if ( op_type == META_OP_REQUIRE_SINGLE ) {
 859                 metatarget_t            *mt = NULL;
 860                 metasingleconn_t        *msc = NULL;
 861
 862                 int                     j;
 863
 864                 for ( j = 0; j < mi->mi_ntargets; j++ ) {
 865                         candidates[ j ].sr_tag = META_NOT_CANDIDATE;
 866                 }
 867
 868                 /*
 869                  * tries to get a unique candidate
 870                  * (takes care of default target)
 871                  */
 872                 if ( i == META_TARGET_NONE ) {
 873                         i = meta_back_get_candidate( op, rs, &ndn );
 874
 875                         if ( rs->sr_err == LDAP_NO_SUCH_OBJECT && parent ) {
 876                                 i = meta_back_get_candidate( op, rs, &pndn );
 877                         }
 878
 879                         if ( rs->sr_err != LDAP_SUCCESS ) {
 880                                 if ( mc != NULL ) {
 881                                         meta_back_release_conn( op, mc );
 882                                 }
 883
 884                                 if ( sendok & LDAP_BACK_SENDERR ) {
 885                                         if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
 886                                                 rs->sr_matched = op->o_bd->be_suffix[ 0 ].bv_val;
 887                                         }
 888                                         send_ldap_result( op, rs );
 889                                         rs->sr_text = NULL;
 890                                         rs->sr_matched = NULL;
 891                                 }
 892
 893                                 return NULL;
 894                         }
 895                 }
 896
 897                 if ( newparent && meta_back_get_candidate( op, rs, op->orr_nnewSup ) != i )
 898                 {
 899                         if ( mc != NULL ) {
 900                                 meta_back_release_conn( op, mc );
 901                         }
 902
 903                         rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
 904                         rs->sr_text = "cross-target rename not supported";
 905                         if ( sendok & LDAP_BACK_SENDERR ) {
 906                                 send_ldap_result( op, rs );
 907                                 rs->sr_text = NULL;
 908                         }
 909
 910                         return NULL;
 911                 }
 912
 913                 Debug( LDAP_DEBUG_TRACE,
 914         "==>meta_back_getconn: got target %d for ndn=\"%s\" from cache\n",
 915                                 i, op->o_req_ndn.bv_val, 0 );
 916
 917                 if ( mc == NULL ) {
 918                         /* Retries searching for a metaconn in the avl tree
 919                          * the reason is that the connection might have been
 920                          * created by meta_back_get_candidate() */
 921                         ldap_pvt_thread_mutex_lock( &mi->mi_conn_mutex );
 922                         mc = (metaconn_t *)avl_find( mi->mi_conntree,
 923                                 (caddr_t)&mc_curr, meta_back_conn_cmp );
 924                         if ( mc != NULL ) {
 925                                 mc->mc_refcnt++;
 926                         }
 927                         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
 928
 929                         /* Looks like we didn't get a bind. Open a new session... */
 930                         if ( mc == NULL ) {
 931                                 mc = metaconn_alloc( op );
 932                                 mc->mc_conn = mc_curr.mc_conn;
 933                                 ber_dupbv( &mc->mc_local_ndn, &mc_curr.mc_local_ndn );
 934                                 new_conn = 1;
 935                         }
 936                 }
 937
 938                 /*
 939                  * Clear all other candidates
 940                  */
 941                 ( void )meta_clear_unused_candidates( op, i );
 942
 943                 mt = &mi->mi_targets[ i ];
 944                 msc = &mc->mc_conns[ i ];
 945
 946                 /*
 947                  * The target is activated; if needed, it is
 948                  * also init'd. In case of error, meta_back_init_one_conn
 949                  * sends the appropriate result.
 950                  */
 951                 err = meta_back_init_one_conn( op, rs, mt, mc, msc,
 952                         LDAP_BACK_CONN_ISPRIV( &mc_curr ),
 953                         i == mc->mc_authz_target, sendok );
 954                 if ( err != LDAP_SUCCESS ) {
 955                         /*
 956                          * FIXME: in case one target cannot
 957                          * be init'd, should the other ones
 958                          * be tried?
 959                          */
 960                         candidates[ i ].sr_tag = META_NOT_CANDIDATE;
 961                         if ( new_conn ) {
 962                                 (void)meta_clear_one_candidate( msc );
 963                                 meta_back_freeconn( op, mc );
 964
 965                         } else {
 966                                 meta_back_release_conn( op, mc );
 967                         }
 968                         return NULL;
 969                 }
 970
 971                 candidates[ i ].sr_err = LDAP_SUCCESS;
 972                 candidates[ i ].sr_tag = META_CANDIDATE;
 973                 ncandidates++;
 974
 975                 if ( candidate ) {
 976                         *candidate = i;
 977                 }
 978
 979         /*
 980          * if no unique candidate ...
 981          */
 982         } else {
 983
 984                 /* Looks like we didn't get a bind. Open a new session... */
 985                 if ( mc == NULL ) {
 986                         mc = metaconn_alloc( op );
 987                         mc->mc_conn = mc_curr.mc_conn;
 988                         ber_dupbv( &mc->mc_local_ndn, &mc_curr.mc_local_ndn );
 989                         new_conn = 1;
 990                 }
 991
 992                 for ( i = 0; i < mi->mi_ntargets; i++ ) {
 993                         metatarget_t            *mt = &mi->mi_targets[ i ];
 994                         metasingleconn_t        *msc = &mc->mc_conns[ i ];
 995
 996                         if ( i == cached
 997                                 || meta_back_is_candidate( &mt->mt_nsuffix,
 998                                                 mt->mt_scope,
 999                                                 &op->o_req_ndn,
1000                                                 LDAP_SCOPE_SUBTREE ) )
1001                         {
1002
1003                                 /*
1004                                  * The target is activated; if needed, it is
1005                                  * also init'd
1006                                  */
1007                                 int lerr = meta_back_init_one_conn( op, rs,
1008                                                 mt, mc, msc,
1009                                                 LDAP_BACK_CONN_ISPRIV( &mc_curr ),
1010                                                 i == mc->mc_authz_target,
1011                                                 sendok );
1012                                 if ( lerr == LDAP_SUCCESS ) {
1013                                         candidates[ i ].sr_tag = META_CANDIDATE;
1014                                         candidates[ i ].sr_err = LDAP_SUCCESS;
1015                                         ncandidates++;
1016
1017                                         Debug( LDAP_DEBUG_TRACE, "%s: meta_back_init_one_conn(%d)\n",
1018                                                 op->o_log_prefix, i, 0 );
1019
1020                                 } else {
1021
1022                                         /*
1023                                          * FIXME: in case one target cannot
1024                                          * be init'd, should the other ones
1025                                          * be tried?
1026                                          */
1027                                         if ( new_conn ) {
1028                                                 ( void )meta_clear_one_candidate( msc );
1029                                         }
1030                                         /* leave the target candidate, but record the error for later use */
1031                                         candidates[ i ].sr_err = lerr;
1032                                         err = lerr;
1033
1034                                         Debug( LDAP_DEBUG_ANY, "%s: meta_back_init_one_conn(%d) failed: %d\n",
1035                                                 op->o_log_prefix, i, lerr );
1036
1037                                         continue;
1038                                 }
1039
1040                         } else {
1041                                 if ( new_conn ) {
1042                                         ( void )meta_clear_one_candidate( msc );
1043                                 }
1044                                 candidates[ i ].sr_tag = META_NOT_CANDIDATE;
1045                         }
1046                 }
1047
1048                 if ( ncandidates == 0 ) {
1049                         if ( new_conn ) {
1050                                 meta_back_freeconn( op, mc );
1051
1052                         } else {
1053                                 meta_back_release_conn( op, mc );
1054                         }
1055
1056                         rs->sr_err = LDAP_NO_SUCH_OBJECT;
1057                         rs->sr_text = "Unable to select valid candidates";
1058
1059                         if ( sendok & LDAP_BACK_SENDERR ) {
1060                                 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
1061                                         rs->sr_matched = op->o_bd->be_suffix[ 0 ].bv_val;
1062                                 }
1063                                 send_ldap_result( op, rs );
1064                                 rs->sr_text = NULL;
1065                                 rs->sr_matched = NULL;
1066                         }
1067
1068                         return NULL;
1069                 }
1070         }
1071
1072 done:;
1073         /* clear out meta_back_init_one_conn non-fatal errors */
1074         rs->sr_err = LDAP_SUCCESS;
1075         rs->sr_text = NULL;
1076
1077         if ( new_conn ) {
1078
1079                 /*
1080                  * Inserts the newly created metaconn in the avl tree
1081                  */
1082                 ldap_pvt_thread_mutex_lock( &mi->mi_conn_mutex );
1083                 err = avl_insert( &mi->mi_conntree, ( caddr_t )mc,
1084                                 meta_back_conn_cmp, meta_back_conn_dup );
1085
1086 #if PRINT_CONNTREE > 0
1087                 myprint( mi->mi_conntree );
1088 #endif /* PRINT_CONNTREE */
1089
1090                 ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
1091
1092                 /*
1093                  * Err could be -1 in case a duplicate metaconn is inserted
1094                  *
1095                  * FIXME: what if the same client issues more than one
1096                  * asynchronous operations?
1097                  */
1098                 if ( err != 0 ) {
1099                         Debug( LDAP_DEBUG_ANY,
1100                                 "%s meta_back_getconn: candidates=%d conn=%ld insert failed\n",
1101                                 op->o_log_prefix, ncandidates,
1102                                 LDAP_BACK_PCONN_ID( mc->mc_conn ) );
1103
1104                         rs->sr_err = LDAP_OTHER;
1105                         rs->sr_text = "Internal server error";
1106                         meta_back_freeconn( op, mc );
1107                         if ( sendok & LDAP_BACK_SENDERR ) {
1108                                 send_ldap_result( op, rs );
1109                                 rs->sr_text = NULL;
1110                         }
1111                         return NULL;
1112                 }
1113
1114                 Debug( LDAP_DEBUG_TRACE,
1115                         "%s meta_back_getconn: candidates=%d conn=%ld inserted\n",
1116                         op->o_log_prefix, ncandidates,
1117                         LDAP_BACK_PCONN_ID( mc->mc_conn ) );
1118
1119         } else {
1120                 Debug( LDAP_DEBUG_TRACE,
1121                         "%s meta_back_getconn: candidates=%d conn=%ld fetched\n",
1122                         op->o_log_prefix, ncandidates,
1123                         LDAP_BACK_PCONN_ID( mc->mc_conn ) );
1124         }
1125
1126         return mc;
1127 }
1128
1129 void
1130 meta_back_release_conn(
1131         Operation               *op,
1132         metaconn_t              *mc )
1133 {
1134         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
1135
1136         assert( mc != NULL );
1137
1138         ldap_pvt_thread_mutex_lock( &mi->mi_conn_mutex );
1139         assert( mc->mc_refcnt > 0 );
1140         mc->mc_refcnt--;
1141         if ( mc->mc_refcnt == 0 && mc->mc_tainted ) {
1142                 meta_back_conn_free( mc );
1143         }
1144         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
1145 }