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

   1 /* io.c - ber general i/o routines */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 1998-2003 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   4060 /* 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 points to
 366 ** the returned berval.
 367 **
 368 ** ber_flatten2 is the same, but uses a struct berval passed by
 369 ** the caller. If alloc is 0 the returned bv uses the ber buf directly.
 370 */
 371 int ber_flatten2(
 372         BerElement *ber,
 373         struct berval *bv,
 374         int alloc )
 375 {
 376         assert( bv != NULL );
 377
 378         ber_int_options.lbo_valid = LBER_INITIALIZED;
 379
 380         if ( bv == NULL ) {
 381                 return -1;
 382         }
 383
 384         if ( ber == NULL ) {
 385                 /* ber is null, create an empty berval */
 386                 bv->bv_val = NULL;
 387                 bv->bv_len = 0;
 388
 389         } else {
 390                 /* copy the berval */
 391                 ber_len_t len = ber_pvt_ber_write( ber );
 392
 393                 if ( alloc ) {
 394                         bv->bv_val = (char *) LBER_MALLOC( len + 1 );
 395                         if ( bv->bv_val == NULL ) {
 396                                 return -1;
 397                         }
 398                         AC_MEMCPY( bv->bv_val, ber->ber_buf, len );
 399                 } else {
 400                         bv->bv_val = ber->ber_buf;
 401                 }
 402                 bv->bv_val[len] = '\0';
 403                 bv->bv_len = len;
 404         }
 405         return 0;
 406 }
 407
 408 int ber_flatten(
 409         BerElement *ber,
 410         struct berval **bvPtr)
 411 {
 412         struct berval *bv;
 413         int rc;
 414
 415         assert( bvPtr != NULL );
 416
 417         ber_int_options.lbo_valid = LBER_INITIALIZED;
 418
 419         if(bvPtr == NULL) {
 420                 return -1;
 421         }
 422
 423         bv = LBER_MALLOC( sizeof(struct berval) );
 424         if ( bv == NULL ) {
 425                 return -1;
 426         }
 427         rc = ber_flatten2(ber, bv, 1);
 428         if (rc == -1) {
 429                 LBER_FREE(bv);
 430         } else {
 431                 *bvPtr = bv;
 432         }
 433         return rc;
 434 }
 435
 436 void
 437 ber_reset( BerElement *ber, int was_writing )
 438 {
 439         assert( ber != NULL );
 440         assert( LBER_VALID( ber ) );
 441
 442         if ( was_writing ) {
 443                 ber->ber_end = ber->ber_ptr;
 444                 ber->ber_ptr = ber->ber_buf;
 445
 446         } else {
 447                 ber->ber_ptr = ber->ber_end;
 448         }
 449
 450         ber->ber_rwptr = NULL;
 451 }
 452
 453 /*
 454  * A rewrite of ber_get_next that can safely be called multiple times
 455  * for the same packet. It will simply continue where it stopped until
 456  * a full packet is read.
 457  */
 458
 459 ber_tag_t
 460 ber_get_next(
 461         Sockbuf *sb,
 462         ber_len_t *len,
 463         BerElement *ber )
 464 {
 465         assert( sb != NULL );
 466         assert( len != NULL );
 467         assert( ber != NULL );
 468
 469         assert( SOCKBUF_VALID( sb ) );
 470         assert( LBER_VALID( ber ) );
 471
 472 #ifdef NEW_LOGGING
 473         LDAP_LOG( BER, ENTRY, "ber_get_next: enter\n", 0, 0, 0 );
 474 #else
 475         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
 476                 "ber_get_next\n" );
 477 #endif
 478
 479         /*
 480          * Any ber element looks like this: tag length contents.
 481          * Assuming everything's ok, we return the tag byte (we
 482          * can assume a single byte), return the length in len,
 483          * and the rest of the undecoded element in buf.
 484          *
 485          * Assumptions:
 486          *      1) small tags (less than 128)
 487          *      2) definite lengths
 488          *      3) primitive encodings used whenever possible
 489          */
 490
 491         if (ber->ber_rwptr == NULL) {
 492                 /* XXYYZ
 493                  * dtest does like this assert.
 494                  */
 495                 /* assert( ber->ber_buf == NULL ); */
 496                 ber->ber_rwptr = (char *) &ber->ber_len-1;
 497                 ber->ber_ptr = ber->ber_rwptr;
 498                 ber->ber_tag = 0;
 499         }
 500
 501         while (ber->ber_rwptr > (char *)&ber->ber_tag && ber->ber_rwptr <
 502                 (char *)(&ber->ber_usertag + 1)) {
 503                 ber_slen_t i;
 504                 char buf[sizeof(ber->ber_len)-1];
 505                 ber_len_t tlen = 0;
 506
 507                 if ((i=ber_int_sb_read( sb, ber->ber_rwptr,
 508                         (char *)(&ber->ber_usertag+1)-ber->ber_rwptr))<=0) {
 509                         return LBER_DEFAULT;
 510                 }
 511
 512                 ber->ber_rwptr += i;
 513
 514                 /* We got at least one byte, try to parse the tag. */
 515                 if (ber->ber_ptr == (char *)&ber->ber_len-1) {
 516                         ber_tag_t tag;
 517                         unsigned char *p = (unsigned char *)ber->ber_ptr;
 518                         tag = *p++;
 519                         if ((tag & LBER_BIG_TAG_MASK) == LBER_BIG_TAG_MASK) {
 520                                 for (i=1; (char *)p<ber->ber_rwptr; i++,p++) {
 521                                         tag <<= 8;
 522                                         tag |= *p;
 523                                         if (!(*p & LBER_MORE_TAG_MASK))
 524                                                 break;
 525                                         /* Is the tag too big? */
 526                                         if (i == sizeof(ber_tag_t)-1) {
 527                                                 errno = ERANGE;
 528                                                 return LBER_DEFAULT;
 529                                         }
 530                                 }
 531                                 /* Did we run out of bytes? */
 532                                 if ((char *)p == ber->ber_rwptr) {
 533                                         return LBER_DEFAULT;
 534                                 }
 535                                 p++;
 536                         }
 537                         ber->ber_tag = tag;
 538                         ber->ber_ptr = (char *)p;
 539
 540                         if (i == 1) continue;
 541                 }
 542
 543                 /* Now look for the length */
 544                 if (*ber->ber_ptr & 0x80) {     /* multi-byte */
 545                         int llen = *(unsigned char *)ber->ber_ptr++ & 0x7f;
 546                         if (llen > (int)sizeof(ber_len_t)) {
 547                                 errno = ERANGE;
 548                                 return LBER_DEFAULT;
 549                         }
 550                         /* Not enough bytes? */
 551                         if (ber->ber_rwptr - ber->ber_ptr < llen) {
 552                                 return LBER_DEFAULT;
 553                         }
 554                         for (i=0; i<llen && ber->ber_ptr<ber->ber_rwptr; i++,ber->ber_ptr++) {
 555                                 tlen <<=8;
 556                                 tlen |= *(unsigned char *)ber->ber_ptr;
 557                         }
 558                 } else {
 559                         tlen = *(unsigned char *)ber->ber_ptr++;
 560                 }
 561                 /* Are there leftover data bytes inside ber->ber_len? */
 562                 if (ber->ber_ptr < (char *)&ber->ber_usertag) {
 563                         if (ber->ber_rwptr < (char *)&ber->ber_usertag)
 564                                 i = ber->ber_rwptr - ber->ber_ptr;
 565                         else
 566                                 i = (char *)&ber->ber_usertag - ber->ber_ptr;
 567                         AC_MEMCPY(buf, ber->ber_ptr, i);
 568                         ber->ber_ptr += i;
 569                 } else {
 570                         i = 0;
 571                 }
 572                 ber->ber_len = tlen;
 573
 574                 /* now fill the buffer. */
 575
 576                 /* make sure length is reasonable */
 577                 if ( ber->ber_len == 0 ) {
 578                         errno = ERANGE;
 579                         return LBER_DEFAULT;
 580                 } else if ( sb->sb_max_incoming && ber->ber_len > sb->sb_max_incoming ) {
 581 #ifdef NEW_LOGGING
 582                         LDAP_LOG( BER, ERR,
 583                                 "ber_get_next: sockbuf_max_incoming limit hit "
 584                                 "(%d > %d)\n", ber->ber_len, sb->sb_max_incoming, 0 );
 585 #else
 586                         ber_log_printf( LDAP_DEBUG_CONNS, ber->ber_debug,
 587                                 "ber_get_next: sockbuf_max_incoming limit hit "
 588                                 "(%ld > %ld)\n", ber->ber_len, sb->sb_max_incoming );
 589 #endif
 590                         errno = ERANGE;
 591                         return LBER_DEFAULT;
 592                 }
 593
 594                 if (ber->ber_buf==NULL) {
 595                         ber_len_t l = ber->ber_rwptr - ber->ber_ptr;
 596                         /* ber->ber_ptr is always <= ber->ber->ber_rwptr.
 597                          * make sure ber->ber_len agrees with what we've
 598                          * already read.
 599                          */
 600                         if ( ber->ber_len < i + l ) {
 601                                 errno = ERANGE;
 602                                 return LBER_DEFAULT;
 603                         }
 604                         ber->ber_buf = (char *) LBER_MALLOC( ber->ber_len + 1 );
 605                         if (ber->ber_buf==NULL) {
 606                                 return LBER_DEFAULT;
 607                         }
 608                         ber->ber_end = ber->ber_buf + ber->ber_len;
 609                         if (i) {
 610                                 AC_MEMCPY(ber->ber_buf, buf, i);
 611                         }
 612                         if (l > 0) {
 613                                 AC_MEMCPY(ber->ber_buf + i, ber->ber_ptr, l);
 614                                 i += l;
 615                         }
 616                         ber->ber_ptr = ber->ber_buf;
 617                         ber->ber_usertag = 0;
 618                         if ((ber_len_t)i == ber->ber_len) {
 619                                 goto done;
 620                         }
 621                         ber->ber_rwptr = ber->ber_buf + i;
 622                 }
 623         }
 624
 625         if ((ber->ber_rwptr>=ber->ber_buf) && (ber->ber_rwptr<ber->ber_end)) {
 626                 ber_slen_t res;
 627                 ber_slen_t to_go;
 628
 629                 to_go = ber->ber_end - ber->ber_rwptr;
 630                 assert( to_go > 0 );
 631
 632                 res = ber_int_sb_read( sb, ber->ber_rwptr, to_go );
 633                 if (res<=0)
 634                         return LBER_DEFAULT;
 635                 ber->ber_rwptr+=res;
 636
 637                 if (res<to_go) {
 638 #if defined( EWOULDBLOCK )
 639                         errno = EWOULDBLOCK;
 640 #elif defined( EAGAIN )
 641                         errno = EAGAIN;
 642 #endif
 643                         return LBER_DEFAULT;
 644                 }
 645 done:
 646                 ber->ber_rwptr = NULL;
 647                 *len = ber->ber_len;
 648                 if ( ber->ber_debug ) {
 649 #ifdef NEW_LOGGING
 650                         LDAP_LOG( BER, DETAIL1,
 651                                 "ber_get_next: tag 0x%lx len %ld\n",
 652                                 ber->ber_tag, ber->ber_len, 0  );
 653                         if(LDAP_LOGS_TEST(BER, DETAIL2))
 654                                         BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
 655 #else
 656                         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
 657                                 "ber_get_next: tag 0x%lx len %ld contents:\n",
 658                                 ber->ber_tag, ber->ber_len );
 659                         ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
 660 #endif
 661                 }
 662                 return (ber->ber_tag);
 663         }
 664
 665         assert( 0 ); /* ber structure is messed up ?*/
 666         return LBER_DEFAULT;
 667 }