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

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