]> git.sur5r.net Git - openldap/blob - libraries/libldap/request.c
bb6c9df78dc71ceefec03e8f60cf6d531dfd9344
[openldap] / libraries / libldap / request.c
1 /* $OpenLDAP$ */
2 /*
3  * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
4  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
5  */
6 /*  Portions
7  *  Copyright (c) 1995 Regents of the University of Michigan.
8  *  All rights reserved.
9  */
10 /*---
11  * This notice applies to changes, created by or for Novell, Inc.,
12  * to preexisting works for which notices appear elsewhere in this file.
13  *
14  * Copyright (C) 1999, 2000 Novell, Inc. All Rights Reserved.
15  *
16  * THIS WORK IS SUBJECT TO U.S. AND INTERNATIONAL COPYRIGHT LAWS AND TREATIES.
17  * USE, MODIFICATION, AND REDISTRIBUTION OF THIS WORK IS SUBJECT TO VERSION
18  * 2.0.1 OF THE OPENLDAP PUBLIC LICENSE, A COPY OF WHICH IS AVAILABLE AT
19  * HTTP://WWW.OPENLDAP.ORG/LICENSE.HTML OR IN THE FILE "LICENSE" IN THE
20  * TOP-LEVEL DIRECTORY OF THE DISTRIBUTION. ANY USE OR EXPLOITATION OF THIS
21  * WORK OTHER THAN AS AUTHORIZED IN VERSION 2.0.1 OF THE OPENLDAP PUBLIC
22  * LICENSE, OR OTHER PRIOR WRITTEN CONSENT FROM NOVELL, COULD SUBJECT THE
23  * PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY. 
24  *---
25  * Modification to OpenLDAP source by Novell, Inc.
26  * April 2000 sfs  Added code to chase V3 referrals
27  *  request.c - sending of ldap requests; handling of referrals
28  */
29
30 #include "portable.h"
31
32 #include <stdio.h>
33
34 #include <ac/stdlib.h>
35
36 #include <ac/errno.h>
37 #include <ac/socket.h>
38 #include <ac/string.h>
39 #include <ac/time.h>
40 #include <ac/unistd.h>
41
42 #include "ldap-int.h"
43 #include "lber.h"
44
45 static LDAPConn *find_connection LDAP_P(( LDAP *ld, LDAPURLDesc *srv, int any ));
46 static void use_connection LDAP_P(( LDAP *ld, LDAPConn *lc ));
47
48 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
49 static LDAPURLDesc *dn2servers LDAP_P(( LDAP *ld, const char *dn ));
50 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
51
52 static BerElement *re_encode_request LDAP_P((
53         LDAP *ld,
54         BerElement *origber,
55     ber_int_t msgid,
56         char **dnp,
57         int      *type));
58
59
60 BerElement *
61 ldap_alloc_ber_with_options( LDAP *ld )
62 {
63         BerElement      *ber;
64
65     if (( ber = ber_alloc_t( ld->ld_lberoptions )) == NULL ) {
66                 ld->ld_errno = LDAP_NO_MEMORY;
67 #ifdef STR_TRANSLATION
68         } else {
69                 ldap_set_ber_options( ld, ber );
70 #endif /* STR_TRANSLATION */
71         }
72
73         return( ber );
74 }
75
76
77 void
78 ldap_set_ber_options( LDAP *ld, BerElement *ber )
79 {
80         ber->ber_options = ld->ld_lberoptions;
81 #ifdef STR_TRANSLATION
82         if (( ld->ld_lberoptions & LBER_TRANSLATE_STRINGS ) != 0 ) {
83                 ber_set_string_translators( ber,
84                     ld->ld_lber_encode_translate_proc,
85                     ld->ld_lber_decode_translate_proc );
86         }
87 #endif /* STR_TRANSLATION */
88 }
89
90
91 ber_int_t
92 ldap_send_initial_request(
93         LDAP *ld,
94         ber_tag_t msgtype,
95         const char *dn,
96         BerElement *ber )
97 {
98         LDAPURLDesc     *servers;
99         int rc;
100
101         Debug( LDAP_DEBUG_TRACE, "ldap_send_initial_request\n", 0, 0, 0 );
102
103         if ( ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, NULL ) == -1 ) {
104                 /* not connected yet */
105                 int rc = ldap_open_defconn( ld );
106
107                 if( rc < 0 ) {
108                         ber_free( ber, 1 );
109                         return( -1 );
110                 }
111
112                 Debug( LDAP_DEBUG_TRACE,
113                         "ldap_delayed_open successful, ld_host is %s\n",
114                         ( ld->ld_host == NULL ) ? "(null)" : ld->ld_host, 0, 0 );
115         }
116
117 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
118         if ( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_DNS )
119                 && ldap_is_dns_dn( dn ) )
120         {
121                 if (( servers = dn2servers( ld, dn )) == NULL ) {
122                         ber_free( ber, 1 );
123                         return( -1 );
124                 }
125
126 #ifdef LDAP_DEBUG
127                 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
128                         LDAPURLDesc     *srv;
129
130                         for (   srv = servers;
131                                         srv != NULL;
132                                 srv = srv->lud_next )
133                         {
134                                 fprintf( stderr,
135                                     "LDAP server %s:  dn %s, port %d\n",
136                                     srv->lud_host, ( srv->lud_dn == NULL ) ?
137                                     "(default)" : srv->lud_dn,
138                                     srv->lud_port );
139                         }
140                 }
141 #endif /* LDAP_DEBUG */
142         } else
143 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
144         {
145                 /*
146                  * use of DNS is turned off or this is an X.500 DN...
147                  * use our default connection
148                  */
149                 servers = NULL;
150         }       
151
152         rc = ldap_send_server_request( ld, ber, ld->ld_msgid, NULL,
153                                                                         servers, NULL, NULL );
154         if (servers)
155                 ldap_free_urllist(servers);
156         return(rc);
157 }
158
159
160
161 int
162 ldap_send_server_request(
163         LDAP *ld,
164         BerElement *ber,
165         ber_int_t msgid,
166         LDAPRequest *parentreq,
167         LDAPURLDesc *srvlist,
168         LDAPConn *lc,
169         LDAPreqinfo *bind )
170 {
171         LDAPRequest     *lr;
172         int incparent;
173
174         Debug( LDAP_DEBUG_TRACE, "ldap_send_server_request\n", 0, 0, 0 );
175
176         incparent = 0;
177         ld->ld_errno = LDAP_SUCCESS;    /* optimistic */
178
179         if ( lc == NULL ) {
180                 if ( srvlist == NULL ) {
181                         lc = ld->ld_defconn;
182                 } else {
183                         if (( lc = find_connection( ld, srvlist, 1 )) ==
184                             NULL ) {
185                                 if ( (bind != NULL) && (parentreq != NULL) ) {
186                                         /* Remember the bind in the parent */
187                                         incparent = 1;
188                                         ++parentreq->lr_outrefcnt;
189                                 }
190                                 lc = ldap_new_connection( ld, srvlist, 0, 1, bind );
191                         }
192                 }
193         }
194
195         if ( lc == NULL || lc->lconn_status != LDAP_CONNST_CONNECTED ) {
196                 ber_free( ber, 1 );
197                 if ( ld->ld_errno == LDAP_SUCCESS ) {
198                         ld->ld_errno = LDAP_SERVER_DOWN;
199                 }
200                 if ( incparent ) {
201                         /* Forget about the bind */
202                         --parentreq->lr_outrefcnt; 
203                 }
204                 return( -1 );
205         }
206
207         use_connection( ld, lc );
208         if (( lr = (LDAPRequest *)LDAP_CALLOC( 1, sizeof( LDAPRequest ))) ==
209             NULL ) {
210                 ld->ld_errno = LDAP_NO_MEMORY;
211                 ldap_free_connection( ld, lc, 0, 0 );
212                 ber_free( ber, 1 );
213                 if ( incparent ) {
214                         /* Forget about the bind */
215                         --parentreq->lr_outrefcnt; 
216                 }
217                 return( -1 );
218         } 
219         lr->lr_msgid = msgid;
220         lr->lr_status = LDAP_REQST_INPROGRESS;
221         lr->lr_res_errno = LDAP_SUCCESS;        /* optimistic */
222         lr->lr_ber = ber;
223         lr->lr_conn = lc;
224         if ( parentreq != NULL ) {      /* sub-request */
225                 if ( !incparent ) { 
226                         /* Increment if we didn't do it before the bind */
227                         ++parentreq->lr_outrefcnt;
228                 }
229                 lr->lr_origid = parentreq->lr_origid;
230                 lr->lr_parentcnt = parentreq->lr_parentcnt + 1;
231                 lr->lr_parent = parentreq;
232                 lr->lr_refnext = parentreq->lr_refnext;
233                 parentreq->lr_refnext = lr;
234         } else {                        /* original request */
235                 lr->lr_origid = lr->lr_msgid;
236         }
237
238         if (( lr->lr_next = ld->ld_requests ) != NULL ) {
239                 lr->lr_next->lr_prev = lr;
240         }
241         ld->ld_requests = lr;
242         lr->lr_prev = NULL;
243
244         if ( ber_flush( lc->lconn_sb, ber, 0 ) != 0 ) {
245 #ifdef notyet
246                 if ( errno == EWOULDBLOCK ) {
247                         /* need to continue write later */
248                         lr->lr_status = LDAP_REQST_WRITING;
249                         ldap_mark_select_write( ld, lc->lconn_sb );
250                 } else {
251 #else /* notyet */
252                         ld->ld_errno = LDAP_SERVER_DOWN;
253                         ldap_free_request( ld, lr );
254                         ldap_free_connection( ld, lc, 0, 0 );
255                         return( -1 );
256 #endif /* notyet */
257 #ifdef notyet
258                 }
259 #endif /* notyet */
260         } else {
261                 if ( parentreq == NULL ) {
262                         ber->ber_end = ber->ber_ptr;
263                         ber->ber_ptr = ber->ber_buf;
264                 }
265
266                 /* sent -- waiting for a response */
267                 ldap_mark_select_read( ld, lc->lconn_sb );
268         }
269
270         ld->ld_errno = LDAP_SUCCESS;
271         return( msgid );
272 }
273
274 LDAPConn *
275 ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb,
276         int connect, LDAPreqinfo *bind )
277 {
278         LDAPConn        *lc;
279         LDAPURLDesc     *srv;
280         Sockbuf         *sb;
281
282         Debug( LDAP_DEBUG_TRACE, "ldap_new_connection\n", 0, 0, 0 );
283         /*
284          * make a new LDAP server connection
285          * XXX open connection synchronously for now
286          */
287         if (( lc = (LDAPConn *)LDAP_CALLOC( 1, sizeof( LDAPConn ))) == NULL ||
288             ( !use_ldsb && ( (sb = ber_sockbuf_alloc()) == NULL ))) {
289                 if ( lc != NULL ) {
290                         LDAP_FREE( (char *)lc );
291                 }
292                 ld->ld_errno = LDAP_NO_MEMORY;
293                 return( NULL );
294         }
295
296         lc->lconn_sb = ( use_ldsb ) ? ld->ld_sb : sb;
297
298         if ( connect ) {
299                 for ( srv = srvlist; srv != NULL; srv = srv->lud_next ) {
300                         if ( open_ldap_connection( ld, lc->lconn_sb,
301                                         srv, &lc->lconn_krbinstance, 0 ) != -1 )
302                         {
303                                 break;
304                         }
305                 }
306
307                 if ( srv == NULL ) {
308                         if ( !use_ldsb ) {
309                                 ber_sockbuf_free( lc->lconn_sb );
310                         }
311                     LDAP_FREE( (char *)lc );
312                     ld->ld_errno = LDAP_SERVER_DOWN;
313                     return( NULL );
314                 }
315
316                 lc->lconn_server = ldap_url_dup(srv);
317         }
318
319         lc->lconn_status = LDAP_CONNST_CONNECTED;
320         lc->lconn_next = ld->ld_conns;
321         ld->ld_conns = lc;
322
323         /*
324          * XXX for now, we always do a synchronous bind.  This will have
325          * to change in the long run...
326          */
327         if ( bind != NULL) {
328                 int             err = 0;
329                 LDAPConn        *savedefconn;
330
331                 /* Set flag to prevent additional referrals from being processed on this
332                  * connection until the bind has completed
333                  */
334                 lc->lconn_rebind_inprogress = 1;
335                 /* V3 rebind function */
336                 if ( ld->ld_rebindproc != NULL) {
337                         LDAPURLDesc     *srvfunc;
338                         if( ( srvfunc = ldap_url_dup( srvlist)) == NULL) {
339                                 ld->ld_errno = LDAP_NO_MEMORY;
340                                 err = -1;
341                         } else {
342                                 savedefconn = ld->ld_defconn;
343                                 ++lc->lconn_refcnt;     /* avoid premature free */
344                                 ld->ld_defconn = lc;
345
346                                 Debug( LDAP_DEBUG_TRACE, "Call application rebindproc\n", 0, 0, 0);
347                                 err = (*ld->ld_rebindproc)( ld, bind->ri_url, bind->ri_request, bind->ri_msgid);
348
349                                 ld->ld_defconn = savedefconn;
350                                 --lc->lconn_refcnt;
351
352                                 if( err != 0) {
353                                 err = -1;
354                                         ldap_free_connection( ld, lc, 1, 0 );
355                                         lc = NULL;
356                         }
357                                 ldap_free_urldesc( srvfunc);
358                 }
359                 } else {
360                         savedefconn = ld->ld_defconn;
361                         ++lc->lconn_refcnt;     /* avoid premature free */
362                         ld->ld_defconn = lc;
363
364                         Debug( LDAP_DEBUG_TRACE, "anonymous rebind via ldap_bind_s\n", 0, 0, 0);
365                         if ( ldap_bind_s( ld, "", "", LDAP_AUTH_SIMPLE ) != LDAP_SUCCESS ) {
366                                 err = -1;
367                         }
368                         ld->ld_defconn = savedefconn;
369                         --lc->lconn_refcnt;
370
371                 if ( err != 0 ) {
372                         ldap_free_connection( ld, lc, 1, 0 );
373                         lc = NULL;
374                 }
375         }
376                 if( lc != NULL)
377                         lc->lconn_rebind_inprogress = 0;
378         }
379
380         return( lc );
381 }
382
383
384 static LDAPConn *
385 find_connection( LDAP *ld, LDAPURLDesc *srv, int any )
386 /*
387  * return an existing connection (if any) to the server srv
388  * if "any" is non-zero, check for any server in the "srv" chain
389  */
390 {
391         LDAPConn        *lc;
392         LDAPURLDesc     *ls;
393
394         for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
395                 for ( ls = srv; ls != NULL; ls = ls->lud_next ) {
396                         if ( lc->lconn_server->lud_host != NULL &&
397                             ls->lud_host != NULL && strcasecmp(
398                             ls->lud_host, lc->lconn_server->lud_host ) == 0
399                             && ls->lud_port == lc->lconn_server->lud_port ) {
400                                 return( lc );
401                         }
402                         if ( !any ) {
403                                 break;
404                         }
405                 }
406         }
407
408         return( NULL );
409 }
410
411
412
413 static void
414 use_connection( LDAP *ld, LDAPConn *lc )
415 {
416         ++lc->lconn_refcnt;
417         lc->lconn_lastused = time( NULL );
418 }
419
420
421 void
422 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
423 {
424         LDAPConn        *tmplc, *prevlc;
425
426         Debug( LDAP_DEBUG_TRACE, "ldap_free_connection\n", 0, 0, 0 );
427
428         if ( force || --lc->lconn_refcnt <= 0 ) {
429                 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
430                         ldap_mark_select_clear( ld, lc->lconn_sb );
431                         if ( unbind ) {
432                                 ldap_send_unbind( ld, lc->lconn_sb, NULL, NULL );
433                         }
434                 }
435
436                 if( lc->lconn_ber != NULL ) {
437                         ber_free( lc->lconn_ber, 1 );
438                 }
439
440                 prevlc = NULL;
441                 for ( tmplc = ld->ld_conns; tmplc != NULL;
442                     tmplc = tmplc->lconn_next ) {
443                         if ( tmplc == lc ) {
444                                 if ( prevlc == NULL ) {
445                                     ld->ld_conns = tmplc->lconn_next;
446                                 } else {
447                                     prevlc->lconn_next = tmplc->lconn_next;
448                                 }
449                                 break;
450                         }
451                         prevlc = tmplc;
452                 }
453                 ldap_free_urllist( lc->lconn_server );
454                 if ( lc->lconn_krbinstance != NULL ) {
455                         LDAP_FREE( lc->lconn_krbinstance );
456                 }
457                 if ( lc->lconn_sb != ld->ld_sb ) {
458                         ber_sockbuf_free( lc->lconn_sb );
459                 }
460                 if( lc->lconn_rebind_queue != NULL) {
461                         int i;
462                         for( i = 0; lc->lconn_rebind_queue[i] != NULL; i++) {
463                                 free_strarray(lc->lconn_rebind_queue[i]);
464                         }
465                         LDAP_FREE( lc->lconn_rebind_queue);
466                 }
467                 LDAP_FREE( lc );
468                 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: actually freed\n",
469                     0, 0, 0 );
470         } else {
471                 lc->lconn_lastused = time( NULL );
472                 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
473                     lc->lconn_refcnt, 0, 0 );
474         }
475 }
476
477
478 #ifdef LDAP_DEBUG
479 void
480 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
481 {
482         LDAPConn        *lc;
483         char            timebuf[32];
484
485         fprintf( stderr, "** Connection%s:\n", all ? "s" : "" );
486         for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
487                 if ( lc->lconn_server != NULL ) {
488                         fprintf( stderr, "* host: %s  port: %d%s\n",
489                             ( lc->lconn_server->lud_host == NULL ) ? "(null)"
490                             : lc->lconn_server->lud_host,
491                             lc->lconn_server->lud_port, ( lc->lconn_sb ==
492                             ld->ld_sb ) ? "  (default)" : "" );
493                 }
494                 fprintf( stderr, "  refcnt: %d  status: %s\n", lc->lconn_refcnt,
495                     ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET ) ?
496                     "NeedSocket" : ( lc->lconn_status ==
497                     LDAP_CONNST_CONNECTING ) ? "Connecting" : "Connected" );
498                 fprintf( stderr, "  last used: %s",
499                     ldap_pvt_ctime( &lc->lconn_lastused, timebuf ));
500                 if( lc->lconn_rebind_inprogress ) {
501                         fprintf( stderr, "  rebind in progress\n");
502                         if( lc->lconn_rebind_queue != NULL) {
503                                 int i = 0;
504                                 for( ;lc->lconn_rebind_queue[i] != NULL; i++) {
505                                         int j = 0;
506                                         for( ;lc->lconn_rebind_queue[i][j] != 0; j++) {
507                                                 fprintf( stderr, "    queue %d entry %d - %s\n",
508                                                         i, j, lc->lconn_rebind_queue[i][j]);
509                                         }
510                                 }
511                         } else {
512                                 fprintf( stderr, "    queue is empty\n");
513                         }
514                 }
515                 fprintf(stderr, "\n");
516                 if ( !all ) {
517                         break;
518                 }
519         }
520 }
521
522
523 void
524 ldap_dump_requests_and_responses( LDAP *ld )
525 {
526         LDAPRequest     *lr;
527         LDAPMessage     *lm, *l;
528
529         fprintf( stderr, "** Outstanding Requests:\n" );
530         if (( lr = ld->ld_requests ) == NULL ) {
531                 fprintf( stderr, "   Empty\n" );
532         }
533         for ( ; lr != NULL; lr = lr->lr_next ) {
534             fprintf( stderr, " * msgid %d,  origid %d, status %s\n",
535                 lr->lr_msgid, lr->lr_origid,
536                 ( lr->lr_status == LDAP_REQST_INPROGRESS ) ? "InProgress" :
537                 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
538                 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
539                 ( lr->lr_status == LDAP_REQST_WRITING) ? "Writing" :
540                 ( lr->lr_status == LDAP_REQST_COMPLETED ? "Request Completed" : "Invalid Status"));
541             fprintf( stderr, "   outstanding referrals %d, parent count %d\n",
542                     lr->lr_outrefcnt, lr->lr_parentcnt );
543         }
544
545         fprintf( stderr, "** Response Queue:\n" );
546         if (( lm = ld->ld_responses ) == NULL ) {
547                 fprintf( stderr, "   Empty\n" );
548         }
549         for ( ; lm != NULL; lm = lm->lm_next ) {
550                 fprintf( stderr, " * msgid %d,  type %lu\n",
551                     lm->lm_msgid, (unsigned long) lm->lm_msgtype );
552                 if (( l = lm->lm_chain ) != NULL ) {
553                         fprintf( stderr, "   chained responses:\n" );
554                         for ( ; l != NULL; l = l->lm_chain ) {
555                                 fprintf( stderr,
556                                     "  * msgid %d,  type %lu\n",
557                                     l->lm_msgid,
558                                     (unsigned long) l->lm_msgtype );
559                         }
560                 }
561         }
562 }
563 #endif /* LDAP_DEBUG */
564
565
566 void
567 ldap_free_request( LDAP *ld, LDAPRequest *lr )
568 {
569         LDAPRequest     *tmplr, *nextlr;
570
571         Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
572                 lr->lr_origid, lr->lr_msgid, 0 );
573
574         if ( lr->lr_parent != NULL ) {
575                 --lr->lr_parent->lr_outrefcnt;
576         } else {
577                 /* free all referrals (child requests) */
578                 for ( tmplr = lr->lr_refnext; tmplr != NULL; tmplr = nextlr ) {
579                         nextlr = tmplr->lr_refnext;
580                         ldap_free_request( ld, tmplr );
581                 }
582         }
583
584         if ( lr->lr_prev == NULL ) {
585                 ld->ld_requests = lr->lr_next;
586         } else {
587                 lr->lr_prev->lr_next = lr->lr_next;
588         }
589
590         if ( lr->lr_next != NULL ) {
591                 lr->lr_next->lr_prev = lr->lr_prev;
592         }
593
594         if ( lr->lr_ber != NULL ) {
595                 ber_free( lr->lr_ber, 1 );
596         }
597
598         if ( lr->lr_res_error != NULL ) {
599                 LDAP_FREE( lr->lr_res_error );
600         }
601
602         if ( lr->lr_res_matched != NULL ) {
603                 LDAP_FREE( lr->lr_res_matched );
604         }
605
606         LDAP_FREE( lr );
607 }
608
609 /*
610  * Chase v3 referrals
611  *
612  * Parameters:
613  *  (IN) ld = LDAP connection handle
614  *  (IN) lr = LDAP Request structure
615  *  (IN) refs = array of pointers to referral strings that we will chase
616  *              The array will be free'd by this function when no longer needed
617  *  (OUT) errstrp = Place to return a string of referrals which could not be followed
618  *  (OUT) hadrefp = 1 if sucessfully followed referral
619  *
620  * Return value - number of referrals followed
621  */
622 LIBLDAP_F(int)
623 ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, char **errstrp, int *hadrefp )
624 {
625         char            *unfollowed;
626         int                      unfollowedcnt = 0;
627         LDAPRequest     *origreq;
628         LDAPURLDesc     *srv = NULL;
629         BerElement      *ber;
630         char            **refarray = NULL;
631         LDAPConn        *lc;
632         int                      rc, count, i, j;
633         LDAPreqinfo  rinfo;
634
635         ld->ld_errno = LDAP_SUCCESS;    /* optimistic */
636         *hadrefp = 0;
637
638         Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referrals\n", 0, 0, 0 );
639
640         unfollowed = NULL;
641         rc = count = 0;
642
643         /* If no referrals in array, return */
644         if ( (refs == NULL) || ( (refs)[0] == NULL) ) {
645                 rc = 0;
646                 goto done;
647         }
648
649         /* Check for hop limit exceeded */
650         if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
651                 Debug( LDAP_DEBUG_ANY,
652                     "more than %d referral hops (dropping)\n", ld->ld_refhoplimit, 0, 0 );
653                 ld->ld_errno = LDAP_REFERRAL_LIMIT_EXCEEDED;
654             rc = -1;
655                 goto done;
656         }
657
658         /* find original request */
659         for ( origreq = lr; origreq->lr_parent != NULL; origreq = origreq->lr_parent ) {
660                 ;
661         }
662
663         refarray = refs;
664         refs = NULL;
665         /* parse out & follow referrals */
666         for( i=0; refarray[i] != NULL; i++) {
667                 /* Parse the referral URL */
668                 if (( rc = ldap_url_parse( refarray[i], &srv)) != LDAP_SUCCESS) {
669                         ld->ld_errno = rc;
670                         rc = -1;
671                         goto done;
672                 }
673
674                 /* treat ldap://hostpart and ldap://hostpart/ the same */
675                 if ( srv->lud_dn && srv->lud_dn[0] == '\0' ) {
676                         LDAP_FREE( srv->lud_dn );
677                         srv->lud_dn = NULL;
678                 }
679
680                 /* check connection for re-bind in progress */
681                 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
682                         if( lc->lconn_rebind_inprogress) {
683                                 /* We are already chasing a referral or search reference and a
684                                  * bind on that connection is in progress.  We must queue
685                                  * referrals on that connection, so we don't get a request
686                                  * going out before the bind operation completes. This happens
687                                  * if two search references come in one behind the other
688                                  * for the same server with different contexts.
689                                  */
690                                 Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referrals: queue referral \"%s\"\n",
691                                         refarray[i], 0, 0);
692                                 if( lc->lconn_rebind_queue == NULL ) {
693                                         /* Create a referral list */
694                                         if( (lc->lconn_rebind_queue = (char ***)LDAP_MALLOC( sizeof(void *) * 2)) == NULL) {
695                                                 ld->ld_errno = LDAP_NO_MEMORY;
696                                                 rc = -1;
697                                                 goto done;
698                                         }
699                                         lc->lconn_rebind_queue[0] = refarray;
700                                         lc->lconn_rebind_queue[1] = NULL;
701                                         refarray = NULL;
702                                 } else {
703                                         /* Count how many referral arrays we already have */
704                                         for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
705                                                 ;
706                                         }
707                                         /* Add the new referral to the list */
708                                         if( (lc->lconn_rebind_queue = (char ***)LDAP_REALLOC(
709                                                         lc->lconn_rebind_queue, sizeof(void *) * (j + 2))) == NULL) {
710                                                 ld->ld_errno = LDAP_NO_MEMORY;
711                                                 rc = -1;
712                                                 goto done;
713                                         }
714                                         lc->lconn_rebind_queue[j] = refarray;
715                                         lc->lconn_rebind_queue[j+1] = NULL;
716                                         refarray = NULL;
717                                 }
718                                 /* We have queued the referral/reference, now just return */
719                                 rc = 0;
720                                 *hadrefp = 1;
721                                 count = 1; /* Pretend we already followed referral */
722                                 goto done;
723                         }
724                 } 
725                 /* Re-encode the request with the new starting point of the search.
726                  * Note: In the future we also need to replace the filter if one
727                  * was provided with the search reference
728                  */
729                 if (( ber = re_encode_request( ld, origreq->lr_ber,
730                             ++ld->ld_msgid, &srv->lud_dn, &rinfo.ri_request )) == NULL ) {
731                         ld->ld_errno = LDAP_ENCODING_ERROR;
732                         rc = -1;
733                         goto done;
734                 }
735
736                 Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referral: msgid %d, url \"%s\"\n",
737                         lr->lr_msgid, refarray[i], 0);
738
739                 /* Send the new request to the server - may require a bind */
740                 rinfo.ri_msgid = origreq->lr_origid;
741                 rinfo.ri_url = refarray[i];
742                 if ( (rc = ldap_send_server_request( ld, ber, ld->ld_msgid,
743                         origreq, srv, NULL, &rinfo )) < 0 ) {
744                         /* Failure, try next referral in the list */
745                         Debug( LDAP_DEBUG_ANY, "Unable to chase referral \"%s\" (%s)\n", 
746                                 refarray[i], ldap_err2string( ld->ld_errno ), 0);
747                         unfollowedcnt += ldap_append_referral( ld, &unfollowed, refarray[i]);
748                         ldap_free_urllist(srv);
749                         srv = NULL;
750                 } else {
751                         /* Success, no need to try this referral list further */
752                         rc = 0;
753                         ++count;
754                         *hadrefp = 1;
755
756                         /* check if there is a queue of referrals that came in during bind */
757                         if( lc == NULL) {
758                                 if (( lc = find_connection( ld, srv, 1 )) == NULL ) {
759                                         ld->ld_errno = LDAP_OPERATIONS_ERROR;
760                                         rc = -1;
761                                         goto done;
762                                 }
763                         }
764
765                         if( lc->lconn_rebind_queue != NULL) {
766                                 /* Release resources of previous list */
767                                 free_strarray(refarray);
768                                 refarray = NULL;
769                                 ldap_free_urllist(srv);
770                                 srv = NULL;
771
772                                 /* Pull entries off end of queue so list always null terminated */
773                                 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
774                                         ;
775                                 }
776                                 refarray = lc->lconn_rebind_queue[j-1];
777                                 lc->lconn_rebind_queue[j-1] = NULL;
778                                 /* we pulled off last entry from queue, free queue */
779                                 if ( j == 1 ) {
780                                         LDAP_FREE( lc->lconn_rebind_queue);
781                                         lc->lconn_rebind_queue = NULL;
782                                 }
783                                 /* restart the loop the with new referral list */
784                                 i = -1;
785                                 continue;
786                         }
787                         break; /* referral followed, break out of for loop */
788                 }
789         } /* end for loop */
790 done:
791         free_strarray(refarray);
792         ldap_free_urllist(srv);
793         LDAP_FREE( *errstrp );
794         
795         if( rc == 0) {
796                 *errstrp = NULL;
797                 LDAP_FREE( unfollowed );
798                 return count;
799         } else {
800                 ld->ld_errno = LDAP_REFERRAL;
801                 *errstrp = unfollowed;
802                 return rc;
803         }
804 }
805
806 /*
807  * XXX merging of errors in this routine needs to be improved
808  */
809 int
810 ldap_chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp )
811 {
812         int             rc, count, len, newdn;
813 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
814         int             ldapref;
815 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
816         char            *p, *ports, *ref, *tmpref, *refdn, *unfollowed;
817         LDAPRequest     *origreq;
818         LDAPURLDesc     *srv;
819         BerElement      *ber;
820         LDAPreqinfo  rinfo;
821
822         Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
823
824         ld->ld_errno = LDAP_SUCCESS;    /* optimistic */
825         *hadrefp = 0;
826
827         if ( *errstrp == NULL ) {
828                 return( 0 );
829         }
830
831         len = strlen( *errstrp );
832         for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
833                 if (( *p == 'R' || *p == 'r' ) && strncasecmp( p,
834                     LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
835                         *p = '\0';
836                         p += LDAP_REF_STR_LEN;
837                         break;
838                 }
839         }
840
841         if ( len < LDAP_REF_STR_LEN ) {
842                 return( 0 );
843         }
844
845         if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
846                 Debug( LDAP_DEBUG_ANY,
847                     "more than %d referral hops (dropping)\n",
848                     ld->ld_refhoplimit, 0, 0 );
849                     /* XXX report as error in ld->ld_errno? */
850                     return( 0 );
851         }
852
853         /* find original request */
854         for ( origreq = lr; origreq->lr_parent != NULL;
855              origreq = origreq->lr_parent ) {
856                 ;
857         }
858
859         unfollowed = NULL;
860         rc = count = 0;
861
862         /* parse out & follow referrals */
863         for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
864 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
865                 ldapref = 0;
866 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
867
868                 if (( p = strchr( ref, '\n' )) != NULL ) {
869                         *p++ = '\0';
870                 } else {
871                         p = NULL;
872                 }
873
874                 ldap_pvt_hex_unescape( ref );
875                 len = strlen( ref );
876
877                 if ( len > LDAP_LDAP_REF_STR_LEN && strncasecmp( ref,
878                     LDAP_LDAP_REF_STR, LDAP_LDAP_REF_STR_LEN ) == 0 ) {
879                         Debug( LDAP_DEBUG_TRACE,
880                             "chasing LDAP referral: <%s>\n", ref, 0, 0 );
881 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
882                         ldapref = 1;
883 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
884                         tmpref = ref + LDAP_LDAP_REF_STR_LEN;
885 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
886                 } else if ( len > LDAP_DX_REF_STR_LEN && strncasecmp( ref,
887                     LDAP_DX_REF_STR, LDAP_DX_REF_STR_LEN ) == 0 ) {
888                         Debug( LDAP_DEBUG_TRACE,
889                             "chasing DX referral: <%s>\n", ref, 0, 0 );
890                         tmpref = ref + LDAP_DX_REF_STR_LEN;
891 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
892                 } else {
893                         Debug( LDAP_DEBUG_TRACE,
894                             "ignoring unknown referral <%s>\n", ref, 0, 0 );
895                         rc = ldap_append_referral( ld, &unfollowed, ref );
896                         *hadrefp = 1;
897                         continue;
898                 }
899
900                 /* copy the complete referral for rebind process */
901                 rinfo.ri_url = LDAP_STRDUP( ref );
902
903                 *hadrefp = 1;
904
905                 if (( refdn = strchr( tmpref, '/' )) != NULL ) {
906                         *refdn++ = '\0';
907                         newdn = refdn[0] != '?' && refdn[0] != '\0';
908                         if( !newdn ) refdn = NULL;
909                 } else {
910                         newdn = 0;
911                 }
912
913                 if (( ber = re_encode_request( ld, origreq->lr_ber,
914                     ++ld->ld_msgid, &refdn, &rinfo.ri_request )) == NULL ) {
915                         return( -1 );
916                 }
917
918 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
919                 if ( ldapref ) {
920 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
921                         if (( srv = (LDAPURLDesc *)LDAP_CALLOC( 1,
922                             sizeof( LDAPURLDesc ))) == NULL ) {
923                                 ber_free( ber, 1 );
924                                 ld->ld_errno = LDAP_NO_MEMORY;
925                                 return( -1 );
926                         }
927
928                         if (( srv->lud_host = LDAP_STRDUP( tmpref )) == NULL ) {
929                                 LDAP_FREE( (char *)srv );
930                                 ber_free( ber, 1 );
931                                 ld->ld_errno = LDAP_NO_MEMORY;
932                                 return( -1 );
933                         }
934
935                         if (( ports = strchr( srv->lud_host, ':' )) != NULL ) {
936                                 *ports++ = '\0';
937                                 srv->lud_port = atoi( ports );
938                         } else {
939                                 srv->lud_port = ldap_int_global_options.ldo_defport;
940                         }
941 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
942                 } else {
943                         srv = dn2servers( ld, tmpref );
944                 }
945 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
946
947                 rinfo.ri_msgid = origreq->lr_origid;
948                 if ( srv != NULL && ldap_send_server_request( ld, ber, ld->ld_msgid,
949                     lr, srv, NULL, &rinfo ) >= 0 ) {
950                         ++count;
951                 } else {
952                         Debug( LDAP_DEBUG_ANY,
953                             "Unable to chase referral (%s)\n", 
954                             ldap_err2string( ld->ld_errno ), 0, 0 );
955                         rc = ldap_append_referral( ld, &unfollowed, ref );
956                 }
957                 LDAP_FREE( rinfo.ri_url);
958
959                 if (srv != NULL)
960                         ldap_free_urllist(srv);
961
962                 if ( !newdn && refdn != NULL ) {
963                         LDAP_FREE( refdn );
964                 }
965         }
966
967         LDAP_FREE( *errstrp );
968         *errstrp = unfollowed;
969
970         return(( rc == 0 ) ? count : rc );
971 }
972
973
974 int
975 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
976 {
977         int     first;
978
979         if ( *referralsp == NULL ) {
980                 first = 1;
981                 *referralsp = (char *)LDAP_MALLOC( strlen( s ) + LDAP_REF_STR_LEN
982                     + 1 );
983         } else {
984                 first = 0;
985                 *referralsp = (char *)LDAP_REALLOC( *referralsp,
986                     strlen( *referralsp ) + strlen( s ) + 2 );
987         }
988
989         if ( *referralsp == NULL ) {
990                 ld->ld_errno = LDAP_NO_MEMORY;
991                 return( -1 );
992         }
993
994         if ( first ) {
995                 strcpy( *referralsp, LDAP_REF_STR );
996         } else {
997                 strcat( *referralsp, "\n" );
998         }
999         strcat( *referralsp, s );
1000
1001         return( 0 );
1002 }
1003
1004
1005
1006 static BerElement *
1007 re_encode_request( LDAP *ld, BerElement *origber, ber_int_t msgid, char **dnp, int *type )
1008 {
1009 /*
1010  * XXX this routine knows way too much about how the lber library works!
1011  */
1012         ber_int_t       along;
1013         ber_tag_t       tag;
1014         ber_int_t       ver;
1015         int             rc;
1016         BerElement      tmpber, *ber;
1017         char            *orig_dn;
1018
1019         Debug( LDAP_DEBUG_TRACE,
1020             "re_encode_request: new msgid %ld, new dn <%s>\n",
1021             (long) msgid, ( *dnp == NULL ) ? "NONE" : *dnp, 0 );
1022
1023         tmpber = *origber;
1024
1025         /*
1026          * all LDAP requests are sequences that start with a message id.
1027          * For all except delete, this is followed by a sequence that is
1028          * tagged with the operation code.  For delete, the provided DN
1029          * is not wrapped by a sequence.
1030          */
1031         rc = ber_scanf( &tmpber, "{it", /*}*/ &along, &tag );
1032
1033         if ( rc == LBER_ERROR ) {
1034                 ld->ld_errno = LDAP_DECODING_ERROR;
1035                 return( NULL );
1036         }
1037
1038         assert( tag != 0);
1039         if ( tag == LDAP_REQ_BIND ) {
1040                 /* bind requests have a version number before the DN & other stuff */
1041                 rc = ber_scanf( &tmpber, "{ia" /*}*/, &ver, &orig_dn );
1042
1043         } else if ( tag == LDAP_REQ_DELETE ) {
1044                 /* delete requests don't have a DN wrapping sequence */
1045                 rc = ber_scanf( &tmpber, "a", &orig_dn );
1046
1047         } else {
1048                 rc = ber_scanf( &tmpber, "{a" /*}*/, &orig_dn );
1049         }
1050
1051         if( rc == LBER_ERROR ) {
1052                 ld->ld_errno = LDAP_DECODING_ERROR;
1053                 return NULL;
1054         }
1055
1056         if ( *dnp == NULL ) {
1057                 *dnp = orig_dn;
1058         } else {
1059                 LDAP_FREE( orig_dn );
1060         }
1061
1062         if (( ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
1063                 return( NULL );
1064         }
1065
1066         if ( tag == LDAP_REQ_BIND ) {
1067                 rc = ber_printf( ber, "{it{is" /*}}*/, msgid, tag, ver, *dnp );
1068         } else if ( tag == LDAP_REQ_DELETE ) {
1069                 rc = ber_printf( ber, "{its}", msgid, tag, *dnp );
1070         } else {
1071                 rc = ber_printf( ber, "{it{s" /*}}*/, msgid, tag, *dnp );
1072         }
1073
1074         if ( rc == -1 ) {
1075                 ld->ld_errno = LDAP_ENCODING_ERROR;
1076                 ber_free( ber, 1 );
1077                 return( NULL );
1078         }
1079
1080         if ( tag != LDAP_REQ_DELETE && (
1081                 ber_write(ber, tmpber.ber_ptr, ( tmpber.ber_end - tmpber.ber_ptr ), 0)
1082                 != ( tmpber.ber_end - tmpber.ber_ptr ) ||
1083             ber_printf( ber, /*{{*/ "}}" ) == -1 ) )
1084         {
1085                 ld->ld_errno = LDAP_ENCODING_ERROR;
1086                 ber_free( ber, 1 );
1087                 return( NULL );
1088         }
1089
1090 #ifdef LDAP_DEBUG
1091         if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
1092                 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
1093                     0, 0, 0 );
1094                 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ber, 0 );
1095         }
1096 #endif /* LDAP_DEBUG */
1097
1098         *type = tag;    /* return request type */
1099         return( ber );
1100 }
1101
1102
1103 LDAPRequest *
1104 ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid )
1105 {
1106         LDAPRequest     *lr;
1107
1108         for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1109                 if( lr->lr_status == LDAP_REQST_COMPLETED ) {
1110                         continue;       /* Skip completed requests */
1111                 }
1112                 if ( msgid == lr->lr_msgid ) {
1113                         break;
1114                 }
1115         }
1116
1117         return( lr );
1118 }
1119
1120
1121 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
1122 static LDAPURLDesc *
1123 dn2servers( LDAP *ld, const char *dn )  /* dn can also be a domain.... */
1124 {
1125         char            *p, *host, *server_dn, **dxs;
1126         const char *domain;
1127         int             i, port;
1128         LDAPURLDesc     *srvlist, *prevsrv, *srv;
1129
1130         if (( domain = strrchr( dn, '@' )) != NULL ) {
1131                 ++domain;
1132         } else {
1133                 domain = dn;
1134         }
1135
1136         if (( dxs = ldap_getdxbyname( domain )) == NULL ) {
1137                 ld->ld_errno = LDAP_NO_MEMORY;
1138                 return( NULL );
1139         }
1140
1141         srvlist = NULL;
1142         for ( i = 0; dxs[ i ] != NULL; ++i ) {
1143                 if (ldap_url_parselist(&srv, dxs[i]) == LDAP_SUCCESS
1144                         || ldap_url_parsehosts(&srv, dxs[i]) == LDAP_SUCCESS)
1145                 {
1146                         /* add to end of list of servers */
1147                         if ( srvlist == NULL ) {
1148                                 srvlist = srv;
1149                         } else {
1150                                 prevsrv->lud_next = srv;
1151                         }
1152                         prevsrv = srv;
1153                 }
1154         }
1155
1156         ldap_value_free( dxs );
1157
1158         if ( srvlist == NULL ) {
1159                 ld->ld_errno = LDAP_SERVER_DOWN;
1160         }
1161
1162         return( srvlist );
1163 }
1164 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */