2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2008 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 #ifdef LDAP_CONNECTIONLESS
259 if ( LDAP_IS_UDP( ld )) {
260 BerElement tmpber = *ber;
261 ber_rewind( &tmpber );
262 rc = ber_write( &tmpber, ld->ld_options.ldo_peer,
263 sizeof( struct sockaddr ), 0 );
265 ld->ld_errno = LDAP_ENCODING_ERROR;
271 /* If we still have an incomplete write, try to finish it before
272 * dealing with the new request. If we don't finish here, return
273 * LDAP_BUSY and let the caller retry later. We only allow a single
274 * request to be in WRITING state.
277 if ( ld->ld_requests &&
278 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
279 ldap_int_flush_request( ld, ld->ld_requests ) < 0 )
285 lr = (LDAPRequest *)LDAP_CALLOC( 1, sizeof( LDAPRequest ) );
287 ld->ld_errno = LDAP_NO_MEMORY;
288 ldap_free_connection( ld, lc, 0, 0 );
291 /* Forget about the bind */
292 --parentreq->lr_outrefcnt;
296 lr->lr_msgid = msgid;
297 lr->lr_status = LDAP_REQST_INPROGRESS;
298 lr->lr_res_errno = LDAP_SUCCESS; /* optimistic */
301 if ( parentreq != NULL ) { /* sub-request */
303 /* Increment if we didn't do it before the bind */
304 ++parentreq->lr_outrefcnt;
306 lr->lr_origid = parentreq->lr_origid;
307 lr->lr_parentcnt = ++parentreq->lr_parentcnt;
308 lr->lr_parent = parentreq;
309 lr->lr_refnext = parentreq->lr_child;
310 parentreq->lr_child = lr;
311 } else { /* original request */
312 lr->lr_origid = lr->lr_msgid;
315 /* Extract requestDN for future reference */
317 BerElement tmpber = *ber;
321 ber_reset( &tmpber, 1 );
322 rtag = ber_scanf( &tmpber, "{it", /*}*/ &bint, &tag );
325 rtag = ber_scanf( &tmpber, "{i" /*}*/, &bint );
327 case LDAP_REQ_DELETE:
330 rtag = ber_scanf( &tmpber, "{" /*}*/ );
331 case LDAP_REQ_ABANDON:
334 if ( tag != LDAP_REQ_ABANDON ) {
335 ber_skip_tag( &tmpber, &lr->lr_dn.bv_len );
336 lr->lr_dn.bv_val = tmpber.ber_ptr;
341 lr->lr_next = ld->ld_requests;
342 if ( lr->lr_next != NULL ) {
343 lr->lr_next->lr_prev = lr;
345 ld->ld_requests = lr;
347 ld->ld_errno = LDAP_SUCCESS;
348 if ( ldap_int_flush_request( ld, lr ) == -1 ) {
355 /* return 0 if no StartTLS ext, 1 if present, 2 if critical */
357 find_tls_ext( LDAPURLDesc *srv )
362 if ( !srv->lud_exts )
365 for (i=0; srv->lud_exts[i]; i++) {
367 ext = srv->lud_exts[i];
368 if ( ext[0] == '!') {
372 if ( !strcasecmp( ext, "StartTLS" ) ||
373 !strcasecmp( ext, "X-StartTLS" ) ||
374 !strcmp( ext, LDAP_EXOP_START_TLS )) {
382 ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist, int use_ldsb,
383 int connect, LDAPreqinfo *bind )
388 Debug( LDAP_DEBUG_TRACE, "ldap_new_connection %d %d %d\n",
389 use_ldsb, connect, (bind != NULL) );
391 * make a new LDAP server connection
392 * XXX open connection synchronously for now
394 lc = (LDAPConn *)LDAP_CALLOC( 1, sizeof( LDAPConn ) );
396 ld->ld_errno = LDAP_NO_MEMORY;
401 assert( ld->ld_sb != NULL );
402 lc->lconn_sb = ld->ld_sb;
405 lc->lconn_sb = ber_sockbuf_alloc();
406 if ( lc->lconn_sb == NULL ) {
407 LDAP_FREE( (char *)lc );
408 ld->ld_errno = LDAP_NO_MEMORY;
414 LDAPURLDesc **srvp, *srv = NULL;
416 async = LDAP_BOOL_GET( &ld->ld_options, LDAP_BOOL_CONNECT_ASYNC );
418 for ( srvp = srvlist; *srvp != NULL; srvp = &(*srvp)->lud_next ) {
421 rc = ldap_int_open_connection( ld, lc, *srvp, async );
425 if ( ld->ld_urllist_proc && ( !async || rc != -2 ) ) {
426 ld->ld_urllist_proc( ld, srvlist, srvp, ld->ld_urllist_params );
435 ber_sockbuf_free( lc->lconn_sb );
437 LDAP_FREE( (char *)lc );
438 ld->ld_errno = LDAP_SERVER_DOWN;
442 lc->lconn_server = ldap_url_dup( srv );
445 lc->lconn_status = async ? LDAP_CONNST_CONNECTING : LDAP_CONNST_CONNECTED;
446 #ifdef LDAP_R_COMPILE
447 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
449 lc->lconn_next = ld->ld_conns;
451 #ifdef LDAP_R_COMPILE
452 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
455 if ( lc->lconn_server->lud_exts ) {
458 int rc, ext = find_tls_ext( lc->lconn_server );
460 LDAPConn *savedefconn;
462 savedefconn = ld->ld_defconn;
463 ++lc->lconn_refcnt; /* avoid premature free */
466 #ifdef LDAP_R_COMPILE
467 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
468 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
470 rc = ldap_start_tls_s( ld, NULL, NULL );
471 #ifdef LDAP_R_COMPILE
472 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
473 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
475 ld->ld_defconn = savedefconn;
478 if ( rc != LDAP_SUCCESS && ext == 2 ) {
479 ldap_free_connection( ld, lc, 1, 0 );
488 if ( bind != NULL ) {
490 LDAPConn *savedefconn;
492 /* Set flag to prevent additional referrals
493 * from being processed on this
494 * connection until the bind has completed
496 lc->lconn_rebind_inprogress = 1;
497 /* V3 rebind function */
498 if ( ld->ld_rebind_proc != NULL) {
499 LDAPURLDesc *srvfunc;
501 srvfunc = ldap_url_dup( *srvlist );
502 if ( srvfunc == NULL ) {
503 ld->ld_errno = LDAP_NO_MEMORY;
506 savedefconn = ld->ld_defconn;
507 ++lc->lconn_refcnt; /* avoid premature free */
510 Debug( LDAP_DEBUG_TRACE, "Call application rebind_proc\n", 0, 0, 0);
511 #ifdef LDAP_R_COMPILE
512 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
513 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
515 err = (*ld->ld_rebind_proc)( ld,
516 bind->ri_url, bind->ri_request, bind->ri_msgid,
517 ld->ld_rebind_params );
518 #ifdef LDAP_R_COMPILE
519 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
520 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
523 ld->ld_defconn = savedefconn;
528 ldap_free_connection( ld, lc, 1, 0 );
531 ldap_free_urldesc( srvfunc );
536 struct berval passwd = BER_BVNULL;
538 savedefconn = ld->ld_defconn;
539 ++lc->lconn_refcnt; /* avoid premature free */
542 Debug( LDAP_DEBUG_TRACE,
543 "anonymous rebind via ldap_sasl_bind(\"\")\n",
546 #ifdef LDAP_R_COMPILE
547 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
548 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
550 rc = ldap_sasl_bind( ld, "", LDAP_SASL_SIMPLE, &passwd,
551 NULL, NULL, &msgid );
552 if ( rc != LDAP_SUCCESS ) {
556 for ( err = 1; err > 0; ) {
557 struct timeval tv = { 0, 100000 };
558 LDAPMessage *res = NULL;
560 switch ( ldap_result( ld, msgid, LDAP_MSG_ALL, &tv, &res ) ) {
566 #ifdef LDAP_R_COMPILE
567 ldap_pvt_thread_yield();
572 rc = ldap_parse_result( ld, res, &err, NULL, NULL, NULL, NULL, 1 );
573 if ( rc != LDAP_SUCCESS ) {
576 } else if ( err != LDAP_SUCCESS ) {
579 /* else err == LDAP_SUCCESS == 0 */
583 Debug( LDAP_DEBUG_TRACE,
584 "ldap_new_connection %p: "
585 "unexpected response %d "
586 "from BIND request id=%d\n",
587 (void *) ld, ldap_msgtype( res ), msgid );
593 #ifdef LDAP_R_COMPILE
594 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
595 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
597 ld->ld_defconn = savedefconn;
601 ldap_free_connection( ld, lc, 1, 0 );
606 lc->lconn_rebind_inprogress = 0;
614 find_connection( LDAP *ld, LDAPURLDesc *srv, int any )
616 * return an existing connection (if any) to the server srv
617 * if "any" is non-zero, check for any server in the "srv" chain
621 LDAPURLDesc *lcu, *lsu;
622 int lcu_port, lsu_port;
625 #ifdef LDAP_R_COMPILE
626 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
628 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
629 lcu = lc->lconn_server;
630 lcu_port = ldap_pvt_url_scheme_port( lcu->lud_scheme,
633 for ( lsu = srv; lsu != NULL; lsu = lsu->lud_next ) {
634 lsu_port = ldap_pvt_url_scheme_port( lsu->lud_scheme,
637 if ( lsu_port == lcu_port
638 && strcmp( lcu->lud_scheme, lsu->lud_scheme ) == 0
639 && lcu->lud_host != NULL && *lcu->lud_host != '\0'
640 && lsu->lud_host != NULL && *lsu->lud_host != '\0'
641 && strcasecmp( lsu->lud_host, lcu->lud_host ) == 0 )
652 #ifdef LDAP_R_COMPILE
653 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
661 use_connection( LDAP *ld, LDAPConn *lc )
664 lc->lconn_lastused = time( NULL );
669 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
671 LDAPConn *tmplc, *prevlc;
673 Debug( LDAP_DEBUG_TRACE,
674 "ldap_free_connection %d %d\n",
677 if ( force || --lc->lconn_refcnt <= 0 ) {
678 /* remove from connections list first */
679 #ifdef LDAP_R_COMPILE
680 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
683 for ( prevlc = NULL, tmplc = ld->ld_conns;
685 tmplc = tmplc->lconn_next )
688 if ( prevlc == NULL ) {
689 ld->ld_conns = tmplc->lconn_next;
691 prevlc->lconn_next = tmplc->lconn_next;
693 if ( ld->ld_defconn == lc ) {
694 ld->ld_defconn = NULL;
700 #ifdef LDAP_R_COMPILE
701 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
704 /* process connection callbacks */
706 struct ldapoptions *lo;
710 lo = &ld->ld_options;
711 if ( lo->ldo_conn_cbs ) {
712 for ( ll=lo->ldo_conn_cbs; ll; ll=ll->ll_next ) {
714 cb->lc_del( ld, lc->lconn_sb, cb );
717 lo = LDAP_INT_GLOBAL_OPT();
718 if ( lo->ldo_conn_cbs ) {
719 for ( ll=lo->ldo_conn_cbs; ll; ll=ll->ll_next ) {
721 cb->lc_del( ld, lc->lconn_sb, cb );
726 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
727 ldap_mark_select_clear( ld, lc->lconn_sb );
729 ldap_send_unbind( ld, lc->lconn_sb,
734 if ( lc->lconn_ber != NULL ) {
735 ber_free( lc->lconn_ber, 1 );
738 ldap_int_sasl_close( ld, lc );
740 ldap_int_gssapi_close( ld, lc );
743 ldap_free_urllist( lc->lconn_server );
745 /* FIXME: is this at all possible?
746 * ldap_ld_free() in unbind.c calls ldap_free_connection()
747 * with force == 1 __after__ explicitly calling
748 * ldap_free_request() on all requests */
752 for ( lr = ld->ld_requests; lr; ) {
753 LDAPRequest *lr_next = lr->lr_next;
755 if ( lr->lr_conn == lc ) {
756 ldap_free_request_int( ld, lr );
763 if ( lc->lconn_sb != ld->ld_sb ) {
764 ber_sockbuf_free( lc->lconn_sb );
766 ber_int_sb_close( lc->lconn_sb );
769 if ( lc->lconn_rebind_queue != NULL) {
771 for( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
772 LDAP_VFREE( lc->lconn_rebind_queue[i] );
774 LDAP_FREE( lc->lconn_rebind_queue );
779 Debug( LDAP_DEBUG_TRACE,
780 "ldap_free_connection: actually freed\n",
784 lc->lconn_lastused = time( NULL );
785 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
786 lc->lconn_refcnt, 0, 0 );
793 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
798 Debug( LDAP_DEBUG_TRACE, "** ld %p Connection%s:\n", (void *)ld, all ? "s" : "", 0 );
799 for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
800 if ( lc->lconn_server != NULL ) {
801 Debug( LDAP_DEBUG_TRACE, "* host: %s port: %d%s\n",
802 ( lc->lconn_server->lud_host == NULL ) ? "(null)"
803 : lc->lconn_server->lud_host,
804 lc->lconn_server->lud_port, ( lc->lconn_sb ==
805 ld->ld_sb ) ? " (default)" : "" );
807 Debug( LDAP_DEBUG_TRACE, " refcnt: %d status: %s\n", lc->lconn_refcnt,
808 ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET )
810 ( lc->lconn_status == LDAP_CONNST_CONNECTING )
811 ? "Connecting" : "Connected", 0 );
812 Debug( LDAP_DEBUG_TRACE, " last used: %s%s\n",
813 ldap_pvt_ctime( &lc->lconn_lastused, timebuf ),
814 lc->lconn_rebind_inprogress ? " rebind in progress" : "", 0 );
815 if ( lc->lconn_rebind_inprogress ) {
816 if ( lc->lconn_rebind_queue != NULL) {
819 for ( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
821 for( j = 0; lc->lconn_rebind_queue[i][j] != 0; j++ ) {
822 Debug( LDAP_DEBUG_TRACE, " queue %d entry %d - %s\n",
823 i, j, lc->lconn_rebind_queue[i][j] );
827 Debug( LDAP_DEBUG_TRACE, " queue is empty\n", 0, 0, 0 );
830 Debug( LDAP_DEBUG_TRACE, "\n", 0, 0, 0 );
839 ldap_dump_requests_and_responses( LDAP *ld )
845 Debug( LDAP_DEBUG_TRACE, "** ld %p Outstanding Requests:\n",
847 lr = ld->ld_requests;
849 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
851 for ( i = 0; lr != NULL; lr = lr->lr_next, i++ ) {
852 Debug( LDAP_DEBUG_TRACE, " * msgid %d, origid %d, status %s\n",
853 lr->lr_msgid, lr->lr_origid,
854 ( lr->lr_status == LDAP_REQST_INPROGRESS ) ? "InProgress" :
855 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
856 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
857 ( lr->lr_status == LDAP_REQST_WRITING ) ? "Writing" :
858 ( lr->lr_status == LDAP_REQST_COMPLETED ) ? "RequestCompleted"
860 Debug( LDAP_DEBUG_TRACE, " outstanding referrals %d, parent count %d\n",
861 lr->lr_outrefcnt, lr->lr_parentcnt, 0 );
863 Debug( LDAP_DEBUG_TRACE, " ld %p request count %d (abandoned %lu)\n",
864 (void *)ld, i, ld->ld_nabandoned );
865 Debug( LDAP_DEBUG_TRACE, "** ld %p Response Queue:\n", (void *)ld, 0, 0 );
866 if ( ( lm = ld->ld_responses ) == NULL ) {
867 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
869 for ( i = 0; lm != NULL; lm = lm->lm_next, i++ ) {
870 Debug( LDAP_DEBUG_TRACE, " * msgid %d, type %lu\n",
871 lm->lm_msgid, (unsigned long)lm->lm_msgtype, 0 );
872 if ( lm->lm_chain != NULL ) {
873 Debug( LDAP_DEBUG_TRACE, " chained responses:\n", 0, 0, 0 );
874 for ( l = lm->lm_chain; l != NULL; l = l->lm_chain ) {
875 Debug( LDAP_DEBUG_TRACE,
876 " * msgid %d, type %lu\n",
878 (unsigned long)l->lm_msgtype, 0 );
882 Debug( LDAP_DEBUG_TRACE, " ld %p response count %d\n", (void *)ld, i, 0 );
884 #endif /* LDAP_DEBUG */
887 ldap_free_request_int( LDAP *ld, LDAPRequest *lr )
889 /* if lr_refcnt > 0, the request has been looked up
890 * by ldap_find_request_by_msgid(); if in the meanwhile
891 * the request is free()'d by someone else, just decrease
892 * the reference count and extract it from the request
893 * list; later on, it will be freed. */
894 if ( lr->lr_prev == NULL ) {
895 if ( lr->lr_refcnt == 0 ) {
896 /* free'ing the first request? */
897 assert( ld->ld_requests == lr );
900 if ( ld->ld_requests == lr ) {
901 ld->ld_requests = lr->lr_next;
905 lr->lr_prev->lr_next = lr->lr_next;
908 if ( lr->lr_next != NULL ) {
909 lr->lr_next->lr_prev = lr->lr_prev;
912 if ( lr->lr_refcnt > 0 ) {
913 lr->lr_refcnt = -lr->lr_refcnt;
921 if ( lr->lr_ber != NULL ) {
922 ber_free( lr->lr_ber, 1 );
926 if ( lr->lr_res_error != NULL ) {
927 LDAP_FREE( lr->lr_res_error );
928 lr->lr_res_error = NULL;
931 if ( lr->lr_res_matched != NULL ) {
932 LDAP_FREE( lr->lr_res_matched );
933 lr->lr_res_matched = NULL;
940 ldap_free_request( LDAP *ld, LDAPRequest *lr )
942 #ifdef LDAP_R_COMPILE
943 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
946 Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
947 lr->lr_origid, lr->lr_msgid, 0 );
949 /* free all referrals (child requests) */
950 while ( lr->lr_child ) {
951 ldap_free_request( ld, lr->lr_child );
954 if ( lr->lr_parent != NULL ) {
957 --lr->lr_parent->lr_outrefcnt;
958 for ( lrp = &lr->lr_parent->lr_child;
960 lrp = &(*lrp)->lr_refnext );
963 *lrp = lr->lr_refnext;
966 ldap_free_request_int( ld, lr );
970 * call first time with *cntp = -1
971 * when returns *cntp == -1, no referrals are left
973 * NOTE: may replace *refsp, or shuffle the contents
974 * of the original array.
976 static int ldap_int_nextref(
982 assert( refsp != NULL );
983 assert( *refsp != NULL );
984 assert( cntp != NULL );
993 if ( (*refsp)[ *cntp ] == NULL ) {
1001 * Chase v3 referrals
1004 * (IN) ld = LDAP connection handle
1005 * (IN) lr = LDAP Request structure
1006 * (IN) refs = array of pointers to referral strings that we will chase
1007 * The array will be free'd by this function when no longer needed
1008 * (IN) sref != 0 if following search reference
1009 * (OUT) errstrp = Place to return a string of referrals which could not be followed
1010 * (OUT) hadrefp = 1 if sucessfully followed referral
1012 * Return value - number of referrals followed
1015 ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, int sref, char **errstrp, int *hadrefp )
1018 int unfollowedcnt = 0;
1019 LDAPRequest *origreq;
1020 LDAPURLDesc *srv = NULL;
1022 char **refarray = NULL;
1024 int rc, count, i, j, id;
1027 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
1030 Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referrals\n", 0, 0, 0 );
1035 /* If no referrals in array, return */
1036 if ( (refs == NULL) || ( (refs)[0] == NULL) ) {
1041 /* Check for hop limit exceeded */
1042 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1043 Debug( LDAP_DEBUG_ANY,
1044 "more than %d referral hops (dropping)\n", ld->ld_refhoplimit, 0, 0 );
1045 ld->ld_errno = LDAP_REFERRAL_LIMIT_EXCEEDED;
1050 /* find original request */
1052 origreq->lr_parent != NULL;
1053 origreq = origreq->lr_parent )
1061 if ( ld->ld_nextref_proc == NULL ) {
1062 ld->ld_nextref_proc = ldap_int_nextref;
1065 /* parse out & follow referrals */
1067 for ( ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params );
1069 ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params ) )
1072 /* Parse the referral URL */
1073 rc = ldap_url_parse_ext( refarray[i], &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1074 if ( rc != LDAP_URL_SUCCESS ) {
1075 /* ldap_url_parse_ext() returns LDAP_URL_* errors
1076 * which do not map on API errors */
1077 ld->ld_errno = LDAP_PARAM_ERROR;
1082 if( srv->lud_crit_exts ) {
1085 /* If StartTLS is the only critical ext, OK. */
1086 if ( find_tls_ext( srv ) == 2 && srv->lud_crit_exts == 1 )
1090 /* we do not support any other extensions */
1091 ld->ld_errno = LDAP_NOT_SUPPORTED;
1097 /* check connection for re-bind in progress */
1098 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1099 /* See if we've already requested this DN with this conn */
1102 ber_len_t len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1103 for ( lp = origreq; lp; ) {
1104 if ( lp->lr_conn == lc
1105 && len == lp->lr_dn.bv_len
1107 && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) == 0 )
1112 if ( lp == origreq ) {
1115 lp = lp->lr_refnext;
1119 ldap_free_urllist( srv );
1121 ld->ld_errno = LDAP_CLIENT_LOOP;
1126 if ( lc->lconn_rebind_inprogress ) {
1127 /* We are already chasing a referral or search reference and a
1128 * bind on that connection is in progress. We must queue
1129 * referrals on that connection, so we don't get a request
1130 * going out before the bind operation completes. This happens
1131 * if two search references come in one behind the other
1132 * for the same server with different contexts.
1134 Debug( LDAP_DEBUG_TRACE,
1135 "ldap_chase_v3referrals: queue referral \"%s\"\n",
1137 if( lc->lconn_rebind_queue == NULL ) {
1138 /* Create a referral list */
1139 lc->lconn_rebind_queue =
1140 (char ***) LDAP_MALLOC( sizeof(void *) * 2);
1142 if( lc->lconn_rebind_queue == NULL) {
1143 ld->ld_errno = LDAP_NO_MEMORY;
1148 lc->lconn_rebind_queue[0] = refarray;
1149 lc->lconn_rebind_queue[1] = NULL;
1153 /* Count how many referral arrays we already have */
1154 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
1158 /* Add the new referral to the list */
1159 lc->lconn_rebind_queue = (char ***) LDAP_REALLOC(
1160 lc->lconn_rebind_queue, sizeof(void *) * (j + 2));
1162 if( lc->lconn_rebind_queue == NULL ) {
1163 ld->ld_errno = LDAP_NO_MEMORY;
1167 lc->lconn_rebind_queue[j] = refarray;
1168 lc->lconn_rebind_queue[j+1] = NULL;
1172 /* We have queued the referral/reference, now just return */
1175 count = 1; /* Pretend we already followed referral */
1179 /* Re-encode the request with the new starting point of the search.
1180 * Note: In the future we also need to replace the filter if one
1181 * was provided with the search reference
1184 /* For references we don't want old dn if new dn empty */
1185 if ( sref && srv->lud_dn == NULL ) {
1186 srv->lud_dn = LDAP_STRDUP( "" );
1189 LDAP_NEXT_MSGID( ld, id );
1190 ber = re_encode_request( ld, origreq->lr_ber, id,
1191 sref, srv, &rinfo.ri_request );
1194 ld->ld_errno = LDAP_ENCODING_ERROR;
1199 Debug( LDAP_DEBUG_TRACE,
1200 "ldap_chase_v3referral: msgid %d, url \"%s\"\n",
1201 lr->lr_msgid, refarray[i], 0);
1203 /* Send the new request to the server - may require a bind */
1204 rinfo.ri_msgid = origreq->lr_origid;
1205 rinfo.ri_url = refarray[i];
1206 #ifdef LDAP_R_COMPILE
1207 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1209 rc = ldap_send_server_request( ld, ber, id,
1210 origreq, &srv, NULL, &rinfo );
1211 #ifdef LDAP_R_COMPILE
1212 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1215 /* Failure, try next referral in the list */
1216 Debug( LDAP_DEBUG_ANY, "Unable to chase referral \"%s\" (%d: %s)\n",
1217 refarray[i], ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1218 unfollowedcnt += ldap_append_referral( ld, &unfollowed, refarray[i] );
1219 ldap_free_urllist( srv );
1221 ld->ld_errno = LDAP_REFERRAL;
1223 /* Success, no need to try this referral list further */
1228 /* check if there is a queue of referrals that came in during bind */
1230 lc = find_connection( ld, srv, 1 );
1232 ld->ld_errno = LDAP_OPERATIONS_ERROR;
1238 if ( lc->lconn_rebind_queue != NULL ) {
1239 /* Release resources of previous list */
1240 LDAP_VFREE( refarray );
1242 ldap_free_urllist( srv );
1245 /* Pull entries off end of queue so list always null terminated */
1246 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++ )
1248 refarray = lc->lconn_rebind_queue[j - 1];
1249 lc->lconn_rebind_queue[j-1] = NULL;
1250 /* we pulled off last entry from queue, free queue */
1252 LDAP_FREE( lc->lconn_rebind_queue );
1253 lc->lconn_rebind_queue = NULL;
1255 /* restart the loop the with new referral list */
1259 break; /* referral followed, break out of for loop */
1261 } /* end for loop */
1263 LDAP_VFREE( refarray );
1264 ldap_free_urllist( srv );
1265 LDAP_FREE( *errstrp );
1269 LDAP_FREE( unfollowed );
1272 *errstrp = unfollowed;
1278 * XXX merging of errors in this routine needs to be improved
1281 ldap_chase_referrals( LDAP *ld,
1289 char *p, *ref, *unfollowed;
1290 LDAPRequest *origreq;
1296 Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
1298 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
1301 if ( *errstrp == NULL ) {
1305 len = strlen( *errstrp );
1306 for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
1307 if ( strncasecmp( p, LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
1309 p += LDAP_REF_STR_LEN;
1314 if ( len < LDAP_REF_STR_LEN ) {
1318 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1319 Debug( LDAP_DEBUG_ANY,
1320 "more than %d referral hops (dropping)\n",
1321 ld->ld_refhoplimit, 0, 0 );
1322 /* XXX report as error in ld->ld_errno? */
1326 /* find original request */
1327 for ( origreq = lr; origreq->lr_parent != NULL;
1328 origreq = origreq->lr_parent ) {
1335 /* parse out & follow referrals */
1336 for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
1337 p = strchr( ref, '\n' );
1342 rc = ldap_url_parse_ext( ref, &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1343 if ( rc != LDAP_URL_SUCCESS ) {
1344 Debug( LDAP_DEBUG_TRACE,
1345 "ignoring %s referral <%s>\n",
1346 ref, rc == LDAP_URL_ERR_BADSCHEME ? "unknown" : "incorrect", 0 );
1347 rc = ldap_append_referral( ld, &unfollowed, ref );
1352 Debug( LDAP_DEBUG_TRACE,
1353 "chasing LDAP referral: <%s>\n", ref, 0, 0 );
1357 /* See if we've already been here */
1358 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1361 ber_len_t len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1362 for ( lp = lr; lp; lp = lp->lr_parent ) {
1363 if ( lp->lr_conn == lc
1364 && len == lp->lr_dn.bv_len )
1366 if ( len && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) )
1373 ldap_free_urllist( srv );
1374 ld->ld_errno = LDAP_CLIENT_LOOP;
1380 LDAP_NEXT_MSGID( ld, id );
1381 ber = re_encode_request( ld, origreq->lr_ber,
1382 id, sref, srv, &rinfo.ri_request );
1384 if ( ber == NULL ) {
1388 /* copy the complete referral for rebind process */
1389 rinfo.ri_url = LDAP_STRDUP( ref );
1391 rinfo.ri_msgid = origreq->lr_origid;
1393 #ifdef LDAP_R_COMPILE
1394 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1396 rc = ldap_send_server_request( ld, ber, id,
1397 lr, &srv, NULL, &rinfo );
1398 #ifdef LDAP_R_COMPILE
1399 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1402 LDAP_FREE( rinfo.ri_url );
1407 Debug( LDAP_DEBUG_ANY,
1408 "Unable to chase referral \"%s\" (%d: %s)\n",
1409 ref, ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1410 rc = ldap_append_referral( ld, &unfollowed, ref );
1413 ldap_free_urllist(srv);
1416 LDAP_FREE( *errstrp );
1417 *errstrp = unfollowed;
1419 return(( rc == 0 ) ? count : rc );
1424 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
1428 if ( *referralsp == NULL ) {
1430 *referralsp = (char *)LDAP_MALLOC( strlen( s ) + LDAP_REF_STR_LEN
1434 *referralsp = (char *)LDAP_REALLOC( *referralsp,
1435 strlen( *referralsp ) + strlen( s ) + 2 );
1438 if ( *referralsp == NULL ) {
1439 ld->ld_errno = LDAP_NO_MEMORY;
1444 strcpy( *referralsp, LDAP_REF_STR );
1446 strcat( *referralsp, "\n" );
1448 strcat( *referralsp, s );
1456 re_encode_request( LDAP *ld,
1457 BerElement *origber,
1464 * XXX this routine knows way too much about how the lber library works!
1472 BerElement tmpber, *ber;
1475 Debug( LDAP_DEBUG_TRACE,
1476 "re_encode_request: new msgid %ld, new dn <%s>\n",
1478 ( srv == NULL || srv->lud_dn == NULL) ? "NONE" : srv->lud_dn, 0 );
1483 * all LDAP requests are sequences that start with a message id.
1484 * For all except delete, this is followed by a sequence that is
1485 * tagged with the operation code. For delete, the provided DN
1486 * is not wrapped by a sequence.
1488 rtag = ber_scanf( &tmpber, "{it", /*}*/ &along, &tag );
1490 if ( rtag == LBER_ERROR ) {
1491 ld->ld_errno = LDAP_DECODING_ERROR;
1496 if ( tag == LDAP_REQ_BIND ) {
1497 /* bind requests have a version number before the DN & other stuff */
1498 rtag = ber_scanf( &tmpber, "{im" /*}*/, &ver, &dn );
1500 } else if ( tag == LDAP_REQ_DELETE ) {
1501 /* delete requests don't have a DN wrapping sequence */
1502 rtag = ber_scanf( &tmpber, "m", &dn );
1504 } else if ( tag == LDAP_REQ_SEARCH ) {
1505 /* search requests need to be re-scope-ed */
1506 rtag = ber_scanf( &tmpber, "{me" /*"}"*/, &dn, &scope );
1508 if( srv->lud_scope != LDAP_SCOPE_DEFAULT ) {
1509 /* use the scope provided in reference */
1510 scope = srv->lud_scope;
1512 } else if ( sref ) {
1513 /* use scope implied by previous operation
1516 * subtree -> subtree
1517 * subordinate -> subtree
1521 case LDAP_SCOPE_BASE:
1522 case LDAP_SCOPE_ONELEVEL:
1523 scope = LDAP_SCOPE_BASE;
1525 case LDAP_SCOPE_SUBTREE:
1526 case LDAP_SCOPE_SUBORDINATE:
1527 scope = LDAP_SCOPE_SUBTREE;
1533 rtag = ber_scanf( &tmpber, "{m" /*}*/, &dn );
1536 if( rtag == LBER_ERROR ) {
1537 ld->ld_errno = LDAP_DECODING_ERROR;
1541 /* restore character zero'd out by ber_scanf*/
1542 dn.bv_val[dn.bv_len] = tmpber.ber_tag;
1544 if (( ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
1548 if ( srv->lud_dn ) {
1549 ber_str2bv( srv->lud_dn, 0, 0, &dn );
1552 if ( tag == LDAP_REQ_BIND ) {
1553 rc = ber_printf( ber, "{it{iO" /*}}*/, msgid, tag, ver, &dn );
1554 } else if ( tag == LDAP_REQ_DELETE ) {
1555 rc = ber_printf( ber, "{itON}", msgid, tag, &dn );
1556 } else if ( tag == LDAP_REQ_SEARCH ) {
1557 rc = ber_printf( ber, "{it{Oe" /*}}*/, msgid, tag, &dn, scope );
1559 rc = ber_printf( ber, "{it{O" /*}}*/, msgid, tag, &dn );
1563 ld->ld_errno = LDAP_ENCODING_ERROR;
1568 if ( tag != LDAP_REQ_DELETE && (
1569 ber_write(ber, tmpber.ber_ptr, ( tmpber.ber_end - tmpber.ber_ptr ), 0)
1570 != ( tmpber.ber_end - tmpber.ber_ptr ) ||
1571 ber_printf( ber, /*{{*/ "N}N}" ) == -1 ) )
1573 ld->ld_errno = LDAP_ENCODING_ERROR;
1579 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
1580 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
1582 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ber, 0 );
1584 #endif /* LDAP_DEBUG */
1586 *type = tag; /* return request type */
1592 ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid )
1596 #ifdef LDAP_R_COMPILE
1597 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1599 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1600 if ( lr->lr_status == LDAP_REQST_COMPLETED ) {
1601 continue; /* Skip completed requests */
1603 if ( msgid == lr->lr_msgid ) {
1608 #ifdef LDAP_R_COMPILE
1609 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1616 ldap_return_request( LDAP *ld, LDAPRequest *lrx, int freeit )
1620 #ifdef LDAP_R_COMPILE
1621 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1623 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1625 if ( lr->lr_refcnt > 0 ) {
1628 } else if ( lr->lr_refcnt < 0 ) {
1630 if ( lr->lr_refcnt == 0 ) {
1638 ldap_free_request_int( ld, lrx );
1640 } else if ( freeit ) {
1641 ldap_free_request( ld, lrx );
1643 #ifdef LDAP_R_COMPILE
1644 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );