3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1995 Regents of the University of Michigan.
10 * request.c - sending of ldap requests; handling of referrals
17 #include <ac/stdlib.h>
20 #include <ac/socket.h>
21 #include <ac/string.h>
23 #include <ac/unistd.h>
28 static LDAPConn *find_connection LDAP_P(( LDAP *ld, LDAPURLDesc *srv, int any ));
29 static void use_connection LDAP_P(( LDAP *ld, LDAPConn *lc ));
31 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
32 static LDAPURLDesc *dn2servers LDAP_P(( LDAP *ld, const char *dn ));
33 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
35 static BerElement *re_encode_request LDAP_P((
43 ldap_alloc_ber_with_options( LDAP *ld )
47 if (( ber = ber_alloc_t( ld->ld_lberoptions )) == NULL ) {
48 ld->ld_errno = LDAP_NO_MEMORY;
49 #ifdef STR_TRANSLATION
51 ldap_set_ber_options( ld, ber );
52 #endif /* STR_TRANSLATION */
60 ldap_set_ber_options( LDAP *ld, BerElement *ber )
62 ber->ber_options = ld->ld_lberoptions;
63 #ifdef STR_TRANSLATION
64 if (( ld->ld_lberoptions & LBER_TRANSLATE_STRINGS ) != 0 ) {
65 ber_set_string_translators( ber,
66 ld->ld_lber_encode_translate_proc,
67 ld->ld_lber_decode_translate_proc );
69 #endif /* STR_TRANSLATION */
74 ldap_send_initial_request(
83 Debug( LDAP_DEBUG_TRACE, "ldap_send_initial_request\n", 0, 0, 0 );
85 if ( ! ber_pvt_sb_in_use(&ld->ld_sb ) ) {
86 /* not connected yet */
87 int rc = ldap_open_defconn( ld );
94 Debug( LDAP_DEBUG_TRACE,
95 "ldap_delayed_open successful, ld_host is %s\n",
96 ( ld->ld_host == NULL ) ? "(null)" : ld->ld_host, 0, 0 );
99 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
100 if ( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_DNS )
101 && ldap_is_dns_dn( dn ) )
103 if (( servers = dn2servers( ld, dn )) == NULL ) {
109 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
114 srv = srv->lud_next )
117 "LDAP server %s: dn %s, port %d\n",
118 srv->lud_host, ( srv->lud_dn == NULL ) ?
119 "(default)" : srv->lud_dn,
123 #endif /* LDAP_DEBUG */
125 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
128 * use of DNS is turned off or this is an X.500 DN...
129 * use our default connection
134 rc = ldap_send_server_request( ld, ber, ld->ld_msgid, NULL,
137 ldap_free_urllist(servers);
144 ldap_send_server_request(
148 LDAPRequest *parentreq,
149 LDAPURLDesc *srvlist,
156 Debug( LDAP_DEBUG_TRACE, "ldap_send_server_request\n", 0, 0, 0 );
159 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
162 if ( srvlist == NULL ) {
165 if (( lc = find_connection( ld, srvlist, 1 )) ==
167 if ( bind && (parentreq != NULL) ) {
168 /* Remember the bind in the parent */
170 ++parentreq->lr_outrefcnt;
172 lc = ldap_new_connection( ld, srvlist, 0, 1, bind );
177 if ( lc == NULL || lc->lconn_status != LDAP_CONNST_CONNECTED ) {
179 if ( ld->ld_errno == LDAP_SUCCESS ) {
180 ld->ld_errno = LDAP_SERVER_DOWN;
183 /* Forget about the bind */
184 --parentreq->lr_outrefcnt;
189 use_connection( ld, lc );
190 if (( lr = (LDAPRequest *)LDAP_CALLOC( 1, sizeof( LDAPRequest ))) ==
192 ld->ld_errno = LDAP_NO_MEMORY;
193 ldap_free_connection( ld, lc, 0, 0 );
196 /* Forget about the bind */
197 --parentreq->lr_outrefcnt;
201 lr->lr_msgid = msgid;
202 lr->lr_status = LDAP_REQST_INPROGRESS;
203 lr->lr_res_errno = LDAP_SUCCESS; /* optimistic */
206 if ( parentreq != NULL ) { /* sub-request */
208 /* Increment if we didn't do it before the bind */
209 ++parentreq->lr_outrefcnt;
211 lr->lr_origid = parentreq->lr_origid;
212 lr->lr_parentcnt = parentreq->lr_parentcnt + 1;
213 lr->lr_parent = parentreq;
214 lr->lr_refnext = parentreq->lr_refnext;
215 parentreq->lr_refnext = lr;
216 } else { /* original request */
217 lr->lr_origid = lr->lr_msgid;
220 if (( lr->lr_next = ld->ld_requests ) != NULL ) {
221 lr->lr_next->lr_prev = lr;
223 ld->ld_requests = lr;
226 if ( ber_flush( lc->lconn_sb, ber, 0 ) != 0 ) {
228 if ( errno == EWOULDBLOCK ) {
229 /* need to continue write later */
230 lr->lr_status = LDAP_REQST_WRITING;
231 ldap_mark_select_write( ld, lc->lconn_sb );
234 ld->ld_errno = LDAP_SERVER_DOWN;
235 ldap_free_request( ld, lr );
236 ldap_free_connection( ld, lc, 0, 0 );
243 if ( parentreq == NULL ) {
244 ber->ber_end = ber->ber_ptr;
245 ber->ber_ptr = ber->ber_buf;
248 /* sent -- waiting for a response */
249 ldap_mark_select_read( ld, lc->lconn_sb );
252 ld->ld_errno = LDAP_SUCCESS;
257 ldap_new_connection( LDAP *ld, LDAPURLDesc *srvlist, int use_ldsb,
258 int connect, int bind )
265 * make a new LDAP server connection
266 * XXX open connection synchronously for now
268 if (( lc = (LDAPConn *)LDAP_CALLOC( 1, sizeof( LDAPConn ))) == NULL ||
269 ( !use_ldsb && ( (sb = ber_sockbuf_alloc()) == NULL ))) {
271 LDAP_FREE( (char *)lc );
273 ld->ld_errno = LDAP_NO_MEMORY;
277 lc->lconn_sb = ( use_ldsb ) ? &ld->ld_sb : sb;
280 for ( srv = srvlist; srv != NULL; srv = srv->lud_next ) {
281 if ( open_ldap_connection( ld, lc->lconn_sb,
282 srv, &lc->lconn_krbinstance, 0 ) != -1 )
290 ber_sockbuf_free( lc->lconn_sb );
292 LDAP_FREE( (char *)lc );
293 ld->ld_errno = LDAP_SERVER_DOWN;
297 lc->lconn_server = ldap_url_dup(srv);
300 lc->lconn_status = LDAP_CONNST_CONNECTED;
301 lc->lconn_next = ld->ld_conns;
305 * XXX for now, we always do a synchronous bind. This will have
306 * to change in the long run...
309 int err, freepasswd, authmethod;
310 char *binddn, *passwd;
311 LDAPConn *savedefconn;
313 freepasswd = err = 0;
315 if ( ld->ld_rebindproc == 0 ) {
316 binddn = passwd = "";
317 authmethod = LDAP_AUTH_SIMPLE;
319 if (( err = (*ld->ld_rebindproc)( ld, &binddn, &passwd,
320 &authmethod, 0 )) == LDAP_SUCCESS ) {
330 savedefconn = ld->ld_defconn;
332 ++lc->lconn_refcnt; /* avoid premature free */
334 if ( ldap_bind_s( ld, binddn, passwd, authmethod ) !=
339 ld->ld_defconn = savedefconn;
343 (*ld->ld_rebindproc)( ld, &binddn, &passwd,
348 ldap_free_connection( ld, lc, 1, 0 );
358 find_connection( LDAP *ld, LDAPURLDesc *srv, int any )
360 * return an existing connection (if any) to the server srv
361 * if "any" is non-zero, check for any server in the "srv" chain
367 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
368 for ( ls = srv; ls != NULL; ls = ls->lud_next ) {
369 if ( lc->lconn_server->lud_host != NULL &&
370 ls->lud_host != NULL && strcasecmp(
371 ls->lud_host, lc->lconn_server->lud_host ) == 0
372 && ls->lud_port == lc->lconn_server->lud_port ) {
387 use_connection( LDAP *ld, LDAPConn *lc )
390 lc->lconn_lastused = time( NULL );
395 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
397 LDAPConn *tmplc, *prevlc;
399 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection\n", 0, 0, 0 );
401 if ( force || --lc->lconn_refcnt <= 0 ) {
402 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
403 ldap_mark_select_clear( ld, lc->lconn_sb );
405 ldap_send_unbind( ld, lc->lconn_sb, NULL, NULL );
410 ldap_close_connection( lc->lconn_sb );
411 ber_pvt_sb_destroy( lc->lconn_sb );
413 if( lc->lconn_ber != NULL ) {
414 ber_free( lc->lconn_ber, 1 );
418 for ( tmplc = ld->ld_conns; tmplc != NULL;
419 tmplc = tmplc->lconn_next ) {
421 if ( prevlc == NULL ) {
422 ld->ld_conns = tmplc->lconn_next;
424 prevlc->lconn_next = tmplc->lconn_next;
430 ldap_free_urllist( lc->lconn_server );
431 if ( lc->lconn_krbinstance != NULL ) {
432 LDAP_FREE( lc->lconn_krbinstance );
434 if ( lc->lconn_sb != &ld->ld_sb ) {
435 ber_sockbuf_free( lc->lconn_sb );
438 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: actually freed\n",
441 lc->lconn_lastused = time( NULL );
442 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
443 lc->lconn_refcnt, 0, 0 );
450 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
455 fprintf( stderr, "** Connection%s:\n", all ? "s" : "" );
456 for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
457 if ( lc->lconn_server != NULL ) {
458 fprintf( stderr, "* host: %s port: %d%s\n",
459 ( lc->lconn_server->lud_host == NULL ) ? "(null)"
460 : lc->lconn_server->lud_host,
461 lc->lconn_server->lud_port, ( lc->lconn_sb ==
462 &ld->ld_sb ) ? " (default)" : "" );
464 fprintf( stderr, " refcnt: %d status: %s\n", lc->lconn_refcnt,
465 ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET ) ?
466 "NeedSocket" : ( lc->lconn_status ==
467 LDAP_CONNST_CONNECTING ) ? "Connecting" : "Connected" );
468 fprintf( stderr, " last used: %s\n",
469 ldap_pvt_ctime( &lc->lconn_lastused, timebuf ));
478 ldap_dump_requests_and_responses( LDAP *ld )
483 fprintf( stderr, "** Outstanding Requests:\n" );
484 if (( lr = ld->ld_requests ) == NULL ) {
485 fprintf( stderr, " Empty\n" );
487 for ( ; lr != NULL; lr = lr->lr_next ) {
488 fprintf( stderr, " * msgid %d, origid %d, status %s\n",
489 lr->lr_msgid, lr->lr_origid, ( lr->lr_status ==
490 LDAP_REQST_INPROGRESS ) ? "InProgress" :
491 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
492 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
494 fprintf( stderr, " outstanding referrals %d, parent count %d\n",
495 lr->lr_outrefcnt, lr->lr_parentcnt );
498 fprintf( stderr, "** Response Queue:\n" );
499 if (( lm = ld->ld_responses ) == NULL ) {
500 fprintf( stderr, " Empty\n" );
502 for ( ; lm != NULL; lm = lm->lm_next ) {
503 fprintf( stderr, " * msgid %d, type %lu\n",
504 lm->lm_msgid, (unsigned long) lm->lm_msgtype );
505 if (( l = lm->lm_chain ) != NULL ) {
506 fprintf( stderr, " chained responses:\n" );
507 for ( ; l != NULL; l = l->lm_chain ) {
509 " * msgid %d, type %lu\n",
511 (unsigned long) l->lm_msgtype );
516 #endif /* LDAP_DEBUG */
520 ldap_free_request( LDAP *ld, LDAPRequest *lr )
522 LDAPRequest *tmplr, *nextlr;
524 Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
525 lr->lr_origid, lr->lr_msgid, 0 );
527 if ( lr->lr_parent != NULL ) {
528 --lr->lr_parent->lr_outrefcnt;
530 /* free all referrals (child requests) */
531 for ( tmplr = lr->lr_refnext; tmplr != NULL; tmplr = nextlr ) {
532 nextlr = tmplr->lr_refnext;
533 ldap_free_request( ld, tmplr );
537 if ( lr->lr_prev == NULL ) {
538 ld->ld_requests = lr->lr_next;
540 lr->lr_prev->lr_next = lr->lr_next;
543 if ( lr->lr_next != NULL ) {
544 lr->lr_next->lr_prev = lr->lr_prev;
547 if ( lr->lr_ber != NULL ) {
548 ber_free( lr->lr_ber, 1 );
551 if ( lr->lr_res_error != NULL ) {
552 LDAP_FREE( lr->lr_res_error );
555 if ( lr->lr_res_matched != NULL ) {
556 LDAP_FREE( lr->lr_res_matched );
564 * XXX merging of errors in this routine needs to be improved
567 ldap_chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp )
569 int rc, count, len, newdn;
570 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
572 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
573 char *p, *ports, *ref, *tmpref, *refdn, *unfollowed;
574 LDAPRequest *origreq;
578 Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
580 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
583 if ( *errstrp == NULL ) {
587 len = strlen( *errstrp );
588 for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
589 if (( *p == 'R' || *p == 'r' ) && strncasecmp( p,
590 LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
592 p += LDAP_REF_STR_LEN;
597 if ( len < LDAP_REF_STR_LEN ) {
601 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
602 Debug( LDAP_DEBUG_ANY,
603 "more than %d referral hops (dropping)\n",
604 ld->ld_refhoplimit, 0, 0 );
605 /* XXX report as error in ld->ld_errno? */
609 /* find original request */
610 for ( origreq = lr; origreq->lr_parent != NULL;
611 origreq = origreq->lr_parent ) {
618 /* parse out & follow referrals */
619 for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
620 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
622 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
624 if (( p = strchr( ref, '\n' )) != NULL ) {
631 if ( len > LDAP_LDAP_REF_STR_LEN && strncasecmp( ref,
632 LDAP_LDAP_REF_STR, LDAP_LDAP_REF_STR_LEN ) == 0 ) {
633 Debug( LDAP_DEBUG_TRACE,
634 "chasing LDAP referral: <%s>\n", ref, 0, 0 );
635 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
637 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
638 tmpref = ref + LDAP_LDAP_REF_STR_LEN;
639 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
640 } else if ( len > LDAP_DX_REF_STR_LEN && strncasecmp( ref,
641 LDAP_DX_REF_STR, LDAP_DX_REF_STR_LEN ) == 0 ) {
642 Debug( LDAP_DEBUG_TRACE,
643 "chasing DX referral: <%s>\n", ref, 0, 0 );
644 tmpref = ref + LDAP_DX_REF_STR_LEN;
645 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
647 Debug( LDAP_DEBUG_TRACE,
648 "ignoring unknown referral <%s>\n", ref, 0, 0 );
649 rc = ldap_append_referral( ld, &unfollowed, ref );
654 /* NOTE! This code treats "ldap://host/" differently
655 * from "ldap://host". The behavior is wrong, but is
656 * left here intentionally to maintain compatibility
657 * with OpenLDAP 1.x and UMich 3.3 clients.
660 if (( refdn = strchr( tmpref, '/' )) != NULL ) {
667 if (( ber = re_encode_request( ld, origreq->lr_ber,
668 ++ld->ld_msgid, &refdn )) == NULL ) {
672 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
674 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
675 if (( srv = (LDAPURLDesc *)LDAP_CALLOC( 1,
676 sizeof( LDAPURLDesc ))) == NULL ) {
678 ld->ld_errno = LDAP_NO_MEMORY;
682 if (( srv->lud_host = LDAP_STRDUP( tmpref )) == NULL ) {
683 LDAP_FREE( (char *)srv );
685 ld->ld_errno = LDAP_NO_MEMORY;
689 if (( ports = strchr( srv->lud_host, ':' )) != NULL ) {
691 srv->lud_port = atoi( ports );
693 srv->lud_port = ldap_int_global_options.ldo_defport;
695 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
697 srv = dn2servers( ld, tmpref );
699 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */
701 if ( srv != NULL && ldap_send_server_request( ld, ber, ld->ld_msgid,
702 lr, srv, NULL, 1 ) >= 0 ) {
705 Debug( LDAP_DEBUG_ANY,
706 "Unable to chase referral (%s)\n",
707 ldap_err2string( ld->ld_errno ), 0, 0 );
708 rc = ldap_append_referral( ld, &unfollowed, ref );
712 ldap_free_urllist(srv);
714 if ( !newdn && refdn != NULL ) {
719 LDAP_FREE( *errstrp );
720 *errstrp = unfollowed;
722 return(( rc == 0 ) ? count : rc );
727 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
731 if ( *referralsp == NULL ) {
733 *referralsp = (char *)LDAP_MALLOC( strlen( s ) + LDAP_REF_STR_LEN
737 *referralsp = (char *)LDAP_REALLOC( *referralsp,
738 strlen( *referralsp ) + strlen( s ) + 2 );
741 if ( *referralsp == NULL ) {
742 ld->ld_errno = LDAP_NO_MEMORY;
747 strcpy( *referralsp, LDAP_REF_STR );
749 strcat( *referralsp, "\n" );
751 strcat( *referralsp, s );
759 re_encode_request( LDAP *ld, BerElement *origber, ber_int_t msgid, char **dnp )
762 * XXX this routine knows way too much about how the lber library works!
769 BerElement tmpber, *ber;
772 Debug( LDAP_DEBUG_TRACE,
773 "re_encode_request: new msgid %ld, new dn <%s>\n",
774 (long) msgid, ( *dnp == NULL ) ? "NONE" : *dnp, 0 );
779 * all LDAP requests are sequences that start with a message id,
780 * followed by a sequence that is tagged with the operation code
782 if ( ber_scanf( &tmpber, "{i", /*}*/ &along ) != LDAP_TAG_MSGID ||
783 ( tag = ber_skip_tag( &tmpber, &len )) == LBER_DEFAULT ) {
784 ld->ld_errno = LDAP_DECODING_ERROR;
788 if (( ber = ldap_alloc_ber_with_options( ld )) == NULL ) {
792 /* bind requests have a version number before the DN & other stuff */
793 if ( tag == LDAP_REQ_BIND && ber_get_int( &tmpber, &ver ) ==
795 ld->ld_errno = LDAP_DECODING_ERROR;
800 /* the rest of the request is the DN followed by other stuff */
801 if ( ber_get_stringa( &tmpber, &orig_dn ) == LBER_DEFAULT ) {
806 if ( *dnp == NULL ) {
809 LDAP_FREE( orig_dn );
812 if ( tag == LDAP_REQ_BIND ) {
813 rc = ber_printf( ber, "{it{is" /*}}*/, msgid, tag, ver, *dnp );
815 rc = ber_printf( ber, "{it{s" /*}}*/, msgid, tag, *dnp );
823 if ( ber_write( ber, tmpber.ber_ptr, ( tmpber.ber_end -
824 tmpber.ber_ptr ), 0 ) != ( tmpber.ber_end - tmpber.ber_ptr ) ||
825 ber_printf( ber, /*{{*/ "}}" ) == -1 ) {
826 ld->ld_errno = LDAP_ENCODING_ERROR;
832 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
833 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
835 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ber, 0 );
837 #endif /* LDAP_DEBUG */
844 ldap_find_request_by_msgid( LDAP *ld, ber_int_t msgid )
848 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
849 if ( msgid == lr->lr_msgid ) {
858 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_DNS
860 dn2servers( LDAP *ld, const char *dn ) /* dn can also be a domain.... */
862 char *p, *host, *server_dn, **dxs;
865 LDAPURLDesc *srvlist, *prevsrv, *srv;
867 if (( domain = strrchr( dn, '@' )) != NULL ) {
873 if (( dxs = ldap_getdxbyname( domain )) == NULL ) {
874 ld->ld_errno = LDAP_NO_MEMORY;
879 for ( i = 0; dxs[ i ] != NULL; ++i ) {
880 if (ldap_url_parselist(&srv, dxs[i]) == LDAP_SUCCESS
881 || ldap_url_parsehosts(&srv, dxs[i]) == LDAP_SUCCESS)
883 /* add to end of list of servers */
884 if ( srvlist == NULL ) {
887 prevsrv->lud_next = srv;
893 ldap_value_free( dxs );
895 if ( srvlist == NULL ) {
896 ld->ld_errno = LDAP_SERVER_DOWN;
901 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_DNS */