1 /* decode.c - ber input decoding routines */
4 * Copyright 1998-2000 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_read( ber, (char *) &xbyte, 1 ) != 1 ) {
53 if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK ) {
57 for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
58 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 ) {
63 tag |= 0x00ffUL & (ber_tag_t) xbyte;
65 if ( ! (xbyte & LBER_MORE_TAG_MASK) ) {
71 if ( i == sizeof(ber_tag_t) ) {
79 ber_skip_tag( BerElement *ber, ber_len_t *len )
84 unsigned char netlen[sizeof(ber_len_t)];
86 assert( ber != NULL );
87 assert( len != NULL );
88 assert( LBER_VALID( ber ) );
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.
97 * 2) primitive encodings used whenever possible
103 * First, we read the tag.
106 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT ) {
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.
117 if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
121 noctets = (lc & 0x7fU);
123 if ( noctets > sizeof(ber_len_t) ) {
127 if( (unsigned) ber_read( ber, netlen, noctets ) != noctets ) {
131 for( i = 0; i < noctets; i++ ) {
140 /* BER length should be non-negative */
145 /* BER element should have enough data left */
146 if( *len > (ber_len_t) ber_pvt_ber_remaining( ber ) ) {
159 * This implementation assumes ber_skip_tag() only
160 * modifies ber_ptr field of the BerElement.
167 tag = ber_skip_tag( ber, len );
179 unsigned char buf[sizeof(ber_int_t)];
181 assert( ber != NULL );
182 assert( num != NULL );
183 assert( LBER_VALID( ber ) );
186 * The tag and length have already been stripped off. We should
187 * be sitting right before len bytes of 2's complement integer,
188 * ready to be read straight into an int. We may have to sign
189 * extend after we read it in.
192 if ( len > sizeof(ber_int_t) ) {
196 /* read into the low-order bytes of our buffer */
197 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
202 /* sign extend if necessary */
204 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
206 /* shift in the bytes */
207 for( i=0 ; i<len; i++ ) {
208 netnum = (netnum << 8 ) | buf[i];
228 assert( ber != NULL );
229 assert( LBER_VALID( ber ) );
231 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
235 if ( ber_getnint( ber, num, len ) != len ) {
247 return ber_get_int( ber, num );
259 assert( ber != NULL );
260 assert( LBER_VALID( ber ) );
262 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
266 /* must fit within allocated space with termination */
267 if ( datalen >= *len ) {
271 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen ) {
281 /* Definitions for recursive get_string
283 * ChArray, BvArray, and BvVec are self-explanatory.
284 * BvOff is a struct berval embedded in an array of larger structures
285 * of siz bytes at off bytes from the beginning of the struct.
287 enum bgbvc { ChArray, BvArray, BvVec, BvOff };
289 /* Use this single cookie for state, to keep actual
290 * stack use to the absolute minimum.
292 typedef struct bgbvr {
307 /* Recursive get_string, for decoding a vector of strings. The number
308 * of elements in the vector is limited only by available stack space.
309 * Each invocation consumes 24 bytes of stack on a 32-bit machine.
312 ber_get_stringbvr( bgbvr *b, int n )
314 struct berval bv, *bvp = NULL;
317 b->tag = ber_next_element( b->ber, &b->len, b->last );
319 b->tag = ber_first_element( b->ber, &b->len, &b->last );
321 if ( b->tag == LBER_DEFAULT )
329 /* Allocate the result vector */
332 *b->res.c = LBER_MALLOC( (n+1) * sizeof( char * ));
333 if ( *b->res.c == NULL )
335 (*b->res.c)[n] = NULL;
338 *b->res.ba = LBER_MALLOC( (n+1) * sizeof( struct berval ));
339 if ( *b->res.ba == NULL )
341 (*b->res.ba)[n].bv_val = NULL;
344 *b->res.bv = LBER_MALLOC( (n+1) * sizeof( struct berval *));
345 if ( *b->res.bv == NULL )
347 (*b->res.bv)[n] = NULL;
350 *b->res.ba = LBER_MALLOC( (n+1) * b->siz );
351 if ( *b->res.ba == NULL )
353 ((struct berval *)((long)(*b->res.ba) + n*b->siz +
354 b->off))->bv_val = NULL;
360 /* Do all local allocs before the recursion. Then there
361 * cannot possibly be any failures on the return trip.
363 if ( b->choice == BvVec )
364 bvp = LBER_MALLOC( sizeof( struct berval ));
366 if ( ber_get_stringbv( b->ber, &bv ) == LBER_DEFAULT ) {
367 if ( bvp ) LBER_FREE( bvp );
371 b->tag = ber_get_stringbvr( b, n+1 );
375 /* store my result */
378 (*b->res.c)[n] = bv.bv_val;
381 (*b->res.ba)[n] = bv;
384 (*b->res.bv)[n] = bvp;
388 *(BVarray)((long)(*b->res.ba)+n*b->siz+b->off) = bv;
391 /* Failure will propagate up and free in reverse
392 * order, which is actually ideal.
394 if ( bvp ) LBER_FREE( bvp );
395 LBER_FREE( bv.bv_val );
401 ber_get_stringbv( BerElement *ber, struct berval *bv )
405 assert( ber != NULL );
406 assert( bv != NULL );
408 assert( LBER_VALID( ber ) );
410 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
415 if ( (bv->bv_val = (char *) LBER_MALLOC( bv->bv_len + 1 )) == NULL ) {
419 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
420 bv->bv_len ) != bv->bv_len ) {
421 LBER_FREE( bv->bv_val );
425 bv->bv_val[bv->bv_len] = '\0';
431 ber_get_stringa( BerElement *ber, char **buf )
436 assert( buf != NULL );
438 tag = ber_get_stringbv( ber, &bv );
445 ber_get_stringal( BerElement *ber, struct berval **bv )
449 assert( ber != NULL );
450 assert( bv != NULL );
452 *bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) );
457 tag = ber_get_stringbv( ber, *bv );
458 if ( tag == LBER_DEFAULT ) {
473 unsigned char unusedbits;
475 assert( ber != NULL );
476 assert( buf != NULL );
477 assert( blen != NULL );
479 assert( LBER_VALID( ber ) );
481 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
487 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL ) {
491 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
497 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
503 *blen = datalen * 8 - unusedbits;
508 ber_get_null( BerElement *ber )
513 assert( ber != NULL );
514 assert( LBER_VALID( ber ) );
516 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
535 assert( ber != NULL );
536 assert( boolval != NULL );
538 assert( LBER_VALID( ber ) );
540 rc = ber_get_int( ber, &longbool );
552 assert( ber != NULL );
553 assert( len != NULL );
554 assert( last != NULL );
556 /* skip the sequence header, use the len to mark where to stop */
557 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
562 *last = ber->ber_ptr + *len;
564 if ( *last == ber->ber_ptr ) {
568 return ber_peek_tag( ber, len );
575 LDAP_CONST char *last )
577 assert( ber != NULL );
578 assert( len != NULL );
579 assert( last != NULL );
581 assert( LBER_VALID( ber ) );
583 if ( ber->ber_ptr == last ) {
587 return ber_peek_tag( ber, len );
592 ber_scanf ( BerElement *ber,
593 LDAP_CONST char *fmt,
597 LDAP_CONST char *fmt_reset;
599 char *s, **ss, ***sss;
600 struct berval ***bv, **bvp, *bval;
610 assert( ber != NULL );
611 assert( fmt != NULL );
613 assert( LBER_VALID( ber ) );
618 LDAP_LOG(( "liblber", LDAP_LEVEL_ENTRY, "ber_scanf fmt (%s) ber:\n", fmt ));
619 BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
621 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
622 "ber_scanf fmt (%s) ber:\n", fmt );
623 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
626 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
627 /* When this is modified, remember to update
628 * the error-cleanup code below accordingly. */
630 case '!': { /* Hook */
631 BERDecodeCallback *f;
634 f = va_arg( ap, BERDecodeCallback * );
635 p = va_arg( ap, void * );
637 rc = (*f)( ber, p, 0 );
640 case 'a': /* octet string - allocate storage as needed */
641 ss = va_arg( ap, char ** );
642 rc = ber_get_stringa( ber, ss );
645 case 'b': /* boolean */
646 i = va_arg( ap, ber_int_t * );
647 rc = ber_get_boolean( ber, i );
650 case 'e': /* enumerated */
652 i = va_arg( ap, ber_int_t * );
653 rc = ber_get_int( ber, i );
656 case 'l': /* length of next item */
657 l = va_arg( ap, ber_len_t * );
658 rc = ber_peek_tag( ber, l );
662 rc = ber_get_null( ber );
665 case 's': /* octet string - in a buffer */
666 s = va_arg( ap, char * );
667 l = va_arg( ap, ber_len_t * );
668 rc = ber_get_stringb( ber, s, l );
671 case 'o': /* octet string in a supplied berval */
672 bval = va_arg( ap, struct berval * );
673 rc = ber_get_stringbv( ber, bval );
676 case 'O': /* octet string - allocate & include length */
677 bvp = va_arg( ap, struct berval ** );
678 rc = ber_get_stringal( ber, bvp );
681 case 'B': /* bit string - allocate storage as needed */
682 ss = va_arg( ap, char ** );
683 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
684 rc = ber_get_bitstringa( ber, ss, l );
687 case 't': /* tag of next item */
688 t = va_arg( ap, ber_tag_t * );
689 *t = rc = ber_peek_tag( ber, &len );
692 case 'T': /* skip tag of next item */
693 t = va_arg( ap, ber_tag_t * );
694 *t = rc = ber_skip_tag( ber, &len );
697 case 'v': /* sequence of strings */
699 bgbvr cookie = { ber, ChArray };
700 cookie.res.c = va_arg( ap, char *** );
701 rc = ber_get_stringbvr( &cookie, 0 );
705 case 'V': /* sequence of strings + lengths */
707 bgbvr cookie = { ber, BvVec };
708 cookie.res.bv = va_arg( ap, struct berval *** );
709 rc = ber_get_stringbvr( &cookie, 0 );
713 case 'W': /* bvarray */
715 bgbvr cookie = { ber, BvArray };
716 cookie.res.ba = va_arg( ap, struct berval ** );
717 rc = ber_get_stringbvr( &cookie, 0 );
721 case 'w': /* bvoffarray - must include address of
722 * a record len, and record offset.
723 * number of records will be returned thru
727 bgbvr cookie = { ber, BvOff };
728 cookie.res.ba = va_arg( ap, struct berval ** );
729 l = va_arg( ap, ber_len_t * );
731 cookie.off = va_arg( ap, ber_len_t );
732 rc = ber_get_stringbvr( &cookie, 0 );
737 case 'x': /* skip the next element - whatever it is */
738 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
743 case '{': /* begin sequence */
744 case '[': /* begin set */
745 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V'
746 && *(fmt + 1) != 'W' && *(fmt + 1) != 'w' )
747 rc = ber_skip_tag( ber, &len );
750 case '}': /* end sequence */
751 case ']': /* end set */
755 if( ber->ber_debug ) {
757 LDAP_LOG(( "liblber", LDAP_LEVEL_ERR,
758 "ber_scanf: unknown fmt %c\n", *fmt ));
760 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
761 "ber_scanf: unknown fmt %c\n", *fmt );
770 if ( rc == LBER_DEFAULT ) {
772 * Error. Reclaim malloced memory that was given to the caller.
773 * Set allocated pointers to NULL, "data length" outvalues to 0.
777 for ( ; fmt_reset < fmt; fmt_reset++ ) {
778 switch ( *fmt_reset ) {
779 case '!': { /* Hook */
780 BERDecodeCallback *f;
783 f = va_arg( ap, BERDecodeCallback * );
784 p = va_arg( ap, void * );
786 (void) (*f)( ber, p, 1 );
789 case 'a': /* octet string - allocate storage as needed */
790 ss = va_arg( ap, char ** );
797 case 'b': /* boolean */
798 case 'e': /* enumerated */
800 (void) va_arg( ap, int * );
803 case 's': /* octet string - in a buffer */
804 (void) va_arg( ap, char * );
805 (void) va_arg( ap, ber_len_t * );
808 case 'l': /* length of next item */
809 (void) va_arg( ap, ber_len_t * );
812 case 't': /* tag of next item */
813 case 'T': /* skip tag of next item */
814 (void) va_arg( ap, ber_tag_t * );
817 case 'o': /* octet string in a supplied berval */
818 bval = va_arg( ap, struct berval * );
819 if ( bval->bv_val != NULL ) {
820 LBER_FREE( bval->bv_val );
826 case 'O': /* octet string - allocate & include length */
827 bvp = va_arg( ap, struct berval ** );
834 case 'B': /* bit string - allocate storage as needed */
835 ss = va_arg( ap, char ** );
840 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
843 case 'v': /* sequence of strings */
844 case 'V': /* sequence of strings + lengths */
845 case 'W': /* BVarray */
847 case 'x': /* skip the next element - whatever it is */
848 case '{': /* begin sequence */
849 case '[': /* begin set */
850 case '}': /* end sequence */
851 case ']': /* end set */
855 /* format should be good */