git.sur5r.net Git - openldap/blob - libraries/libldap/result.c

   1 /* result.c - wait for an ldap result */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1998-2005 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
  17  * All rights reserved.
  18  */
  19 /* This notice applies to changes, created by or for Novell, Inc.,
  20  * to preexisting works for which notices appear elsewhere in this file.
  21  *
  22  * Copyright (C) 1999, 2000 Novell, Inc. All Rights Reserved.
  23  *
  24  * THIS WORK IS SUBJECT TO U.S. AND INTERNATIONAL COPYRIGHT LAWS AND TREATIES.
  25  * USE, MODIFICATION, AND REDISTRIBUTION OF THIS WORK IS SUBJECT TO VERSION
  26  * 2.0.1 OF THE OPENLDAP PUBLIC LICENSE, A COPY OF WHICH IS AVAILABLE AT
  27  * HTTP://WWW.OPENLDAP.ORG/LICENSE.HTML OR IN THE FILE "LICENSE" IN THE
  28  * TOP-LEVEL DIRECTORY OF THE DISTRIBUTION. ANY USE OR EXPLOITATION OF THIS
  29  * WORK OTHER THAN AS AUTHORIZED IN VERSION 2.0.1 OF THE OPENLDAP PUBLIC
  30  * LICENSE, OR OTHER PRIOR WRITTEN CONSENT FROM NOVELL, COULD SUBJECT THE
  31  * PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY.
  32  *---
  33  * Modification to OpenLDAP source by Novell, Inc.
  34  * April 2000 sfs Add code to process V3 referrals and search results
  35  *---
  36  * Note: A verbatim copy of version 2.0.1 of the OpenLDAP Public License
  37  * can be found in the file "build/LICENSE-2.0.1" in this distribution
  38  * of OpenLDAP Software.
  39  */
  40 /* Portions Copyright (C) The Internet Society (1997)
  41  * ASN.1 fragments are from RFC 2251; see RFC for full legal notices.
  42  */
  43
  44 /*
  45  * LDAPv3 (RFC2251)
  46  *      LDAPResult ::= SEQUENCE {
  47  *              resultCode              ENUMERATED { ... },
  48  *              matchedDN               LDAPDN,
  49  *              errorMessage    LDAPString,
  50  *              referral                Referral OPTIONAL
  51  *      }
  52  *      Referral ::= SEQUENCE OF LDAPURL        (one or more)
  53  *      LDAPURL ::= LDAPString                          (limited to URL chars)
  54  */
  55
  56 #include "portable.h"
  57
  58 #include <stdio.h>
  59
  60 #include <ac/stdlib.h>
  61
  62 #include <ac/errno.h>
  63 #include <ac/socket.h>
  64 #include <ac/string.h>
  65 #include <ac/time.h>
  66 #include <ac/unistd.h>
  67
  68 #include "ldap-int.h"
  69 #include "ldap_log.h"
  70
  71 static int ldap_abandoned LDAP_P(( LDAP *ld, ber_int_t msgid ));
  72 static int ldap_mark_abandoned LDAP_P(( LDAP *ld, ber_int_t msgid ));
  73 static int wait4msg LDAP_P(( LDAP *ld, ber_int_t msgid, int all, struct timeval *timeout,
  74         LDAPMessage **result ));
  75 static ber_tag_t try_read1msg LDAP_P(( LDAP *ld, ber_int_t msgid,
  76         int all, Sockbuf *sb, LDAPConn **lc, LDAPMessage **result ));
  77 static ber_tag_t build_result_ber LDAP_P(( LDAP *ld, BerElement **bp, LDAPRequest *lr ));
  78 static void merge_error_info LDAP_P(( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr ));
  79 static LDAPMessage * chkResponseList LDAP_P(( LDAP *ld, int msgid, int all));
  80
  81
  82 /*
  83  * ldap_result - wait for an ldap result response to a message from the
  84  * ldap server.  If msgid is LDAP_RES_ANY (-1), any message will be
  85  * accepted.  If msgid is LDAP_RES_UNSOLICITED (0), any unsolicited
  86  * message is accepted.  Otherwise ldap_result will wait for a response
  87  * with msgid.  If all is LDAP_MSG_ONE (0) the first message with id
  88  * msgid will be accepted, otherwise, ldap_result will wait for all
  89  * responses with id msgid and then return a pointer to the entire list
  90  * of messages.  In general, this is only useful for search responses,
  91  * which can be of three message types (zero or more entries, zero or
  92  * search references, followed by an ldap result).  An extension to
  93  * LDAPv3 allows partial extended responses to be returned in response
  94  * to any request.  The type of the first message received is returned.
  95  * When waiting, any messages that have been abandoned are discarded.
  96  *
  97  * Example:
  98  *      ldap_result( s, msgid, all, timeout, result )
  99  */
 100 int
 101 ldap_result(
 102         LDAP *ld,
 103         int msgid,
 104         int all,
 105         struct timeval *timeout,
 106         LDAPMessage **result )
 107 {
 108         LDAPMessage     *lm;
 109         int     rc;
 110
 111         assert( ld != NULL );
 112         assert( result != NULL );
 113
 114         Debug( LDAP_DEBUG_TRACE, "ldap_result msgid %d\n", msgid, 0, 0 );
 115
 116 #ifdef LDAP_R_COMPILE
 117         ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
 118 #endif
 119         lm = chkResponseList(ld, msgid, all);
 120
 121         if ( lm == NULL ) {
 122                 rc = wait4msg( ld, msgid, all, timeout, result );
 123         } else {
 124                 *result = lm;
 125                 ld->ld_errno = LDAP_SUCCESS;
 126                 rc = lm->lm_msgtype;
 127         }
 128 #ifdef LDAP_R_COMPILE
 129         ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
 130 #endif
 131         return( rc );
 132 }
 133
 134 static LDAPMessage *
 135 chkResponseList(
 136         LDAP *ld,
 137         int msgid,
 138         int all)
 139 {
 140         LDAPMessage     *lm, *lastlm, *nextlm;
 141     /*
 142          * Look through the list of responses we have received on
 143          * this association and see if the response we're interested in
 144          * is there.  If it is, return it.  If not, call wait4msg() to
 145          * wait until it arrives or timeout occurs.
 146          */
 147
 148         Debug( LDAP_DEBUG_TRACE,
 149                 "ldap_chkResponseList for msgid=%d, all=%d\n",
 150             msgid, all, 0 );
 151         lastlm = NULL;
 152         for ( lm = ld->ld_responses; lm != NULL; lm = nextlm ) {
 153                 nextlm = lm->lm_next;
 154
 155                 if ( ldap_abandoned( ld, lm->lm_msgid ) ) {
 156                         Debug( LDAP_DEBUG_TRACE,
 157                                 "ldap_chkResponseList msg abandoned, msgid %d\n",
 158                             msgid, 0, 0 );
 159                         ldap_mark_abandoned( ld, lm->lm_msgid );
 160
 161                         if ( lastlm == NULL ) {
 162                                 /* Remove first entry in list */
 163                                 ld->ld_responses = lm->lm_next;
 164                         } else {
 165                                 lastlm->lm_next = nextlm;
 166                         }
 167
 168                         ldap_msgfree( lm );
 169
 170                         continue;
 171                 }
 172
 173                 if ( msgid == LDAP_RES_ANY || lm->lm_msgid == msgid ) {
 174                         LDAPMessage     *tmp;
 175
 176                         if ( all == LDAP_MSG_ONE || msgid == LDAP_RES_UNSOLICITED ) {
 177                                 break;
 178                         }
 179
 180                         if ( lm->lm_chain == NULL ) {
 181                                 if ((lm->lm_msgtype == LDAP_RES_SEARCH_ENTRY) ||
 182                                         (lm->lm_msgtype == LDAP_RES_SEARCH_REFERENCE) ||
 183                                         (lm->lm_msgtype == LDAP_RES_INTERMEDIATE)) {
 184                                         tmp = NULL;
 185                                 } else {
 186                                         tmp = lm;
 187                                 }
 188                         } else {
 189                                 if ((lm->lm_chain_tail->lm_chain->lm_msgtype
 190                                                 == LDAP_RES_SEARCH_ENTRY) ||
 191                                         (lm->lm_chain_tail->lm_chain->lm_msgtype
 192                                                 == LDAP_RES_SEARCH_REFERENCE) ||
 193                                         (lm->lm_chain_tail->lm_chain->lm_msgtype
 194                                                 == LDAP_RES_INTERMEDIATE)) {
 195                                         tmp = NULL;
 196                                 } else {
 197                                         tmp = lm->lm_chain_tail->lm_chain;
 198                                 }
 199                         }
 200
 201                         if ( tmp == NULL ) {
 202                                 lm = NULL;
 203                         }
 204
 205                         break;
 206                 }
 207                 lastlm = lm;
 208         }
 209
 210     if ( lm != NULL ) {
 211                 /* Found an entry, remove it from the list */
 212             if ( lastlm == NULL ) {
 213                     ld->ld_responses = (all == LDAP_MSG_ONE && lm->lm_chain != NULL
 214                         ? lm->lm_chain : lm->lm_next);
 215             } else {
 216                     lastlm->lm_next = (all == LDAP_MSG_ONE && lm->lm_chain != NULL
 217                         ? lm->lm_chain : lm->lm_next);
 218             }
 219             if ( all == LDAP_MSG_ONE && lm->lm_chain != NULL ) {
 220                     lm->lm_chain->lm_next = lm->lm_next;
 221                     lm->lm_chain = NULL;
 222             }
 223             lm->lm_next = NULL;
 224     }
 225
 226 #ifdef LDAP_DEBUG
 227         if( lm == NULL) {
 228                 Debug( LDAP_DEBUG_TRACE,
 229                         "ldap_chkResponseList returns NULL\n", 0, 0, 0);
 230         } else {
 231                 Debug( LDAP_DEBUG_TRACE,
 232                         "ldap_chkResponseList returns msgid %d, type 0x%02lu\n",
 233                         lm->lm_msgid, (unsigned long) lm->lm_msgtype, 0);
 234         }
 235 #endif
 236     return lm;
 237 }
 238
 239 static int
 240 wait4msg(
 241         LDAP *ld,
 242         ber_int_t msgid,
 243         int all,
 244         struct timeval *timeout,
 245         LDAPMessage **result )
 246 {
 247         int             rc;
 248         struct timeval  tv, *tvp;
 249         time_t          start_time = 0;
 250         time_t          tmp_time;
 251         LDAPConn        *lc, *nextlc;
 252
 253         assert( ld != NULL );
 254         assert( result != NULL );
 255
 256 #ifdef LDAP_DEBUG
 257         if ( timeout == NULL ) {
 258                 Debug( LDAP_DEBUG_TRACE, "wait4msg (infinite timeout), msgid %d\n",
 259                     msgid, 0, 0 );
 260         } else {
 261                 Debug( LDAP_DEBUG_TRACE, "wait4msg (timeout %ld sec, %ld usec), msgid %d\n",
 262                        (long) timeout->tv_sec, (long) timeout->tv_usec, msgid );
 263         }
 264 #endif /* LDAP_DEBUG */
 265
 266         if ( timeout == NULL ) {
 267                 tvp = NULL;
 268         } else {
 269                 tv = *timeout;
 270                 tvp = &tv;
 271                 start_time = time( NULL );
 272         }
 273
 274         rc = -2;
 275         while ( rc == -2 ) {
 276 #ifdef LDAP_DEBUG
 277                 Debug( LDAP_DEBUG_TRACE, "wait4msg continue, msgid %d, all %d\n",
 278                     msgid, all, 0 );
 279                 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
 280                         ldap_dump_connection( ld, ld->ld_conns, 1 );
 281                         ldap_dump_requests_and_responses( ld );
 282                 }
 283 #endif /* LDAP_DEBUG */
 284
 285         if( (*result = chkResponseList(ld, msgid, all)) != NULL ) {
 286             rc = (*result)->lm_msgtype;
 287         } else {
 288                         int lc_ready = 0;
 289
 290                         for ( lc = ld->ld_conns; lc != NULL; lc = nextlc ) {
 291                                 nextlc = lc->lconn_next;
 292                                 if ( ber_sockbuf_ctrl( lc->lconn_sb,
 293                                                 LBER_SB_OPT_DATA_READY, NULL ) ) {
 294                                         rc = try_read1msg( ld, msgid, all, lc->lconn_sb,
 295                                                 &lc, result );
 296                                         lc_ready = 1;
 297                                     break;
 298                                 }
 299                 }
 300
 301                     if ( !lc_ready ) {
 302                             rc = ldap_int_select( ld, tvp );
 303 #ifdef LDAP_DEBUG
 304                             if ( rc == -1 ) {
 305                                 Debug( LDAP_DEBUG_TRACE,
 306                                         "ldap_int_select returned -1: errno %d\n",
 307                                         errno, 0, 0 );
 308                             }
 309 #endif
 310
 311                             if ( rc == 0 || ( rc == -1 && (
 312                                     !LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_RESTART)
 313                                     || errno != EINTR )))
 314                             {
 315                                     ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
 316                                         LDAP_TIMEOUT);
 317                                     return( rc );
 318                             }
 319
 320                             if ( rc == -1 ) {
 321                                     rc = -2;    /* select interrupted: loop */
 322                             } else {
 323                                     rc = -2;
 324 #ifdef LDAP_R_COMPILE
 325                                     ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
 326 #endif
 327                                     if ( ld->ld_requests &&
 328                                                 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
 329                                                 ldap_is_write_ready( ld,
 330                                                         ld->ld_requests->lr_conn->lconn_sb ) ) {
 331                                                 ldap_int_flush_request( ld, ld->ld_requests );
 332                                         }
 333 #ifdef LDAP_R_COMPILE
 334                                     ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
 335 #endif
 336                                     for ( lc = ld->ld_conns; rc == -2 && lc != NULL;
 337                                         lc = nextlc ) {
 338                                             nextlc = lc->lconn_next;
 339                                             if ( lc->lconn_status ==
 340                                                 LDAP_CONNST_CONNECTED &&
 341                                                 ldap_is_read_ready( ld,
 342                                                 lc->lconn_sb )) {
 343                                                     rc = try_read1msg( ld, msgid, all,
 344                                                         lc->lconn_sb, &lc, result );
 345                                                         if ( lc == NULL ) lc = nextlc;
 346                                             }
 347                                     }
 348                             }
 349                     }
 350                 }
 351
 352                 if ( rc == -2 && tvp != NULL ) {
 353                         tmp_time = time( NULL );
 354                         if (( tv.tv_sec -=  ( tmp_time - start_time )) <= 0 ) {
 355                                 rc = 0; /* timed out */
 356                                 ld->ld_errno = LDAP_TIMEOUT;
 357                                 break;
 358                         }
 359
 360                         Debug( LDAP_DEBUG_TRACE, "wait4msg:  %ld secs to go\n",
 361                                (long) tv.tv_sec, 0, 0 );
 362                         start_time = tmp_time;
 363                 }
 364         }
 365
 366         return( rc );
 367 }
 368
 369
 370 static ber_tag_t
 371 try_read1msg(
 372         LDAP *ld,
 373         ber_int_t msgid,
 374         int all,
 375         Sockbuf *sb,
 376         LDAPConn **lcp,
 377         LDAPMessage **result )
 378 {
 379         BerElement      *ber;
 380         LDAPMessage     *new, *l, *prev, *tmp, *chain_head;
 381         ber_int_t       id;
 382         ber_tag_t       tag;
 383         ber_len_t       len;
 384         int             foundit = 0;
 385         LDAPRequest     *lr, *tmplr;
 386         LDAPConn        *lc;
 387         BerElement      tmpber;
 388         int             rc, refer_cnt, hadref, simple_request;
 389         ber_int_t       lderr;
 390 #ifdef LDAP_CONNECTIONLESS
 391         int             firstmsg = 1, moremsgs = 0, isv2 = 0;
 392 #endif
 393         /*
 394          * v3ref = flag for V3 referral / search reference
 395          * 0 = not a ref, 1 = sucessfully chased ref, -1 = pass ref to application
 396          */
 397         int     v3ref;
 398
 399         assert( ld != NULL );
 400         assert( lcp != NULL );
 401         assert( *lcp != NULL );
 402
 403         Debug( LDAP_DEBUG_TRACE, "read1msg: msgid %d, all %d\n", msgid, all, 0 );
 404
 405         lc = *lcp;
 406
 407 retry:
 408         if ( lc->lconn_ber == NULL ) {
 409                 lc->lconn_ber = ldap_alloc_ber_with_options(ld);
 410
 411                 if( lc->lconn_ber == NULL ) {
 412                         return -1;
 413                 }
 414         }
 415
 416         ber = lc->lconn_ber;
 417         assert( LBER_VALID (ber) );
 418
 419         /* get the next message */
 420         errno = 0;
 421 #ifdef LDAP_CONNECTIONLESS
 422         if ( LDAP_IS_UDP(ld) ) {
 423                 struct sockaddr from;
 424                 ber_int_sb_read(sb, &from, sizeof(struct sockaddr));
 425                 if (ld->ld_options.ldo_version == LDAP_VERSION2) isv2=1;
 426         }
 427 nextresp3:
 428 #endif
 429         tag = ber_get_next( sb, &len, ber );
 430         if ( tag == LDAP_TAG_MESSAGE ) {
 431                 /*
 432                  * We read a complete message.
 433                  * The connection should no longer need this ber.
 434                  */
 435                 lc->lconn_ber = NULL;
 436         }
 437         if ( tag != LDAP_TAG_MESSAGE ) {
 438                 if ( tag == LBER_DEFAULT) {
 439 #ifdef LDAP_DEBUG
 440                         Debug( LDAP_DEBUG_CONNS,
 441                               "ber_get_next failed.\n", 0, 0, 0 );
 442 #endif
 443 #ifdef EWOULDBLOCK
 444                         if (errno==EWOULDBLOCK) return -2;
 445 #endif
 446 #ifdef EAGAIN
 447                         if (errno == EAGAIN) return -2;
 448 #endif
 449                         ld->ld_errno = LDAP_SERVER_DOWN;
 450                         return -1;
 451                 }
 452                 ld->ld_errno = LDAP_LOCAL_ERROR;
 453                 return -1;
 454         }
 455
 456         /* message id */
 457         if ( ber_get_int( ber, &id ) == LBER_ERROR ) {
 458                 ber_free( ber, 1 );
 459                 ld->ld_errno = LDAP_DECODING_ERROR;
 460                 return( -1 );
 461         }
 462
 463         /* if it's been abandoned, toss it */
 464         if ( ldap_abandoned( ld, id ) ) {
 465                 Debug( LDAP_DEBUG_ANY, "abandoned\n", 0, 0, 0);
 466 retry_ber:
 467                 ber_free( ber, 1 );
 468                 if ( ber_sockbuf_ctrl( sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
 469                         goto retry;
 470                 }
 471                 return( -2 );   /* continue looking */
 472         }
 473
 474         if (( lr = ldap_find_request_by_msgid( ld, id )) == NULL ) {
 475                 Debug( LDAP_DEBUG_ANY,
 476                     "no request for response with msgid %ld (tossing)\n",
 477                     (long) id, 0, 0 );
 478                 goto retry_ber;
 479         }
 480 #ifdef LDAP_CONNECTIONLESS
 481         if (LDAP_IS_UDP(ld) && isv2) {
 482                 ber_scanf(ber, "x{");
 483         }
 484 nextresp2:
 485 #endif
 486         /* the message type */
 487         if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
 488                 ld->ld_errno = LDAP_DECODING_ERROR;
 489                 ber_free( ber, 1 );
 490                 return( -1 );
 491         }
 492
 493         Debug( LDAP_DEBUG_TRACE,
 494                 "ldap_read: message type %s msgid %ld, original id %ld\n",
 495             ldap_int_msgtype2str( tag ),
 496                 (long) lr->lr_msgid, (long) lr->lr_origid );
 497
 498         id = lr->lr_origid;
 499         refer_cnt = 0;
 500         hadref = simple_request = 0;
 501         rc = -2;        /* default is to keep looking (no response found) */
 502         lr->lr_res_msgtype = tag;
 503
 504         /*
 505          * This code figures out if we are going to chase a
 506          * referral / search reference, or pass it back to the application
 507          */
 508         v3ref = 0;      /* Assume not a V3 search reference or referral */
 509         if( (tag != LDAP_RES_SEARCH_ENTRY) && (ld->ld_version > LDAP_VERSION2) ) {
 510                 BerElement      tmpber = *ber;  /* struct copy */
 511                 char **refs = NULL;
 512
 513                 if( tag == LDAP_RES_SEARCH_REFERENCE) {
 514                         /* This is a V3 search reference */
 515                         /* Assume we do not chase the reference, but pass it to application */
 516                         v3ref = -1;
 517                         if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ||
 518                                         (lr->lr_parent != NULL) )
 519                         {
 520                                 /* Get the referral list */
 521                                 if ( ber_scanf( &tmpber, "{v}", &refs ) == LBER_ERROR ) {
 522                                         rc = LDAP_DECODING_ERROR;
 523                                 } else {
 524                                         /* Note: refs arrary is freed by ldap_chase_v3referrals */
 525                                         refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
 526                                             1, &lr->lr_res_error, &hadref );
 527                                         if ( refer_cnt > 0 ) {  /* sucessfully chased reference */
 528                                                 /* If haven't got end search, set chasing referrals */
 529                                                 if( lr->lr_status != LDAP_REQST_COMPLETED) {
 530                                                         lr->lr_status = LDAP_REQST_CHASINGREFS;
 531                                                         Debug( LDAP_DEBUG_TRACE,
 532                                                             "read1msg:  search ref chased, mark request chasing refs, id = %d\n",
 533                                                             lr->lr_msgid, 0, 0);
 534                                                 }
 535                                                 v3ref = 1;      /* We sucessfully chased the reference */
 536                                         }
 537                                 }
 538                         }
 539                 } else {
 540                         /* Check for V3 referral */
 541                         ber_len_t len;
 542                         if ( ber_scanf( &tmpber, "{iaa",/*}*/ &lderr,
 543                                     &lr->lr_res_matched, &lr->lr_res_error )
 544                                     != LBER_ERROR ) {
 545                                 /* Check if V3 referral */
 546                                 if( ber_peek_tag( &tmpber, &len) == LDAP_TAG_REFERRAL ) {
 547                                         /* We have a V3 referral, assume we cannot chase it */
 548                                         v3ref = -1;
 549                                         if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
 550                                                          || (lr->lr_parent != NULL) )
 551                                         {
 552                                                 v3ref = -1;  /* Assume referral not chased and return it to app */
 553                                                 /* Get the referral list */
 554                                                 if( ber_scanf( &tmpber, "{v}", &refs) == LBER_ERROR) {
 555                                                         rc = LDAP_DECODING_ERROR;
 556                                                         lr->lr_status = LDAP_REQST_COMPLETED;
 557                                                         Debug( LDAP_DEBUG_TRACE,
 558                                                             "read1msg: referral decode error, mark request completed, id = %d\n",
 559                                                                     lr->lr_msgid, 0, 0);
 560                                                 } else {
 561                                                         /* Chase the referral
 562                                                          * Note: refs arrary is freed by ldap_chase_v3referrals
 563                                                          */
 564                                                         refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
 565                                                             0, &lr->lr_res_error, &hadref );
 566                                                         lr->lr_status = LDAP_REQST_COMPLETED;
 567                                                         Debug( LDAP_DEBUG_TRACE,
 568                                                             "read1msg:  referral chased, mark request completed, id = %d\n",
 569                                                             lr->lr_msgid, 0, 0);
 570                                                         if( refer_cnt > 0) {
 571                                                                 v3ref = 1;  /* Referral successfully chased */
 572                                                         }
 573                                                 }
 574                                         }
 575                                 }
 576
 577                                 if( lr->lr_res_matched != NULL ) {
 578                                         LDAP_FREE( lr->lr_res_matched );
 579                                         lr->lr_res_matched = NULL;
 580                                 }
 581                                 if( lr->lr_res_error != NULL ) {
 582                                         LDAP_FREE( lr->lr_res_error );
 583                                         lr->lr_res_error = NULL;
 584                                 }
 585                         }
 586                 }
 587         }
 588
 589         /* All results that just return a status, i.e. don't return data
 590          * go through the following code.  This code also chases V2 referrals
 591          * and checks if all referrals have been chased.
 592          */
 593         if ( (tag != LDAP_RES_SEARCH_ENTRY) && (v3ref > -1) &&
 594                 (tag != LDAP_RES_INTERMEDIATE ))
 595         {
 596                 /* For a v3 search referral/reference, only come here if already chased it */
 597                 if ( ld->ld_version >= LDAP_VERSION2 &&
 598                         ( lr->lr_parent != NULL ||
 599                         LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ) )
 600                 {
 601                         tmpber = *ber;  /* struct copy */
 602                         if ( v3ref == 1 ) {
 603                                 /* V3 search reference or V3 referral
 604                                  * sucessfully chased. If this message
 605                                  * is a search result, then it has no more
 606                                  * outstanding referrals.
 607                                  */
 608                                 if ( tag == LDAP_RES_SEARCH_RESULT )
 609                                         refer_cnt = 0;
 610                         } else if ( ber_scanf( &tmpber, "{iaa}", &lderr,
 611                             &lr->lr_res_matched, &lr->lr_res_error )
 612                             != LBER_ERROR ) {
 613                                 if ( lderr != LDAP_SUCCESS ) {
 614                                         /* referrals are in error string */
 615                                         refer_cnt = ldap_chase_referrals( ld, lr,
 616                                                 &lr->lr_res_error, -1, &hadref );
 617                                         lr->lr_status = LDAP_REQST_COMPLETED;
 618                                         Debug( LDAP_DEBUG_TRACE,
 619                                             "read1msg:  V2 referral chased, mark request completed, id = %d\n", lr->lr_msgid, 0, 0);
 620                                 }
 621
 622                                 /* save errno, message, and matched string */
 623                                 if ( !hadref || lr->lr_res_error == NULL ) {
 624                                         lr->lr_res_errno = ( lderr ==
 625                                         LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
 626                                         : lderr;
 627                                 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
 628                                         lr->lr_res_errno = ld->ld_errno;
 629                                 } else {
 630                                         lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
 631                                 }
 632 Debug( LDAP_DEBUG_TRACE,
 633     "new result:  res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
 634     lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
 635     lr->lr_res_matched ? lr->lr_res_matched : "" );
 636                         }
 637                 }
 638
 639                 Debug( LDAP_DEBUG_TRACE,
 640                     "read1msg:  %d new referrals\n", refer_cnt, 0, 0 );
 641
 642                 if ( refer_cnt != 0 ) { /* chasing referrals */
 643                         ber_free( ber, 1 );
 644                         ber = NULL;
 645                         if ( refer_cnt < 0 ) {
 646                                 return( -1 );   /* fatal error */
 647                         }
 648                         lr->lr_res_errno = LDAP_SUCCESS; /* sucessfully chased referral */
 649                 } else {
 650                         if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
 651                                 /* request without any referrals */
 652                                 simple_request = ( hadref ? 0 : 1 );
 653                         } else {
 654                                 /* request with referrals or child request */
 655                                 ber_free( ber, 1 );
 656                                 ber = NULL;
 657                         }
 658
 659                         lr->lr_status = LDAP_REQST_COMPLETED; /* declare this request done */
 660                         Debug( LDAP_DEBUG_TRACE,
 661                             "read1msg:  mark request completed, id = %d\n", lr->lr_msgid, 0, 0);
 662                         while ( lr->lr_parent != NULL ) {
 663                                 merge_error_info( ld, lr->lr_parent, lr );
 664
 665                                 lr = lr->lr_parent;
 666                                 if ( --lr->lr_outrefcnt > 0 ) {
 667                                         break;  /* not completely done yet */
 668                                 }
 669                         }
 670
 671                         /* Check if all requests are finished, lr is now parent */
 672                         tmplr = lr;
 673                         if (tmplr->lr_status == LDAP_REQST_COMPLETED) {
 674                                 for ( tmplr=lr->lr_child;
 675                                         tmplr != NULL;
 676                                         tmplr=tmplr->lr_refnext)
 677                                 {
 678                                         if( tmplr->lr_status != LDAP_REQST_COMPLETED) break;
 679                                 }
 680                         }
 681
 682                         /* This is the parent request if the request has referrals */
 683                         if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL &&
 684                                 tmplr == NULL )
 685                         {
 686                                 id = lr->lr_msgid;
 687                                 tag = lr->lr_res_msgtype;
 688                                 Debug( LDAP_DEBUG_ANY, "request %ld done\n",
 689                                     (long) id, 0, 0 );
 690 Debug( LDAP_DEBUG_TRACE,
 691 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
 692 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
 693 lr->lr_res_matched ? lr->lr_res_matched : "" );
 694                                 if ( !simple_request ) {
 695                                         ber_free( ber, 1 );
 696                                         ber = NULL;
 697                                         if ( build_result_ber( ld, &ber, lr )
 698                                             == LBER_ERROR ) {
 699                                                 rc = -1; /* fatal error */
 700                                         }
 701                                 }
 702
 703                                 ldap_free_request( ld, lr );
 704                         }
 705
 706                         if ( lc != NULL ) {
 707                                 ldap_free_connection( ld, lc, 0, 1 );
 708                                 *lcp = NULL;
 709                         }
 710                 }
 711         }
 712
 713         if ( ber == NULL ) {
 714                 return( rc );
 715         }
 716
 717         /* make a new ldap message */
 718         if ( (new = (LDAPMessage *) LDAP_CALLOC( 1, sizeof(LDAPMessage) ))
 719             == NULL ) {
 720                 ld->ld_errno = LDAP_NO_MEMORY;
 721                 return( -1 );
 722         }
 723         new->lm_msgid = (int)id;
 724         new->lm_msgtype = tag;
 725         new->lm_ber = ber;
 726
 727 #ifdef LDAP_CONNECTIONLESS
 728         /* CLDAP replies all fit in a single datagram. In LDAPv2 RFC1798
 729          * the responses are all a sequence wrapped in one message. In
 730          * LDAPv3 each response is in its own message. The datagram must
 731          * end with a SearchResult. We can't just parse each response in
 732          * separate calls to try_read1msg because the header info is only
 733          * present at the beginning of the datagram, not at the beginning
 734          * of each response. So parse all the responses at once and queue
 735          * them up, then pull off the first response to return to the
 736          * caller when all parsing is complete.
 737          */
 738         if ( LDAP_IS_UDP(ld) ) {
 739                 /* If not a result, look for more */
 740                 if ( tag != LDAP_RES_SEARCH_RESULT ) {
 741                         int ok = 0;
 742                         moremsgs = 1;
 743                         if (isv2) {
 744                                 /* LDAPv2: dup the current ber, skip past the current
 745                                  * response, and see if there are any more after it.
 746                                  */
 747                                 ber = ber_dup( ber );
 748                                 ber_scanf( ber, "x" );
 749                                 if (ber_peek_tag(ber, &len) != LBER_DEFAULT) {
 750                                         /* There's more - dup the ber buffer so they can all be
 751                                          * individually freed by ldap_msgfree.
 752                                          */
 753                                         struct berval bv;
 754                                         ber_get_option(ber, LBER_OPT_BER_REMAINING_BYTES, &len);
 755                                         bv.bv_val = LDAP_MALLOC(len);
 756                                         if (bv.bv_val) {
 757                                                 ok=1;
 758                                                 ber_read(ber, bv.bv_val, len);
 759                                                 bv.bv_len = len;
 760                                                 ber_init2(ber, &bv, ld->ld_lberoptions );
 761                                         }
 762                                 }
 763                         } else {
 764                                 /* LDAPv3: Just allocate a new ber. Since this is a buffered
 765                                  * datagram, if the sockbuf is readable we still have data
 766                                  * to parse.
 767                                  */
 768                                 ber = ldap_alloc_ber_with_options(ld);
 769                                 if (ber_sockbuf_ctrl(sb, LBER_SB_OPT_DATA_READY, NULL)) ok=1;
 770                         }
 771                         /* set up response chain */
 772                         if ( firstmsg ) {
 773                                 firstmsg = 0;
 774                                 new->lm_next = ld->ld_responses;
 775                                 ld->ld_responses = new;
 776                                 new->lm_chain_tail = new;
 777                                 chain_head = new;
 778                         } else {
 779                                 tmp->lm_chain = new;
 780                                 chain_head->lm_chain_tail = tmp;
 781                         }
 782                         tmp = new;
 783                         /* "ok" means there's more to parse */
 784                         if (ok) {
 785                                 if (isv2) goto nextresp2;
 786                                 else goto nextresp3;
 787                         } else {
 788                                 /* got to end of datagram without a SearchResult. Free
 789                                  * our dup'd ber, but leave any buffer alone. For v2 case,
 790                                  * the previous response is still using this buffer. For v3,
 791                                  * the new ber has no buffer to free yet.
 792                                  */
 793                                 ber_free(ber, 0);
 794                                 return -1;
 795                         }
 796                 } else if ( moremsgs ) {
 797                 /* got search result, and we had multiple responses in 1 datagram.
 798                  * stick the result onto the end of the chain, and then pull the
 799                  * first response off the head of the chain.
 800                  */
 801                         tmp->lm_chain = new;
 802                         chain_head->lm_chain_tail = tmp;
 803                         *result = chkResponseList( ld, msgid, all );
 804                         ld->ld_errno = LDAP_SUCCESS;
 805                         return( (*result)->lm_msgtype );
 806                 }
 807         }
 808 #endif
 809
 810         /* is this the one we're looking for? */
 811         if ( msgid == LDAP_RES_ANY || id == msgid ) {
 812                 if ( all == LDAP_MSG_ONE
 813                     || (new->lm_msgtype != LDAP_RES_SEARCH_RESULT
 814                     && new->lm_msgtype != LDAP_RES_SEARCH_ENTRY
 815                     && new->lm_msgtype != LDAP_RES_SEARCH_REFERENCE) ) {
 816                         *result = new;
 817                         ld->ld_errno = LDAP_SUCCESS;
 818                         return( tag );
 819                 } else if ( new->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
 820                         foundit = 1;    /* return the chain later */
 821                 }
 822         }
 823
 824         /*
 825          * if not, we must add it to the list of responses.  if
 826          * the msgid is already there, it must be part of an existing
 827          * search response.
 828          */
 829
 830         prev = NULL;
 831         for ( l = ld->ld_responses; l != NULL; l = l->lm_next ) {
 832                 if ( l->lm_msgid == new->lm_msgid )
 833                         break;
 834                 prev = l;
 835         }
 836
 837         /* not part of an existing search response */
 838         if ( l == NULL ) {
 839                 if ( foundit ) {
 840                         *result = new;
 841                         goto exit;
 842                 }
 843
 844                 new->lm_next = ld->ld_responses;
 845                 ld->ld_responses = new;
 846                 new->lm_chain_tail = new;
 847                 goto exit;
 848         }
 849
 850         Debug( LDAP_DEBUG_TRACE, "adding response id %ld type %ld:\n",
 851             (long) new->lm_msgid, (long) new->lm_msgtype, 0 );
 852
 853         /* part of a search response - add to end of list of entries */
 854         if (l->lm_chain == NULL) {
 855                 if ((l->lm_msgtype == LDAP_RES_SEARCH_ENTRY) ||
 856                         (l->lm_msgtype == LDAP_RES_SEARCH_REFERENCE) ||
 857                         (l->lm_msgtype == LDAP_RES_INTERMEDIATE)) {
 858                         /* do not advance lm_chain_tail in this case */
 859                         l->lm_chain = new;
 860                 } else {
 861                         /*FIXME: ldap_msgfree( l );*/
 862                         l = new;
 863                         l->lm_chain_tail = new;
 864                 }
 865         } else {
 866                 if ((l->lm_chain_tail->lm_chain->lm_msgtype
 867                                 == LDAP_RES_SEARCH_ENTRY) ||
 868                         (l->lm_chain_tail->lm_chain->lm_msgtype
 869                                 == LDAP_RES_SEARCH_REFERENCE) ||
 870                         (l->lm_chain_tail->lm_chain->lm_msgtype
 871                                 == LDAP_RES_INTERMEDIATE)) {
 872                         l->lm_chain_tail->lm_chain->lm_chain = new;
 873                         l->lm_chain_tail = l->lm_chain_tail->lm_chain;
 874                 } else {
 875                         /*FIXME: ldap_msgfree( l->lm_chain_tail->lm_chain );*/
 876                         l->lm_chain_tail->lm_chain = new;
 877                 }
 878         }
 879
 880         /* return the whole chain if that's what we were looking for */
 881         if ( foundit ) {
 882                 if ( prev == NULL )
 883                         ld->ld_responses = l->lm_next;
 884                 else
 885                         prev->lm_next = l->lm_next;
 886                 *result = l;
 887         }
 888
 889 exit:
 890         if ( foundit ) {
 891                 ld->ld_errno = LDAP_SUCCESS;
 892                 return( tag );
 893         }
 894         if ( ber_sockbuf_ctrl( sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
 895                 goto retry;
 896         }
 897         return( -2 );   /* continue looking */
 898 }
 899
 900
 901 static ber_tag_t
 902 build_result_ber( LDAP *ld, BerElement **bp, LDAPRequest *lr )
 903 {
 904         ber_len_t       len;
 905         ber_tag_t       tag;
 906         ber_int_t       along;
 907         BerElement *ber;
 908
 909         *bp = NULL;
 910         ber = ldap_alloc_ber_with_options( ld );
 911
 912         if( ber == NULL ) {
 913                 ld->ld_errno = LDAP_NO_MEMORY;
 914                 return LBER_ERROR;
 915         }
 916
 917         if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
 918             lr->lr_res_msgtype, lr->lr_res_errno,
 919             lr->lr_res_matched ? lr->lr_res_matched : "",
 920             lr->lr_res_error ? lr->lr_res_error : "" ) == -1 ) {
 921
 922                 ld->ld_errno = LDAP_ENCODING_ERROR;
 923                 ber_free(ber, 1);
 924                 return( LBER_ERROR );
 925         }
 926
 927         ber_reset( ber, 1 );
 928
 929         if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
 930                 ld->ld_errno = LDAP_DECODING_ERROR;
 931                 ber_free(ber, 1);
 932                 return( LBER_ERROR );
 933         }
 934
 935         if ( ber_get_int( ber, &along ) == LBER_ERROR ) {
 936                 ld->ld_errno = LDAP_DECODING_ERROR;
 937                 ber_free(ber, 1);
 938                 return( LBER_ERROR );
 939         }
 940
 941         tag = ber_peek_tag( ber, &len );
 942
 943         if ( tag == LBER_ERROR ) {
 944                 ld->ld_errno = LDAP_DECODING_ERROR;
 945                 ber_free(ber, 1);
 946                 return( LBER_ERROR );
 947         }
 948
 949         *bp = ber;
 950         return tag;
 951 }
 952
 953
 954 static void
 955 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
 956 {
 957 /*
 958  * Merge error information in "lr" with "parentr" error code and string.
 959  */
 960         if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
 961                 parentr->lr_res_errno = lr->lr_res_errno;
 962                 if ( lr->lr_res_error != NULL ) {
 963                         (void)ldap_append_referral( ld, &parentr->lr_res_error,
 964                             lr->lr_res_error );
 965                 }
 966         } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
 967             parentr->lr_res_errno == LDAP_SUCCESS ) {
 968                 parentr->lr_res_errno = lr->lr_res_errno;
 969                 if ( parentr->lr_res_error != NULL ) {
 970                         LDAP_FREE( parentr->lr_res_error );
 971                 }
 972                 parentr->lr_res_error = lr->lr_res_error;
 973                 lr->lr_res_error = NULL;
 974                 if ( LDAP_NAME_ERROR( lr->lr_res_errno )) {
 975                         if ( parentr->lr_res_matched != NULL ) {
 976                                 LDAP_FREE( parentr->lr_res_matched );
 977                         }
 978                         parentr->lr_res_matched = lr->lr_res_matched;
 979                         lr->lr_res_matched = NULL;
 980                 }
 981         }
 982
 983         Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info:  ",
 984             parentr->lr_msgid, 0, 0 );
 985         Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
 986             parentr->lr_res_errno, parentr->lr_res_error ?
 987             parentr->lr_res_error : "", parentr->lr_res_matched ?
 988             parentr->lr_res_matched : "" );
 989 }
 990
 991
 992
 993 int
 994 ldap_msgtype( LDAPMessage *lm )
 995 {
 996         assert( lm != NULL );
 997         return ( lm != NULL ) ? lm->lm_msgtype : -1;
 998 }
 999
