2 * Copyright (c) 1995 Regents of the University of Michigan.
5 * request.c - sending of ldap requests; handling of referrals
9 static char copyright[] = "@(#) Copyright (c) 1995 Regents of the University of Michigan.\nAll rights reserved.\n";
19 #if defined( DOS ) || defined( _WIN32 )
33 #include <sys/types.h>
34 #include <sys/socket.h>
37 #include <sys/select.h>
43 #include "ucx_select.h"
51 #endif /* USE_SYSCONF */
54 #if defined( LDAP_REFERRALS ) || defined( LDAP_DNS )
56 static LDAPConn *find_connection( LDAP *ld, LDAPServer *srv, int any );
57 static void use_connection( LDAP *ld, LDAPConn *lc );
58 static void free_servers( LDAPServer *srvlist );
59 #else /* NEEDPROTOS */
60 static LDAPConn *find_connection();
61 static void use_connection();
62 static void free_servers();
63 #endif /* NEEDPROTOS */
64 #endif /* LDAP_REFERRALS || LDAP_DNS */
69 static LDAPServer *dn2servers( LDAP *ld, char *dn );
70 #else /* NEEDPROTOS */
71 static LDAPServer *dn2servers();
72 #endif /* NEEDPROTOS */
77 static BerElement *re_encode_request( LDAP *ld, BerElement *origber,
78 int msgid, char **dnp );
79 #else /* NEEDPROTOS */
80 static BerElement *re_encode_request();
81 #endif /* NEEDPROTOS */
82 #endif /* LDAP_REFERRALS */
86 alloc_ber_with_options( LDAP *ld )
90 if (( ber = ber_alloc_t( ld->ld_lberoptions )) == NULLBER ) {
91 ld->ld_errno = LDAP_NO_MEMORY;
92 #ifdef STR_TRANSLATION
94 set_ber_options( ld, ber );
95 #endif /* STR_TRANSLATION */
103 set_ber_options( LDAP *ld, BerElement *ber )
105 ber->ber_options = ld->ld_lberoptions;
106 #ifdef STR_TRANSLATION
107 if (( ld->ld_lberoptions & LBER_TRANSLATE_STRINGS ) != 0 ) {
108 ber_set_string_translators( ber,
109 ld->ld_lber_encode_translate_proc,
110 ld->ld_lber_decode_translate_proc );
112 #endif /* STR_TRANSLATION */
117 send_initial_request( LDAP *ld, unsigned long msgtype, char *dn,
120 #if defined( LDAP_REFERRALS ) || defined( LDAP_DNS )
122 #endif /* LDAP_REFERRALS || LDAP_DNS */
124 Debug( LDAP_DEBUG_TRACE, "send_initial_request\n", 0, 0, 0 );
126 #if !defined( LDAP_REFERRALS ) && !defined( LDAP_DNS )
127 if ( ber_flush( &ld->ld_sb, ber, 1 ) != 0 ) {
128 ld->ld_errno = LDAP_SERVER_DOWN;
132 ld->ld_errno = LDAP_SUCCESS;
133 return( ld->ld_msgid );
134 #else /* !LDAP_REFERRALS && !LDAP_DNS */
137 if (( ld->ld_options & LDAP_OPT_DNS ) != 0 && ldap_is_dns_dn( dn )) {
138 if (( servers = dn2servers( ld, dn )) == NULL ) {
144 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
147 for ( srv = servers; srv != NULL;
148 srv = srv->lsrv_next ) {
150 "LDAP server %s: dn %s, port %d\n",
151 srv->lsrv_host, ( srv->lsrv_dn == NULL ) ?
152 "(default)" : srv->lsrv_dn,
156 #endif /* LDAP_DEBUG */
158 #endif /* LDAP_DNS */
160 * use of DNS is turned off or this is an X.500 DN...
161 * use our default connection
166 #endif /* LDAP_DNS */
168 return( send_server_request( ld, ber, ld->ld_msgid, NULL, servers,
170 #endif /* !LDAP_REFERRALS && !LDAP_DNS */
175 #if defined( LDAP_REFERRALS ) || defined( LDAP_DNS )
177 send_server_request( LDAP *ld, BerElement *ber, int msgid, LDAPRequest
178 *parentreq, LDAPServer *srvlist, LDAPConn *lc, int bind )
182 Debug( LDAP_DEBUG_TRACE, "send_server_request\n", 0, 0, 0 );
184 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
187 if ( srvlist == NULL ) {
190 if (( lc = find_connection( ld, srvlist, 1 )) ==
192 lc = new_connection( ld, &srvlist, 0, 1, bind );
194 free_servers( srvlist );
198 if ( lc == NULL || lc->lconn_status != LDAP_CONNST_CONNECTED ) {
200 if ( ld->ld_errno == LDAP_SUCCESS ) {
201 ld->ld_errno = LDAP_SERVER_DOWN;
206 use_connection( ld, lc );
207 if (( lr = (LDAPRequest *)calloc( 1, sizeof( LDAPRequest ))) ==
209 ld->ld_errno = LDAP_NO_MEMORY;
210 free_connection( ld, lc, 0, 0 );
214 lr->lr_msgid = msgid;
215 lr->lr_status = LDAP_REQST_INPROGRESS;
216 lr->lr_res_errno = LDAP_SUCCESS; /* optimistic */
219 if ( parentreq != NULL ) { /* sub-request */
220 ++parentreq->lr_outrefcnt;
221 lr->lr_origid = parentreq->lr_origid;
222 lr->lr_parentcnt = parentreq->lr_parentcnt + 1;
223 lr->lr_parent = parentreq;
224 lr->lr_refnext = parentreq->lr_refnext;
225 parentreq->lr_refnext = lr;
226 } else { /* original request */
227 lr->lr_origid = lr->lr_msgid;
230 if (( lr->lr_next = ld->ld_requests ) != NULL ) {
231 lr->lr_next->lr_prev = lr;
233 ld->ld_requests = lr;
236 if ( ber_flush( lc->lconn_sb, ber, 0 ) != 0 ) {
240 if ( errno == EWOULDBLOCK ) {
241 /* need to continue write later */
242 lr->lr_status = LDAP_REQST_WRITING;
243 mark_select_write( ld, lc->lconn_sb );
246 ld->ld_errno = LDAP_SERVER_DOWN;
247 free_request( ld, lr );
248 free_connection( ld, lc, 0, 0 );
255 if ( parentreq == NULL ) {
256 ber->ber_end = ber->ber_ptr;
257 ber->ber_ptr = ber->ber_buf;
260 /* sent -- waiting for a response */
261 mark_select_read( ld, lc->lconn_sb );
264 ld->ld_errno = LDAP_SUCCESS;
270 new_connection( LDAP *ld, LDAPServer **srvlistp, int use_ldsb,
271 int connect, int bind )
274 LDAPServer *prevsrv, *srv;
278 * make a new LDAP server connection
279 * XXX open connection synchronously for now
281 if (( lc = (LDAPConn *)calloc( 1, sizeof( LDAPConn ))) == NULL ||
282 ( !use_ldsb && ( sb = (Sockbuf *)calloc( 1, sizeof( Sockbuf )))
287 ld->ld_errno = LDAP_NO_MEMORY;
291 lc->lconn_sb = ( use_ldsb ) ? &ld->ld_sb : sb;
296 for ( srv = *srvlistp; srv != NULL; srv = srv->lsrv_next ) {
297 if ( open_ldap_connection( ld, lc->lconn_sb,
298 srv->lsrv_host, srv->lsrv_port,
299 &lc->lconn_krbinstance, 0 ) != -1 ) {
307 free( (char *)lc->lconn_sb );
310 ld->ld_errno = LDAP_SERVER_DOWN;
314 if ( prevsrv == NULL ) {
315 *srvlistp = srv->lsrv_next;
317 prevsrv->lsrv_next = srv->lsrv_next;
319 lc->lconn_server = srv;
322 lc->lconn_status = LDAP_CONNST_CONNECTED;
323 lc->lconn_next = ld->ld_conns;
327 * XXX for now, we always do a synchronous bind. This will have
328 * to change in the long run...
331 int err, freepasswd, authmethod;
332 char *binddn, *passwd;
333 LDAPConn *savedefconn;
335 freepasswd = err = 0;
337 if ( ld->ld_rebindproc == NULL ) {
338 binddn = passwd = "";
339 authmethod = LDAP_AUTH_SIMPLE;
341 if (( err = (*ld->ld_rebindproc)( ld, &binddn, &passwd,
342 &authmethod, 0 )) == LDAP_SUCCESS ) {
352 savedefconn = ld->ld_defconn;
354 ++lc->lconn_refcnt; /* avoid premature free */
356 if ( ldap_bind_s( ld, binddn, passwd, authmethod ) !=
361 ld->ld_defconn = savedefconn;
365 (*ld->ld_rebindproc)( ld, &binddn, &passwd,
370 free_connection( ld, lc, 1, 0 );
380 find_connection( LDAP *ld, LDAPServer *srv, int any )
382 * return an existing connection (if any) to the server srv
383 * if "any" is non-zero, check for any server in the "srv" chain
389 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
390 for ( ls = srv; ls != NULL; ls = ls->lsrv_next ) {
391 if ( lc->lconn_server->lsrv_host != NULL &&
392 ls->lsrv_host != NULL && strcasecmp(
393 ls->lsrv_host, lc->lconn_server->lsrv_host ) == 0
394 && ls->lsrv_port == lc->lconn_server->lsrv_port ) {
409 use_connection( LDAP *ld, LDAPConn *lc )
412 lc->lconn_lastused = time( 0 );
417 free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
419 LDAPConn *tmplc, *prevlc;
421 Debug( LDAP_DEBUG_TRACE, "free_connection\n", 0, 0, 0 );
423 if ( force || --lc->lconn_refcnt <= 0 ) {
424 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
425 mark_select_clear( ld, lc->lconn_sb );
427 send_unbind( ld, lc->lconn_sb );
429 close_connection( lc->lconn_sb );
430 if ( lc->lconn_sb->sb_ber.ber_buf != NULL ) {
431 free( lc->lconn_sb->sb_ber.ber_buf );
435 for ( tmplc = ld->ld_conns; tmplc != NULL;
436 tmplc = tmplc->lconn_next ) {
438 if ( prevlc == NULL ) {
439 ld->ld_conns = tmplc->lconn_next;
441 prevlc->lconn_next = tmplc->lconn_next;
446 free_servers( lc->lconn_server );
447 if ( lc->lconn_krbinstance != NULL ) {
448 free( lc->lconn_krbinstance );
450 if ( lc->lconn_sb != &ld->ld_sb ) {
451 free( (char *)lc->lconn_sb );
454 Debug( LDAP_DEBUG_TRACE, "free_connection: actually freed\n",
457 lc->lconn_lastused = time( 0 );
458 Debug( LDAP_DEBUG_TRACE, "free_connection: refcnt %d\n",
459 lc->lconn_refcnt, 0, 0 );
466 dump_connection( LDAP *ld, LDAPConn *lconns, int all )
470 fprintf( stderr, "** Connection%s:\n", all ? "s" : "" );
471 for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
472 if ( lc->lconn_server != NULL ) {
473 fprintf( stderr, "* host: %s port: %d%s\n",
474 ( lc->lconn_server->lsrv_host == NULL ) ? "(null)"
475 : lc->lconn_server->lsrv_host,
476 lc->lconn_server->lsrv_port, ( lc->lconn_sb ==
477 &ld->ld_sb ) ? " (default)" : "" );
479 fprintf( stderr, " refcnt: %d status: %s\n", lc->lconn_refcnt,
480 ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET ) ?
481 "NeedSocket" : ( lc->lconn_status ==
482 LDAP_CONNST_CONNECTING ) ? "Connecting" : "Connected" );
483 fprintf( stderr, " last used: %s\n",
484 ctime( &lc->lconn_lastused ));
493 dump_requests_and_responses( LDAP *ld )
498 fprintf( stderr, "** Outstanding Requests:\n" );
499 if (( lr = ld->ld_requests ) == NULL ) {
500 fprintf( stderr, " Empty\n" );
502 for ( ; lr != NULL; lr = lr->lr_next ) {
503 fprintf( stderr, " * msgid %d, origid %d, status %s\n",
504 lr->lr_msgid, lr->lr_origid, ( lr->lr_status ==
505 LDAP_REQST_INPROGRESS ) ? "InProgress" :
506 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
507 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
509 fprintf( stderr, " outstanding referrals %d, parent count %d\n",
510 lr->lr_outrefcnt, lr->lr_parentcnt );
513 fprintf( stderr, "** Response Queue:\n" );
514 if (( lm = ld->ld_responses ) == NULLMSG ) {
515 fprintf( stderr, " Empty\n" );
517 for ( ; lm != NULLMSG; lm = lm->lm_next ) {
518 fprintf( stderr, " * msgid %d, type %d\n",
519 lm->lm_msgid, lm->lm_msgtype );
520 if (( l = lm->lm_chain ) != NULL ) {
521 fprintf( stderr, " chained responses:\n" );
522 for ( ; l != NULLMSG; l = l->lm_chain ) {
524 " * msgid %d, type %d\n",
525 l->lm_msgid, l->lm_msgtype );
530 #endif /* LDAP_DEBUG */
534 free_request( LDAP *ld, LDAPRequest *lr )
536 LDAPRequest *tmplr, *nextlr;
538 Debug( LDAP_DEBUG_TRACE, "free_request (origid %d, msgid %d)\n",
539 lr->lr_origid, lr->lr_msgid, 0 );
541 if ( lr->lr_parent != NULL ) {
542 --lr->lr_parent->lr_outrefcnt;
544 /* free all referrals (child requests) */
545 for ( tmplr = lr->lr_refnext; tmplr != NULL; tmplr = nextlr ) {
546 nextlr = tmplr->lr_refnext;
547 free_request( ld, tmplr );
551 if ( lr->lr_prev == NULL ) {
552 ld->ld_requests = lr->lr_next;
554 lr->lr_prev->lr_next = lr->lr_next;
557 if ( lr->lr_next != NULL ) {
558 lr->lr_next->lr_prev = lr->lr_prev;
561 if ( lr->lr_ber != NULL ) {
562 ber_free( lr->lr_ber, 1 );
565 if ( lr->lr_res_error != NULL ) {
566 free( lr->lr_res_error );
569 if ( lr->lr_res_matched != NULL ) {
570 free( lr->lr_res_matched );
578 free_servers( LDAPServer *srvlist )
582 while ( srvlist != NULL ) {
583 nextsrv = srvlist->lsrv_next;
584 if ( srvlist->lsrv_dn != NULL ) {
585 free( srvlist->lsrv_dn );
587 if ( srvlist->lsrv_host != NULL ) {
588 free( srvlist->lsrv_host );
594 #endif /* LDAP_REFERRALS || LDAP_DNS */
597 #ifdef LDAP_REFERRALS
599 * XXX merging of errors in this routine needs to be improved
602 chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp )
604 int rc, count, len, newdn;
607 #endif /* LDAP_DNS */
608 char *p, *ports, *ref, *tmpref, *refdn, *unfollowed;
609 LDAPRequest *origreq;
613 Debug( LDAP_DEBUG_TRACE, "chase_referrals\n", 0, 0, 0 );
615 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
618 if ( *errstrp == NULL ) {
622 len = strlen( *errstrp );
623 for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
624 if (( *p == 'R' || *p == 'r' ) && strncasecmp( p,
625 LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
627 p += LDAP_REF_STR_LEN;
632 if ( len < LDAP_REF_STR_LEN ) {
636 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
637 Debug( LDAP_DEBUG_ANY,
638 "more than %d referral hops (dropping)\n",
639 ld->ld_refhoplimit, 0, 0 );
640 /* XXX report as error in ld->ld_errno? */
644 /* find original request */
645 for ( origreq = lr; origreq->lr_parent != NULL;
646 origreq = origreq->lr_parent ) {
653 /* parse out & follow referrals */
654 for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
657 #endif /* LDAP_DNS */
659 if (( p = strchr( ref, '\n' )) != NULL ) {
666 if ( len > LDAP_LDAP_REF_STR_LEN && strncasecmp( ref,
667 LDAP_LDAP_REF_STR, LDAP_LDAP_REF_STR_LEN ) == 0 ) {
668 Debug( LDAP_DEBUG_TRACE,
669 "chasing LDAP referral: <%s>\n", ref, 0, 0 );
672 #endif /* LDAP_DNS */
673 tmpref = ref + LDAP_LDAP_REF_STR_LEN;
675 } else if ( len > LDAP_DX_REF_STR_LEN && strncasecmp( ref,
676 LDAP_DX_REF_STR, LDAP_DX_REF_STR_LEN ) == 0 ) {
677 Debug( LDAP_DEBUG_TRACE,
678 "chasing DX referral: <%s>\n", ref, 0, 0 );
679 tmpref = ref + LDAP_DX_REF_STR_LEN;
680 #endif /* LDAP_DNS */
682 Debug( LDAP_DEBUG_TRACE,
683 "ignoring unknown referral <%s>\n", ref, 0, 0 );
684 rc = append_referral( ld, &unfollowed, ref );
690 if (( refdn = strchr( tmpref, '/' )) != NULL ) {
697 if (( ber = re_encode_request( ld, origreq->lr_ber,
698 ++ld->ld_msgid, &refdn )) == NULL ) {
704 #endif /* LDAP_DNS */
705 if (( srv = (LDAPServer *)calloc( 1,
706 sizeof( LDAPServer ))) == NULL ) {
708 ld->ld_errno = LDAP_NO_MEMORY;
712 if (( srv->lsrv_host = strdup( tmpref )) == NULL ) {
715 ld->ld_errno = LDAP_NO_MEMORY;
719 if (( ports = strchr( srv->lsrv_host, ':' )) != NULL ) {
721 srv->lsrv_port = atoi( ports );
723 srv->lsrv_port = LDAP_PORT;
727 srv = dn2servers( ld, tmpref );
729 #endif /* LDAP_DNS */
731 if ( srv != NULL && send_server_request( ld, ber, ld->ld_msgid,
732 lr, srv, NULL, 1 ) >= 0 ) {
735 Debug( LDAP_DEBUG_ANY,
736 "Unable to chase referral (%s)\n",
737 ldap_err2string( ld->ld_errno ), 0, 0 );
738 rc = append_referral( ld, &unfollowed, ref );
741 if ( !newdn && refdn != NULL ) {
747 *errstrp = unfollowed;
749 return(( rc == 0 ) ? count : rc );
754 append_referral( LDAP *ld, char **referralsp, char *s )
758 if ( *referralsp == NULL ) {
760 *referralsp = (char *)malloc( strlen( s ) + LDAP_REF_STR_LEN
764 *referralsp = (char *)realloc( *referralsp,
765 strlen( *referralsp ) + strlen( s ) + 2 );
768 if ( *referralsp == NULL ) {
769 ld->ld_errno = LDAP_NO_MEMORY;
774 strcpy( *referralsp, LDAP_REF_STR );
776 strcat( *referralsp, "\n" );
778 strcat( *referralsp, s );
786 re_encode_request( LDAP *ld, BerElement *origber, int msgid, char **dnp )
789 * XXX this routine knows way too much about how the lber library works!
791 unsigned long along, tag;
794 BerElement tmpber, *ber;
797 Debug( LDAP_DEBUG_TRACE,
798 "re_encode_request: new msgid %d, new dn <%s>\n",
799 msgid, ( *dnp == NULL ) ? "NONE" : *dnp, 0 );
804 * all LDAP requests are sequences that start with a message id,
805 * followed by a sequence that is tagged with the operation code
807 if ( ber_scanf( &tmpber, "{i", &along ) != LDAP_TAG_MSGID ||
808 ( tag = ber_skip_tag( &tmpber, &along )) == LBER_DEFAULT ) {
809 ld->ld_errno = LDAP_DECODING_ERROR;
813 if (( ber = alloc_ber_with_options( ld )) == NULLBER ) {
817 /* bind requests have a version number before the DN & other stuff */
818 if ( tag == LDAP_REQ_BIND && ber_get_int( &tmpber, (long *)&ver ) ==
820 ld->ld_errno = LDAP_DECODING_ERROR;
825 /* the rest of the request is the DN followed by other stuff */
826 if ( ber_get_stringa( &tmpber, &orig_dn ) == LBER_DEFAULT ) {
831 if ( *dnp == NULL ) {
837 if ( tag == LDAP_REQ_BIND ) {
838 rc = ber_printf( ber, "{it{is", msgid, tag, ver, *dnp );
840 rc = ber_printf( ber, "{it{s", msgid, tag, *dnp );
848 if ( ber_write( ber, tmpber.ber_ptr, ( tmpber.ber_end -
849 tmpber.ber_ptr ), 0 ) != ( tmpber.ber_end - tmpber.ber_ptr ) ||
850 ber_printf( ber, "}}" ) == -1 ) {
851 ld->ld_errno = LDAP_ENCODING_ERROR;
857 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
858 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
862 #endif /* LDAP_DEBUG */
869 find_request_by_msgid( LDAP *ld, int msgid )
873 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
874 if ( msgid == lr->lr_msgid ) {
881 #endif /* LDAP_REFERRALS */
886 dn2servers( LDAP *ld, char *dn ) /* dn can also be a domain.... */
888 char *p, *domain, *host, *server_dn, **dxs;
890 LDAPServer *srvlist, *prevsrv, *srv;
892 if (( domain = strrchr( dn, '@' )) != NULL ) {
898 if (( dxs = getdxbyname( domain )) == NULL ) {
899 ld->ld_errno = LDAP_NO_MEMORY;
905 for ( i = 0; dxs[ i ] != NULL; ++i ) {
908 if ( strchr( dxs[ i ], ':' ) == NULL ) {
910 } else if ( strlen( dxs[ i ] ) >= 7 &&
911 strncmp( dxs[ i ], "ldap://", 7 ) == 0 ) {
913 if (( p = strchr( host, ':' )) == NULL ) {
919 if (( p = strchr( p, '/' )) != NULL ) {
921 if ( *server_dn == '\0' ) {
929 if ( host != NULL ) { /* found a server we can use */
930 if (( srv = (LDAPServer *)calloc( 1,
931 sizeof( LDAPServer ))) == NULL ) {
932 free_servers( srvlist );
934 break; /* exit loop & return */
937 /* add to end of list of servers */
938 if ( srvlist == NULL ) {
941 prevsrv->lsrv_next = srv;
946 if (( srv->lsrv_host = strdup( host )) == NULL ||
947 ( server_dn != NULL && ( srv->lsrv_dn =
948 strdup( server_dn )) == NULL )) {
949 free_servers( srvlist );
951 break; /* exit loop & return */
953 srv->lsrv_port = port;
957 ldap_value_free( dxs );
959 if ( srvlist == NULL ) {
960 ld->ld_errno = LDAP_SERVER_DOWN;
965 #endif /* LDAP_DNS */