1 /* decode.c - ber input decoding routines */
4 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
8 * Copyright (c) 1990 Regents of the University of Michigan.
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.
23 #include <ac/stdlib.h>
25 #include <ac/stdarg.h>
26 #include <ac/string.h>
27 #include <ac/socket.h>
31 static ber_len_t ber_getnint LDAP_P((
36 /* return the tag - LBER_DEFAULT returned means trouble */
38 ber_get_tag( BerElement *ber )
44 assert( ber != NULL );
45 assert( LBER_VALID( ber ) );
47 if ( ber_pvt_ber_remaining( ber ) < 1 ) {
51 if ( ber->ber_ptr == ber->ber_buf )
52 tag = *(unsigned char *)ber->ber_ptr;
57 if ( (tag & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK ) {
61 for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
62 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 ) {
67 tag |= 0x00ffUL & (ber_tag_t) xbyte;
69 if ( ! (xbyte & LBER_MORE_TAG_MASK) ) {
75 if ( i == sizeof(ber_tag_t) ) {
83 ber_skip_tag( BerElement *ber, ber_len_t *len )
88 unsigned char netlen[sizeof(ber_len_t)];
90 assert( ber != NULL );
91 assert( len != NULL );
92 assert( LBER_VALID( ber ) );
95 * Any ber element looks like this: tag length contents.
96 * Assuming everything's ok, we return the tag byte (we
97 * can assume a single byte), and return the length in len.
100 * 1) definite lengths
101 * 2) primitive encodings used whenever possible
107 * First, we read the tag.
110 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT ) {
115 * Next, read the length. The first byte contains the length of
116 * the length. If bit 8 is set, the length is the long form,
117 * otherwise it's the short form. We don't allow a length that's
118 * greater than what we can hold in a ber_len_t.
121 if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
125 noctets = (lc & 0x7fU);
127 if ( noctets > sizeof(ber_len_t) ) {
131 if( (unsigned) ber_read( ber, netlen, noctets ) != noctets ) {
135 for( i = 0; i < noctets; i++ ) {
144 /* BER element should have enough data left */
145 if( *len > (ber_len_t) ber_pvt_ber_remaining( ber ) ) {
148 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
159 * This implementation assumes ber_skip_tag() only
160 * modifies ber_ptr field of the BerElement.
168 tag = ber_skip_tag( ber, len );
181 unsigned char buf[sizeof(ber_int_t)];
183 assert( ber != NULL );
184 assert( num != NULL );
185 assert( LBER_VALID( ber ) );
188 * The tag and length have already been stripped off. We should
189 * be sitting right before len bytes of 2's complement integer,
190 * ready to be read straight into an int. We may have to sign
191 * extend after we read it in.
194 if ( len > sizeof(ber_int_t) ) {
198 /* read into the low-order bytes of our buffer */
199 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
204 /* sign extend if necessary */
206 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
208 /* shift in the bytes */
209 for( i=0 ; i<len; i++ ) {
210 netnum = (netnum << 8 ) | buf[i];
218 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
231 assert( ber != NULL );
232 assert( LBER_VALID( ber ) );
234 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
238 if ( ber_getnint( ber, num, len ) != len ) {
250 return ber_get_int( ber, num );
262 assert( ber != NULL );
263 assert( LBER_VALID( ber ) );
265 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
269 /* must fit within allocated space with termination */
270 if ( datalen >= *len ) {
274 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen ) {
277 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
285 /* Definitions for get_string vector
287 * ChArray, BvArray, and BvVec are self-explanatory.
288 * BvOff is a struct berval embedded in an array of larger structures
289 * of siz bytes at off bytes from the beginning of the struct.
291 enum bgbvc { ChArray, BvArray, BvVec, BvOff };
293 /* Use this single cookie for state, to keep actual
294 * stack use to the absolute minimum.
296 typedef struct bgbvr {
310 ber_get_stringbvl( bgbvr *b, ber_len_t *rlen )
316 struct berval bv, *bvp = NULL;
318 /* For rewinding, just like ber_peek_tag() */
319 orig = b->ber->ber_ptr;
320 tag = b->ber->ber_tag;
322 if ( ber_first_element( b->ber, &len, &last ) != LBER_DEFAULT ) {
323 for ( ; b->ber->ber_ptr < last; i++ )
325 if (ber_skip_tag( b->ber, &len ) == LBER_DEFAULT) break;
326 b->ber->ber_ptr += len;
330 if ( rlen ) *rlen = i;
340 /* Allocate the result vector */
343 *b->res.c = LBER_MALLOC( (n+1) * sizeof( char * ));
344 if ( *b->res.c == NULL )
346 (*b->res.c)[n] = NULL;
349 *b->res.ba = LBER_MALLOC( (n+1) * sizeof( struct berval ));
350 if ( *b->res.ba == NULL )
352 (*b->res.ba)[n].bv_val = NULL;
355 *b->res.bv = LBER_MALLOC( (n+1) * sizeof( struct berval *));
356 if ( *b->res.bv == NULL )
358 (*b->res.bv)[n] = NULL;
361 *b->res.ba = LBER_MALLOC( (n+1) * b->siz );
362 if ( *b->res.ba == NULL )
364 ((struct berval *)((long)(*b->res.ba) + n*b->siz +
365 b->off))->bv_val = NULL;
368 b->ber->ber_ptr = orig;
369 b->ber->ber_tag = tag;
370 ber_skip_tag( b->ber, &len );
374 tag = ber_next_element( b->ber, &len, last );
375 if ( ber_get_stringbv( b->ber, &bv, b->alloc ) == LBER_DEFAULT )
378 /* store my result */
381 (*b->res.c)[n] = bv.bv_val;
384 (*b->res.ba)[n] = bv;
387 bvp = LBER_MALLOC( sizeof( struct berval ));
389 LBER_FREE(bv.bv_val);
392 (*b->res.bv)[n] = bvp;
396 *(BerVarray)((long)(*b->res.ba)+n*b->siz+b->off) = bv;
402 if (b->alloc || b->choice == BvVec)
407 case ChArray: LBER_FREE((*b->res.c)[n]); break;
408 case BvArray: LBER_FREE((*b->res.ba)[n].bv_val); break;
409 case BvVec: LBER_FREE((*b->res.bv)[n]->bv_val);
410 LBER_FREE((*b->res.bv)[n]); break;
415 LBER_FREE(*b->res.c);
421 ber_get_stringbv( BerElement *ber, struct berval *bv, int alloc )
425 assert( ber != NULL );
426 assert( bv != NULL );
428 assert( LBER_VALID( ber ) );
430 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
435 if ( (ber_len_t) ber_pvt_ber_remaining( ber ) < bv->bv_len ) {
440 if ( (bv->bv_val = (char *) LBER_MALLOC( bv->bv_len + 1 )) == NULL ) {
444 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
445 bv->bv_len ) != bv->bv_len ) {
446 LBER_FREE( bv->bv_val );
451 bv->bv_val = ber->ber_ptr;
452 ber->ber_ptr += bv->bv_len;
454 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
455 bv->bv_val[bv->bv_len] = '\0';
461 ber_get_stringa( BerElement *ber, char **buf )
466 assert( buf != NULL );
468 tag = ber_get_stringbv( ber, &bv, 1 );
475 ber_get_stringal( BerElement *ber, struct berval **bv )
479 assert( ber != NULL );
480 assert( bv != NULL );
482 *bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) );
487 tag = ber_get_stringbv( ber, *bv, 1 );
488 if ( tag == LBER_DEFAULT ) {
503 unsigned char unusedbits;
505 assert( ber != NULL );
506 assert( buf != NULL );
507 assert( blen != NULL );
509 assert( LBER_VALID( ber ) );
511 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
517 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL ) {
521 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
527 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
532 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
534 *blen = datalen * 8 - unusedbits;
539 ber_get_null( BerElement *ber )
544 assert( ber != NULL );
545 assert( LBER_VALID( ber ) );
547 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
554 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
567 assert( ber != NULL );
568 assert( boolval != NULL );
570 assert( LBER_VALID( ber ) );
572 rc = ber_get_int( ber, &longbool );
584 assert( ber != NULL );
585 assert( len != NULL );
586 assert( last != NULL );
588 /* skip the sequence header, use the len to mark where to stop */
589 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
593 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
595 *last = ber->ber_ptr + *len;
597 if ( *last == ber->ber_ptr ) {
601 return ber_peek_tag( ber, len );
608 LDAP_CONST char *last )
610 assert( ber != NULL );
611 assert( len != NULL );
612 assert( last != NULL );
614 assert( LBER_VALID( ber ) );
616 if ( ber->ber_ptr >= last ) {
620 return ber_peek_tag( ber, len );
625 ber_scanf ( BerElement *ber,
626 LDAP_CONST char *fmt,
630 LDAP_CONST char *fmt_reset;
632 struct berval **bvp, *bval;
641 assert( ber != NULL );
642 assert( fmt != NULL );
644 assert( LBER_VALID( ber ) );
649 LDAP_LOG( BER, ENTRY, "ber_scanf fmt (%s) ber:\n", fmt, 0, 0 );
651 if ( LDAP_LOGS_TEST(BER, DETAIL2 ))
652 BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
654 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
655 "ber_scanf fmt (%s) ber:\n", fmt );
656 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
659 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
660 /* When this is modified, remember to update
661 * the error-cleanup code below accordingly. */
663 case '!': { /* Hook */
664 BERDecodeCallback *f;
667 f = va_arg( ap, BERDecodeCallback * );
668 p = va_arg( ap, void * );
670 rc = (*f)( ber, p, 0 );
673 case 'a': /* octet string - allocate storage as needed */
674 ss = va_arg( ap, char ** );
675 rc = ber_get_stringa( ber, ss );
678 case 'b': /* boolean */
679 i = va_arg( ap, ber_int_t * );
680 rc = ber_get_boolean( ber, i );
683 case 'e': /* enumerated */
685 i = va_arg( ap, ber_int_t * );
686 rc = ber_get_int( ber, i );
689 case 'l': /* length of next item */
690 l = va_arg( ap, ber_len_t * );
691 rc = ber_peek_tag( ber, l );
695 rc = ber_get_null( ber );
698 case 's': /* octet string - in a buffer */
699 s = va_arg( ap, char * );
700 l = va_arg( ap, ber_len_t * );
701 rc = ber_get_stringb( ber, s, l );
704 case 'm': /* octet string in berval, in-place */
705 bval = va_arg( ap, struct berval * );
706 rc = ber_get_stringbv( ber, bval, 0 );
709 case 'o': /* octet string in a supplied berval */
710 bval = va_arg( ap, struct berval * );
711 rc = ber_get_stringbv( ber, bval, 1 );
714 case 'O': /* octet string - allocate & include length */
715 bvp = va_arg( ap, struct berval ** );
716 rc = ber_get_stringal( ber, bvp );
719 case 'B': /* bit string - allocate storage as needed */
720 ss = va_arg( ap, char ** );
721 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
722 rc = ber_get_bitstringa( ber, ss, l );
725 case 't': /* tag of next item */
726 t = va_arg( ap, ber_tag_t * );
727 *t = rc = ber_peek_tag( ber, &len );
730 case 'T': /* skip tag of next item */
731 t = va_arg( ap, ber_tag_t * );
732 *t = rc = ber_skip_tag( ber, &len );
735 case 'v': /* sequence of strings */
737 bgbvr cookie = { ChArray };
739 cookie.res.c = va_arg( ap, char *** );
741 rc = ber_get_stringbvl( &cookie, NULL );
745 case 'V': /* sequence of strings + lengths */
747 bgbvr cookie = { BvVec };
749 cookie.res.bv = va_arg( ap, struct berval *** );
751 rc = ber_get_stringbvl( &cookie, NULL );
755 case 'W': /* bvarray */
757 bgbvr cookie = { BvArray };
759 cookie.res.ba = va_arg( ap, struct berval ** );
761 rc = ber_get_stringbvl( &cookie, NULL );
765 case 'M': /* bvoffarray - must include address of
766 * a record len, and record offset.
767 * number of records will be returned thru
768 * len ptr on finish. parsed in-place.
771 bgbvr cookie = { BvOff };
773 cookie.res.ba = va_arg( ap, struct berval ** );
775 l = va_arg( ap, ber_len_t * );
777 cookie.off = va_arg( ap, ber_len_t );
778 rc = ber_get_stringbvl( &cookie, l );
782 case 'x': /* skip the next element - whatever it is */
783 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
786 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
789 case '{': /* begin sequence */
790 case '[': /* begin set */
791 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V'
792 && *(fmt + 1) != 'W' && *(fmt + 1) != 'M' )
793 rc = ber_skip_tag( ber, &len );
796 case '}': /* end sequence */
797 case ']': /* end set */
801 if( ber->ber_debug ) {
804 "ber_scanf: unknown fmt %c\n", *fmt, 0, 0 );
806 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
807 "ber_scanf: unknown fmt %c\n", *fmt );
816 if ( rc == LBER_DEFAULT ) {
818 * Error. Reclaim malloced memory that was given to the caller.
819 * Set allocated pointers to NULL, "data length" outvalues to 0.
823 for ( ; fmt_reset < fmt; fmt_reset++ ) {
824 switch ( *fmt_reset ) {
825 case '!': { /* Hook */
826 BERDecodeCallback *f;
829 f = va_arg( ap, BERDecodeCallback * );
830 p = va_arg( ap, void * );
832 (void) (*f)( ber, p, 1 );
835 case 'a': /* octet string - allocate storage as needed */
836 ss = va_arg( ap, char ** );
843 case 'b': /* boolean */
844 case 'e': /* enumerated */
846 (void) va_arg( ap, int * );
849 case 's': /* octet string - in a buffer */
850 (void) va_arg( ap, char * );
851 (void) va_arg( ap, ber_len_t * );
854 case 'l': /* length of next item */
855 (void) va_arg( ap, ber_len_t * );
858 case 't': /* tag of next item */
859 case 'T': /* skip tag of next item */
860 (void) va_arg( ap, ber_tag_t * );
863 case 'o': /* octet string in a supplied berval */
864 bval = va_arg( ap, struct berval * );
865 if ( bval->bv_val != NULL ) {
866 LBER_FREE( bval->bv_val );
872 case 'O': /* octet string - allocate & include length */
873 bvp = va_arg( ap, struct berval ** );
880 case 'B': /* bit string - allocate storage as needed */
881 ss = va_arg( ap, char ** );
886 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
889 case 'v': /* sequence of strings */
890 case 'V': /* sequence of strings + lengths */
891 case 'W': /* BerVarray */
892 case 'm': /* berval in-place */
893 case 'M': /* BVoff array in-place */
895 case 'x': /* skip the next element - whatever it is */
896 case '{': /* begin sequence */
897 case '[': /* begin set */
898 case '}': /* end sequence */
899 case ']': /* end set */
903 /* format should be good */