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