2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2010 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);
130 if (msgtype != LDAP_REQ_ABANDON && msgtype != LDAP_REQ_SEARCH)
133 return LDAP_PARAM_ERROR;
137 #ifdef LDAP_R_COMPILE
138 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
140 rc = ldap_send_server_request( ld, ber, msgid, NULL,
142 #ifdef LDAP_R_COMPILE
143 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
150 ldap_int_flush_request(
154 LDAPConn *lc = lr->lr_conn;
156 if ( ber_flush2( lc->lconn_sb, lr->lr_ber, LBER_FLUSH_FREE_NEVER ) != 0 ) {
157 if ( sock_errno() == EAGAIN ) {
158 /* need to continue write later */
159 lr->lr_status = LDAP_REQST_WRITING;
160 ldap_mark_select_write( ld, lc->lconn_sb );
161 ld->ld_errno = LDAP_BUSY;
164 ld->ld_errno = LDAP_SERVER_DOWN;
165 ldap_free_request( ld, lr );
166 ldap_free_connection( ld, lc, 0, 0 );
170 if ( lr->lr_parent == NULL ) {
171 lr->lr_ber->ber_end = lr->lr_ber->ber_ptr;
172 lr->lr_ber->ber_ptr = lr->lr_ber->ber_buf;
174 lr->lr_status = LDAP_REQST_INPROGRESS;
176 /* sent -- waiting for a response */
177 ldap_mark_select_read( ld, lc->lconn_sb );
183 ldap_send_server_request(
187 LDAPRequest *parentreq,
188 LDAPURLDesc **srvlist,
195 Debug( LDAP_DEBUG_TRACE, "ldap_send_server_request\n", 0, 0, 0 );
198 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
201 if ( srvlist == NULL ) {
204 lc = find_connection( ld, *srvlist, 1 );
206 if ( (bind != NULL) && (parentreq != NULL) ) {
207 /* Remember the bind in the parent */
209 ++parentreq->lr_outrefcnt;
211 lc = ldap_new_connection( ld, srvlist, 0, 1, bind );
216 /* async connect... */
217 if ( lc != NULL && lc->lconn_status == LDAP_CONNST_CONNECTING ) {
218 ber_socket_t sd = AC_SOCKET_ERROR;
219 struct timeval tv = { 0 };
221 ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_GET_FD, &sd );
224 switch ( ldap_int_poll( ld, sd, &tv ) ) {
227 lc->lconn_status = LDAP_CONNST_CONNECTED;
231 /* async only occurs if a network timeout is set */
233 /* honor network timeout */
234 if ( time( NULL ) - lc->lconn_created <= ld->ld_options.ldo_tm_net.tv_sec )
236 /* caller will have to call again */
237 ld->ld_errno = LDAP_X_CONNECTING;
247 if ( lc == NULL || lc->lconn_status != LDAP_CONNST_CONNECTED ) {
248 if ( ld->ld_errno == LDAP_SUCCESS ) {
249 ld->ld_errno = LDAP_SERVER_DOWN;
254 /* Forget about the bind */
255 --parentreq->lr_outrefcnt;
260 use_connection( ld, lc );
262 #ifdef LDAP_CONNECTIONLESS
263 if ( LDAP_IS_UDP( ld )) {
264 BerElement tmpber = *ber;
265 ber_rewind( &tmpber );
266 rc = ber_write( &tmpber, ld->ld_options.ldo_peer,
267 sizeof( struct sockaddr ), 0 );
269 ld->ld_errno = LDAP_ENCODING_ERROR;
275 /* If we still have an incomplete write, try to finish it before
276 * dealing with the new request. If we don't finish here, return
277 * LDAP_BUSY and let the caller retry later. We only allow a single
278 * request to be in WRITING state.
281 if ( ld->ld_requests &&
282 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
283 ldap_int_flush_request( ld, ld->ld_requests ) < 0 )
289 lr = (LDAPRequest *)LDAP_CALLOC( 1, sizeof( LDAPRequest ) );
291 ld->ld_errno = LDAP_NO_MEMORY;
292 ldap_free_connection( ld, lc, 0, 0 );
295 /* Forget about the bind */
296 --parentreq->lr_outrefcnt;
300 lr->lr_msgid = msgid;
301 lr->lr_status = LDAP_REQST_INPROGRESS;
302 lr->lr_res_errno = LDAP_SUCCESS; /* optimistic */
305 if ( parentreq != NULL ) { /* sub-request */
307 /* Increment if we didn't do it before the bind */
308 ++parentreq->lr_outrefcnt;
310 lr->lr_origid = parentreq->lr_origid;
311 lr->lr_parentcnt = ++parentreq->lr_parentcnt;
312 lr->lr_parent = parentreq;
313 lr->lr_refnext = parentreq->lr_child;
314 parentreq->lr_child = lr;
315 } else { /* original request */
316 lr->lr_origid = lr->lr_msgid;
319 /* Extract requestDN for future reference */
321 BerElement tmpber = *ber;
325 ber_reset( &tmpber, 1 );
326 rtag = ber_scanf( &tmpber, "{it", /*}*/ &bint, &tag );
329 rtag = ber_scanf( &tmpber, "{i" /*}*/, &bint );
331 case LDAP_REQ_DELETE:
334 rtag = ber_scanf( &tmpber, "{" /*}*/ );
335 case LDAP_REQ_ABANDON:
338 if ( tag != LDAP_REQ_ABANDON ) {
339 ber_skip_tag( &tmpber, &lr->lr_dn.bv_len );
340 lr->lr_dn.bv_val = tmpber.ber_ptr;
345 lr->lr_next = ld->ld_requests;
346 if ( lr->lr_next != NULL ) {
347 lr->lr_next->lr_prev = lr;
349 ld->ld_requests = lr;
351 ld->ld_errno = LDAP_SUCCESS;
352 if ( ldap_int_flush_request( ld, lr ) == -1 ) {
359 /* return 0 if no StartTLS ext, 1 if present, 2 if critical */
361 find_tls_ext( LDAPURLDesc *srv )
366 if ( !srv->lud_exts )
369 for (i=0; srv->lud_exts[i]; i++) {
371 ext = srv->lud_exts[i];
372 if ( ext[0] == '!') {
376 if ( !strcasecmp( ext, "StartTLS" ) ||
377 !strcasecmp( ext, "X-StartTLS" ) ||
378 !strcmp( ext, LDAP_EXOP_START_TLS )) {
386 * caller must hold ld_req_mutex or be exclusive user of ld
387 * if ( connect != 0 ) or ( bind != NULL ) caller must also hold
388 * ld_req_mutex and ld_res_mutex
392 ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist, int use_ldsb,
393 int connect, LDAPreqinfo *bind )
398 Debug( LDAP_DEBUG_TRACE, "ldap_new_connection %d %d %d\n",
399 use_ldsb, connect, (bind != NULL) );
401 * make a new LDAP server connection
402 * XXX open connection synchronously for now
404 lc = (LDAPConn *)LDAP_CALLOC( 1, sizeof( LDAPConn ) );
406 ld->ld_errno = LDAP_NO_MEMORY;
411 assert( ld->ld_sb != NULL );
412 lc->lconn_sb = ld->ld_sb;
415 lc->lconn_sb = ber_sockbuf_alloc();
416 if ( lc->lconn_sb == NULL ) {
417 LDAP_FREE( (char *)lc );
418 ld->ld_errno = LDAP_NO_MEMORY;
424 LDAPURLDesc **srvp, *srv = NULL;
426 async = LDAP_BOOL_GET( &ld->ld_options, LDAP_BOOL_CONNECT_ASYNC );
428 for ( srvp = srvlist; *srvp != NULL; srvp = &(*srvp)->lud_next ) {
431 rc = ldap_int_open_connection( ld, lc, *srvp, async );
435 if ( ld->ld_urllist_proc && ( !async || rc != -2 ) ) {
436 ld->ld_urllist_proc( ld, srvlist, srvp, ld->ld_urllist_params );
445 ber_sockbuf_free( lc->lconn_sb );
447 LDAP_FREE( (char *)lc );
448 ld->ld_errno = LDAP_SERVER_DOWN;
452 lc->lconn_server = ldap_url_dup( srv );
455 lc->lconn_status = async ? LDAP_CONNST_CONNECTING : LDAP_CONNST_CONNECTED;
456 #ifdef LDAP_R_COMPILE
457 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
459 lc->lconn_next = ld->ld_conns;
461 #ifdef LDAP_R_COMPILE
462 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
466 #ifdef LDAP_R_COMPILE
467 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
468 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
472 if ( lc->lconn_server->lud_exts ) {
473 int rc, ext = find_tls_ext( lc->lconn_server );
475 LDAPConn *savedefconn;
477 savedefconn = ld->ld_defconn;
478 ++lc->lconn_refcnt; /* avoid premature free */
481 #ifdef LDAP_R_COMPILE
482 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
483 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
485 rc = ldap_start_tls_s( ld, NULL, NULL );
486 #ifdef LDAP_R_COMPILE
487 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
488 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
490 ld->ld_defconn = savedefconn;
493 if ( rc != LDAP_SUCCESS && ext == 2 ) {
494 ldap_free_connection( ld, lc, 1, 0 );
502 if ( bind != NULL ) {
504 LDAPConn *savedefconn;
506 #ifdef LDAP_R_COMPILE
507 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
508 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
511 /* Set flag to prevent additional referrals
512 * from being processed on this
513 * connection until the bind has completed
515 lc->lconn_rebind_inprogress = 1;
516 /* V3 rebind function */
517 if ( ld->ld_rebind_proc != NULL) {
518 LDAPURLDesc *srvfunc;
520 srvfunc = ldap_url_dup( *srvlist );
521 if ( srvfunc == NULL ) {
522 ld->ld_errno = LDAP_NO_MEMORY;
525 savedefconn = ld->ld_defconn;
526 ++lc->lconn_refcnt; /* avoid premature free */
529 Debug( LDAP_DEBUG_TRACE, "Call application rebind_proc\n", 0, 0, 0);
530 #ifdef LDAP_R_COMPILE
531 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
532 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
534 err = (*ld->ld_rebind_proc)( ld,
535 bind->ri_url, bind->ri_request, bind->ri_msgid,
536 ld->ld_rebind_params );
537 #ifdef LDAP_R_COMPILE
538 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
539 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
542 ld->ld_defconn = savedefconn;
547 ldap_free_connection( ld, lc, 1, 0 );
550 ldap_free_urldesc( srvfunc );
555 struct berval passwd = BER_BVNULL;
557 savedefconn = ld->ld_defconn;
558 ++lc->lconn_refcnt; /* avoid premature free */
561 Debug( LDAP_DEBUG_TRACE,
562 "anonymous rebind via ldap_sasl_bind(\"\")\n",
565 #ifdef LDAP_R_COMPILE
566 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
567 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
569 rc = ldap_sasl_bind( ld, "", LDAP_SASL_SIMPLE, &passwd,
570 NULL, NULL, &msgid );
571 if ( rc != LDAP_SUCCESS ) {
575 for ( err = 1; err > 0; ) {
576 struct timeval tv = { 0, 100000 };
577 LDAPMessage *res = NULL;
579 switch ( ldap_result( ld, msgid, LDAP_MSG_ALL, &tv, &res ) ) {
585 #ifdef LDAP_R_COMPILE
586 ldap_pvt_thread_yield();
591 rc = ldap_parse_result( ld, res, &err, NULL, NULL, NULL, NULL, 1 );
592 if ( rc != LDAP_SUCCESS ) {
595 } else if ( err != LDAP_SUCCESS ) {
598 /* else err == LDAP_SUCCESS == 0 */
602 Debug( LDAP_DEBUG_TRACE,
603 "ldap_new_connection %p: "
604 "unexpected response %d "
605 "from BIND request id=%d\n",
606 (void *) ld, ldap_msgtype( res ), msgid );
612 #ifdef LDAP_R_COMPILE
613 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
614 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
616 ld->ld_defconn = savedefconn;
620 ldap_free_connection( ld, lc, 1, 0 );
625 lc->lconn_rebind_inprogress = 0;
633 find_connection( LDAP *ld, LDAPURLDesc *srv, int any )
635 * return an existing connection (if any) to the server srv
636 * if "any" is non-zero, check for any server in the "srv" chain
640 LDAPURLDesc *lcu, *lsu;
641 int lcu_port, lsu_port;
644 #ifdef LDAP_R_COMPILE
645 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
647 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
648 lcu = lc->lconn_server;
649 lcu_port = ldap_pvt_url_scheme_port( lcu->lud_scheme,
652 for ( lsu = srv; lsu != NULL; lsu = lsu->lud_next ) {
653 lsu_port = ldap_pvt_url_scheme_port( lsu->lud_scheme,
656 if ( lsu_port == lcu_port
657 && strcmp( lcu->lud_scheme, lsu->lud_scheme ) == 0
658 && lcu->lud_host != NULL && lsu->lud_host != NULL
659 && strcasecmp( lsu->lud_host, lcu->lud_host ) == 0 )
670 #ifdef LDAP_R_COMPILE
671 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
678 * NOTE: the caller holds ld_req_mutex
682 use_connection( LDAP *ld, LDAPConn *lc )
685 lc->lconn_lastused = time( NULL );
690 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
692 LDAPConn *tmplc, *prevlc;
694 Debug( LDAP_DEBUG_TRACE,
695 "ldap_free_connection %d %d\n",
698 if ( force || --lc->lconn_refcnt <= 0 ) {
699 /* remove from connections list first */
700 #ifdef LDAP_R_COMPILE
701 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
704 for ( prevlc = NULL, tmplc = ld->ld_conns;
706 tmplc = tmplc->lconn_next )
709 if ( prevlc == NULL ) {
710 ld->ld_conns = tmplc->lconn_next;
712 prevlc->lconn_next = tmplc->lconn_next;
714 if ( ld->ld_defconn == lc ) {
715 ld->ld_defconn = NULL;
721 #ifdef LDAP_R_COMPILE
722 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
725 /* process connection callbacks */
727 struct ldapoptions *lo;
731 lo = &ld->ld_options;
732 if ( lo->ldo_conn_cbs ) {
733 for ( ll=lo->ldo_conn_cbs; ll; ll=ll->ll_next ) {
735 cb->lc_del( ld, lc->lconn_sb, cb );
738 lo = LDAP_INT_GLOBAL_OPT();
739 if ( lo->ldo_conn_cbs ) {
740 for ( ll=lo->ldo_conn_cbs; ll; ll=ll->ll_next ) {
742 cb->lc_del( ld, lc->lconn_sb, cb );
747 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
748 ldap_mark_select_clear( ld, lc->lconn_sb );
750 ldap_send_unbind( ld, lc->lconn_sb,
755 if ( lc->lconn_ber != NULL ) {
756 ber_free( lc->lconn_ber, 1 );
759 ldap_int_sasl_close( ld, lc );
761 ldap_int_gssapi_close( ld, lc );
764 ldap_free_urllist( lc->lconn_server );
766 /* FIXME: is this at all possible?
767 * ldap_ld_free() in unbind.c calls ldap_free_connection()
768 * with force == 1 __after__ explicitly calling
769 * ldap_free_request() on all requests */
773 for ( lr = ld->ld_requests; lr; ) {
774 LDAPRequest *lr_next = lr->lr_next;
776 if ( lr->lr_conn == lc ) {
777 ldap_free_request_int( ld, lr );
784 if ( lc->lconn_sb != ld->ld_sb ) {
785 ber_sockbuf_free( lc->lconn_sb );
787 ber_int_sb_close( lc->lconn_sb );
790 if ( lc->lconn_rebind_queue != NULL) {
792 for( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
793 LDAP_VFREE( lc->lconn_rebind_queue[i] );
795 LDAP_FREE( lc->lconn_rebind_queue );
800 Debug( LDAP_DEBUG_TRACE,
801 "ldap_free_connection: actually freed\n",
805 lc->lconn_lastused = time( NULL );
806 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
807 lc->lconn_refcnt, 0, 0 );
814 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
819 Debug( LDAP_DEBUG_TRACE, "** ld %p Connection%s:\n", (void *)ld, all ? "s" : "", 0 );
820 for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
821 if ( lc->lconn_server != NULL ) {
822 Debug( LDAP_DEBUG_TRACE, "* host: %s port: %d%s\n",
823 ( lc->lconn_server->lud_host == NULL ) ? "(null)"
824 : lc->lconn_server->lud_host,
825 lc->lconn_server->lud_port, ( lc->lconn_sb ==
826 ld->ld_sb ) ? " (default)" : "" );
828 Debug( LDAP_DEBUG_TRACE, " refcnt: %d status: %s\n", lc->lconn_refcnt,
829 ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET )
831 ( lc->lconn_status == LDAP_CONNST_CONNECTING )
832 ? "Connecting" : "Connected", 0 );
833 Debug( LDAP_DEBUG_TRACE, " last used: %s%s\n",
834 ldap_pvt_ctime( &lc->lconn_lastused, timebuf ),
835 lc->lconn_rebind_inprogress ? " rebind in progress" : "", 0 );
836 if ( lc->lconn_rebind_inprogress ) {
837 if ( lc->lconn_rebind_queue != NULL) {
840 for ( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
842 for( j = 0; lc->lconn_rebind_queue[i][j] != 0; j++ ) {
843 Debug( LDAP_DEBUG_TRACE, " queue %d entry %d - %s\n",
844 i, j, lc->lconn_rebind_queue[i][j] );
848 Debug( LDAP_DEBUG_TRACE, " queue is empty\n", 0, 0, 0 );
851 Debug( LDAP_DEBUG_TRACE, "\n", 0, 0, 0 );
860 ldap_dump_requests_and_responses( LDAP *ld )
866 Debug( LDAP_DEBUG_TRACE, "** ld %p Outstanding Requests:\n",
868 lr = ld->ld_requests;
870 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
872 for ( i = 0; lr != NULL; lr = lr->lr_next, i++ ) {
873 Debug( LDAP_DEBUG_TRACE, " * msgid %d, origid %d, status %s\n",
874 lr->lr_msgid, lr->lr_origid,
875 ( lr->lr_status == LDAP_REQST_INPROGRESS ) ? "InProgress" :
876 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
877 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
878 ( lr->lr_status == LDAP_REQST_WRITING ) ? "Writing" :
879 ( lr->lr_status == LDAP_REQST_COMPLETED ) ? "RequestCompleted"
881 Debug( LDAP_DEBUG_TRACE, " outstanding referrals %d, parent count %d\n",
882 lr->lr_outrefcnt, lr->lr_parentcnt, 0 );
884 Debug( LDAP_DEBUG_TRACE, " ld %p request count %d (abandoned %lu)\n",
885 (void *)ld, i, ld->ld_nabandoned );
886 Debug( LDAP_DEBUG_TRACE, "** ld %p Response Queue:\n", (void *)ld, 0, 0 );
887 if ( ( lm = ld->ld_responses ) == NULL ) {
888 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
890 for ( i = 0; lm != NULL; lm = lm->lm_next, i++ ) {
891 Debug( LDAP_DEBUG_TRACE, " * msgid %d, type %lu\n",
892 lm->lm_msgid, (unsigned long)lm->lm_msgtype, 0 );
893 if ( lm->lm_chain != NULL ) {
894 Debug( LDAP_DEBUG_TRACE, " chained responses:\n", 0, 0, 0 );
895 for ( l = lm->lm_chain; l != NULL; l = l->lm_chain ) {
896 Debug( LDAP_DEBUG_TRACE,
897 " * msgid %d, type %lu\n",
899 (unsigned long)l->lm_msgtype, 0 );
903 Debug( LDAP_DEBUG_TRACE, " ld %p response count %d\n", (void *)ld, i, 0 );
905 #endif /* LDAP_DEBUG */
908 ldap_free_request_int( LDAP *ld, LDAPRequest *lr )
910 /* if lr_refcnt > 0, the request has been looked up
911 * by ldap_find_request_by_msgid(); if in the meanwhile
912 * the request is free()'d by someone else, just decrease
913 * the reference count and extract it from the request
914 * list; later on, it will be freed. */
915 if ( lr->lr_prev == NULL ) {
916 if ( lr->lr_refcnt == 0 ) {
917 /* free'ing the first request? */
918 assert( ld->ld_requests == lr );
921 if ( ld->ld_requests == lr ) {
922 ld->ld_requests = lr->lr_next;
926 lr->lr_prev->lr_next = lr->lr_next;
929 if ( lr->lr_next != NULL ) {
930 lr->lr_next->lr_prev = lr->lr_prev;
933 if ( lr->lr_refcnt > 0 ) {
934 lr->lr_refcnt = -lr->lr_refcnt;
942 if ( lr->lr_ber != NULL ) {
943 ber_free( lr->lr_ber, 1 );
947 if ( lr->lr_res_error != NULL ) {
948 LDAP_FREE( lr->lr_res_error );
949 lr->lr_res_error = NULL;
952 if ( lr->lr_res_matched != NULL ) {
953 LDAP_FREE( lr->lr_res_matched );
954 lr->lr_res_matched = NULL;
961 ldap_free_request( LDAP *ld, LDAPRequest *lr )
963 #ifdef LDAP_R_COMPILE
964 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
967 Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
968 lr->lr_origid, lr->lr_msgid, 0 );
970 /* free all referrals (child requests) */
971 while ( lr->lr_child ) {
972 ldap_free_request( ld, lr->lr_child );
975 if ( lr->lr_parent != NULL ) {
978 --lr->lr_parent->lr_outrefcnt;
979 for ( lrp = &lr->lr_parent->lr_child;
981 lrp = &(*lrp)->lr_refnext );
984 *lrp = lr->lr_refnext;
987 ldap_free_request_int( ld, lr );
991 * call first time with *cntp = -1
992 * when returns *cntp == -1, no referrals are left
994 * NOTE: may replace *refsp, or shuffle the contents
995 * of the original array.
997 static int ldap_int_nextref(
1003 assert( refsp != NULL );
1004 assert( *refsp != NULL );
1005 assert( cntp != NULL );
1014 if ( (*refsp)[ *cntp ] == NULL ) {
1022 * Chase v3 referrals
1025 * (IN) ld = LDAP connection handle
1026 * (IN) lr = LDAP Request structure
1027 * (IN) refs = array of pointers to referral strings that we will chase
1028 * The array will be free'd by this function when no longer needed
1029 * (IN) sref != 0 if following search reference
1030 * (OUT) errstrp = Place to return a string of referrals which could not be followed
1031 * (OUT) hadrefp = 1 if sucessfully followed referral
1033 * Return value - number of referrals followed
1036 ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, int sref, char **errstrp, int *hadrefp )
1039 int unfollowedcnt = 0;
1040 LDAPRequest *origreq;
1041 LDAPURLDesc *srv = NULL;
1043 char **refarray = NULL;
1045 int rc, count, i, j, id;
1048 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
1051 Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referrals\n", 0, 0, 0 );
1056 /* If no referrals in array, return */
1057 if ( (refs == NULL) || ( (refs)[0] == NULL) ) {
1062 /* Check for hop limit exceeded */
1063 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1064 Debug( LDAP_DEBUG_ANY,
1065 "more than %d referral hops (dropping)\n", ld->ld_refhoplimit, 0, 0 );
1066 ld->ld_errno = LDAP_REFERRAL_LIMIT_EXCEEDED;
1071 /* find original request */
1073 origreq->lr_parent != NULL;
1074 origreq = origreq->lr_parent )
1082 if ( ld->ld_nextref_proc == NULL ) {
1083 ld->ld_nextref_proc = ldap_int_nextref;
1086 /* parse out & follow referrals */
1088 for ( ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params );
1090 ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params ) )
1093 /* Parse the referral URL */
1094 rc = ldap_url_parse_ext( refarray[i], &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1095 if ( rc != LDAP_URL_SUCCESS ) {
1096 /* ldap_url_parse_ext() returns LDAP_URL_* errors
1097 * which do not map on API errors */
1098 ld->ld_errno = LDAP_PARAM_ERROR;
1103 if( srv->lud_crit_exts ) {
1106 /* If StartTLS is the only critical ext, OK. */
1107 if ( find_tls_ext( srv ) == 2 && srv->lud_crit_exts == 1 )
1111 /* we do not support any other extensions */
1112 ld->ld_errno = LDAP_NOT_SUPPORTED;
1118 /* check connection for re-bind in progress */
1119 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1120 /* See if we've already requested this DN with this conn */
1123 ber_len_t len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1124 for ( lp = origreq; lp; ) {
1125 if ( lp->lr_conn == lc
1126 && len == lp->lr_dn.bv_len
1128 && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) == 0 )
1133 if ( lp == origreq ) {
1136 lp = lp->lr_refnext;
1140 ldap_free_urllist( srv );
1142 ld->ld_errno = LDAP_CLIENT_LOOP;
1147 if ( lc->lconn_rebind_inprogress ) {
1148 /* We are already chasing a referral or search reference and a
1149 * bind on that connection is in progress. We must queue
1150 * referrals on that connection, so we don't get a request
1151 * going out before the bind operation completes. This happens
1152 * if two search references come in one behind the other
1153 * for the same server with different contexts.
1155 Debug( LDAP_DEBUG_TRACE,
1156 "ldap_chase_v3referrals: queue referral \"%s\"\n",
1158 if( lc->lconn_rebind_queue == NULL ) {
1159 /* Create a referral list */
1160 lc->lconn_rebind_queue =
1161 (char ***) LDAP_MALLOC( sizeof(void *) * 2);
1163 if( lc->lconn_rebind_queue == NULL) {
1164 ld->ld_errno = LDAP_NO_MEMORY;
1169 lc->lconn_rebind_queue[0] = refarray;
1170 lc->lconn_rebind_queue[1] = NULL;
1174 /* Count how many referral arrays we already have */
1175 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
1179 /* Add the new referral to the list */
1180 lc->lconn_rebind_queue = (char ***) LDAP_REALLOC(
1181 lc->lconn_rebind_queue, sizeof(void *) * (j + 2));
1183 if( lc->lconn_rebind_queue == NULL ) {
1184 ld->ld_errno = LDAP_NO_MEMORY;
1188 lc->lconn_rebind_queue[j] = refarray;
1189 lc->lconn_rebind_queue[j+1] = NULL;
1193 /* We have queued the referral/reference, now just return */
1196 count = 1; /* Pretend we already followed referral */
1200 /* Re-encode the request with the new starting point of the search.
1201 * Note: In the future we also need to replace the filter if one
1202 * was provided with the search reference
1205 /* For references we don't want old dn if new dn empty */
1206 if ( sref && srv->lud_dn == NULL ) {
1207 srv->lud_dn = LDAP_STRDUP( "" );
1210 LDAP_NEXT_MSGID( ld, id );
1211 ber = re_encode_request( ld, origreq->lr_ber, id,
1212 sref, srv, &rinfo.ri_request );
1215 ld->ld_errno = LDAP_ENCODING_ERROR;
1220 Debug( LDAP_DEBUG_TRACE,
1221 "ldap_chase_v3referral: msgid %d, url \"%s\"\n",
1222 lr->lr_msgid, refarray[i], 0);
1224 /* Send the new request to the server - may require a bind */
1225 rinfo.ri_msgid = origreq->lr_origid;
1226 rinfo.ri_url = refarray[i];
1227 #ifdef LDAP_R_COMPILE
1228 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1230 rc = ldap_send_server_request( ld, ber, id,
1231 origreq, &srv, NULL, &rinfo );
1232 #ifdef LDAP_R_COMPILE
1233 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1236 /* Failure, try next referral in the list */
1237 Debug( LDAP_DEBUG_ANY, "Unable to chase referral \"%s\" (%d: %s)\n",
1238 refarray[i], ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1239 unfollowedcnt += ldap_append_referral( ld, &unfollowed, refarray[i] );
1240 ldap_free_urllist( srv );
1242 ld->ld_errno = LDAP_REFERRAL;
1244 /* Success, no need to try this referral list further */
1249 /* check if there is a queue of referrals that came in during bind */
1251 lc = find_connection( ld, srv, 1 );
1253 ld->ld_errno = LDAP_OPERATIONS_ERROR;
1259 if ( lc->lconn_rebind_queue != NULL ) {
1260 /* Release resources of previous list */
1261 LDAP_VFREE( refarray );
1263 ldap_free_urllist( srv );
1266 /* Pull entries off end of queue so list always null terminated */
1267 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++ )
1269 refarray = lc->lconn_rebind_queue[j - 1];
1270 lc->lconn_rebind_queue[j-1] = NULL;
1271 /* we pulled off last entry from queue, free queue */
1273 LDAP_FREE( lc->lconn_rebind_queue );
1274 lc->lconn_rebind_queue = NULL;
1276 /* restart the loop the with new referral list */
1280 break; /* referral followed, break out of for loop */
1282 } /* end for loop */
1284 LDAP_VFREE( refarray );
1285 ldap_free_urllist( srv );
1286 LDAP_FREE( *errstrp );
1290 LDAP_FREE( unfollowed );
1293 *errstrp = unfollowed;
1299 * XXX merging of errors in this routine needs to be improved
1302 ldap_chase_referrals( LDAP *ld,
1310 char *p, *ref, *unfollowed;
1311 LDAPRequest *origreq;
1317 Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
1319 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
1322 if ( *errstrp == NULL ) {
1326 len = strlen( *errstrp );
1327 for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
1328 if ( strncasecmp( p, LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
1330 p += LDAP_REF_STR_LEN;
1335 if ( len < LDAP_REF_STR_LEN ) {
1339 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1340 Debug( LDAP_DEBUG_ANY,
1341 "more than %d referral hops (dropping)\n",
1342 ld->ld_refhoplimit, 0, 0 );
1343 /* XXX report as error in ld->ld_errno? */
1347 /* find original request */
1348 for ( origreq = lr; origreq->lr_parent != NULL;
1349 origreq = origreq->lr_parent ) {
1356 /* parse out & follow referrals */
1357 for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
1358 p = strchr( ref, '\n' );
1363 rc = ldap_url_parse_ext( ref, &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1364 if ( rc != LDAP_URL_SUCCESS ) {
1365 Debug( LDAP_DEBUG_TRACE,
1366 "ignoring %s referral <%s>\n",
1367 ref, rc == LDAP_URL_ERR_BADSCHEME ? "unknown" : "incorrect", 0 );
1368 rc = ldap_append_referral( ld, &unfollowed, ref );
1373 Debug( LDAP_DEBUG_TRACE,
1374 "chasing LDAP referral: <%s>\n", ref, 0, 0 );
1378 /* See if we've already been here */
1379 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1382 ber_len_t len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1383 for ( lp = lr; lp; lp = lp->lr_parent ) {
1384 if ( lp->lr_conn == lc
1385 && len == lp->lr_dn.bv_len )
1387 if ( len && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) )
1394 ldap_free_urllist( srv );
1395 ld->ld_errno = LDAP_CLIENT_LOOP;
1401 LDAP_NEXT_MSGID( ld, id );
1402 ber = re_encode_request( ld, origreq->lr_ber,
1403 id, sref, srv, &rinfo.ri_request );
1405 if ( ber == NULL ) {
1409 /* copy the complete referral for rebind process */
1410 rinfo.ri_url = LDAP_STRDUP( ref );
1412 rinfo.ri_msgid = origreq->lr_origid;
1414 #ifdef LDAP_R_COMPILE
1415 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1417 rc = ldap_send_server_request( ld, ber, id,
1418 lr, &srv, NULL, &rinfo );
1419 #ifdef LDAP_R_COMPILE
1420 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1423 LDAP_FREE( rinfo.ri_url );
1428 Debug( LDAP_DEBUG_ANY,
1429 "Unable to chase referral \"%s\" (%d: %s)\n",
1430 ref, ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1431 rc = ldap_append_referral( ld, &unfollowed, ref );
1434 ldap_free_urllist(srv);
1437 LDAP_FREE( *errstrp );
1438 *errstrp = unfollowed;
1440 return(( rc == 0 ) ? count : rc );
1445 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
1449 if ( *referralsp == NULL ) {
1451 *referralsp = (char *)LDAP_MALLOC( strlen( s ) + LDAP_REF_STR_LEN
1455 *referralsp = (char *)LDAP_REALLOC( *referralsp,
1456 strlen( *referralsp ) + strlen( s ) + 2 );
1459 if ( *referralsp == NULL ) {
1460 ld->ld_errno = LDAP_NO_MEMORY;
1465 strcpy( *referralsp, LDAP_REF_STR );
1467 strcat( *referralsp, "\n" );
1469 strcat( *referralsp, s );
1477 re_encode_request( LDAP *ld,
1478 BerElement *origber,
1485 * XXX this routine knows way too much about how the lber library works!
1493 BerElement tmpber, *ber;
1496 Debug( LDAP_DEBUG_TRACE,
1497 "re_encode_request: new msgid %ld, new dn <%s>\n",
1499 ( srv == NULL || srv->lud_dn == NULL) ? "NONE" : srv->lud_dn, 0 );
1504 * all LDAP requests are sequences that start with a message id.
1505 * For all except delete, this is followed by a sequence that is
1506 * tagged with the operation code. For delete, the provided DN
1507 * is not wrapped by a sequence.
1509 rtag = ber_scanf( &tmpber, "{it", /*}*/ &along, &tag );
1511 if ( rtag == LBER_ERROR ) {
1512 ld->ld_errno = LDAP_DECODING_ERROR;
1517 if ( tag == LDAP_REQ_BIND ) {
1518 /* bind requests have a version number before the DN & other stuff */
1519 rtag = ber_scanf( &tmpber, "{im" /*}*/, &ver, &dn );
1521 } else if ( tag == LDAP_REQ_DELETE ) {
1522 /* delete requests don't have a DN wrapping sequence */
1523 rtag = ber_scanf( &tmpber, "m", &dn );
1525 } else if ( tag == LDAP_REQ_SEARCH ) {
1526 /* search requests need to be re-scope-ed */
1527 rtag = ber_scanf( &tmpber, "{me" /*"}"*/, &dn, &scope );
1529 if( srv->lud_scope != LDAP_SCOPE_DEFAULT ) {
1530 /* use the scope provided in reference */
1531 scope = srv->lud_scope;
1533 } else if ( sref ) {
1534 /* use scope implied by previous operation
1537 * subtree -> subtree
1538 * subordinate -> subtree
1542 case LDAP_SCOPE_BASE:
1543 case LDAP_SCOPE_ONELEVEL:
1544 scope = LDAP_SCOPE_BASE;
1546 case LDAP_SCOPE_SUBTREE:
1547 case LDAP_SCOPE_SUBORDINATE:
1548 scope = LDAP_SCOPE_SUBTREE;
1554 rtag = ber_scanf( &tmpber, "{m" /*}*/, &dn );
1557 if( rtag == LBER_ERROR ) {
1558 ld->ld_errno = LDAP_DECODING_ERROR;
1562 /* restore character zero'd out by ber_scanf*/
1563 dn.bv_val[dn.bv_len] = tmpber.ber_tag;
1565 if (( ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
1569 if ( srv->lud_dn ) {
1570 ber_str2bv( srv->lud_dn, 0, 0, &dn );
1573 if ( tag == LDAP_REQ_BIND ) {
1574 rc = ber_printf( ber, "{it{iO" /*}}*/, msgid, tag, ver, &dn );
1575 } else if ( tag == LDAP_REQ_DELETE ) {
1576 rc = ber_printf( ber, "{itON}", msgid, tag, &dn );
1577 } else if ( tag == LDAP_REQ_SEARCH ) {
1578 rc = ber_printf( ber, "{it{Oe" /*}}*/, msgid, tag, &dn, scope );
1580 rc = ber_printf( ber, "{it{O" /*}}*/, msgid, tag, &dn );
1584 ld->ld_errno = LDAP_ENCODING_ERROR;
1589 if ( tag != LDAP_REQ_DELETE && (
1590 ber_write(ber, tmpber.ber_ptr, ( tmpber.ber_end - tmpber.ber_ptr ), 0)
1591 != ( tmpber.ber_end - tmpber.ber_ptr ) ||
1592 ber_printf( ber, /*{{*/ "N}N}" ) == -1 ) )
1594 ld->ld_errno = LDAP_ENCODING_ERROR;
1600 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
1601 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
1603 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ber, 0 );
1605 #endif /* LDAP_DEBUG */
1607 *type = tag; /* return request type */
1613 ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid )
1617 #ifdef LDAP_R_COMPILE
1618 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1620 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1621 if ( lr->lr_status == LDAP_REQST_COMPLETED ) {
1622 continue; /* Skip completed requests */
1624 if ( msgid == lr->lr_msgid ) {
1629 #ifdef LDAP_R_COMPILE
1630 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1637 ldap_return_request( LDAP *ld, LDAPRequest *lrx, int freeit )
1641 #ifdef LDAP_R_COMPILE
1642 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1644 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1646 if ( lr->lr_refcnt > 0 ) {
1649 } else if ( lr->lr_refcnt < 0 ) {
1651 if ( lr->lr_refcnt == 0 ) {
1659 ldap_free_request_int( ld, lrx );
1661 } else if ( freeit ) {
1662 ldap_free_request( ld, lrx );
1664 #ifdef LDAP_R_COMPILE
1665 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );