]> git.sur5r.net Git - openldap/blob - libraries/libldap/request.c
ITS#6262
[openldap] / libraries / libldap / request.c
1 /* $OpenLDAP$ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3  *
4  * Copyright 1998-2010 The OpenLDAP Foundation.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted only as authorized by the OpenLDAP
9  * Public License.
10  *
11  * A copy of this license is available in the file LICENSE in the
12  * top-level directory of the distribution or, alternatively, at
13  * <http://www.OpenLDAP.org/license.html>.
14  */
15 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
16  * All rights reserved.
17  */
18 /* This notice applies to changes, created by or for Novell, Inc.,
19  * to preexisting works for which notices appear elsewhere in this file.
20  *
21  * Copyright (C) 1999, 2000 Novell, Inc. All Rights Reserved.
22  *
23  * THIS WORK IS SUBJECT TO U.S. AND INTERNATIONAL COPYRIGHT LAWS AND TREATIES.
24  * USE, MODIFICATION, AND REDISTRIBUTION OF THIS WORK IS SUBJECT TO VERSION
25  * 2.0.1 OF THE OPENLDAP PUBLIC LICENSE, A COPY OF WHICH IS AVAILABLE AT
26  * HTTP://WWW.OPENLDAP.ORG/LICENSE.HTML OR IN THE FILE "LICENSE" IN THE
27  * TOP-LEVEL DIRECTORY OF THE DISTRIBUTION. ANY USE OR EXPLOITATION OF THIS
28  * WORK OTHER THAN AS AUTHORIZED IN VERSION 2.0.1 OF THE OPENLDAP PUBLIC
29  * LICENSE, OR OTHER PRIOR WRITTEN CONSENT FROM NOVELL, COULD SUBJECT THE
30  * PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY. 
31  *---
32  * Modification to OpenLDAP source by Novell, Inc.
33  * April 2000 sfs  Added code to chase V3 referrals
34  *  request.c - sending of ldap requests; handling of referrals
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
41 #include "portable.h"
42
43 #include <stdio.h>
44
45 #include <ac/stdlib.h>
46
47 #include <ac/errno.h>
48 #include <ac/socket.h>
49 #include <ac/string.h>
50 #include <ac/time.h>
51 #include <ac/unistd.h>
52
53 #include "ldap-int.h"
54 #include "lber.h"
55
56 static LDAPConn *find_connection LDAP_P(( LDAP *ld, LDAPURLDesc *srv, int any ));
57 static void use_connection LDAP_P(( LDAP *ld, LDAPConn *lc ));
58 static void ldap_free_request_int LDAP_P(( LDAP *ld, LDAPRequest *lr ));
59
60 static BerElement *
61 re_encode_request( LDAP *ld,
62         BerElement *origber,
63         ber_int_t msgid,
64         int sref,
65         LDAPURLDesc *srv,
66         int *type );
67
68 BerElement *
69 ldap_alloc_ber_with_options( LDAP *ld )
70 {
71         BerElement      *ber;
72
73         ber = ber_alloc_t( ld->ld_lberoptions );
74         if ( ber == NULL ) {
75                 ld->ld_errno = LDAP_NO_MEMORY;
76         }
77
78         return( ber );
79 }
80
81
82 void
83 ldap_set_ber_options( LDAP *ld, BerElement *ber )
84 {
85         ber->ber_options = ld->ld_lberoptions;
86 }
87
88
89 ber_int_t
90 ldap_send_initial_request(
91         LDAP *ld,
92         ber_tag_t msgtype,
93         const char *dn,
94         BerElement *ber,
95         ber_int_t msgid)
96 {
97         int rc = 1;
98
99         Debug( LDAP_DEBUG_TRACE, "ldap_send_initial_request\n", 0, 0, 0 );
100
101 #ifdef LDAP_R_COMPILE
102         ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
103 #endif
104         if ( ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, NULL ) == -1 ) {
105                 /* not connected yet */
106                 rc = ldap_open_defconn( ld );
107
108         }
109 #ifdef LDAP_R_COMPILE
110         ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
111 #endif
112         if( rc < 0 ) {
113                 ber_free( ber, 1 );
114                 return( -1 );
115         } else if ( rc == 0 ) {
116                 Debug( LDAP_DEBUG_TRACE,
117                         "ldap_open_defconn: successful\n",
118                         0, 0, 0 );
119         }
120
121 #ifdef LDAP_CONNECTIONLESS
122         if (LDAP_IS_UDP(ld)) {
123                 if (msgtype == LDAP_REQ_BIND) {
124                         if (ld->ld_options.ldo_cldapdn)
125                                 ldap_memfree(ld->ld_options.ldo_cldapdn);
126                         ld->ld_options.ldo_cldapdn = ldap_strdup(dn);
127                         return 0;
128                 }
129                 if (msgtype != LDAP_REQ_ABANDON && msgtype != LDAP_REQ_SEARCH)
130                         return LDAP_PARAM_ERROR;
131         }
132 #endif
133 #ifdef LDAP_R_COMPILE
134         ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
135 #endif
136         rc = ldap_send_server_request( ld, ber, msgid, NULL,
137                 NULL, NULL, NULL );
138 #ifdef LDAP_R_COMPILE
139         ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
140 #endif
141         return(rc);
142 }
143
144
145 int
146 ldap_int_flush_request(
147         LDAP *ld,
148         LDAPRequest *lr )
149 {
150         LDAPConn *lc = lr->lr_conn;
151
152         if ( ber_flush2( lc->lconn_sb, lr->lr_ber, LBER_FLUSH_FREE_NEVER ) != 0 ) {
153                 if ( sock_errno() == EAGAIN ) {
154                         /* need to continue write later */
155                         lr->lr_status = LDAP_REQST_WRITING;
156                         ldap_mark_select_write( ld, lc->lconn_sb );
157                         ld->ld_errno = LDAP_BUSY;
158                         return -2;
159                 } else {
160                         ld->ld_errno = LDAP_SERVER_DOWN;
161                         ldap_free_request( ld, lr );
162                         ldap_free_connection( ld, lc, 0, 0 );
163                         return( -1 );
164                 }
165         } else {
166                 if ( lr->lr_parent == NULL ) {
167                         lr->lr_ber->ber_end = lr->lr_ber->ber_ptr;
168                         lr->lr_ber->ber_ptr = lr->lr_ber->ber_buf;
169                 }
170                 lr->lr_status = LDAP_REQST_INPROGRESS;
171
172                 /* sent -- waiting for a response */
173                 ldap_mark_select_read( ld, lc->lconn_sb );
174         }
175         return 0;
176 }
177
178 int
179 ldap_send_server_request(
180         LDAP *ld,
181         BerElement *ber,
182         ber_int_t msgid,
183         LDAPRequest *parentreq,
184         LDAPURLDesc **srvlist,
185         LDAPConn *lc,
186         LDAPreqinfo *bind )
187 {
188         LDAPRequest     *lr;
189         int             incparent, rc;
190
191         Debug( LDAP_DEBUG_TRACE, "ldap_send_server_request\n", 0, 0, 0 );
192
193         incparent = 0;
194         ld->ld_errno = LDAP_SUCCESS;    /* optimistic */
195
196         if ( lc == NULL ) {
197                 if ( srvlist == NULL ) {
198                         lc = ld->ld_defconn;
199                 } else {
200                         lc = find_connection( ld, *srvlist, 1 );
201                         if ( lc == NULL ) {
202                                 if ( (bind != NULL) && (parentreq != NULL) ) {
203                                         /* Remember the bind in the parent */
204                                         incparent = 1;
205                                         ++parentreq->lr_outrefcnt;
206                                 }
207                                 lc = ldap_new_connection( ld, srvlist, 0, 1, bind );
208                         }
209                 }
210         }
211
212         /* async connect... */
213         if ( lc != NULL && lc->lconn_status == LDAP_CONNST_CONNECTING ) {
214                 ber_socket_t    sd = AC_SOCKET_ERROR;
215                 struct timeval  tv = { 0 };
216
217                 ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_GET_FD, &sd );
218
219                 /* poll ... */
220                 switch ( ldap_int_poll( ld, sd, &tv ) ) {
221                 case 0:
222                         /* go on! */
223                         lc->lconn_status = LDAP_CONNST_CONNECTED;
224                         break;
225
226                 case -2:
227                         /* async only occurs if a network timeout is set */
228
229                         /* honor network timeout */
230                         if ( time( NULL ) - lc->lconn_created <= ld->ld_options.ldo_tm_net.tv_sec )
231                         {
232                                 /* caller will have to call again */
233                                 ld->ld_errno = LDAP_X_CONNECTING;
234                         }
235                         /* fallthru */
236
237                 default:
238                         /* error */
239                         break;
240                 }
241         }
242
243         if ( lc == NULL || lc->lconn_status != LDAP_CONNST_CONNECTED ) {
244                 if ( ld->ld_errno == LDAP_SUCCESS ) {
245                         ld->ld_errno = LDAP_SERVER_DOWN;
246                 }
247
248                 ber_free( ber, 1 );
249                 if ( incparent ) {
250                         /* Forget about the bind */
251                         --parentreq->lr_outrefcnt; 
252                 }
253                 return( -1 );
254         }
255
256         use_connection( ld, lc );
257
258 #ifdef LDAP_CONNECTIONLESS
259         if ( LDAP_IS_UDP( ld )) {
260                 BerElement tmpber = *ber;
261                 ber_rewind( &tmpber );
262                 rc = ber_write( &tmpber, ld->ld_options.ldo_peer,
263                         sizeof( struct sockaddr ), 0 );
264                 if ( rc == -1 ) {
265                         ld->ld_errno = LDAP_ENCODING_ERROR;
266                         return rc;
267                 }
268         }
269 #endif
270
271         /* If we still have an incomplete write, try to finish it before
272          * dealing with the new request. If we don't finish here, return
273          * LDAP_BUSY and let the caller retry later. We only allow a single
274          * request to be in WRITING state.
275          */
276         rc = 0;
277         if ( ld->ld_requests &&
278                 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
279                 ldap_int_flush_request( ld, ld->ld_requests ) < 0 )
280         {
281                 rc = -1;
282         }
283         if ( rc ) return rc;
284
285         lr = (LDAPRequest *)LDAP_CALLOC( 1, sizeof( LDAPRequest ) );
286         if ( lr == NULL ) {
287                 ld->ld_errno = LDAP_NO_MEMORY;
288                 ldap_free_connection( ld, lc, 0, 0 );
289                 ber_free( ber, 1 );
290                 if ( incparent ) {
291                         /* Forget about the bind */
292                         --parentreq->lr_outrefcnt; 
293                 }
294                 return( -1 );
295         } 
296         lr->lr_msgid = msgid;
297         lr->lr_status = LDAP_REQST_INPROGRESS;
298         lr->lr_res_errno = LDAP_SUCCESS;        /* optimistic */
299         lr->lr_ber = ber;
300         lr->lr_conn = lc;
301         if ( parentreq != NULL ) {      /* sub-request */
302                 if ( !incparent ) { 
303                         /* Increment if we didn't do it before the bind */
304                         ++parentreq->lr_outrefcnt;
305                 }
306                 lr->lr_origid = parentreq->lr_origid;
307                 lr->lr_parentcnt = ++parentreq->lr_parentcnt;
308                 lr->lr_parent = parentreq;
309                 lr->lr_refnext = parentreq->lr_child;
310                 parentreq->lr_child = lr;
311         } else {                        /* original request */
312                 lr->lr_origid = lr->lr_msgid;
313         }
314
315         /* Extract requestDN for future reference */
316         {
317                 BerElement tmpber = *ber;
318                 ber_int_t       bint;
319                 ber_tag_t       tag, rtag;
320
321                 ber_reset( &tmpber, 1 );
322                 rtag = ber_scanf( &tmpber, "{it", /*}*/ &bint, &tag );
323                 switch ( tag ) {
324                 case LDAP_REQ_BIND:
325                         rtag = ber_scanf( &tmpber, "{i" /*}*/, &bint );
326                         break;
327                 case LDAP_REQ_DELETE:
328                         break;
329                 default:
330                         rtag = ber_scanf( &tmpber, "{" /*}*/ );
331                 case LDAP_REQ_ABANDON:
332                         break;
333                 }
334                 if ( tag != LDAP_REQ_ABANDON ) {
335                         ber_skip_tag( &tmpber, &lr->lr_dn.bv_len );
336                         lr->lr_dn.bv_val = tmpber.ber_ptr;
337                 }
338         }
339
340         lr->lr_prev = NULL;
341         lr->lr_next = ld->ld_requests;
342         if ( lr->lr_next != NULL ) {
343                 lr->lr_next->lr_prev = lr;
344         }
345         ld->ld_requests = lr;
346
347         ld->ld_errno = LDAP_SUCCESS;
348         if ( ldap_int_flush_request( ld, lr ) == -1 ) {
349                 msgid = -1;
350         }
351
352         return( msgid );
353 }
354
355 /* return 0 if no StartTLS ext, 1 if present, 2 if critical */
356 static int
357 find_tls_ext( LDAPURLDesc *srv )
358 {
359         int i, crit;
360         char *ext;
361
362         if ( !srv->lud_exts )
363                 return 0;
364
365         for (i=0; srv->lud_exts[i]; i++) {
366                 crit = 0;
367                 ext = srv->lud_exts[i];
368                 if ( ext[0] == '!') {
369                         ext++;
370                         crit = 1;
371                 }
372                 if ( !strcasecmp( ext, "StartTLS" ) ||
373                         !strcasecmp( ext, "X-StartTLS" ) ||
374                         !strcmp( ext, LDAP_EXOP_START_TLS )) {
375                         return crit + 1;
376                 }
377         }
378         return 0;
379 }
380
381 LDAPConn *
382 ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist, int use_ldsb,
383         int connect, LDAPreqinfo *bind )
384 {
385         LDAPConn        *lc;
386         int             async = 0;
387
388         Debug( LDAP_DEBUG_TRACE, "ldap_new_connection %d %d %d\n",
389                 use_ldsb, connect, (bind != NULL) );
390         /*
391          * make a new LDAP server connection
392          * XXX open connection synchronously for now
393          */
394         lc = (LDAPConn *)LDAP_CALLOC( 1, sizeof( LDAPConn ) );
395         if ( lc == NULL ) {
396                 ld->ld_errno = LDAP_NO_MEMORY;
397                 return( NULL );
398         }
399         
400         if ( use_ldsb ) {
401                 assert( ld->ld_sb != NULL );
402                 lc->lconn_sb = ld->ld_sb;
403
404         } else {
405                 lc->lconn_sb = ber_sockbuf_alloc();
406                 if ( lc->lconn_sb == NULL ) {
407                         LDAP_FREE( (char *)lc );
408                         ld->ld_errno = LDAP_NO_MEMORY;
409                         return( NULL );
410                 }
411         }
412
413         if ( connect ) {
414                 LDAPURLDesc     **srvp, *srv = NULL;
415
416                 async = LDAP_BOOL_GET( &ld->ld_options, LDAP_BOOL_CONNECT_ASYNC );
417
418                 for ( srvp = srvlist; *srvp != NULL; srvp = &(*srvp)->lud_next ) {
419                         int             rc;
420
421                         rc = ldap_int_open_connection( ld, lc, *srvp, async );
422                         if ( rc != -1 ) {
423                                 srv = *srvp;
424
425                                 if ( ld->ld_urllist_proc && ( !async || rc != -2 ) ) {
426                                         ld->ld_urllist_proc( ld, srvlist, srvp, ld->ld_urllist_params );
427                                 }
428
429                                 break;
430                         }
431                 }
432
433                 if ( srv == NULL ) {
434                         if ( !use_ldsb ) {
435                                 ber_sockbuf_free( lc->lconn_sb );
436                         }
437                         LDAP_FREE( (char *)lc );
438                         ld->ld_errno = LDAP_SERVER_DOWN;
439                         return( NULL );
440                 }
441
442                 lc->lconn_server = ldap_url_dup( srv );
443         }
444
445         lc->lconn_status = async ? LDAP_CONNST_CONNECTING : LDAP_CONNST_CONNECTED;
446 #ifdef LDAP_R_COMPILE
447         ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
448 #endif
449         lc->lconn_next = ld->ld_conns;
450         ld->ld_conns = lc;
451 #ifdef LDAP_R_COMPILE
452         ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
453 #endif
454
455         if ( connect ) {
456 #ifdef HAVE_TLS
457                 if ( lc->lconn_server->lud_exts ) {
458                         int rc, ext = find_tls_ext( lc->lconn_server );
459                         if ( ext ) {
460                                 LDAPConn        *savedefconn;
461
462                                 savedefconn = ld->ld_defconn;
463                                 ++lc->lconn_refcnt;     /* avoid premature free */
464                                 ld->ld_defconn = lc;
465
466 #ifdef LDAP_R_COMPILE
467                                 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
468                                 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
469 #endif
470                                 rc = ldap_start_tls_s( ld, NULL, NULL );
471 #ifdef LDAP_R_COMPILE
472                                 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
473                                 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
474 #endif
475                                 ld->ld_defconn = savedefconn;
476                                 --lc->lconn_refcnt;
477
478                                 if ( rc != LDAP_SUCCESS && ext == 2 ) {
479                                         ldap_free_connection( ld, lc, 1, 0 );
480                                         return NULL;
481                                 }
482                         }
483                 }
484 #endif
485         }
486
487         if ( bind != NULL ) {
488                 int             err = 0;
489                 LDAPConn        *savedefconn;
490
491                 /* Set flag to prevent additional referrals
492                  * from being processed on this
493                  * connection until the bind has completed
494                  */
495                 lc->lconn_rebind_inprogress = 1;
496                 /* V3 rebind function */
497                 if ( ld->ld_rebind_proc != NULL) {
498                         LDAPURLDesc     *srvfunc;
499
500                         srvfunc = ldap_url_dup( *srvlist );
501                         if ( srvfunc == NULL ) {
502                                 ld->ld_errno = LDAP_NO_MEMORY;
503                                 err = -1;
504                         } else {
505                                 savedefconn = ld->ld_defconn;
506                                 ++lc->lconn_refcnt;     /* avoid premature free */
507                                 ld->ld_defconn = lc;
508
509                                 Debug( LDAP_DEBUG_TRACE, "Call application rebind_proc\n", 0, 0, 0);
510 #ifdef LDAP_R_COMPILE
511                                 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
512                                 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
513 #endif
514                                 err = (*ld->ld_rebind_proc)( ld,
515                                         bind->ri_url, bind->ri_request, bind->ri_msgid,
516                                         ld->ld_rebind_params );
517 #ifdef LDAP_R_COMPILE
518                                 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
519                                 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
520 #endif
521
522                                 ld->ld_defconn = savedefconn;
523                                 --lc->lconn_refcnt;
524
525                                 if ( err != 0 ) {
526                                         err = -1;
527                                         ldap_free_connection( ld, lc, 1, 0 );
528                                         lc = NULL;
529                                 }
530                                 ldap_free_urldesc( srvfunc );
531                         }
532
533                 } else {
534                         int             msgid, rc;
535                         struct berval   passwd = BER_BVNULL;
536
537                         savedefconn = ld->ld_defconn;
538                         ++lc->lconn_refcnt;     /* avoid premature free */
539                         ld->ld_defconn = lc;
540
541                         Debug( LDAP_DEBUG_TRACE,
542                                 "anonymous rebind via ldap_sasl_bind(\"\")\n",
543                                 0, 0, 0);
544
545 #ifdef LDAP_R_COMPILE
546                         ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
547                         ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
548 #endif
549                         rc = ldap_sasl_bind( ld, "", LDAP_SASL_SIMPLE, &passwd,
550                                 NULL, NULL, &msgid );
551                         if ( rc != LDAP_SUCCESS ) {
552                                 err = -1;
553
554                         } else {
555                                 for ( err = 1; err > 0; ) {
556                                         struct timeval  tv = { 0, 100000 };
557                                         LDAPMessage     *res = NULL;
558
559                                         switch ( ldap_result( ld, msgid, LDAP_MSG_ALL, &tv, &res ) ) {
560                                         case -1:
561                                                 err = -1;
562                                                 break;
563
564                                         case 0:
565 #ifdef LDAP_R_COMPILE
566                                                 ldap_pvt_thread_yield();
567 #endif
568                                                 break;
569
570                                         case LDAP_RES_BIND:
571                                                 rc = ldap_parse_result( ld, res, &err, NULL, NULL, NULL, NULL, 1 );
572                                                 if ( rc != LDAP_SUCCESS ) {
573                                                         err = -1;
574
575                                                 } else if ( err != LDAP_SUCCESS ) {
576                                                         err = -1;
577                                                 }
578                                                 /* else err == LDAP_SUCCESS == 0 */
579                                                 break;
580
581                                         default:
582                                                 Debug( LDAP_DEBUG_TRACE,
583                                                         "ldap_new_connection %p: "
584                                                         "unexpected response %d "
585                                                         "from BIND request id=%d\n",
586                                                         (void *) ld, ldap_msgtype( res ), msgid );
587                                                 err = -1;
588                                                 break;
589                                         }
590                                 }
591                         }
592 #ifdef LDAP_R_COMPILE
593                         ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
594                         ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
595 #endif
596                         ld->ld_defconn = savedefconn;
597                         --lc->lconn_refcnt;
598
599                         if ( err != 0 ) {
600                                 ldap_free_connection( ld, lc, 1, 0 );
601                                 lc = NULL;
602                         }
603                 }
604                 if ( lc != NULL )
605                         lc->lconn_rebind_inprogress = 0;
606         }
607
608         return( lc );
609 }
610
611
612 static LDAPConn *
613 find_connection( LDAP *ld, LDAPURLDesc *srv, int any )
614 /*
615  * return an existing connection (if any) to the server srv
616  * if "any" is non-zero, check for any server in the "srv" chain
617  */
618 {
619         LDAPConn        *lc;
620         LDAPURLDesc     *lcu, *lsu;
621         int lcu_port, lsu_port;
622         int found = 0;
623
624 #ifdef LDAP_R_COMPILE
625         ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
626 #endif
627         for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
628                 lcu = lc->lconn_server;
629                 lcu_port = ldap_pvt_url_scheme_port( lcu->lud_scheme,
630                         lcu->lud_port );
631
632                 for ( lsu = srv; lsu != NULL; lsu = lsu->lud_next ) {
633                         lsu_port = ldap_pvt_url_scheme_port( lsu->lud_scheme,
634                                 lsu->lud_port );
635
636                         if ( lsu_port == lcu_port
637                                 && strcmp( lcu->lud_scheme, lsu->lud_scheme ) == 0
638                                 && lcu->lud_host != NULL && lsu->lud_host != NULL
639                                 && strcasecmp( lsu->lud_host, lcu->lud_host ) == 0 )
640                         {
641                                 found = 1;
642                                 break;
643                         }
644
645                         if ( !any ) break;
646                 }
647                 if ( found )
648                         break;
649         }
650 #ifdef LDAP_R_COMPILE
651         ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
652 #endif
653         return lc;
654 }
655
656
657
658 static void
659 use_connection( LDAP *ld, LDAPConn *lc )
660 {
661         ++lc->lconn_refcnt;
662         lc->lconn_lastused = time( NULL );
663 }
664
665
666 void
667 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
668 {
669         LDAPConn        *tmplc, *prevlc;
670
671         Debug( LDAP_DEBUG_TRACE,
672                 "ldap_free_connection %d %d\n",
673                 force, unbind, 0 );
674
675         if ( force || --lc->lconn_refcnt <= 0 ) {
676                 /* remove from connections list first */
677 #ifdef LDAP_R_COMPILE
678                 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
679 #endif
680
681                 for ( prevlc = NULL, tmplc = ld->ld_conns;
682                         tmplc != NULL;
683                         tmplc = tmplc->lconn_next )
684                 {
685                         if ( tmplc == lc ) {
686                                 if ( prevlc == NULL ) {
687                                     ld->ld_conns = tmplc->lconn_next;
688                                 } else {
689                                     prevlc->lconn_next = tmplc->lconn_next;
690                                 }
691                                 if ( ld->ld_defconn == lc ) {
692                                         ld->ld_defconn = NULL;
693                                 }
694                                 break;
695                         }
696                         prevlc = tmplc;
697                 }
698 #ifdef LDAP_R_COMPILE
699                 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
700 #endif
701
702                 /* process connection callbacks */
703                 {
704                         struct ldapoptions *lo;
705                         ldaplist *ll;
706                         ldap_conncb *cb;
707
708                         lo = &ld->ld_options;
709                         if ( lo->ldo_conn_cbs ) {
710                                 for ( ll=lo->ldo_conn_cbs; ll; ll=ll->ll_next ) {
711                                         cb = ll->ll_data;
712                                         cb->lc_del( ld, lc->lconn_sb, cb );
713                                 }
714                         }
715                         lo = LDAP_INT_GLOBAL_OPT();
716                         if ( lo->ldo_conn_cbs ) {
717                                 for ( ll=lo->ldo_conn_cbs; ll; ll=ll->ll_next ) {
718                                         cb = ll->ll_data;
719                                         cb->lc_del( ld, lc->lconn_sb, cb );
720                                 }
721                         }
722                 }
723
724                 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
725                         ldap_mark_select_clear( ld, lc->lconn_sb );
726                         if ( unbind ) {
727                                 ldap_send_unbind( ld, lc->lconn_sb,
728                                                 NULL, NULL );
729                         }
730                 }
731
732                 if ( lc->lconn_ber != NULL ) {
733                         ber_free( lc->lconn_ber, 1 );
734                 }
735
736                 ldap_int_sasl_close( ld, lc );
737 #ifdef HAVE_GSSAPI
738                 ldap_int_gssapi_close( ld, lc );
739 #endif
740
741                 ldap_free_urllist( lc->lconn_server );
742
743                 /* FIXME: is this at all possible?
744                  * ldap_ld_free() in unbind.c calls ldap_free_connection()
745                  * with force == 1 __after__ explicitly calling
746                  * ldap_free_request() on all requests */
747                 if ( force ) {
748                         LDAPRequest     *lr;
749
750                         for ( lr = ld->ld_requests; lr; ) {
751                                 LDAPRequest     *lr_next = lr->lr_next;
752
753                                 if ( lr->lr_conn == lc ) {
754                                         ldap_free_request_int( ld, lr );
755                                 }
756
757                                 lr = lr_next;
758                         }
759                 }
760
761                 if ( lc->lconn_sb != ld->ld_sb ) {
762                         ber_sockbuf_free( lc->lconn_sb );
763                 } else {
764                         ber_int_sb_close( lc->lconn_sb );
765                 }
766
767                 if ( lc->lconn_rebind_queue != NULL) {
768                         int i;
769                         for( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
770                                 LDAP_VFREE( lc->lconn_rebind_queue[i] );
771                         }
772                         LDAP_FREE( lc->lconn_rebind_queue );
773                 }
774
775                 LDAP_FREE( lc );
776
777                 Debug( LDAP_DEBUG_TRACE,
778                         "ldap_free_connection: actually freed\n",
779                         0, 0, 0 );
780
781         } else {
782                 lc->lconn_lastused = time( NULL );
783                 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
784                                 lc->lconn_refcnt, 0, 0 );
785         }
786 }
787
788
789 #ifdef LDAP_DEBUG
790 void
791 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
792 {
793         LDAPConn        *lc;
794         char            timebuf[32];
795
796         Debug( LDAP_DEBUG_TRACE, "** ld %p Connection%s:\n", (void *)ld, all ? "s" : "", 0 );
797         for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
798                 if ( lc->lconn_server != NULL ) {
799                         Debug( LDAP_DEBUG_TRACE, "* host: %s  port: %d%s\n",
800                                 ( lc->lconn_server->lud_host == NULL ) ? "(null)"
801                                 : lc->lconn_server->lud_host,
802                                 lc->lconn_server->lud_port, ( lc->lconn_sb ==
803                                 ld->ld_sb ) ? "  (default)" : "" );
804                 }
805                 Debug( LDAP_DEBUG_TRACE, "  refcnt: %d  status: %s\n", lc->lconn_refcnt,
806                         ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET )
807                                 ? "NeedSocket" :
808                                 ( lc->lconn_status == LDAP_CONNST_CONNECTING )
809                                         ? "Connecting" : "Connected", 0 );
810                 Debug( LDAP_DEBUG_TRACE, "  last used: %s%s\n",
811                         ldap_pvt_ctime( &lc->lconn_lastused, timebuf ),
812                         lc->lconn_rebind_inprogress ? "  rebind in progress" : "", 0 );
813                 if ( lc->lconn_rebind_inprogress ) {
814                         if ( lc->lconn_rebind_queue != NULL) {
815                                 int     i;
816
817                                 for ( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
818                                         int     j;
819                                         for( j = 0; lc->lconn_rebind_queue[i][j] != 0; j++ ) {
820                                                 Debug( LDAP_DEBUG_TRACE, "    queue %d entry %d - %s\n",
821                                                         i, j, lc->lconn_rebind_queue[i][j] );
822                                         }
823                                 }
824                         } else {
825                                 Debug( LDAP_DEBUG_TRACE, "    queue is empty\n", 0, 0, 0 );
826                         }
827                 }
828                 Debug( LDAP_DEBUG_TRACE, "\n", 0, 0, 0 );
829                 if ( !all ) {
830                         break;
831                 }
832         }
833 }
834
835
836 void
837 ldap_dump_requests_and_responses( LDAP *ld )
838 {
839         LDAPRequest     *lr;
840         LDAPMessage     *lm, *l;
841         int             i;
842
843         Debug( LDAP_DEBUG_TRACE, "** ld %p Outstanding Requests:\n",
844                 (void *)ld, 0, 0 );
845         lr = ld->ld_requests;
846         if ( lr == NULL ) {
847                 Debug( LDAP_DEBUG_TRACE, "   Empty\n", 0, 0, 0 );
848         }
849         for ( i = 0; lr != NULL; lr = lr->lr_next, i++ ) {
850                 Debug( LDAP_DEBUG_TRACE, " * msgid %d,  origid %d, status %s\n",
851                         lr->lr_msgid, lr->lr_origid,
852                         ( lr->lr_status == LDAP_REQST_INPROGRESS ) ? "InProgress" :
853                         ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
854                         ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
855                         ( lr->lr_status == LDAP_REQST_WRITING ) ? "Writing" :
856                         ( lr->lr_status == LDAP_REQST_COMPLETED ) ? "RequestCompleted"
857                                 : "InvalidStatus" );
858                 Debug( LDAP_DEBUG_TRACE, "   outstanding referrals %d, parent count %d\n",
859                         lr->lr_outrefcnt, lr->lr_parentcnt, 0 );
860         }
861         Debug( LDAP_DEBUG_TRACE, "  ld %p request count %d (abandoned %lu)\n",
862                 (void *)ld, i, ld->ld_nabandoned );
863         Debug( LDAP_DEBUG_TRACE, "** ld %p Response Queue:\n", (void *)ld, 0, 0 );
864         if ( ( lm = ld->ld_responses ) == NULL ) {
865                 Debug( LDAP_DEBUG_TRACE, "   Empty\n", 0, 0, 0 );
866         }
867         for ( i = 0; lm != NULL; lm = lm->lm_next, i++ ) {
868                 Debug( LDAP_DEBUG_TRACE, " * msgid %d,  type %lu\n",
869                     lm->lm_msgid, (unsigned long)lm->lm_msgtype, 0 );
870                 if ( lm->lm_chain != NULL ) {
871                         Debug( LDAP_DEBUG_TRACE, "   chained responses:\n", 0, 0, 0 );
872                         for ( l = lm->lm_chain; l != NULL; l = l->lm_chain ) {
873                                 Debug( LDAP_DEBUG_TRACE,
874                                         "  * msgid %d,  type %lu\n",
875                                         l->lm_msgid,
876                                         (unsigned long)l->lm_msgtype, 0 );
877                         }
878                 }
879         }
880         Debug( LDAP_DEBUG_TRACE, "  ld %p response count %d\n", (void *)ld, i, 0 );
881 }
882 #endif /* LDAP_DEBUG */
883
884 static void
885 ldap_free_request_int( LDAP *ld, LDAPRequest *lr )
886 {
887         /* if lr_refcnt > 0, the request has been looked up 
888          * by ldap_find_request_by_msgid(); if in the meanwhile
889          * the request is free()'d by someone else, just decrease
890          * the reference count and extract it from the request
891          * list; later on, it will be freed. */
892         if ( lr->lr_prev == NULL ) {
893                 if ( lr->lr_refcnt == 0 ) {
894                         /* free'ing the first request? */
895                         assert( ld->ld_requests == lr );
896                 }
897
898                 if ( ld->ld_requests == lr ) {
899                         ld->ld_requests = lr->lr_next;
900                 }
901
902         } else {
903                 lr->lr_prev->lr_next = lr->lr_next;
904         }
905
906         if ( lr->lr_next != NULL ) {
907                 lr->lr_next->lr_prev = lr->lr_prev;
908         }
909
910         if ( lr->lr_refcnt > 0 ) {
911                 lr->lr_refcnt = -lr->lr_refcnt;
912
913                 lr->lr_prev = NULL;
914                 lr->lr_next = NULL;
915
916                 return;
917         }
918
919         if ( lr->lr_ber != NULL ) {
920                 ber_free( lr->lr_ber, 1 );
921                 lr->lr_ber = NULL;
922         }
923
924         if ( lr->lr_res_error != NULL ) {
925                 LDAP_FREE( lr->lr_res_error );
926                 lr->lr_res_error = NULL;
927         }
928
929         if ( lr->lr_res_matched != NULL ) {
930                 LDAP_FREE( lr->lr_res_matched );
931                 lr->lr_res_matched = NULL;
932         }
933
934         LDAP_FREE( lr );
935 }
936
937 void
938 ldap_free_request( LDAP *ld, LDAPRequest *lr )
939 {
940 #ifdef LDAP_R_COMPILE
941         LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
942 #endif
943
944         Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
945                 lr->lr_origid, lr->lr_msgid, 0 );
946
947         /* free all referrals (child requests) */
948         while ( lr->lr_child ) {
949                 ldap_free_request( ld, lr->lr_child );
950         }
951
952         if ( lr->lr_parent != NULL ) {
953                 LDAPRequest     **lrp;
954
955                 --lr->lr_parent->lr_outrefcnt;
956                 for ( lrp = &lr->lr_parent->lr_child;
957                         *lrp && *lrp != lr;
958                         lrp = &(*lrp)->lr_refnext );
959
960                 if ( *lrp == lr ) {
961                         *lrp = lr->lr_refnext;
962                 }
963         }
964         ldap_free_request_int( ld, lr );
965 }
966
967 /*
968  * call first time with *cntp = -1
969  * when returns *cntp == -1, no referrals are left
970  *
971  * NOTE: may replace *refsp, or shuffle the contents
972  * of the original array.
973  */
974 static int ldap_int_nextref(
975         LDAP                    *ld,
976         char                    ***refsp,
977         int                     *cntp,
978         void                    *params )
979 {
980         assert( refsp != NULL );
981         assert( *refsp != NULL );
982         assert( cntp != NULL );
983
984         if ( *cntp < -1 ) {
985                 *cntp = -1;
986                 return -1;
987         }
988
989         (*cntp)++;
990
991         if ( (*refsp)[ *cntp ] == NULL ) {
992                 *cntp = -1;
993         }
994
995         return 0;
996 }
997
998 /*
999  * Chase v3 referrals
1000  *
1001  * Parameters:
1002  *  (IN) ld = LDAP connection handle
1003  *  (IN) lr = LDAP Request structure
1004  *  (IN) refs = array of pointers to referral strings that we will chase
1005  *              The array will be free'd by this function when no longer needed
1006  *  (IN) sref != 0 if following search reference
1007  *  (OUT) errstrp = Place to return a string of referrals which could not be followed
1008  *  (OUT) hadrefp = 1 if sucessfully followed referral
1009  *
1010  * Return value - number of referrals followed
1011  */
1012 int
1013 ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, int sref, char **errstrp, int *hadrefp )
1014 {
1015         char            *unfollowed;
1016         int              unfollowedcnt = 0;
1017         LDAPRequest     *origreq;
1018         LDAPURLDesc     *srv = NULL;
1019         BerElement      *ber;
1020         char            **refarray = NULL;
1021         LDAPConn        *lc;
1022         int                      rc, count, i, j, id;
1023         LDAPreqinfo  rinfo;
1024
1025         ld->ld_errno = LDAP_SUCCESS;    /* optimistic */
1026         *hadrefp = 0;
1027
1028         Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referrals\n", 0, 0, 0 );
1029
1030         unfollowed = NULL;
1031         rc = count = 0;
1032
1033         /* If no referrals in array, return */
1034         if ( (refs == NULL) || ( (refs)[0] == NULL) ) {
1035                 rc = 0;
1036                 goto done;
1037         }
1038
1039         /* Check for hop limit exceeded */
1040         if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1041                 Debug( LDAP_DEBUG_ANY,
1042                     "more than %d referral hops (dropping)\n", ld->ld_refhoplimit, 0, 0 );
1043                 ld->ld_errno = LDAP_REFERRAL_LIMIT_EXCEEDED;
1044                 rc = -1;
1045                 goto done;
1046         }
1047
1048         /* find original request */
1049         for ( origreq = lr;
1050                 origreq->lr_parent != NULL;
1051                 origreq = origreq->lr_parent )
1052         {
1053                 /* empty */ ;
1054         }
1055
1056         refarray = refs;
1057         refs = NULL;
1058
1059         if ( ld->ld_nextref_proc == NULL ) {
1060                 ld->ld_nextref_proc = ldap_int_nextref;
1061         }
1062
1063         /* parse out & follow referrals */
1064         i = -1;
1065         for ( ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params );
1066                         i != -1;
1067                         ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params ) )
1068         {
1069
1070                 /* Parse the referral URL */
1071                 rc = ldap_url_parse_ext( refarray[i], &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1072                 if ( rc != LDAP_URL_SUCCESS ) {
1073                         /* ldap_url_parse_ext() returns LDAP_URL_* errors
1074                          * which do not map on API errors */
1075                         ld->ld_errno = LDAP_PARAM_ERROR;
1076                         rc = -1;
1077                         goto done;
1078                 }
1079
1080                 if( srv->lud_crit_exts ) {
1081                         int ok = 0;
1082 #ifdef HAVE_TLS
1083                         /* If StartTLS is the only critical ext, OK. */
1084                         if ( find_tls_ext( srv ) == 2 && srv->lud_crit_exts == 1 )
1085                                 ok = 1;
1086 #endif
1087                         if ( !ok ) {
1088                                 /* we do not support any other extensions */
1089                                 ld->ld_errno = LDAP_NOT_SUPPORTED;
1090                                 rc = -1;
1091                                 goto done;
1092                         }
1093                 }
1094
1095                 /* check connection for re-bind in progress */
1096                 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1097                         /* See if we've already requested this DN with this conn */
1098                         LDAPRequest *lp;
1099                         int looped = 0;
1100                         ber_len_t len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1101                         for ( lp = origreq; lp; ) {
1102                                 if ( lp->lr_conn == lc
1103                                         && len == lp->lr_dn.bv_len
1104                                         && len
1105                                         && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) == 0 )
1106                                 {
1107                                         looped = 1;
1108                                         break;
1109                                 }
1110                                 if ( lp == origreq ) {
1111                                         lp = lp->lr_child;
1112                                 } else {
1113                                         lp = lp->lr_refnext;
1114                                 }
1115                         }
1116                         if ( looped ) {
1117                                 ldap_free_urllist( srv );
1118                                 srv = NULL;
1119                                 ld->ld_errno = LDAP_CLIENT_LOOP;
1120                                 rc = -1;
1121                                 continue;
1122                         }
1123
1124                         if ( lc->lconn_rebind_inprogress ) {
1125                                 /* We are already chasing a referral or search reference and a
1126                                  * bind on that connection is in progress.  We must queue
1127                                  * referrals on that connection, so we don't get a request
1128                                  * going out before the bind operation completes. This happens
1129                                  * if two search references come in one behind the other
1130                                  * for the same server with different contexts.
1131                                  */
1132                                 Debug( LDAP_DEBUG_TRACE,
1133                                         "ldap_chase_v3referrals: queue referral \"%s\"\n",
1134                                         refarray[i], 0, 0);
1135                                 if( lc->lconn_rebind_queue == NULL ) {
1136                                         /* Create a referral list */
1137                                         lc->lconn_rebind_queue =
1138                                                 (char ***) LDAP_MALLOC( sizeof(void *) * 2);
1139
1140                                         if( lc->lconn_rebind_queue == NULL) {
1141                                                 ld->ld_errno = LDAP_NO_MEMORY;
1142                                                 rc = -1;
1143                                                 goto done;
1144                                         }
1145
1146                                         lc->lconn_rebind_queue[0] = refarray;
1147                                         lc->lconn_rebind_queue[1] = NULL;
1148                                         refarray = NULL;
1149
1150                                 } else {
1151                                         /* Count how many referral arrays we already have */
1152                                         for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
1153                                                 /* empty */;
1154                                         }
1155
1156                                         /* Add the new referral to the list */
1157                                         lc->lconn_rebind_queue = (char ***) LDAP_REALLOC(
1158                                                 lc->lconn_rebind_queue, sizeof(void *) * (j + 2));
1159
1160                                         if( lc->lconn_rebind_queue == NULL ) {
1161                                                 ld->ld_errno = LDAP_NO_MEMORY;
1162                                                 rc = -1;
1163                                                 goto done;
1164                                         }
1165                                         lc->lconn_rebind_queue[j] = refarray;
1166                                         lc->lconn_rebind_queue[j+1] = NULL;
1167                                         refarray = NULL;
1168                                 }
1169
1170                                 /* We have queued the referral/reference, now just return */
1171                                 rc = 0;
1172                                 *hadrefp = 1;
1173                                 count = 1; /* Pretend we already followed referral */
1174                                 goto done;
1175                         }
1176                 } 
1177                 /* Re-encode the request with the new starting point of the search.
1178                  * Note: In the future we also need to replace the filter if one
1179                  * was provided with the search reference
1180                  */
1181
1182                 /* For references we don't want old dn if new dn empty */
1183                 if ( sref && srv->lud_dn == NULL ) {
1184                         srv->lud_dn = LDAP_STRDUP( "" );
1185                 }
1186
1187                 LDAP_NEXT_MSGID( ld, id );
1188                 ber = re_encode_request( ld, origreq->lr_ber, id,
1189                         sref, srv, &rinfo.ri_request );
1190
1191                 if( ber == NULL ) {
1192                         ld->ld_errno = LDAP_ENCODING_ERROR;
1193                         rc = -1;
1194                         goto done;
1195                 }
1196
1197                 Debug( LDAP_DEBUG_TRACE,
1198                         "ldap_chase_v3referral: msgid %d, url \"%s\"\n",
1199                         lr->lr_msgid, refarray[i], 0);
1200
1201                 /* Send the new request to the server - may require a bind */
1202                 rinfo.ri_msgid = origreq->lr_origid;
1203                 rinfo.ri_url = refarray[i];
1204 #ifdef LDAP_R_COMPILE
1205                 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1206 #endif
1207                 rc = ldap_send_server_request( ld, ber, id,
1208                         origreq, &srv, NULL, &rinfo );
1209 #ifdef LDAP_R_COMPILE
1210                 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1211 #endif
1212                 if ( rc < 0 ) {
1213                         /* Failure, try next referral in the list */
1214                         Debug( LDAP_DEBUG_ANY, "Unable to chase referral \"%s\" (%d: %s)\n", 
1215                                 refarray[i], ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1216                         unfollowedcnt += ldap_append_referral( ld, &unfollowed, refarray[i] );
1217                         ldap_free_urllist( srv );
1218                         srv = NULL;
1219                         ld->ld_errno = LDAP_REFERRAL;
1220                 } else {
1221                         /* Success, no need to try this referral list further */
1222                         rc = 0;
1223                         ++count;
1224                         *hadrefp = 1;
1225
1226                         /* check if there is a queue of referrals that came in during bind */
1227                         if ( lc == NULL) {
1228                                 lc = find_connection( ld, srv, 1 );
1229                                 if ( lc == NULL ) {
1230                                         ld->ld_errno = LDAP_OPERATIONS_ERROR;
1231                                         rc = -1;
1232                                         goto done;
1233                                 }
1234                         }
1235
1236                         if ( lc->lconn_rebind_queue != NULL ) {
1237                                 /* Release resources of previous list */
1238                                 LDAP_VFREE( refarray );
1239                                 refarray = NULL;
1240                                 ldap_free_urllist( srv );
1241                                 srv = NULL;
1242
1243                                 /* Pull entries off end of queue so list always null terminated */
1244                                 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++ )
1245                                         ;
1246                                 refarray = lc->lconn_rebind_queue[j - 1];
1247                                 lc->lconn_rebind_queue[j-1] = NULL;
1248                                 /* we pulled off last entry from queue, free queue */
1249                                 if ( j == 1 ) {
1250                                         LDAP_FREE( lc->lconn_rebind_queue );
1251                                         lc->lconn_rebind_queue = NULL;
1252                                 }
1253                                 /* restart the loop the with new referral list */
1254                                 i = -1;
1255                                 continue;
1256                         }
1257                         break; /* referral followed, break out of for loop */
1258                 }
1259         } /* end for loop */
1260 done:
1261         LDAP_VFREE( refarray );
1262         ldap_free_urllist( srv );
1263         LDAP_FREE( *errstrp );
1264         
1265         if( rc == 0 ) {
1266                 *errstrp = NULL;
1267                 LDAP_FREE( unfollowed );
1268                 return count;
1269         } else {
1270                 *errstrp = unfollowed;
1271                 return rc;
1272         }
1273 }
1274
1275 /*
1276  * XXX merging of errors in this routine needs to be improved
1277  */
1278 int
1279 ldap_chase_referrals( LDAP *ld,
1280         LDAPRequest *lr,
1281         char **errstrp,
1282         int sref,
1283         int *hadrefp )
1284 {
1285         int             rc, count, id;
1286         unsigned        len;
1287         char            *p, *ref, *unfollowed;
1288         LDAPRequest     *origreq;
1289         LDAPURLDesc     *srv;
1290         BerElement      *ber;
1291         LDAPreqinfo  rinfo;
1292         LDAPConn        *lc;
1293
1294         Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
1295
1296         ld->ld_errno = LDAP_SUCCESS;    /* optimistic */
1297         *hadrefp = 0;
1298
1299         if ( *errstrp == NULL ) {
1300                 return( 0 );
1301         }
1302
1303         len = strlen( *errstrp );
1304         for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
1305                 if ( strncasecmp( p, LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
1306                         *p = '\0';
1307                         p += LDAP_REF_STR_LEN;
1308                         break;
1309                 }
1310         }
1311
1312         if ( len < LDAP_REF_STR_LEN ) {
1313                 return( 0 );
1314         }
1315
1316         if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1317                 Debug( LDAP_DEBUG_ANY,
1318                     "more than %d referral hops (dropping)\n",
1319                     ld->ld_refhoplimit, 0, 0 );
1320                     /* XXX report as error in ld->ld_errno? */
1321                     return( 0 );
1322         }
1323
1324         /* find original request */
1325         for ( origreq = lr; origreq->lr_parent != NULL;
1326              origreq = origreq->lr_parent ) {
1327                 /* empty */;
1328         }
1329
1330         unfollowed = NULL;
1331         rc = count = 0;
1332
1333         /* parse out & follow referrals */
1334         for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
1335                 p = strchr( ref, '\n' );
1336                 if ( p != NULL ) {
1337                         *p++ = '\0';
1338                 }
1339
1340                 rc = ldap_url_parse_ext( ref, &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1341                 if ( rc != LDAP_URL_SUCCESS ) {
1342                         Debug( LDAP_DEBUG_TRACE,
1343                                 "ignoring %s referral <%s>\n",
1344                                 ref, rc == LDAP_URL_ERR_BADSCHEME ? "unknown" : "incorrect", 0 );
1345                         rc = ldap_append_referral( ld, &unfollowed, ref );
1346                         *hadrefp = 1;
1347                         continue;
1348                 }
1349
1350                 Debug( LDAP_DEBUG_TRACE,
1351                     "chasing LDAP referral: <%s>\n", ref, 0, 0 );
1352
1353                 *hadrefp = 1;
1354
1355                 /* See if we've already been here */
1356                 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1357                         LDAPRequest *lp;
1358                         int looped = 0;
1359                         ber_len_t len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1360                         for ( lp = lr; lp; lp = lp->lr_parent ) {
1361                                 if ( lp->lr_conn == lc
1362                                         && len == lp->lr_dn.bv_len )
1363                                 {
1364                                         if ( len && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) )
1365                                                         continue;
1366                                         looped = 1;
1367                                         break;
1368                                 }
1369                         }
1370                         if ( looped ) {
1371                                 ldap_free_urllist( srv );
1372                                 ld->ld_errno = LDAP_CLIENT_LOOP;
1373                                 rc = -1;
1374                                 continue;
1375                         }
1376                 }
1377
1378                 LDAP_NEXT_MSGID( ld, id );
1379                 ber = re_encode_request( ld, origreq->lr_ber,
1380                     id, sref, srv, &rinfo.ri_request );
1381
1382                 if ( ber == NULL ) {
1383                         return -1 ;
1384                 }
1385
1386                 /* copy the complete referral for rebind process */
1387                 rinfo.ri_url = LDAP_STRDUP( ref );
1388
1389                 rinfo.ri_msgid = origreq->lr_origid;
1390
1391 #ifdef LDAP_R_COMPILE
1392                 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1393 #endif
1394                 rc = ldap_send_server_request( ld, ber, id,
1395                         lr, &srv, NULL, &rinfo );
1396 #ifdef LDAP_R_COMPILE
1397                 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1398 #endif
1399
1400                 LDAP_FREE( rinfo.ri_url );
1401
1402                 if( rc >= 0 ) {
1403                         ++count;
1404                 } else {
1405                         Debug( LDAP_DEBUG_ANY,
1406                                 "Unable to chase referral \"%s\" (%d: %s)\n", 
1407                                 ref, ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1408                         rc = ldap_append_referral( ld, &unfollowed, ref );
1409                 }
1410
1411                 ldap_free_urllist(srv);
1412         }
1413
1414         LDAP_FREE( *errstrp );
1415         *errstrp = unfollowed;
1416
1417         return(( rc == 0 ) ? count : rc );
1418 }
1419
1420
1421 int
1422 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
1423 {
1424         int     first;
1425
1426         if ( *referralsp == NULL ) {
1427                 first = 1;
1428                 *referralsp = (char *)LDAP_MALLOC( strlen( s ) + LDAP_REF_STR_LEN
1429                     + 1 );
1430         } else {
1431                 first = 0;
1432                 *referralsp = (char *)LDAP_REALLOC( *referralsp,
1433                     strlen( *referralsp ) + strlen( s ) + 2 );
1434         }
1435
1436         if ( *referralsp == NULL ) {
1437                 ld->ld_errno = LDAP_NO_MEMORY;
1438                 return( -1 );
1439         }
1440
1441         if ( first ) {
1442                 strcpy( *referralsp, LDAP_REF_STR );
1443         } else {
1444                 strcat( *referralsp, "\n" );
1445         }
1446         strcat( *referralsp, s );
1447
1448         return( 0 );
1449 }
1450
1451
1452
1453 static BerElement *
1454 re_encode_request( LDAP *ld,
1455         BerElement *origber,
1456         ber_int_t msgid,
1457         int sref,
1458         LDAPURLDesc *srv,
1459         int *type )
1460 {
1461         /*
1462          * XXX this routine knows way too much about how the lber library works!
1463          */
1464         ber_int_t       along;
1465         ber_tag_t       tag;
1466         ber_tag_t       rtag;
1467         ber_int_t       ver;
1468         ber_int_t       scope;
1469         int             rc;
1470         BerElement      tmpber, *ber;
1471         struct berval           dn;
1472
1473         Debug( LDAP_DEBUG_TRACE,
1474             "re_encode_request: new msgid %ld, new dn <%s>\n",
1475             (long) msgid,
1476                 ( srv == NULL || srv->lud_dn == NULL) ? "NONE" : srv->lud_dn, 0 );
1477
1478         tmpber = *origber;
1479
1480         /*
1481          * all LDAP requests are sequences that start with a message id.
1482          * For all except delete, this is followed by a sequence that is
1483          * tagged with the operation code.  For delete, the provided DN
1484          * is not wrapped by a sequence.
1485          */
1486         rtag = ber_scanf( &tmpber, "{it", /*}*/ &along, &tag );
1487
1488         if ( rtag == LBER_ERROR ) {
1489                 ld->ld_errno = LDAP_DECODING_ERROR;
1490                 return( NULL );
1491         }
1492
1493         assert( tag != 0);
1494         if ( tag == LDAP_REQ_BIND ) {
1495                 /* bind requests have a version number before the DN & other stuff */
1496                 rtag = ber_scanf( &tmpber, "{im" /*}*/, &ver, &dn );
1497
1498         } else if ( tag == LDAP_REQ_DELETE ) {
1499                 /* delete requests don't have a DN wrapping sequence */
1500                 rtag = ber_scanf( &tmpber, "m", &dn );
1501
1502         } else if ( tag == LDAP_REQ_SEARCH ) {
1503                 /* search requests need to be re-scope-ed */
1504                 rtag = ber_scanf( &tmpber, "{me" /*"}"*/, &dn, &scope );
1505
1506                 if( srv->lud_scope != LDAP_SCOPE_DEFAULT ) {
1507                         /* use the scope provided in reference */
1508                         scope = srv->lud_scope;
1509
1510                 } else if ( sref ) {
1511                         /* use scope implied by previous operation
1512                          *   base -> base
1513                          *   one -> base
1514                          *   subtree -> subtree
1515                          *   subordinate -> subtree
1516                          */
1517                         switch( scope ) {
1518                         default:
1519                         case LDAP_SCOPE_BASE:
1520                         case LDAP_SCOPE_ONELEVEL:
1521                                 scope = LDAP_SCOPE_BASE;
1522                                 break;
1523                         case LDAP_SCOPE_SUBTREE:
1524                         case LDAP_SCOPE_SUBORDINATE:
1525                                 scope = LDAP_SCOPE_SUBTREE;
1526                                 break;
1527                         }
1528                 }
1529
1530         } else {
1531                 rtag = ber_scanf( &tmpber, "{m" /*}*/, &dn );
1532         }
1533
1534         if( rtag == LBER_ERROR ) {
1535                 ld->ld_errno = LDAP_DECODING_ERROR;
1536                 return NULL;
1537         }
1538
1539         /* restore character zero'd out by ber_scanf*/
1540         dn.bv_val[dn.bv_len] = tmpber.ber_tag;
1541
1542         if (( ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
1543                 return NULL;
1544         }
1545
1546         if ( srv->lud_dn ) {
1547                 ber_str2bv( srv->lud_dn, 0, 0, &dn );
1548         }
1549
1550         if ( tag == LDAP_REQ_BIND ) {
1551                 rc = ber_printf( ber, "{it{iO" /*}}*/, msgid, tag, ver, &dn );
1552         } else if ( tag == LDAP_REQ_DELETE ) {
1553                 rc = ber_printf( ber, "{itON}", msgid, tag, &dn );
1554         } else if ( tag == LDAP_REQ_SEARCH ) {
1555                 rc = ber_printf( ber, "{it{Oe" /*}}*/, msgid, tag, &dn, scope );
1556         } else {
1557                 rc = ber_printf( ber, "{it{O" /*}}*/, msgid, tag, &dn );
1558         }
1559
1560         if ( rc == -1 ) {
1561                 ld->ld_errno = LDAP_ENCODING_ERROR;
1562                 ber_free( ber, 1 );
1563                 return NULL;
1564         }
1565
1566         if ( tag != LDAP_REQ_DELETE && (
1567                 ber_write(ber, tmpber.ber_ptr, ( tmpber.ber_end - tmpber.ber_ptr ), 0)
1568                 != ( tmpber.ber_end - tmpber.ber_ptr ) ||
1569             ber_printf( ber, /*{{*/ "N}N}" ) == -1 ) )
1570         {
1571                 ld->ld_errno = LDAP_ENCODING_ERROR;
1572                 ber_free( ber, 1 );
1573                 return NULL;
1574         }
1575
1576 #ifdef LDAP_DEBUG
1577         if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
1578                 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
1579                     0, 0, 0 );
1580                 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ber, 0 );
1581         }
1582 #endif /* LDAP_DEBUG */
1583
1584         *type = tag;    /* return request type */
1585         return ber;
1586 }
1587
1588
1589 LDAPRequest *
1590 ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid )
1591 {
1592         LDAPRequest     *lr;
1593
1594 #ifdef LDAP_R_COMPILE
1595         ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1596 #endif
1597         for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1598                 if ( lr->lr_status == LDAP_REQST_COMPLETED ) {
1599                         continue;       /* Skip completed requests */
1600                 }
1601                 if ( msgid == lr->lr_msgid ) {
1602                         lr->lr_refcnt++;
1603                         break;
1604                 }
1605         }
1606 #ifdef LDAP_R_COMPILE
1607         ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1608 #endif
1609
1610         return( lr );
1611 }
1612
1613 void
1614 ldap_return_request( LDAP *ld, LDAPRequest *lrx, int freeit )
1615 {
1616         LDAPRequest     *lr;
1617
1618 #ifdef LDAP_R_COMPILE
1619         ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1620 #endif
1621         for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1622                 if ( lr == lrx ) {
1623                         if ( lr->lr_refcnt > 0 ) {
1624                                 lr->lr_refcnt--;
1625
1626                         } else if ( lr->lr_refcnt < 0 ) {
1627                                 lr->lr_refcnt++;
1628                                 if ( lr->lr_refcnt == 0 ) {
1629                                         lr = NULL;
1630                                 }
1631                         }
1632                         break;
1633                 }
1634         }
1635         if ( lr == NULL ) {
1636                 ldap_free_request_int( ld, lrx );
1637
1638         } else if ( freeit ) {
1639                 ldap_free_request( ld, lrx );
1640         }
1641 #ifdef LDAP_R_COMPILE
1642         ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1643 #endif
1644 }