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

   1 /* decode.c - ber input decoding 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/stdarg.h>
  26 #include <ac/string.h>
  27 #include <ac/socket.h>
  28
  29 #include "lber-int.h"
  30
  31 static ber_len_t ber_getnint LDAP_P((
  32         BerElement *ber,
  33         ber_int_t *num,
  34         ber_len_t len ));
  35
  36 /* return the tag - LBER_DEFAULT returned means trouble */
  37 ber_tag_t
  38 ber_get_tag( BerElement *ber )
  39 {
  40         unsigned char   xbyte;
  41         ber_tag_t       tag;
  42         unsigned int    i;
  43
  44         assert( ber != NULL );
  45         assert( BER_VALID( ber ) );
  46
  47         if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
  48                 return( LBER_DEFAULT );
  49
  50         tag = xbyte;
  51
  52         if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
  53                 return tag;
  54
  55         for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
  56                 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
  57                         return( LBER_DEFAULT );
  58
  59                 tag <<= 8;
  60                 tag |= 0x00ffUL & (ber_tag_t) xbyte;
  61
  62                 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
  63                         break;
  64         }
  65
  66         /* tag too big! */
  67         if ( i == sizeof(ber_tag_t) )
  68                 return( LBER_DEFAULT );
  69
  70         return tag;
  71 }
  72
  73 ber_tag_t
  74 ber_skip_tag( BerElement *ber, ber_len_t *len )
  75 {
  76         ber_tag_t       tag;
  77         unsigned char   lc;
  78         ber_len_t       i, noctets;
  79         unsigned char netlen[sizeof(ber_len_t)];
  80
  81         assert( ber != NULL );
  82         assert( len != NULL );
  83         assert( BER_VALID( ber ) );
  84
  85         /*
  86          * Any ber element looks like this: tag length contents.
  87          * Assuming everything's ok, we return the tag byte (we
  88          * can assume a single byte), and return the length in len.
  89          *
  90          * Assumptions:
  91          *      1) definite lengths
  92          *      2) primitive encodings used whenever possible
  93          */
  94
  95         *len = 0;
  96
  97         /*
  98          * First, we read the tag.
  99          */
 100
 101         if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT )
 102                 return( LBER_DEFAULT );
 103
 104         /*
 105          * Next, read the length.  The first byte contains the length of
 106          * the length.  If bit 8 is set, the length is the long form,
 107          * otherwise it's the short form.  We don't allow a length that's
 108          * greater than what we can hold in a ber_len_t.
 109          */
 110
 111         if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
 112                 return( LBER_DEFAULT );
 113
 114         if ( lc & 0x80U ) {
 115                 noctets = (lc & 0x7fU);
 116
 117                 if ( noctets > sizeof(ber_len_t) ) {
 118                         return( LBER_DEFAULT );
 119                 }
 120
 121                 if( (unsigned) ber_read( ber, netlen, noctets ) != noctets ) {
 122                         return( LBER_DEFAULT );
 123                 }
 124
 125                 for( i = 0; i < noctets; i++ ) {
 126                         *len <<= 8;
 127                         *len |= netlen[i];
 128                 }
 129
 130         } else {
 131                 *len = lc;
 132         }
 133
 134         return( tag );
 135 }
 136
 137 ber_tag_t
 138 ber_peek_tag(
 139         BerElement *ber,
 140         ber_len_t *len )
 141 {
 142         /*
 143          * This implementation assumes ber_skip_tag() only
 144          * modifies ber_ptr field of the BerElement.
 145          */
 146
 147         char *save;
 148         ber_tag_t       tag;
 149
 150         save = ber->ber_ptr;
 151         tag = ber_skip_tag( ber, len );
 152         ber->ber_ptr = save;
 153
 154         return tag;
 155 }
 156
 157 static ber_len_t
 158 ber_getnint(
 159         BerElement *ber,
 160         ber_int_t *num,
 161         ber_len_t len )
 162 {
 163         unsigned char buf[sizeof(ber_int_t)];
 164
 165         assert( ber != NULL );
 166         assert( num != NULL );
 167
 168         assert( BER_VALID( ber ) );
 169
 170         /*
 171          * The tag and length have already been stripped off.  We should
 172          * be sitting right before len bytes of 2's complement integer,
 173          * ready to be read straight into an int.  We may have to sign
 174          * extend after we read it in.
 175          */
 176
 177         if ( len > sizeof(ber_int_t) )
 178                 return( -1 );
 179
 180         /* read into the low-order bytes of our buffer */
 181         if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
 182                 return( -1 );
 183         }
 184
 185         if( len ) {
 186                 /* sign extend if necessary */
 187                 ber_len_t i;
 188                 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
 189
 190                 /* shift in the bytes */
 191                 for( i=0 ; i<len; i++ ) {
 192                         netnum = (netnum << 8 ) | buf[i];
 193                 }
 194
 195                 *num = netnum;
 196
 197         } else {
 198                 *num = 0;
 199         }
 200
 201         return( len );
 202 }
 203
 204 ber_tag_t
 205 ber_get_int(
 206         BerElement *ber,
 207         ber_int_t *num )
 208 {
 209         ber_tag_t       tag;
 210         ber_len_t       len;
 211
 212         assert( ber != NULL );
 213         assert( BER_VALID( ber ) );
 214
 215         if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
 216                 return( LBER_DEFAULT );
 217
 218         if ( ber_getnint( ber, num, len ) != len )
 219                 return( LBER_DEFAULT );
 220         else
 221                 return( tag );
 222 }
 223
 224 ber_tag_t
 225 ber_get_enum(
 226         BerElement *ber,
 227         ber_int_t *num )
 228 {
 229         return ber_get_int( ber, num );
 230 }
 231
 232 ber_tag_t
 233 ber_get_stringb(
 234         BerElement *ber,
 235         char *buf,
 236         ber_len_t *len )
 237 {
 238         ber_len_t       datalen;
 239         ber_tag_t       tag;
 240
 241         assert( ber != NULL );
 242         assert( BER_VALID( ber ) );
 243
 244         if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
 245                 return( LBER_DEFAULT );
 246         if ( datalen > (*len - 1) )
 247                 return( LBER_DEFAULT );
 248
 249         if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen )
 250                 return( LBER_DEFAULT );
 251
 252         buf[datalen] = '\0';
 253
 254         *len = datalen;
 255         return( tag );
 256 }
 257
 258 ber_tag_t
 259 ber_get_stringa( BerElement *ber, char **buf )
 260 {
 261         ber_len_t       datalen;
 262         ber_tag_t       tag;
 263
 264         assert( ber != NULL );
 265         assert( buf != NULL );
 266
 267         assert( BER_VALID( ber ) );
 268
 269         if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
 270                 *buf = NULL;
 271                 return( LBER_DEFAULT );
 272         }
 273
 274         if ( (*buf = (char *) LBER_MALLOC( datalen + 1 )) == NULL )
 275                 return( LBER_DEFAULT );
 276
 277         if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
 278                 LBER_FREE( *buf );
 279                 *buf = NULL;
 280                 return( LBER_DEFAULT );
 281         }
 282         (*buf)[datalen] = '\0';
 283
 284         return( tag );
 285 }
 286
 287 ber_tag_t
 288 ber_get_stringal( BerElement *ber, struct berval **bv )
 289 {
 290         ber_len_t       len;
 291         ber_tag_t       tag;
 292
 293         assert( ber != NULL );
 294         assert( bv != NULL );
 295
 296         assert( BER_VALID( ber ) );
 297
 298         if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
 299                 *bv = NULL;
 300                 return( LBER_DEFAULT );
 301         }
 302
 303         if ( (*bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) )) == NULL )
 304                 return( LBER_DEFAULT );
 305
 306         if ( ((*bv)->bv_val = (char *) LBER_MALLOC( len + 1 )) == NULL ) {
 307                 LBER_FREE( *bv );
 308                 *bv = NULL;
 309                 return( LBER_DEFAULT );
 310         }
 311
 312         if ( (ber_len_t) ber_read( ber, (*bv)->bv_val, len ) != len ) {
 313                 ber_bvfree( *bv );
 314                 *bv = NULL;
 315                 return( LBER_DEFAULT );
 316         }
 317         ((*bv)->bv_val)[len] = '\0';
 318         (*bv)->bv_len = len;
 319
 320         return( tag );
 321 }
 322
 323 ber_tag_t
 324 ber_get_bitstringa(
 325         BerElement *ber,
 326         char **buf,
 327         ber_len_t *blen )
 328 {
 329         ber_len_t       datalen;
 330         ber_tag_t       tag;
 331         unsigned char   unusedbits;
 332
 333         assert( ber != NULL );
 334         assert( buf != NULL );
 335         assert( blen != NULL );
 336
 337         assert( BER_VALID( ber ) );
 338
 339         if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
 340                 *buf = NULL;
 341                 return( LBER_DEFAULT );
 342         }
 343         --datalen;
 344
 345         if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL )
 346                 return( LBER_DEFAULT );
 347
 348         if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
 349                 LBER_FREE( buf );
 350                 *buf = NULL;
 351                 return( LBER_DEFAULT );
 352         }
 353
 354         if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
 355                 LBER_FREE( buf );
 356                 *buf = NULL;
 357                 return( LBER_DEFAULT );
 358         }
 359
 360         *blen = datalen * 8 - unusedbits;
 361         return( tag );
 362 }
 363
 364 ber_tag_t
 365 ber_get_null( BerElement *ber )
 366 {
 367         ber_len_t       len;
 368         ber_tag_t       tag;
 369
 370         assert( ber != NULL );
 371         assert( BER_VALID( ber ) );
 372
 373         if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
 374                 return( LBER_DEFAULT );
 375
 376         if ( len != 0 )
 377                 return( LBER_DEFAULT );
 378
 379         return( tag );
 380 }
 381
 382 ber_tag_t
 383 ber_get_boolean(
 384         BerElement *ber,
 385         ber_int_t *boolval )
 386 {
 387         ber_int_t       longbool;
 388         ber_tag_t       rc;
 389
 390         assert( ber != NULL );
 391         assert( boolval != NULL );
 392
 393         assert( BER_VALID( ber ) );
 394
 395         rc = ber_get_int( ber, &longbool );
 396         *boolval = longbool;
 397
 398         return( rc );
 399 }
 400
 401 ber_tag_t
 402 ber_first_element(
 403         BerElement *ber,
 404         ber_len_t *len,
 405         char **last )
 406 {
 407         assert( ber != NULL );
 408         assert( len != NULL );
 409         assert( last != NULL );
 410
 411         /* skip the sequence header, use the len to mark where to stop */
 412         if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
 413                 *last = NULL;
 414                 return( LBER_DEFAULT );
 415         }
 416
 417         *last = ber->ber_ptr + *len;
 418
 419         if ( *last == ber->ber_ptr ) {
 420                 return( LBER_DEFAULT );
 421         }
 422
 423         return( ber_peek_tag( ber, len ) );
 424 }
 425
 426 ber_tag_t
 427 ber_next_element(
 428         BerElement *ber,
 429         ber_len_t *len,
 430         LDAP_CONST char *last )
 431 {
 432         assert( ber != NULL );
 433         assert( len != NULL );
 434         assert( last != NULL );
 435
 436         assert( BER_VALID( ber ) );
 437
 438         if ( ber->ber_ptr == last ) {
 439                 return( LBER_DEFAULT );
 440         }
 441
 442         return( ber_peek_tag( ber, len ) );
 443 }
 444
 445 /* VARARGS */
 446 ber_tag_t
 447 ber_scanf ( BerElement *ber,
 448         LDAP_CONST char *fmt,
 449         ... )
 450 {
 451         va_list         ap;
 452         LDAP_CONST char         *fmt_reset;
 453         char            *last;
 454         char            *s, **ss, ***sss;
 455         struct berval   ***bv, **bvp, *bval;
 456         ber_int_t       *i;
 457         int j;
 458         ber_len_t       *l;
 459         ber_tag_t       *t;
 460         ber_tag_t       rc, tag;
 461         ber_len_t       len;
 462
 463         va_start( ap, fmt );
 464
 465         assert( ber != NULL );
 466         assert( fmt != NULL );
 467
 468         assert( BER_VALID( ber ) );
 469
 470         fmt_reset = fmt;
 471
 472         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
 473                 "ber_scanf fmt (%s) ber:\n", fmt );
 474         ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
 475
 476         for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
 477                 /* When this is modified, remember to update
 478                  * the error-cleanup code below accordingly. */
 479                 switch ( *fmt ) {
 480                 case '!': { /* Hook */
 481                                 BERDecodeCallback *f;
 482                                 void *p;
 483
 484                                 f = va_arg( ap, BERDecodeCallback * );
 485                                 p = va_arg( ap, void * );
 486
 487                                 rc = (*f)( ber, p, 0 );
 488                         } break;
 489
 490                 case 'a':       /* octet string - allocate storage as needed */
 491                         ss = va_arg( ap, char ** );
 492                         rc = ber_get_stringa( ber, ss );
 493                         break;
 494
 495                 case 'b':       /* boolean */
 496                         i = va_arg( ap, ber_int_t * );
 497                         rc = ber_get_boolean( ber, i );
 498                         break;
 499
 500                 case 'e':       /* enumerated */
 501                 case 'i':       /* int */
 502                         i = va_arg( ap, ber_int_t * );
 503                         rc = ber_get_int( ber, i );
 504                         break;
 505
 506                 case 'l':       /* length of next item */
 507                         l = va_arg( ap, ber_len_t * );
 508                         rc = ber_peek_tag( ber, l );
 509                         break;
 510
 511                 case 'n':       /* null */
 512                         rc = ber_get_null( ber );
 513                         break;
 514
 515                 case 's':       /* octet string - in a buffer */
 516                         s = va_arg( ap, char * );
 517                         l = va_arg( ap, ber_len_t * );
 518                         rc = ber_get_stringb( ber, s, l );
 519                         break;
 520
 521                 case 'o':       /* octet string in a supplied berval */
 522                         bval = va_arg( ap, struct berval * );
 523                         ber_peek_tag( ber, &bval->bv_len );
 524                         rc = ber_get_stringa( ber, &bval->bv_val );
 525                         break;
 526
 527                 case 'O':       /* octet string - allocate & include length */
 528                         bvp = va_arg( ap, struct berval ** );
 529                         rc = ber_get_stringal( ber, bvp );
 530                         break;
 531
 532                 case 'B':       /* bit string - allocate storage as needed */
 533                         ss = va_arg( ap, char ** );
 534                         l = va_arg( ap, ber_len_t * ); /* for length, in bits */
 535                         rc = ber_get_bitstringa( ber, ss, l );
 536                         break;
 537
 538                 case 't':       /* tag of next item */
 539                         t = va_arg( ap, ber_tag_t * );
 540                         *t = rc = ber_peek_tag( ber, &len );
 541                         break;
 542
 543                 case 'T':       /* skip tag of next item */
 544                         t = va_arg( ap, ber_tag_t * );
 545                         *t = rc = ber_skip_tag( ber, &len );
 546                         break;
 547
 548                 case 'v':       /* sequence of strings */
 549                         sss = va_arg( ap, char *** );
 550                         *sss = NULL;
 551                         j = 0;
 552                         for ( tag = ber_first_element( ber, &len, &last );
 553                             tag != LBER_DEFAULT && rc != LBER_DEFAULT;
 554                             tag = ber_next_element( ber, &len, last ) )
 555                         {
 556                                 *sss = (char **) LBER_REALLOC( *sss,
 557                                         (j + 2) * sizeof(char *) );
 558
 559                                 rc = ber_get_stringa( ber, &((*sss)[j]) );
 560                                 j++;
 561                         }
 562                         if ( j > 0 )
 563                                 (*sss)[j] = NULL;
 564                         break;
 565
 566                 case 'V':       /* sequence of strings + lengths */
 567                         bv = va_arg( ap, struct berval *** );
 568                         *bv = NULL;
 569                         j = 0;
 570                         for ( tag = ber_first_element( ber, &len, &last );
 571                             tag != LBER_DEFAULT && rc != LBER_DEFAULT;
 572                             tag = ber_next_element( ber, &len, last ) )
 573                         {
 574                                 *bv = (struct berval **) LBER_REALLOC( *bv,
 575                                         (j + 2) * sizeof(struct berval *) );
 576
 577                                 rc = ber_get_stringal( ber, &((*bv)[j]) );
 578                                 j++;
 579                         }
 580                         if ( j > 0 )
 581                                 (*bv)[j] = NULL;
 582                         break;
 583
 584                 case 'x':       /* skip the next element - whatever it is */
 585                         if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
 586                                 break;
 587                         ber->ber_ptr += len;
 588                         break;
 589
 590                 case '{':       /* begin sequence */
 591                 case '[':       /* begin set */
 592                         if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
 593                                 rc = ber_skip_tag( ber, &len );
 594                         break;
 595
 596                 case '}':       /* end sequence */
 597                 case ']':       /* end set */
 598                         break;
 599
 600                 default:
 601                         if( ber->ber_debug ) {
 602                                 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
 603                                         "ber_scanf: unknown fmt %c\n", *fmt );
 604                         }
 605                         rc = LBER_DEFAULT;
 606                         break;
 607                 }
 608         }
 609
 610         va_end( ap );
 611
 612         if ( rc == LBER_DEFAULT ) {
 613             /*
 614              * Error.  Reclaim malloced memory that was given to the caller.
 615              * Set allocated pointers to NULL, "data length" outvalues to 0.
 616              */
 617             va_start( ap, fmt );
 618
 619             for ( ; fmt_reset < fmt; fmt_reset++ ) {
 620                 switch ( *fmt_reset ) {
 621                 case '!': { /* Hook */
 622                                 BERDecodeCallback *f;
 623                                 void *p;
 624
 625                                 f = va_arg( ap, BERDecodeCallback * );
 626                                 p = va_arg( ap, void * );
 627
 628                                 (void) (*f)( ber, p, 1 );
 629                         } break;
 630
 631                 case 'a':       /* octet string - allocate storage as needed */
 632                         ss = va_arg( ap, char ** );
 633                         if ( *ss ) {
 634                                 LBER_FREE( *ss );
 635                                 *ss = NULL;
 636                         }
 637                         break;
 638
 639                 case 'b':       /* boolean */
 640                 case 'e':       /* enumerated */
 641                 case 'i':       /* int */
 642                         (void) va_arg( ap, int * );
 643                         break;
 644
 645                 case 's':       /* octet string - in a buffer */
 646                         (void) va_arg( ap, char * );
 647                         (void) va_arg( ap, ber_len_t * );
 648                         break;
 649
 650                 case 'l':       /* length of next item */
 651                         (void) va_arg( ap, ber_len_t * );
 652                         break;
 653
 654                 case 't':       /* tag of next item */
 655                 case 'T':       /* skip tag of next item */
 656                         (void) va_arg( ap, ber_tag_t * );
 657                         break;
 658
 659                 case 'o':       /* octet string in a supplied berval */
 660                         bval = va_arg( ap, struct berval * );
 661                         if ( bval->bv_val != NULL ) {
 662                                 LBER_FREE( bval->bv_val );
 663                                 bval->bv_val = NULL;
 664                         }
 665                         bval->bv_len = 0;
 666                         break;
 667
 668                 case 'O':       /* octet string - allocate & include length */
 669                         bvp = va_arg( ap, struct berval ** );
 670                         if ( *bvp ) {
 671                                 ber_bvfree( *bvp );
 672                                 *bvp = NULL;
 673                         }
 674                         break;
 675
 676                 case 'B':       /* bit string - allocate storage as needed */
 677                         ss = va_arg( ap, char ** );
 678                         if ( *ss ) {
 679                                 LBER_FREE( *ss );
 680                                 *ss = NULL;
 681                         }
 682                         *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
 683                         break;
 684
 685                 case 'v':       /* sequence of strings */
 686                         sss = va_arg( ap, char *** );
 687                         if ( *sss ) {
 688                                 for (j = 0;  (*sss)[j];  j++) {
 689                                         LBER_FREE( (*sss)[j] );
 690                                         (*sss)[j] = NULL;
 691                                 }
 692                                 LBER_FREE( *sss );
 693                                 *sss = NULL;
 694                         }
 695                         break;
 696
 697                 case 'V':       /* sequence of strings + lengths */
 698                         bv = va_arg( ap, struct berval *** );
 699                         if ( *bv ) {
 700                                 ber_bvecfree( *bv );
 701                                 *bv = NULL;
 702                         }
 703                         break;
 704
 705                 case 'n':       /* null */
 706                 case 'x':       /* skip the next element - whatever it is */
 707                 case '{':       /* begin sequence */
 708                 case '[':       /* begin set */
 709                 case '}':       /* end sequence */
 710                 case ']':       /* end set */
 711                         break;
 712
 713                 default:
 714                         /* format should be good */
 715                         assert( 0 );
 716                 }
 717             }
 718
 719             va_end( ap );
 720         }
 721
 722         return( rc );
 723 }