2 * Copyright (c) 1995 Regents of the University of Michigan.
5 * request.c - sending of ldap requests; handling of referrals
11 static char copyright[] = "@(#) Copyright (c) 1995 Regents of the University of Michigan.\nAll rights reserved.\n";
18 #include <ac/socket.h>
19 #include <ac/string.h>
21 #include <ac/unistd.h>
27 #if defined( LDAP_REFERRALS ) || defined( LDAP_DNS )
28 static LDAPConn *find_connection LDAP_P(( LDAP *ld, LDAPServer *srv, int any ));
29 static void use_connection LDAP_P(( LDAP *ld, LDAPConn *lc ));
30 static void free_servers LDAP_P(( LDAPServer *srvlist ));
31 #endif /* LDAP_REFERRALS || LDAP_DNS */
35 static LDAPServer *dn2servers LDAP_P(( LDAP *ld, char *dn ));
39 static BerElement *re_encode_request LDAP_P(( LDAP *ld, BerElement *origber,
40 int msgid, char **dnp ));
41 #endif /* LDAP_REFERRALS */
45 ldap_alloc_ber_with_options( LDAP *ld )
49 if (( ber = ber_alloc_t( ld->ld_lberoptions )) == NULLBER ) {
50 ld->ld_errno = LDAP_NO_MEMORY;
51 #ifdef STR_TRANSLATION
53 ldap_set_ber_options( ld, ber );
54 #endif /* STR_TRANSLATION */
62 ldap_set_ber_options( LDAP *ld, BerElement *ber )
64 ber->ber_options = ld->ld_lberoptions;
65 #ifdef STR_TRANSLATION
66 if (( ld->ld_lberoptions & LBER_TRANSLATE_STRINGS ) != 0 ) {
67 ber_set_string_translators( ber,
68 ld->ld_lber_encode_translate_proc,
69 ld->ld_lber_decode_translate_proc );
71 #endif /* STR_TRANSLATION */
76 ldap_send_initial_request( LDAP *ld, unsigned long msgtype, char *dn,
79 #if defined( LDAP_REFERRALS ) || defined( LDAP_DNS )
81 #endif /* LDAP_REFERRALS || LDAP_DNS */
83 Debug( LDAP_DEBUG_TRACE, "ldap_send_initial_request\n", 0, 0, 0 );
85 #if !defined( LDAP_REFERRALS ) && !defined( LDAP_DNS )
86 if ( ber_flush( &ld->ld_sb, ber, 1 ) != 0 ) {
87 ld->ld_errno = LDAP_SERVER_DOWN;
91 ld->ld_errno = LDAP_SUCCESS;
92 return( ld->ld_msgid );
93 #else /* !LDAP_REFERRALS && !LDAP_DNS */
96 if (( ld->ld_options & LDAP_OPT_DNS ) != 0 && ldap_is_dns_dn( dn )) {
97 if (( servers = dn2servers( ld, dn )) == NULL ) {
103 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
106 for ( srv = servers; srv != NULL;
107 srv = srv->lsrv_next ) {
109 "LDAP server %s: dn %s, port %d\n",
110 srv->lsrv_host, ( srv->lsrv_dn == NULL ) ?
111 "(default)" : srv->lsrv_dn,
115 #endif /* LDAP_DEBUG */
117 #endif /* LDAP_DNS */
119 * use of DNS is turned off or this is an X.500 DN...
120 * use our default connection
125 #endif /* LDAP_DNS */
127 return( ldap_send_server_request( ld, ber, ld->ld_msgid, NULL, servers,
129 #endif /* !LDAP_REFERRALS && !LDAP_DNS */
134 #if defined( LDAP_REFERRALS ) || defined( LDAP_DNS )
136 ldap_send_server_request( LDAP *ld, BerElement *ber, int msgid, LDAPRequest
137 *parentreq, LDAPServer *srvlist, LDAPConn *lc, int bind )
142 Debug( LDAP_DEBUG_TRACE, "ldap_send_server_request\n", 0, 0, 0 );
145 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
148 if ( srvlist == NULL ) {
151 if (( lc = find_connection( ld, srvlist, 1 )) ==
153 if ( bind && (parentreq != NULL) ) {
154 /* Remember the bind in the parent */
156 ++parentreq->lr_outrefcnt;
158 lc = ldap_new_connection( ld, &srvlist, 0, 1, bind );
160 free_servers( srvlist );
164 if ( lc == NULL || lc->lconn_status != LDAP_CONNST_CONNECTED ) {
166 if ( ld->ld_errno == LDAP_SUCCESS ) {
167 ld->ld_errno = LDAP_SERVER_DOWN;
170 /* Forget about the bind */
171 --parentreq->lr_outrefcnt;
176 use_connection( ld, lc );
177 if (( lr = (LDAPRequest *)calloc( 1, sizeof( LDAPRequest ))) ==
179 ld->ld_errno = LDAP_NO_MEMORY;
180 ldap_free_connection( ld, lc, 0, 0 );
183 /* Forget about the bind */
184 --parentreq->lr_outrefcnt;
188 lr->lr_msgid = msgid;
189 lr->lr_status = LDAP_REQST_INPROGRESS;
190 lr->lr_res_errno = LDAP_SUCCESS; /* optimistic */
193 if ( parentreq != NULL ) { /* sub-request */
195 /* Increment if we didn't do it before the bind */
196 ++parentreq->lr_outrefcnt;
198 lr->lr_origid = parentreq->lr_origid;
199 lr->lr_parentcnt = parentreq->lr_parentcnt + 1;
200 lr->lr_parent = parentreq;
201 lr->lr_refnext = parentreq->lr_refnext;
202 parentreq->lr_refnext = lr;
203 } else { /* original request */
204 lr->lr_origid = lr->lr_msgid;
207 if (( lr->lr_next = ld->ld_requests ) != NULL ) {
208 lr->lr_next->lr_prev = lr;
210 ld->ld_requests = lr;
213 if ( ber_flush( lc->lconn_sb, ber, 0 ) != 0 ) {
217 if ( errno == EWOULDBLOCK ) {
218 /* need to continue write later */
219 lr->lr_status = LDAP_REQST_WRITING;
220 ldap_mark_select_write( ld, lc->lconn_sb );
223 ld->ld_errno = LDAP_SERVER_DOWN;
224 ldap_free_request( ld, lr );
225 ldap_free_connection( ld, lc, 0, 0 );
232 if ( parentreq == NULL ) {
233 ber->ber_end = ber->ber_ptr;
234 ber->ber_ptr = ber->ber_buf;
237 /* sent -- waiting for a response */
238 ldap_mark_select_read( ld, lc->lconn_sb );
241 ld->ld_errno = LDAP_SUCCESS;
247 ldap_new_connection( LDAP *ld, LDAPServer **srvlistp, int use_ldsb,
248 int connect, int bind )
251 LDAPServer *prevsrv, *srv;
255 * make a new LDAP server connection
256 * XXX open connection synchronously for now
258 if (( lc = (LDAPConn *)calloc( 1, sizeof( LDAPConn ))) == NULL ||
259 ( !use_ldsb && ( sb = (Sockbuf *)calloc( 1, sizeof( Sockbuf )))
264 ld->ld_errno = LDAP_NO_MEMORY;
268 lc->lconn_sb = ( use_ldsb ) ? &ld->ld_sb : sb;
273 for ( srv = *srvlistp; srv != NULL; srv = srv->lsrv_next ) {
274 if ( open_ldap_connection( ld, lc->lconn_sb,
275 srv->lsrv_host, srv->lsrv_port,
276 &lc->lconn_krbinstance, 0 ) != -1 ) {
284 free( (char *)lc->lconn_sb );
287 ld->ld_errno = LDAP_SERVER_DOWN;
291 if ( prevsrv == NULL ) {
292 *srvlistp = srv->lsrv_next;
294 prevsrv->lsrv_next = srv->lsrv_next;
296 lc->lconn_server = srv;
299 lc->lconn_status = LDAP_CONNST_CONNECTED;
300 lc->lconn_next = ld->ld_conns;
304 * XXX for now, we always do a synchronous bind. This will have
305 * to change in the long run...
308 int err, freepasswd, authmethod;
309 char *binddn, *passwd;
310 LDAPConn *savedefconn;
312 freepasswd = err = 0;
314 if ( ld->ld_rebindproc == NULL ) {
315 binddn = passwd = "";
316 authmethod = LDAP_AUTH_SIMPLE;
318 if (( err = (*ld->ld_rebindproc)( ld, &binddn, &passwd,
319 &authmethod, 0 )) == LDAP_SUCCESS ) {
329 savedefconn = ld->ld_defconn;
331 ++lc->lconn_refcnt; /* avoid premature free */
333 if ( ldap_bind_s( ld, binddn, passwd, authmethod ) !=
338 ld->ld_defconn = savedefconn;
342 (*ld->ld_rebindproc)( ld, &binddn, &passwd,
347 ldap_free_connection( ld, lc, 1, 0 );
357 find_connection( LDAP *ld, LDAPServer *srv, int any )
359 * return an existing connection (if any) to the server srv
360 * if "any" is non-zero, check for any server in the "srv" chain
366 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
367 for ( ls = srv; ls != NULL; ls = ls->lsrv_next ) {
368 if ( lc->lconn_server->lsrv_host != NULL &&
369 ls->lsrv_host != NULL && strcasecmp(
370 ls->lsrv_host, lc->lconn_server->lsrv_host ) == 0
371 && ls->lsrv_port == lc->lconn_server->lsrv_port ) {
386 use_connection( LDAP *ld, LDAPConn *lc )
389 lc->lconn_lastused = time( 0 );
394 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
396 LDAPConn *tmplc, *prevlc;
398 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection\n", 0, 0, 0 );
400 if ( force || --lc->lconn_refcnt <= 0 ) {
401 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
402 ldap_mark_select_clear( ld, lc->lconn_sb );
404 ldap_send_unbind( ld, lc->lconn_sb );
406 ldap_close_connection( lc->lconn_sb );
407 if ( lc->lconn_sb->sb_ber.ber_buf != NULL ) {
408 free( lc->lconn_sb->sb_ber.ber_buf );
412 for ( tmplc = ld->ld_conns; tmplc != NULL;
413 tmplc = tmplc->lconn_next ) {
415 if ( prevlc == NULL ) {
416 ld->ld_conns = tmplc->lconn_next;
418 prevlc->lconn_next = tmplc->lconn_next;
424 free_servers( lc->lconn_server );
425 if ( lc->lconn_krbinstance != NULL ) {
426 free( lc->lconn_krbinstance );
428 if ( lc->lconn_sb != &ld->ld_sb ) {
429 free( (char *)lc->lconn_sb );
432 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: actually freed\n",
435 lc->lconn_lastused = time( 0 );
436 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
437 lc->lconn_refcnt, 0, 0 );
444 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
448 fprintf( stderr, "** Connection%s:\n", all ? "s" : "" );
449 for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
450 if ( lc->lconn_server != NULL ) {
451 fprintf( stderr, "* host: %s port: %d%s\n",
452 ( lc->lconn_server->lsrv_host == NULL ) ? "(null)"
453 : lc->lconn_server->lsrv_host,
454 lc->lconn_server->lsrv_port, ( lc->lconn_sb ==
455 &ld->ld_sb ) ? " (default)" : "" );
457 fprintf( stderr, " refcnt: %d status: %s\n", lc->lconn_refcnt,
458 ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET ) ?
459 "NeedSocket" : ( lc->lconn_status ==
460 LDAP_CONNST_CONNECTING ) ? "Connecting" : "Connected" );
461 fprintf( stderr, " last used: %s\n",
462 ctime( &lc->lconn_lastused ));
471 ldap_dump_requests_and_responses( LDAP *ld )
476 fprintf( stderr, "** Outstanding Requests:\n" );
477 if (( lr = ld->ld_requests ) == NULL ) {
478 fprintf( stderr, " Empty\n" );
480 for ( ; lr != NULL; lr = lr->lr_next ) {
481 fprintf( stderr, " * msgid %d, origid %d, status %s\n",
482 lr->lr_msgid, lr->lr_origid, ( lr->lr_status ==
483 LDAP_REQST_INPROGRESS ) ? "InProgress" :
484 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
485 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
487 fprintf( stderr, " outstanding referrals %d, parent count %d\n",
488 lr->lr_outrefcnt, lr->lr_parentcnt );
491 fprintf( stderr, "** Response Queue:\n" );
492 if (( lm = ld->ld_responses ) == NULLMSG ) {
493 fprintf( stderr, " Empty\n" );
495 for ( ; lm != NULLMSG; lm = lm->lm_next ) {
496 fprintf( stderr, " * msgid %d, type %d\n",
497 lm->lm_msgid, lm->lm_msgtype );
498 if (( l = lm->lm_chain ) != NULL ) {
499 fprintf( stderr, " chained responses:\n" );
500 for ( ; l != NULLMSG; l = l->lm_chain ) {
502 " * msgid %d, type %d\n",
503 l->lm_msgid, l->lm_msgtype );
508 #endif /* LDAP_DEBUG */
512 ldap_free_request( LDAP *ld, LDAPRequest *lr )
514 LDAPRequest *tmplr, *nextlr;
516 Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
517 lr->lr_origid, lr->lr_msgid, 0 );
519 if ( lr->lr_parent != NULL ) {
520 --lr->lr_parent->lr_outrefcnt;
522 /* free all referrals (child requests) */
523 for ( tmplr = lr->lr_refnext; tmplr != NULL; tmplr = nextlr ) {
524 nextlr = tmplr->lr_refnext;
525 ldap_free_request( ld, tmplr );
529 if ( lr->lr_prev == NULL ) {
530 ld->ld_requests = lr->lr_next;
532 lr->lr_prev->lr_next = lr->lr_next;
535 if ( lr->lr_next != NULL ) {
536 lr->lr_next->lr_prev = lr->lr_prev;
539 if ( lr->lr_ber != NULL ) {
540 ber_free( lr->lr_ber, 1 );
543 if ( lr->lr_res_error != NULL ) {
544 free( lr->lr_res_error );
547 if ( lr->lr_res_matched != NULL ) {
548 free( lr->lr_res_matched );
556 free_servers( LDAPServer *srvlist )
560 while ( srvlist != NULL ) {
561 nextsrv = srvlist->lsrv_next;
562 if ( srvlist->lsrv_dn != NULL ) {
563 free( srvlist->lsrv_dn );
565 if ( srvlist->lsrv_host != NULL ) {
566 free( srvlist->lsrv_host );
572 #endif /* LDAP_REFERRALS || LDAP_DNS */
575 #ifdef LDAP_REFERRALS
577 * XXX merging of errors in this routine needs to be improved
580 ldap_chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp )
582 int rc, count, len, newdn;
585 #endif /* LDAP_DNS */
586 char *p, *ports, *ref, *tmpref, *refdn, *unfollowed;
587 LDAPRequest *origreq;
591 Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
593 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
596 if ( *errstrp == NULL ) {
600 len = strlen( *errstrp );
601 for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
602 if (( *p == 'R' || *p == 'r' ) && strncasecmp( p,
603 LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
605 p += LDAP_REF_STR_LEN;
610 if ( len < LDAP_REF_STR_LEN ) {
614 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
615 Debug( LDAP_DEBUG_ANY,
616 "more than %d referral hops (dropping)\n",
617 ld->ld_refhoplimit, 0, 0 );
618 /* XXX report as error in ld->ld_errno? */
622 /* find original request */
623 for ( origreq = lr; origreq->lr_parent != NULL;
624 origreq = origreq->lr_parent ) {
631 /* parse out & follow referrals */
632 for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
635 #endif /* LDAP_DNS */
637 if (( p = strchr( ref, '\n' )) != NULL ) {
644 if ( len > LDAP_LDAP_REF_STR_LEN && strncasecmp( ref,
645 LDAP_LDAP_REF_STR, LDAP_LDAP_REF_STR_LEN ) == 0 ) {
646 Debug( LDAP_DEBUG_TRACE,
647 "chasing LDAP referral: <%s>\n", ref, 0, 0 );
650 #endif /* LDAP_DNS */
651 tmpref = ref + LDAP_LDAP_REF_STR_LEN;
653 } else if ( len > LDAP_DX_REF_STR_LEN && strncasecmp( ref,
654 LDAP_DX_REF_STR, LDAP_DX_REF_STR_LEN ) == 0 ) {
655 Debug( LDAP_DEBUG_TRACE,
656 "chasing DX referral: <%s>\n", ref, 0, 0 );
657 tmpref = ref + LDAP_DX_REF_STR_LEN;
658 #endif /* LDAP_DNS */
660 Debug( LDAP_DEBUG_TRACE,
661 "ignoring unknown referral <%s>\n", ref, 0, 0 );
662 rc = ldap_append_referral( ld, &unfollowed, ref );
668 if (( refdn = strchr( tmpref, '/' )) != NULL ) {
675 if (( ber = re_encode_request( ld, origreq->lr_ber,
676 ++ld->ld_msgid, &refdn )) == NULL ) {
682 #endif /* LDAP_DNS */
683 if (( srv = (LDAPServer *)calloc( 1,
684 sizeof( LDAPServer ))) == NULL ) {
686 ld->ld_errno = LDAP_NO_MEMORY;
690 if (( srv->lsrv_host = ldap_strdup( tmpref )) == NULL ) {
693 ld->ld_errno = LDAP_NO_MEMORY;
697 if (( ports = strchr( srv->lsrv_host, ':' )) != NULL ) {
699 srv->lsrv_port = atoi( ports );
701 srv->lsrv_port = openldap_ldap_global_options.ldo_defport;
705 srv = dn2servers( ld, tmpref );
707 #endif /* LDAP_DNS */
709 if ( srv != NULL && ldap_send_server_request( ld, ber, ld->ld_msgid,
710 lr, srv, NULL, 1 ) >= 0 ) {
713 Debug( LDAP_DEBUG_ANY,
714 "Unable to chase referral (%s)\n",
715 ldap_err2string( ld->ld_errno ), 0, 0 );
716 rc = ldap_append_referral( ld, &unfollowed, ref );
719 if ( !newdn && refdn != NULL ) {
725 *errstrp = unfollowed;
727 return(( rc == 0 ) ? count : rc );
732 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
736 if ( *referralsp == NULL ) {
738 *referralsp = (char *)malloc( strlen( s ) + LDAP_REF_STR_LEN
742 *referralsp = (char *)realloc( *referralsp,
743 strlen( *referralsp ) + strlen( s ) + 2 );
746 if ( *referralsp == NULL ) {
747 ld->ld_errno = LDAP_NO_MEMORY;
752 strcpy( *referralsp, LDAP_REF_STR );
754 strcat( *referralsp, "\n" );
756 strcat( *referralsp, s );
764 re_encode_request( LDAP *ld, BerElement *origber, int msgid, char **dnp )
767 * XXX this routine knows way too much about how the lber library works!
769 unsigned long along, tag;
772 BerElement tmpber, *ber;
775 Debug( LDAP_DEBUG_TRACE,
776 "re_encode_request: new msgid %d, new dn <%s>\n",
777 msgid, ( *dnp == NULL ) ? "NONE" : *dnp, 0 );
782 * all LDAP requests are sequences that start with a message id,
783 * followed by a sequence that is tagged with the operation code
785 if ( ber_scanf( &tmpber, "{i", &along ) != LDAP_TAG_MSGID ||
786 ( tag = ber_skip_tag( &tmpber, &along )) == LBER_DEFAULT ) {
787 ld->ld_errno = LDAP_DECODING_ERROR;
791 if (( ber = ldap_alloc_ber_with_options( ld )) == NULLBER ) {
795 /* bind requests have a version number before the DN & other stuff */
796 if ( tag == LDAP_REQ_BIND && ber_get_int( &tmpber, (long *)&ver ) ==
798 ld->ld_errno = LDAP_DECODING_ERROR;
803 /* the rest of the request is the DN followed by other stuff */
804 if ( ber_get_stringa( &tmpber, &orig_dn ) == LBER_DEFAULT ) {
809 if ( *dnp == NULL ) {
815 if ( tag == LDAP_REQ_BIND ) {
816 rc = ber_printf( ber, "{it{is", msgid, tag, ver, *dnp );
818 rc = ber_printf( ber, "{it{s", msgid, tag, *dnp );
826 if ( ber_write( ber, tmpber.ber_ptr, ( tmpber.ber_end -
827 tmpber.ber_ptr ), 0 ) != ( tmpber.ber_end - tmpber.ber_ptr ) ||
828 ber_printf( ber, "}}" ) == -1 ) {
829 ld->ld_errno = LDAP_ENCODING_ERROR;
835 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
836 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
840 #endif /* LDAP_DEBUG */
847 ldap_find_request_by_msgid( LDAP *ld, int msgid )
851 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
852 if ( msgid == lr->lr_msgid ) {
859 #endif /* LDAP_REFERRALS */
864 dn2servers( LDAP *ld, char *dn ) /* dn can also be a domain.... */
866 char *p, *domain, *host, *server_dn, **dxs;
868 LDAPServer *srvlist, *prevsrv, *srv;
870 if (( domain = strrchr( dn, '@' )) != NULL ) {
876 if (( dxs = ldap_getdxbyname( domain )) == NULL ) {
877 ld->ld_errno = LDAP_NO_MEMORY;
883 for ( i = 0; dxs[ i ] != NULL; ++i ) {
884 port = openldap_ldap_global_options.ldo_defport;
886 if ( strchr( dxs[ i ], ':' ) == NULL ) {
888 } else if ( strlen( dxs[ i ] ) >= 7 &&
889 strncmp( dxs[ i ], "ldap://", 7 ) == 0 ) {
891 if (( p = strchr( host, ':' )) == NULL ) {
897 if (( p = strchr( p, '/' )) != NULL ) {
899 if ( *server_dn == '\0' ) {
907 if ( host != NULL ) { /* found a server we can use */
908 if (( srv = (LDAPServer *)calloc( 1,
909 sizeof( LDAPServer ))) == NULL ) {
910 free_servers( srvlist );
912 break; /* exit loop & return */
915 /* add to end of list of servers */
916 if ( srvlist == NULL ) {
919 prevsrv->lsrv_next = srv;
924 if (( srv->lsrv_host = ldap_strdup( host )) == NULL ||
925 ( server_dn != NULL && ( srv->lsrv_dn =
926 ldap_strdup( server_dn )) == NULL )) {
927 free_servers( srvlist );
929 break; /* exit loop & return */
931 srv->lsrv_port = port;
935 ldap_value_free( dxs );
937 if ( srvlist == NULL ) {
938 ld->ld_errno = LDAP_SERVER_DOWN;
943 #endif /* LDAP_DNS */