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