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

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