git.sur5r.net Git - openldap/blob - libraries/liblber/io.c

   1 /* io.c - ber general i/o routines */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved.
   5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   6  */
   7 /* Portions
   8  * Copyright (c) 1990 Regents of the University of Michigan.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms are permitted
  12  * provided that this notice is preserved and that due credit is given
  13  * to the University of Michigan at Ann Arbor. The name of the University
  14  * may not be used to endorse or promote products derived from this
  15  * software without specific prior written permission. This software
  16  * is provided ``as is'' without express or implied warranty.
  17  */
  18
  19 #include "portable.h"
  20
  21 #include <stdio.h>
  22
  23 #include <ac/stdlib.h>
  24
  25 #include <ac/ctype.h>
  26 #include <ac/errno.h>
  27 #include <ac/socket.h>
  28 #include <ac/string.h>
  29 #include <ac/unistd.h>
  30
  31 #ifdef HAVE_IO_H
  32 #include <io.h>
  33 #endif
  34
  35 #include "lber-int.h"
  36 #include "ldap_log.h"
  37
  38 ber_slen_t
  39 ber_read(
  40         BerElement *ber,
  41         char *buf,
  42         ber_len_t len )
  43 {
  44         ber_len_t       actuallen, nleft;
  45
  46         assert( ber != NULL );
  47         assert( buf != NULL );
  48
  49         assert( LBER_VALID( ber ) );
  50
  51         nleft = ber_pvt_ber_remaining( ber );
  52         actuallen = nleft < len ? nleft : len;
  53
  54         AC_MEMCPY( buf, ber->ber_ptr, actuallen );
  55
  56         ber->ber_ptr += actuallen;
  57
  58         return( (ber_slen_t) actuallen );
  59 }
  60
  61 ber_slen_t
  62 ber_write(
  63         BerElement *ber,
  64         LDAP_CONST char *buf,
  65         ber_len_t len,
  66         int nosos )
  67 {
  68         assert( ber != NULL );
  69         assert( buf != NULL );
  70
  71         assert( LBER_VALID( ber ) );
  72
  73         if ( nosos || ber->ber_sos == NULL ) {
  74                 if ( ber->ber_ptr + len > ber->ber_end ) {
  75                         if ( ber_realloc( ber, len ) != 0 )
  76                                 return( -1 );
  77                 }
  78                 AC_MEMCPY( ber->ber_ptr, buf, (size_t)len );
  79                 ber->ber_ptr += len;
  80                 return( (ber_slen_t) len );
  81
  82         } else {
  83                 if ( ber->ber_sos->sos_ptr + len > ber->ber_end ) {
  84                         if ( ber_realloc( ber, len ) != 0 )
  85                                 return( -1 );
  86                 }
  87                 AC_MEMCPY( ber->ber_sos->sos_ptr, buf, (size_t)len );
  88                 ber->ber_sos->sos_ptr += len;
  89                 ber->ber_sos->sos_clen += len;
  90                 return( (ber_slen_t) len );
  91         }
  92 }
  93
  94 int
  95 ber_realloc( BerElement *ber, ber_len_t len )
  96 {
  97         ber_len_t       total;
  98         Seqorset        *s;
  99         long            off;
 100         char            *oldbuf;
 101
 102         assert( ber != NULL );
 103         assert( len > 0 );
 104         assert( LBER_VALID( ber ) );
 105
 106         total = ber_pvt_ber_total( ber );
 107
 108 #define LBER_EXBUFSIZ   1000 /* a few words less than 2^N for binary buddy */
 109 #if defined( LBER_EXBUFSIZ ) && LBER_EXBUFSIZ > 0
 110 # ifndef notdef
 111         /* don't realloc by small amounts */
 112         total += len < LBER_EXBUFSIZ ? LBER_EXBUFSIZ : len;
 113 # else
 114         {       /* not sure what value this adds */
 115                 ber_len_t have = (total + (LBER_EXBUFSIZE - 1)) / LBER_EXBUFSIZ;
 116                 ber_len_t need = (len + (LBER_EXBUFSIZ - 1)) / LBER_EXBUFSIZ;
 117                 total = ( have + need ) * LBER_EXBUFSIZ;
 118         }
 119 # endif
 120 #else
 121         total += len;   /* realloc just what's needed */
 122 #endif
 123
 124         oldbuf = ber->ber_buf;
 125
 126         ber->ber_buf = (char *) LBER_REALLOC( oldbuf, total );
 127
 128         if ( ber->ber_buf == NULL ) {
 129                 ber->ber_buf = oldbuf;
 130                 return( -1 );
 131         }
 132
 133         ber->ber_end = ber->ber_buf + total;
 134
 135         /*
 136          * If the stinking thing was moved, we need to go through and
 137          * reset all the sos and ber pointers.  Offsets would've been
 138          * a better idea... oh well.
 139          */
 140
 141         if ( ber->ber_buf != oldbuf ) {
 142                 ber->ber_ptr = ber->ber_buf + (ber->ber_ptr - oldbuf);
 143
 144                 for ( s = ber->ber_sos; s != NULL; s = s->sos_next ) {
 145                         off = s->sos_first - oldbuf;
 146                         s->sos_first = ber->ber_buf + off;
 147
 148                         off = s->sos_ptr - oldbuf;
 149                         s->sos_ptr = ber->ber_buf + off;
 150                 }
 151         }
 152
 153         return( 0 );
 154 }
 155
 156 void
 157 ber_free_buf( BerElement *ber )
 158 {
 159         Seqorset *s, *next;
 160
 161         assert( LBER_VALID( ber ) );
 162
 163         if ( ber->ber_buf) LBER_FREE( ber->ber_buf );
 164
 165         for( s = ber->ber_sos ; s != NULL ; s = next ) {
 166                 next = s->sos_next;
 167                 LBER_FREE( s );
 168         }
 169
 170         ber->ber_buf = NULL;
 171         ber->ber_sos = NULL;
 172         ber->ber_valid = LBER_UNINITIALIZED;
 173 }
 174
 175 void
 176 ber_free( BerElement *ber, int freebuf )
 177 {
 178 #ifdef LDAP_MEMORY_DEBUG
 179         assert( ber != NULL );
 180 #endif
 181
 182         if( ber == NULL ) {
 183                 return;
 184         }
 185
 186         if( freebuf )
 187                 ber_free_buf( ber );
 188
 189         LBER_FREE( (char *) ber );
 190 }
 191
 192 int
 193 ber_flush( Sockbuf *sb, BerElement *ber, int freeit )
 194 {
 195         ber_len_t       towrite;
 196         ber_slen_t      rc;
 197
 198         assert( sb != NULL );
 199         assert( ber != NULL );
 200
 201         assert( SOCKBUF_VALID( sb ) );
 202         assert( LBER_VALID( ber ) );
 203
 204         if ( ber->ber_rwptr == NULL ) {
 205                 ber->ber_rwptr = ber->ber_buf;
 206         }
 207         towrite = ber->ber_ptr - ber->ber_rwptr;
 208
 209         if ( sb->sb_debug ) {
 210 #ifdef NEW_LOGGING
 211                 LDAP_LOG( BER, DETAIL1,
 212                            "ber_flush: %ld bytes to sd %ld%s\n",
 213                            towrite, (long)sb->sb_fd,
 214                            ber->ber_rwptr != ber->ber_buf ? " (re-flush)" : "" );
 215
 216                 if(LDAP_LOGS_TEST(BER, DETAIL2))
 217                                 BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
 218
 219 #else
 220                 ber_log_printf( LDAP_DEBUG_ANY, sb->sb_debug,
 221                         "ber_flush: %ld bytes to sd %ld%s\n",
 222                         towrite, (long) sb->sb_fd,
 223                         ber->ber_rwptr != ber->ber_buf ?  " (re-flush)" : "" );
 224                 ber_log_bprint( LDAP_DEBUG_PACKETS, sb->sb_debug,
 225                         ber->ber_rwptr, towrite );
 226 #endif
 227         }
 228
 229         while ( towrite > 0 ) {
 230                 rc = ber_int_sb_write( sb, ber->ber_rwptr, towrite );
 231                 if (rc<=0) {
 232                         return -1;
 233                 }
 234                 towrite -= rc;
 235                 ber->ber_rwptr += rc;
 236         }
 237
 238         if ( freeit )
 239                 ber_free( ber, 1 );
 240
 241         return( 0 );
 242 }
 243
 244 BerElement *
 245 ber_alloc_t( int options )
 246 {
 247         BerElement      *ber;
 248
 249     ber_int_options.lbo_valid = LBER_INITIALIZED;
 250
 251         ber = (BerElement *) LBER_CALLOC( 1, sizeof(BerElement) );
 252
 253         if ( ber == NULL ) {
 254                 return NULL;
 255         }
 256
 257         ber->ber_valid = LBER_VALID_BERELEMENT;
 258         ber->ber_tag = LBER_DEFAULT;
 259         ber->ber_options = options;
 260         ber->ber_debug = ber_int_debug;
 261
 262         assert( LBER_VALID( ber ) );
 263         return ber;
 264 }
 265
 266 BerElement *
 267 ber_alloc( void )       /* deprecated */
 268 {
 269         return ber_alloc_t( 0 );
 270 }
 271
 272 BerElement *
 273 der_alloc( void )       /* deprecated */
 274 {
 275         return ber_alloc_t( LBER_USE_DER );
 276 }
 277
 278 BerElement *
 279 ber_dup( BerElement *ber )
 280 {
 281         BerElement      *new;
 282
 283         assert( ber != NULL );
 284         assert( LBER_VALID( ber ) );
 285
 286         if ( (new = ber_alloc_t( ber->ber_options )) == NULL ) {
 287                 return NULL;
 288         }
 289
 290         *new = *ber;
 291
 292         assert( LBER_VALID( new ) );
 293         return( new );
 294 }
 295
 296
 297 void
 298 ber_init2( BerElement *ber, struct berval *bv, int options )
 299 {
 300         assert( ber != NULL );
 301
 302         ber_int_options.lbo_valid = LBER_INITIALIZED;
 303
 304         (void) memset( (char *)ber, '\0', sizeof( BerElement ));
 305         ber->ber_valid = LBER_VALID_BERELEMENT;
 306         ber->ber_tag = LBER_DEFAULT;
 307         ber->ber_options = (char) options;
 308         ber->ber_debug = ber_int_debug;
 309
 310         if ( bv != NULL ) {
 311                 ber->ber_buf = bv->bv_val;
 312                 ber->ber_ptr = ber->ber_buf;
 313                 ber->ber_end = ber->ber_buf + bv->bv_len;
 314         }
 315
 316         assert( LBER_VALID( ber ) );
 317 }
 318
 319 /* OLD U-Mich ber_init() */
 320 void
 321 ber_init_w_nullc( BerElement *ber, int options )
 322 {
 323         ber_init2( ber, NULL, options );
 324 }
 325
 326 /* New C-API ber_init() */
 327 /* This function constructs a BerElement containing a copy
 328 ** of the data in the bv argument.
 329 */
 330 BerElement *
 331 ber_init( struct berval *bv )
 332 {
 333         BerElement *ber;
 334
 335         assert( bv != NULL );
 336
 337     ber_int_options.lbo_valid = LBER_INITIALIZED;
 338
 339         if ( bv == NULL ) {
 340                 return NULL;
 341         }
 342
 343         ber = ber_alloc_t( 0 );
 344
 345         if( ber == NULL ) {
 346                 /* allocation failed */
 347                 return NULL;
 348         }
 349
 350         /* copy the data */
 351         if ( ((ber_len_t) ber_write ( ber, bv->bv_val, bv->bv_len, 0 ))
 352                 != bv->bv_len )
 353         {
 354                 /* write failed, so free and return NULL */
 355                 ber_free( ber, 1 );
 356                 return NULL;
 357         }
 358
 359         ber_reset( ber, 1 );    /* reset the pointer to the start of the buffer */
 360         return ber;
 361 }
 362
 363 /* New C-API ber_flatten routine */
 364 /* This routine allocates a struct berval whose contents are a BER
 365 ** encoding taken from the ber argument.  The bvPtr pointer pointers to
 366 ** the returned berval.
 367 */
 368 int ber_flatten(
 369         BerElement *ber,
 370         struct berval **bvPtr)
 371 {
 372         struct berval *bv;
 373
 374         assert( bvPtr != NULL );
 375
 376     ber_int_options.lbo_valid = LBER_INITIALIZED;
 377
 378         if(bvPtr == NULL) {
 379                 return -1;
 380         }
 381
 382         bv = LBER_MALLOC( sizeof(struct berval) );
 383         if ( bv == NULL ) {
 384                 return -1;
 385         }
 386
 387         if ( ber == NULL ) {
 388                 /* ber is null, create an empty berval */
 389                 bv->bv_val = NULL;
 390                 bv->bv_len = 0;
 391
 392         } else {
 393                 /* copy the berval */
 394                 ber_len_t len = ber_pvt_ber_write( ber );
 395
 396                 bv->bv_val = (char *) LBER_MALLOC( len + 1 );
 397                 if ( bv->bv_val == NULL ) {
 398                         LBER_FREE( bv );
 399                         return -1;
 400                 }
 401
 402                 AC_MEMCPY( bv->bv_val, ber->ber_buf, len );
 403                 bv->bv_val[len] = '\0';
 404                 bv->bv_len = len;
 405         }
 406
 407         *bvPtr = bv;
 408         return 0;
 409 }
 410
 411 void
 412 ber_reset( BerElement *ber, int was_writing )
 413 {
 414         assert( ber != NULL );
 415         assert( LBER_VALID( ber ) );
 416
 417         if ( was_writing ) {
 418                 ber->ber_end = ber->ber_ptr;
 419                 ber->ber_ptr = ber->ber_buf;
 420
 421         } else {
 422                 ber->ber_ptr = ber->ber_end;
 423         }
 424
 425         ber->ber_rwptr = NULL;
 426 }
 427
 428 /*
 429  * A rewrite of ber_get_next that can safely be called multiple times
 430  * for the same packet. It will simply continue where it stopped until
 431  * a full packet is read.
 432  */
 433
 434 ber_tag_t
 435 ber_get_next(
 436         Sockbuf *sb,
 437         ber_len_t *len,
 438         BerElement *ber )
 439 {
 440         assert( sb != NULL );
 441         assert( len != NULL );
 442         assert( ber != NULL );
 443
 444         assert( SOCKBUF_VALID( sb ) );
 445         assert( LBER_VALID( ber ) );
 446
 447 #ifdef NEW_LOGGING
 448         LDAP_LOG( BER, ENTRY, "ber_get_next: enter\n", 0, 0, 0 );
 449 #else
 450         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
 451                 "ber_get_next\n" );
 452 #endif
 453
 454         /*
 455          * Any ber element looks like this: tag length contents.
 456          * Assuming everything's ok, we return the tag byte (we
 457          * can assume a single byte), return the length in len,
 458          * and the rest of the undecoded element in buf.
 459          *
 460          * Assumptions:
 461          *      1) small tags (less than 128)
 462          *      2) definite lengths
 463          *      3) primitive encodings used whenever possible
 464          */
 465
 466         if (ber->ber_rwptr == NULL) {
 467                 /* XXYYZ
 468                  * dtest does like this assert.
 469                  */
 470                 /* assert( ber->ber_buf == NULL ); */
 471                 ber->ber_rwptr = (char *) &ber->ber_len-1;
 472                 ber->ber_ptr = ber->ber_rwptr;
 473                 ber->ber_tag = 0;
 474         }
 475
 476         while (ber->ber_rwptr > (char *)&ber->ber_tag && ber->ber_rwptr <
 477                 (char *)(&ber->ber_usertag + 1)) {
 478                 ber_slen_t i;
 479                 char buf[sizeof(ber->ber_len)-1];
 480                 ber_len_t tlen = 0;
 481
 482                 if ((i=ber_int_sb_read( sb, ber->ber_rwptr,
 483                         (char *)(&ber->ber_usertag+1)-ber->ber_rwptr))<=0) {
 484                         return LBER_DEFAULT;
 485                 }
 486
 487                 ber->ber_rwptr += i;
 488
 489                 /* We got at least one byte, try to parse the tag. */
 490                 if (ber->ber_ptr == (char *)&ber->ber_len-1) {
 491                         ber_tag_t tag;
 492                         unsigned char *p = (unsigned char *)ber->ber_ptr;
 493                         tag = *p++;
 494                         if ((tag & LBER_BIG_TAG_MASK) == LBER_BIG_TAG_MASK) {
 495                                 for (i=1; (char *)p<ber->ber_rwptr; i++,p++) {
 496                                         tag <<= 8;
 497                                         tag |= *p;
 498                                         if (!(*p & LBER_MORE_TAG_MASK))
 499                                                 break;
 500                                         /* Is the tag too big? */
 501                                         if (i == sizeof(ber_tag_t)-1) {
 502                                                 errno = ERANGE;
 503                                                 return LBER_DEFAULT;
 504                                         }
 505                                 }
 506                                 /* Did we run out of bytes? */
 507                                 if ((char *)p == ber->ber_rwptr) {
 508                                         return LBER_DEFAULT;
 509                                 }
 510                                 p++;
 511                         }
 512                         ber->ber_tag = tag;
 513                         ber->ber_ptr = (char *)p;
 514                 }
 515
 516                 if (i == 1) continue;
 517
 518                 /* Now look for the length */
 519                 if (*ber->ber_ptr & 0x80) {     /* multi-byte */
 520                         int llen = *(unsigned char *)ber->ber_ptr++ & 0x7f;
 521                         if (llen > (int)sizeof(ber_len_t)) {
 522                                 errno = ERANGE;
 523                                 return LBER_DEFAULT;
 524                         }
 525                         /* Not enough bytes? */
 526                         if (ber->ber_rwptr - ber->ber_ptr < llen) {
 527                                 return LBER_DEFAULT;
 528                         }
 529                         for (i=0; i<llen && ber->ber_ptr<ber->ber_rwptr; i++,ber->ber_ptr++) {
 530                                 tlen <<=8;
 531                                 tlen |= *(unsigned char *)ber->ber_ptr;
 532                         }
 533                 } else {
 534                         tlen = *(unsigned char *)ber->ber_ptr++;
 535                 }
 536                 /* Are there leftover data bytes inside ber->ber_len? */
 537                 if (ber->ber_ptr < (char *)&ber->ber_usertag) {
 538                         if (ber->ber_rwptr < (char *)&ber->ber_usertag)
 539                                 i = ber->ber_rwptr - ber->ber_ptr;
 540                         else
 541                                 i = (char *)&ber->ber_usertag - ber->ber_ptr;
 542                         AC_MEMCPY(buf, ber->ber_ptr, i);
 543                         ber->ber_ptr += i;
 544                 } else {
 545                         i = 0;
 546                 }
 547                 ber->ber_len = tlen;
 548
 549                 /* now fill the buffer. */
 550
 551                 /* make sure length is reasonable */
 552                 if ( ber->ber_len == 0 ) {
 553                         errno = ERANGE;
 554                         return LBER_DEFAULT;
 555                 } else if ( sb->sb_max_incoming && ber->ber_len > sb->sb_max_incoming ) {
 556 #ifdef NEW_LOGGING
 557                         LDAP_LOG( BER, ERR,
 558                                 "ber_get_next: sockbuf_max_incoming limit hit "
 559                                 "(%d > %d)\n", ber->ber_len, sb->sb_max_incoming, 0 );
 560 #else
 561                         ber_log_printf( LDAP_DEBUG_CONNS, ber->ber_debug,
 562                                 "ber_get_next: sockbuf_max_incoming limit hit "
 563                                 "(%ld > %ld)\n", ber->ber_len, sb->sb_max_incoming );
 564 #endif
 565                         errno = ERANGE;
 566                         return LBER_DEFAULT;
 567                 }
 568
 569                 if (ber->ber_buf==NULL) {
 570                         ber_len_t l = ber->ber_rwptr - ber->ber_ptr;
 571                         /* ber->ber_ptr is always <= ber->ber->ber_rwptr.
 572                          * make sure ber->ber_len agrees with what we've
 573                          * already read.
 574                          */
 575                         if ( ber->ber_len < i + l ) {
 576                                 errno = ERANGE;
 577                                 return LBER_DEFAULT;
 578                         }
 579                         ber->ber_buf = (char *) LBER_MALLOC( ber->ber_len + 1 );
 580                         if (ber->ber_buf==NULL) {
 581                                 return LBER_DEFAULT;
 582                         }
 583                         ber->ber_end = ber->ber_buf + ber->ber_len;
 584                         if (i) {
 585                                 AC_MEMCPY(ber->ber_buf, buf, i);
 586                         }
 587                         if (l > 0) {
 588                                 AC_MEMCPY(ber->ber_buf + i, ber->ber_ptr, l);
 589                                 i += l;
 590                         }
 591                         ber->ber_ptr = ber->ber_buf;
 592                         ber->ber_usertag = 0;
 593                         if ((ber_len_t)i == ber->ber_len) {
 594                                 goto done;
 595                         }
 596                         ber->ber_rwptr = ber->ber_buf + i;
 597                 }
 598         }
 599
 600         if ((ber->ber_rwptr>=ber->ber_buf) && (ber->ber_rwptr<ber->ber_end)) {
 601                 ber_slen_t res;
 602                 ber_slen_t to_go;
 603
 604                 to_go = ber->ber_end - ber->ber_rwptr;
 605                 assert( to_go > 0 );
 606
 607                 res = ber_int_sb_read( sb, ber->ber_rwptr, to_go );
 608                 if (res<=0)
 609                         return LBER_DEFAULT;
 610                 ber->ber_rwptr+=res;
 611
 612                 if (res<to_go) {
 613 #if defined( EWOULDBLOCK )
 614                         errno = EWOULDBLOCK;
 615 #elif defined( EAGAIN )
 616                         errno = EAGAIN;
 617 #endif
 618                         return LBER_DEFAULT;
 619                 }
 620 done:
 621                 ber->ber_rwptr = NULL;
 622                 *len = ber->ber_len;
 623                 if ( ber->ber_debug ) {
 624 #ifdef NEW_LOGGING
 625                         LDAP_LOG( BER, DETAIL1,
 626                                 "ber_get_next: tag 0x%lx len %ld\n",
 627                                 ber->ber_tag, ber->ber_len, 0  );
 628                         if(LDAP_LOGS_TEST(BER, DETAIL2))
 629                                         BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
 630 #else
 631                         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
 632                                 "ber_get_next: tag 0x%lx len %ld contents:\n",
 633                                 ber->ber_tag, ber->ber_len );
 634                         ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
 635 #endif
 636                 }
 637                 return (ber->ber_tag);
 638         }
 639
 640         assert( 0 ); /* ber structure is messed up ?*/
 641         return LBER_DEFAULT;
 642 }