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 LDAP_MUTEX_LOCK( &ld->ld_req_mutex );
102 if ( ber_sockbuf_ctrl( ld->ld_sb, LBER_SB_OPT_GET_FD, NULL ) == -1 ) {
103 /* not connected yet */
104 rc = ldap_open_defconn( ld );
107 LDAP_MUTEX_UNLOCK( &ld->ld_req_mutex );
111 } else if ( rc == 0 ) {
112 Debug( LDAP_DEBUG_TRACE,
113 "ldap_open_defconn: successful\n",
117 #ifdef LDAP_CONNECTIONLESS
118 if (LDAP_IS_UDP(ld)) {
119 if (msgtype == LDAP_REQ_BIND) {
120 if (ld->ld_options.ldo_cldapdn)
121 ldap_memfree(ld->ld_options.ldo_cldapdn);
122 ld->ld_options.ldo_cldapdn = ldap_strdup(dn);
126 if (msgtype != LDAP_REQ_ABANDON && msgtype != LDAP_REQ_SEARCH)
129 return LDAP_PARAM_ERROR;
133 LDAP_MUTEX_LOCK( &ld->ld_req_mutex );
134 rc = ldap_send_server_request( ld, ber, msgid, NULL,
136 LDAP_MUTEX_UNLOCK( &ld->ld_req_mutex );
142 ldap_int_flush_request(
146 LDAPConn *lc = lr->lr_conn;
148 if ( ber_flush2( lc->lconn_sb, lr->lr_ber, LBER_FLUSH_FREE_NEVER ) != 0 ) {
149 if ( sock_errno() == EAGAIN ) {
150 /* need to continue write later */
151 lr->lr_status = LDAP_REQST_WRITING;
152 ldap_mark_select_write( ld, lc->lconn_sb );
153 ld->ld_errno = LDAP_BUSY;
156 ld->ld_errno = LDAP_SERVER_DOWN;
157 ldap_free_request( ld, lr );
158 ldap_free_connection( ld, lc, 0, 0 );
162 if ( lr->lr_parent == NULL ) {
163 lr->lr_ber->ber_end = lr->lr_ber->ber_ptr;
164 lr->lr_ber->ber_ptr = lr->lr_ber->ber_buf;
166 lr->lr_status = LDAP_REQST_INPROGRESS;
168 /* sent -- waiting for a response */
169 ldap_mark_select_read( ld, lc->lconn_sb );
175 ldap_send_server_request(
179 LDAPRequest *parentreq,
180 LDAPURLDesc **srvlist,
187 Debug( LDAP_DEBUG_TRACE, "ldap_send_server_request\n", 0, 0, 0 );
190 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
193 if ( srvlist == NULL ) {
196 lc = find_connection( ld, *srvlist, 1 );
198 if ( (bind != NULL) && (parentreq != NULL) ) {
199 /* Remember the bind in the parent */
201 ++parentreq->lr_outrefcnt;
203 lc = ldap_new_connection( ld, srvlist, 0, 1, bind );
208 /* async connect... */
209 if ( lc != NULL && lc->lconn_status == LDAP_CONNST_CONNECTING ) {
210 ber_socket_t sd = AC_SOCKET_ERROR;
211 struct timeval tv = { 0 };
213 ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_GET_FD, &sd );
216 switch ( ldap_int_poll( ld, sd, &tv ) ) {
219 lc->lconn_status = LDAP_CONNST_CONNECTED;
223 /* async only occurs if a network timeout is set */
225 /* honor network timeout */
226 if ( time( NULL ) - lc->lconn_created <= ld->ld_options.ldo_tm_net.tv_sec )
228 /* caller will have to call again */
229 ld->ld_errno = LDAP_X_CONNECTING;
239 if ( lc == NULL || lc->lconn_status != LDAP_CONNST_CONNECTED ) {
240 if ( ld->ld_errno == LDAP_SUCCESS ) {
241 ld->ld_errno = LDAP_SERVER_DOWN;
246 /* Forget about the bind */
247 --parentreq->lr_outrefcnt;
252 use_connection( ld, lc );
254 #ifdef LDAP_CONNECTIONLESS
255 if ( LDAP_IS_UDP( ld )) {
256 BerElement tmpber = *ber;
257 ber_rewind( &tmpber );
258 rc = ber_write( &tmpber, ld->ld_options.ldo_peer,
259 sizeof( struct sockaddr ), 0 );
261 ld->ld_errno = LDAP_ENCODING_ERROR;
267 /* If we still have an incomplete write, try to finish it before
268 * dealing with the new request. If we don't finish here, return
269 * LDAP_BUSY and let the caller retry later. We only allow a single
270 * request to be in WRITING state.
273 if ( ld->ld_requests &&
274 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
275 ldap_int_flush_request( ld, ld->ld_requests ) < 0 )
281 lr = (LDAPRequest *)LDAP_CALLOC( 1, sizeof( LDAPRequest ) );
283 ld->ld_errno = LDAP_NO_MEMORY;
284 ldap_free_connection( ld, lc, 0, 0 );
287 /* Forget about the bind */
288 --parentreq->lr_outrefcnt;
292 lr->lr_msgid = msgid;
293 lr->lr_status = LDAP_REQST_INPROGRESS;
294 lr->lr_res_errno = LDAP_SUCCESS; /* optimistic */
297 if ( parentreq != NULL ) { /* sub-request */
299 /* Increment if we didn't do it before the bind */
300 ++parentreq->lr_outrefcnt;
302 lr->lr_origid = parentreq->lr_origid;
303 lr->lr_parentcnt = ++parentreq->lr_parentcnt;
304 lr->lr_parent = parentreq;
305 lr->lr_refnext = parentreq->lr_child;
306 parentreq->lr_child = lr;
307 } else { /* original request */
308 lr->lr_origid = lr->lr_msgid;
311 /* Extract requestDN for future reference */
313 BerElement tmpber = *ber;
317 ber_reset( &tmpber, 1 );
318 rtag = ber_scanf( &tmpber, "{it", /*}*/ &bint, &tag );
321 rtag = ber_scanf( &tmpber, "{i" /*}*/, &bint );
323 case LDAP_REQ_DELETE:
326 rtag = ber_scanf( &tmpber, "{" /*}*/ );
327 case LDAP_REQ_ABANDON:
330 if ( tag != LDAP_REQ_ABANDON ) {
331 ber_skip_tag( &tmpber, &lr->lr_dn.bv_len );
332 lr->lr_dn.bv_val = tmpber.ber_ptr;
337 lr->lr_next = ld->ld_requests;
338 if ( lr->lr_next != NULL ) {
339 lr->lr_next->lr_prev = lr;
341 ld->ld_requests = lr;
343 ld->ld_errno = LDAP_SUCCESS;
344 if ( ldap_int_flush_request( ld, lr ) == -1 ) {
351 /* return 0 if no StartTLS ext, 1 if present, 2 if critical */
353 find_tls_ext( LDAPURLDesc *srv )
358 if ( !srv->lud_exts )
361 for (i=0; srv->lud_exts[i]; i++) {
363 ext = srv->lud_exts[i];
364 if ( ext[0] == '!') {
368 if ( !strcasecmp( ext, "StartTLS" ) ||
369 !strcasecmp( ext, "X-StartTLS" ) ||
370 !strcmp( ext, LDAP_EXOP_START_TLS )) {
378 * caller must hold ld_req_mutex or be exclusive user of ld
379 * if ( connect != 0 ) or ( bind != NULL ) caller must also hold
380 * ld_req_mutex and ld_res_mutex
384 ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist, int use_ldsb,
385 int connect, LDAPreqinfo *bind )
390 Debug( LDAP_DEBUG_TRACE, "ldap_new_connection %d %d %d\n",
391 use_ldsb, connect, (bind != NULL) );
393 * make a new LDAP server connection
394 * XXX open connection synchronously for now
396 lc = (LDAPConn *)LDAP_CALLOC( 1, sizeof( LDAPConn ) );
398 ld->ld_errno = LDAP_NO_MEMORY;
403 assert( ld->ld_sb != NULL );
404 lc->lconn_sb = ld->ld_sb;
407 lc->lconn_sb = ber_sockbuf_alloc();
408 if ( lc->lconn_sb == NULL ) {
409 LDAP_FREE( (char *)lc );
410 ld->ld_errno = LDAP_NO_MEMORY;
416 LDAPURLDesc **srvp, *srv = NULL;
418 async = LDAP_BOOL_GET( &ld->ld_options, LDAP_BOOL_CONNECT_ASYNC );
420 for ( srvp = srvlist; *srvp != NULL; srvp = &(*srvp)->lud_next ) {
423 rc = ldap_int_open_connection( ld, lc, *srvp, async );
427 if ( ld->ld_urllist_proc && ( !async || rc != -2 ) ) {
428 ld->ld_urllist_proc( ld, srvlist, srvp, ld->ld_urllist_params );
437 ber_sockbuf_free( lc->lconn_sb );
439 LDAP_FREE( (char *)lc );
440 ld->ld_errno = LDAP_SERVER_DOWN;
444 lc->lconn_server = ldap_url_dup( srv );
447 lc->lconn_status = async ? LDAP_CONNST_CONNECTING : LDAP_CONNST_CONNECTED;
448 LDAP_MUTEX_LOCK( &ld->ld_conn_mutex );
449 lc->lconn_next = ld->ld_conns;
451 LDAP_MUTEX_UNLOCK( &ld->ld_conn_mutex );
454 LDAP_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
455 LDAP_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
458 if ( lc->lconn_server->lud_exts ) {
459 int rc, ext = find_tls_ext( lc->lconn_server );
461 LDAPConn *savedefconn;
463 savedefconn = ld->ld_defconn;
464 ++lc->lconn_refcnt; /* avoid premature free */
467 LDAP_MUTEX_UNLOCK( &ld->ld_req_mutex );
468 LDAP_MUTEX_UNLOCK( &ld->ld_res_mutex );
469 rc = ldap_start_tls_s( ld, NULL, NULL );
470 LDAP_MUTEX_LOCK( &ld->ld_res_mutex );
471 LDAP_MUTEX_LOCK( &ld->ld_req_mutex );
472 ld->ld_defconn = savedefconn;
475 if ( rc != LDAP_SUCCESS && ext == 2 ) {
476 ldap_free_connection( ld, lc, 1, 0 );
484 if ( bind != NULL ) {
486 LDAPConn *savedefconn;
488 LDAP_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
489 LDAP_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
491 /* Set flag to prevent additional referrals
492 * from being processed on this
493 * connection until the bind has completed
495 lc->lconn_rebind_inprogress = 1;
496 /* V3 rebind function */
497 if ( ld->ld_rebind_proc != NULL) {
498 LDAPURLDesc *srvfunc;
500 srvfunc = ldap_url_dup( *srvlist );
501 if ( srvfunc == NULL ) {
502 ld->ld_errno = LDAP_NO_MEMORY;
505 savedefconn = ld->ld_defconn;
506 ++lc->lconn_refcnt; /* avoid premature free */
509 Debug( LDAP_DEBUG_TRACE, "Call application rebind_proc\n", 0, 0, 0);
510 LDAP_MUTEX_UNLOCK( &ld->ld_req_mutex );
511 LDAP_MUTEX_UNLOCK( &ld->ld_res_mutex );
512 err = (*ld->ld_rebind_proc)( ld,
513 bind->ri_url, bind->ri_request, bind->ri_msgid,
514 ld->ld_rebind_params );
515 LDAP_MUTEX_LOCK( &ld->ld_res_mutex );
516 LDAP_MUTEX_LOCK( &ld->ld_req_mutex );
518 ld->ld_defconn = savedefconn;
523 ldap_free_connection( ld, lc, 1, 0 );
526 ldap_free_urldesc( srvfunc );
531 struct berval passwd = BER_BVNULL;
533 savedefconn = ld->ld_defconn;
534 ++lc->lconn_refcnt; /* avoid premature free */
537 Debug( LDAP_DEBUG_TRACE,
538 "anonymous rebind via ldap_sasl_bind(\"\")\n",
541 LDAP_MUTEX_UNLOCK( &ld->ld_req_mutex );
542 LDAP_MUTEX_UNLOCK( &ld->ld_res_mutex );
543 rc = ldap_sasl_bind( ld, "", LDAP_SASL_SIMPLE, &passwd,
544 NULL, NULL, &msgid );
545 if ( rc != LDAP_SUCCESS ) {
549 for ( err = 1; err > 0; ) {
550 struct timeval tv = { 0, 100000 };
551 LDAPMessage *res = NULL;
553 switch ( ldap_result( ld, msgid, LDAP_MSG_ALL, &tv, &res ) ) {
559 #ifdef LDAP_R_COMPILE
560 ldap_pvt_thread_yield();
565 rc = ldap_parse_result( ld, res, &err, NULL, NULL, NULL, NULL, 1 );
566 if ( rc != LDAP_SUCCESS ) {
569 } else if ( err != LDAP_SUCCESS ) {
572 /* else err == LDAP_SUCCESS == 0 */
576 Debug( LDAP_DEBUG_TRACE,
577 "ldap_new_connection %p: "
578 "unexpected response %d "
579 "from BIND request id=%d\n",
580 (void *) ld, ldap_msgtype( res ), msgid );
586 LDAP_MUTEX_LOCK( &ld->ld_res_mutex );
587 LDAP_MUTEX_LOCK( &ld->ld_req_mutex );
588 ld->ld_defconn = savedefconn;
592 ldap_free_connection( ld, lc, 1, 0 );
597 lc->lconn_rebind_inprogress = 0;
605 find_connection( LDAP *ld, LDAPURLDesc *srv, int any )
607 * return an existing connection (if any) to the server srv
608 * if "any" is non-zero, check for any server in the "srv" chain
612 LDAPURLDesc *lcu, *lsu;
613 int lcu_port, lsu_port;
616 LDAP_MUTEX_LOCK( &ld->ld_conn_mutex );
617 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
618 lcu = lc->lconn_server;
619 lcu_port = ldap_pvt_url_scheme_port( lcu->lud_scheme,
622 for ( lsu = srv; lsu != NULL; lsu = lsu->lud_next ) {
623 lsu_port = ldap_pvt_url_scheme_port( lsu->lud_scheme,
626 if ( lsu_port == lcu_port
627 && strcmp( lcu->lud_scheme, lsu->lud_scheme ) == 0
628 && lcu->lud_host != NULL && lsu->lud_host != NULL
629 && strcasecmp( lsu->lud_host, lcu->lud_host ) == 0 )
640 LDAP_MUTEX_UNLOCK( &ld->ld_conn_mutex );
646 * NOTE: the caller holds ld_req_mutex
650 use_connection( LDAP *ld, LDAPConn *lc )
653 lc->lconn_lastused = time( NULL );
658 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
660 LDAPConn *tmplc, *prevlc;
662 Debug( LDAP_DEBUG_TRACE,
663 "ldap_free_connection %d %d\n",
666 if ( force || --lc->lconn_refcnt <= 0 ) {
667 /* remove from connections list first */
668 LDAP_MUTEX_LOCK( &ld->ld_conn_mutex );
670 for ( prevlc = NULL, tmplc = ld->ld_conns;
672 tmplc = tmplc->lconn_next )
675 if ( prevlc == NULL ) {
676 ld->ld_conns = tmplc->lconn_next;
678 prevlc->lconn_next = tmplc->lconn_next;
680 if ( ld->ld_defconn == lc ) {
681 ld->ld_defconn = NULL;
687 LDAP_MUTEX_UNLOCK( &ld->ld_conn_mutex );
689 /* process connection callbacks */
691 struct ldapoptions *lo;
695 lo = &ld->ld_options;
696 if ( lo->ldo_conn_cbs ) {
697 for ( ll=lo->ldo_conn_cbs; ll; ll=ll->ll_next ) {
699 cb->lc_del( ld, lc->lconn_sb, cb );
702 lo = LDAP_INT_GLOBAL_OPT();
703 if ( lo->ldo_conn_cbs ) {
704 for ( ll=lo->ldo_conn_cbs; ll; ll=ll->ll_next ) {
706 cb->lc_del( ld, lc->lconn_sb, cb );
711 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
712 ldap_mark_select_clear( ld, lc->lconn_sb );
714 ldap_send_unbind( ld, lc->lconn_sb,
719 if ( lc->lconn_ber != NULL ) {
720 ber_free( lc->lconn_ber, 1 );
723 ldap_int_sasl_close( ld, lc );
725 ldap_int_gssapi_close( ld, lc );
728 ldap_free_urllist( lc->lconn_server );
730 /* FIXME: is this at all possible?
731 * ldap_ld_free() in unbind.c calls ldap_free_connection()
732 * with force == 1 __after__ explicitly calling
733 * ldap_free_request() on all requests */
737 for ( lr = ld->ld_requests; lr; ) {
738 LDAPRequest *lr_next = lr->lr_next;
740 if ( lr->lr_conn == lc ) {
741 ldap_free_request_int( ld, lr );
748 if ( lc->lconn_sb != ld->ld_sb ) {
749 ber_sockbuf_free( lc->lconn_sb );
751 ber_int_sb_close( lc->lconn_sb );
754 if ( lc->lconn_rebind_queue != NULL) {
756 for( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
757 LDAP_VFREE( lc->lconn_rebind_queue[i] );
759 LDAP_FREE( lc->lconn_rebind_queue );
764 Debug( LDAP_DEBUG_TRACE,
765 "ldap_free_connection: actually freed\n",
769 lc->lconn_lastused = time( NULL );
770 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
771 lc->lconn_refcnt, 0, 0 );
778 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
783 Debug( LDAP_DEBUG_TRACE, "** ld %p Connection%s:\n", (void *)ld, all ? "s" : "", 0 );
784 for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
785 if ( lc->lconn_server != NULL ) {
786 Debug( LDAP_DEBUG_TRACE, "* host: %s port: %d%s\n",
787 ( lc->lconn_server->lud_host == NULL ) ? "(null)"
788 : lc->lconn_server->lud_host,
789 lc->lconn_server->lud_port, ( lc->lconn_sb ==
790 ld->ld_sb ) ? " (default)" : "" );
792 Debug( LDAP_DEBUG_TRACE, " refcnt: %d status: %s\n", lc->lconn_refcnt,
793 ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET )
795 ( lc->lconn_status == LDAP_CONNST_CONNECTING )
796 ? "Connecting" : "Connected", 0 );
797 Debug( LDAP_DEBUG_TRACE, " last used: %s%s\n",
798 ldap_pvt_ctime( &lc->lconn_lastused, timebuf ),
799 lc->lconn_rebind_inprogress ? " rebind in progress" : "", 0 );
800 if ( lc->lconn_rebind_inprogress ) {
801 if ( lc->lconn_rebind_queue != NULL) {
804 for ( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
806 for( j = 0; lc->lconn_rebind_queue[i][j] != 0; j++ ) {
807 Debug( LDAP_DEBUG_TRACE, " queue %d entry %d - %s\n",
808 i, j, lc->lconn_rebind_queue[i][j] );
812 Debug( LDAP_DEBUG_TRACE, " queue is empty\n", 0, 0, 0 );
815 Debug( LDAP_DEBUG_TRACE, "\n", 0, 0, 0 );
824 ldap_dump_requests_and_responses( LDAP *ld )
830 Debug( LDAP_DEBUG_TRACE, "** ld %p Outstanding Requests:\n",
832 lr = ld->ld_requests;
834 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
836 for ( i = 0; lr != NULL; lr = lr->lr_next, i++ ) {
837 Debug( LDAP_DEBUG_TRACE, " * msgid %d, origid %d, status %s\n",
838 lr->lr_msgid, lr->lr_origid,
839 ( lr->lr_status == LDAP_REQST_INPROGRESS ) ? "InProgress" :
840 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
841 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
842 ( lr->lr_status == LDAP_REQST_WRITING ) ? "Writing" :
843 ( lr->lr_status == LDAP_REQST_COMPLETED ) ? "RequestCompleted"
845 Debug( LDAP_DEBUG_TRACE, " outstanding referrals %d, parent count %d\n",
846 lr->lr_outrefcnt, lr->lr_parentcnt, 0 );
848 Debug( LDAP_DEBUG_TRACE, " ld %p request count %d (abandoned %lu)\n",
849 (void *)ld, i, ld->ld_nabandoned );
850 Debug( LDAP_DEBUG_TRACE, "** ld %p Response Queue:\n", (void *)ld, 0, 0 );
851 if ( ( lm = ld->ld_responses ) == NULL ) {
852 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
854 for ( i = 0; lm != NULL; lm = lm->lm_next, i++ ) {
855 Debug( LDAP_DEBUG_TRACE, " * msgid %d, type %lu\n",
856 lm->lm_msgid, (unsigned long)lm->lm_msgtype, 0 );
857 if ( lm->lm_chain != NULL ) {
858 Debug( LDAP_DEBUG_TRACE, " chained responses:\n", 0, 0, 0 );
859 for ( l = lm->lm_chain; l != NULL; l = l->lm_chain ) {
860 Debug( LDAP_DEBUG_TRACE,
861 " * msgid %d, type %lu\n",
863 (unsigned long)l->lm_msgtype, 0 );
867 Debug( LDAP_DEBUG_TRACE, " ld %p response count %d\n", (void *)ld, i, 0 );
869 #endif /* LDAP_DEBUG */
872 ldap_free_request_int( LDAP *ld, LDAPRequest *lr )
874 /* if lr_refcnt > 0, the request has been looked up
875 * by ldap_find_request_by_msgid(); if in the meanwhile
876 * the request is free()'d by someone else, just decrease
877 * the reference count and extract it from the request
878 * list; later on, it will be freed. */
879 if ( lr->lr_prev == NULL ) {
880 if ( lr->lr_refcnt == 0 ) {
881 /* free'ing the first request? */
882 assert( ld->ld_requests == lr );
885 if ( ld->ld_requests == lr ) {
886 ld->ld_requests = lr->lr_next;
890 lr->lr_prev->lr_next = lr->lr_next;
893 if ( lr->lr_next != NULL ) {
894 lr->lr_next->lr_prev = lr->lr_prev;
897 if ( lr->lr_refcnt > 0 ) {
898 lr->lr_refcnt = -lr->lr_refcnt;
906 if ( lr->lr_ber != NULL ) {
907 ber_free( lr->lr_ber, 1 );
911 if ( lr->lr_res_error != NULL ) {
912 LDAP_FREE( lr->lr_res_error );
913 lr->lr_res_error = NULL;
916 if ( lr->lr_res_matched != NULL ) {
917 LDAP_FREE( lr->lr_res_matched );
918 lr->lr_res_matched = NULL;
925 ldap_free_request( LDAP *ld, LDAPRequest *lr )
927 LDAP_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
929 Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
930 lr->lr_origid, lr->lr_msgid, 0 );
932 /* free all referrals (child requests) */
933 while ( lr->lr_child ) {
934 ldap_free_request( ld, lr->lr_child );
937 if ( lr->lr_parent != NULL ) {
940 --lr->lr_parent->lr_outrefcnt;
941 for ( lrp = &lr->lr_parent->lr_child;
943 lrp = &(*lrp)->lr_refnext );
946 *lrp = lr->lr_refnext;
949 ldap_free_request_int( ld, lr );
953 * call first time with *cntp = -1
954 * when returns *cntp == -1, no referrals are left
956 * NOTE: may replace *refsp, or shuffle the contents
957 * of the original array.
959 static int ldap_int_nextref(
965 assert( refsp != NULL );
966 assert( *refsp != NULL );
967 assert( cntp != NULL );
976 if ( (*refsp)[ *cntp ] == NULL ) {
987 * (IN) ld = LDAP connection handle
988 * (IN) lr = LDAP Request structure
989 * (IN) refs = array of pointers to referral strings that we will chase
990 * The array will be free'd by this function when no longer needed
991 * (IN) sref != 0 if following search reference
992 * (OUT) errstrp = Place to return a string of referrals which could not be followed
993 * (OUT) hadrefp = 1 if sucessfully followed referral
995 * Return value - number of referrals followed
998 ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, int sref, char **errstrp, int *hadrefp )
1001 int unfollowedcnt = 0;
1002 LDAPRequest *origreq;
1003 LDAPURLDesc *srv = NULL;
1005 char **refarray = NULL;
1007 int rc, count, i, j, id;
1009 LDAP_NEXTREF_PROC *nextref_proc = ld->ld_nextref_proc ? ld->ld_nextref_proc : ldap_int_nextref;
1011 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
1014 Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referrals\n", 0, 0, 0 );
1019 /* If no referrals in array, return */
1020 if ( (refs == NULL) || ( (refs)[0] == NULL) ) {
1025 /* Check for hop limit exceeded */
1026 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1027 Debug( LDAP_DEBUG_ANY,
1028 "more than %d referral hops (dropping)\n", ld->ld_refhoplimit, 0, 0 );
1029 ld->ld_errno = LDAP_REFERRAL_LIMIT_EXCEEDED;
1034 /* find original request */
1036 origreq->lr_parent != NULL;
1037 origreq = origreq->lr_parent )
1045 /* parse out & follow referrals */
1046 /* NOTE: if nextref_proc == ldap_int_nextref, params is ignored */
1048 for ( nextref_proc( ld, &refarray, &i, ld->ld_nextref_params );
1050 nextref_proc( ld, &refarray, &i, ld->ld_nextref_params ) )
1053 /* Parse the referral URL */
1054 rc = ldap_url_parse_ext( refarray[i], &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1055 if ( rc != LDAP_URL_SUCCESS ) {
1056 /* ldap_url_parse_ext() returns LDAP_URL_* errors
1057 * which do not map on API errors */
1058 ld->ld_errno = LDAP_PARAM_ERROR;
1063 if( srv->lud_crit_exts ) {
1066 /* If StartTLS is the only critical ext, OK. */
1067 if ( find_tls_ext( srv ) == 2 && srv->lud_crit_exts == 1 )
1071 /* we do not support any other extensions */
1072 ld->ld_errno = LDAP_NOT_SUPPORTED;
1078 /* check connection for re-bind in progress */
1079 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1080 /* See if we've already requested this DN with this conn */
1083 ber_len_t len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1084 for ( lp = origreq; lp; ) {
1085 if ( lp->lr_conn == lc
1086 && len == lp->lr_dn.bv_len
1088 && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) == 0 )
1093 if ( lp == origreq ) {
1096 lp = lp->lr_refnext;
1100 ldap_free_urllist( srv );
1102 ld->ld_errno = LDAP_CLIENT_LOOP;
1107 if ( lc->lconn_rebind_inprogress ) {
1108 /* We are already chasing a referral or search reference and a
1109 * bind on that connection is in progress. We must queue
1110 * referrals on that connection, so we don't get a request
1111 * going out before the bind operation completes. This happens
1112 * if two search references come in one behind the other
1113 * for the same server with different contexts.
1115 Debug( LDAP_DEBUG_TRACE,
1116 "ldap_chase_v3referrals: queue referral \"%s\"\n",
1118 if( lc->lconn_rebind_queue == NULL ) {
1119 /* Create a referral list */
1120 lc->lconn_rebind_queue =
1121 (char ***) LDAP_MALLOC( sizeof(void *) * 2);
1123 if( lc->lconn_rebind_queue == NULL) {
1124 ld->ld_errno = LDAP_NO_MEMORY;
1129 lc->lconn_rebind_queue[0] = refarray;
1130 lc->lconn_rebind_queue[1] = NULL;
1134 /* Count how many referral arrays we already have */
1135 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
1139 /* Add the new referral to the list */
1140 lc->lconn_rebind_queue = (char ***) LDAP_REALLOC(
1141 lc->lconn_rebind_queue, sizeof(void *) * (j + 2));
1143 if( lc->lconn_rebind_queue == NULL ) {
1144 ld->ld_errno = LDAP_NO_MEMORY;
1148 lc->lconn_rebind_queue[j] = refarray;
1149 lc->lconn_rebind_queue[j+1] = NULL;
1153 /* We have queued the referral/reference, now just return */
1156 count = 1; /* Pretend we already followed referral */
1160 /* Re-encode the request with the new starting point of the search.
1161 * Note: In the future we also need to replace the filter if one
1162 * was provided with the search reference
1165 /* For references we don't want old dn if new dn empty */
1166 if ( sref && srv->lud_dn == NULL ) {
1167 srv->lud_dn = LDAP_STRDUP( "" );
1170 LDAP_NEXT_MSGID( ld, id );
1171 ber = re_encode_request( ld, origreq->lr_ber, id,
1172 sref, srv, &rinfo.ri_request );
1175 ld->ld_errno = LDAP_ENCODING_ERROR;
1180 Debug( LDAP_DEBUG_TRACE,
1181 "ldap_chase_v3referral: msgid %d, url \"%s\"\n",
1182 lr->lr_msgid, refarray[i], 0);
1184 /* Send the new request to the server - may require a bind */
1185 rinfo.ri_msgid = origreq->lr_origid;
1186 rinfo.ri_url = refarray[i];
1187 LDAP_MUTEX_LOCK( &ld->ld_req_mutex );
1188 rc = ldap_send_server_request( ld, ber, id,
1189 origreq, &srv, NULL, &rinfo );
1190 LDAP_MUTEX_UNLOCK( &ld->ld_req_mutex );
1192 /* Failure, try next referral in the list */
1193 Debug( LDAP_DEBUG_ANY, "Unable to chase referral \"%s\" (%d: %s)\n",
1194 refarray[i], ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1195 unfollowedcnt += ldap_append_referral( ld, &unfollowed, refarray[i] );
1196 ldap_free_urllist( srv );
1198 ld->ld_errno = LDAP_REFERRAL;
1200 /* Success, no need to try this referral list further */
1205 /* check if there is a queue of referrals that came in during bind */
1207 lc = find_connection( ld, srv, 1 );
1209 ld->ld_errno = LDAP_OPERATIONS_ERROR;
1215 if ( lc->lconn_rebind_queue != NULL ) {
1216 /* Release resources of previous list */
1217 LDAP_VFREE( refarray );
1219 ldap_free_urllist( srv );
1222 /* Pull entries off end of queue so list always null terminated */
1223 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++ )
1225 refarray = lc->lconn_rebind_queue[j - 1];
1226 lc->lconn_rebind_queue[j-1] = NULL;
1227 /* we pulled off last entry from queue, free queue */
1229 LDAP_FREE( lc->lconn_rebind_queue );
1230 lc->lconn_rebind_queue = NULL;
1232 /* restart the loop the with new referral list */
1236 break; /* referral followed, break out of for loop */
1238 } /* end for loop */
1240 LDAP_VFREE( refarray );
1241 ldap_free_urllist( srv );
1242 LDAP_FREE( *errstrp );
1246 LDAP_FREE( unfollowed );
1249 *errstrp = unfollowed;
1255 * XXX merging of errors in this routine needs to be improved
1258 ldap_chase_referrals( LDAP *ld,
1266 char *p, *ref, *unfollowed;
1267 LDAPRequest *origreq;
1273 Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
1275 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
1278 if ( *errstrp == NULL ) {
1282 len = strlen( *errstrp );
1283 for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
1284 if ( strncasecmp( p, LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
1286 p += LDAP_REF_STR_LEN;
1291 if ( len < LDAP_REF_STR_LEN ) {
1295 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1296 Debug( LDAP_DEBUG_ANY,
1297 "more than %d referral hops (dropping)\n",
1298 ld->ld_refhoplimit, 0, 0 );
1299 /* XXX report as error in ld->ld_errno? */
1303 /* find original request */
1304 for ( origreq = lr; origreq->lr_parent != NULL;
1305 origreq = origreq->lr_parent ) {
1312 /* parse out & follow referrals */
1313 for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
1314 p = strchr( ref, '\n' );
1319 rc = ldap_url_parse_ext( ref, &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1320 if ( rc != LDAP_URL_SUCCESS ) {
1321 Debug( LDAP_DEBUG_TRACE,
1322 "ignoring %s referral <%s>\n",
1323 ref, rc == LDAP_URL_ERR_BADSCHEME ? "unknown" : "incorrect", 0 );
1324 rc = ldap_append_referral( ld, &unfollowed, ref );
1329 Debug( LDAP_DEBUG_TRACE,
1330 "chasing LDAP referral: <%s>\n", ref, 0, 0 );
1334 /* See if we've already been here */
1335 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1338 ber_len_t len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1339 for ( lp = lr; lp; lp = lp->lr_parent ) {
1340 if ( lp->lr_conn == lc
1341 && len == lp->lr_dn.bv_len )
1343 if ( len && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) )
1350 ldap_free_urllist( srv );
1351 ld->ld_errno = LDAP_CLIENT_LOOP;
1357 LDAP_NEXT_MSGID( ld, id );
1358 ber = re_encode_request( ld, origreq->lr_ber,
1359 id, sref, srv, &rinfo.ri_request );
1361 if ( ber == NULL ) {
1365 /* copy the complete referral for rebind process */
1366 rinfo.ri_url = LDAP_STRDUP( ref );
1368 rinfo.ri_msgid = origreq->lr_origid;
1370 LDAP_MUTEX_LOCK( &ld->ld_req_mutex );
1371 rc = ldap_send_server_request( ld, ber, id,
1372 lr, &srv, NULL, &rinfo );
1373 LDAP_MUTEX_UNLOCK( &ld->ld_req_mutex );
1375 LDAP_FREE( rinfo.ri_url );
1380 Debug( LDAP_DEBUG_ANY,
1381 "Unable to chase referral \"%s\" (%d: %s)\n",
1382 ref, ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1383 rc = ldap_append_referral( ld, &unfollowed, ref );
1386 ldap_free_urllist(srv);
1389 LDAP_FREE( *errstrp );
1390 *errstrp = unfollowed;
1392 return(( rc == 0 ) ? count : rc );
1397 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
1401 if ( *referralsp == NULL ) {
1403 *referralsp = (char *)LDAP_MALLOC( strlen( s ) + LDAP_REF_STR_LEN
1407 *referralsp = (char *)LDAP_REALLOC( *referralsp,
1408 strlen( *referralsp ) + strlen( s ) + 2 );
1411 if ( *referralsp == NULL ) {
1412 ld->ld_errno = LDAP_NO_MEMORY;
1417 strcpy( *referralsp, LDAP_REF_STR );
1419 strcat( *referralsp, "\n" );
1421 strcat( *referralsp, s );
1429 re_encode_request( LDAP *ld,
1430 BerElement *origber,
1437 * XXX this routine knows way too much about how the lber library works!
1445 BerElement tmpber, *ber;
1448 Debug( LDAP_DEBUG_TRACE,
1449 "re_encode_request: new msgid %ld, new dn <%s>\n",
1451 ( srv == NULL || srv->lud_dn == NULL) ? "NONE" : srv->lud_dn, 0 );
1456 * all LDAP requests are sequences that start with a message id.
1457 * For all except delete, this is followed by a sequence that is
1458 * tagged with the operation code. For delete, the provided DN
1459 * is not wrapped by a sequence.
1461 rtag = ber_scanf( &tmpber, "{it", /*}*/ &along, &tag );
1463 if ( rtag == LBER_ERROR ) {
1464 ld->ld_errno = LDAP_DECODING_ERROR;
1469 if ( tag == LDAP_REQ_BIND ) {
1470 /* bind requests have a version number before the DN & other stuff */
1471 rtag = ber_scanf( &tmpber, "{im" /*}*/, &ver, &dn );
1473 } else if ( tag == LDAP_REQ_DELETE ) {
1474 /* delete requests don't have a DN wrapping sequence */
1475 rtag = ber_scanf( &tmpber, "m", &dn );
1477 } else if ( tag == LDAP_REQ_SEARCH ) {
1478 /* search requests need to be re-scope-ed */
1479 rtag = ber_scanf( &tmpber, "{me" /*"}"*/, &dn, &scope );
1481 if( srv->lud_scope != LDAP_SCOPE_DEFAULT ) {
1482 /* use the scope provided in reference */
1483 scope = srv->lud_scope;
1485 } else if ( sref ) {
1486 /* use scope implied by previous operation
1489 * subtree -> subtree
1490 * subordinate -> subtree
1494 case LDAP_SCOPE_BASE:
1495 case LDAP_SCOPE_ONELEVEL:
1496 scope = LDAP_SCOPE_BASE;
1498 case LDAP_SCOPE_SUBTREE:
1499 case LDAP_SCOPE_SUBORDINATE:
1500 scope = LDAP_SCOPE_SUBTREE;
1506 rtag = ber_scanf( &tmpber, "{m" /*}*/, &dn );
1509 if( rtag == LBER_ERROR ) {
1510 ld->ld_errno = LDAP_DECODING_ERROR;
1514 /* restore character zero'd out by ber_scanf*/
1515 dn.bv_val[dn.bv_len] = tmpber.ber_tag;
1517 if (( ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
1521 if ( srv->lud_dn ) {
1522 ber_str2bv( srv->lud_dn, 0, 0, &dn );
1525 if ( tag == LDAP_REQ_BIND ) {
1526 rc = ber_printf( ber, "{it{iO" /*}}*/, msgid, tag, ver, &dn );
1527 } else if ( tag == LDAP_REQ_DELETE ) {
1528 rc = ber_printf( ber, "{itON}", msgid, tag, &dn );
1529 } else if ( tag == LDAP_REQ_SEARCH ) {
1530 rc = ber_printf( ber, "{it{Oe" /*}}*/, msgid, tag, &dn, scope );
1532 rc = ber_printf( ber, "{it{O" /*}}*/, msgid, tag, &dn );
1536 ld->ld_errno = LDAP_ENCODING_ERROR;
1541 if ( tag != LDAP_REQ_DELETE && (
1542 ber_write(ber, tmpber.ber_ptr, ( tmpber.ber_end - tmpber.ber_ptr ), 0)
1543 != ( tmpber.ber_end - tmpber.ber_ptr ) ||
1544 ber_printf( ber, /*{{*/ "N}N}" ) == -1 ) )
1546 ld->ld_errno = LDAP_ENCODING_ERROR;
1552 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
1553 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
1555 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ber, 0 );
1557 #endif /* LDAP_DEBUG */
1559 *type = tag; /* return request type */
1565 ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid )
1569 LDAP_MUTEX_LOCK( &ld->ld_req_mutex );
1570 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1571 if ( lr->lr_status == LDAP_REQST_COMPLETED ) {
1572 continue; /* Skip completed requests */
1574 if ( msgid == lr->lr_msgid ) {
1579 LDAP_MUTEX_UNLOCK( &ld->ld_req_mutex );
1585 ldap_return_request( LDAP *ld, LDAPRequest *lrx, int freeit )
1589 LDAP_MUTEX_LOCK( &ld->ld_req_mutex );
1590 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1592 if ( lr->lr_refcnt > 0 ) {
1595 } else if ( lr->lr_refcnt < 0 ) {
1597 if ( lr->lr_refcnt == 0 ) {
1605 ldap_free_request_int( ld, lrx );
1607 } else if ( freeit ) {
1608 ldap_free_request( ld, lrx );
1610 LDAP_MUTEX_UNLOCK( &ld->ld_req_mutex );