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;
58 if ( (tag & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK ) {
62 for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
63 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 ) {
68 tag |= 0x00ffUL & (ber_tag_t) xbyte;
70 if ( ! (xbyte & LBER_MORE_TAG_MASK) ) {
76 if ( i == sizeof(ber_tag_t) ) {
84 ber_skip_tag( BerElement *ber, ber_len_t *len )
89 unsigned char netlen[sizeof(ber_len_t)];
91 assert( ber != NULL );
92 assert( len != NULL );
93 assert( LBER_VALID( ber ) );
96 * Any ber element looks like this: tag length contents.
97 * Assuming everything's ok, we return the tag byte (we
98 * can assume a single byte), and return the length in len.
101 * 1) definite lengths
102 * 2) primitive encodings used whenever possible
108 * First, we read the tag.
111 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT ) {
116 * Next, read the length. The first byte contains the length of
117 * the length. If bit 8 is set, the length is the long form,
118 * otherwise it's the short form. We don't allow a length that's
119 * greater than what we can hold in a ber_len_t.
122 if ( ber_read( ber, (char *) &lc, 1 ) != 1 ) {
127 noctets = (lc & 0x7fU);
129 if ( noctets > sizeof(ber_len_t) ) {
133 if( (unsigned) ber_read( ber, (char *) netlen, noctets ) != noctets ) {
137 for( i = 0; i < noctets; i++ ) {
146 /* BER element should have enough data left */
147 if( *len > (ber_len_t) ber_pvt_ber_remaining( ber ) ) {
150 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
161 * This implementation assumes ber_skip_tag() only
162 * modifies ber_ptr field of the BerElement.
170 tag = ber_skip_tag( ber, len );
183 unsigned char buf[sizeof(ber_int_t)];
185 assert( ber != NULL );
186 assert( num != NULL );
187 assert( LBER_VALID( ber ) );
190 * The tag and length have already been stripped off. We should
191 * be sitting right before len bytes of 2's complement integer,
192 * ready to be read straight into an int. We may have to sign
193 * extend after we read it in.
196 if ( len > sizeof(ber_int_t) ) {
200 /* read into the low-order bytes of our buffer */
201 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
206 /* sign extend if necessary */
208 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
210 /* shift in the bytes */
211 for( i=0 ; i<len; i++ ) {
212 netnum = (netnum << 8 ) | buf[i];
220 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
233 assert( ber != NULL );
234 assert( LBER_VALID( ber ) );
236 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
240 if ( ber_getnint( ber, num, len ) != len ) {
252 return ber_get_int( ber, num );
264 assert( ber != NULL );
265 assert( LBER_VALID( ber ) );
267 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
271 /* must fit within allocated space with termination */
272 if ( datalen >= *len ) {
276 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen ) {
279 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
287 /* Definitions for get_string vector
289 * ChArray, BvArray, and BvVec are self-explanatory.
290 * BvOff is a struct berval embedded in an array of larger structures
291 * of siz bytes at off bytes from the beginning of the struct.
293 enum bgbvc { ChArray, BvArray, BvVec, BvOff };
295 /* Use this single cookie for state, to keep actual
296 * stack use to the absolute minimum.
298 typedef struct bgbvr {
312 ber_get_stringbvl( bgbvr *b, ber_len_t *rlen )
318 struct berval bv, *bvp = NULL;
320 /* For rewinding, just like ber_peek_tag() */
321 orig = b->ber->ber_ptr;
322 tag = b->ber->ber_tag;
324 if ( ber_first_element( b->ber, &len, &last ) != LBER_DEFAULT ) {
325 for ( ; b->ber->ber_ptr < last; i++ ) {
326 if (ber_skip_tag( b->ber, &len ) == LBER_DEFAULT) break;
327 b->ber->ber_ptr += len;
328 b->ber->ber_tag = *(unsigned char *)b->ber->ber_ptr;
332 if ( rlen ) *rlen = i;
341 /* Allocate the result vector */
344 *b->res.c = ber_memalloc_x( (n+1)*sizeof( char * ),
346 if ( *b->res.c == NULL ) return LBER_DEFAULT;
347 (*b->res.c)[n] = NULL;
350 *b->res.ba = ber_memalloc_x( (n+1)*sizeof( struct berval ),
352 if ( *b->res.ba == NULL ) return LBER_DEFAULT;
353 (*b->res.ba)[n].bv_val = NULL;
356 *b->res.bv = ber_memalloc_x( (n+1)*sizeof( struct berval *),
358 if ( *b->res.bv == NULL ) return LBER_DEFAULT;
359 (*b->res.bv)[n] = NULL;
362 *b->res.ba = ber_memalloc_x( (n+1) * b->siz, b->ber->ber_memctx );
363 if ( *b->res.ba == NULL ) return LBER_DEFAULT;
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 ) {
379 /* store my result */
382 (*b->res.c)[n] = bv.bv_val;
385 (*b->res.ba)[n] = bv;
388 bvp = ber_memalloc_x( sizeof( struct berval ), b->ber->ber_memctx);
390 LBER_FREE(bv.bv_val);
393 (*b->res.bv)[n] = bvp;
397 *(BerVarray)((long)(*b->res.ba)+n*b->siz+b->off) = bv;
404 if (b->alloc || b->choice == BvVec) {
405 for (--n; n>=0; n--) {
408 LBER_FREE((*b->res.c)[n]);
411 LBER_FREE((*b->res.ba)[n].bv_val);
414 LBER_FREE((*b->res.bv)[n]->bv_val);
415 LBER_FREE((*b->res.bv)[n]);
422 LBER_FREE(*b->res.c);
428 ber_get_stringbv( BerElement *ber, struct berval *bv, int alloc )
432 assert( ber != NULL );
433 assert( bv != NULL );
435 assert( LBER_VALID( ber ) );
437 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
442 if ( (ber_len_t) ber_pvt_ber_remaining( ber ) < bv->bv_len ) {
447 bv->bv_val = (char *) ber_memalloc_x( bv->bv_len + 1,
449 if ( bv->bv_val == NULL ) {
453 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
454 bv->bv_len ) != bv->bv_len )
456 LBER_FREE( bv->bv_val );
461 bv->bv_val = ber->ber_ptr;
462 ber->ber_ptr += bv->bv_len;
464 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
465 bv->bv_val[bv->bv_len] = '\0';
471 ber_get_stringa( BerElement *ber, char **buf )
476 assert( buf != NULL );
478 tag = ber_get_stringbv( ber, &bv, 1 );
485 ber_get_stringal( BerElement *ber, struct berval **bv )
489 assert( ber != NULL );
490 assert( bv != NULL );
492 *bv = (struct berval *) ber_memalloc_x( sizeof(struct berval),
498 tag = ber_get_stringbv( ber, *bv, 1 );
499 if ( tag == LBER_DEFAULT ) {
514 unsigned char unusedbits;
516 assert( ber != NULL );
517 assert( buf != NULL );
518 assert( blen != NULL );
520 assert( LBER_VALID( ber ) );
522 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
528 *buf = (char *) ber_memalloc_x( datalen, ber->ber_memctx );
529 if ( *buf == NULL ) {
533 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
539 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
544 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
546 *blen = datalen * 8 - unusedbits;
551 ber_get_null( BerElement *ber )
556 assert( ber != NULL );
557 assert( LBER_VALID( ber ) );
559 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
566 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
579 assert( ber != NULL );
580 assert( boolval != NULL );
582 assert( LBER_VALID( ber ) );
584 rc = ber_get_int( ber, &longbool );
596 assert( ber != NULL );
597 assert( len != NULL );
598 assert( last != NULL );
600 /* skip the sequence header, use the len to mark where to stop */
601 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
605 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
607 *last = ber->ber_ptr + *len;
609 if ( *last == ber->ber_ptr ) {
613 return ber_peek_tag( ber, len );
620 LDAP_CONST char *last )
622 assert( ber != NULL );
623 assert( len != NULL );
624 assert( last != NULL );
626 assert( LBER_VALID( ber ) );
628 if ( ber->ber_ptr >= last ) {
632 return ber_peek_tag( ber, len );
637 ber_scanf ( BerElement *ber,
638 LDAP_CONST char *fmt,
642 LDAP_CONST char *fmt_reset;
644 struct berval **bvp, *bval;
653 assert( ber != NULL );
654 assert( fmt != NULL );
656 assert( LBER_VALID( ber ) );
661 LDAP_LOG( BER, ENTRY, "ber_scanf fmt (%s) ber:\n", fmt, 0, 0 );
663 if ( LDAP_LOGS_TEST(BER, DETAIL2 )) {
664 BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
667 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
668 "ber_scanf fmt (%s) ber:\n", fmt );
669 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
672 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
673 /* When this is modified, remember to update
674 * the error-cleanup code below accordingly. */
676 case '!': { /* Hook */
677 BERDecodeCallback *f;
680 f = va_arg( ap, BERDecodeCallback * );
681 p = va_arg( ap, void * );
683 rc = (*f)( ber, p, 0 );
686 case 'a': /* octet string - allocate storage as needed */
687 ss = va_arg( ap, char ** );
688 rc = ber_get_stringa( ber, ss );
691 case 'b': /* boolean */
692 i = va_arg( ap, ber_int_t * );
693 rc = ber_get_boolean( ber, i );
696 case 'e': /* enumerated */
698 i = va_arg( ap, ber_int_t * );
699 rc = ber_get_int( ber, i );
702 case 'l': /* length of next item */
703 l = va_arg( ap, ber_len_t * );
704 rc = ber_peek_tag( ber, l );
708 rc = ber_get_null( ber );
711 case 's': /* octet string - in a buffer */
712 s = va_arg( ap, char * );
713 l = va_arg( ap, ber_len_t * );
714 rc = ber_get_stringb( ber, s, l );
717 case 'm': /* octet string in berval, in-place */
718 bval = va_arg( ap, struct berval * );
719 rc = ber_get_stringbv( ber, bval, 0 );
722 case 'o': /* octet string in a supplied berval */
723 bval = va_arg( ap, struct berval * );
724 rc = ber_get_stringbv( ber, bval, 1 );
727 case 'O': /* octet string - allocate & include length */
728 bvp = va_arg( ap, struct berval ** );
729 rc = ber_get_stringal( ber, bvp );
732 case 'B': /* bit string - allocate storage as needed */
733 ss = va_arg( ap, char ** );
734 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
735 rc = ber_get_bitstringa( ber, ss, l );
738 case 't': /* tag of next item */
739 t = va_arg( ap, ber_tag_t * );
740 *t = rc = ber_peek_tag( ber, &len );
743 case 'T': /* skip tag of next item */
744 t = va_arg( ap, ber_tag_t * );
745 *t = rc = ber_skip_tag( ber, &len );
748 case 'v': /* sequence of strings */
750 bgbvr cookie = { ChArray };
752 cookie.res.c = va_arg( ap, char *** );
754 rc = ber_get_stringbvl( &cookie, NULL );
758 case 'V': /* sequence of strings + lengths */
760 bgbvr cookie = { BvVec };
762 cookie.res.bv = va_arg( ap, struct berval *** );
764 rc = ber_get_stringbvl( &cookie, NULL );
768 case 'W': /* bvarray */
770 bgbvr cookie = { BvArray };
772 cookie.res.ba = va_arg( ap, struct berval ** );
774 rc = ber_get_stringbvl( &cookie, NULL );
778 case 'M': /* bvoffarray - must include address of
779 * a record len, and record offset.
780 * number of records will be returned thru
781 * len ptr on finish. parsed in-place.
784 bgbvr cookie = { BvOff };
786 cookie.res.ba = va_arg( ap, struct berval ** );
788 l = va_arg( ap, ber_len_t * );
790 cookie.off = va_arg( ap, ber_len_t );
791 rc = ber_get_stringbvl( &cookie, l );
795 case 'x': /* skip the next element - whatever it is */
796 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
799 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
802 case '{': /* begin sequence */
803 case '[': /* begin set */
804 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V'
805 && *(fmt + 1) != 'W' && *(fmt + 1) != 'M' )
806 rc = ber_skip_tag( ber, &len );
809 case '}': /* end sequence */
810 case ']': /* end set */
814 if( ber->ber_debug ) {
817 "ber_scanf: unknown fmt %c\n", *fmt, 0, 0 );
819 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
820 "ber_scanf: unknown fmt %c\n", *fmt );
829 if ( rc == LBER_DEFAULT ) {
831 * Error. Reclaim malloced memory that was given to the caller.
832 * Set allocated pointers to NULL, "data length" outvalues to 0.
836 for ( ; fmt_reset < fmt; fmt_reset++ ) {
837 switch ( *fmt_reset ) {
838 case '!': { /* Hook */
839 BERDecodeCallback *f;
842 f = va_arg( ap, BERDecodeCallback * );
843 p = va_arg( ap, void * );
845 (void) (*f)( ber, p, 1 );
848 case 'a': /* octet string - allocate storage as needed */
849 ss = va_arg( ap, char ** );
856 case 'b': /* boolean */
857 case 'e': /* enumerated */
859 (void) va_arg( ap, int * );
862 case 's': /* octet string - in a buffer */
863 (void) va_arg( ap, char * );
864 (void) va_arg( ap, ber_len_t * );
867 case 'l': /* length of next item */
868 (void) va_arg( ap, ber_len_t * );
871 case 't': /* tag of next item */
872 case 'T': /* skip tag of next item */
873 (void) va_arg( ap, ber_tag_t * );
876 case 'o': /* octet string in a supplied berval */
877 bval = va_arg( ap, struct berval * );
878 if ( bval->bv_val != NULL ) {
879 LBER_FREE( bval->bv_val );
885 case 'O': /* octet string - allocate & include length */
886 bvp = va_arg( ap, struct berval ** );
893 case 'B': /* bit string - allocate storage as needed */
894 ss = va_arg( ap, char ** );
899 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
902 case 'v': /* sequence of strings */
903 case 'V': /* sequence of strings + lengths */
904 case 'W': /* BerVarray */
905 case 'm': /* berval in-place */
906 case 'M': /* BVoff array in-place */
908 case 'x': /* skip the next element - whatever it is */
909 case '{': /* begin sequence */
910 case '[': /* begin set */
911 case '}': /* end sequence */
912 case ']': /* end set */
916 /* format should be good */