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, (char *) 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;
327 b->ber->ber_tag = *(unsigned char *)b->ber->ber_ptr;
331 if ( rlen ) *rlen = i;
341 /* Allocate the result vector */
344 *b->res.c = ber_memalloc_x( (n+1) * sizeof( char * ), b->ber->ber_memctx);
345 if ( *b->res.c == NULL )
347 (*b->res.c)[n] = NULL;
350 *b->res.ba = ber_memalloc_x( (n+1) * sizeof( struct berval ), b->ber->ber_memctx);
351 if ( *b->res.ba == NULL )
353 (*b->res.ba)[n].bv_val = NULL;
356 *b->res.bv = ber_memalloc_x( (n+1) * sizeof( struct berval *), b->ber->ber_memctx);
357 if ( *b->res.bv == NULL )
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 )
365 ((struct berval *)((long)(*b->res.ba) + n*b->siz +
366 b->off))->bv_val = NULL;
369 b->ber->ber_ptr = orig;
370 b->ber->ber_tag = tag;
371 ber_skip_tag( b->ber, &len );
375 tag = ber_next_element( b->ber, &len, last );
376 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;
403 if (b->alloc || b->choice == BvVec)
408 case ChArray: LBER_FREE((*b->res.c)[n]); break;
409 case BvArray: LBER_FREE((*b->res.ba)[n].bv_val); break;
410 case BvVec: LBER_FREE((*b->res.bv)[n]->bv_val);
411 LBER_FREE((*b->res.bv)[n]); break;
416 LBER_FREE(*b->res.c);
422 ber_get_stringbv( BerElement *ber, struct berval *bv, int alloc )
426 assert( ber != NULL );
427 assert( bv != NULL );
429 assert( LBER_VALID( ber ) );
431 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
436 if ( (ber_len_t) ber_pvt_ber_remaining( ber ) < bv->bv_len ) {
441 if ( (bv->bv_val = (char *) ber_memalloc_x( bv->bv_len + 1, ber->ber_memctx )) == NULL ) {
445 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
446 bv->bv_len ) != bv->bv_len ) {
447 LBER_FREE( bv->bv_val );
452 bv->bv_val = ber->ber_ptr;
453 ber->ber_ptr += bv->bv_len;
455 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
456 bv->bv_val[bv->bv_len] = '\0';
462 ber_get_stringa( BerElement *ber, char **buf )
467 assert( buf != NULL );
469 tag = ber_get_stringbv( ber, &bv, 1 );
476 ber_get_stringal( BerElement *ber, struct berval **bv )
480 assert( ber != NULL );
481 assert( bv != NULL );
483 *bv = (struct berval *) ber_memalloc_x( sizeof(struct berval), ber->ber_memctx );
488 tag = ber_get_stringbv( ber, *bv, 1 );
489 if ( tag == LBER_DEFAULT ) {
504 unsigned char unusedbits;
506 assert( ber != NULL );
507 assert( buf != NULL );
508 assert( blen != NULL );
510 assert( LBER_VALID( ber ) );
512 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
518 if ( (*buf = (char *) ber_memalloc_x( datalen, ber->ber_memctx )) == NULL ) {
522 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
528 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
533 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
535 *blen = datalen * 8 - unusedbits;
540 ber_get_null( BerElement *ber )
545 assert( ber != NULL );
546 assert( LBER_VALID( ber ) );
548 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
555 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
568 assert( ber != NULL );
569 assert( boolval != NULL );
571 assert( LBER_VALID( ber ) );
573 rc = ber_get_int( ber, &longbool );
585 assert( ber != NULL );
586 assert( len != NULL );
587 assert( last != NULL );
589 /* skip the sequence header, use the len to mark where to stop */
590 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
594 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
596 *last = ber->ber_ptr + *len;
598 if ( *last == ber->ber_ptr ) {
602 return ber_peek_tag( ber, len );
609 LDAP_CONST char *last )
611 assert( ber != NULL );
612 assert( len != NULL );
613 assert( last != NULL );
615 assert( LBER_VALID( ber ) );
617 if ( ber->ber_ptr >= last ) {
621 return ber_peek_tag( ber, len );
626 ber_scanf ( BerElement *ber,
627 LDAP_CONST char *fmt,
631 LDAP_CONST char *fmt_reset;
633 struct berval **bvp, *bval;
642 assert( ber != NULL );
643 assert( fmt != NULL );
645 assert( LBER_VALID( ber ) );
650 LDAP_LOG( BER, ENTRY, "ber_scanf fmt (%s) ber:\n", fmt, 0, 0 );
652 if ( LDAP_LOGS_TEST(BER, DETAIL2 ))
653 BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
655 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
656 "ber_scanf fmt (%s) ber:\n", fmt );
657 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
660 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
661 /* When this is modified, remember to update
662 * the error-cleanup code below accordingly. */
664 case '!': { /* Hook */
665 BERDecodeCallback *f;
668 f = va_arg( ap, BERDecodeCallback * );
669 p = va_arg( ap, void * );
671 rc = (*f)( ber, p, 0 );
674 case 'a': /* octet string - allocate storage as needed */
675 ss = va_arg( ap, char ** );
676 rc = ber_get_stringa( ber, ss );
679 case 'b': /* boolean */
680 i = va_arg( ap, ber_int_t * );
681 rc = ber_get_boolean( ber, i );
684 case 'e': /* enumerated */
686 i = va_arg( ap, ber_int_t * );
687 rc = ber_get_int( ber, i );
690 case 'l': /* length of next item */
691 l = va_arg( ap, ber_len_t * );
692 rc = ber_peek_tag( ber, l );
696 rc = ber_get_null( ber );
699 case 's': /* octet string - in a buffer */
700 s = va_arg( ap, char * );
701 l = va_arg( ap, ber_len_t * );
702 rc = ber_get_stringb( ber, s, l );
705 case 'm': /* octet string in berval, in-place */
706 bval = va_arg( ap, struct berval * );
707 rc = ber_get_stringbv( ber, bval, 0 );
710 case 'o': /* octet string in a supplied berval */
711 bval = va_arg( ap, struct berval * );
712 rc = ber_get_stringbv( ber, bval, 1 );
715 case 'O': /* octet string - allocate & include length */
716 bvp = va_arg( ap, struct berval ** );
717 rc = ber_get_stringal( ber, bvp );
720 case 'B': /* bit string - allocate storage as needed */
721 ss = va_arg( ap, char ** );
722 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
723 rc = ber_get_bitstringa( ber, ss, l );
726 case 't': /* tag of next item */
727 t = va_arg( ap, ber_tag_t * );
728 *t = rc = ber_peek_tag( ber, &len );
731 case 'T': /* skip tag of next item */
732 t = va_arg( ap, ber_tag_t * );
733 *t = rc = ber_skip_tag( ber, &len );
736 case 'v': /* sequence of strings */
738 bgbvr cookie = { ChArray };
740 cookie.res.c = va_arg( ap, char *** );
742 rc = ber_get_stringbvl( &cookie, NULL );
746 case 'V': /* sequence of strings + lengths */
748 bgbvr cookie = { BvVec };
750 cookie.res.bv = va_arg( ap, struct berval *** );
752 rc = ber_get_stringbvl( &cookie, NULL );
756 case 'W': /* bvarray */
758 bgbvr cookie = { BvArray };
760 cookie.res.ba = va_arg( ap, struct berval ** );
762 rc = ber_get_stringbvl( &cookie, NULL );
766 case 'M': /* bvoffarray - must include address of
767 * a record len, and record offset.
768 * number of records will be returned thru
769 * len ptr on finish. parsed in-place.
772 bgbvr cookie = { BvOff };
774 cookie.res.ba = va_arg( ap, struct berval ** );
776 l = va_arg( ap, ber_len_t * );
778 cookie.off = va_arg( ap, ber_len_t );
779 rc = ber_get_stringbvl( &cookie, l );
783 case 'x': /* skip the next element - whatever it is */
784 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
787 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
790 case '{': /* begin sequence */
791 case '[': /* begin set */
792 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V'
793 && *(fmt + 1) != 'W' && *(fmt + 1) != 'M' )
794 rc = ber_skip_tag( ber, &len );
797 case '}': /* end sequence */
798 case ']': /* end set */
802 if( ber->ber_debug ) {
805 "ber_scanf: unknown fmt %c\n", *fmt, 0, 0 );
807 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
808 "ber_scanf: unknown fmt %c\n", *fmt );
817 if ( rc == LBER_DEFAULT ) {
819 * Error. Reclaim malloced memory that was given to the caller.
820 * Set allocated pointers to NULL, "data length" outvalues to 0.
824 for ( ; fmt_reset < fmt; fmt_reset++ ) {
825 switch ( *fmt_reset ) {
826 case '!': { /* Hook */
827 BERDecodeCallback *f;
830 f = va_arg( ap, BERDecodeCallback * );
831 p = va_arg( ap, void * );
833 (void) (*f)( ber, p, 1 );
836 case 'a': /* octet string - allocate storage as needed */
837 ss = va_arg( ap, char ** );
844 case 'b': /* boolean */
845 case 'e': /* enumerated */
847 (void) va_arg( ap, int * );
850 case 's': /* octet string - in a buffer */
851 (void) va_arg( ap, char * );
852 (void) va_arg( ap, ber_len_t * );
855 case 'l': /* length of next item */
856 (void) va_arg( ap, ber_len_t * );
859 case 't': /* tag of next item */
860 case 'T': /* skip tag of next item */
861 (void) va_arg( ap, ber_tag_t * );
864 case 'o': /* octet string in a supplied berval */
865 bval = va_arg( ap, struct berval * );
866 if ( bval->bv_val != NULL ) {
867 LBER_FREE( bval->bv_val );
873 case 'O': /* octet string - allocate & include length */
874 bvp = va_arg( ap, struct berval ** );
881 case 'B': /* bit string - allocate storage as needed */
882 ss = va_arg( ap, char ** );
887 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
890 case 'v': /* sequence of strings */
891 case 'V': /* sequence of strings + lengths */
892 case 'W': /* BerVarray */
893 case 'm': /* berval in-place */
894 case 'M': /* BVoff array in-place */
896 case 'x': /* skip the next element - whatever it is */
897 case '{': /* begin sequence */
898 case '[': /* begin set */
899 case '}': /* end sequence */
900 case ']': /* end set */
904 /* format should be good */