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_VERSION;
 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, id, fromaddr, i;
 283     struct timeval      tv;
 284
 285     fromaddr = -1;
 286
 287     if ( crip->cri_try == 0 ) {
 288         crip->cri_maxtries = ld->ld_cldaptries * ld->ld_cldapnaddr;
 289         crip->cri_timeout = ld->ld_cldaptimeout;
 290         crip->cri_useaddr = 0;
 291         Debug( LDAP_DEBUG_TRACE, "cldap_result tries %d timeout %d\n",
 292                 ld->ld_cldaptries, ld->ld_cldaptimeout, 0 );
 293     }
 294
 295     if ((tv.tv_sec = crip->cri_timeout / ld->ld_cldapnaddr) < 1 ) {
 296         tv.tv_sec = 1;
 297     }
 298     tv.tv_usec = 0;
 299
 300     Debug( LDAP_DEBUG_TRACE,
 301             "cldap_result waiting up to %ld seconds for a response\n",
 302             (long) tv.tv_sec, 0, 0 );
 303     ber_init_w_nullc( &ber, 0 );
 304     ldap_set_ber_options( ld, &ber );
 305
 306     if ( cldap_getmsg( ld, &tv, &ber ) == -1 ) {
 307         ret = ld->ld_errno;
 308         Debug( LDAP_DEBUG_TRACE, "cldap_getmsg returned -1 (%d)\n",
 309                 ret, 0, 0 );
 310     } else if ( ld->ld_errno == LDAP_TIMEOUT ) {
 311         Debug( LDAP_DEBUG_TRACE,
 312             "cldap_result timed out\n", 0, 0, 0 );
 313         /*
 314          * It timed out; is it time to give up?
 315          */
 316         if ( ++crip->cri_try >= crip->cri_maxtries ) {
 317             ret = LDAP_TIMEOUT;
 318             --crip->cri_try;
 319         } else {
 320             if ( ++crip->cri_useaddr >= ld->ld_cldapnaddr ) {
 321                 /*
 322                  * new round: reset address to first one and
 323                  * double the timeout
 324                  */
 325                 crip->cri_useaddr = 0;
 326                 crip->cri_timeout <<= 1;
 327             }
 328             ret = -1;
 329         }
 330
 331     } else {
 332         /*
 333          * Got a response.  It should look like:
 334          * { msgid, logdn, { searchresponse...}}
 335          */
 336         logdn = NULL;
 337
 338         if ( ber_scanf( &ber, "ia", &id, &logdn ) == LBER_ERROR ) {
 339             LDAP_FREE( ber.ber_buf );   /* gack! */
 340             ret = LDAP_DECODING_ERROR;
 341             Debug( LDAP_DEBUG_TRACE,
 342                     "cldap_result: ber_scanf returned LBER_ERROR (%d)\n",
 343                     ret, 0, 0 );
 344         } else if ( id != msgid ) {
 345             LDAP_FREE( ber.ber_buf );   /* gack! */
 346             Debug( LDAP_DEBUG_TRACE,
 347                     "cldap_result: looking for msgid %d; got %d\n",
 348                     msgid, id, 0 );
 349             ret = -1;   /* ignore and keep looking */
 350         } else {
 351             struct sockaddr_in * src;
 352             /*
 353              * got a result: determine which server it came from
 354              * decode into ldap message chain
 355              */
 356             src = (struct sockaddr_in *) ber_pvt_sb_udp_get_src( sb );
 357
 358             for ( fromaddr = 0; fromaddr < ld->ld_cldapnaddr; ++fromaddr ) {
 359                     if ( memcmp( &((struct sockaddr_in *)
 360                             ld->ld_cldapaddrs[ fromaddr ])->sin_addr,
 361                             &(src->sin_addr),
 362                             sizeof( struct in_addr )) == 0 ) {
 363                         break;
 364                     }
 365             }
 366             ret = cldap_parsemsg( ld, msgid, &ber, res, base );
 367             LDAP_FREE( ber.ber_buf );   /* gack! */
 368             Debug( LDAP_DEBUG_TRACE,
 369                 "cldap_result got result (%d)\n", ret, 0, 0 );
 370         }
 371
 372         if ( logdn != NULL ) {
 373                 LDAP_FREE( logdn );
 374         }
 375     }
 376
 377
 378     /*
 379      * If we are giving up (successfully or otherwise) then
 380      * abandon any outstanding requests.
 381      */
 382     if ( ret != -1 ) {
 383         i = crip->cri_try;
 384         if ( i >= ld->ld_cldapnaddr ) {
 385             i = ld->ld_cldapnaddr - 1;
 386         }
 387
 388         for ( ; i >= 0; --i ) {
 389             if ( i == fromaddr ) {
 390                 continue;
 391             }
 392             ber_pvt_sb_udp_set_dst( sb, ld->ld_cldapaddrs[i] );
 393
 394             Debug( LDAP_DEBUG_TRACE, "cldap_result abandoning id %d (to %s)\n",
 395                 msgid, inet_ntoa( ((struct sockaddr_in *)
 396                 ld->ld_cldapaddrs[i])->sin_addr ), 0 );
 397             (void) ldap_abandon( ld, msgid );
 398         }
 399     }
 400
 401     return( ld->ld_errno = ret );
 402 }
 403
 404
 405 static int
 406 cldap_parsemsg( LDAP *ld, int msgid, BerElement *ber,
 407         LDAPMessage **res, char *base )
 408 {
 409     unsigned long       tag, len;
 410     int                 baselen, slen, rc;
 411     char                *dn, *p, *cookie;
 412     LDAPMessage         *chain, *prev, *ldm;
 413     struct berval       *bv;
 414
 415     rc = LDAP_DECODING_ERROR;   /* pessimistic */
 416     ldm = chain = prev = NULLMSG;
 417     baselen = ( base == NULL ) ? 0 : strlen( base );
 418     bv = NULL;
 419
 420     for ( tag = ber_first_element( ber, &len, &cookie );
 421             tag != LBER_DEFAULT && rc != LDAP_SUCCESS;
 422             tag = ber_next_element( ber, &len, cookie )) {
 423         if (( ldm = (LDAPMessage *)LDAP_CALLOC( 1, sizeof(LDAPMessage)))
 424                 == NULL || ( ldm->lm_ber = ldap_alloc_ber_with_options( ld ))
 425                 == NULLBER ) {
 426             rc = LDAP_NO_MEMORY;
 427             break;      /* return w/error*/
 428         }
 429         ldm->lm_msgid = msgid;
 430         ldm->lm_msgtype = tag;
 431
 432         if ( tag == LDAP_RES_SEARCH_RESULT ) {
 433             Debug( LDAP_DEBUG_TRACE, "cldap_parsemsg got search result\n",
 434                     0, 0, 0 );
 435
 436             if ( ber_get_stringal( ber, &bv ) == LBER_DEFAULT ) {
 437                 break;  /* return w/error */
 438             }
 439
 440             if ( ber_printf( ldm->lm_ber, "to", tag, bv->bv_val,
 441                     bv->bv_len ) == -1 ) {
 442                 break;  /* return w/error */
 443             }
 444             ber_bvfree( bv );
 445             bv = NULL;
 446             rc = LDAP_SUCCESS;
 447
 448         } else if ( tag == LDAP_RES_SEARCH_ENTRY ) {
 449             if ( ber_scanf( ber, "{aO", &dn, &bv ) == LBER_ERROR ) {
 450                 break;  /* return w/error */
 451             }
 452             Debug( LDAP_DEBUG_TRACE, "cldap_parsemsg entry %s\n", dn, 0, 0 );
 453             if ( dn != NULL && *(dn + ( slen = strlen(dn)) - 1) == '*' &&
 454                     baselen > 0 ) {
 455                 /*
 456                  * substitute original searchbase for trailing '*'
 457                  */
 458                 if (( p = (char *)LDAP_MALLOC( slen + baselen )) == NULL ) {
 459                     rc = LDAP_NO_MEMORY;
 460                     LDAP_FREE( dn );
 461                     break;      /* return w/error */
 462                 }
 463                 strcpy( p, dn );
 464                 strcpy( p + slen - 1, base );
 465                 LDAP_FREE( dn );
 466                 dn = p;
 467             }
 468
 469             if ( ber_printf( ldm->lm_ber, "t{so}", tag, dn, bv->bv_val,
 470                     bv->bv_len ) == -1 ) {
 471                 break;  /* return w/error */
 472             }
 473             LDAP_FREE( dn );
 474             ber_bvfree( bv );
 475             bv = NULL;
 476
 477 #ifdef notyet
 478         } else if ( tag == LDAP_RES_SEARCH_REFERENCE ) {
 479 #endif
 480         } else {
 481             Debug( LDAP_DEBUG_TRACE, "cldap_parsemsg got unknown tag %lu\n",
 482                     tag, 0, 0 );
 483             rc = LDAP_PROTOCOL_ERROR;
 484             break;      /* return w/error */
 485         }
 486
 487         /* Reset message ber so we can read from it later.  Gack! */
 488         ldm->lm_ber->ber_end = ldm->lm_ber->ber_ptr;
 489         ldm->lm_ber->ber_ptr = ldm->lm_ber->ber_buf;
 490
 491 #ifdef LDAP_DEBUG
 492         if ( ldap_debug & LDAP_DEBUG_PACKETS ) {
 493             fprintf( stderr, "cldap_parsemsg add message id %d type %d:\n",
 494                     ldm->lm_msgid, ldm->lm_msgtype  );
 495             ber_log_dump( LDAP_DEBUG_BER, ldap_debug, ldm->lm_ber, 1 );
 496         }
 497 #endif /* LDAP_DEBUG */
 498
 499 #ifndef LDAP_NOCACHE
 500             if ( ld->ld_cache != NULL ) {
 501                 ldap_add_result_to_cache( ld, ldm );
 502             }
 503 #endif /* LDAP_NOCACHE */
 504
 505         if ( chain == NULL ) {
 506             chain = ldm;
 507         } else {
 508             prev->lm_chain = ldm;
 509         }
 510         prev = ldm;
 511         ldm = NULL;
 512     }
 513
 514     /* dispose of any leftovers */
 515     if ( ldm != NULL ) {
 516         if ( ldm->lm_ber != NULLBER ) {
 517             ber_free( ldm->lm_ber, 1 );
 518         }
 519         LDAP_FREE( ldm );
 520     }
 521     if ( bv != NULL ) {
 522         ber_bvfree( bv );
 523     }
 524
 525     /* return chain, calling result2error if we got anything at all */
 526     *res = chain;
 527     return(( *res == NULLMSG ) ? rc : ldap_result2error( ld, *res, 0 ));
 528 }
 529 #endif /* LDAP_CONNECTIONLESS */