1000
1001 int
1002 ldap_msgid( LDAPMessage *lm )
1003 {
1004         assert( lm != NULL );
1005
1006         return ( lm != NULL ) ? lm->lm_msgid : -1;
1007 }
1008
1009
1010 char * ldap_int_msgtype2str( ber_tag_t tag )
1011 {
1012         switch( tag ) {
1013         case LDAP_RES_ADD: return "add";
1014         case LDAP_RES_BIND: return "bind";
1015         case LDAP_RES_COMPARE: return "compare";
1016         case LDAP_RES_DELETE: return "delete";
1017         case LDAP_RES_EXTENDED: return "extended-result";
1018         case LDAP_RES_INTERMEDIATE: return "intermediate";
1019         case LDAP_RES_MODIFY: return "modify";
1020         case LDAP_RES_RENAME: return "rename";
1021         case LDAP_RES_SEARCH_ENTRY: return "search-entry";
1022         case LDAP_RES_SEARCH_REFERENCE: return "search-reference";
1023         case LDAP_RES_SEARCH_RESULT: return "search-result";
1024         }
1025         return "unknown";
1026 }
1027
1028 int
1029 ldap_msgfree( LDAPMessage *lm )
1030 {
1031         LDAPMessage     *next;
1032         int             type = 0;
1033
1034         Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
1035
1036         for ( ; lm != NULL; lm = next ) {
1037                 next = lm->lm_chain;
1038                 type = lm->lm_msgtype;
1039                 ber_free( lm->lm_ber, 1 );
1040                 LDAP_FREE( (char *) lm );
1041         }
1042
1043         return( type );
1044 }
1045
1046 /*
1047  * ldap_msgdelete - delete a message.  It returns:
1048  *      0       if the entire message was deleted
1049  *      -1      if the message was not found, or only part of it was found
1050  */
1051 int
1052 ldap_msgdelete( LDAP *ld, int msgid )
1053 {
1054         LDAPMessage     *lm, *prev;
1055         int rc = 0;
1056
1057         assert( ld != NULL );
1058
1059         Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
1060
1061         prev = NULL;
1062 #ifdef LDAP_R_COMPILE
1063         ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
1064 #endif
1065         for ( lm = ld->ld_responses; lm != NULL; lm = lm->lm_next ) {
1066                 if ( lm->lm_msgid == msgid )
1067                         break;
1068                 prev = lm;
1069         }
1070
1071         if ( lm == NULL ) {
1072                 rc = -1;
1073         } else {
1074                 if ( prev == NULL )
1075                         ld->ld_responses = lm->lm_next;
1076                 else
1077                         prev->lm_next = lm->lm_next;
1078         }
1079 #ifdef LDAP_R_COMPILE
1080         ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
1081 #endif
1082         if ( lm && ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
1083                 rc = -1;
1084
1085         return( rc );
1086 }
1087
1088
1089 /*
1090  * return 1 if message msgid is waiting to be abandoned, 0 otherwise
1091  */
1092 static int
1093 ldap_abandoned( LDAP *ld, ber_int_t msgid )
1094 {
1095         int     i;
1096
1097         if ( ld->ld_abandoned == NULL )
1098                 return( 0 );
1099
1100         for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1101                 if ( ld->ld_abandoned[i] == msgid )
1102                         return( 1 );
1103
1104         return( 0 );
1105 }
1106
1107
1108 static int
1109 ldap_mark_abandoned( LDAP *ld, ber_int_t msgid )
1110 {
1111         int     i;
1112
1113         if ( ld->ld_abandoned == NULL )
1114                 return( -1 );
1115
1116         for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1117                 if ( ld->ld_abandoned[i] == msgid )
1118                         break;
1119
1120         if ( ld->ld_abandoned[i] == -1 )
1121                 return( -1 );
1122
1123         for ( ; ld->ld_abandoned[i] != -1; i++ ) {
1124                 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];
1125         }
1126
1127         return( 0 );
1128 }