2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2006 The OpenLDAP Foundation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted only as authorized by the OpenLDAP
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>.
15 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
16 * All rights reserved.
18 /* This notice applies to changes, created by or for Novell, Inc.,
19 * to preexisting works for which notices appear elsewhere in this file.
21 * Copyright (C) 1999, 2000 Novell, Inc. All Rights Reserved.
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.
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
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.
45 #include <ac/stdlib.h>
48 #include <ac/socket.h>
49 #include <ac/string.h>
51 #include <ac/unistd.h>
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 ));
61 re_encode_request( LDAP *ld,
69 ldap_alloc_ber_with_options( LDAP *ld )
73 ber = ber_alloc_t( ld->ld_lberoptions );
75 ld->ld_errno = LDAP_NO_MEMORY;
83 ldap_set_ber_options( LDAP *ld, BerElement *ber )
85 ber->ber_options = ld->ld_lberoptions;
90 ldap_send_initial_request(
99 Debug( LDAP_DEBUG_TRACE, "ldap_send_initial_request\n", 0, 0, 0 );
101 #ifdef LDAP_R_COMPILE
102 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
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 );
109 #ifdef LDAP_R_COMPILE
110 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
115 } else if ( rc == 0 ) {
116 Debug( LDAP_DEBUG_TRACE,
117 "ldap_open_defconn: successful\n",
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);
129 if (msgtype != LDAP_REQ_ABANDON && msgtype != LDAP_REQ_SEARCH)
130 return LDAP_PARAM_ERROR;
133 #ifdef LDAP_R_COMPILE
134 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
136 rc = ldap_send_server_request( ld, ber, msgid, NULL,
138 #ifdef LDAP_R_COMPILE
139 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
146 ldap_int_flush_request(
150 LDAPConn *lc = lr->lr_conn;
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;
160 ld->ld_errno = LDAP_SERVER_DOWN;
161 ldap_free_request( ld, lr );
162 ldap_free_connection( ld, lc, 0, 0 );
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;
170 lr->lr_status = LDAP_REQST_INPROGRESS;
172 /* sent -- waiting for a response */
173 ldap_mark_select_read( ld, lc->lconn_sb );
179 ldap_send_server_request(
183 LDAPRequest *parentreq,
184 LDAPURLDesc **srvlist,
191 Debug( LDAP_DEBUG_TRACE, "ldap_send_server_request\n", 0, 0, 0 );
194 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
197 if ( srvlist == NULL ) {
200 lc = find_connection( ld, *srvlist, 1 );
202 if ( (bind != NULL) && (parentreq != NULL) ) {
203 /* Remember the bind in the parent */
205 ++parentreq->lr_outrefcnt;
207 lc = ldap_new_connection( ld, srvlist, 0, 1, bind );
212 if ( lc == NULL || lc->lconn_status != LDAP_CONNST_CONNECTED ) {
214 if ( ld->ld_errno == LDAP_SUCCESS ) {
215 ld->ld_errno = LDAP_SERVER_DOWN;
218 /* Forget about the bind */
219 --parentreq->lr_outrefcnt;
224 use_connection( ld, lc );
226 /* If we still have an incomplete write, try to finish it before
227 * dealing with the new request. If we don't finish here, return
228 * LDAP_BUSY and let the caller retry later. We only allow a single
229 * request to be in WRITING state.
232 if ( ld->ld_requests &&
233 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
234 ldap_int_flush_request( ld, ld->ld_requests ) < 0 )
240 lr = (LDAPRequest *)LDAP_CALLOC( 1, sizeof( LDAPRequest ) );
242 ld->ld_errno = LDAP_NO_MEMORY;
243 ldap_free_connection( ld, lc, 0, 0 );
246 /* Forget about the bind */
247 --parentreq->lr_outrefcnt;
251 lr->lr_msgid = msgid;
252 lr->lr_status = LDAP_REQST_INPROGRESS;
253 lr->lr_res_errno = LDAP_SUCCESS; /* optimistic */
256 if ( parentreq != NULL ) { /* sub-request */
258 /* Increment if we didn't do it before the bind */
259 ++parentreq->lr_outrefcnt;
261 lr->lr_origid = parentreq->lr_origid;
262 lr->lr_parentcnt = ++parentreq->lr_parentcnt;
263 lr->lr_parent = parentreq;
264 lr->lr_refnext = parentreq->lr_child;
265 parentreq->lr_child = lr;
266 } else { /* original request */
267 lr->lr_origid = lr->lr_msgid;
270 /* Extract requestDN for future reference */
272 BerElement tmpber = *ber;
276 ber_reset( &tmpber, 1 );
277 rtag = ber_scanf( &tmpber, "{it", /*}*/ &bint, &tag );
280 rtag = ber_scanf( &tmpber, "{i" /*}*/, &bint );
282 case LDAP_REQ_DELETE:
285 rtag = ber_scanf( &tmpber, "{" /*}*/ );
286 case LDAP_REQ_ABANDON:
289 if ( tag != LDAP_REQ_ABANDON ) {
290 ber_skip_tag( &tmpber, &lr->lr_dn.bv_len );
291 lr->lr_dn.bv_val = tmpber.ber_ptr;
296 lr->lr_next = ld->ld_requests;
297 if ( lr->lr_next != NULL ) {
298 lr->lr_next->lr_prev = lr;
300 ld->ld_requests = lr;
302 ld->ld_errno = LDAP_SUCCESS;
303 if ( ldap_int_flush_request( ld, lr ) == -1 ) {
311 ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist, int use_ldsb,
312 int connect, LDAPreqinfo *bind )
316 Debug( LDAP_DEBUG_TRACE, "ldap_new_connection %d %d %d\n",
317 use_ldsb, connect, (bind != NULL) );
319 * make a new LDAP server connection
320 * XXX open connection synchronously for now
322 lc = (LDAPConn *)LDAP_CALLOC( 1, sizeof( LDAPConn ) );
324 ld->ld_errno = LDAP_NO_MEMORY;
329 assert( ld->ld_sb != NULL );
330 lc->lconn_sb = ld->ld_sb;
333 lc->lconn_sb = ber_sockbuf_alloc();
334 if ( lc->lconn_sb == NULL ) {
335 LDAP_FREE( (char *)lc );
336 ld->ld_errno = LDAP_NO_MEMORY;
342 LDAPURLDesc **srvp, *srv = NULL;
344 for ( srvp = srvlist; *srvp != NULL; srvp = &(*srvp)->lud_next ) {
345 if ( ldap_int_open_connection( ld, lc, *srvp, 0 ) != -1 )
349 if ( ld->ld_urllist_proc ) {
350 ld->ld_urllist_proc( ld, srvlist, srvp, ld->ld_urllist_params );
359 ber_sockbuf_free( lc->lconn_sb );
361 LDAP_FREE( (char *)lc );
362 ld->ld_errno = LDAP_SERVER_DOWN;
366 lc->lconn_server = ldap_url_dup( srv );
369 lc->lconn_status = LDAP_CONNST_CONNECTED;
370 #ifdef LDAP_R_COMPILE
371 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
373 lc->lconn_next = ld->ld_conns;
375 #ifdef LDAP_R_COMPILE
376 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
379 if ( bind != NULL ) {
381 LDAPConn *savedefconn;
383 /* Set flag to prevent additional referrals
384 * from being processed on this
385 * connection until the bind has completed
387 lc->lconn_rebind_inprogress = 1;
388 /* V3 rebind function */
389 if ( ld->ld_rebind_proc != NULL) {
390 LDAPURLDesc *srvfunc;
392 srvfunc = ldap_url_dup( *srvlist );
393 if ( srvfunc == NULL ) {
394 ld->ld_errno = LDAP_NO_MEMORY;
397 savedefconn = ld->ld_defconn;
398 ++lc->lconn_refcnt; /* avoid premature free */
401 Debug( LDAP_DEBUG_TRACE, "Call application rebind_proc\n", 0, 0, 0);
402 #ifdef LDAP_R_COMPILE
403 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
404 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
406 err = (*ld->ld_rebind_proc)( ld,
407 bind->ri_url, bind->ri_request, bind->ri_msgid,
408 ld->ld_rebind_params );
409 #ifdef LDAP_R_COMPILE
410 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
411 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
414 ld->ld_defconn = savedefconn;
419 ldap_free_connection( ld, lc, 1, 0 );
422 ldap_free_urldesc( srvfunc );
427 struct berval passwd = BER_BVNULL;
429 savedefconn = ld->ld_defconn;
430 ++lc->lconn_refcnt; /* avoid premature free */
433 Debug( LDAP_DEBUG_TRACE, "anonymous rebind via ldap_bind_s\n", 0, 0, 0);
434 #ifdef LDAP_R_COMPILE
435 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
436 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
438 rc = ldap_sasl_bind( ld, "", LDAP_SASL_SIMPLE, &passwd,
439 NULL, NULL, &msgid );
440 if ( rc != LDAP_SUCCESS ) {
444 for ( err = 1; err > 0; ) {
445 struct timeval tv = { 0, 100000 };
446 LDAPMessage *res = NULL;
448 switch ( ldap_result( ld, msgid, LDAP_MSG_ALL, &tv, &res ) ) {
454 #ifdef LDAP_R_COMPILE
455 ldap_pvt_thread_yield();
460 rc = ldap_parse_result( ld, res, &err, NULL, NULL, NULL, NULL, 1 );
461 if ( rc != LDAP_SUCCESS ) {
464 } else if ( err != LDAP_SUCCESS ) {
467 /* else err == LDAP_SUCCESS == 0 */
475 #ifdef LDAP_R_COMPILE
476 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
477 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
479 ld->ld_defconn = savedefconn;
483 ldap_free_connection( ld, lc, 1, 0 );
488 lc->lconn_rebind_inprogress = 0;
496 find_connection( LDAP *ld, LDAPURLDesc *srv, int any )
498 * return an existing connection (if any) to the server srv
499 * if "any" is non-zero, check for any server in the "srv" chain
503 LDAPURLDesc *lcu, *lsu;
504 int lcu_port, lsu_port;
507 #ifdef LDAP_R_COMPILE
508 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
510 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
511 lcu = lc->lconn_server;
512 lcu_port = ldap_pvt_url_scheme_port( lcu->lud_scheme,
515 for ( lsu = srv; lsu != NULL; lsu = lsu->lud_next ) {
516 lsu_port = ldap_pvt_url_scheme_port( lsu->lud_scheme,
519 if ( lsu_port == lcu_port
520 && strcmp( lcu->lud_scheme, lsu->lud_scheme ) == 0
521 && lcu->lud_host != NULL && *lcu->lud_host != '\0'
522 && lsu->lud_host != NULL && *lsu->lud_host != '\0'
523 && strcasecmp( lsu->lud_host, lcu->lud_host ) == 0 )
534 #ifdef LDAP_R_COMPILE
535 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
543 use_connection( LDAP *ld, LDAPConn *lc )
546 lc->lconn_lastused = time( NULL );
551 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
553 LDAPConn *tmplc, *prevlc;
555 Debug( LDAP_DEBUG_TRACE,
556 "ldap_free_connection %d %d\n",
559 if ( force || --lc->lconn_refcnt <= 0 ) {
560 /* remove from connections list first */
561 #ifdef LDAP_R_COMPILE
562 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
565 for ( prevlc = NULL, tmplc = ld->ld_conns;
567 tmplc = tmplc->lconn_next )
570 if ( prevlc == NULL ) {
571 ld->ld_conns = tmplc->lconn_next;
573 prevlc->lconn_next = tmplc->lconn_next;
579 #ifdef LDAP_R_COMPILE
580 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
583 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
584 ldap_mark_select_clear( ld, lc->lconn_sb );
586 ldap_send_unbind( ld, lc->lconn_sb,
591 if ( lc->lconn_ber != NULL ) {
592 ber_free( lc->lconn_ber, 1 );
595 ldap_int_sasl_close( ld, lc );
597 ldap_free_urllist( lc->lconn_server );
598 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
599 if ( lc->lconn_krbinstance != NULL ) {
600 LDAP_FREE( lc->lconn_krbinstance );
604 /* FIXME: is this at all possible?
605 * ldap_ld_free() in unbind.c calls ldap_free_connection()
606 * with force == 1 __after__ explicitly calling
607 * ldap_free_request() on all requests */
611 for ( lr = ld->ld_requests; lr; ) {
612 LDAPRequest *lr_next = lr->lr_next;
614 if ( lr->lr_conn == lc ) {
615 ldap_free_request_int( ld, lr );
622 if ( lc->lconn_sb != ld->ld_sb ) {
623 ber_sockbuf_free( lc->lconn_sb );
626 if ( lc->lconn_rebind_queue != NULL) {
628 for( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
629 LDAP_VFREE( lc->lconn_rebind_queue[i] );
631 LDAP_FREE( lc->lconn_rebind_queue );
636 Debug( LDAP_DEBUG_TRACE,
637 "ldap_free_connection: actually freed\n",
641 lc->lconn_lastused = time( NULL );
642 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
643 lc->lconn_refcnt, 0, 0 );
650 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
655 Debug( LDAP_DEBUG_TRACE, "** ld %p Connection%s:\n", (void *)ld, all ? "s" : "", 0 );
656 for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
657 if ( lc->lconn_server != NULL ) {
658 Debug( LDAP_DEBUG_TRACE, "* host: %s port: %d%s\n",
659 ( lc->lconn_server->lud_host == NULL ) ? "(null)"
660 : lc->lconn_server->lud_host,
661 lc->lconn_server->lud_port, ( lc->lconn_sb ==
662 ld->ld_sb ) ? " (default)" : "" );
664 Debug( LDAP_DEBUG_TRACE, " refcnt: %d status: %s\n", lc->lconn_refcnt,
665 ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET )
666 ? "NeedSocket" : ( lc->lconn_status == LDAP_CONNST_CONNECTING )
667 ? "Connecting" : "Connected", 0 );
668 Debug( LDAP_DEBUG_TRACE, " last used: %s%s\n",
669 ldap_pvt_ctime( &lc->lconn_lastused, timebuf ),
670 lc->lconn_rebind_inprogress ? " rebind in progress" : "", 0 );
671 if ( lc->lconn_rebind_inprogress ) {
672 if ( lc->lconn_rebind_queue != NULL) {
675 for ( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
677 for( j = 0; lc->lconn_rebind_queue[i][j] != 0; j++ ) {
678 Debug( LDAP_DEBUG_TRACE, " queue %d entry %d - %s\n",
679 i, j, lc->lconn_rebind_queue[i][j] );
683 Debug( LDAP_DEBUG_TRACE, " queue is empty\n", 0, 0, 0 );
686 Debug( LDAP_DEBUG_TRACE, "\n", 0, 0, 0 );
695 ldap_dump_requests_and_responses( LDAP *ld )
701 Debug( LDAP_DEBUG_TRACE, "** ld %p Outstanding Requests:\n",
703 lr = ld->ld_requests;
705 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
707 for ( i = 0; lr != NULL; lr = lr->lr_next, i++ ) {
708 Debug( LDAP_DEBUG_TRACE, " * msgid %d, origid %d, status %s\n",
709 lr->lr_msgid, lr->lr_origid,
710 ( lr->lr_status == LDAP_REQST_INPROGRESS ) ? "InProgress" :
711 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
712 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
713 ( lr->lr_status == LDAP_REQST_WRITING ) ? "Writing" :
714 ( lr->lr_status == LDAP_REQST_COMPLETED ) ? "RequestCompleted"
716 Debug( LDAP_DEBUG_TRACE, " outstanding referrals %d, parent count %d\n",
717 lr->lr_outrefcnt, lr->lr_parentcnt, 0 );
719 Debug( LDAP_DEBUG_TRACE, " ld %p request count %d (abandoned %d)\n",
720 (void *)ld, i, ld->ld_nabandoned );
721 Debug( LDAP_DEBUG_TRACE, "** ld %p Response Queue:\n", (void *)ld, 0, 0 );
722 if ( ( lm = ld->ld_responses ) == NULL ) {
723 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
725 for ( i = 0; lm != NULL; lm = lm->lm_next, i++ ) {
726 Debug( LDAP_DEBUG_TRACE, " * msgid %d, type %lu\n",
727 lm->lm_msgid, (unsigned long)lm->lm_msgtype, 0 );
728 if ( ( l = lm->lm_chain ) != NULL ) {
729 Debug( LDAP_DEBUG_TRACE, " chained responses:\n", 0, 0, 0 );
730 for ( ; l != NULL; l = l->lm_chain ) {
731 Debug( LDAP_DEBUG_TRACE,
732 " * msgid %d, type %lu\n",
734 (unsigned long)l->lm_msgtype, 0 );
738 Debug( LDAP_DEBUG_TRACE, " ld %p response count %d\n", (void *)ld, i, 0 );
740 #endif /* LDAP_DEBUG */
743 ldap_free_request_int( LDAP *ld, LDAPRequest *lr )
745 /* if lr_refcnt > 0, the request has been looked up
746 * by ldap_find_request_by_msgid(); if in the meanwhile
747 * the request is free()'d by someone else, just decrease
748 * the reference count and extract it from the request
749 * list; later on, it will be freed. */
750 if ( lr->lr_prev == NULL ) {
751 if ( lr->lr_refcnt == 0 ) {
752 /* free'ing the first request? */
753 assert( ld->ld_requests == lr );
756 if ( ld->ld_requests == lr ) {
757 ld->ld_requests = lr->lr_next;
761 lr->lr_prev->lr_next = lr->lr_next;
764 if ( lr->lr_next != NULL ) {
765 lr->lr_next->lr_prev = lr->lr_prev;
768 if ( lr->lr_refcnt > 0 ) {
769 lr->lr_refcnt = -lr->lr_refcnt;
777 if ( lr->lr_ber != NULL ) {
778 ber_free( lr->lr_ber, 1 );
782 if ( lr->lr_res_error != NULL ) {
783 LDAP_FREE( lr->lr_res_error );
784 lr->lr_res_error = NULL;
787 if ( lr->lr_res_matched != NULL ) {
788 LDAP_FREE( lr->lr_res_matched );
789 lr->lr_res_matched = NULL;
796 ldap_free_request( LDAP *ld, LDAPRequest *lr )
798 LDAPRequest **ttmplr;
799 #ifdef LDAP_R_COMPILE
800 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
803 Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
804 lr->lr_origid, lr->lr_msgid, 0 );
806 /* free all referrals (child requests) */
807 while ( lr->lr_child )
808 ldap_free_request( ld, lr->lr_child );
810 if ( lr->lr_parent != NULL ) {
811 --lr->lr_parent->lr_outrefcnt;
812 for ( ttmplr = &lr->lr_parent->lr_child;
813 *ttmplr && *ttmplr != lr;
814 ttmplr = &(*ttmplr)->lr_refnext );
816 *ttmplr = lr->lr_refnext;
818 ldap_free_request_int( ld, lr );
822 * call first time with *cntp = -1
823 * when returns *cntp == -1, no referrals are left
825 * NOTE: may replace *refsp, or shuffle the contents
826 * of the original array.
828 static int ldap_int_nextref(
834 assert( refsp != NULL );
835 assert( *refsp != NULL );
836 assert( cntp != NULL );
845 if ( (*refsp)[ *cntp ] == NULL ) {
856 * (IN) ld = LDAP connection handle
857 * (IN) lr = LDAP Request structure
858 * (IN) refs = array of pointers to referral strings that we will chase
859 * The array will be free'd by this function when no longer needed
860 * (IN) sref != 0 if following search reference
861 * (OUT) errstrp = Place to return a string of referrals which could not be followed
862 * (OUT) hadrefp = 1 if sucessfully followed referral
864 * Return value - number of referrals followed
867 ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, int sref, char **errstrp, int *hadrefp )
870 int unfollowedcnt = 0;
871 LDAPRequest *origreq;
872 LDAPURLDesc *srv = NULL;
874 char **refarray = NULL;
876 int rc, count, i, j, id;
879 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
882 Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referrals\n", 0, 0, 0 );
887 /* If no referrals in array, return */
888 if ( (refs == NULL) || ( (refs)[0] == NULL) ) {
893 /* Check for hop limit exceeded */
894 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
895 Debug( LDAP_DEBUG_ANY,
896 "more than %d referral hops (dropping)\n", ld->ld_refhoplimit, 0, 0 );
897 ld->ld_errno = LDAP_REFERRAL_LIMIT_EXCEEDED;
902 /* find original request */
904 origreq->lr_parent != NULL;
905 origreq = origreq->lr_parent )
913 if ( ld->ld_nextref_proc == NULL ) {
914 ld->ld_nextref_proc = ldap_int_nextref;
917 /* parse out & follow referrals */
919 for ( ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params );
921 ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params ) )
924 /* Parse the referral URL */
925 rc = ldap_url_parse_ext( refarray[i], &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
926 if ( rc != LDAP_URL_SUCCESS ) {
927 /* ldap_url_parse_ext() returns LDAP_URL_* errors
928 * which do not map on API errors */
929 ld->ld_errno = LDAP_PARAM_ERROR;
934 if( srv->lud_crit_exts ) {
935 /* we do not support any extensions */
936 ld->ld_errno = LDAP_NOT_SUPPORTED;
941 /* check connection for re-bind in progress */
942 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
943 /* See if we've already requested this DN with this conn */
946 int len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
947 for ( lp = origreq; lp; ) {
948 if ( lp->lr_conn == lc
949 && len == lp->lr_dn.bv_len
951 && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) == 0 )
956 if ( lp == origreq ) {
963 ldap_free_urllist( srv );
965 ld->ld_errno = LDAP_CLIENT_LOOP;
970 if ( lc->lconn_rebind_inprogress ) {
971 /* We are already chasing a referral or search reference and a
972 * bind on that connection is in progress. We must queue
973 * referrals on that connection, so we don't get a request
974 * going out before the bind operation completes. This happens
975 * if two search references come in one behind the other
976 * for the same server with different contexts.
978 Debug( LDAP_DEBUG_TRACE,
979 "ldap_chase_v3referrals: queue referral \"%s\"\n",
981 if( lc->lconn_rebind_queue == NULL ) {
982 /* Create a referral list */
983 lc->lconn_rebind_queue =
984 (char ***) LDAP_MALLOC( sizeof(void *) * 2);
986 if( lc->lconn_rebind_queue == NULL) {
987 ld->ld_errno = LDAP_NO_MEMORY;
992 lc->lconn_rebind_queue[0] = refarray;
993 lc->lconn_rebind_queue[1] = NULL;
997 /* Count how many referral arrays we already have */
998 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
1002 /* Add the new referral to the list */
1003 lc->lconn_rebind_queue = (char ***) LDAP_REALLOC(
1004 lc->lconn_rebind_queue, sizeof(void *) * (j + 2));
1006 if( lc->lconn_rebind_queue == NULL ) {
1007 ld->ld_errno = LDAP_NO_MEMORY;
1011 lc->lconn_rebind_queue[j] = refarray;
1012 lc->lconn_rebind_queue[j+1] = NULL;
1016 /* We have queued the referral/reference, now just return */
1019 count = 1; /* Pretend we already followed referral */
1023 /* Re-encode the request with the new starting point of the search.
1024 * Note: In the future we also need to replace the filter if one
1025 * was provided with the search reference
1028 /* For references we don't want old dn if new dn empty */
1029 if ( sref && srv->lud_dn == NULL ) {
1030 srv->lud_dn = LDAP_STRDUP( "" );
1033 LDAP_NEXT_MSGID( ld, id );
1034 ber = re_encode_request( ld, origreq->lr_ber, id,
1035 sref, srv, &rinfo.ri_request );
1038 ld->ld_errno = LDAP_ENCODING_ERROR;
1043 Debug( LDAP_DEBUG_TRACE,
1044 "ldap_chase_v3referral: msgid %d, url \"%s\"\n",
1045 lr->lr_msgid, refarray[i], 0);
1047 /* Send the new request to the server - may require a bind */
1048 rinfo.ri_msgid = origreq->lr_origid;
1049 rinfo.ri_url = refarray[i];
1050 #ifdef LDAP_R_COMPILE
1051 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1053 rc = ldap_send_server_request( ld, ber, id,
1054 origreq, &srv, NULL, &rinfo );
1055 #ifdef LDAP_R_COMPILE
1056 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1059 /* Failure, try next referral in the list */
1060 Debug( LDAP_DEBUG_ANY, "Unable to chase referral \"%s\" (%d: %s)\n",
1061 refarray[i], ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1062 unfollowedcnt += ldap_append_referral( ld, &unfollowed, refarray[i] );
1063 ldap_free_urllist( srv );
1065 ld->ld_errno = LDAP_REFERRAL;
1067 /* Success, no need to try this referral list further */
1072 /* check if there is a queue of referrals that came in during bind */
1074 lc = find_connection( ld, srv, 1 );
1076 ld->ld_errno = LDAP_OPERATIONS_ERROR;
1082 if ( lc->lconn_rebind_queue != NULL ) {
1083 /* Release resources of previous list */
1084 LDAP_VFREE( refarray );
1086 ldap_free_urllist( srv );
1089 /* Pull entries off end of queue so list always null terminated */
1090 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++ )
1092 refarray = lc->lconn_rebind_queue[j - 1];
1093 lc->lconn_rebind_queue[j-1] = NULL;
1094 /* we pulled off last entry from queue, free queue */
1096 LDAP_FREE( lc->lconn_rebind_queue );
1097 lc->lconn_rebind_queue = NULL;
1099 /* restart the loop the with new referral list */
1103 break; /* referral followed, break out of for loop */
1105 } /* end for loop */
1107 LDAP_VFREE( refarray );
1108 ldap_free_urllist( srv );
1109 LDAP_FREE( *errstrp );
1113 LDAP_FREE( unfollowed );
1116 *errstrp = unfollowed;
1122 * XXX merging of errors in this routine needs to be improved
1125 ldap_chase_referrals( LDAP *ld,
1133 char *p, *ref, *unfollowed;
1134 LDAPRequest *origreq;
1140 Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
1142 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
1145 if ( *errstrp == NULL ) {
1149 len = strlen( *errstrp );
1150 for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
1151 if ( strncasecmp( p, LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
1153 p += LDAP_REF_STR_LEN;
1158 if ( len < LDAP_REF_STR_LEN ) {
1162 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1163 Debug( LDAP_DEBUG_ANY,
1164 "more than %d referral hops (dropping)\n",
1165 ld->ld_refhoplimit, 0, 0 );
1166 /* XXX report as error in ld->ld_errno? */
1170 /* find original request */
1171 for ( origreq = lr; origreq->lr_parent != NULL;
1172 origreq = origreq->lr_parent ) {
1179 /* parse out & follow referrals */
1180 for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
1181 p = strchr( ref, '\n' );
1186 rc = ldap_url_parse_ext( ref, &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1187 if ( rc != LDAP_URL_SUCCESS ) {
1188 Debug( LDAP_DEBUG_TRACE,
1189 "ignoring %s referral <%s>\n",
1190 ref, rc == LDAP_URL_ERR_BADSCHEME ? "unknown" : "incorrect", 0 );
1191 rc = ldap_append_referral( ld, &unfollowed, ref );
1196 Debug( LDAP_DEBUG_TRACE,
1197 "chasing LDAP referral: <%s>\n", ref, 0, 0 );
1201 /* See if we've already been here */
1202 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1205 int len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1206 for ( lp = lr; lp; lp = lp->lr_parent ) {
1207 if ( lp->lr_conn == lc
1208 && len == lp->lr_dn.bv_len )
1210 if ( len && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) )
1217 ldap_free_urllist(srv);
1218 ld->ld_errno = LDAP_CLIENT_LOOP;
1224 LDAP_NEXT_MSGID( ld, id );
1225 ber = re_encode_request( ld, origreq->lr_ber,
1226 id, sref, srv, &rinfo.ri_request );
1228 if ( ber == NULL ) {
1232 /* copy the complete referral for rebind process */
1233 rinfo.ri_url = LDAP_STRDUP( ref );
1235 rinfo.ri_msgid = origreq->lr_origid;
1237 #ifdef LDAP_R_COMPILE
1238 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1240 rc = ldap_send_server_request( ld, ber, id,
1241 lr, &srv, NULL, &rinfo );
1242 #ifdef LDAP_R_COMPILE
1243 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1246 LDAP_FREE( rinfo.ri_url );
1251 Debug( LDAP_DEBUG_ANY,
1252 "Unable to chase referral \"%s\" (%d: %s)\n",
1253 ref, ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1254 rc = ldap_append_referral( ld, &unfollowed, ref );
1257 ldap_free_urllist(srv);
1260 LDAP_FREE( *errstrp );
1261 *errstrp = unfollowed;
1263 return(( rc == 0 ) ? count : rc );
1268 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
1272 if ( *referralsp == NULL ) {
1274 *referralsp = (char *)LDAP_MALLOC( strlen( s ) + LDAP_REF_STR_LEN
1278 *referralsp = (char *)LDAP_REALLOC( *referralsp,
1279 strlen( *referralsp ) + strlen( s ) + 2 );
1282 if ( *referralsp == NULL ) {
1283 ld->ld_errno = LDAP_NO_MEMORY;
1288 strcpy( *referralsp, LDAP_REF_STR );
1290 strcat( *referralsp, "\n" );
1292 strcat( *referralsp, s );
1300 re_encode_request( LDAP *ld,
1301 BerElement *origber,
1308 * XXX this routine knows way too much about how the lber library works!
1316 BerElement tmpber, *ber;
1319 Debug( LDAP_DEBUG_TRACE,
1320 "re_encode_request: new msgid %ld, new dn <%s>\n",
1322 ( srv == NULL || srv->lud_dn == NULL) ? "NONE" : srv->lud_dn, 0 );
1327 * all LDAP requests are sequences that start with a message id.
1328 * For all except delete, this is followed by a sequence that is
1329 * tagged with the operation code. For delete, the provided DN
1330 * is not wrapped by a sequence.
1332 rtag = ber_scanf( &tmpber, "{it", /*}*/ &along, &tag );
1334 if ( rtag == LBER_ERROR ) {
1335 ld->ld_errno = LDAP_DECODING_ERROR;
1340 if ( tag == LDAP_REQ_BIND ) {
1341 /* bind requests have a version number before the DN & other stuff */
1342 rtag = ber_scanf( &tmpber, "{im" /*}*/, &ver, &dn );
1344 } else if ( tag == LDAP_REQ_DELETE ) {
1345 /* delete requests don't have a DN wrapping sequence */
1346 rtag = ber_scanf( &tmpber, "m", &dn );
1348 } else if ( tag == LDAP_REQ_SEARCH ) {
1349 /* search requests need to be re-scope-ed */
1350 rtag = ber_scanf( &tmpber, "{me" /*"}"*/, &dn, &scope );
1352 if( srv->lud_scope != LDAP_SCOPE_DEFAULT ) {
1353 /* use the scope provided in reference */
1354 scope = srv->lud_scope;
1356 } else if ( sref ) {
1357 /* use scope implied by previous operation
1360 * subtree -> subtree
1361 * subordinate -> subtree
1365 case LDAP_SCOPE_BASE:
1366 case LDAP_SCOPE_ONELEVEL:
1367 scope = LDAP_SCOPE_BASE;
1369 case LDAP_SCOPE_SUBTREE:
1370 case LDAP_SCOPE_SUBORDINATE:
1371 scope = LDAP_SCOPE_SUBTREE;
1377 rtag = ber_scanf( &tmpber, "{m" /*}*/, &dn );
1380 if( rtag == LBER_ERROR ) {
1381 ld->ld_errno = LDAP_DECODING_ERROR;
1385 /* restore character zero'd out by ber_scanf*/
1386 dn.bv_val[dn.bv_len] = tmpber.ber_tag;
1388 if (( ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
1392 if ( srv->lud_dn ) {
1393 ber_str2bv( srv->lud_dn, 0, 0, &dn );
1396 if ( tag == LDAP_REQ_BIND ) {
1397 rc = ber_printf( ber, "{it{iO" /*}}*/, msgid, tag, ver, &dn );
1398 } else if ( tag == LDAP_REQ_DELETE ) {
1399 rc = ber_printf( ber, "{itON}", msgid, tag, &dn );
1400 } else if ( tag == LDAP_REQ_SEARCH ) {
1401 rc = ber_printf( ber, "{it{Oe" /*}}*/, msgid, tag, &dn, scope );
1403 rc = ber_printf( ber, "{it{O" /*}}*/, msgid, tag, &dn );
1407 ld->ld_errno = LDAP_ENCODING_ERROR;
1412 if ( tag != LDAP_REQ_DELETE && (
1413 ber_write(ber, tmpber.ber_ptr, ( tmpber.ber_end - tmpber.ber_ptr ), 0)
1414 != ( tmpber.ber_end - tmpber.ber_ptr ) ||
1415 ber_printf( ber, /*{{*/ "N}N}" ) == -1 ) )
1417 ld->ld_errno = LDAP_ENCODING_ERROR;
1423 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
1424 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
1426 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ber, 0 );
1428 #endif /* LDAP_DEBUG */
1430 *type = tag; /* return request type */
1436 ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid )
1440 #ifdef LDAP_R_COMPILE
1441 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1443 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1444 if ( lr->lr_status == LDAP_REQST_COMPLETED ) {
1445 continue; /* Skip completed requests */
1447 if ( msgid == lr->lr_msgid ) {
1452 #ifdef LDAP_R_COMPILE
1453 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1460 ldap_return_request( LDAP *ld, LDAPRequest *lrx, int freeit )
1464 #ifdef LDAP_R_COMPILE
1465 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1467 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1469 if ( lr->lr_refcnt > 0 ) {
1472 } else if ( lr->lr_refcnt < 0 ) {
1474 if ( lr->lr_refcnt == 0 ) {
1482 ldap_free_request_int( ld, lrx );
1484 } else if ( freeit ) {
1485 ldap_free_request( ld, lrx );
1487 #ifdef LDAP_R_COMPILE
1488 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );