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