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 ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist, int use_ldsb,
387 int connect, LDAPreqinfo *bind )
392 Debug( LDAP_DEBUG_TRACE, "ldap_new_connection %d %d %d\n",
393 use_ldsb, connect, (bind != NULL) );
395 * make a new LDAP server connection
396 * XXX open connection synchronously for now
398 lc = (LDAPConn *)LDAP_CALLOC( 1, sizeof( LDAPConn ) );
400 ld->ld_errno = LDAP_NO_MEMORY;
405 assert( ld->ld_sb != NULL );
406 lc->lconn_sb = ld->ld_sb;
409 lc->lconn_sb = ber_sockbuf_alloc();
410 if ( lc->lconn_sb == NULL ) {
411 LDAP_FREE( (char *)lc );
412 ld->ld_errno = LDAP_NO_MEMORY;
418 LDAPURLDesc **srvp, *srv = NULL;
420 async = LDAP_BOOL_GET( &ld->ld_options, LDAP_BOOL_CONNECT_ASYNC );
422 for ( srvp = srvlist; *srvp != NULL; srvp = &(*srvp)->lud_next ) {
425 rc = ldap_int_open_connection( ld, lc, *srvp, async );
429 if ( ld->ld_urllist_proc && ( !async || rc != -2 ) ) {
430 ld->ld_urllist_proc( ld, srvlist, srvp, ld->ld_urllist_params );
439 ber_sockbuf_free( lc->lconn_sb );
441 LDAP_FREE( (char *)lc );
442 ld->ld_errno = LDAP_SERVER_DOWN;
446 lc->lconn_server = ldap_url_dup( srv );
449 lc->lconn_status = async ? LDAP_CONNST_CONNECTING : LDAP_CONNST_CONNECTED;
450 #ifdef LDAP_R_COMPILE
451 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
453 lc->lconn_next = ld->ld_conns;
455 #ifdef LDAP_R_COMPILE
456 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
461 if ( lc->lconn_server->lud_exts ) {
462 int rc, ext = find_tls_ext( lc->lconn_server );
464 LDAPConn *savedefconn;
466 savedefconn = ld->ld_defconn;
467 ++lc->lconn_refcnt; /* avoid premature free */
470 #ifdef LDAP_R_COMPILE
471 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
472 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
474 rc = ldap_start_tls_s( ld, NULL, NULL );
475 #ifdef LDAP_R_COMPILE
476 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
477 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
479 ld->ld_defconn = savedefconn;
482 if ( rc != LDAP_SUCCESS && ext == 2 ) {
483 ldap_free_connection( ld, lc, 1, 0 );
491 if ( bind != NULL ) {
493 LDAPConn *savedefconn;
495 /* Set flag to prevent additional referrals
496 * from being processed on this
497 * connection until the bind has completed
499 lc->lconn_rebind_inprogress = 1;
500 /* V3 rebind function */
501 if ( ld->ld_rebind_proc != NULL) {
502 LDAPURLDesc *srvfunc;
504 srvfunc = ldap_url_dup( *srvlist );
505 if ( srvfunc == NULL ) {
506 ld->ld_errno = LDAP_NO_MEMORY;
509 savedefconn = ld->ld_defconn;
510 ++lc->lconn_refcnt; /* avoid premature free */
513 Debug( LDAP_DEBUG_TRACE, "Call application rebind_proc\n", 0, 0, 0);
514 #ifdef LDAP_R_COMPILE
515 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
516 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
518 err = (*ld->ld_rebind_proc)( ld,
519 bind->ri_url, bind->ri_request, bind->ri_msgid,
520 ld->ld_rebind_params );
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 );
526 ld->ld_defconn = savedefconn;
531 ldap_free_connection( ld, lc, 1, 0 );
534 ldap_free_urldesc( srvfunc );
539 struct berval passwd = BER_BVNULL;
541 savedefconn = ld->ld_defconn;
542 ++lc->lconn_refcnt; /* avoid premature free */
545 Debug( LDAP_DEBUG_TRACE,
546 "anonymous rebind via ldap_sasl_bind(\"\")\n",
549 #ifdef LDAP_R_COMPILE
550 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
551 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
553 rc = ldap_sasl_bind( ld, "", LDAP_SASL_SIMPLE, &passwd,
554 NULL, NULL, &msgid );
555 if ( rc != LDAP_SUCCESS ) {
559 for ( err = 1; err > 0; ) {
560 struct timeval tv = { 0, 100000 };
561 LDAPMessage *res = NULL;
563 switch ( ldap_result( ld, msgid, LDAP_MSG_ALL, &tv, &res ) ) {
569 #ifdef LDAP_R_COMPILE
570 ldap_pvt_thread_yield();
575 rc = ldap_parse_result( ld, res, &err, NULL, NULL, NULL, NULL, 1 );
576 if ( rc != LDAP_SUCCESS ) {
579 } else if ( err != LDAP_SUCCESS ) {
582 /* else err == LDAP_SUCCESS == 0 */
586 Debug( LDAP_DEBUG_TRACE,
587 "ldap_new_connection %p: "
588 "unexpected response %d "
589 "from BIND request id=%d\n",
590 (void *) ld, ldap_msgtype( res ), msgid );
596 #ifdef LDAP_R_COMPILE
597 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
598 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
600 ld->ld_defconn = savedefconn;
604 ldap_free_connection( ld, lc, 1, 0 );
609 lc->lconn_rebind_inprogress = 0;
617 find_connection( LDAP *ld, LDAPURLDesc *srv, int any )
619 * return an existing connection (if any) to the server srv
620 * if "any" is non-zero, check for any server in the "srv" chain
624 LDAPURLDesc *lcu, *lsu;
625 int lcu_port, lsu_port;
628 #ifdef LDAP_R_COMPILE
629 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
631 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
632 lcu = lc->lconn_server;
633 lcu_port = ldap_pvt_url_scheme_port( lcu->lud_scheme,
636 for ( lsu = srv; lsu != NULL; lsu = lsu->lud_next ) {
637 lsu_port = ldap_pvt_url_scheme_port( lsu->lud_scheme,
640 if ( lsu_port == lcu_port
641 && strcmp( lcu->lud_scheme, lsu->lud_scheme ) == 0
642 && lcu->lud_host != NULL && lsu->lud_host != NULL
643 && strcasecmp( lsu->lud_host, lcu->lud_host ) == 0 )
654 #ifdef LDAP_R_COMPILE
655 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
663 use_connection( LDAP *ld, LDAPConn *lc )
666 lc->lconn_lastused = time( NULL );
671 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
673 LDAPConn *tmplc, *prevlc;
675 Debug( LDAP_DEBUG_TRACE,
676 "ldap_free_connection %d %d\n",
679 if ( force || --lc->lconn_refcnt <= 0 ) {
680 /* remove from connections list first */
681 #ifdef LDAP_R_COMPILE
682 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
685 for ( prevlc = NULL, tmplc = ld->ld_conns;
687 tmplc = tmplc->lconn_next )
690 if ( prevlc == NULL ) {
691 ld->ld_conns = tmplc->lconn_next;
693 prevlc->lconn_next = tmplc->lconn_next;
695 if ( ld->ld_defconn == lc ) {
696 ld->ld_defconn = NULL;
702 #ifdef LDAP_R_COMPILE
703 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
706 /* process connection callbacks */
708 struct ldapoptions *lo;
712 lo = &ld->ld_options;
713 if ( lo->ldo_conn_cbs ) {
714 for ( ll=lo->ldo_conn_cbs; ll; ll=ll->ll_next ) {
716 cb->lc_del( ld, lc->lconn_sb, cb );
719 lo = LDAP_INT_GLOBAL_OPT();
720 if ( lo->ldo_conn_cbs ) {
721 for ( ll=lo->ldo_conn_cbs; ll; ll=ll->ll_next ) {
723 cb->lc_del( ld, lc->lconn_sb, cb );
728 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
729 ldap_mark_select_clear( ld, lc->lconn_sb );
731 ldap_send_unbind( ld, lc->lconn_sb,
736 if ( lc->lconn_ber != NULL ) {
737 ber_free( lc->lconn_ber, 1 );
740 ldap_int_sasl_close( ld, lc );
742 ldap_int_gssapi_close( ld, lc );
745 ldap_free_urllist( lc->lconn_server );
747 /* FIXME: is this at all possible?
748 * ldap_ld_free() in unbind.c calls ldap_free_connection()
749 * with force == 1 __after__ explicitly calling
750 * ldap_free_request() on all requests */
754 for ( lr = ld->ld_requests; lr; ) {
755 LDAPRequest *lr_next = lr->lr_next;
757 if ( lr->lr_conn == lc ) {
758 ldap_free_request_int( ld, lr );
765 if ( lc->lconn_sb != ld->ld_sb ) {
766 ber_sockbuf_free( lc->lconn_sb );
768 ber_int_sb_close( lc->lconn_sb );
771 if ( lc->lconn_rebind_queue != NULL) {
773 for( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
774 LDAP_VFREE( lc->lconn_rebind_queue[i] );
776 LDAP_FREE( lc->lconn_rebind_queue );
781 Debug( LDAP_DEBUG_TRACE,
782 "ldap_free_connection: actually freed\n",
786 lc->lconn_lastused = time( NULL );
787 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
788 lc->lconn_refcnt, 0, 0 );
795 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
800 Debug( LDAP_DEBUG_TRACE, "** ld %p Connection%s:\n", (void *)ld, all ? "s" : "", 0 );
801 for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
802 if ( lc->lconn_server != NULL ) {
803 Debug( LDAP_DEBUG_TRACE, "* host: %s port: %d%s\n",
804 ( lc->lconn_server->lud_host == NULL ) ? "(null)"
805 : lc->lconn_server->lud_host,
806 lc->lconn_server->lud_port, ( lc->lconn_sb ==
807 ld->ld_sb ) ? " (default)" : "" );
809 Debug( LDAP_DEBUG_TRACE, " refcnt: %d status: %s\n", lc->lconn_refcnt,
810 ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET )
812 ( lc->lconn_status == LDAP_CONNST_CONNECTING )
813 ? "Connecting" : "Connected", 0 );
814 Debug( LDAP_DEBUG_TRACE, " last used: %s%s\n",
815 ldap_pvt_ctime( &lc->lconn_lastused, timebuf ),
816 lc->lconn_rebind_inprogress ? " rebind in progress" : "", 0 );
817 if ( lc->lconn_rebind_inprogress ) {
818 if ( lc->lconn_rebind_queue != NULL) {
821 for ( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
823 for( j = 0; lc->lconn_rebind_queue[i][j] != 0; j++ ) {
824 Debug( LDAP_DEBUG_TRACE, " queue %d entry %d - %s\n",
825 i, j, lc->lconn_rebind_queue[i][j] );
829 Debug( LDAP_DEBUG_TRACE, " queue is empty\n", 0, 0, 0 );
832 Debug( LDAP_DEBUG_TRACE, "\n", 0, 0, 0 );
841 ldap_dump_requests_and_responses( LDAP *ld )
847 Debug( LDAP_DEBUG_TRACE, "** ld %p Outstanding Requests:\n",
849 lr = ld->ld_requests;
851 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
853 for ( i = 0; lr != NULL; lr = lr->lr_next, i++ ) {
854 Debug( LDAP_DEBUG_TRACE, " * msgid %d, origid %d, status %s\n",
855 lr->lr_msgid, lr->lr_origid,
856 ( lr->lr_status == LDAP_REQST_INPROGRESS ) ? "InProgress" :
857 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
858 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
859 ( lr->lr_status == LDAP_REQST_WRITING ) ? "Writing" :
860 ( lr->lr_status == LDAP_REQST_COMPLETED ) ? "RequestCompleted"
862 Debug( LDAP_DEBUG_TRACE, " outstanding referrals %d, parent count %d\n",
863 lr->lr_outrefcnt, lr->lr_parentcnt, 0 );
865 Debug( LDAP_DEBUG_TRACE, " ld %p request count %d (abandoned %lu)\n",
866 (void *)ld, i, ld->ld_nabandoned );
867 Debug( LDAP_DEBUG_TRACE, "** ld %p Response Queue:\n", (void *)ld, 0, 0 );
868 if ( ( lm = ld->ld_responses ) == NULL ) {
869 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
871 for ( i = 0; lm != NULL; lm = lm->lm_next, i++ ) {
872 Debug( LDAP_DEBUG_TRACE, " * msgid %d, type %lu\n",
873 lm->lm_msgid, (unsigned long)lm->lm_msgtype, 0 );
874 if ( lm->lm_chain != NULL ) {
875 Debug( LDAP_DEBUG_TRACE, " chained responses:\n", 0, 0, 0 );
876 for ( l = lm->lm_chain; l != NULL; l = l->lm_chain ) {
877 Debug( LDAP_DEBUG_TRACE,
878 " * msgid %d, type %lu\n",
880 (unsigned long)l->lm_msgtype, 0 );
884 Debug( LDAP_DEBUG_TRACE, " ld %p response count %d\n", (void *)ld, i, 0 );
886 #endif /* LDAP_DEBUG */
889 ldap_free_request_int( LDAP *ld, LDAPRequest *lr )
891 /* if lr_refcnt > 0, the request has been looked up
892 * by ldap_find_request_by_msgid(); if in the meanwhile
893 * the request is free()'d by someone else, just decrease
894 * the reference count and extract it from the request
895 * list; later on, it will be freed. */
896 if ( lr->lr_prev == NULL ) {
897 if ( lr->lr_refcnt == 0 ) {
898 /* free'ing the first request? */
899 assert( ld->ld_requests == lr );
902 if ( ld->ld_requests == lr ) {
903 ld->ld_requests = lr->lr_next;
907 lr->lr_prev->lr_next = lr->lr_next;
910 if ( lr->lr_next != NULL ) {
911 lr->lr_next->lr_prev = lr->lr_prev;
914 if ( lr->lr_refcnt > 0 ) {
915 lr->lr_refcnt = -lr->lr_refcnt;
923 if ( lr->lr_ber != NULL ) {
924 ber_free( lr->lr_ber, 1 );
928 if ( lr->lr_res_error != NULL ) {
929 LDAP_FREE( lr->lr_res_error );
930 lr->lr_res_error = NULL;
933 if ( lr->lr_res_matched != NULL ) {
934 LDAP_FREE( lr->lr_res_matched );
935 lr->lr_res_matched = NULL;
942 ldap_free_request( LDAP *ld, LDAPRequest *lr )
944 #ifdef LDAP_R_COMPILE
945 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
948 Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
949 lr->lr_origid, lr->lr_msgid, 0 );
951 /* free all referrals (child requests) */
952 while ( lr->lr_child ) {
953 ldap_free_request( ld, lr->lr_child );
956 if ( lr->lr_parent != NULL ) {
959 --lr->lr_parent->lr_outrefcnt;
960 for ( lrp = &lr->lr_parent->lr_child;
962 lrp = &(*lrp)->lr_refnext );
965 *lrp = lr->lr_refnext;
968 ldap_free_request_int( ld, lr );
972 * call first time with *cntp = -1
973 * when returns *cntp == -1, no referrals are left
975 * NOTE: may replace *refsp, or shuffle the contents
976 * of the original array.
978 static int ldap_int_nextref(
984 assert( refsp != NULL );
985 assert( *refsp != NULL );
986 assert( cntp != NULL );
995 if ( (*refsp)[ *cntp ] == NULL ) {
1003 * Chase v3 referrals
1006 * (IN) ld = LDAP connection handle
1007 * (IN) lr = LDAP Request structure
1008 * (IN) refs = array of pointers to referral strings that we will chase
1009 * The array will be free'd by this function when no longer needed
1010 * (IN) sref != 0 if following search reference
1011 * (OUT) errstrp = Place to return a string of referrals which could not be followed
1012 * (OUT) hadrefp = 1 if sucessfully followed referral
1014 * Return value - number of referrals followed
1017 ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, int sref, char **errstrp, int *hadrefp )
1020 int unfollowedcnt = 0;
1021 LDAPRequest *origreq;
1022 LDAPURLDesc *srv = NULL;
1024 char **refarray = NULL;
1026 int rc, count, i, j, id;
1029 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
1032 Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referrals\n", 0, 0, 0 );
1037 /* If no referrals in array, return */
1038 if ( (refs == NULL) || ( (refs)[0] == NULL) ) {
1043 /* Check for hop limit exceeded */
1044 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1045 Debug( LDAP_DEBUG_ANY,
1046 "more than %d referral hops (dropping)\n", ld->ld_refhoplimit, 0, 0 );
1047 ld->ld_errno = LDAP_REFERRAL_LIMIT_EXCEEDED;
1052 /* find original request */
1054 origreq->lr_parent != NULL;
1055 origreq = origreq->lr_parent )
1063 if ( ld->ld_nextref_proc == NULL ) {
1064 ld->ld_nextref_proc = ldap_int_nextref;
1067 /* parse out & follow referrals */
1069 for ( ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params );
1071 ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params ) )
1074 /* Parse the referral URL */
1075 rc = ldap_url_parse_ext( refarray[i], &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1076 if ( rc != LDAP_URL_SUCCESS ) {
1077 /* ldap_url_parse_ext() returns LDAP_URL_* errors
1078 * which do not map on API errors */
1079 ld->ld_errno = LDAP_PARAM_ERROR;
1084 if( srv->lud_crit_exts ) {
1087 /* If StartTLS is the only critical ext, OK. */
1088 if ( find_tls_ext( srv ) == 2 && srv->lud_crit_exts == 1 )
1092 /* we do not support any other extensions */
1093 ld->ld_errno = LDAP_NOT_SUPPORTED;
1099 /* check connection for re-bind in progress */
1100 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1101 /* See if we've already requested this DN with this conn */
1104 ber_len_t len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1105 for ( lp = origreq; lp; ) {
1106 if ( lp->lr_conn == lc
1107 && len == lp->lr_dn.bv_len
1109 && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) == 0 )
1114 if ( lp == origreq ) {
1117 lp = lp->lr_refnext;
1121 ldap_free_urllist( srv );
1123 ld->ld_errno = LDAP_CLIENT_LOOP;
1128 if ( lc->lconn_rebind_inprogress ) {
1129 /* We are already chasing a referral or search reference and a
1130 * bind on that connection is in progress. We must queue
1131 * referrals on that connection, so we don't get a request
1132 * going out before the bind operation completes. This happens
1133 * if two search references come in one behind the other
1134 * for the same server with different contexts.
1136 Debug( LDAP_DEBUG_TRACE,
1137 "ldap_chase_v3referrals: queue referral \"%s\"\n",
1139 if( lc->lconn_rebind_queue == NULL ) {
1140 /* Create a referral list */
1141 lc->lconn_rebind_queue =
1142 (char ***) LDAP_MALLOC( sizeof(void *) * 2);
1144 if( lc->lconn_rebind_queue == NULL) {
1145 ld->ld_errno = LDAP_NO_MEMORY;
1150 lc->lconn_rebind_queue[0] = refarray;
1151 lc->lconn_rebind_queue[1] = NULL;
1155 /* Count how many referral arrays we already have */
1156 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
1160 /* Add the new referral to the list */
1161 lc->lconn_rebind_queue = (char ***) LDAP_REALLOC(
1162 lc->lconn_rebind_queue, sizeof(void *) * (j + 2));
1164 if( lc->lconn_rebind_queue == NULL ) {
1165 ld->ld_errno = LDAP_NO_MEMORY;
1169 lc->lconn_rebind_queue[j] = refarray;
1170 lc->lconn_rebind_queue[j+1] = NULL;
1174 /* We have queued the referral/reference, now just return */
1177 count = 1; /* Pretend we already followed referral */
1181 /* Re-encode the request with the new starting point of the search.
1182 * Note: In the future we also need to replace the filter if one
1183 * was provided with the search reference
1186 /* For references we don't want old dn if new dn empty */
1187 if ( sref && srv->lud_dn == NULL ) {
1188 srv->lud_dn = LDAP_STRDUP( "" );
1191 LDAP_NEXT_MSGID( ld, id );
1192 ber = re_encode_request( ld, origreq->lr_ber, id,
1193 sref, srv, &rinfo.ri_request );
1196 ld->ld_errno = LDAP_ENCODING_ERROR;
1201 Debug( LDAP_DEBUG_TRACE,
1202 "ldap_chase_v3referral: msgid %d, url \"%s\"\n",
1203 lr->lr_msgid, refarray[i], 0);
1205 /* Send the new request to the server - may require a bind */
1206 rinfo.ri_msgid = origreq->lr_origid;
1207 rinfo.ri_url = refarray[i];
1208 #ifdef LDAP_R_COMPILE
1209 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1211 rc = ldap_send_server_request( ld, ber, id,
1212 origreq, &srv, NULL, &rinfo );
1213 #ifdef LDAP_R_COMPILE
1214 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1217 /* Failure, try next referral in the list */
1218 Debug( LDAP_DEBUG_ANY, "Unable to chase referral \"%s\" (%d: %s)\n",
1219 refarray[i], ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1220 unfollowedcnt += ldap_append_referral( ld, &unfollowed, refarray[i] );
1221 ldap_free_urllist( srv );
1223 ld->ld_errno = LDAP_REFERRAL;
1225 /* Success, no need to try this referral list further */
1230 /* check if there is a queue of referrals that came in during bind */
1232 lc = find_connection( ld, srv, 1 );
1234 ld->ld_errno = LDAP_OPERATIONS_ERROR;
1240 if ( lc->lconn_rebind_queue != NULL ) {
1241 /* Release resources of previous list */
1242 LDAP_VFREE( refarray );
1244 ldap_free_urllist( srv );
1247 /* Pull entries off end of queue so list always null terminated */
1248 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++ )
1250 refarray = lc->lconn_rebind_queue[j - 1];
1251 lc->lconn_rebind_queue[j-1] = NULL;
1252 /* we pulled off last entry from queue, free queue */
1254 LDAP_FREE( lc->lconn_rebind_queue );
1255 lc->lconn_rebind_queue = NULL;
1257 /* restart the loop the with new referral list */
1261 break; /* referral followed, break out of for loop */
1263 } /* end for loop */
1265 LDAP_VFREE( refarray );
1266 ldap_free_urllist( srv );
1267 LDAP_FREE( *errstrp );
1271 LDAP_FREE( unfollowed );
1274 *errstrp = unfollowed;
1280 * XXX merging of errors in this routine needs to be improved
1283 ldap_chase_referrals( LDAP *ld,
1291 char *p, *ref, *unfollowed;
1292 LDAPRequest *origreq;
1298 Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
1300 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
1303 if ( *errstrp == NULL ) {
1307 len = strlen( *errstrp );
1308 for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
1309 if ( strncasecmp( p, LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
1311 p += LDAP_REF_STR_LEN;
1316 if ( len < LDAP_REF_STR_LEN ) {
1320 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1321 Debug( LDAP_DEBUG_ANY,
1322 "more than %d referral hops (dropping)\n",
1323 ld->ld_refhoplimit, 0, 0 );
1324 /* XXX report as error in ld->ld_errno? */
1328 /* find original request */
1329 for ( origreq = lr; origreq->lr_parent != NULL;
1330 origreq = origreq->lr_parent ) {
1337 /* parse out & follow referrals */
1338 for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
1339 p = strchr( ref, '\n' );
1344 rc = ldap_url_parse_ext( ref, &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1345 if ( rc != LDAP_URL_SUCCESS ) {
1346 Debug( LDAP_DEBUG_TRACE,
1347 "ignoring %s referral <%s>\n",
1348 ref, rc == LDAP_URL_ERR_BADSCHEME ? "unknown" : "incorrect", 0 );
1349 rc = ldap_append_referral( ld, &unfollowed, ref );
1354 Debug( LDAP_DEBUG_TRACE,
1355 "chasing LDAP referral: <%s>\n", ref, 0, 0 );
1359 /* See if we've already been here */
1360 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1363 ber_len_t len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1364 for ( lp = lr; lp; lp = lp->lr_parent ) {
1365 if ( lp->lr_conn == lc
1366 && len == lp->lr_dn.bv_len )
1368 if ( len && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) )
1375 ldap_free_urllist( srv );
1376 ld->ld_errno = LDAP_CLIENT_LOOP;
1382 LDAP_NEXT_MSGID( ld, id );
1383 ber = re_encode_request( ld, origreq->lr_ber,
1384 id, sref, srv, &rinfo.ri_request );
1386 if ( ber == NULL ) {
1390 /* copy the complete referral for rebind process */
1391 rinfo.ri_url = LDAP_STRDUP( ref );
1393 rinfo.ri_msgid = origreq->lr_origid;
1395 #ifdef LDAP_R_COMPILE
1396 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1398 rc = ldap_send_server_request( ld, ber, id,
1399 lr, &srv, NULL, &rinfo );
1400 #ifdef LDAP_R_COMPILE
1401 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1404 LDAP_FREE( rinfo.ri_url );
1409 Debug( LDAP_DEBUG_ANY,
1410 "Unable to chase referral \"%s\" (%d: %s)\n",
1411 ref, ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1412 rc = ldap_append_referral( ld, &unfollowed, ref );
1415 ldap_free_urllist(srv);
1418 LDAP_FREE( *errstrp );
1419 *errstrp = unfollowed;
1421 return(( rc == 0 ) ? count : rc );
1426 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
1430 if ( *referralsp == NULL ) {
1432 *referralsp = (char *)LDAP_MALLOC( strlen( s ) + LDAP_REF_STR_LEN
1436 *referralsp = (char *)LDAP_REALLOC( *referralsp,
1437 strlen( *referralsp ) + strlen( s ) + 2 );
1440 if ( *referralsp == NULL ) {
1441 ld->ld_errno = LDAP_NO_MEMORY;
1446 strcpy( *referralsp, LDAP_REF_STR );
1448 strcat( *referralsp, "\n" );
1450 strcat( *referralsp, s );
1458 re_encode_request( LDAP *ld,
1459 BerElement *origber,
1466 * XXX this routine knows way too much about how the lber library works!
1474 BerElement tmpber, *ber;
1477 Debug( LDAP_DEBUG_TRACE,
1478 "re_encode_request: new msgid %ld, new dn <%s>\n",
1480 ( srv == NULL || srv->lud_dn == NULL) ? "NONE" : srv->lud_dn, 0 );
1485 * all LDAP requests are sequences that start with a message id.
1486 * For all except delete, this is followed by a sequence that is
1487 * tagged with the operation code. For delete, the provided DN
1488 * is not wrapped by a sequence.
1490 rtag = ber_scanf( &tmpber, "{it", /*}*/ &along, &tag );
1492 if ( rtag == LBER_ERROR ) {
1493 ld->ld_errno = LDAP_DECODING_ERROR;
1498 if ( tag == LDAP_REQ_BIND ) {
1499 /* bind requests have a version number before the DN & other stuff */
1500 rtag = ber_scanf( &tmpber, "{im" /*}*/, &ver, &dn );
1502 } else if ( tag == LDAP_REQ_DELETE ) {
1503 /* delete requests don't have a DN wrapping sequence */
1504 rtag = ber_scanf( &tmpber, "m", &dn );
1506 } else if ( tag == LDAP_REQ_SEARCH ) {
1507 /* search requests need to be re-scope-ed */
1508 rtag = ber_scanf( &tmpber, "{me" /*"}"*/, &dn, &scope );
1510 if( srv->lud_scope != LDAP_SCOPE_DEFAULT ) {
1511 /* use the scope provided in reference */
1512 scope = srv->lud_scope;
1514 } else if ( sref ) {
1515 /* use scope implied by previous operation
1518 * subtree -> subtree
1519 * subordinate -> subtree
1523 case LDAP_SCOPE_BASE:
1524 case LDAP_SCOPE_ONELEVEL:
1525 scope = LDAP_SCOPE_BASE;
1527 case LDAP_SCOPE_SUBTREE:
1528 case LDAP_SCOPE_SUBORDINATE:
1529 scope = LDAP_SCOPE_SUBTREE;
1535 rtag = ber_scanf( &tmpber, "{m" /*}*/, &dn );
1538 if( rtag == LBER_ERROR ) {
1539 ld->ld_errno = LDAP_DECODING_ERROR;
1543 /* restore character zero'd out by ber_scanf*/
1544 dn.bv_val[dn.bv_len] = tmpber.ber_tag;
1546 if (( ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
1550 if ( srv->lud_dn ) {
1551 ber_str2bv( srv->lud_dn, 0, 0, &dn );
1554 if ( tag == LDAP_REQ_BIND ) {
1555 rc = ber_printf( ber, "{it{iO" /*}}*/, msgid, tag, ver, &dn );
1556 } else if ( tag == LDAP_REQ_DELETE ) {
1557 rc = ber_printf( ber, "{itON}", msgid, tag, &dn );
1558 } else if ( tag == LDAP_REQ_SEARCH ) {
1559 rc = ber_printf( ber, "{it{Oe" /*}}*/, msgid, tag, &dn, scope );
1561 rc = ber_printf( ber, "{it{O" /*}}*/, msgid, tag, &dn );
1565 ld->ld_errno = LDAP_ENCODING_ERROR;
1570 if ( tag != LDAP_REQ_DELETE && (
1571 ber_write(ber, tmpber.ber_ptr, ( tmpber.ber_end - tmpber.ber_ptr ), 0)
1572 != ( tmpber.ber_end - tmpber.ber_ptr ) ||
1573 ber_printf( ber, /*{{*/ "N}N}" ) == -1 ) )
1575 ld->ld_errno = LDAP_ENCODING_ERROR;
1581 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
1582 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
1584 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ber, 0 );
1586 #endif /* LDAP_DEBUG */
1588 *type = tag; /* return request type */
1594 ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid )
1598 #ifdef LDAP_R_COMPILE
1599 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1601 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1602 if ( lr->lr_status == LDAP_REQST_COMPLETED ) {
1603 continue; /* Skip completed requests */
1605 if ( msgid == lr->lr_msgid ) {
1610 #ifdef LDAP_R_COMPILE
1611 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1618 ldap_return_request( LDAP *ld, LDAPRequest *lrx, int freeit )
1622 #ifdef LDAP_R_COMPILE
1623 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1625 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1627 if ( lr->lr_refcnt > 0 ) {
1630 } else if ( lr->lr_refcnt < 0 ) {
1632 if ( lr->lr_refcnt == 0 ) {
1640 ldap_free_request_int( ld, lrx );
1642 } else if ( freeit ) {
1643 ldap_free_request( ld, lrx );
1645 #ifdef LDAP_R_COMPILE
1646 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );