git.sur5r.net Git - openldap/blob - libraries/libldap/cldap.c

   1 /*
   2  * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
   3  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   4  */
   5 /*  Portions
   6  *  Copyright (c) 1990, 1994 Regents of the University of Michigan.
   7  *  All rights reserved.
   8  *
   9  *  cldap.c - synchronous, retrying interface to the cldap protocol
  10  */
  11
  12 #include "portable.h"
  13
  14 #ifdef LDAP_CONNECTIONLESS
  15
  16 #include <stdio.h>
  17 #include <stdlib.h>
  18
  19 #include <ac/errno.h>
  20 #include <ac/socket.h>
  21 #include <ac/string.h>
  22 #include <ac/time.h>
  23 #include <ac/unistd.h>
  24
  25 #include "ldap-int.h"
  26
  27 #define DEF_CLDAP_TIMEOUT       3
  28 #define DEF_CLDAP_TRIES         4
  29
  30
  31 struct cldap_retinfo {
  32         int             cri_maxtries;
  33         int             cri_try;
  34         int             cri_useaddr;
  35         long            cri_timeout;
  36 };
  37
  38 static int add_addr LDAP_P((
  39         LDAP *ld, struct sockaddr *sap ));
  40 static int cldap_result LDAP_P((
  41         LDAP *ld, int msgid, LDAPMessage **res,
  42         struct cldap_retinfo *crip, char *base ));
  43 static int cldap_parsemsg LDAP_P((
  44         LDAP *ld, int msgid, BerElement *ber,
  45         LDAPMessage **res, char *base ));
  46
  47 /*
  48  * cldap_open - initialize and connect to an ldap server.  A magic cookie to
  49  * be used for future communication is returned on success, NULL on failure.
  50  *
  51  * Example:
  52  *      LDAP    *ld;
  53  *      ld = cldap_open( hostname, port );
  54  */
  55
  56 LDAP *
  57 cldap_open( char *host, int port )
  58 {
  59     int                 s;
  60     unsigned long       address;
  61     struct sockaddr_in  sock;
  62     struct hostent      *hp;
  63     LDAP                *ld;
  64     char                *p;
  65     int                 i;
  66
  67     /* buffers for ldap_pvt_gethostbyname_a ... */
  68     struct hostent      he_buf;
  69     int                 local_h_errno;
  70     char                *ha_buf=NULL;
  71
  72 #define DO_RETURN(x) if (ha_buf) LDAP_FREE(ha_buf); return (x);
  73
  74     Debug( LDAP_DEBUG_TRACE, "ldap_open\n", 0, 0, 0 );
  75
  76     if ( (s = socket( AF_INET, SOCK_DGRAM, 0 )) < 0 ) {
  77         return( NULL );
  78     }
  79
  80     sock.sin_addr.s_addr = 0;
  81     sock.sin_family = AF_INET;
  82     sock.sin_port = 0;
  83     if ( bind(s, (struct sockaddr *) &sock, sizeof(sock)) < 0)  {
  84         tcp_close( s );
  85         return( NULL );
  86     }
  87     if (( ld = ldap_init( host, port )) == NULL ) {
  88         tcp_close( s );
  89         return( NULL );
  90     }
  91
  92     ld->ld_cldapnaddr = 0;
  93     ld->ld_cldapaddrs = NULL;
  94
  95     if (ber_pvt_sb_set_io( &(ld->ld_sb), &ber_pvt_sb_io_udp, NULL )<0) {
  96        ldap_ld_free(ld, 1 );
  97        return NULL;
  98     }
  99
 100     ld->ld_version = LDAP_VERSION;
 101
 102     sock.sin_family = AF_INET;
 103     sock.sin_port = htons( port );
 104
 105     /*
 106      * 'host' may be a space-separated list.
 107      */
 108     if ( host != NULL ) {
 109         for ( ; host != NULL; host = p ) {
 110             if (( p = strchr( host, ' ' )) != NULL ) {
 111                 for (*p++ = '\0'; *p == ' '; p++) {
 112                     ;
 113                 }
 114             }
 115
 116             address = inet_addr( host );
 117             /* This was just a test for -1 until OSF1 let inet_addr return
 118                unsigned int, which is narrower than 'unsigned long address' */
 119             if ( address == 0xffffffff || address == (unsigned long) -1 ) {
 120                 if ((ldap_pvt_gethostbyname_a( host, &he_buf, &ha_buf,
 121                                               &hp,&local_h_errno)<0) ||
 122                     (hp==NULL)) {
 123                    errno = EHOSTUNREACH;
 124                    continue;
 125                 }
 126
 127                 for ( i = 0; hp->h_addr_list[ i ] != 0; ++i ) {
 128                     SAFEMEMCPY( (char *)&sock.sin_addr.s_addr,
 129                             (char *)hp->h_addr_list[ i ],
 130                             sizeof(sock.sin_addr.s_addr));
 131                     if ( add_addr( ld, (struct sockaddr *)&sock ) < 0 ) {
 132                         ldap_ld_free( ld, 1 );
 133                         DO_RETURN( NULL );
 134                     }
 135                 }
 136
 137             } else {
 138                 sock.sin_addr.s_addr = address;
 139                 if ( add_addr( ld, (struct sockaddr *)&sock ) < 0 ) {
 140                     ldap_ld_free( ld, 1 );
 141                     DO_RETURN( NULL );
 142                 }
 143             }
 144
 145             if ( ld->ld_host == NULL ) {
 146                     ld->ld_host = LDAP_STRDUP( host );
 147             }
 148         }
 149     } else {
 150         address = INADDR_LOOPBACK;
 151         sock.sin_addr.s_addr = htonl( address );
 152         if ( add_addr( ld, (struct sockaddr *)&sock ) < 0 ) {
 153             ldap_ld_free( ld, 1 );
 154             DO_RETURN( NULL );
 155         }
 156     }
 157
 158     if ( ld->ld_cldapaddrs == NULL
 159             || ( ld->ld_defconn = ldap_new_connection( ld, NULL, 1,0,0 )) == NULL
 160             ) {
 161         ldap_ld_free( ld, 0 );
 162         DO_RETURN( NULL );
 163     }
 164
 165     ber_pvt_sb_udp_set_dst( &ld->ld_sb, ld->ld_cldapaddrs[0] );
 166
 167     cldap_setretryinfo( ld, 0, 0 );
 168
 169 #ifdef LDAP_DEBUG
 170     putchar( '\n' );
 171     for ( i = 0; i < ld->ld_cldapnaddr; ++i ) {
 172         Debug( LDAP_DEBUG_TRACE, "end of cldap_open address %d is %s\n",
 173                 i, inet_ntoa( ((struct sockaddr_in *)
 174                 ld->ld_cldapaddrs[ i ])->sin_addr ), 0 );
 175     }
 176 #endif
 177
 178     DO_RETURN( ld );
 179 }
 180
 181 #undef DO_RETURN
 182
 183 void
 184 cldap_close( LDAP *ld )
 185 {
 186         ldap_ld_free( ld, 0 );
 187 }
 188
 189
 190 void
 191 cldap_setretryinfo( LDAP *ld, int tries, int timeout )
 192 {
 193     ld->ld_cldaptries = ( tries <= 0 ) ? DEF_CLDAP_TRIES : tries;
 194     ld->ld_cldaptimeout = ( timeout <= 0 ) ? DEF_CLDAP_TIMEOUT : timeout;
 195 }
 196
 197
 198 int
 199 cldap_search_s( LDAP *ld, char *base, int scope, char *filter, char **attrs,
 200         int attrsonly, LDAPMessage **res, char *logdn )
 201 {
 202     int                         ret, msgid;
 203     struct cldap_retinfo        cri;
 204
 205     *res = NULLMSG;
 206
 207     (void) memset( &cri, 0, sizeof( cri ));
 208
 209     if ( logdn != NULL ) {
 210         ld->ld_cldapdn = logdn;
 211     } else if ( ld->ld_cldapdn == NULL ) {
 212         ld->ld_cldapdn = "";
 213     }
 214
 215     do {
 216         if ( cri.cri_try != 0 ) {
 217                 --ld->ld_msgid; /* use same id as before */
 218         }
 219
 220         ber_pvt_sb_udp_set_dst( &(ld->ld_sb),
 221                         ld->ld_cldapaddrs[ cri.cri_useaddr ] );
 222
 223         Debug( LDAP_DEBUG_TRACE, "cldap_search_s try %d (to %s)\n",
 224             cri.cri_try, inet_ntoa( ((struct sockaddr_in *)
 225             ld->ld_cldapaddrs[ cri.cri_useaddr ])->sin_addr), 0 );
 226
 227             if ( (msgid = ldap_search( ld, base, scope, filter, attrs,
 228                 attrsonly )) == -1 ) {
 229                     return( ld->ld_errno );
 230             }
 231 #ifndef LDAP_NOCACHE
 232             if ( ld->ld_cache != NULL && ld->ld_responses != NULL ) {
 233                 Debug( LDAP_DEBUG_TRACE, "cldap_search_s res from cache\n",
 234                         0, 0, 0 );
 235                 *res = ld->ld_responses;
 236                 ld->ld_responses = ld->ld_responses->lm_next;
 237                 return( ldap_result2error( ld, *res, 0 ));
 238             }
 239 #endif /* LDAP_NOCACHE */
 240             ret = cldap_result( ld, msgid, res, &cri, base );
 241         } while (ret == -1);
 242
 243         return( ret );
 244 }
 245
 246
 247 static int
 248 add_addr( LDAP *ld, struct sockaddr *sap )
 249 {
 250     struct sockaddr     *newsap, **addrs;
 251
 252     if (( newsap = (struct sockaddr *)LDAP_MALLOC( sizeof( struct sockaddr )))
 253             == NULL ) {
 254         ld->ld_errno = LDAP_NO_MEMORY;
 255         return( -1 );
 256     }
 257
 258         addrs = (struct sockaddr **)LDAP_REALLOC( ld->ld_cldapaddrs,
 259                 ( ld->ld_cldapnaddr + 1 ) * sizeof(struct sockaddr *));
 260
 261     if ( addrs == NULL ) {
 262         LDAP_FREE( newsap );
 263         ld->ld_errno = LDAP_NO_MEMORY;
 264         return( -1 );
 265     }
 266
 267     SAFEMEMCPY( (char *)newsap, (char *)sap, sizeof( struct sockaddr ));
 268     addrs[ ld->ld_cldapnaddr++ ] = newsap;
 269     ld->ld_cldapaddrs = (void **)addrs;
 270     return( 0 );
 271 }
 272
 273
 274 static int
 275 cldap_result( LDAP *ld, int msgid, LDAPMessage **res,
 276         struct cldap_retinfo *crip, char *base )
 277 {
 278     Sockbuf             *sb = &ld->ld_sb;
 279     BerElement          ber;
 280     char                *logdn;
 281     int                 ret, id, fromaddr, i;
 282     struct timeval      tv;
 283
 284     fromaddr = -1;
 285
 286     if ( crip->cri_try == 0 ) {
 287         crip->cri_maxtries = ld->ld_cldaptries * ld->ld_cldapnaddr;
 288         crip->cri_timeout = ld->ld_cldaptimeout;
 289         crip->cri_useaddr = 0;
 290         Debug( LDAP_DEBUG_TRACE, "cldap_result tries %d timeout %d\n",
 291                 ld->ld_cldaptries, ld->ld_cldaptimeout, 0 );
 292     }
 293
 294     if ((tv.tv_sec = crip->cri_timeout / ld->ld_cldapnaddr) < 1 ) {
 295         tv.tv_sec = 1;
 296     }
 297     tv.tv_usec = 0;
 298
 299     Debug( LDAP_DEBUG_TRACE,
 300             "cldap_result waiting up to %ld seconds for a response\n",
 301             (long) tv.tv_sec, 0, 0 );
 302     ber_init_w_nullc( &ber, 0 );
 303     ldap_set_ber_options( ld, &ber );
 304
 305     if ( cldap_getmsg( ld, &tv, &ber ) == -1 ) {
 306         ret = ld->ld_errno;
 307         Debug( LDAP_DEBUG_TRACE, "cldap_getmsg returned -1 (%d)\n",
 308                 ret, 0, 0 );
 309     } else if ( ld->ld_errno == LDAP_TIMEOUT ) {
 310         Debug( LDAP_DEBUG_TRACE,
 311             "cldap_result timed out\n", 0, 0, 0 );
 312         /*
 313          * It timed out; is it time to give up?
 314          */
 315         if ( ++crip->cri_try >= crip->cri_maxtries ) {
 316             ret = LDAP_TIMEOUT;
 317             --crip->cri_try;
 318         } else {
 319             if ( ++crip->cri_useaddr >= ld->ld_cldapnaddr ) {
 320                 /*
 321                  * new round: reset address to first one and
 322                  * double the timeout
 323                  */
 324                 crip->cri_useaddr = 0;
 325                 crip->cri_timeout <<= 1;
 326             }
 327             ret = -1;
 328         }
 329
 330     } else {
 331         /*
 332          * Got a response.  It should look like:
 333          * { msgid, logdn, { searchresponse...}}
 334          */
 335         logdn = NULL;
 336
 337         if ( ber_scanf( &ber, "ia", &id, &logdn ) == LBER_ERROR ) {
 338             LDAP_FREE( ber.ber_buf );   /* gack! */
 339             ret = LDAP_DECODING_ERROR;
 340             Debug( LDAP_DEBUG_TRACE,
 341                     "cldap_result: ber_scanf returned LBER_ERROR (%d)\n",
 342                     ret, 0, 0 );
 343         } else if ( id != msgid ) {
 344             LDAP_FREE( ber.ber_buf );   /* gack! */
 345             Debug( LDAP_DEBUG_TRACE,
 346                     "cldap_result: looking for msgid %d; got %d\n",
 347                     msgid, id, 0 );
 348             ret = -1;   /* ignore and keep looking */
 349         } else {
 350             struct sockaddr_in * src;
 351             /*
 352              * got a result: determine which server it came from
 353              * decode into ldap message chain
 354              */
 355             src = (struct sockaddr_in *) ber_pvt_sb_udp_get_src( sb );
 356
 357             for ( fromaddr = 0; fromaddr < ld->ld_cldapnaddr; ++fromaddr ) {
 358                     if ( memcmp( &((struct sockaddr_in *)
 359                             ld->ld_cldapaddrs[ fromaddr ])->sin_addr,
 360                             &(src->sin_addr),
 361                             sizeof( struct in_addr )) == 0 ) {
 362                         break;
 363                     }
 364             }
 365             ret = cldap_parsemsg( ld, msgid, &ber, res, base );
 366             LDAP_FREE( ber.ber_buf );   /* gack! */
 367             Debug( LDAP_DEBUG_TRACE,
 368                 "cldap_result got result (%d)\n", ret, 0, 0 );
 369         }
 370
 371         if ( logdn != NULL ) {
 372                 LDAP_FREE( logdn );
 373         }
 374     }
 375
 376
 377     /*
 378      * If we are giving up (successfully or otherwise) then
 379      * abandon any outstanding requests.
 380      */
 381     if ( ret != -1 ) {
 382         i = crip->cri_try;
 383         if ( i >= ld->ld_cldapnaddr ) {
 384             i = ld->ld_cldapnaddr - 1;
 385         }
 386
 387         for ( ; i >= 0; --i ) {
 388             if ( i == fromaddr ) {
 389                 continue;
 390             }
 391             ber_pvt_sb_udp_set_dst( sb, ld->ld_cldapaddrs[i] );
 392
 393             Debug( LDAP_DEBUG_TRACE, "cldap_result abandoning id %d (to %s)\n",
 394                 msgid, inet_ntoa( ((struct sockaddr_in *)
 395                 ld->ld_cldapaddrs[i])->sin_addr ), 0 );
 396             (void) ldap_abandon( ld, msgid );
 397         }
 398     }
 399
 400     return( ld->ld_errno = ret );
 401 }
 402
 403
 404 static int
 405 cldap_parsemsg( LDAP *ld, int msgid, BerElement *ber,
 406         LDAPMessage **res, char *base )
 407 {
 408     unsigned long       tag, len;
 409     int                 baselen, slen, rc;
 410     char                *dn, *p, *cookie;
 411     LDAPMessage         *chain, *prev, *ldm;
 412     struct berval       *bv;
 413
 414     rc = LDAP_DECODING_ERROR;   /* pessimistic */
 415     ldm = chain = prev = NULLMSG;
 416     baselen = ( base == NULL ) ? 0 : strlen( base );
 417     bv = NULL;
 418
 419     for ( tag = ber_first_element( ber, &len, &cookie );
 420             tag != LBER_DEFAULT && rc != LDAP_SUCCESS;
 421             tag = ber_next_element( ber, &len, cookie )) {
 422         if (( ldm = (LDAPMessage *)LDAP_CALLOC( 1, sizeof(LDAPMessage)))
 423                 == NULL || ( ldm->lm_ber = ldap_alloc_ber_with_options( ld ))
 424                 == NULLBER ) {
 425             rc = LDAP_NO_MEMORY;
 426             break;      /* return w/error*/
 427         }
 428         ldm->lm_msgid = msgid;
 429         ldm->lm_msgtype = tag;
 430
 431         if ( tag == LDAP_RES_SEARCH_RESULT ) {
 432             Debug( LDAP_DEBUG_TRACE, "cldap_parsemsg got search result\n",
 433                     0, 0, 0 );
 434
 435             if ( ber_get_stringal( ber, &bv ) == LBER_DEFAULT ) {
 436                 break;  /* return w/error */
 437             }
 438
 439             if ( ber_printf( ldm->lm_ber, "to", tag, bv->bv_val,
 440                     bv->bv_len ) == -1 ) {
 441                 break;  /* return w/error */
 442             }
 443             ber_bvfree( bv );
 444             bv = NULL;
 445             rc = LDAP_SUCCESS;
 446
 447         } else if ( tag == LDAP_RES_SEARCH_ENTRY ) {
 448             if ( ber_scanf( ber, "{aO", &dn, &bv ) == LBER_ERROR ) {
 449                 break;  /* return w/error */
 450             }
 451             Debug( LDAP_DEBUG_TRACE, "cldap_parsemsg entry %s\n", dn, 0, 0 );
 452             if ( dn != NULL && *(dn + ( slen = strlen(dn)) - 1) == '*' &&
 453                     baselen > 0 ) {
 454                 /*
 455                  * substitute original searchbase for trailing '*'
 456                  */
 457                 if (( p = (char *)LDAP_MALLOC( slen + baselen )) == NULL ) {
 458                     rc = LDAP_NO_MEMORY;
 459                     LDAP_FREE( dn );
 460                     break;      /* return w/error */
 461                 }
 462                 strcpy( p, dn );
 463                 strcpy( p + slen - 1, base );
 464                 LDAP_FREE( dn );
 465                 dn = p;
 466             }
 467
 468             if ( ber_printf( ldm->lm_ber, "t{so}", tag, dn, bv->bv_val,
 469                     bv->bv_len ) == -1 ) {
 470                 break;  /* return w/error */
 471             }
 472             LDAP_FREE( dn );
 473             ber_bvfree( bv );
 474             bv = NULL;
 475
 476 #ifdef notyet
 477         } else if ( tag == LDAP_RES_SEARCH_REFERENCE ) {
 478 #endif
 479         } else {
 480             Debug( LDAP_DEBUG_TRACE, "cldap_parsemsg got unknown tag %lu\n",
 481                     tag, 0, 0 );
 482             rc = LDAP_PROTOCOL_ERROR;
 483             break;      /* return w/error */
 484         }
 485
 486         /* Reset message ber so we can read from it later.  Gack! */
 487         ldm->lm_ber->ber_end = ldm->lm_ber->ber_ptr;
 488         ldm->lm_ber->ber_ptr = ldm->lm_ber->ber_buf;
 489
 490 #ifdef LDAP_DEBUG
 491         if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
 492             fprintf( stderr, "cldap_parsemsg add message id %d type %d:\n",
 493                     ldm->lm_msgid, ldm->lm_msgtype  );
 494             ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ldm->lm_ber, 1 );
 495         }
 496 #endif /* LDAP_DEBUG */
 497
 498 #ifndef LDAP_NOCACHE
 499             if ( ld->ld_cache != NULL ) {
 500                 ldap_add_result_to_cache( ld, ldm );
 501             }
 502 #endif /* LDAP_NOCACHE */
 503
 504         if ( chain == NULL ) {
 505             chain = ldm;
 506         } else {
 507             prev->lm_chain = ldm;
 508         }
 509         prev = ldm;
 510         ldm = NULL;
 511     }
 512
 513     /* dispose of any leftovers */
 514     if ( ldm != NULL ) {
 515         if ( ldm->lm_ber != NULLBER ) {
 516             ber_free( ldm->lm_ber, 1 );
 517         }
 518         LDAP_FREE( ldm );
 519     }
 520     if ( bv != NULL ) {
 521         ber_bvfree( bv );
 522     }
 523
 524     /* return chain, calling result2error if we got anything at all */
 525     *res = chain;
 526     return(( *res == NULLMSG ) ? rc : ldap_result2error( ld, *res, 0 ));
 527 }
 528 #endif /* LDAP_CONNECTIONLESS */