2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2007 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 /* 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 };
217 ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_GET_FD, &sd );
220 switch ( ldap_int_poll( ld, sd, &tv ) ) {
223 lc->lconn_status = LDAP_CONNST_CONNECTED;
227 /* async only occurs if a network timeout is set */
229 /* honor network timeout */
230 if ( time( NULL ) - lc->lconn_created <= ld->ld_options.ldo_tm_net.tv_sec )
232 /* caller will have to call again */
233 ld->ld_errno = LDAP_X_CONNECTING;
243 if ( lc == NULL || lc->lconn_status != LDAP_CONNST_CONNECTED ) {
244 if ( ld->ld_errno == LDAP_SUCCESS ) {
245 ld->ld_errno = LDAP_SERVER_DOWN;
250 /* Forget about the bind */
251 --parentreq->lr_outrefcnt;
256 use_connection( ld, lc );
258 /* If we still have an incomplete write, try to finish it before
259 * dealing with the new request. If we don't finish here, return
260 * LDAP_BUSY and let the caller retry later. We only allow a single
261 * request to be in WRITING state.
264 if ( ld->ld_requests &&
265 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
266 ldap_int_flush_request( ld, ld->ld_requests ) < 0 )
272 lr = (LDAPRequest *)LDAP_CALLOC( 1, sizeof( LDAPRequest ) );
274 ld->ld_errno = LDAP_NO_MEMORY;
275 ldap_free_connection( ld, lc, 0, 0 );
278 /* Forget about the bind */
279 --parentreq->lr_outrefcnt;
283 lr->lr_msgid = msgid;
284 lr->lr_status = LDAP_REQST_INPROGRESS;
285 lr->lr_res_errno = LDAP_SUCCESS; /* optimistic */
288 if ( parentreq != NULL ) { /* sub-request */
290 /* Increment if we didn't do it before the bind */
291 ++parentreq->lr_outrefcnt;
293 lr->lr_origid = parentreq->lr_origid;
294 lr->lr_parentcnt = ++parentreq->lr_parentcnt;
295 lr->lr_parent = parentreq;
296 lr->lr_refnext = parentreq->lr_child;
297 parentreq->lr_child = lr;
298 } else { /* original request */
299 lr->lr_origid = lr->lr_msgid;
302 /* Extract requestDN for future reference */
304 BerElement tmpber = *ber;
308 ber_reset( &tmpber, 1 );
309 rtag = ber_scanf( &tmpber, "{it", /*}*/ &bint, &tag );
312 rtag = ber_scanf( &tmpber, "{i" /*}*/, &bint );
314 case LDAP_REQ_DELETE:
317 rtag = ber_scanf( &tmpber, "{" /*}*/ );
318 case LDAP_REQ_ABANDON:
321 if ( tag != LDAP_REQ_ABANDON ) {
322 ber_skip_tag( &tmpber, &lr->lr_dn.bv_len );
323 lr->lr_dn.bv_val = tmpber.ber_ptr;
328 lr->lr_next = ld->ld_requests;
329 if ( lr->lr_next != NULL ) {
330 lr->lr_next->lr_prev = lr;
332 ld->ld_requests = lr;
334 ld->ld_errno = LDAP_SUCCESS;
335 if ( ldap_int_flush_request( ld, lr ) == -1 ) {
343 ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist, int use_ldsb,
344 int connect, LDAPreqinfo *bind )
349 Debug( LDAP_DEBUG_TRACE, "ldap_new_connection %d %d %d\n",
350 use_ldsb, connect, (bind != NULL) );
352 * make a new LDAP server connection
353 * XXX open connection synchronously for now
355 lc = (LDAPConn *)LDAP_CALLOC( 1, sizeof( LDAPConn ) );
357 ld->ld_errno = LDAP_NO_MEMORY;
362 assert( ld->ld_sb != NULL );
363 lc->lconn_sb = ld->ld_sb;
366 lc->lconn_sb = ber_sockbuf_alloc();
367 if ( lc->lconn_sb == NULL ) {
368 LDAP_FREE( (char *)lc );
369 ld->ld_errno = LDAP_NO_MEMORY;
375 LDAPURLDesc **srvp, *srv = NULL;
377 async = LDAP_BOOL_GET( &ld->ld_options, LDAP_BOOL_CONNECT_ASYNC );
379 for ( srvp = srvlist; *srvp != NULL; srvp = &(*srvp)->lud_next ) {
382 rc = ldap_int_open_connection( ld, lc, *srvp, async );
386 if ( ld->ld_urllist_proc && ( !async || rc != -2 ) ) {
387 ld->ld_urllist_proc( ld, srvlist, srvp, ld->ld_urllist_params );
396 ber_sockbuf_free( lc->lconn_sb );
398 LDAP_FREE( (char *)lc );
399 ld->ld_errno = LDAP_SERVER_DOWN;
403 lc->lconn_server = ldap_url_dup( srv );
406 lc->lconn_status = async ? LDAP_CONNST_CONNECTING : LDAP_CONNST_CONNECTED;
407 #ifdef LDAP_R_COMPILE
408 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
410 lc->lconn_next = ld->ld_conns;
412 #ifdef LDAP_R_COMPILE
413 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
416 if ( bind != NULL ) {
418 LDAPConn *savedefconn;
420 /* Set flag to prevent additional referrals
421 * from being processed on this
422 * connection until the bind has completed
424 lc->lconn_rebind_inprogress = 1;
425 /* V3 rebind function */
426 if ( ld->ld_rebind_proc != NULL) {
427 LDAPURLDesc *srvfunc;
429 srvfunc = ldap_url_dup( *srvlist );
430 if ( srvfunc == NULL ) {
431 ld->ld_errno = LDAP_NO_MEMORY;
434 savedefconn = ld->ld_defconn;
435 ++lc->lconn_refcnt; /* avoid premature free */
438 Debug( LDAP_DEBUG_TRACE, "Call application rebind_proc\n", 0, 0, 0);
439 #ifdef LDAP_R_COMPILE
440 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
441 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
443 err = (*ld->ld_rebind_proc)( ld,
444 bind->ri_url, bind->ri_request, bind->ri_msgid,
445 ld->ld_rebind_params );
446 #ifdef LDAP_R_COMPILE
447 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
448 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
451 ld->ld_defconn = savedefconn;
456 ldap_free_connection( ld, lc, 1, 0 );
459 ldap_free_urldesc( srvfunc );
464 struct berval passwd = BER_BVNULL;
466 savedefconn = ld->ld_defconn;
467 ++lc->lconn_refcnt; /* avoid premature free */
470 Debug( LDAP_DEBUG_TRACE,
471 "anonymous rebind via ldap_sasl_bind(\"\")\n",
474 #ifdef LDAP_R_COMPILE
475 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
476 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
478 rc = ldap_sasl_bind( ld, "", LDAP_SASL_SIMPLE, &passwd,
479 NULL, NULL, &msgid );
480 if ( rc != LDAP_SUCCESS ) {
484 for ( err = 1; err > 0; ) {
485 struct timeval tv = { 0, 100000 };
486 LDAPMessage *res = NULL;
488 switch ( ldap_result( ld, msgid, LDAP_MSG_ALL, &tv, &res ) ) {
494 #ifdef LDAP_R_COMPILE
495 ldap_pvt_thread_yield();
500 rc = ldap_parse_result( ld, res, &err, NULL, NULL, NULL, NULL, 1 );
501 if ( rc != LDAP_SUCCESS ) {
504 } else if ( err != LDAP_SUCCESS ) {
507 /* else err == LDAP_SUCCESS == 0 */
511 Debug( LDAP_DEBUG_TRACE,
512 "ldap_new_connection %p: "
513 "unexpected response %d "
514 "from BIND request id=%d\n",
515 (void *) ld, ldap_msgtype( res ), msgid );
521 #ifdef LDAP_R_COMPILE
522 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
523 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
525 ld->ld_defconn = savedefconn;
529 ldap_free_connection( ld, lc, 1, 0 );
534 lc->lconn_rebind_inprogress = 0;
542 find_connection( LDAP *ld, LDAPURLDesc *srv, int any )
544 * return an existing connection (if any) to the server srv
545 * if "any" is non-zero, check for any server in the "srv" chain
549 LDAPURLDesc *lcu, *lsu;
550 int lcu_port, lsu_port;
553 #ifdef LDAP_R_COMPILE
554 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
556 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
557 lcu = lc->lconn_server;
558 lcu_port = ldap_pvt_url_scheme_port( lcu->lud_scheme,
561 for ( lsu = srv; lsu != NULL; lsu = lsu->lud_next ) {
562 lsu_port = ldap_pvt_url_scheme_port( lsu->lud_scheme,
565 if ( lsu_port == lcu_port
566 && strcmp( lcu->lud_scheme, lsu->lud_scheme ) == 0
567 && lcu->lud_host != NULL && *lcu->lud_host != '\0'
568 && lsu->lud_host != NULL && *lsu->lud_host != '\0'
569 && strcasecmp( lsu->lud_host, lcu->lud_host ) == 0 )
580 #ifdef LDAP_R_COMPILE
581 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
589 use_connection( LDAP *ld, LDAPConn *lc )
592 lc->lconn_lastused = time( NULL );
597 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
599 LDAPConn *tmplc, *prevlc;
601 Debug( LDAP_DEBUG_TRACE,
602 "ldap_free_connection %d %d\n",
605 if ( force || --lc->lconn_refcnt <= 0 ) {
606 /* remove from connections list first */
607 #ifdef LDAP_R_COMPILE
608 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
611 for ( prevlc = NULL, tmplc = ld->ld_conns;
613 tmplc = tmplc->lconn_next )
616 if ( prevlc == NULL ) {
617 ld->ld_conns = tmplc->lconn_next;
619 prevlc->lconn_next = tmplc->lconn_next;
625 #ifdef LDAP_R_COMPILE
626 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
629 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
630 ldap_mark_select_clear( ld, lc->lconn_sb );
632 ldap_send_unbind( ld, lc->lconn_sb,
637 if ( lc->lconn_ber != NULL ) {
638 ber_free( lc->lconn_ber, 1 );
641 ldap_int_sasl_close( ld, lc );
643 ldap_free_urllist( lc->lconn_server );
645 /* FIXME: is this at all possible?
646 * ldap_ld_free() in unbind.c calls ldap_free_connection()
647 * with force == 1 __after__ explicitly calling
648 * ldap_free_request() on all requests */
652 for ( lr = ld->ld_requests; lr; ) {
653 LDAPRequest *lr_next = lr->lr_next;
655 if ( lr->lr_conn == lc ) {
656 ldap_free_request_int( ld, lr );
663 if ( lc->lconn_sb != ld->ld_sb ) {
664 ber_sockbuf_free( lc->lconn_sb );
667 if ( lc->lconn_rebind_queue != NULL) {
669 for( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
670 LDAP_VFREE( lc->lconn_rebind_queue[i] );
672 LDAP_FREE( lc->lconn_rebind_queue );
677 Debug( LDAP_DEBUG_TRACE,
678 "ldap_free_connection: actually freed\n",
682 lc->lconn_lastused = time( NULL );
683 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
684 lc->lconn_refcnt, 0, 0 );
691 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
696 Debug( LDAP_DEBUG_TRACE, "** ld %p Connection%s:\n", (void *)ld, all ? "s" : "", 0 );
697 for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
698 if ( lc->lconn_server != NULL ) {
699 Debug( LDAP_DEBUG_TRACE, "* host: %s port: %d%s\n",
700 ( lc->lconn_server->lud_host == NULL ) ? "(null)"
701 : lc->lconn_server->lud_host,
702 lc->lconn_server->lud_port, ( lc->lconn_sb ==
703 ld->ld_sb ) ? " (default)" : "" );
705 Debug( LDAP_DEBUG_TRACE, " refcnt: %d status: %s\n", lc->lconn_refcnt,
706 ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET )
708 ( lc->lconn_status == LDAP_CONNST_CONNECTING )
709 ? "Connecting" : "Connected", 0 );
710 Debug( LDAP_DEBUG_TRACE, " last used: %s%s\n",
711 ldap_pvt_ctime( &lc->lconn_lastused, timebuf ),
712 lc->lconn_rebind_inprogress ? " rebind in progress" : "", 0 );
713 if ( lc->lconn_rebind_inprogress ) {
714 if ( lc->lconn_rebind_queue != NULL) {
717 for ( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
719 for( j = 0; lc->lconn_rebind_queue[i][j] != 0; j++ ) {
720 Debug( LDAP_DEBUG_TRACE, " queue %d entry %d - %s\n",
721 i, j, lc->lconn_rebind_queue[i][j] );
725 Debug( LDAP_DEBUG_TRACE, " queue is empty\n", 0, 0, 0 );
728 Debug( LDAP_DEBUG_TRACE, "\n", 0, 0, 0 );
737 ldap_dump_requests_and_responses( LDAP *ld )
743 Debug( LDAP_DEBUG_TRACE, "** ld %p Outstanding Requests:\n",
745 lr = ld->ld_requests;
747 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
749 for ( i = 0; lr != NULL; lr = lr->lr_next, i++ ) {
750 Debug( LDAP_DEBUG_TRACE, " * msgid %d, origid %d, status %s\n",
751 lr->lr_msgid, lr->lr_origid,
752 ( lr->lr_status == LDAP_REQST_INPROGRESS ) ? "InProgress" :
753 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
754 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
755 ( lr->lr_status == LDAP_REQST_WRITING ) ? "Writing" :
756 ( lr->lr_status == LDAP_REQST_COMPLETED ) ? "RequestCompleted"
758 Debug( LDAP_DEBUG_TRACE, " outstanding referrals %d, parent count %d\n",
759 lr->lr_outrefcnt, lr->lr_parentcnt, 0 );
761 Debug( LDAP_DEBUG_TRACE, " ld %p request count %d (abandoned %lu)\n",
762 (void *)ld, i, ld->ld_nabandoned );
763 Debug( LDAP_DEBUG_TRACE, "** ld %p Response Queue:\n", (void *)ld, 0, 0 );
764 if ( ( lm = ld->ld_responses ) == NULL ) {
765 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
767 for ( i = 0; lm != NULL; lm = lm->lm_next, i++ ) {
768 Debug( LDAP_DEBUG_TRACE, " * msgid %d, type %lu\n",
769 lm->lm_msgid, (unsigned long)lm->lm_msgtype, 0 );
770 if ( lm->lm_chain != NULL ) {
771 Debug( LDAP_DEBUG_TRACE, " chained responses:\n", 0, 0, 0 );
772 for ( l = lm->lm_chain; l != NULL; l = l->lm_chain ) {
773 Debug( LDAP_DEBUG_TRACE,
774 " * msgid %d, type %lu\n",
776 (unsigned long)l->lm_msgtype, 0 );
780 Debug( LDAP_DEBUG_TRACE, " ld %p response count %d\n", (void *)ld, i, 0 );
782 #endif /* LDAP_DEBUG */
785 ldap_free_request_int( LDAP *ld, LDAPRequest *lr )
787 /* if lr_refcnt > 0, the request has been looked up
788 * by ldap_find_request_by_msgid(); if in the meanwhile
789 * the request is free()'d by someone else, just decrease
790 * the reference count and extract it from the request
791 * list; later on, it will be freed. */
792 if ( lr->lr_prev == NULL ) {
793 if ( lr->lr_refcnt == 0 ) {
794 /* free'ing the first request? */
795 assert( ld->ld_requests == lr );
798 if ( ld->ld_requests == lr ) {
799 ld->ld_requests = lr->lr_next;
803 lr->lr_prev->lr_next = lr->lr_next;
806 if ( lr->lr_next != NULL ) {
807 lr->lr_next->lr_prev = lr->lr_prev;
810 if ( lr->lr_refcnt > 0 ) {
811 lr->lr_refcnt = -lr->lr_refcnt;
819 if ( lr->lr_ber != NULL ) {
820 ber_free( lr->lr_ber, 1 );
824 if ( lr->lr_res_error != NULL ) {
825 LDAP_FREE( lr->lr_res_error );
826 lr->lr_res_error = NULL;
829 if ( lr->lr_res_matched != NULL ) {
830 LDAP_FREE( lr->lr_res_matched );
831 lr->lr_res_matched = NULL;
838 ldap_free_request( LDAP *ld, LDAPRequest *lr )
840 #ifdef LDAP_R_COMPILE
841 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
844 Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
845 lr->lr_origid, lr->lr_msgid, 0 );
847 /* free all referrals (child requests) */
848 while ( lr->lr_child ) {
849 ldap_free_request( ld, lr->lr_child );
852 if ( lr->lr_parent != NULL ) {
855 --lr->lr_parent->lr_outrefcnt;
856 for ( lrp = &lr->lr_parent->lr_child;
858 lrp = &(*lrp)->lr_refnext );
861 *lrp = lr->lr_refnext;
864 ldap_free_request_int( ld, lr );
868 * call first time with *cntp = -1
869 * when returns *cntp == -1, no referrals are left
871 * NOTE: may replace *refsp, or shuffle the contents
872 * of the original array.
874 static int ldap_int_nextref(
880 assert( refsp != NULL );
881 assert( *refsp != NULL );
882 assert( cntp != NULL );
891 if ( (*refsp)[ *cntp ] == NULL ) {
902 * (IN) ld = LDAP connection handle
903 * (IN) lr = LDAP Request structure
904 * (IN) refs = array of pointers to referral strings that we will chase
905 * The array will be free'd by this function when no longer needed
906 * (IN) sref != 0 if following search reference
907 * (OUT) errstrp = Place to return a string of referrals which could not be followed
908 * (OUT) hadrefp = 1 if sucessfully followed referral
910 * Return value - number of referrals followed
913 ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, int sref, char **errstrp, int *hadrefp )
916 int unfollowedcnt = 0;
917 LDAPRequest *origreq;
918 LDAPURLDesc *srv = NULL;
920 char **refarray = NULL;
922 int rc, count, i, j, id;
925 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
928 Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referrals\n", 0, 0, 0 );
933 /* If no referrals in array, return */
934 if ( (refs == NULL) || ( (refs)[0] == NULL) ) {
939 /* Check for hop limit exceeded */
940 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
941 Debug( LDAP_DEBUG_ANY,
942 "more than %d referral hops (dropping)\n", ld->ld_refhoplimit, 0, 0 );
943 ld->ld_errno = LDAP_REFERRAL_LIMIT_EXCEEDED;
948 /* find original request */
950 origreq->lr_parent != NULL;
951 origreq = origreq->lr_parent )
959 if ( ld->ld_nextref_proc == NULL ) {
960 ld->ld_nextref_proc = ldap_int_nextref;
963 /* parse out & follow referrals */
965 for ( ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params );
967 ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params ) )
970 /* Parse the referral URL */
971 rc = ldap_url_parse_ext( refarray[i], &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
972 if ( rc != LDAP_URL_SUCCESS ) {
973 /* ldap_url_parse_ext() returns LDAP_URL_* errors
974 * which do not map on API errors */
975 ld->ld_errno = LDAP_PARAM_ERROR;
980 if( srv->lud_crit_exts ) {
981 /* we do not support any extensions */
982 ld->ld_errno = LDAP_NOT_SUPPORTED;
987 /* check connection for re-bind in progress */
988 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
989 /* See if we've already requested this DN with this conn */
992 int len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
993 for ( lp = origreq; lp; ) {
994 if ( lp->lr_conn == lc
995 && len == lp->lr_dn.bv_len
997 && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) == 0 )
1002 if ( lp == origreq ) {
1005 lp = lp->lr_refnext;
1009 ldap_free_urllist( srv );
1011 ld->ld_errno = LDAP_CLIENT_LOOP;
1016 if ( lc->lconn_rebind_inprogress ) {
1017 /* We are already chasing a referral or search reference and a
1018 * bind on that connection is in progress. We must queue
1019 * referrals on that connection, so we don't get a request
1020 * going out before the bind operation completes. This happens
1021 * if two search references come in one behind the other
1022 * for the same server with different contexts.
1024 Debug( LDAP_DEBUG_TRACE,
1025 "ldap_chase_v3referrals: queue referral \"%s\"\n",
1027 if( lc->lconn_rebind_queue == NULL ) {
1028 /* Create a referral list */
1029 lc->lconn_rebind_queue =
1030 (char ***) LDAP_MALLOC( sizeof(void *) * 2);
1032 if( lc->lconn_rebind_queue == NULL) {
1033 ld->ld_errno = LDAP_NO_MEMORY;
1038 lc->lconn_rebind_queue[0] = refarray;
1039 lc->lconn_rebind_queue[1] = NULL;
1043 /* Count how many referral arrays we already have */
1044 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
1048 /* Add the new referral to the list */
1049 lc->lconn_rebind_queue = (char ***) LDAP_REALLOC(
1050 lc->lconn_rebind_queue, sizeof(void *) * (j + 2));
1052 if( lc->lconn_rebind_queue == NULL ) {
1053 ld->ld_errno = LDAP_NO_MEMORY;
1057 lc->lconn_rebind_queue[j] = refarray;
1058 lc->lconn_rebind_queue[j+1] = NULL;
1062 /* We have queued the referral/reference, now just return */
1065 count = 1; /* Pretend we already followed referral */
1069 /* Re-encode the request with the new starting point of the search.
1070 * Note: In the future we also need to replace the filter if one
1071 * was provided with the search reference
1074 /* For references we don't want old dn if new dn empty */
1075 if ( sref && srv->lud_dn == NULL ) {
1076 srv->lud_dn = LDAP_STRDUP( "" );
1079 LDAP_NEXT_MSGID( ld, id );
1080 ber = re_encode_request( ld, origreq->lr_ber, id,
1081 sref, srv, &rinfo.ri_request );
1084 ld->ld_errno = LDAP_ENCODING_ERROR;
1089 Debug( LDAP_DEBUG_TRACE,
1090 "ldap_chase_v3referral: msgid %d, url \"%s\"\n",
1091 lr->lr_msgid, refarray[i], 0);
1093 /* Send the new request to the server - may require a bind */
1094 rinfo.ri_msgid = origreq->lr_origid;
1095 rinfo.ri_url = refarray[i];
1096 #ifdef LDAP_R_COMPILE
1097 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1099 rc = ldap_send_server_request( ld, ber, id,
1100 origreq, &srv, NULL, &rinfo );
1101 #ifdef LDAP_R_COMPILE
1102 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1105 /* Failure, try next referral in the list */
1106 Debug( LDAP_DEBUG_ANY, "Unable to chase referral \"%s\" (%d: %s)\n",
1107 refarray[i], ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1108 unfollowedcnt += ldap_append_referral( ld, &unfollowed, refarray[i] );
1109 ldap_free_urllist( srv );
1111 ld->ld_errno = LDAP_REFERRAL;
1113 /* Success, no need to try this referral list further */
1118 /* check if there is a queue of referrals that came in during bind */
1120 lc = find_connection( ld, srv, 1 );
1122 ld->ld_errno = LDAP_OPERATIONS_ERROR;
1128 if ( lc->lconn_rebind_queue != NULL ) {
1129 /* Release resources of previous list */
1130 LDAP_VFREE( refarray );
1132 ldap_free_urllist( srv );
1135 /* Pull entries off end of queue so list always null terminated */
1136 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++ )
1138 refarray = lc->lconn_rebind_queue[j - 1];
1139 lc->lconn_rebind_queue[j-1] = NULL;
1140 /* we pulled off last entry from queue, free queue */
1142 LDAP_FREE( lc->lconn_rebind_queue );
1143 lc->lconn_rebind_queue = NULL;
1145 /* restart the loop the with new referral list */
1149 break; /* referral followed, break out of for loop */
1151 } /* end for loop */
1153 LDAP_VFREE( refarray );
1154 ldap_free_urllist( srv );
1155 LDAP_FREE( *errstrp );
1159 LDAP_FREE( unfollowed );
1162 *errstrp = unfollowed;
1168 * XXX merging of errors in this routine needs to be improved
1171 ldap_chase_referrals( LDAP *ld,
1179 char *p, *ref, *unfollowed;
1180 LDAPRequest *origreq;
1186 Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
1188 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
1191 if ( *errstrp == NULL ) {
1195 len = strlen( *errstrp );
1196 for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
1197 if ( strncasecmp( p, LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
1199 p += LDAP_REF_STR_LEN;
1204 if ( len < LDAP_REF_STR_LEN ) {
1208 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1209 Debug( LDAP_DEBUG_ANY,
1210 "more than %d referral hops (dropping)\n",
1211 ld->ld_refhoplimit, 0, 0 );
1212 /* XXX report as error in ld->ld_errno? */
1216 /* find original request */
1217 for ( origreq = lr; origreq->lr_parent != NULL;
1218 origreq = origreq->lr_parent ) {
1225 /* parse out & follow referrals */
1226 for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
1227 p = strchr( ref, '\n' );
1232 rc = ldap_url_parse_ext( ref, &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1233 if ( rc != LDAP_URL_SUCCESS ) {
1234 Debug( LDAP_DEBUG_TRACE,
1235 "ignoring %s referral <%s>\n",
1236 ref, rc == LDAP_URL_ERR_BADSCHEME ? "unknown" : "incorrect", 0 );
1237 rc = ldap_append_referral( ld, &unfollowed, ref );
1242 Debug( LDAP_DEBUG_TRACE,
1243 "chasing LDAP referral: <%s>\n", ref, 0, 0 );
1247 /* See if we've already been here */
1248 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1251 int len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1252 for ( lp = lr; lp; lp = lp->lr_parent ) {
1253 if ( lp->lr_conn == lc
1254 && len == lp->lr_dn.bv_len )
1256 if ( len && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) )
1263 ldap_free_urllist( srv );
1264 ld->ld_errno = LDAP_CLIENT_LOOP;
1270 LDAP_NEXT_MSGID( ld, id );
1271 ber = re_encode_request( ld, origreq->lr_ber,
1272 id, sref, srv, &rinfo.ri_request );
1274 if ( ber == NULL ) {
1278 /* copy the complete referral for rebind process */
1279 rinfo.ri_url = LDAP_STRDUP( ref );
1281 rinfo.ri_msgid = origreq->lr_origid;
1283 #ifdef LDAP_R_COMPILE
1284 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1286 rc = ldap_send_server_request( ld, ber, id,
1287 lr, &srv, NULL, &rinfo );
1288 #ifdef LDAP_R_COMPILE
1289 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1292 LDAP_FREE( rinfo.ri_url );
1297 Debug( LDAP_DEBUG_ANY,
1298 "Unable to chase referral \"%s\" (%d: %s)\n",
1299 ref, ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1300 rc = ldap_append_referral( ld, &unfollowed, ref );
1303 ldap_free_urllist(srv);
1306 LDAP_FREE( *errstrp );
1307 *errstrp = unfollowed;
1309 return(( rc == 0 ) ? count : rc );
1314 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
1318 if ( *referralsp == NULL ) {
1320 *referralsp = (char *)LDAP_MALLOC( strlen( s ) + LDAP_REF_STR_LEN
1324 *referralsp = (char *)LDAP_REALLOC( *referralsp,
1325 strlen( *referralsp ) + strlen( s ) + 2 );
1328 if ( *referralsp == NULL ) {
1329 ld->ld_errno = LDAP_NO_MEMORY;
1334 strcpy( *referralsp, LDAP_REF_STR );
1336 strcat( *referralsp, "\n" );
1338 strcat( *referralsp, s );
1346 re_encode_request( LDAP *ld,
1347 BerElement *origber,
1354 * XXX this routine knows way too much about how the lber library works!
1362 BerElement tmpber, *ber;
1365 Debug( LDAP_DEBUG_TRACE,
1366 "re_encode_request: new msgid %ld, new dn <%s>\n",
1368 ( srv == NULL || srv->lud_dn == NULL) ? "NONE" : srv->lud_dn, 0 );
1373 * all LDAP requests are sequences that start with a message id.
1374 * For all except delete, this is followed by a sequence that is
1375 * tagged with the operation code. For delete, the provided DN
1376 * is not wrapped by a sequence.
1378 rtag = ber_scanf( &tmpber, "{it", /*}*/ &along, &tag );
1380 if ( rtag == LBER_ERROR ) {
1381 ld->ld_errno = LDAP_DECODING_ERROR;
1386 if ( tag == LDAP_REQ_BIND ) {
1387 /* bind requests have a version number before the DN & other stuff */
1388 rtag = ber_scanf( &tmpber, "{im" /*}*/, &ver, &dn );
1390 } else if ( tag == LDAP_REQ_DELETE ) {
1391 /* delete requests don't have a DN wrapping sequence */
1392 rtag = ber_scanf( &tmpber, "m", &dn );
1394 } else if ( tag == LDAP_REQ_SEARCH ) {
1395 /* search requests need to be re-scope-ed */
1396 rtag = ber_scanf( &tmpber, "{me" /*"}"*/, &dn, &scope );
1398 if( srv->lud_scope != LDAP_SCOPE_DEFAULT ) {
1399 /* use the scope provided in reference */
1400 scope = srv->lud_scope;
1402 } else if ( sref ) {
1403 /* use scope implied by previous operation
1406 * subtree -> subtree
1407 * subordinate -> subtree
1411 case LDAP_SCOPE_BASE:
1412 case LDAP_SCOPE_ONELEVEL:
1413 scope = LDAP_SCOPE_BASE;
1415 case LDAP_SCOPE_SUBTREE:
1416 case LDAP_SCOPE_SUBORDINATE:
1417 scope = LDAP_SCOPE_SUBTREE;
1423 rtag = ber_scanf( &tmpber, "{m" /*}*/, &dn );
1426 if( rtag == LBER_ERROR ) {
1427 ld->ld_errno = LDAP_DECODING_ERROR;
1431 /* restore character zero'd out by ber_scanf*/
1432 dn.bv_val[dn.bv_len] = tmpber.ber_tag;
1434 if (( ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
1438 if ( srv->lud_dn ) {
1439 ber_str2bv( srv->lud_dn, 0, 0, &dn );
1442 if ( tag == LDAP_REQ_BIND ) {
1443 rc = ber_printf( ber, "{it{iO" /*}}*/, msgid, tag, ver, &dn );
1444 } else if ( tag == LDAP_REQ_DELETE ) {
1445 rc = ber_printf( ber, "{itON}", msgid, tag, &dn );
1446 } else if ( tag == LDAP_REQ_SEARCH ) {
1447 rc = ber_printf( ber, "{it{Oe" /*}}*/, msgid, tag, &dn, scope );
1449 rc = ber_printf( ber, "{it{O" /*}}*/, msgid, tag, &dn );
1453 ld->ld_errno = LDAP_ENCODING_ERROR;
1458 if ( tag != LDAP_REQ_DELETE && (
1459 ber_write(ber, tmpber.ber_ptr, ( tmpber.ber_end - tmpber.ber_ptr ), 0)
1460 != ( tmpber.ber_end - tmpber.ber_ptr ) ||
1461 ber_printf( ber, /*{{*/ "N}N}" ) == -1 ) )
1463 ld->ld_errno = LDAP_ENCODING_ERROR;
1469 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
1470 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
1472 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ber, 0 );
1474 #endif /* LDAP_DEBUG */
1476 *type = tag; /* return request type */
1482 ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid )
1486 #ifdef LDAP_R_COMPILE
1487 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1489 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1490 if ( lr->lr_status == LDAP_REQST_COMPLETED ) {
1491 continue; /* Skip completed requests */
1493 if ( msgid == lr->lr_msgid ) {
1498 #ifdef LDAP_R_COMPILE
1499 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1506 ldap_return_request( LDAP *ld, LDAPRequest *lrx, int freeit )
1510 #ifdef LDAP_R_COMPILE
1511 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1513 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1515 if ( lr->lr_refcnt > 0 ) {
1518 } else if ( lr->lr_refcnt < 0 ) {
1520 if ( lr->lr_refcnt == 0 ) {
1528 ldap_free_request_int( ld, lrx );
1530 } else if ( freeit ) {
1531 ldap_free_request( ld, lrx );
1533 #ifdef LDAP_R_COMPILE
1534 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );