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