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