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>
25 #if defined( LDAP_REFERRALS ) || defined( LDAP_DNS )
26 static LDAPConn *find_connection LDAP_P(( LDAP *ld, LDAPServer *srv, int any ));
27 static void use_connection LDAP_P(( LDAP *ld, LDAPConn *lc ));
28 static void free_servers LDAP_P(( LDAPServer *srvlist ));
29 #endif /* LDAP_REFERRALS || LDAP_DNS */
33 static LDAPServer *dn2servers LDAP_P(( LDAP *ld, char *dn ));
37 static BerElement *re_encode_request LDAP_P(( LDAP *ld, BerElement *origber,
38 int msgid, char **dnp ));
39 #endif /* LDAP_REFERRALS */
43 ldap_alloc_ber_with_options( LDAP *ld )
47 if (( ber = ber_alloc_t( ld->ld_lberoptions )) == NULLBER ) {
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( LDAP *ld, unsigned long msgtype, char *dn,
77 #if defined( LDAP_REFERRALS ) || defined( LDAP_DNS )
79 #endif /* LDAP_REFERRALS || LDAP_DNS */
81 Debug( LDAP_DEBUG_TRACE, "ldap_send_initial_request\n", 0, 0, 0 );
83 #if !defined( LDAP_REFERRALS ) && !defined( LDAP_DNS )
84 if ( ber_flush( &ld->ld_sb, ber, 1 ) != 0 ) {
85 ld->ld_errno = LDAP_SERVER_DOWN;
89 ld->ld_errno = LDAP_SUCCESS;
90 return( ld->ld_msgid );
91 #else /* !LDAP_REFERRALS && !LDAP_DNS */
94 if (( ld->ld_options & LDAP_OPT_DNS ) != 0 && ldap_is_dns_dn( dn )) {
95 if (( servers = dn2servers( ld, dn )) == NULL ) {
101 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
104 for ( srv = servers; srv != NULL;
105 srv = srv->lsrv_next ) {
107 "LDAP server %s: dn %s, port %d\n",
108 srv->lsrv_host, ( srv->lsrv_dn == NULL ) ?
109 "(default)" : srv->lsrv_dn,
113 #endif /* LDAP_DEBUG */
115 #endif /* LDAP_DNS */
117 * use of DNS is turned off or this is an X.500 DN...
118 * use our default connection
123 #endif /* LDAP_DNS */
125 return( ldap_send_server_request( ld, ber, ld->ld_msgid, NULL, servers,
127 #endif /* !LDAP_REFERRALS && !LDAP_DNS */
132 #if defined( LDAP_REFERRALS ) || defined( LDAP_DNS )
134 ldap_send_server_request( LDAP *ld, BerElement *ber, int msgid, LDAPRequest
135 *parentreq, LDAPServer *srvlist, LDAPConn *lc, int bind )
140 Debug( LDAP_DEBUG_TRACE, "ldap_send_server_request\n", 0, 0, 0 );
143 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
146 if ( srvlist == NULL ) {
149 if (( lc = find_connection( ld, srvlist, 1 )) ==
151 if ( bind && (parentreq != NULL) ) {
152 /* Remember the bind in the parent */
154 ++parentreq->lr_outrefcnt;
156 lc = ldap_new_connection( ld, &srvlist, 0, 1, bind );
158 free_servers( srvlist );
162 if ( lc == NULL || lc->lconn_status != LDAP_CONNST_CONNECTED ) {
164 if ( ld->ld_errno == LDAP_SUCCESS ) {
165 ld->ld_errno = LDAP_SERVER_DOWN;
168 /* Forget about the bind */
169 --parentreq->lr_outrefcnt;
174 use_connection( ld, lc );
175 if (( lr = (LDAPRequest *)calloc( 1, sizeof( LDAPRequest ))) ==
177 ld->ld_errno = LDAP_NO_MEMORY;
178 ldap_free_connection( ld, lc, 0, 0 );
181 /* Forget about the bind */
182 --parentreq->lr_outrefcnt;
186 lr->lr_msgid = msgid;
187 lr->lr_status = LDAP_REQST_INPROGRESS;
188 lr->lr_res_errno = LDAP_SUCCESS; /* optimistic */
191 if ( parentreq != NULL ) { /* sub-request */
193 /* Increment if we didn't do it before the bind */
194 ++parentreq->lr_outrefcnt;
196 lr->lr_origid = parentreq->lr_origid;
197 lr->lr_parentcnt = parentreq->lr_parentcnt + 1;
198 lr->lr_parent = parentreq;
199 lr->lr_refnext = parentreq->lr_refnext;
200 parentreq->lr_refnext = lr;
201 } else { /* original request */
202 lr->lr_origid = lr->lr_msgid;
205 if (( lr->lr_next = ld->ld_requests ) != NULL ) {
206 lr->lr_next->lr_prev = lr;
208 ld->ld_requests = lr;
211 if ( ber_flush( lc->lconn_sb, ber, 0 ) != 0 ) {
215 if ( errno == EWOULDBLOCK ) {
216 /* need to continue write later */
217 lr->lr_status = LDAP_REQST_WRITING;
218 ldap_mark_select_write( ld, lc->lconn_sb );
221 ld->ld_errno = LDAP_SERVER_DOWN;
222 ldap_free_request( ld, lr );
223 ldap_free_connection( ld, lc, 0, 0 );
230 if ( parentreq == NULL ) {
231 ber->ber_end = ber->ber_ptr;
232 ber->ber_ptr = ber->ber_buf;
235 /* sent -- waiting for a response */
236 ldap_mark_select_read( ld, lc->lconn_sb );
239 ld->ld_errno = LDAP_SUCCESS;
245 ldap_new_connection( LDAP *ld, LDAPServer **srvlistp, int use_ldsb,
246 int connect, int bind )
249 LDAPServer *prevsrv, *srv;
253 * make a new LDAP server connection
254 * XXX open connection synchronously for now
256 if (( lc = (LDAPConn *)calloc( 1, sizeof( LDAPConn ))) == NULL ||
257 ( !use_ldsb && ( sb = (Sockbuf *)calloc( 1, sizeof( Sockbuf )))
262 ld->ld_errno = LDAP_NO_MEMORY;
266 lc->lconn_sb = ( use_ldsb ) ? &ld->ld_sb : sb;
271 for ( srv = *srvlistp; srv != NULL; srv = srv->lsrv_next ) {
272 if ( open_ldap_connection( ld, lc->lconn_sb,
273 srv->lsrv_host, srv->lsrv_port,
274 &lc->lconn_krbinstance, 0 ) != -1 ) {
282 free( (char *)lc->lconn_sb );
285 ld->ld_errno = LDAP_SERVER_DOWN;
289 if ( prevsrv == NULL ) {
290 *srvlistp = srv->lsrv_next;
292 prevsrv->lsrv_next = srv->lsrv_next;
294 lc->lconn_server = srv;
297 lc->lconn_status = LDAP_CONNST_CONNECTED;
298 lc->lconn_next = ld->ld_conns;
302 * XXX for now, we always do a synchronous bind. This will have
303 * to change in the long run...
306 int err, freepasswd, authmethod;
307 char *binddn, *passwd;
308 LDAPConn *savedefconn;
310 freepasswd = err = 0;
312 if ( ld->ld_rebindproc == NULL ) {
313 binddn = passwd = "";
314 authmethod = LDAP_AUTH_SIMPLE;
316 if (( err = (*ld->ld_rebindproc)( ld, &binddn, &passwd,
317 &authmethod, 0 )) == LDAP_SUCCESS ) {
327 savedefconn = ld->ld_defconn;
329 ++lc->lconn_refcnt; /* avoid premature free */
331 if ( ldap_bind_s( ld, binddn, passwd, authmethod ) !=
336 ld->ld_defconn = savedefconn;
340 (*ld->ld_rebindproc)( ld, &binddn, &passwd,
345 ldap_free_connection( ld, lc, 1, 0 );
355 find_connection( LDAP *ld, LDAPServer *srv, int any )
357 * return an existing connection (if any) to the server srv
358 * if "any" is non-zero, check for any server in the "srv" chain
364 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
365 for ( ls = srv; ls != NULL; ls = ls->lsrv_next ) {
366 if ( lc->lconn_server->lsrv_host != NULL &&
367 ls->lsrv_host != NULL && strcasecmp(
368 ls->lsrv_host, lc->lconn_server->lsrv_host ) == 0
369 && ls->lsrv_port == lc->lconn_server->lsrv_port ) {
384 use_connection( LDAP *ld, LDAPConn *lc )
387 lc->lconn_lastused = time( 0 );
392 ldap_free_connection( LDAP *ld, LDAPConn *lc, int force, int unbind )
394 LDAPConn *tmplc, *prevlc;
396 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection\n", 0, 0, 0 );
398 if ( force || --lc->lconn_refcnt <= 0 ) {
399 if ( lc->lconn_status == LDAP_CONNST_CONNECTED ) {
400 ldap_mark_select_clear( ld, lc->lconn_sb );
402 ldap_send_unbind( ld, lc->lconn_sb );
404 ldap_close_connection( lc->lconn_sb );
405 if ( lc->lconn_sb->sb_ber.ber_buf != NULL ) {
406 free( lc->lconn_sb->sb_ber.ber_buf );
410 for ( tmplc = ld->ld_conns; tmplc != NULL;
411 tmplc = tmplc->lconn_next ) {
413 if ( prevlc == NULL ) {
414 ld->ld_conns = tmplc->lconn_next;
416 prevlc->lconn_next = tmplc->lconn_next;
422 free_servers( lc->lconn_server );
423 if ( lc->lconn_krbinstance != NULL ) {
424 free( lc->lconn_krbinstance );
426 if ( lc->lconn_sb != &ld->ld_sb ) {
427 free( (char *)lc->lconn_sb );
430 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: actually freed\n",
433 lc->lconn_lastused = time( 0 );
434 Debug( LDAP_DEBUG_TRACE, "ldap_free_connection: refcnt %d\n",
435 lc->lconn_refcnt, 0, 0 );
442 ldap_dump_connection( LDAP *ld, LDAPConn *lconns, int all )
446 fprintf( stderr, "** Connection%s:\n", all ? "s" : "" );
447 for ( lc = lconns; lc != NULL; lc = lc->lconn_next ) {
448 if ( lc->lconn_server != NULL ) {
449 fprintf( stderr, "* host: %s port: %d%s\n",
450 ( lc->lconn_server->lsrv_host == NULL ) ? "(null)"
451 : lc->lconn_server->lsrv_host,
452 lc->lconn_server->lsrv_port, ( lc->lconn_sb ==
453 &ld->ld_sb ) ? " (default)" : "" );
455 fprintf( stderr, " refcnt: %d status: %s\n", lc->lconn_refcnt,
456 ( lc->lconn_status == LDAP_CONNST_NEEDSOCKET ) ?
457 "NeedSocket" : ( lc->lconn_status ==
458 LDAP_CONNST_CONNECTING ) ? "Connecting" : "Connected" );
459 fprintf( stderr, " last used: %s\n",
460 ctime( &lc->lconn_lastused ));
469 ldap_dump_requests_and_responses( LDAP *ld )
474 fprintf( stderr, "** Outstanding Requests:\n" );
475 if (( lr = ld->ld_requests ) == NULL ) {
476 fprintf( stderr, " Empty\n" );
478 for ( ; lr != NULL; lr = lr->lr_next ) {
479 fprintf( stderr, " * msgid %d, origid %d, status %s\n",
480 lr->lr_msgid, lr->lr_origid, ( lr->lr_status ==
481 LDAP_REQST_INPROGRESS ) ? "InProgress" :
482 ( lr->lr_status == LDAP_REQST_CHASINGREFS ) ? "ChasingRefs" :
483 ( lr->lr_status == LDAP_REQST_NOTCONNECTED ) ? "NotConnected" :
485 fprintf( stderr, " outstanding referrals %d, parent count %d\n",
486 lr->lr_outrefcnt, lr->lr_parentcnt );
489 fprintf( stderr, "** Response Queue:\n" );
490 if (( lm = ld->ld_responses ) == NULLMSG ) {
491 fprintf( stderr, " Empty\n" );
493 for ( ; lm != NULLMSG; lm = lm->lm_next ) {
494 fprintf( stderr, " * msgid %d, type %d\n",
495 lm->lm_msgid, lm->lm_msgtype );
496 if (( l = lm->lm_chain ) != NULL ) {
497 fprintf( stderr, " chained responses:\n" );
498 for ( ; l != NULLMSG; l = l->lm_chain ) {
500 " * msgid %d, type %d\n",
501 l->lm_msgid, l->lm_msgtype );
506 #endif /* LDAP_DEBUG */
510 ldap_free_request( LDAP *ld, LDAPRequest *lr )
512 LDAPRequest *tmplr, *nextlr;
514 Debug( LDAP_DEBUG_TRACE, "ldap_free_request (origid %d, msgid %d)\n",
515 lr->lr_origid, lr->lr_msgid, 0 );
517 if ( lr->lr_parent != NULL ) {
518 --lr->lr_parent->lr_outrefcnt;
520 /* free all referrals (child requests) */
521 for ( tmplr = lr->lr_refnext; tmplr != NULL; tmplr = nextlr ) {
522 nextlr = tmplr->lr_refnext;
523 ldap_free_request( ld, tmplr );
527 if ( lr->lr_prev == NULL ) {
528 ld->ld_requests = lr->lr_next;
530 lr->lr_prev->lr_next = lr->lr_next;
533 if ( lr->lr_next != NULL ) {
534 lr->lr_next->lr_prev = lr->lr_prev;
537 if ( lr->lr_ber != NULL ) {
538 ber_free( lr->lr_ber, 1 );
541 if ( lr->lr_res_error != NULL ) {
542 free( lr->lr_res_error );
545 if ( lr->lr_res_matched != NULL ) {
546 free( lr->lr_res_matched );
554 free_servers( LDAPServer *srvlist )
558 while ( srvlist != NULL ) {
559 nextsrv = srvlist->lsrv_next;
560 if ( srvlist->lsrv_dn != NULL ) {
561 free( srvlist->lsrv_dn );
563 if ( srvlist->lsrv_host != NULL ) {
564 free( srvlist->lsrv_host );
570 #endif /* LDAP_REFERRALS || LDAP_DNS */
573 #ifdef LDAP_REFERRALS
575 * XXX merging of errors in this routine needs to be improved
578 ldap_chase_referrals( LDAP *ld, LDAPRequest *lr, char **errstrp, int *hadrefp )
580 int rc, count, len, newdn;
583 #endif /* LDAP_DNS */
584 char *p, *ports, *ref, *tmpref, *refdn, *unfollowed;
585 LDAPRequest *origreq;
589 Debug( LDAP_DEBUG_TRACE, "ldap_chase_referrals\n", 0, 0, 0 );
591 ld->ld_errno = LDAP_SUCCESS; /* optimistic */
594 if ( *errstrp == NULL ) {
598 len = strlen( *errstrp );
599 for ( p = *errstrp; len >= LDAP_REF_STR_LEN; ++p, --len ) {
600 if (( *p == 'R' || *p == 'r' ) && strncasecmp( p,
601 LDAP_REF_STR, LDAP_REF_STR_LEN ) == 0 ) {
603 p += LDAP_REF_STR_LEN;
608 if ( len < LDAP_REF_STR_LEN ) {
612 if ( lr->lr_parentcnt >= ld->ld_refhoplimit ) {
613 Debug( LDAP_DEBUG_ANY,
614 "more than %d referral hops (dropping)\n",
615 ld->ld_refhoplimit, 0, 0 );
616 /* XXX report as error in ld->ld_errno? */
620 /* find original request */
621 for ( origreq = lr; origreq->lr_parent != NULL;
622 origreq = origreq->lr_parent ) {
629 /* parse out & follow referrals */
630 for ( ref = p; rc == 0 && ref != NULL; ref = p ) {
633 #endif /* LDAP_DNS */
635 if (( p = strchr( ref, '\n' )) != NULL ) {
642 if ( len > LDAP_LDAP_REF_STR_LEN && strncasecmp( ref,
643 LDAP_LDAP_REF_STR, LDAP_LDAP_REF_STR_LEN ) == 0 ) {
644 Debug( LDAP_DEBUG_TRACE,
645 "chasing LDAP referral: <%s>\n", ref, 0, 0 );
648 #endif /* LDAP_DNS */
649 tmpref = ref + LDAP_LDAP_REF_STR_LEN;
651 } else if ( len > LDAP_DX_REF_STR_LEN && strncasecmp( ref,
652 LDAP_DX_REF_STR, LDAP_DX_REF_STR_LEN ) == 0 ) {
653 Debug( LDAP_DEBUG_TRACE,
654 "chasing DX referral: <%s>\n", ref, 0, 0 );
655 tmpref = ref + LDAP_DX_REF_STR_LEN;
656 #endif /* LDAP_DNS */
658 Debug( LDAP_DEBUG_TRACE,
659 "ignoring unknown referral <%s>\n", ref, 0, 0 );
660 rc = ldap_append_referral( ld, &unfollowed, ref );
666 if (( refdn = strchr( tmpref, '/' )) != NULL ) {
673 if (( ber = re_encode_request( ld, origreq->lr_ber,
674 ++ld->ld_msgid, &refdn )) == NULL ) {
680 #endif /* LDAP_DNS */
681 if (( srv = (LDAPServer *)calloc( 1,
682 sizeof( LDAPServer ))) == NULL ) {
684 ld->ld_errno = LDAP_NO_MEMORY;
688 if (( srv->lsrv_host = strdup( tmpref )) == NULL ) {
691 ld->ld_errno = LDAP_NO_MEMORY;
695 if (( ports = strchr( srv->lsrv_host, ':' )) != NULL ) {
697 srv->lsrv_port = atoi( ports );
699 srv->lsrv_port = LDAP_PORT;
703 srv = dn2servers( ld, tmpref );
705 #endif /* LDAP_DNS */
707 if ( srv != NULL && ldap_send_server_request( ld, ber, ld->ld_msgid,
708 lr, srv, NULL, 1 ) >= 0 ) {
711 Debug( LDAP_DEBUG_ANY,
712 "Unable to chase referral (%s)\n",
713 ldap_err2string( ld->ld_errno ), 0, 0 );
714 rc = ldap_append_referral( ld, &unfollowed, ref );
717 if ( !newdn && refdn != NULL ) {
723 *errstrp = unfollowed;
725 return(( rc == 0 ) ? count : rc );
730 ldap_append_referral( LDAP *ld, char **referralsp, char *s )
734 if ( *referralsp == NULL ) {
736 *referralsp = (char *)malloc( strlen( s ) + LDAP_REF_STR_LEN
740 *referralsp = (char *)realloc( *referralsp,
741 strlen( *referralsp ) + strlen( s ) + 2 );
744 if ( *referralsp == NULL ) {
745 ld->ld_errno = LDAP_NO_MEMORY;
750 strcpy( *referralsp, LDAP_REF_STR );
752 strcat( *referralsp, "\n" );
754 strcat( *referralsp, s );
762 re_encode_request( LDAP *ld, BerElement *origber, int msgid, char **dnp )
765 * XXX this routine knows way too much about how the lber library works!
767 unsigned long along, tag;
770 BerElement tmpber, *ber;
773 Debug( LDAP_DEBUG_TRACE,
774 "re_encode_request: new msgid %d, new dn <%s>\n",
775 msgid, ( *dnp == NULL ) ? "NONE" : *dnp, 0 );
780 * all LDAP requests are sequences that start with a message id,
781 * followed by a sequence that is tagged with the operation code
783 if ( ber_scanf( &tmpber, "{i", &along ) != LDAP_TAG_MSGID ||
784 ( tag = ber_skip_tag( &tmpber, &along )) == LBER_DEFAULT ) {
785 ld->ld_errno = LDAP_DECODING_ERROR;
789 if (( ber = ldap_alloc_ber_with_options( ld )) == NULLBER ) {
793 /* bind requests have a version number before the DN & other stuff */
794 if ( tag == LDAP_REQ_BIND && ber_get_int( &tmpber, (long *)&ver ) ==
796 ld->ld_errno = LDAP_DECODING_ERROR;
801 /* the rest of the request is the DN followed by other stuff */
802 if ( ber_get_stringa( &tmpber, &orig_dn ) == LBER_DEFAULT ) {
807 if ( *dnp == NULL ) {
813 if ( tag == LDAP_REQ_BIND ) {
814 rc = ber_printf( ber, "{it{is", msgid, tag, ver, *dnp );
816 rc = ber_printf( ber, "{it{s", msgid, tag, *dnp );
824 if ( ber_write( ber, tmpber.ber_ptr, ( tmpber.ber_end -
825 tmpber.ber_ptr ), 0 ) != ( tmpber.ber_end - tmpber.ber_ptr ) ||
826 ber_printf( ber, "}}" ) == -1 ) {
827 ld->ld_errno = LDAP_ENCODING_ERROR;
833 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
834 Debug( LDAP_DEBUG_ANY, "re_encode_request new request is:\n",
838 #endif /* LDAP_DEBUG */
845 ldap_find_request_by_msgid( LDAP *ld, int msgid )
849 for ( lr = ld->ld_requests; lr != NULL; lr = lr->lr_next ) {
850 if ( msgid == lr->lr_msgid ) {
857 #endif /* LDAP_REFERRALS */
862 dn2servers( LDAP *ld, char *dn ) /* dn can also be a domain.... */
864 char *p, *domain, *host, *server_dn, **dxs;
866 LDAPServer *srvlist, *prevsrv, *srv;
868 if (( domain = strrchr( dn, '@' )) != NULL ) {
874 if (( dxs = ldap_getdxbyname( domain )) == NULL ) {
875 ld->ld_errno = LDAP_NO_MEMORY;
881 for ( i = 0; dxs[ i ] != NULL; ++i ) {
884 if ( strchr( dxs[ i ], ':' ) == NULL ) {
886 } else if ( strlen( dxs[ i ] ) >= 7 &&
887 strncmp( dxs[ i ], "ldap://", 7 ) == 0 ) {
889 if (( p = strchr( host, ':' )) == NULL ) {
895 if (( p = strchr( p, '/' )) != NULL ) {
897 if ( *server_dn == '\0' ) {
905 if ( host != NULL ) { /* found a server we can use */
906 if (( srv = (LDAPServer *)calloc( 1,
907 sizeof( LDAPServer ))) == NULL ) {
908 free_servers( srvlist );
910 break; /* exit loop & return */
913 /* add to end of list of servers */
914 if ( srvlist == NULL ) {
917 prevsrv->lsrv_next = srv;
922 if (( srv->lsrv_host = strdup( host )) == NULL ||
923 ( server_dn != NULL && ( srv->lsrv_dn =
924 strdup( server_dn )) == NULL )) {
925 free_servers( srvlist );
927 break; /* exit loop & return */
929 srv->lsrv_port = port;
933 ldap_value_free( dxs );
935 if ( srvlist == NULL ) {
936 ld->ld_errno = LDAP_SERVER_DOWN;
941 #endif /* LDAP_DNS */