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 && ber->ber_buf != NULL )
 206                 LBER_FREE( ber->ber_buf );
 207
 208         ber->ber_buf = NULL;
 209         ber->ber_valid = LBER_UNINITIALIZED;
 210
 211         LBER_FREE( (char *) ber );
 212 }
 213
 214 int
 215 ber_flush( Sockbuf *sb, BerElement *ber, int freeit )
 216 {
 217         ber_len_t       nwritten, towrite;
 218         ber_slen_t      rc;
 219
 220         assert( sb != NULL );
 221         assert( ber != NULL );
 222
 223         assert( SOCKBUF_VALID( ber ) );
 224         assert( BER_VALID( ber ) );
 225
 226         if ( ber->ber_rwptr == NULL ) {
 227                 ber->ber_rwptr = ber->ber_buf;
 228         }
 229         towrite = ber->ber_ptr - ber->ber_rwptr;
 230
 231         if ( sb->sb_debug ) {
 232                 ber_log_printf( LDAP_DEBUG_ANY, sb->sb_debug,
 233                         "ber_flush: %ld bytes to sd %ld%s\n", towrite,
 234                     (long) sb->sb_sd, ber->ber_rwptr != ber->ber_buf ? " (re-flush)"
 235                     : "" );
 236                 ber_log_bprint( LDAP_DEBUG_PACKETS, sb->sb_debug,
 237                         ber->ber_rwptr, towrite );
 238         }
 239
 240 #if HAVE_WRITE
 241         if ( sb->sb_options & (LBER_TO_FILE | LBER_TO_FILE_ONLY) ) {
 242                 rc = write( sb->sb_fd, ber->ber_rwptr, towrite );
 243                 if ( sb->sb_options & LBER_TO_FILE_ONLY ) {
 244                         if ( freeit )
 245                                 ber_free( ber, 1 );
 246                         return( (int)rc );
 247                 }
 248         }
 249 #endif
 250
 251         nwritten = 0;
 252         do {
 253                 rc = ber_pvt_sb_write( sb, ber->ber_rwptr, towrite );
 254                 if (rc<=0) {
 255                         return -1;
 256                 }
 257                 towrite -= rc;
 258                 nwritten += rc;
 259                 ber->ber_rwptr += rc;
 260         } while ( towrite > 0 );
 261
 262         if ( freeit )
 263                 ber_free( ber, 1 );
 264
 265         return( 0 );
 266 }
 267
 268 BerElement *
 269 ber_alloc_t( int options )
 270 {
 271         BerElement      *ber;
 272
 273     ber_int_options.lbo_valid = LBER_INITIALIZED;
 274
 275         ber = (BerElement *) LBER_CALLOC( 1, sizeof(BerElement) );
 276
 277         if ( ber == NULL )
 278                 return( NULL );
 279
 280         ber->ber_valid = LBER_VALID_BERELEMENT;
 281         ber->ber_tag = LBER_DEFAULT;
 282         ber->ber_options = options;
 283         ber->ber_debug = ber_int_debug;
 284
 285         assert( BER_VALID( ber ) );
 286         return( ber );
 287 }
 288
 289 BerElement *
 290 ber_alloc( void )       /* deprecated */
 291 {
 292         return( ber_alloc_t( 0 ) );
 293 }
 294
 295 BerElement *
 296 der_alloc( void )       /* deprecated */
 297 {
 298         return( ber_alloc_t( LBER_USE_DER ) );
 299 }
 300
 301 BerElement *
 302 ber_dup( LDAP_CONST BerElement *ber )
 303 {
 304         BerElement      *new;
 305
 306         assert( ber != NULL );
 307         assert( BER_VALID( ber ) );
 308
 309         if ( (new = ber_alloc_t( ber->ber_options )) == NULL ) {
 310                 return( NULL );
 311         }
 312
 313         *new = *ber;
 314
 315         assert( BER_VALID( new ) );
 316         return( new );
 317 }
 318
 319
 320 /* OLD U-Mich ber_init() */
 321 void
 322 ber_init_w_nullc( BerElement *ber, int options )
 323 {
 324         assert( ber != NULL );
 325
 326     ber_int_options.lbo_valid = LBER_INITIALIZED;
 327
 328         (void) memset( (char *)ber, '\0', sizeof( BerElement ));
 329         ber->ber_valid = LBER_VALID_BERELEMENT;
 330         ber->ber_tag = LBER_DEFAULT;
 331         ber->ber_options = (char) options;
 332         ber->ber_debug = ber_int_debug;
 333
 334         assert( BER_VALID( ber ) );
 335 }
 336
 337 /* New C-API ber_init() */
 338 /* This function constructs a BerElement containing a copy
 339 ** of the data in the bv argument.
 340 */
 341 BerElement *
 342 ber_init( struct berval *bv )
 343 {
 344         BerElement *ber;
 345
 346         assert( bv != NULL );
 347
 348     ber_int_options.lbo_valid = LBER_INITIALIZED;
 349
 350         if ( bv == NULL ) {
 351                 return NULL;
 352         }
 353
 354         ber = ber_alloc_t( 0 );
 355
 356         if( ber == NULL ) {
 357                 /* allocation failed */
 358                 return ( NULL );
 359         }
 360
 361         /* copy the data */
 362         if ( ( (ber_len_t) ber_write ( ber, bv->bv_val, bv->bv_len, 0 )) != bv->bv_len ) {
 363                 /* write failed, so free and return NULL */
 364                 ber_free( ber, 1 );
 365                 return( NULL );
 366         }
 367
 368         ber_reset( ber, 1 );    /* reset the pointer to the start of the buffer */
 369
 370         return ( ber );
 371 }
 372
 373 /* New C-API ber_flatten routine */
 374 /* This routine allocates a struct berval whose contents are a BER
 375 ** encoding taken from the ber argument.  The bvPtr pointer pointers to
 376 ** the returned berval.
 377 */
 378 int ber_flatten(
 379         LDAP_CONST BerElement *ber,
 380         struct berval **bvPtr)
 381 {
 382         struct berval *bv;
 383
 384         assert( bvPtr != NULL );
 385
 386     ber_int_options.lbo_valid = LBER_INITIALIZED;
 387
 388         if(bvPtr == NULL) {
 389                 return( -1 );
 390         }
 391
 392         if ( (bv = LBER_MALLOC( sizeof(struct berval))) == NULL ) {
 393                 return( -1 );
 394         }
 395
 396         if ( ber == NULL ) {
 397                 /* ber is null, create an empty berval */
 398                 bv->bv_val = NULL;
 399                 bv->bv_len = 0;
 400
 401         } else {
 402                 /* copy the berval */
 403                 ber_len_t len = ber->ber_ptr - ber->ber_buf;
 404
 405                 if ( (bv->bv_val = (char *) LBER_MALLOC( len + 1 )) == NULL ) {
 406                         ber_bvfree( bv );
 407                         return( -1 );
 408                 }
 409
 410                 SAFEMEMCPY( bv->bv_val, ber->ber_buf, len );
 411                 bv->bv_val[len] = '\0';
 412                 bv->bv_len = len;
 413         }
 414
 415         *bvPtr = bv;
 416         return( 0 );
 417 }
 418
 419 void
 420 ber_reset( BerElement *ber, int was_writing )
 421 {
 422         assert( ber != NULL );
 423         assert( BER_VALID( ber ) );
 424
 425         if ( was_writing ) {
 426                 ber->ber_end = ber->ber_ptr;
 427                 ber->ber_ptr = ber->ber_buf;
 428         } else {
 429                 ber->ber_ptr = ber->ber_end;
 430         }
 431
 432         ber->ber_rwptr = NULL;
 433 }
 434
 435 #if 0
 436 /* return the tag - LBER_DEFAULT returned means trouble */
 437 static ber_tag_t
 438 get_tag( Sockbuf *sb )
 439 {
 440         unsigned char   xbyte;
 441         ber_tag_t       tag;
 442         char            *tagp;
 443         unsigned int    i;
 444
 445         assert( sb != NULL );
 446         assert( SOCKBUF_VALID( sb ) );
 447
 448         if ( ber_pvt_sb_read( sb, (char *) &xbyte, 1 ) != 1 )
 449                 return( LBER_DEFAULT );
 450
 451         if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
 452                 return( (ber_tag_t) xbyte );
 453
 454         tagp = (char *) &tag;
 455         tagp[0] = xbyte;
 456         for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
 457                 if ( ber_pvt_sb_read( sb, (char *) &xbyte, 1 ) != 1 )
 458                         return( LBER_DEFAULT );
 459
 460                 tagp[i] = xbyte;
 461
 462                 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
 463                         break;
 464         }
 465
 466         /* tag too big! */
 467         if ( i == sizeof(ber_tag_t) )
 468                 return( LBER_DEFAULT );
 469
 470         /* want leading, not trailing 0's */
 471         return( tag >> (sizeof(ber_tag_t) - i - 1) );
 472 }
 473 #endif
 474
 475 /*
 476  * A rewrite of ber_get_next that can safely be called multiple times
 477  * for the same packet. It will simply continue were it stopped until
 478  * a full packet is read.
 479  */
 480
 481 ber_tag_t
 482 ber_get_next(
 483         Sockbuf *sb,
 484         ber_len_t *len,
 485         BerElement *ber )
 486 {
 487         assert( sb != NULL );
 488         assert( len != NULL );
 489         assert( ber != NULL );
 490
 491         assert( SOCKBUF_VALID( sb ) );
 492         assert( BER_VALID( ber ) );
 493
 494         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
 495                 "ber_get_next\n" );
 496
 497         /*
 498          * Any ber element looks like this: tag length contents.
 499          * Assuming everything's ok, we return the tag byte (we
 500          * can assume a single byte), return the length in len,
 501          * and the rest of the undecoded element in buf.
 502          *
 503          * Assumptions:
 504          *      1) small tags (less than 128)
 505          *      2) definite lengths
 506          *      3) primitive encodings used whenever possible
 507          */
 508
 509         if (ber->ber_rwptr == NULL) {
 510                 /* XXYYZ
 511                  * dtest does like this assert.
 512                  */
 513                 /* assert( ber->ber_buf == NULL ); */
 514                 ber->ber_rwptr = (char *) &ber->ber_tag;
 515                 ber->ber_tag = 0;
 516         }
 517
 518 #define PTR_IN_VAR( ptr, var )\
 519 (((ptr)>=(char *) &(var)) && ((ptr)< (char *) &(var)+sizeof(var)))
 520
 521         if (PTR_IN_VAR(ber->ber_rwptr, ber->ber_tag)) {
 522                 if (ber->ber_rwptr == (char *) &ber->ber_tag) {
 523                         if (ber_pvt_sb_read( sb, ber->ber_rwptr, 1)<=0)
 524                                 return LBER_DEFAULT;
 525                         if ((ber->ber_rwptr[0] & LBER_BIG_TAG_MASK)
 526                                 != LBER_BIG_TAG_MASK) {
 527                                 ber->ber_tag = ber->ber_rwptr[0];
 528                                 ber->ber_rwptr = (char *) &ber->ber_usertag;
 529                                 goto get_lenbyte;
 530                         }
 531                         ber->ber_rwptr++;
 532                 }
 533                 do {
 534                         /* reading the tag... */
 535                         if (ber_pvt_sb_read( sb, ber->ber_rwptr, 1)<=0)
 536                                 return LBER_DEFAULT;
 537                         if (! (ber->ber_rwptr[0] & LBER_MORE_TAG_MASK) ) {
 538                                 ber->ber_tag>>=sizeof(ber->ber_tag) -
 539                                   ((char *) &ber->ber_tag - ber->ber_rwptr);
 540                                 ber->ber_rwptr = (char *) &ber->ber_usertag;
 541                                 goto get_lenbyte;
 542                         }
 543                 } while (PTR_IN_VAR(ber->ber_rwptr,ber->ber_tag));
 544                 errno = ERANGE; /* this is a serious error. */
 545                 return LBER_DEFAULT;
 546         }
 547 get_lenbyte:
 548         if (ber->ber_rwptr==(char *) &ber->ber_usertag) {
 549                 unsigned char c;
 550                 if (ber_pvt_sb_read( sb, (char *) &c, 1)<=0)
 551                         return LBER_DEFAULT;
 552                 if (c & 0x80U) {
 553                         int len = c & 0x7fU;
 554                         if ( (len==0) || ( len>sizeof( ber->ber_len ) ) ) {
 555                                 errno = ERANGE;
 556                                 return LBER_DEFAULT;
 557                         }
 558                         ber->ber_rwptr = (char *) &ber->ber_len +
 559                                 sizeof(ber->ber_len) - len;
 560                         ber->ber_len = 0;
 561                 } else {
 562                         ber->ber_len = c;
 563                         goto fill_buffer;
 564                 }
 565         }
 566         if (PTR_IN_VAR(ber->ber_rwptr, ber->ber_len)) {
 567                 ber_slen_t res;
 568                 ber_slen_t to_go;
 569                 to_go = (char *) &ber->ber_len + sizeof( ber->ber_len ) -
 570                         ber->ber_rwptr;
 571                 assert( to_go > 0 );
 572                 res = ber_pvt_sb_read( sb, ber->ber_rwptr, to_go );
 573                 if (res <=0)
 574                         return LBER_DEFAULT;
 575                 ber->ber_rwptr += res;
 576                 if (res==to_go) {
 577                         /* convert length. */
 578                         ber->ber_len = LBER_LEN_NTOH( ber->ber_len );
 579                         goto fill_buffer;
 580                 } else {
 581 #if defined( EWOULDBLOCK )
 582                         errno = EWOULDBLOCK;
 583 #elif defined( EAGAIN )
 584                         errno = EAGAIN;
 585 #endif
 586                         return LBER_DEFAULT;
 587                 }
 588         }
 589 fill_buffer:
 590         /* now fill the buffer. */
 591         if (ber->ber_buf==NULL) {
 592                 if (ber->ber_len > MAX_BERBUFSIZE) {
 593                         errno = ERANGE;
 594                         return LBER_DEFAULT;
 595                 }
 596                 ber->ber_buf = (char *) LBER_MALLOC( ber->ber_len );
 597                 if (ber->ber_buf==NULL)
 598                         return LBER_DEFAULT;
 599                 ber->ber_rwptr = ber->ber_buf;
 600                 ber->ber_ptr = ber->ber_buf;
 601                 ber->ber_end = ber->ber_buf + ber->ber_len;
 602         }
 603         if ((ber->ber_rwptr>=ber->ber_buf) && (ber->ber_rwptr<ber->ber_end)) {
 604                 ber_slen_t res;
 605                 ber_slen_t to_go;
 606
 607                 to_go = ber->ber_end - ber->ber_rwptr;
 608                 assert( to_go > 0 );
 609
 610                 res = ber_pvt_sb_read( sb, ber->ber_rwptr, to_go );
 611                 if (res<=0)
 612                         return LBER_DEFAULT;
 613                 ber->ber_rwptr+=res;
 614
 615                 if (res<to_go) {
 616 #if defined( EWOULDBLOCK )
 617                         errno = EWOULDBLOCK;
 618 #elif defined( EAGAIN )
 619                         errno = EAGAIN;
 620 #endif
 621                         return LBER_DEFAULT;
 622                 }
 623
 624                 ber->ber_rwptr = NULL;
 625                 *len = ber->ber_len;
 626                 if ( ber->ber_debug ) {
 627                         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
 628                                 "ber_get_next: tag 0x%lx len %ld contents:\n",
 629                                 ber->ber_tag, ber->ber_len );
 630                         ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
 631                 }
 632                 return (ber->ber_tag);
 633         }
 634         assert( 0 ); /* ber structure is messed up ?*/
 635         return LBER_DEFAULT;
 636 }