2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2006 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 ( 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 if ( lc == NULL || lc->lconn_status != LDAP_CONNST_CONNECTED ) {
214 if ( ld->ld_errno == LDAP_SUCCESS ) {
215 ld->ld_errno = LDAP_SERVER_DOWN;
218 /* Forget about the bind */
219 --parentreq->lr_outrefcnt;
224 use_connection( ld, lc );
226 /* If we still have an incomplete write, try to finish it before
227 * dealing with the new request. If we don't finish here, return
228 * LDAP_BUSY and let the caller retry later. We only allow a single
229 * request to be in WRITING state.
232 if ( ld->ld_requests &&
233 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
234 ldap_int_flush_request( ld, ld->ld_requests ) < 0 )
240 lr = (LDAPRequest *)LDAP_CALLOC( 1, sizeof( LDAPRequest ) );
242 ld->ld_errno = LDAP_NO_MEMORY;
243 ldap_free_connection( ld, lc, 0, 0 );
246 /* Forget about the bind */
247 --parentreq->lr_outrefcnt;
251 lr->lr_msgid = msgid;
252 lr->lr_status = LDAP_REQST_INPROGRESS;
253 lr->lr_res_errno = LDAP_SUCCESS; /* optimistic */
256 if ( parentreq != NULL ) { /* sub-request */
258 /* Increment if we didn't do it before the bind */
259 ++parentreq->lr_outrefcnt;
261 lr->lr_origid = parentreq->lr_origid;
262 lr->lr_parentcnt = ++parentreq->lr_parentcnt;
263 lr->lr_parent = parentreq;
264 lr->lr_refnext = parentreq->lr_child;
265 parentreq->lr_child = lr;
266 } else { /* original request */
267 lr->lr_origid = lr->lr_msgid;
270 /* Extract requestDN for future reference */
272 BerElement tmpber = *ber;
276 ber_reset( &tmpber, 1 );
277 rtag = ber_scanf( &tmpber, "{it", /*}*/ &bint, &tag );
280 rtag = ber_scanf( &tmpber, "{i" /*}*/, &bint );
282 case LDAP_REQ_DELETE:
285 rtag = ber_scanf( &tmpber, "{" /*}*/ );
286 case LDAP_REQ_ABANDON:
289 if ( tag != LDAP_REQ_ABANDON ) {
290 ber_skip_tag( &tmpber, &lr->lr_dn.bv_len );
291 lr->lr_dn.bv_val = tmpber.ber_ptr;
296 if (( lr->lr_next = ld->ld_requests ) != NULL ) {
297 lr->lr_next->lr_prev = lr;
299 ld->ld_requests = lr;
301 ld->ld_errno = LDAP_SUCCESS;
302 if ( ldap_int_flush_request( ld, lr ) == -1 ) {
310 ldap_new_connection( LDAP *ld, LDAPURLDesc **srvlist, int use_ldsb,
311 int connect, LDAPreqinfo *bind )
315 Debug( LDAP_DEBUG_TRACE, "ldap_new_connection %d %d %d\n",
316 use_ldsb, connect, (bind != NULL) );
318 * make a new LDAP server connection
319 * XXX open connection synchronously for now
321 lc = (LDAPConn *)LDAP_CALLOC( 1, sizeof( LDAPConn ) );
323 ld->ld_errno = LDAP_NO_MEMORY;
328 assert( ld->ld_sb != NULL );
329 lc->lconn_sb = ld->ld_sb;
332 lc->lconn_sb = ber_sockbuf_alloc();
333 if ( lc->lconn_sb == NULL ) {
334 LDAP_FREE( (char *)lc );
335 ld->ld_errno = LDAP_NO_MEMORY;
341 LDAPURLDesc **srvp, *srv = NULL;
343 for ( srvp = srvlist; *srvp != NULL; srvp = &(*srvp)->lud_next ) {
344 if ( ldap_int_open_connection( ld, lc, *srvp, 0 ) != -1 )
348 if ( ld->ld_urllist_proc ) {
349 ld->ld_urllist_proc( ld, srvlist, srvp, ld->ld_urllist_params );
358 ber_sockbuf_free( lc->lconn_sb );
360 LDAP_FREE( (char *)lc );
361 ld->ld_errno = LDAP_SERVER_DOWN;
365 lc->lconn_server = ldap_url_dup( srv );
368 lc->lconn_status = LDAP_CONNST_CONNECTED;
369 #ifdef LDAP_R_COMPILE
370 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
372 lc->lconn_next = ld->ld_conns;
374 #ifdef LDAP_R_COMPILE
375 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
378 if ( bind != NULL ) {
380 LDAPConn *savedefconn;
382 /* Set flag to prevent additional referrals
383 * from being processed on this
384 * connection until the bind has completed
386 lc->lconn_rebind_inprogress = 1;
387 /* V3 rebind function */
388 if ( ld->ld_rebind_proc != NULL) {
389 LDAPURLDesc *srvfunc;
391 srvfunc = ldap_url_dup( *srvlist );
392 if ( srvfunc == NULL ) {
393 ld->ld_errno = LDAP_NO_MEMORY;
396 savedefconn = ld->ld_defconn;
397 ++lc->lconn_refcnt; /* avoid premature free */
400 Debug( LDAP_DEBUG_TRACE, "Call application rebind_proc\n", 0, 0, 0);
401 #ifdef LDAP_R_COMPILE
402 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
403 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
405 err = (*ld->ld_rebind_proc)( ld,
406 bind->ri_url, bind->ri_request, bind->ri_msgid,
407 ld->ld_rebind_params );
408 #ifdef LDAP_R_COMPILE
409 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
410 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
413 ld->ld_defconn = savedefconn;
418 ldap_free_connection( ld, lc, 1, 0 );
421 ldap_free_urldesc( srvfunc );
426 struct berval passwd = BER_BVNULL;
428 savedefconn = ld->ld_defconn;
429 ++lc->lconn_refcnt; /* avoid premature free */
432 Debug( LDAP_DEBUG_TRACE, "anonymous rebind via ldap_bind_s\n", 0, 0, 0);
433 #ifdef LDAP_R_COMPILE
434 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
435 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
437 rc = ldap_sasl_bind( ld, "", LDAP_SASL_SIMPLE, &passwd,
438 NULL, NULL, &msgid );
439 if ( rc != LDAP_SUCCESS ) {
443 for ( err = 1; err > 0; ) {
444 struct timeval tv = { 0, 100000 };
445 LDAPMessage *res = NULL;
447 switch ( ldap_result( ld, msgid, LDAP_MSG_ALL, &tv, &res ) ) {
453 #ifdef LDAP_R_COMPILE
454 ldap_pvt_thread_yield();
459 rc = ldap_parse_result( ld, res, &err, NULL, NULL, NULL, NULL, 1 );
460 if ( rc != LDAP_SUCCESS ) {
463 } else if ( err != LDAP_SUCCESS ) {
466 /* else err == LDAP_SUCCESS == 0 */
474 #ifdef LDAP_R_COMPILE
475 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
476 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
478 ld->ld_defconn = savedefconn;
482 ldap_free_connection( ld, lc, 1, 0 );
487 lc->lconn_rebind_inprogress = 0;
495 find_connection( LDAP *ld, LDAPURLDesc *srv, int any )
497 * return an existing connection (if any) to the server srv
498 * if "any" is non-zero, check for any server in the "srv" chain
502 LDAPURLDesc *lcu, *lsu;
503 int lcu_port, lsu_port;
506 #ifdef LDAP_R_COMPILE
507 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
509 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
510 lcu = lc->lconn_server;
511 lcu_port = ldap_pvt_url_scheme_port( lcu->lud_scheme,
514 for ( lsu = srv; lsu != NULL; lsu = lsu->lud_next ) {
515 lsu_port = ldap_pvt_url_scheme_port( lsu->lud_scheme,
518 if ( lsu_port == lcu_port
519 && strcmp( lcu->lud_scheme, lsu->lud_scheme ) == 0
520 && lcu->lud_host != NULL && *lcu->lud_host != '\0'
521 && lsu->lud_host != NULL && *lsu->lud_host != '\0'
522 && strcasecmp( lsu->lud_host, lcu->lud_host ) == 0 )
533 #ifdef LDAP_R_COMPILE
534 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
542 use_connection( LDAP *ld, LDAPConn *lc )
545 lc->lconn_lastused = time( NULL );
550 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
552 LDAPConn *tmplc, *prevlc;
554 Debug( LDAP_DEBUG_TRACE,
555 "ldap_free_connection %d %d\n",
558 if ( force || --lc->lconn_refcnt <= 0 ) {
559 /* remove from connections list first */
560 #ifdef LDAP_R_COMPILE
561 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
564 for ( prevlc = NULL, tmplc = ld->ld_conns;
566 tmplc = tmplc->lconn_next )
569 if ( prevlc == NULL ) {
570 ld->ld_conns = tmplc->lconn_next;
572 prevlc->lconn_next = tmplc->lconn_next;
578 #ifdef LDAP_R_COMPILE
579 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
582 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
583 ldap_mark_select_clear( ld, lc->lconn_sb );
585 ldap_send_unbind( ld, lc->lconn_sb,
590 if ( lc->lconn_ber != NULL ) {
591 ber_free( lc->lconn_ber, 1 );
594 ldap_int_sasl_close( ld, lc );
596 ldap_free_urllist( lc->lconn_server );
597 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
598 if ( lc->lconn_krbinstance != NULL ) {
599 LDAP_FREE( lc->lconn_krbinstance );
603 /* FIXME: is this at all possible?
604 * ldap_ld_free() in unbind.c calls ldap_free_connection()
605 * with force == 1 __after__ explicitly calling
606 * ldap_free_request() on all requests */
610 for ( lr = ld->ld_requests; lr; ) {
611 LDAPRequest *lr_next = lr->lr_next;
613 if ( lr->lr_conn == lc ) {
614 ldap_free_request_int( ld, lr );
621 if ( lc->lconn_sb != ld->ld_sb ) {
622 ber_sockbuf_free( lc->lconn_sb );
625 if ( lc->lconn_rebind_queue != NULL) {
627 for( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
628 LDAP_VFREE( lc->lconn_rebind_queue[i] );
630 LDAP_FREE( lc->lconn_rebind_queue );
635 Debug( LDAP_DEBUG_TRACE,
636 "ldap_free_connection: actually freed\n",
640 lc->lconn_lastused = time( NULL );
641 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
642 lc->lconn_refcnt, 0, 0 );
649 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
654 Debug( LDAP_DEBUG_TRACE, "** ld %p Connection%s:\n", (void *)ld, all ? "s" : "", 0 );
655 for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
656 if ( lc->lconn_server != NULL ) {
657 Debug( LDAP_DEBUG_TRACE, "* host: %s port: %d%s\n",
658 ( lc->lconn_server->lud_host == NULL ) ? "(null)"
659 : lc->lconn_server->lud_host,
660 lc->lconn_server->lud_port, ( lc->lconn_sb ==
661 ld->ld_sb ) ? " (default)" : "" );
663 Debug( LDAP_DEBUG_TRACE, " refcnt: %d status: %s\n", lc->lconn_refcnt,
664 ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET )
665 ? "NeedSocket" : ( lc->lconn_status == LDAP_CONNST_CONNECTING )
666 ? "Connecting" : "Connected", 0 );
667 Debug( LDAP_DEBUG_TRACE, " last used: %s%s\n",
668 ldap_pvt_ctime( &lc->lconn_lastused, timebuf ),
669 lc->lconn_rebind_inprogress ? " rebind in progress" : "", 0 );
670 if ( lc->lconn_rebind_inprogress ) {
671 if ( lc->lconn_rebind_queue != NULL) {
674 for ( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
676 for( j = 0; lc->lconn_rebind_queue[i][j] != 0; j++ ) {
677 Debug( LDAP_DEBUG_TRACE, " queue %d entry %d - %s\n",
678 i, j, lc->lconn_rebind_queue[i][j] );
682 Debug( LDAP_DEBUG_TRACE, " queue is empty\n", 0, 0, 0 );
685 Debug( LDAP_DEBUG_TRACE, "\n", 0, 0, 0 );
694 ldap_dump_requests_and_responses( LDAP *ld )
700 Debug( LDAP_DEBUG_TRACE, "** ld %p Outstanding Requests:\n",
702 lr = ld->ld_requests;
704 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
706 for ( i = 0; lr != NULL; lr = lr->lr_next, i++ ) {
707 Debug( LDAP_DEBUG_TRACE, " * msgid %d, origid %d, status %s\n",
708 lr->lr_msgid, lr->lr_origid,
709 ( lr->lr_status == LDAP_REQST_INPROGRESS ) ? "InProgress" :
710 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
711 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
712 ( lr->lr_status == LDAP_REQST_WRITING ) ? "Writing" :
713 ( lr->lr_status == LDAP_REQST_COMPLETED ) ? "RequestCompleted"
715 Debug( LDAP_DEBUG_TRACE, " outstanding referrals %d, parent count %d\n",
716 lr->lr_outrefcnt, lr->lr_parentcnt, 0 );
718 Debug( LDAP_DEBUG_TRACE, " ld %p request count %d\n", (void *)ld, i, 0 );
719 Debug( LDAP_DEBUG_TRACE, "** ld %p Response Queue:\n", (void *)ld, 0, 0 );
720 if ( ( lm = ld->ld_responses ) == NULL ) {
721 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
723 for ( i = 0; lm != NULL; lm = lm->lm_next, i++ ) {
724 Debug( LDAP_DEBUG_TRACE, " * msgid %d, type %lu\n",
725 lm->lm_msgid, (unsigned long)lm->lm_msgtype, 0 );
726 if ( ( l = lm->lm_chain ) != NULL ) {
727 Debug( LDAP_DEBUG_TRACE, " chained responses:\n", 0, 0, 0 );
728 for ( ; l != NULL; l = l->lm_chain ) {
729 Debug( LDAP_DEBUG_TRACE,
730 " * msgid %d, type %lu\n",
732 (unsigned long)l->lm_msgtype, 0 );
736 Debug( LDAP_DEBUG_TRACE, " ld %p response count %d\n", (void *)ld, i, 0 );
738 #endif /* LDAP_DEBUG */
741 ldap_free_request_int( LDAP *ld, LDAPRequest *lr )
743 if ( lr->lr_prev == NULL ) {
744 /* free'ing the first request? */
745 assert( ld->ld_requests == lr );
746 ld->ld_requests = lr->lr_next;
749 lr->lr_prev->lr_next = lr->lr_next;
752 if ( lr->lr_next != NULL ) {
753 lr->lr_next->lr_prev = lr->lr_prev;
756 if ( lr->lr_ber != NULL ) {
757 ber_free( lr->lr_ber, 1 );
761 if ( lr->lr_res_error != NULL ) {
762 LDAP_FREE( lr->lr_res_error );
763 lr->lr_res_error = NULL;
766 if ( lr->lr_res_matched != NULL ) {
767 LDAP_FREE( lr->lr_res_matched );
768 lr->lr_res_matched = NULL;
775 ldap_free_request( LDAP *ld, LDAPRequest *lr )
777 LDAPRequest **ttmplr;
778 #ifdef LDAP_R_COMPILE
779 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
782 Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
783 lr->lr_origid, lr->lr_msgid, 0 );
785 /* free all referrals (child requests) */
786 while ( lr->lr_child )
787 ldap_free_request( ld, lr->lr_child );
789 if ( lr->lr_parent != NULL ) {
790 --lr->lr_parent->lr_outrefcnt;
791 for ( ttmplr = &lr->lr_parent->lr_child; *ttmplr && *ttmplr != lr; ttmplr = &(*ttmplr)->lr_refnext );
793 *ttmplr = lr->lr_refnext;
795 ldap_free_request_int( ld, lr );
799 * call first time with *cntp = -1
800 * when returns *cntp == -1, no referrals are left
802 * NOTE: may replace *refsp, or shuffle the contents
803 * of the original array.
805 static int ldap_int_nextref(
811 assert( refsp != NULL );
812 assert( *refsp != NULL );
813 assert( cntp != NULL );
822 if ( (*refsp)[ *cntp ] == NULL ) {
833 * (IN) ld = LDAP connection handle
834 * (IN) lr = LDAP Request structure
835 * (IN) refs = array of pointers to referral strings that we will chase
836 * The array will be free'd by this function when no longer needed
837 * (IN) sref != 0 if following search reference
838 * (OUT) errstrp = Place to return a string of referrals which could not be followed
839 * (OUT) hadrefp = 1 if sucessfully followed referral
841 * Return value - number of referrals followed
844 ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, int sref, char **errstrp, int *hadrefp )
847 int unfollowedcnt = 0;
848 LDAPRequest *origreq;
849 LDAPURLDesc *srv = NULL;
851 char **refarray = NULL;
853 int rc, count, i, j, id;
856 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
859 Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referrals\n", 0, 0, 0 );
864 /* If no referrals in array, return */
865 if ( (refs == NULL) || ( (refs)[0] == NULL) ) {
870 /* Check for hop limit exceeded */
871 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
872 Debug( LDAP_DEBUG_ANY,
873 "more than %d referral hops (dropping)\n", ld->ld_refhoplimit, 0, 0 );
874 ld->ld_errno = LDAP_REFERRAL_LIMIT_EXCEEDED;
879 /* find original request */
881 origreq->lr_parent != NULL;
882 origreq = origreq->lr_parent )
890 if ( ld->ld_nextref_proc == NULL ) {
891 ld->ld_nextref_proc = ldap_int_nextref;
894 /* parse out & follow referrals */
896 for ( ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params );
898 ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params ) )
901 /* Parse the referral URL */
902 rc = ldap_url_parse_ext( refarray[i], &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
903 if ( rc != LDAP_URL_SUCCESS ) {
904 /* ldap_url_parse_ext() returns LDAP_URL_* errors
905 * which do not map on API errors */
906 ld->ld_errno = LDAP_PARAM_ERROR;
911 if( srv->lud_crit_exts ) {
912 /* we do not support any extensions */
913 ld->ld_errno = LDAP_NOT_SUPPORTED;
918 /* check connection for re-bind in progress */
919 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
920 /* See if we've already requested this DN with this conn */
923 int len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
924 for ( lp = origreq; lp; ) {
925 if ( lp->lr_conn == lc
926 && len == lp->lr_dn.bv_len
928 && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) == 0 )
933 if ( lp == origreq ) {
940 ldap_free_urllist( srv );
942 ld->ld_errno = LDAP_CLIENT_LOOP;
947 if ( lc->lconn_rebind_inprogress ) {
948 /* We are already chasing a referral or search reference and a
949 * bind on that connection is in progress. We must queue
950 * referrals on that connection, so we don't get a request
951 * going out before the bind operation completes. This happens
952 * if two search references come in one behind the other
953 * for the same server with different contexts.
955 Debug( LDAP_DEBUG_TRACE,
956 "ldap_chase_v3referrals: queue referral \"%s\"\n",
958 if( lc->lconn_rebind_queue == NULL ) {
959 /* Create a referral list */
960 lc->lconn_rebind_queue =
961 (char ***) LDAP_MALLOC( sizeof(void *) * 2);
963 if( lc->lconn_rebind_queue == NULL) {
964 ld->ld_errno = LDAP_NO_MEMORY;
969 lc->lconn_rebind_queue[0] = refarray;
970 lc->lconn_rebind_queue[1] = NULL;
974 /* Count how many referral arrays we already have */
975 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
979 /* Add the new referral to the list */
980 lc->lconn_rebind_queue = (char ***) LDAP_REALLOC(
981 lc->lconn_rebind_queue, sizeof(void *) * (j + 2));
983 if( lc->lconn_rebind_queue == NULL ) {
984 ld->ld_errno = LDAP_NO_MEMORY;
988 lc->lconn_rebind_queue[j] = refarray;
989 lc->lconn_rebind_queue[j+1] = NULL;
993 /* We have queued the referral/reference, now just return */
996 count = 1; /* Pretend we already followed referral */
1000 /* Re-encode the request with the new starting point of the search.
1001 * Note: In the future we also need to replace the filter if one
1002 * was provided with the search reference
1005 /* For references we don't want old dn if new dn empty */
1006 if ( sref && srv->lud_dn == NULL ) {
1007 srv->lud_dn = LDAP_STRDUP( "" );
1010 LDAP_NEXT_MSGID( ld, id );
1011 ber = re_encode_request( ld, origreq->lr_ber, id,
1012 sref, srv, &rinfo.ri_request );
1015 ld->ld_errno = LDAP_ENCODING_ERROR;
1020 Debug( LDAP_DEBUG_TRACE,
1021 "ldap_chase_v3referral: msgid %d, url \"%s\"\n",
1022 lr->lr_msgid, refarray[i], 0);
1024 /* Send the new request to the server - may require a bind */
1025 rinfo.ri_msgid = origreq->lr_origid;
1026 rinfo.ri_url = refarray[i];
1027 #ifdef LDAP_R_COMPILE
1028 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1030 rc = ldap_send_server_request( ld, ber, id,
1031 origreq, &srv, NULL, &rinfo );
1032 #ifdef LDAP_R_COMPILE
1033 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1036 /* Failure, try next referral in the list */
1037 Debug( LDAP_DEBUG_ANY, "Unable to chase referral \"%s\" (%d: %s)\n",
1038 refarray[i], ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1039 unfollowedcnt += ldap_append_referral( ld, &unfollowed, refarray[i] );
1040 ldap_free_urllist( srv );
1042 ld->ld_errno = LDAP_REFERRAL;
1044 /* Success, no need to try this referral list further */
1049 /* check if there is a queue of referrals that came in during bind */
1051 lc = find_connection( ld, srv, 1 );
1053 ld->ld_errno = LDAP_OPERATIONS_ERROR;
1059 if ( lc->lconn_rebind_queue != NULL ) {
1060 /* Release resources of previous list */
1061 LDAP_VFREE( refarray );
1063 ldap_free_urllist( srv );
1066 /* Pull entries off end of queue so list always null terminated */
1067 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++ )
1069 refarray = lc->lconn_rebind_queue[j - 1];
1070 lc->lconn_rebind_queue[j-1] = NULL;
1071 /* we pulled off last entry from queue, free queue */
1073 LDAP_FREE( lc->lconn_rebind_queue );
1074 lc->lconn_rebind_queue = NULL;
1076 /* restart the loop the with new referral list */
1080 break; /* referral followed, break out of for loop */
1082 } /* end for loop */
1084 LDAP_VFREE( refarray );
1085 ldap_free_urllist( srv );
1086 LDAP_FREE( *errstrp );
1090 LDAP_FREE( unfollowed );
1093 *errstrp = unfollowed;
1099 * XXX merging of errors in this routine needs to be improved
1102 ldap_chase_referrals( LDAP *ld,
1110 char *p, *ref, *unfollowed;
1111 LDAPRequest *origreq;
1117 Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
1119 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
1122 if ( *errstrp == NULL ) {
1126 len = strlen( *errstrp );
1127 for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
1128 if ( strncasecmp( p, LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
1130 p += LDAP_REF_STR_LEN;
1135 if ( len < LDAP_REF_STR_LEN ) {
1139 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1140 Debug( LDAP_DEBUG_ANY,
1141 "more than %d referral hops (dropping)\n",
1142 ld->ld_refhoplimit, 0, 0 );
1143 /* XXX report as error in ld->ld_errno? */
1147 /* find original request */
1148 for ( origreq = lr; origreq->lr_parent != NULL;
1149 origreq = origreq->lr_parent ) {
1156 /* parse out & follow referrals */
1157 for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
1158 p = strchr( ref, '\n' );
1163 rc = ldap_url_parse_ext( ref, &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1164 if ( rc != LDAP_URL_SUCCESS ) {
1165 Debug( LDAP_DEBUG_TRACE,
1166 "ignoring %s referral <%s>\n",
1167 ref, rc == LDAP_URL_ERR_BADSCHEME ? "unknown" : "incorrect", 0 );
1168 rc = ldap_append_referral( ld, &unfollowed, ref );
1173 Debug( LDAP_DEBUG_TRACE,
1174 "chasing LDAP referral: <%s>\n", ref, 0, 0 );
1178 /* See if we've already been here */
1179 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1182 int len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1183 for ( lp = lr; lp; lp = lp->lr_parent ) {
1184 if ( lp->lr_conn == lc
1185 && len == lp->lr_dn.bv_len )
1187 if ( len && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) )
1194 ldap_free_urllist(srv);
1195 ld->ld_errno = LDAP_CLIENT_LOOP;
1201 LDAP_NEXT_MSGID( ld, id );
1202 ber = re_encode_request( ld, origreq->lr_ber,
1203 id, sref, srv, &rinfo.ri_request );
1205 if ( ber == NULL ) {
1209 /* copy the complete referral for rebind process */
1210 rinfo.ri_url = LDAP_STRDUP( ref );
1212 rinfo.ri_msgid = origreq->lr_origid;
1214 #ifdef LDAP_R_COMPILE
1215 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1217 rc = ldap_send_server_request( ld, ber, id,
1218 lr, &srv, NULL, &rinfo );
1219 #ifdef LDAP_R_COMPILE
1220 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1223 LDAP_FREE( rinfo.ri_url );
1228 Debug( LDAP_DEBUG_ANY,
1229 "Unable to chase referral \"%s\" (%d: %s)\n",
1230 ref, ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1231 rc = ldap_append_referral( ld, &unfollowed, ref );
1234 ldap_free_urllist(srv);
1237 LDAP_FREE( *errstrp );
1238 *errstrp = unfollowed;
1240 return(( rc == 0 ) ? count : rc );
1245 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
1249 if ( *referralsp == NULL ) {
1251 *referralsp = (char *)LDAP_MALLOC( strlen( s ) + LDAP_REF_STR_LEN
1255 *referralsp = (char *)LDAP_REALLOC( *referralsp,
1256 strlen( *referralsp ) + strlen( s ) + 2 );
1259 if ( *referralsp == NULL ) {
1260 ld->ld_errno = LDAP_NO_MEMORY;
1265 strcpy( *referralsp, LDAP_REF_STR );
1267 strcat( *referralsp, "\n" );
1269 strcat( *referralsp, s );
1277 re_encode_request( LDAP *ld,
1278 BerElement *origber,
1285 * XXX this routine knows way too much about how the lber library works!
1293 BerElement tmpber, *ber;
1296 Debug( LDAP_DEBUG_TRACE,
1297 "re_encode_request: new msgid %ld, new dn <%s>\n",
1299 ( srv == NULL || srv->lud_dn == NULL) ? "NONE" : srv->lud_dn, 0 );
1304 * all LDAP requests are sequences that start with a message id.
1305 * For all except delete, this is followed by a sequence that is
1306 * tagged with the operation code. For delete, the provided DN
1307 * is not wrapped by a sequence.
1309 rtag = ber_scanf( &tmpber, "{it", /*}*/ &along, &tag );
1311 if ( rtag == LBER_ERROR ) {
1312 ld->ld_errno = LDAP_DECODING_ERROR;
1317 if ( tag == LDAP_REQ_BIND ) {
1318 /* bind requests have a version number before the DN & other stuff */
1319 rtag = ber_scanf( &tmpber, "{im" /*}*/, &ver, &dn );
1321 } else if ( tag == LDAP_REQ_DELETE ) {
1322 /* delete requests don't have a DN wrapping sequence */
1323 rtag = ber_scanf( &tmpber, "m", &dn );
1325 } else if ( tag == LDAP_REQ_SEARCH ) {
1326 /* search requests need to be re-scope-ed */
1327 rtag = ber_scanf( &tmpber, "{me" /*"}"*/, &dn, &scope );
1329 if( srv->lud_scope != LDAP_SCOPE_DEFAULT ) {
1330 /* use the scope provided in reference */
1331 scope = srv->lud_scope;
1333 } else if ( sref ) {
1334 /* use scope implied by previous operation
1337 * subtree -> subtree
1338 * subordinate -> subtree
1342 case LDAP_SCOPE_BASE:
1343 case LDAP_SCOPE_ONELEVEL:
1344 scope = LDAP_SCOPE_BASE;
1346 case LDAP_SCOPE_SUBTREE:
1347 case LDAP_SCOPE_SUBORDINATE:
1348 scope = LDAP_SCOPE_SUBTREE;
1354 rtag = ber_scanf( &tmpber, "{m" /*}*/, &dn );
1357 if( rtag == LBER_ERROR ) {
1358 ld->ld_errno = LDAP_DECODING_ERROR;
1362 /* restore character zero'd out by ber_scanf*/
1363 dn.bv_val[dn.bv_len] = tmpber.ber_tag;
1365 if (( ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
1369 if ( srv->lud_dn ) {
1370 ber_str2bv( srv->lud_dn, 0, 0, &dn );
1373 if ( tag == LDAP_REQ_BIND ) {
1374 rc = ber_printf( ber, "{it{iO" /*}}*/, msgid, tag, ver, &dn );
1375 } else if ( tag == LDAP_REQ_DELETE ) {
1376 rc = ber_printf( ber, "{itON}", msgid, tag, &dn );
1377 } else if ( tag == LDAP_REQ_SEARCH ) {
1378 rc = ber_printf( ber, "{it{Oe" /*}}*/, msgid, tag, &dn, scope );
1380 rc = ber_printf( ber, "{it{O" /*}}*/, msgid, tag, &dn );
1384 ld->ld_errno = LDAP_ENCODING_ERROR;
1389 if ( tag != LDAP_REQ_DELETE && (
1390 ber_write(ber, tmpber.ber_ptr, ( tmpber.ber_end - tmpber.ber_ptr ), 0)
1391 != ( tmpber.ber_end - tmpber.ber_ptr ) ||
1392 ber_printf( ber, /*{{*/ "N}N}" ) == -1 ) )
1394 ld->ld_errno = LDAP_ENCODING_ERROR;
1400 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
1401 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
1403 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ber, 0 );
1405 #endif /* LDAP_DEBUG */
1407 *type = tag; /* return request type */
1413 ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid )
1417 #ifdef LDAP_R_COMPILE
1418 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1420 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1421 if ( lr->lr_status == LDAP_REQST_COMPLETED ) {
1422 continue; /* Skip completed requests */
1424 if ( msgid == lr->lr_msgid ) {
1428 #ifdef LDAP_R_COMPILE
1429 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );