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

   1 /* io.c - ber general i/o routines */
   2 /* $OpenLDAP$ */
   3 /*
   4  * Copyright 1998-1999 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 #undef LDAP_F_PRE
  36 #define LDAP_F_PRE LDAP_F_EXPORT
  37
  38 #include "lber-int.h"
  39
  40 static ber_slen_t BerRead LDAP_P((
  41         Sockbuf *sb,
  42         char *buf,
  43         ber_len_t len ));
  44
  45 static int ber_realloc LDAP_P((
  46         BerElement *ber,
  47         ber_len_t len ));
  48
  49 #define EXBUFSIZ        1024
  50
  51 /* probably far too large... */
  52 #define MAX_BERBUFSIZE  (128*1024)
  53
  54 #if defined( DOS ) && !defined( _WIN32 ) && (MAX_BERBUFSIZE > 65535)
  55 # undef MAX_BERBUFSIZE
  56 # define MAX_BERBUFSIZE 65535
  57 #endif
  58
  59 static ber_slen_t
  60 BerRead(
  61         Sockbuf *sb,
  62         char *buf,
  63         ber_len_t len )
  64 {
  65         ber_slen_t      c;
  66         ber_slen_t      nread = 0;
  67
  68         assert( sb != NULL );
  69         assert( buf != NULL );
  70
  71         assert( SOCKBUF_VALID( sb ) );
  72
  73         while ( len > 0 ) {
  74                 if ( (c = ber_pvt_sb_read( sb, buf, len )) <= 0 ) {
  75                         if ( nread > 0 )
  76                                 break;
  77                         return( c );
  78                 }
  79                 buf+= c;
  80                 nread+=c;
  81                 len-=c;
  82         }
  83
  84         return( nread );
  85 }
  86
  87 ber_slen_t
  88 ber_read(
  89         BerElement *ber,
  90         char *buf,
  91         ber_len_t len )
  92 {
  93         ber_len_t       actuallen, nleft;
  94
  95         assert( ber != NULL );
  96         assert( buf != NULL );
  97
  98         assert( BER_VALID( ber ) );
  99
 100         nleft = ber->ber_end - ber->ber_ptr;
 101         actuallen = nleft < len ? nleft : len;
 102
 103         SAFEMEMCPY( buf, ber->ber_ptr, actuallen );
 104
 105         ber->ber_ptr += actuallen;
 106
 107         return( (ber_slen_t) actuallen );
 108 }
 109
 110 ber_slen_t
 111 ber_write(
 112         BerElement *ber,
 113         LDAP_CONST char *buf,
 114         ber_len_t len,
 115         int nosos )
 116 {
 117         assert( ber != NULL );
 118         assert( buf != NULL );
 119
 120         assert( BER_VALID( ber ) );
 121
 122         if ( nosos || ber->ber_sos == NULL ) {
 123                 if ( ber->ber_ptr + len > ber->ber_end ) {
 124                         if ( ber_realloc( ber, len ) != 0 )
 125                                 return( -1 );
 126                 }
 127                 SAFEMEMCPY( ber->ber_ptr, buf, (size_t)len );
 128                 ber->ber_ptr += len;
 129                 return( (ber_slen_t) len );
 130
 131         } else {
 132                 if ( ber->ber_sos->sos_ptr + len > ber->ber_end ) {
 133                         if ( ber_realloc( ber, len ) != 0 )
 134                                 return( -1 );
 135                 }
 136                 SAFEMEMCPY( ber->ber_sos->sos_ptr, buf, (size_t)len );
 137                 ber->ber_sos->sos_ptr += len;
 138                 ber->ber_sos->sos_clen += len;
 139                 return( (ber_slen_t) len );
 140         }
 141 }
 142
 143 static int
 144 ber_realloc( BerElement *ber, ber_len_t len )
 145 {
 146         ber_len_t       need, have, total;
 147         Seqorset        *s;
 148         long            off;
 149         char            *oldbuf;
 150
 151         assert( ber != NULL );
 152         assert( len > 0 );
 153
 154         assert( BER_VALID( ber ) );
 155
 156         have = (ber->ber_end - ber->ber_buf) / EXBUFSIZ;
 157         need = (len < EXBUFSIZ ? 1 : (len + (EXBUFSIZ - 1)) / EXBUFSIZ);
 158         total = have * EXBUFSIZ + need * EXBUFSIZ;
 159
 160         oldbuf = ber->ber_buf;
 161
 162         ber->ber_buf = (char *) LBER_REALLOC( ber->ber_buf, total );
 163
 164         if ( ber->ber_buf == NULL ) {
 165                 ber->ber_buf = oldbuf;
 166                 return( -1 );
 167         }
 168
 169         ber->ber_end = ber->ber_buf + total;
 170
 171         /*
 172          * If the stinking thing was moved, we need to go through and
 173          * reset all the sos and ber pointers.  Offsets would've been
 174          * a better idea... oh well.
 175          */
 176
 177         if ( ber->ber_buf != oldbuf ) {
 178                 ber->ber_ptr = ber->ber_buf + (ber->ber_ptr - oldbuf);
 179
 180                 for ( s = ber->ber_sos; s != NULL; s = s->sos_next ) {
 181                         off = s->sos_first - oldbuf;
 182                         s->sos_first = ber->ber_buf + off;
 183
 184                         off = s->sos_ptr - oldbuf;
 185                         s->sos_ptr = ber->ber_buf + off;
 186                 }
 187         }
 188
 189         return( 0 );
 190 }
 191
 192 void
 193 ber_free( BerElement *ber, int freebuf )
 194 {
 195 #ifdef LDAP_MEMORY_DEBUG
 196         assert( ber != NULL );
 197 #endif
 198
 199         if( ber == NULL ) {
 200                 return;
 201         }
 202
 203         assert( BER_VALID( ber ) );
 204
 205         if ( freebuf ) {
 206                 Seqorset *s, *next;
 207                 LBER_FREE( ber->ber_buf );
 208
 209                 for( s = ber->ber_sos ; s != NULL ; s = next ) {
 210                         next = s->sos_next;
 211                         LBER_FREE( s );
 212                 }
 213         }
 214
 215         ber->ber_buf = NULL;
 216         ber->ber_sos = NULL;
 217         ber->ber_valid = LBER_UNINITIALIZED;
 218
 219         LBER_FREE( (char *) ber );
 220 }
 221
 222 int
 223 ber_flush( Sockbuf *sb, BerElement *ber, int freeit )
 224 {
 225         ber_len_t       nwritten, towrite;
 226         ber_slen_t      rc;
 227
 228         assert( sb != NULL );
 229         assert( ber != NULL );
 230
 231         assert( SOCKBUF_VALID( ber ) );
 232         assert( BER_VALID( ber ) );
 233
 234         if ( ber->ber_rwptr == NULL ) {
 235                 ber->ber_rwptr = ber->ber_buf;
 236         }
 237         towrite = ber->ber_ptr - ber->ber_rwptr;
 238
 239         if ( sb->sb_debug ) {
 240                 ber_log_printf( LDAP_DEBUG_ANY, sb->sb_debug,
 241                         "ber_flush: %ld bytes to sd %ld%s\n", towrite,
 242                     (long) sb->sb_sd, ber->ber_rwptr != ber->ber_buf ? " (re-flush)"
 243                     : "" );
 244                 ber_log_bprint( LDAP_DEBUG_PACKETS, sb->sb_debug,
 245                         ber->ber_rwptr, towrite );
 246         }
 247
 248 #if HAVE_WRITE
 249         if ( sb->sb_options & (LBER_TO_FILE | LBER_TO_FILE_ONLY) ) {
 250                 rc = write( sb->sb_fd, ber->ber_rwptr, towrite );
 251                 if ( sb->sb_options & LBER_TO_FILE_ONLY ) {
 252                         if ( freeit )
 253                                 ber_free( ber, 1 );
 254                         return( (int)rc );
 255                 }
 256         }
 257 #endif
 258
 259         nwritten = 0;
 260         do {
 261                 rc = ber_pvt_sb_write( sb, ber->ber_rwptr, towrite );
 262                 if (rc<=0) {
 263                         return -1;
 264                 }
 265                 towrite -= rc;
 266                 nwritten += rc;
 267                 ber->ber_rwptr += rc;
 268         } while ( towrite > 0 );
 269
 270         if ( freeit )
 271                 ber_free( ber, 1 );
 272
 273         return( 0 );
 274 }
 275
 276 BerElement *
 277 ber_alloc_t( int options )
 278 {
 279         BerElement      *ber;
 280
 281     ber_int_options.lbo_valid = LBER_INITIALIZED;
 282
 283         ber = (BerElement *) LBER_CALLOC( 1, sizeof(BerElement) );
 284
 285         if ( ber == NULL )
 286                 return( NULL );
 287
 288         ber->ber_valid = LBER_VALID_BERELEMENT;
 289         ber->ber_tag = LBER_DEFAULT;
 290         ber->ber_options = options;
 291         ber->ber_debug = ber_int_debug;
 292
 293         assert( BER_VALID( ber ) );
 294         return( ber );
 295 }
 296
 297 BerElement *
 298 ber_alloc( void )       /* deprecated */
 299 {
 300         return( ber_alloc_t( 0 ) );
 301 }
 302
 303 BerElement *
 304 der_alloc( void )       /* deprecated */
 305 {
 306         return( ber_alloc_t( LBER_USE_DER ) );
 307 }
 308
 309 BerElement *
 310 ber_dup( BerElement *ber )
 311 {
 312         BerElement      *new;
 313
 314         assert( ber != NULL );
 315         assert( BER_VALID( ber ) );
 316
 317         if ( (new = ber_alloc_t( ber->ber_options )) == NULL ) {
 318                 return( NULL );
 319         }
 320
 321         *new = *ber;
 322
 323         assert( BER_VALID( new ) );
 324         return( new );
 325 }
 326
 327
 328 /* OLD U-Mich ber_init() */
 329 void
 330 ber_init_w_nullc( BerElement *ber, int options )
 331 {
 332         assert( ber != NULL );
 333
 334     ber_int_options.lbo_valid = LBER_INITIALIZED;
 335
 336         (void) memset( (char *)ber, '\0', sizeof( BerElement ));
 337         ber->ber_valid = LBER_VALID_BERELEMENT;
 338         ber->ber_tag = LBER_DEFAULT;
 339         ber->ber_options = (char) options;
 340         ber->ber_debug = ber_int_debug;
 341
 342         assert( BER_VALID( ber ) );
 343 }
 344
 345 /* New C-API ber_init() */
 346 /* This function constructs a BerElement containing a copy
 347 ** of the data in the bv argument.
 348 */
 349 BerElement *
 350 ber_init( struct berval *bv )
 351 {
 352         BerElement *ber;
 353
 354         assert( bv != NULL );
 355
 356     ber_int_options.lbo_valid = LBER_INITIALIZED;
 357
 358         if ( bv == NULL ) {
 359                 return NULL;
 360         }
 361
 362         ber = ber_alloc_t( 0 );
 363
 364         if( ber == NULL ) {
 365                 /* allocation failed */
 366                 return ( NULL );
 367         }
 368
 369         /* copy the data */
 370         if ( ( (ber_len_t) ber_write ( ber, bv->bv_val, bv->bv_len, 0 )) != bv->bv_len ) {
 371                 /* write failed, so free and return NULL */
 372                 ber_free( ber, 1 );
 373                 return( NULL );
 374         }
 375
 376         ber_reset( ber, 1 );    /* reset the pointer to the start of the buffer */
 377
 378         return ( ber );
 379 }
 380
 381 /* New C-API ber_flatten routine */
 382 /* This routine allocates a struct berval whose contents are a BER
 383 ** encoding taken from the ber argument.  The bvPtr pointer pointers to
 384 ** the returned berval.
 385 */
 386 int ber_flatten(
 387         BerElement *ber,
 388         struct berval **bvPtr)
 389 {
 390         struct berval *bv;
 391
 392         assert( bvPtr != NULL );
 393
 394     ber_int_options.lbo_valid = LBER_INITIALIZED;
 395
 396         if(bvPtr == NULL) {
 397                 return( -1 );
 398         }
 399
 400         if ( (bv = LBER_MALLOC( sizeof(struct berval))) == NULL ) {
 401                 return( -1 );
 402         }
 403
 404         if ( ber == NULL ) {
 405                 /* ber is null, create an empty berval */
 406                 bv->bv_val = NULL;
 407                 bv->bv_len = 0;
 408
 409         } else {
 410                 /* copy the berval */
 411                 ber_len_t len = ber->ber_ptr - ber->ber_buf;
 412
 413                 if ( (bv->bv_val = (char *) LBER_MALLOC( len + 1 )) == NULL ) {
 414                         ber_bvfree( bv );
 415                         return( -1 );
 416                 }
 417
 418                 SAFEMEMCPY( bv->bv_val, ber->ber_buf, len );
 419                 bv->bv_val[len] = '\0';
 420                 bv->bv_len = len;
 421         }
 422
 423         *bvPtr = bv;
 424         return( 0 );
 425 }
 426
 427 void
 428 ber_reset( BerElement *ber, int was_writing )
 429 {
 430         assert( ber != NULL );
 431         assert( BER_VALID( ber ) );
 432
 433         if ( was_writing ) {
 434                 ber->ber_end = ber->ber_ptr;
 435                 ber->ber_ptr = ber->ber_buf;
 436         } else {
 437                 ber->ber_ptr = ber->ber_end;
 438         }
 439
 440         ber->ber_rwptr = NULL;
 441 }
 442
 443 #if 0
 444 /* return the tag - LBER_DEFAULT returned means trouble */
 445 static ber_tag_t
 446 get_tag( Sockbuf *sb )
 447 {
 448         unsigned char   xbyte;
 449         ber_tag_t       tag;
 450         char            *tagp;
 451         unsigned int    i;
 452
 453         assert( sb != NULL );
 454         assert( SOCKBUF_VALID( sb ) );
 455
 456         if ( ber_pvt_sb_read( sb, (char *) &xbyte, 1 ) != 1 )
 457                 return( LBER_DEFAULT );
 458
 459         if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
 460                 return( (ber_tag_t) xbyte );
 461
 462         tagp = (char *) &tag;
 463         tagp[0] = xbyte;
 464         for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
 465                 if ( ber_pvt_sb_read( sb, (char *) &xbyte, 1 ) != 1 )
 466                         return( LBER_DEFAULT );
 467
 468                 tagp[i] = xbyte;
 469
 470                 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
 471                         break;
 472         }
 473
 474         /* tag too big! */
 475         if ( i == sizeof(ber_tag_t) )
 476                 return( LBER_DEFAULT );
 477
 478         /* want leading, not trailing 0's */
 479         return( tag >> (sizeof(ber_tag_t) - i - 1) );
 480 }
 481 #endif
 482
 483 /*
 484  * A rewrite of ber_get_next that can safely be called multiple times
 485  * for the same packet. It will simply continue were it stopped until
 486  * a full packet is read.
 487  */
 488
 489 ber_tag_t
 490 ber_get_next(
 491         Sockbuf *sb,
 492         ber_len_t *len,
 493         BerElement *ber )
 494 {
 495         assert( sb != NULL );
 496         assert( len != NULL );
 497         assert( ber != NULL );
 498
 499         assert( SOCKBUF_VALID( sb ) );
 500         assert( BER_VALID( ber ) );
 501
 502         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
 503                 "ber_get_next\n" );
 504
 505         /*
 506          * Any ber element looks like this: tag length contents.
 507          * Assuming everything's ok, we return the tag byte (we
 508          * can assume a single byte), return the length in len,
 509          * and the rest of the undecoded element in buf.
 510          *
 511          * Assumptions:
 512          *      1) small tags (less than 128)
 513          *      2) definite lengths
 514          *      3) primitive encodings used whenever possible
 515          */
 516
 517         if (ber->ber_rwptr == NULL) {
 518                 /* XXYYZ
 519                  * dtest does like this assert.
 520                  */
 521                 /* assert( ber->ber_buf == NULL ); */
 522                 ber->ber_rwptr = (char *) &ber->ber_tag;
 523                 ber->ber_tag = 0;
 524         }
 525
 526 #undef PTR_IN_VAR
 527 #define PTR_IN_VAR( ptr, var ) \
 528         (((ptr)>=(char *) &(var)) && ((ptr)< (char *) &(var)+sizeof(var)))
 529
 530         if (PTR_IN_VAR(ber->ber_rwptr, ber->ber_tag)) {
 531                 if (ber->ber_rwptr == (char *) &ber->ber_tag) {
 532                         if (ber_pvt_sb_read( sb, ber->ber_rwptr, 1)<=0)
 533                                 return LBER_DEFAULT;
 534                         if ((ber->ber_rwptr[0] & LBER_BIG_TAG_MASK)
 535                                 != LBER_BIG_TAG_MASK) {
 536                                 ber->ber_tag = ber->ber_rwptr[0];
 537                                 ber->ber_rwptr = (char *) &ber->ber_usertag;
 538                                 goto get_lenbyte;
 539                         }
 540                         ber->ber_rwptr++;
 541                 }
 542                 do {
 543                         /* reading the tag... */
 544                         if (ber_pvt_sb_read( sb, ber->ber_rwptr, 1)<=0)
 545                                 return LBER_DEFAULT;
 546                         if (! (ber->ber_rwptr[0] & LBER_MORE_TAG_MASK) ) {
 547                                 ber->ber_tag>>=sizeof(ber->ber_tag) -
 548                                   ((char *) &ber->ber_tag - ber->ber_rwptr);
 549                                 ber->ber_rwptr = (char *) &ber->ber_usertag;
 550                                 goto get_lenbyte;
 551                         }
 552                 } while( PTR_IN_VAR(ber->ber_rwptr, ber->ber_tag ));
 553                 errno = ERANGE; /* this is a serious error. */
 554                 return LBER_DEFAULT;
 555         }
 556
 557 get_lenbyte:
 558         if (ber->ber_rwptr==(char *) &ber->ber_usertag) {
 559                 unsigned char c;
 560                 if (ber_pvt_sb_read( sb, (char *) &c, 1)<=0)
 561                         return LBER_DEFAULT;
 562                 if (c & 0x80U) {
 563                         int len = c & 0x7fU;
 564                         if ( (len==0) || ( len>sizeof( ber->ber_len ) ) ) {
 565                                 errno = ERANGE;
 566                                 return LBER_DEFAULT;
 567                         }
 568                         ber->ber_rwptr = (char *) &ber->ber_len +
 569                                 sizeof(ber->ber_len) - len;
 570                         ber->ber_len = 0;
 571                 } else {
 572                         ber->ber_len = c;
 573                         goto fill_buffer;
 574                 }
 575         }
 576
 577         if (PTR_IN_VAR(ber->ber_rwptr, ber->ber_len)) {
 578                 unsigned char netlen[sizeof(ber_len_t)];
 579
 580                 ber_slen_t res;
 581                 ber_slen_t to_go;
 582                 to_go = (char *) &ber->ber_len + sizeof( ber->ber_len ) -
 583                         ber->ber_rwptr;
 584                 assert( to_go > 0 );
 585                 res = ber_pvt_sb_read( sb, netlen, to_go );
 586                 if (res <= 0) {
 587                         return LBER_DEFAULT;
 588                 }
 589                 ber->ber_rwptr += res;
 590
 591                 if (res==to_go) {
 592                         /* convert length. */
 593                         ber->ber_len = 0;
 594                         for( to_go = 0; to_go < res ; to_go++ ) {
 595                                 ber->ber_len <<= 8;
 596                                 ber->ber_len |= netlen[to_go];
 597                         }
 598                         goto fill_buffer;
 599                 } else {
 600 #if defined( EWOULDBLOCK )
 601                         errno = EWOULDBLOCK;
 602 #elif defined( EAGAIN )
 603                         errno = EAGAIN;
 604 #endif
 605                         return LBER_DEFAULT;
 606                 }
 607         }
 608
 609 fill_buffer:
 610         /* now fill the buffer. */
 611         if (ber->ber_buf==NULL) {
 612                 if (ber->ber_len > MAX_BERBUFSIZE) {
 613                         errno = ERANGE;
 614                         return LBER_DEFAULT;
 615                 }
 616                 ber->ber_buf = (char *) LBER_MALLOC( ber->ber_len );
 617                 if (ber->ber_buf==NULL)
 618                         return LBER_DEFAULT;
 619                 ber->ber_rwptr = ber->ber_buf;
 620                 ber->ber_ptr = ber->ber_buf;
 621                 ber->ber_end = ber->ber_buf + ber->ber_len;
 622         }
 623
 624         if ((ber->ber_rwptr>=ber->ber_buf) && (ber->ber_rwptr<ber->ber_end)) {
 625                 ber_slen_t res;
 626                 ber_slen_t to_go;
 627
 628                 to_go = ber->ber_end - ber->ber_rwptr;
 629                 assert( to_go > 0 );
 630
 631                 res = ber_pvt_sb_read( sb, ber->ber_rwptr, to_go );
 632                 if (res<=0)
 633                         return LBER_DEFAULT;
 634                 ber->ber_rwptr+=res;
 635
 636                 if (res<to_go) {
 637 #if defined( EWOULDBLOCK )
 638                         errno = EWOULDBLOCK;
 639 #elif defined( EAGAIN )
 640                         errno = EAGAIN;
 641 #endif
 642                         return LBER_DEFAULT;
 643                 }
 644
 645                 ber->ber_rwptr = NULL;
 646                 *len = ber->ber_len;
 647                 if ( ber->ber_debug ) {
 648                         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
 649                                 "ber_get_next: tag 0x%lx len %ld contents:\n",
 650                                 ber->ber_tag, ber->ber_len );
 651                         ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
 652                 }
 653                 return (ber->ber_tag);
 654         }
 655         assert( 0 ); /* ber structure is messed up ?*/
 656         return LBER_DEFAULT;
 657 }