3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1990, 1994 Regents of the University of Michigan.
10 * cldap.c - synchronous, retrying interface to the cldap protocol
15 #ifdef LDAP_CONNECTIONLESS
19 #include <ac/stdlib.h>
22 #include <ac/socket.h>
23 #include <ac/string.h>
25 #include <ac/unistd.h>
29 #define DEF_CLDAP_TIMEOUT 3
30 #define DEF_CLDAP_TRIES 4
33 struct cldap_retinfo {
40 static int add_addr LDAP_P((
41 LDAP *ld, struct sockaddr *sap ));
42 static int cldap_result LDAP_P((
43 LDAP *ld, int msgid, LDAPMessage **res,
44 struct cldap_retinfo *crip, const char *base ));
45 static int cldap_parsemsg LDAP_P((
46 LDAP *ld, int msgid, BerElement *ber,
47 LDAPMessage **res, const char *base ));
50 * cldap_open - initialize and connect to an ldap server. A magic cookie to
51 * be used for future communication is returned on success, NULL on failure.
55 * ld = cldap_open( hostname, port );
59 cldap_open( LDAP_CONST char *host, int port )
62 unsigned long address;
63 struct sockaddr_in sock;
69 /* buffers for ldap_pvt_gethostbyname_a ... */
70 struct hostent he_buf;
74 #define DO_RETURN(x) if (ha_buf) LDAP_FREE(ha_buf); return (x);
76 Debug( LDAP_DEBUG_TRACE, "ldap_open\n", 0, 0, 0 );
78 if ( (s = socket( AF_INET, SOCK_DGRAM, 0 )) < 0 ) {
82 sock.sin_addr.s_addr = 0;
83 sock.sin_family = AF_INET;
85 if ( bind(s, (struct sockaddr *) &sock, sizeof(sock)) < 0) {
89 if (( ld = ldap_init( host, port )) == NULL ) {
94 ld->ld_cldapnaddr = 0;
95 ld->ld_cldapaddrs = NULL;
97 if (ber_pvt_sb_set_io( &(ld->ld_sb), &ber_pvt_sb_io_udp, NULL )<0) {
98 ldap_ld_free(ld, 1, NULL, NULL );
102 ld->ld_version = LDAP_VERSION2;
104 sock.sin_family = AF_INET;
105 sock.sin_port = htons( port );
108 * 'host' may be a space-separated list.
110 if ( host != NULL ) {
111 char *host_dup = LDAP_STRDUP( host );
113 for ( ; host != NULL; host = p ) {
114 if (( p = strchr( host, ' ' )) != NULL ) {
115 for (*p++ = '\0'; *p == ' '; p++) {
120 address = inet_addr( host );
121 /* This was just a test for -1 until OSF1 let inet_addr return
122 unsigned int, which is narrower than 'unsigned long address' */
123 if ( address == 0xffffffff || address == (unsigned long) -1 ) {
124 if ((ldap_pvt_gethostbyname_a( host, &he_buf, &ha_buf,
125 &hp,&local_h_errno)<0) ||
127 errno = EHOSTUNREACH;
131 for ( i = 0; hp->h_addr_list[ i ] != 0; ++i ) {
132 SAFEMEMCPY( (char *)&sock.sin_addr,
133 (char *)hp->h_addr_list[ i ],
134 sizeof(sock.sin_addr));
135 if ( add_addr( ld, (struct sockaddr *)&sock ) < 0 ) {
136 ldap_ld_free( ld, 1, NULL, NULL );
137 LDAP_FREE( host_dup );
143 sock.sin_addr.s_addr = address;
144 if ( add_addr( ld, (struct sockaddr *)&sock ) < 0 ) {
145 ldap_ld_free( ld, 1, NULL, NULL );
146 LDAP_FREE( host_dup );
151 if ( ld->ld_host == NULL ) {
152 ld->ld_host = LDAP_STRDUP( host );
155 LDAP_FREE( host_dup );
157 sock.sin_addr.s_addr = htonl( INADDR_LOOPBACK );
158 if ( add_addr( ld, (struct sockaddr *)&sock ) < 0 ) {
159 ldap_ld_free( ld, 1, NULL, NULL );
164 if ( ld->ld_cldapaddrs == NULL
165 || ( ld->ld_defconn = ldap_new_connection( ld, NULL, 1,0,0 )) == NULL
167 ldap_ld_free( ld, 0, NULL, NULL );
171 ber_pvt_sb_udp_set_dst( &ld->ld_sb, ld->ld_cldapaddrs[0] );
173 cldap_setretryinfo( ld, 0, 0 );
177 for ( i = 0; i < ld->ld_cldapnaddr; ++i ) {
178 Debug( LDAP_DEBUG_TRACE, "end of cldap_open address %d is %s\n",
179 i, inet_ntoa( ((struct sockaddr_in *)
180 ld->ld_cldapaddrs[ i ])->sin_addr ), 0 );
190 cldap_close( LDAP *ld )
192 ldap_ld_free( ld, 0, NULL, NULL );
197 cldap_setretryinfo( LDAP *ld, int tries, int timeout )
199 ld->ld_cldaptries = ( tries <= 0 ) ? DEF_CLDAP_TRIES : tries;
200 ld->ld_cldaptimeout = ( timeout <= 0 ) ? DEF_CLDAP_TIMEOUT : timeout;
205 cldap_search_s( LDAP *ld,
206 LDAP_CONST char *base,
208 LDAP_CONST char *filter,
215 struct cldap_retinfo cri;
219 (void) memset( &cri, 0, sizeof( cri ));
221 if ( logdn != NULL ) {
222 ld->ld_cldapdn = logdn;
223 } else if ( ld->ld_cldapdn == NULL ) {
228 if ( cri.cri_try != 0 ) {
229 --ld->ld_msgid; /* use same id as before */
232 ber_pvt_sb_udp_set_dst( &(ld->ld_sb),
233 ld->ld_cldapaddrs[ cri.cri_useaddr ] );
235 Debug( LDAP_DEBUG_TRACE, "cldap_search_s try %d (to %s)\n",
236 cri.cri_try, inet_ntoa( ((struct sockaddr_in *)
237 ld->ld_cldapaddrs[ cri.cri_useaddr ])->sin_addr), 0 );
239 if ( (msgid = ldap_search( ld, base, scope, filter, attrs,
240 attrsonly )) == -1 ) {
241 return( ld->ld_errno );
244 if ( ld->ld_cache != NULL && ld->ld_responses != NULL ) {
245 Debug( LDAP_DEBUG_TRACE, "cldap_search_s res from cache\n",
247 *res = ld->ld_responses;
248 ld->ld_responses = ld->ld_responses->lm_next;
249 return( ldap_result2error( ld, *res, 0 ));
251 #endif /* LDAP_NOCACHE */
252 ret = cldap_result( ld, msgid, res, &cri, base );
260 add_addr( LDAP *ld, struct sockaddr *sap )
262 struct sockaddr *newsap, **addrs;
264 if (( newsap = (struct sockaddr *)LDAP_MALLOC( sizeof( struct sockaddr )))
266 ld->ld_errno = LDAP_NO_MEMORY;
270 addrs = (struct sockaddr **)LDAP_REALLOC( ld->ld_cldapaddrs,
271 ( ld->ld_cldapnaddr + 1 ) * sizeof(struct sockaddr *));
273 if ( addrs == NULL ) {
275 ld->ld_errno = LDAP_NO_MEMORY;
279 SAFEMEMCPY( (char *)newsap, (char *)sap, sizeof( struct sockaddr ));
280 addrs[ ld->ld_cldapnaddr++ ] = newsap;
281 ld->ld_cldapaddrs = (void **)addrs;
287 cldap_result( LDAP *ld, int msgid, LDAPMessage **res,
288 struct cldap_retinfo *crip, const char *base )
290 Sockbuf *sb = &ld->ld_sb;
293 int ret, fromaddr, i;
299 if ( crip->cri_try == 0 ) {
300 crip->cri_maxtries = ld->ld_cldaptries * ld->ld_cldapnaddr;
301 crip->cri_timeout = ld->ld_cldaptimeout;
302 crip->cri_useaddr = 0;
303 Debug( LDAP_DEBUG_TRACE, "cldap_result tries %d timeout %d\n",
304 ld->ld_cldaptries, ld->ld_cldaptimeout, 0 );
307 if ((tv.tv_sec = crip->cri_timeout / ld->ld_cldapnaddr) < 1 ) {
312 Debug( LDAP_DEBUG_TRACE,
313 "cldap_result waiting up to %ld seconds for a response\n",
314 (long) tv.tv_sec, 0, 0 );
315 ber_init_w_nullc( &ber, 0 );
316 ldap_set_ber_options( ld, &ber );
318 if ( cldap_getmsg( ld, &tv, &ber ) == -1 ) {
320 Debug( LDAP_DEBUG_TRACE, "cldap_getmsg returned -1 (%d)\n",
322 } else if ( ld->ld_errno == LDAP_TIMEOUT ) {
323 Debug( LDAP_DEBUG_TRACE,
324 "cldap_result timed out\n", 0, 0, 0 );
326 * It timed out; is it time to give up?
328 if ( ++crip->cri_try >= crip->cri_maxtries ) {
332 if ( ++crip->cri_useaddr >= ld->ld_cldapnaddr ) {
334 * new round: reset address to first one and
337 crip->cri_useaddr = 0;
338 crip->cri_timeout <<= 1;
345 * Got a response. It should look like:
346 * { msgid, logdn, { searchresponse...}}
350 if ( ber_scanf( &ber, "ia", &id, &logdn ) == LBER_ERROR ) {
351 LDAP_FREE( ber.ber_buf ); /* gack! */
352 ret = LDAP_DECODING_ERROR;
353 Debug( LDAP_DEBUG_TRACE,
354 "cldap_result: ber_scanf returned LBER_ERROR (%d)\n",
356 } else if ( id != msgid ) {
357 LDAP_FREE( ber.ber_buf ); /* gack! */
358 Debug( LDAP_DEBUG_TRACE,
359 "cldap_result: looking for msgid %d; got %d\n",
361 ret = -1; /* ignore and keep looking */
363 struct sockaddr_in * src;
365 * got a result: determine which server it came from
366 * decode into ldap message chain
368 src = (struct sockaddr_in *) ber_pvt_sb_udp_get_src( sb );
370 for ( fromaddr = 0; fromaddr < ld->ld_cldapnaddr; ++fromaddr ) {
371 if ( memcmp( &((struct sockaddr_in *)
372 ld->ld_cldapaddrs[ fromaddr ])->sin_addr,
374 sizeof( struct in_addr )) == 0 ) {
378 ret = cldap_parsemsg( ld, msgid, &ber, res, base );
379 LDAP_FREE( ber.ber_buf ); /* gack! */
380 Debug( LDAP_DEBUG_TRACE,
381 "cldap_result got result (%d)\n", ret, 0, 0 );
384 if ( logdn != NULL ) {
391 * If we are giving up (successfully or otherwise) then
392 * abandon any outstanding requests.
396 if ( i >= ld->ld_cldapnaddr ) {
397 i = ld->ld_cldapnaddr - 1;
400 for ( ; i >= 0; --i ) {
401 if ( i == fromaddr ) {
404 ber_pvt_sb_udp_set_dst( sb, ld->ld_cldapaddrs[i] );
406 Debug( LDAP_DEBUG_TRACE, "cldap_result abandoning id %d (to %s)\n",
407 msgid, inet_ntoa( ((struct sockaddr_in *)
408 ld->ld_cldapaddrs[i])->sin_addr ), 0 );
409 (void) ldap_abandon( ld, msgid );
413 return( ld->ld_errno = ret );
418 cldap_parsemsg( LDAP *ld, int msgid, BerElement *ber,
419 LDAPMessage **res, const char *base )
425 char *dn, *p, *cookie;
426 LDAPMessage *chain, *prev, *ldm;
429 rc = LDAP_DECODING_ERROR; /* pessimistic */
430 ldm = chain = prev = NULL;
431 baselen = ( base == NULL ) ? 0 : strlen( base );
434 for ( tag = ber_first_element( ber, &len, &cookie );
435 tag != LBER_DEFAULT && rc != LDAP_SUCCESS;
436 tag = ber_next_element( ber, &len, cookie )) {
437 if (( ldm = (LDAPMessage *)LDAP_CALLOC( 1, sizeof(LDAPMessage)))
438 == NULL || ( ldm->lm_ber = ldap_alloc_ber_with_options( ld ))
441 break; /* return w/error*/
443 ldm->lm_msgid = msgid;
444 ldm->lm_msgtype = tag;
446 if ( tag == LDAP_RES_SEARCH_RESULT ) {
447 Debug( LDAP_DEBUG_TRACE, "cldap_parsemsg got search result\n",
450 if ( ber_get_stringal( ber, &bv ) == LBER_DEFAULT ) {
451 break; /* return w/error */
454 if ( ber_printf( ldm->lm_ber, "tO", tag, bv ) == -1 ) {
455 break; /* return w/error */
461 } else if ( tag == LDAP_RES_SEARCH_ENTRY ) {
462 if ( ber_scanf( ber, "{aO" /*}*/, &dn, &bv ) == LBER_ERROR ) {
463 break; /* return w/error */
465 Debug( LDAP_DEBUG_TRACE, "cldap_parsemsg entry %s\n", dn, 0, 0 );
466 if ( dn != NULL && *(dn + ( slen = strlen(dn)) - 1) == '*' &&
469 * substitute original searchbase for trailing '*'
471 if (( p = (char *)LDAP_MALLOC( slen + baselen )) == NULL ) {
474 break; /* return w/error */
477 strcpy( p + slen - 1, base );
482 if ( ber_printf( ldm->lm_ber, "t{so}", tag, dn, bv->bv_val,
483 bv->bv_len ) == -1 ) {
484 break; /* return w/error */
491 } else if ( tag == LDAP_RES_SEARCH_REFERENCE ) {
494 Debug( LDAP_DEBUG_TRACE, "cldap_parsemsg got unknown tag %lu\n",
496 rc = LDAP_DECODING_ERROR;
497 break; /* return w/error */
500 /* Reset message ber so we can read from it later. Gack! */
501 ldm->lm_ber->ber_end = ldm->lm_ber->ber_ptr;
502 ldm->lm_ber->ber_ptr = ldm->lm_ber->ber_buf;
505 if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
506 fprintf( stderr, "cldap_parsemsg add message id %ld type %ld:\n",
507 (long) ldm->lm_msgid, (long) ldm->lm_msgtype );
508 ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ldm->lm_ber, 1 );
510 #endif /* LDAP_DEBUG */
513 if ( ld->ld_cache != NULL ) {
514 ldap_add_result_to_cache( ld, ldm );
516 #endif /* LDAP_NOCACHE */
518 if ( chain == NULL ) {
521 prev->lm_chain = ldm;
527 /* dispose of any leftovers */
529 if ( ldm->lm_ber != NULL ) {
530 ber_free( ldm->lm_ber, 1 );
538 /* return chain, calling result2error if we got anything at all */
540 return(( *res == NULL ) ? rc : ldap_result2error( ld, *res, 0 ));
542 #endif /* LDAP_CONNECTIONLESS */