2 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
3 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6 * Copyright (c) 1990, 1994 Regents of the University of Michigan.
9 * cldap.c - synchronous, retrying interface to the cldap protocol
14 #ifdef LDAP_CONNECTIONLESS
18 #include <ac/stdlib.h>
21 #include <ac/socket.h>
22 #include <ac/string.h>
24 #include <ac/unistd.h>
28 #define DEF_CLDAP_TIMEOUT 3
29 #define DEF_CLDAP_TRIES 4
32 struct cldap_retinfo {
39 static int add_addr LDAP_P((
40 LDAP *ld, struct sockaddr *sap ));
41 static int cldap_result LDAP_P((
42 LDAP *ld, int msgid, LDAPMessage **res,
43 struct cldap_retinfo *crip, const char *base ));
44 static int cldap_parsemsg LDAP_P((
45 LDAP *ld, int msgid, BerElement *ber,
46 LDAPMessage **res, const char *base ));
49 * cldap_open - initialize and connect to an ldap server. A magic cookie to
50 * be used for future communication is returned on success, NULL on failure.
54 * ld = cldap_open( hostname, port );
58 cldap_open( LDAP_CONST char *host, int port )
61 unsigned long address;
62 struct sockaddr_in sock;
68 /* buffers for ldap_pvt_gethostbyname_a ... */
69 struct hostent he_buf;
73 #define DO_RETURN(x) if (ha_buf) LDAP_FREE(ha_buf); return (x);
75 Debug( LDAP_DEBUG_TRACE, "ldap_open\n", 0, 0, 0 );
77 if ( (s = socket( AF_INET, SOCK_DGRAM, 0 )) < 0 ) {
81 sock.sin_addr.s_addr = 0;
82 sock.sin_family = AF_INET;
84 if ( bind(s, (struct sockaddr *) &sock, sizeof(sock)) < 0) {
88 if (( ld = ldap_init( host, port )) == NULL ) {
93 ld->ld_cldapnaddr = 0;
94 ld->ld_cldapaddrs = NULL;
96 if (ber_pvt_sb_set_io( &(ld->ld_sb), &ber_pvt_sb_io_udp, NULL )<0) {
97 ldap_ld_free(ld, 1, NULL, NULL );
101 ld->ld_version = LDAP_VERSION2;
103 sock.sin_family = AF_INET;
104 sock.sin_port = htons( port );
107 * 'host' may be a space-separated list.
109 if ( host != NULL ) {
110 char *host_dup = LDAP_STRDUP( host );
112 for ( ; host != NULL; host = p ) {
113 if (( p = strchr( host, ' ' )) != NULL ) {
114 for (*p++ = '\0'; *p == ' '; p++) {
119 address = inet_addr( host );
120 /* This was just a test for -1 until OSF1 let inet_addr return
121 unsigned int, which is narrower than 'unsigned long address' */
122 if ( address == 0xffffffff || address == (unsigned long) -1 ) {
123 if ((ldap_pvt_gethostbyname_a( host, &he_buf, &ha_buf,
124 &hp,&local_h_errno)<0) ||
126 errno = EHOSTUNREACH;
130 for ( i = 0; hp->h_addr_list[ i ] != 0; ++i ) {
131 SAFEMEMCPY( (char *)&sock.sin_addr.s_addr,
132 (char *)hp->h_addr_list[ i ],
133 sizeof(sock.sin_addr.s_addr));
134 if ( add_addr( ld, (struct sockaddr *)&sock ) < 0 ) {
135 ldap_ld_free( ld, 1, NULL, NULL );
136 LDAP_FREE( host_dup );
142 sock.sin_addr.s_addr = address;
143 if ( add_addr( ld, (struct sockaddr *)&sock ) < 0 ) {
144 ldap_ld_free( ld, 1, NULL, NULL );
145 LDAP_FREE( host_dup );
150 if ( ld->ld_host == NULL ) {
151 ld->ld_host = LDAP_STRDUP( host );
154 LDAP_FREE( host_dup );
156 sock.sin_addr.s_addr = htonl( INADDR_LOOPBACK );
157 if ( add_addr( ld, (struct sockaddr *)&sock ) < 0 ) {
158 ldap_ld_free( ld, 1, NULL, NULL );
163 if ( ld->ld_cldapaddrs == NULL
164 || ( ld->ld_defconn = ldap_new_connection( ld, NULL, 1,0,0 )) == NULL
166 ldap_ld_free( ld, 0, NULL, NULL );
170 ber_pvt_sb_udp_set_dst( &ld->ld_sb, ld->ld_cldapaddrs[0] );
172 cldap_setretryinfo( ld, 0, 0 );
176 for ( i = 0; i < ld->ld_cldapnaddr; ++i ) {
177 Debug( LDAP_DEBUG_TRACE, "end of cldap_open address %d is %s\n",
178 i, inet_ntoa( ((struct sockaddr_in *)
179 ld->ld_cldapaddrs[ i ])->sin_addr ), 0 );
189 cldap_close( LDAP *ld )
191 ldap_ld_free( ld, 0, NULL, NULL );
196 cldap_setretryinfo( LDAP *ld, int tries, int timeout )
198 ld->ld_cldaptries = ( tries <= 0 ) ? DEF_CLDAP_TRIES : tries;
199 ld->ld_cldaptimeout = ( timeout <= 0 ) ? DEF_CLDAP_TIMEOUT : timeout;
204 cldap_search_s( LDAP *ld,
205 LDAP_CONST char *base,
207 LDAP_CONST char *filter,
214 struct cldap_retinfo cri;
218 (void) memset( &cri, 0, sizeof( cri ));
220 if ( logdn != NULL ) {
221 ld->ld_cldapdn = logdn;
222 } else if ( ld->ld_cldapdn == NULL ) {
227 if ( cri.cri_try != 0 ) {
228 --ld->ld_msgid; /* use same id as before */
231 ber_pvt_sb_udp_set_dst( &(ld->ld_sb),
232 ld->ld_cldapaddrs[ cri.cri_useaddr ] );
234 Debug( LDAP_DEBUG_TRACE, "cldap_search_s try %d (to %s)\n",
235 cri.cri_try, inet_ntoa( ((struct sockaddr_in *)
236 ld->ld_cldapaddrs[ cri.cri_useaddr ])->sin_addr), 0 );
238 if ( (msgid = ldap_search( ld, base, scope, filter, attrs,
239 attrsonly )) == -1 ) {
240 return( ld->ld_errno );
243 if ( ld->ld_cache != NULL && ld->ld_responses != NULL ) {
244 Debug( LDAP_DEBUG_TRACE, "cldap_search_s res from cache\n",
246 *res = ld->ld_responses;
247 ld->ld_responses = ld->ld_responses->lm_next;
248 return( ldap_result2error( ld, *res, 0 ));
250 #endif /* LDAP_NOCACHE */
251 ret = cldap_result( ld, msgid, res, &cri, base );
259 add_addr( LDAP *ld, struct sockaddr *sap )
261 struct sockaddr *newsap, **addrs;
263 if (( newsap = (struct sockaddr *)LDAP_MALLOC( sizeof( struct sockaddr )))
265 ld->ld_errno = LDAP_NO_MEMORY;
269 addrs = (struct sockaddr **)LDAP_REALLOC( ld->ld_cldapaddrs,
270 ( ld->ld_cldapnaddr + 1 ) * sizeof(struct sockaddr *));
272 if ( addrs == NULL ) {
274 ld->ld_errno = LDAP_NO_MEMORY;
278 SAFEMEMCPY( (char *)newsap, (char *)sap, sizeof( struct sockaddr ));
279 addrs[ ld->ld_cldapnaddr++ ] = newsap;
280 ld->ld_cldapaddrs = (void **)addrs;
286 cldap_result( LDAP *ld, int msgid, LDAPMessage **res,
287 struct cldap_retinfo *crip, const char *base )
289 Sockbuf *sb = &ld->ld_sb;
292 int ret, fromaddr, i;
298 if ( crip->cri_try == 0 ) {
299 crip->cri_maxtries = ld->ld_cldaptries * ld->ld_cldapnaddr;
300 crip->cri_timeout = ld->ld_cldaptimeout;
301 crip->cri_useaddr = 0;
302 Debug( LDAP_DEBUG_TRACE, "cldap_result tries %d timeout %d\n",
303 ld->ld_cldaptries, ld->ld_cldaptimeout, 0 );
306 if ((tv.tv_sec = crip->cri_timeout / ld->ld_cldapnaddr) < 1 ) {
311 Debug( LDAP_DEBUG_TRACE,
312 "cldap_result waiting up to %ld seconds for a response\n",
313 (long) tv.tv_sec, 0, 0 );
314 ber_init_w_nullc( &ber, 0 );
315 ldap_set_ber_options( ld, &ber );
317 if ( cldap_getmsg( ld, &tv, &ber ) == -1 ) {
319 Debug( LDAP_DEBUG_TRACE, "cldap_getmsg returned -1 (%d)\n",
321 } else if ( ld->ld_errno == LDAP_TIMEOUT ) {
322 Debug( LDAP_DEBUG_TRACE,
323 "cldap_result timed out\n", 0, 0, 0 );
325 * It timed out; is it time to give up?
327 if ( ++crip->cri_try >= crip->cri_maxtries ) {
331 if ( ++crip->cri_useaddr >= ld->ld_cldapnaddr ) {
333 * new round: reset address to first one and
336 crip->cri_useaddr = 0;
337 crip->cri_timeout <<= 1;
344 * Got a response. It should look like:
345 * { msgid, logdn, { searchresponse...}}
349 if ( ber_scanf( &ber, "ia", &id, &logdn ) == LBER_ERROR ) {
350 LDAP_FREE( ber.ber_buf ); /* gack! */
351 ret = LDAP_DECODING_ERROR;
352 Debug( LDAP_DEBUG_TRACE,
353 "cldap_result: ber_scanf returned LBER_ERROR (%d)\n",
355 } else if ( id != msgid ) {
356 LDAP_FREE( ber.ber_buf ); /* gack! */
357 Debug( LDAP_DEBUG_TRACE,
358 "cldap_result: looking for msgid %d; got %d\n",
360 ret = -1; /* ignore and keep looking */
362 struct sockaddr_in * src;
364 * got a result: determine which server it came from
365 * decode into ldap message chain
367 src = (struct sockaddr_in *) ber_pvt_sb_udp_get_src( sb );
369 for ( fromaddr = 0; fromaddr < ld->ld_cldapnaddr; ++fromaddr ) {
370 if ( memcmp( &((struct sockaddr_in *)
371 ld->ld_cldapaddrs[ fromaddr ])->sin_addr,
373 sizeof( struct in_addr )) == 0 ) {
377 ret = cldap_parsemsg( ld, msgid, &ber, res, base );
378 LDAP_FREE( ber.ber_buf ); /* gack! */
379 Debug( LDAP_DEBUG_TRACE,
380 "cldap_result got result (%d)\n", ret, 0, 0 );
383 if ( logdn != NULL ) {
390 * If we are giving up (successfully or otherwise) then
391 * abandon any outstanding requests.
395 if ( i >= ld->ld_cldapnaddr ) {
396 i = ld->ld_cldapnaddr - 1;
399 for ( ; i >= 0; --i ) {
400 if ( i == fromaddr ) {
403 ber_pvt_sb_udp_set_dst( sb, ld->ld_cldapaddrs[i] );
405 Debug( LDAP_DEBUG_TRACE, "cldap_result abandoning id %d (to %s)\n",
406 msgid, inet_ntoa( ((struct sockaddr_in *)
407 ld->ld_cldapaddrs[i])->sin_addr ), 0 );
408 (void) ldap_abandon( ld, msgid );
412 return( ld->ld_errno = ret );
417 cldap_parsemsg( LDAP *ld, int msgid, BerElement *ber,
418 LDAPMessage **res, const char *base )
424 char *dn, *p, *cookie;
425 LDAPMessage *chain, *prev, *ldm;
428 rc = LDAP_DECODING_ERROR; /* pessimistic */
429 ldm = chain = prev = NULL;
430 baselen = ( base == NULL ) ? 0 : strlen( base );
433 for ( tag = ber_first_element( ber, &len, &cookie );
434 tag != LBER_DEFAULT && rc != LDAP_SUCCESS;
435 tag = ber_next_element( ber, &len, cookie )) {
436 if (( ldm = (LDAPMessage *)LDAP_CALLOC( 1, sizeof(LDAPMessage)))
437 == NULL || ( ldm->lm_ber = ldap_alloc_ber_with_options( ld ))
440 break; /* return w/error*/
442 ldm->lm_msgid = msgid;
443 ldm->lm_msgtype = tag;
445 if ( tag == LDAP_RES_SEARCH_RESULT ) {
446 Debug( LDAP_DEBUG_TRACE, "cldap_parsemsg got search result\n",
449 if ( ber_get_stringal( ber, &bv ) == LBER_DEFAULT ) {
450 break; /* return w/error */
453 if ( ber_printf( ldm->lm_ber, "tO", tag, bv ) == -1 ) {
454 break; /* return w/error */
460 } else if ( tag == LDAP_RES_SEARCH_ENTRY ) {
461 if ( ber_scanf( ber, "{aO" /*}*/, &dn, &bv ) == LBER_ERROR ) {
462 break; /* return w/error */
464 Debug( LDAP_DEBUG_TRACE, "cldap_parsemsg entry %s\n", dn, 0, 0 );
465 if ( dn != NULL && *(dn + ( slen = strlen(dn)) - 1) == '*' &&
468 * substitute original searchbase for trailing '*'
470 if (( p = (char *)LDAP_MALLOC( slen + baselen )) == NULL ) {
473 break; /* return w/error */
476 strcpy( p + slen - 1, base );
481 if ( ber_printf( ldm->lm_ber, "t{so}", tag, dn, bv->bv_val,
482 bv->bv_len ) == -1 ) {
483 break; /* return w/error */
490 } else if ( tag == LDAP_RES_SEARCH_REFERENCE ) {
493 Debug( LDAP_DEBUG_TRACE, "cldap_parsemsg got unknown tag %lu\n",
495 rc = LDAP_DECODING_ERROR;
496 break; /* return w/error */
499 /* Reset message ber so we can read from it later. Gack! */
500 ldm->lm_ber->ber_end = ldm->lm_ber->ber_ptr;
501 ldm->lm_ber->ber_ptr = ldm->lm_ber->ber_buf;
504 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
505 fprintf( stderr, "cldap_parsemsg add message id %d type %d:\n",
506 ldm->lm_msgid, ldm->lm_msgtype );
507 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ldm->lm_ber, 1 );
509 #endif /* LDAP_DEBUG */
512 if ( ld->ld_cache != NULL ) {
513 ldap_add_result_to_cache( ld, ldm );
515 #endif /* LDAP_NOCACHE */
517 if ( chain == NULL ) {
520 prev->lm_chain = ldm;
526 /* dispose of any leftovers */
528 if ( ldm->lm_ber != NULL ) {
529 ber_free( ldm->lm_ber, 1 );
537 /* return chain, calling result2error if we got anything at all */
539 return(( *res == NULL ) ? rc : ldap_result2error( ld, *res, 0 ));
541 #endif /* LDAP_CONNECTIONLESS */