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 );
425 struct berval passwd = BER_BVNULL;
427 savedefconn = ld->ld_defconn;
428 ++lc->lconn_refcnt; /* avoid premature free */
431 Debug( LDAP_DEBUG_TRACE, "anonymous rebind via ldap_bind_s\n", 0, 0, 0);
432 #ifdef LDAP_R_COMPILE
433 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
434 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
436 rc = ldap_sasl_bind( ld, "", LDAP_SASL_SIMPLE, &passwd,
437 NULL, NULL, &msgid );
438 if ( rc != LDAP_SUCCESS ) {
442 for ( err = 1; err > 0; ) {
443 struct timeval tv = { 0, 100000 };
444 LDAPMessage *res = NULL;
446 switch ( ldap_result( ld, msgid, LDAP_MSG_ALL, &tv, &res ) ) {
452 #ifdef LDAP_R_COMPILE
453 ldap_pvt_thread_yield();
458 rc = ldap_parse_result( ld, res, &err, NULL, NULL, NULL, NULL, 1 );
459 if ( rc != LDAP_SUCCESS ) {
462 } else if ( err != LDAP_SUCCESS ) {
465 /* else err == LDAP_SUCCESS == 0 */
473 #ifdef LDAP_R_COMPILE
474 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
475 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
477 ld->ld_defconn = savedefconn;
481 ldap_free_connection( ld, lc, 1, 0 );
486 lc->lconn_rebind_inprogress = 0;
494 find_connection( LDAP *ld, LDAPURLDesc *srv, int any )
496 * return an existing connection (if any) to the server srv
497 * if "any" is non-zero, check for any server in the "srv" chain
501 LDAPURLDesc *lcu, *lsu;
502 int lcu_port, lsu_port;
505 #ifdef LDAP_R_COMPILE
506 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
508 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
509 lcu = lc->lconn_server;
510 lcu_port = ldap_pvt_url_scheme_port( lcu->lud_scheme,
513 for ( lsu = srv; lsu != NULL; lsu = lsu->lud_next ) {
514 lsu_port = ldap_pvt_url_scheme_port( lsu->lud_scheme,
517 if ( lsu_port == lcu_port
518 && strcmp( lcu->lud_scheme, lsu->lud_scheme ) == 0
519 && lcu->lud_host != NULL && *lcu->lud_host != '\0'
520 && lsu->lud_host != NULL && *lsu->lud_host != '\0'
521 && strcasecmp( lsu->lud_host, lcu->lud_host ) == 0 )
532 #ifdef LDAP_R_COMPILE
533 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
541 use_connection( LDAP *ld, LDAPConn *lc )
544 lc->lconn_lastused = time( NULL );
549 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
551 LDAPConn *tmplc, *prevlc;
553 Debug( LDAP_DEBUG_TRACE,
554 "ldap_free_connection %d %d\n",
557 if ( force || --lc->lconn_refcnt <= 0 ) {
558 /* remove from connections list first */
559 #ifdef LDAP_R_COMPILE
560 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
563 for ( prevlc = NULL, tmplc = ld->ld_conns;
565 tmplc = tmplc->lconn_next )
568 if ( prevlc == NULL ) {
569 ld->ld_conns = tmplc->lconn_next;
571 prevlc->lconn_next = tmplc->lconn_next;
577 #ifdef LDAP_R_COMPILE
578 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
581 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
582 ldap_mark_select_clear( ld, lc->lconn_sb );
584 ldap_send_unbind( ld, lc->lconn_sb,
589 if ( lc->lconn_ber != NULL ) {
590 ber_free( lc->lconn_ber, 1 );
593 ldap_int_sasl_close( ld, lc );
595 ldap_free_urllist( lc->lconn_server );
596 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_KBIND
597 if ( lc->lconn_krbinstance != NULL ) {
598 LDAP_FREE( lc->lconn_krbinstance );
602 /* FIXME: is this at all possible? */
606 for ( lr = ld->ld_requests; lr; ) {
607 LDAPRequest *lr_next = lr->lr_next;
609 if ( lr->lr_conn == lc ) {
610 ldap_free_request_int( ld, lr );
617 if ( lc->lconn_sb != ld->ld_sb ) {
618 ber_sockbuf_free( lc->lconn_sb );
621 if ( lc->lconn_rebind_queue != NULL) {
623 for( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
624 LDAP_VFREE( lc->lconn_rebind_queue[i] );
626 LDAP_FREE( lc->lconn_rebind_queue );
631 Debug( LDAP_DEBUG_TRACE,
632 "ldap_free_connection: actually freed\n",
636 lc->lconn_lastused = time( NULL );
637 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
638 lc->lconn_refcnt, 0, 0 );
645 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
650 Debug( LDAP_DEBUG_TRACE, "** ld %p Connection%s:\n", (void *)ld, all ? "s" : "", 0 );
651 for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
652 if ( lc->lconn_server != NULL ) {
653 Debug( LDAP_DEBUG_TRACE, "* host: %s port: %d%s\n",
654 ( lc->lconn_server->lud_host == NULL ) ? "(null)"
655 : lc->lconn_server->lud_host,
656 lc->lconn_server->lud_port, ( lc->lconn_sb ==
657 ld->ld_sb ) ? " (default)" : "" );
659 Debug( LDAP_DEBUG_TRACE, " refcnt: %d status: %s\n", lc->lconn_refcnt,
660 ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET )
661 ? "NeedSocket" : ( lc->lconn_status == LDAP_CONNST_CONNECTING )
662 ? "Connecting" : "Connected", 0 );
663 Debug( LDAP_DEBUG_TRACE, " last used: %s%s\n",
664 ldap_pvt_ctime( &lc->lconn_lastused, timebuf ),
665 lc->lconn_rebind_inprogress ? " rebind in progress" : "", 0 );
666 if ( lc->lconn_rebind_inprogress ) {
667 if ( lc->lconn_rebind_queue != NULL) {
670 for ( i = 0; lc->lconn_rebind_queue[i] != NULL; i++ ) {
672 for( j = 0; lc->lconn_rebind_queue[i][j] != 0; j++ ) {
673 Debug( LDAP_DEBUG_TRACE, " queue %d entry %d - %s\n",
674 i, j, lc->lconn_rebind_queue[i][j] );
678 Debug( LDAP_DEBUG_TRACE, " queue is empty\n", 0, 0, 0 );
681 Debug( LDAP_DEBUG_TRACE, "\n", 0, 0, 0 );
690 ldap_dump_requests_and_responses( LDAP *ld )
696 Debug( LDAP_DEBUG_TRACE, "** ld %p Outstanding Requests:\n",
698 lr = ld->ld_requests;
700 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
702 for ( i = 0; lr != NULL; lr = lr->lr_next, i++ ) {
703 Debug( LDAP_DEBUG_TRACE, " * msgid %d, origid %d, status %s\n",
704 lr->lr_msgid, lr->lr_origid,
705 ( lr->lr_status == LDAP_REQST_INPROGRESS ) ? "InProgress" :
706 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
707 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
708 ( lr->lr_status == LDAP_REQST_WRITING ) ? "Writing" :
709 ( lr->lr_status == LDAP_REQST_COMPLETED ) ? "RequestCompleted"
711 Debug( LDAP_DEBUG_TRACE, " outstanding referrals %d, parent count %d\n",
712 lr->lr_outrefcnt, lr->lr_parentcnt, 0 );
714 Debug( LDAP_DEBUG_TRACE, " ld %p request count %d\n", (void *)ld, i, 0 );
715 Debug( LDAP_DEBUG_TRACE, "** ld %p Response Queue:\n", (void *)ld, 0, 0 );
716 if ( ( lm = ld->ld_responses ) == NULL ) {
717 Debug( LDAP_DEBUG_TRACE, " Empty\n", 0, 0, 0 );
719 for ( i = 0; lm != NULL; lm = lm->lm_next, i++ ) {
720 Debug( LDAP_DEBUG_TRACE, " * msgid %d, type %lu\n",
721 lm->lm_msgid, (unsigned long)lm->lm_msgtype, 0 );
722 if ( ( l = lm->lm_chain ) != NULL ) {
723 Debug( LDAP_DEBUG_TRACE, " chained responses:\n", 0, 0, 0 );
724 for ( ; l != NULL; l = l->lm_chain ) {
725 Debug( LDAP_DEBUG_TRACE,
726 " * msgid %d, type %lu\n",
728 (unsigned long)l->lm_msgtype, 0 );
732 Debug( LDAP_DEBUG_TRACE, " ld %p response count %d\n", (void *)ld, i, 0 );
734 #endif /* LDAP_DEBUG */
737 ldap_free_request_int( LDAP *ld, LDAPRequest *lr )
739 if ( lr->lr_prev == NULL ) {
740 /* free'ing the first request? */
741 assert( ld->ld_requests == lr );
742 ld->ld_requests = lr->lr_next;
745 lr->lr_prev->lr_next = lr->lr_next;
748 if ( lr->lr_next != NULL ) {
749 lr->lr_next->lr_prev = lr->lr_prev;
752 if ( lr->lr_ber != NULL ) {
753 ber_free( lr->lr_ber, 1 );
757 if ( lr->lr_res_error != NULL ) {
758 LDAP_FREE( lr->lr_res_error );
759 lr->lr_res_error = NULL;
762 if ( lr->lr_res_matched != NULL ) {
763 LDAP_FREE( lr->lr_res_matched );
764 lr->lr_res_matched = NULL;
771 ldap_free_request( LDAP *ld, LDAPRequest *lr )
773 LDAPRequest **ttmplr;
774 #ifdef LDAP_R_COMPILE
775 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_req_mutex );
778 Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
779 lr->lr_origid, lr->lr_msgid, 0 );
781 /* free all referrals (child requests) */
782 while ( lr->lr_child )
783 ldap_free_request( ld, lr->lr_child );
785 if ( lr->lr_parent != NULL ) {
786 --lr->lr_parent->lr_outrefcnt;
787 for ( ttmplr = &lr->lr_parent->lr_child; *ttmplr && *ttmplr != lr; ttmplr = &(*ttmplr)->lr_refnext );
789 *ttmplr = lr->lr_refnext;
791 ldap_free_request_int( ld, lr );
795 * call first time with *cntp = -1
796 * when returns *cntp == -1, no referrals are left
798 * NOTE: may replace *refsp, or shuffle the contents
799 * of the original array.
801 static int ldap_int_nextref(
807 assert( refsp != NULL );
808 assert( *refsp != NULL );
809 assert( cntp != NULL );
818 if ( (*refsp)[ *cntp ] == NULL ) {
829 * (IN) ld = LDAP connection handle
830 * (IN) lr = LDAP Request structure
831 * (IN) refs = array of pointers to referral strings that we will chase
832 * The array will be free'd by this function when no longer needed
833 * (IN) sref != 0 if following search reference
834 * (OUT) errstrp = Place to return a string of referrals which could not be followed
835 * (OUT) hadrefp = 1 if sucessfully followed referral
837 * Return value - number of referrals followed
840 ldap_chase_v3referrals( LDAP *ld, LDAPRequest *lr, char **refs, int sref, char **errstrp, int *hadrefp )
843 int unfollowedcnt = 0;
844 LDAPRequest *origreq;
845 LDAPURLDesc *srv = NULL;
847 char **refarray = NULL;
849 int rc, count, i, j, id;
852 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
855 Debug( LDAP_DEBUG_TRACE, "ldap_chase_v3referrals\n", 0, 0, 0 );
860 /* If no referrals in array, return */
861 if ( (refs == NULL) || ( (refs)[0] == NULL) ) {
866 /* Check for hop limit exceeded */
867 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
868 Debug( LDAP_DEBUG_ANY,
869 "more than %d referral hops (dropping)\n", ld->ld_refhoplimit, 0, 0 );
870 ld->ld_errno = LDAP_REFERRAL_LIMIT_EXCEEDED;
875 /* find original request */
877 origreq->lr_parent != NULL;
878 origreq = origreq->lr_parent )
886 if ( ld->ld_nextref_proc == NULL ) {
887 ld->ld_nextref_proc = ldap_int_nextref;
890 /* parse out & follow referrals */
892 for ( ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params );
894 ld->ld_nextref_proc( ld, &refarray, &i, ld->ld_nextref_params ) )
897 /* Parse the referral URL */
898 rc = ldap_url_parse_ext( refarray[i], &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
899 if ( rc != LDAP_URL_SUCCESS ) {
900 /* ldap_url_parse_ext() returns LDAP_URL_* errors
901 * which do not map on API errors */
902 ld->ld_errno = LDAP_PARAM_ERROR;
907 if( srv->lud_crit_exts ) {
908 /* we do not support any extensions */
909 ld->ld_errno = LDAP_NOT_SUPPORTED;
914 /* check connection for re-bind in progress */
915 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
916 /* See if we've already requested this DN with this conn */
919 int len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
920 for ( lp = origreq; lp; ) {
921 if ( lp->lr_conn == lc
922 && len == lp->lr_dn.bv_len
924 && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) == 0 )
929 if ( lp == origreq ) {
936 ldap_free_urllist( srv );
938 ld->ld_errno = LDAP_CLIENT_LOOP;
943 if ( lc->lconn_rebind_inprogress ) {
944 /* We are already chasing a referral or search reference and a
945 * bind on that connection is in progress. We must queue
946 * referrals on that connection, so we don't get a request
947 * going out before the bind operation completes. This happens
948 * if two search references come in one behind the other
949 * for the same server with different contexts.
951 Debug( LDAP_DEBUG_TRACE,
952 "ldap_chase_v3referrals: queue referral \"%s\"\n",
954 if( lc->lconn_rebind_queue == NULL ) {
955 /* Create a referral list */
956 lc->lconn_rebind_queue =
957 (char ***) LDAP_MALLOC( sizeof(void *) * 2);
959 if( lc->lconn_rebind_queue == NULL) {
960 ld->ld_errno = LDAP_NO_MEMORY;
965 lc->lconn_rebind_queue[0] = refarray;
966 lc->lconn_rebind_queue[1] = NULL;
970 /* Count how many referral arrays we already have */
971 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++) {
975 /* Add the new referral to the list */
976 lc->lconn_rebind_queue = (char ***) LDAP_REALLOC(
977 lc->lconn_rebind_queue, sizeof(void *) * (j + 2));
979 if( lc->lconn_rebind_queue == NULL ) {
980 ld->ld_errno = LDAP_NO_MEMORY;
984 lc->lconn_rebind_queue[j] = refarray;
985 lc->lconn_rebind_queue[j+1] = NULL;
989 /* We have queued the referral/reference, now just return */
992 count = 1; /* Pretend we already followed referral */
996 /* Re-encode the request with the new starting point of the search.
997 * Note: In the future we also need to replace the filter if one
998 * was provided with the search reference
1001 /* For references we don't want old dn if new dn empty */
1002 if ( sref && srv->lud_dn == NULL ) {
1003 srv->lud_dn = LDAP_STRDUP( "" );
1006 LDAP_NEXT_MSGID( ld, id );
1007 ber = re_encode_request( ld, origreq->lr_ber, id,
1008 sref, srv, &rinfo.ri_request );
1011 ld->ld_errno = LDAP_ENCODING_ERROR;
1016 Debug( LDAP_DEBUG_TRACE,
1017 "ldap_chase_v3referral: msgid %d, url \"%s\"\n",
1018 lr->lr_msgid, refarray[i], 0);
1020 /* Send the new request to the server - may require a bind */
1021 rinfo.ri_msgid = origreq->lr_origid;
1022 rinfo.ri_url = refarray[i];
1023 #ifdef LDAP_R_COMPILE
1024 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1026 rc = ldap_send_server_request( ld, ber, id,
1027 origreq, &srv, NULL, &rinfo );
1028 #ifdef LDAP_R_COMPILE
1029 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1032 /* Failure, try next referral in the list */
1033 Debug( LDAP_DEBUG_ANY, "Unable to chase referral \"%s\" (%d: %s)\n",
1034 refarray[i], ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1035 unfollowedcnt += ldap_append_referral( ld, &unfollowed, refarray[i] );
1036 ldap_free_urllist( srv );
1038 ld->ld_errno = LDAP_REFERRAL;
1040 /* Success, no need to try this referral list further */
1045 /* check if there is a queue of referrals that came in during bind */
1047 lc = find_connection( ld, srv, 1 );
1049 ld->ld_errno = LDAP_OPERATIONS_ERROR;
1055 if ( lc->lconn_rebind_queue != NULL ) {
1056 /* Release resources of previous list */
1057 LDAP_VFREE( refarray );
1059 ldap_free_urllist( srv );
1062 /* Pull entries off end of queue so list always null terminated */
1063 for( j = 0; lc->lconn_rebind_queue[j] != NULL; j++ )
1065 refarray = lc->lconn_rebind_queue[j - 1];
1066 lc->lconn_rebind_queue[j-1] = NULL;
1067 /* we pulled off last entry from queue, free queue */
1069 LDAP_FREE( lc->lconn_rebind_queue );
1070 lc->lconn_rebind_queue = NULL;
1072 /* restart the loop the with new referral list */
1076 break; /* referral followed, break out of for loop */
1078 } /* end for loop */
1080 LDAP_VFREE( refarray );
1081 ldap_free_urllist( srv );
1082 LDAP_FREE( *errstrp );
1086 LDAP_FREE( unfollowed );
1089 *errstrp = unfollowed;
1095 * XXX merging of errors in this routine needs to be improved
1098 ldap_chase_referrals( LDAP *ld,
1106 char *p, *ref, *unfollowed;
1107 LDAPRequest *origreq;
1113 Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
1115 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
1118 if ( *errstrp == NULL ) {
1122 len = strlen( *errstrp );
1123 for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
1124 if ( strncasecmp( p, LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
1126 p += LDAP_REF_STR_LEN;
1131 if ( len < LDAP_REF_STR_LEN ) {
1135 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
1136 Debug( LDAP_DEBUG_ANY,
1137 "more than %d referral hops (dropping)\n",
1138 ld->ld_refhoplimit, 0, 0 );
1139 /* XXX report as error in ld->ld_errno? */
1143 /* find original request */
1144 for ( origreq = lr; origreq->lr_parent != NULL;
1145 origreq = origreq->lr_parent ) {
1152 /* parse out & follow referrals */
1153 for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
1154 p = strchr( ref, '\n' );
1159 rc = ldap_url_parse_ext( ref, &srv, LDAP_PVT_URL_PARSE_NOEMPTY_DN );
1160 if ( rc != LDAP_URL_SUCCESS ) {
1161 Debug( LDAP_DEBUG_TRACE,
1162 "ignoring %s referral <%s>\n",
1163 ref, rc == LDAP_URL_ERR_BADSCHEME ? "unknown" : "incorrect", 0 );
1164 rc = ldap_append_referral( ld, &unfollowed, ref );
1169 Debug( LDAP_DEBUG_TRACE,
1170 "chasing LDAP referral: <%s>\n", ref, 0, 0 );
1174 /* See if we've already been here */
1175 if (( lc = find_connection( ld, srv, 1 )) != NULL ) {
1178 int len = srv->lud_dn ? strlen( srv->lud_dn ) : 0;
1179 for ( lp = lr; lp; lp = lp->lr_parent ) {
1180 if ( lp->lr_conn == lc
1181 && len == lp->lr_dn.bv_len )
1183 if ( len && strncmp( srv->lud_dn, lp->lr_dn.bv_val, len ) )
1190 ldap_free_urllist(srv);
1191 ld->ld_errno = LDAP_CLIENT_LOOP;
1197 LDAP_NEXT_MSGID( ld, id );
1198 ber = re_encode_request( ld, origreq->lr_ber,
1199 id, sref, srv, &rinfo.ri_request );
1201 if ( ber == NULL ) {
1205 /* copy the complete referral for rebind process */
1206 rinfo.ri_url = LDAP_STRDUP( ref );
1208 rinfo.ri_msgid = origreq->lr_origid;
1210 #ifdef LDAP_R_COMPILE
1211 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1213 rc = ldap_send_server_request( ld, ber, id,
1214 lr, &srv, NULL, &rinfo );
1215 #ifdef LDAP_R_COMPILE
1216 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
1219 LDAP_FREE( rinfo.ri_url );
1224 Debug( LDAP_DEBUG_ANY,
1225 "Unable to chase referral \"%s\" (%d: %s)\n",
1226 ref, ld->ld_errno, ldap_err2string( ld->ld_errno ) );
1227 rc = ldap_append_referral( ld, &unfollowed, ref );
1230 ldap_free_urllist(srv);
1233 LDAP_FREE( *errstrp );
1234 *errstrp = unfollowed;
1236 return(( rc == 0 ) ? count : rc );
1241 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
1245 if ( *referralsp == NULL ) {
1247 *referralsp = (char *)LDAP_MALLOC( strlen( s ) + LDAP_REF_STR_LEN
1251 *referralsp = (char *)LDAP_REALLOC( *referralsp,
1252 strlen( *referralsp ) + strlen( s ) + 2 );
1255 if ( *referralsp == NULL ) {
1256 ld->ld_errno = LDAP_NO_MEMORY;
1261 strcpy( *referralsp, LDAP_REF_STR );
1263 strcat( *referralsp, "\n" );
1265 strcat( *referralsp, s );
1273 re_encode_request( LDAP *ld,
1274 BerElement *origber,
1281 * XXX this routine knows way too much about how the lber library works!
1289 BerElement tmpber, *ber;
1292 Debug( LDAP_DEBUG_TRACE,
1293 "re_encode_request: new msgid %ld, new dn <%s>\n",
1295 ( srv == NULL || srv->lud_dn == NULL) ? "NONE" : srv->lud_dn, 0 );
1300 * all LDAP requests are sequences that start with a message id.
1301 * For all except delete, this is followed by a sequence that is
1302 * tagged with the operation code. For delete, the provided DN
1303 * is not wrapped by a sequence.
1305 rtag = ber_scanf( &tmpber, "{it", /*}*/ &along, &tag );
1307 if ( rtag == LBER_ERROR ) {
1308 ld->ld_errno = LDAP_DECODING_ERROR;
1313 if ( tag == LDAP_REQ_BIND ) {
1314 /* bind requests have a version number before the DN & other stuff */
1315 rtag = ber_scanf( &tmpber, "{im" /*}*/, &ver, &dn );
1317 } else if ( tag == LDAP_REQ_DELETE ) {
1318 /* delete requests don't have a DN wrapping sequence */
1319 rtag = ber_scanf( &tmpber, "m", &dn );
1321 } else if ( tag == LDAP_REQ_SEARCH ) {
1322 /* search requests need to be re-scope-ed */
1323 rtag = ber_scanf( &tmpber, "{me" /*"}"*/, &dn, &scope );
1325 if( srv->lud_scope != LDAP_SCOPE_DEFAULT ) {
1326 /* use the scope provided in reference */
1327 scope = srv->lud_scope;
1329 } else if ( sref ) {
1330 /* use scope implied by previous operation
1333 * subtree -> subtree
1334 * subordinate -> subtree
1338 case LDAP_SCOPE_BASE:
1339 case LDAP_SCOPE_ONELEVEL:
1340 scope = LDAP_SCOPE_BASE;
1342 case LDAP_SCOPE_SUBTREE:
1343 case LDAP_SCOPE_SUBORDINATE:
1344 scope = LDAP_SCOPE_SUBTREE;
1350 rtag = ber_scanf( &tmpber, "{m" /*}*/, &dn );
1353 if( rtag == LBER_ERROR ) {
1354 ld->ld_errno = LDAP_DECODING_ERROR;
1358 /* restore character zero'd out by ber_scanf*/
1359 dn.bv_val[dn.bv_len] = tmpber.ber_tag;
1361 if (( ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
1365 if ( srv->lud_dn ) {
1366 ber_str2bv( srv->lud_dn, 0, 0, &dn );
1369 if ( tag == LDAP_REQ_BIND ) {
1370 rc = ber_printf( ber, "{it{iO" /*}}*/, msgid, tag, ver, &dn );
1371 } else if ( tag == LDAP_REQ_DELETE ) {
1372 rc = ber_printf( ber, "{itON}", msgid, tag, &dn );
1373 } else if ( tag == LDAP_REQ_SEARCH ) {
1374 rc = ber_printf( ber, "{it{Oe" /*}}*/, msgid, tag, &dn, scope );
1376 rc = ber_printf( ber, "{it{O" /*}}*/, msgid, tag, &dn );
1380 ld->ld_errno = LDAP_ENCODING_ERROR;
1385 if ( tag != LDAP_REQ_DELETE && (
1386 ber_write(ber, tmpber.ber_ptr, ( tmpber.ber_end - tmpber.ber_ptr ), 0)
1387 != ( tmpber.ber_end - tmpber.ber_ptr ) ||
1388 ber_printf( ber, /*{{*/ "N}N}" ) == -1 ) )
1390 ld->ld_errno = LDAP_ENCODING_ERROR;
1396 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
1397 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
1399 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ber, 0 );
1401 #endif /* LDAP_DEBUG */
1403 *type = tag; /* return request type */
1409 ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid )
1413 #ifdef LDAP_R_COMPILE
1414 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
1416 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
1417 if ( lr->lr_status == LDAP_REQST_COMPLETED ) {
1418 continue; /* Skip completed requests */
1420 if ( msgid == lr->lr_msgid ) {
1424 #ifdef LDAP_R_COMPILE
1425 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );