1 /* decode.c - ber input decoding routines */
4 * Copyright 1998-2002 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 xbyte = *ber->ber_ptr;
59 if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK ) {
63 for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
64 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 ) {
69 tag |= 0x00ffUL & (ber_tag_t) xbyte;
71 if ( ! (xbyte & LBER_MORE_TAG_MASK) ) {
77 if ( i == sizeof(ber_tag_t) ) {
85 ber_skip_tag( BerElement *ber, ber_len_t *len )
90 unsigned char netlen[sizeof(ber_len_t)];
92 assert( ber != NULL );
93 assert( len != NULL );
94 assert( LBER_VALID( ber ) );
97 * Any ber element looks like this: tag length contents.
98 * Assuming everything's ok, we return the tag byte (we
99 * can assume a single byte), and return the length in len.
102 * 1) definite lengths
103 * 2) primitive encodings used whenever possible
109 * First, we read the tag.
112 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT ) {
117 * Next, read the length. The first byte contains the length of
118 * the length. If bit 8 is set, the length is the long form,
119 * otherwise it's the short form. We don't allow a length that's
120 * greater than what we can hold in a ber_len_t.
123 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, netlen, noctets ) != noctets ) {
137 for( i = 0; i < noctets; i++ ) {
146 /* BER length should be non-negative */
151 /* BER element should have enough data left */
152 if( *len > (ber_len_t) ber_pvt_ber_remaining( ber ) ) {
155 ber->ber_tag = *ber->ber_ptr;
166 * This implementation assumes ber_skip_tag() only
167 * modifies ber_ptr field of the BerElement.
175 tag = ber_skip_tag( ber, len );
188 unsigned char buf[sizeof(ber_int_t)];
190 assert( ber != NULL );
191 assert( num != NULL );
192 assert( LBER_VALID( ber ) );
195 * The tag and length have already been stripped off. We should
196 * be sitting right before len bytes of 2's complement integer,
197 * ready to be read straight into an int. We may have to sign
198 * extend after we read it in.
201 if ( len > sizeof(ber_int_t) ) {
205 /* read into the low-order bytes of our buffer */
206 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
211 /* sign extend if necessary */
213 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
215 /* shift in the bytes */
216 for( i=0 ; i<len; i++ ) {
217 netnum = (netnum << 8 ) | buf[i];
225 ber->ber_tag = *ber->ber_ptr;
238 assert( ber != NULL );
239 assert( LBER_VALID( ber ) );
241 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
245 if ( ber_getnint( ber, num, len ) != len ) {
257 return ber_get_int( ber, num );
269 assert( ber != NULL );
270 assert( LBER_VALID( ber ) );
272 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
276 /* must fit within allocated space with termination */
277 if ( datalen >= *len ) {
281 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen ) {
284 ber->ber_tag = *ber->ber_ptr;
292 /* Definitions for recursive get_string
294 * ChArray, BvArray, and BvVec are self-explanatory.
295 * BvOff is a struct berval embedded in an array of larger structures
296 * of siz bytes at off bytes from the beginning of the struct.
298 enum bgbvc { ChArray, BvArray, BvVec, BvOff };
300 /* Use this single cookie for state, to keep actual
301 * stack use to the absolute minimum.
303 typedef struct bgbvr {
318 /* Recursive get_string, for decoding a vector of strings. The number
319 * of elements in the vector is limited only by available stack space.
320 * Each invocation consumes 24 bytes of stack on a 32-bit machine.
323 ber_get_stringbvr( bgbvr *b, int n )
325 struct berval bv, *bvp = NULL;
328 b->tag = ber_next_element( b->ber, &b->len, b->last );
330 b->tag = ber_first_element( b->ber, &b->len, &b->last );
332 if ( b->tag == LBER_DEFAULT )
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;
371 /* Do all local allocs before the recursion. Then there
372 * cannot possibly be any failures on the return trip.
374 if ( b->choice == BvVec )
375 bvp = LBER_MALLOC( sizeof( struct berval ));
377 if ( ber_get_stringbv( b->ber, &bv ) == LBER_DEFAULT ) {
378 if ( bvp ) LBER_FREE( bvp );
382 b->tag = ber_get_stringbvr( b, n+1 );
386 /* store my result */
389 (*b->res.c)[n] = bv.bv_val;
392 (*b->res.ba)[n] = bv;
395 (*b->res.bv)[n] = bvp;
399 *(BVarray)((long)(*b->res.ba)+n*b->siz+b->off) = bv;
402 /* Failure will propagate up and free in reverse
403 * order, which is actually ideal.
405 if ( bvp ) LBER_FREE( bvp );
406 LBER_FREE( bv.bv_val );
412 ber_get_stringbv( BerElement *ber, struct berval *bv )
416 assert( ber != NULL );
417 assert( bv != NULL );
419 assert( LBER_VALID( ber ) );
421 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
426 if ( (bv->bv_val = (char *) LBER_MALLOC( bv->bv_len + 1 )) == NULL ) {
430 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
431 bv->bv_len ) != bv->bv_len ) {
432 LBER_FREE( bv->bv_val );
436 bv->bv_val[bv->bv_len] = '\0';
437 ber->ber_tag = *ber->ber_ptr;
443 ber_get_stringa( BerElement *ber, char **buf )
448 assert( buf != NULL );
450 tag = ber_get_stringbv( ber, &bv );
457 ber_get_stringal( BerElement *ber, struct berval **bv )
461 assert( ber != NULL );
462 assert( bv != NULL );
464 *bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) );
469 tag = ber_get_stringbv( ber, *bv );
470 if ( tag == LBER_DEFAULT ) {
485 unsigned char unusedbits;
487 assert( ber != NULL );
488 assert( buf != NULL );
489 assert( blen != NULL );
491 assert( LBER_VALID( ber ) );
493 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
499 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL ) {
503 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
509 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
514 ber->ber_tag = *ber->ber_ptr;
516 *blen = datalen * 8 - unusedbits;
521 ber_get_null( BerElement *ber )
526 assert( ber != NULL );
527 assert( LBER_VALID( ber ) );
529 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
536 ber->ber_tag = *ber->ber_ptr;
549 assert( ber != NULL );
550 assert( boolval != NULL );
552 assert( LBER_VALID( ber ) );
554 rc = ber_get_int( ber, &longbool );
566 assert( ber != NULL );
567 assert( len != NULL );
568 assert( last != NULL );
570 /* skip the sequence header, use the len to mark where to stop */
571 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
575 ber->ber_tag = *ber->ber_ptr;
577 *last = ber->ber_ptr + *len;
579 if ( *last == ber->ber_ptr ) {
583 return ber_peek_tag( ber, len );
590 LDAP_CONST char *last )
592 assert( ber != NULL );
593 assert( len != NULL );
594 assert( last != NULL );
596 assert( LBER_VALID( ber ) );
598 if ( ber->ber_ptr == last ) {
602 return ber_peek_tag( ber, len );
607 ber_scanf ( BerElement *ber,
608 LDAP_CONST char *fmt,
612 LDAP_CONST char *fmt_reset;
621 struct berval **bvp, *bval;
630 assert( ber != NULL );
631 assert( fmt != NULL );
633 assert( LBER_VALID( ber ) );
638 LDAP_LOG(( "liblber", LDAP_LEVEL_ENTRY, "ber_scanf fmt (%s) ber:\n", fmt ));
639 BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
641 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
642 "ber_scanf fmt (%s) ber:\n", fmt );
643 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
646 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
647 /* When this is modified, remember to update
648 * the error-cleanup code below accordingly. */
650 case '!': { /* Hook */
651 BERDecodeCallback *f;
654 f = va_arg( ap, BERDecodeCallback * );
655 p = va_arg( ap, void * );
657 rc = (*f)( ber, p, 0 );
660 case 'a': /* octet string - allocate storage as needed */
661 ss = va_arg( ap, char ** );
662 rc = ber_get_stringa( ber, ss );
665 case 'b': /* boolean */
666 i = va_arg( ap, ber_int_t * );
667 rc = ber_get_boolean( ber, i );
670 case 'e': /* enumerated */
672 i = va_arg( ap, ber_int_t * );
673 rc = ber_get_int( ber, i );
676 case 'l': /* length of next item */
677 l = va_arg( ap, ber_len_t * );
678 rc = ber_peek_tag( ber, l );
682 rc = ber_get_null( ber );
685 case 's': /* octet string - in a buffer */
686 s = va_arg( ap, char * );
687 l = va_arg( ap, ber_len_t * );
688 rc = ber_get_stringb( ber, s, l );
691 case 'o': /* octet string in a supplied berval */
692 bval = va_arg( ap, struct berval * );
693 rc = ber_get_stringbv( ber, bval );
696 case 'O': /* octet string - allocate & include length */
697 bvp = va_arg( ap, struct berval ** );
698 rc = ber_get_stringal( ber, bvp );
701 case 'B': /* bit string - allocate storage as needed */
702 ss = va_arg( ap, char ** );
703 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
704 rc = ber_get_bitstringa( ber, ss, l );
707 case 't': /* tag of next item */
708 t = va_arg( ap, ber_tag_t * );
709 *t = rc = ber_peek_tag( ber, &len );
712 case 'T': /* skip tag of next item */
713 t = va_arg( ap, ber_tag_t * );
714 *t = rc = ber_skip_tag( ber, &len );
717 case 'v': /* sequence of strings */
719 bgbvr cookie = { ber, ChArray };
720 cookie.res.c = va_arg( ap, char *** );
721 rc = ber_get_stringbvr( &cookie, 0 );
725 case 'V': /* sequence of strings + lengths */
727 bgbvr cookie = { ber, BvVec };
728 cookie.res.bv = va_arg( ap, struct berval *** );
729 rc = ber_get_stringbvr( &cookie, 0 );
733 case 'W': /* bvarray */
735 bgbvr cookie = { ber, BvArray };
736 cookie.res.ba = va_arg( ap, struct berval ** );
737 rc = ber_get_stringbvr( &cookie, 0 );
741 case 'w': /* bvoffarray - must include address of
742 * a record len, and record offset.
743 * number of records will be returned thru
747 bgbvr cookie = { ber, BvOff };
748 cookie.res.ba = va_arg( ap, struct berval ** );
749 l = va_arg( ap, ber_len_t * );
751 cookie.off = va_arg( ap, ber_len_t );
752 rc = ber_get_stringbvr( &cookie, 0 );
757 case 'x': /* skip the next element - whatever it is */
758 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
761 ber->ber_tag = *ber->ber_ptr;
764 case '{': /* begin sequence */
765 case '[': /* begin set */
766 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V'
767 && *(fmt + 1) != 'W' && *(fmt + 1) != 'w' )
768 rc = ber_skip_tag( ber, &len );
771 case '}': /* end sequence */
772 case ']': /* end set */
776 if( ber->ber_debug ) {
778 LDAP_LOG(( "liblber", LDAP_LEVEL_ERR,
779 "ber_scanf: unknown fmt %c\n", *fmt ));
781 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
782 "ber_scanf: unknown fmt %c\n", *fmt );
791 if ( rc == LBER_DEFAULT ) {
793 * Error. Reclaim malloced memory that was given to the caller.
794 * Set allocated pointers to NULL, "data length" outvalues to 0.
798 for ( ; fmt_reset < fmt; fmt_reset++ ) {
799 switch ( *fmt_reset ) {
800 case '!': { /* Hook */
801 BERDecodeCallback *f;
804 f = va_arg( ap, BERDecodeCallback * );
805 p = va_arg( ap, void * );
807 (void) (*f)( ber, p, 1 );
810 case 'a': /* octet string - allocate storage as needed */
811 ss = va_arg( ap, char ** );
818 case 'b': /* boolean */
819 case 'e': /* enumerated */
821 (void) va_arg( ap, int * );
824 case 's': /* octet string - in a buffer */
825 (void) va_arg( ap, char * );
826 (void) va_arg( ap, ber_len_t * );
829 case 'l': /* length of next item */
830 (void) va_arg( ap, ber_len_t * );
833 case 't': /* tag of next item */
834 case 'T': /* skip tag of next item */
835 (void) va_arg( ap, ber_tag_t * );
838 case 'o': /* octet string in a supplied berval */
839 bval = va_arg( ap, struct berval * );
840 if ( bval->bv_val != NULL ) {
841 LBER_FREE( bval->bv_val );
847 case 'O': /* octet string - allocate & include length */
848 bvp = va_arg( ap, struct berval ** );
855 case 'B': /* bit string - allocate storage as needed */
856 ss = va_arg( ap, char ** );
861 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
864 case 'v': /* sequence of strings */
865 case 'V': /* sequence of strings + lengths */
866 case 'W': /* BVarray */
868 case 'x': /* skip the next element - whatever it is */
869 case '{': /* begin sequence */
870 case '[': /* begin set */
871 case '}': /* end sequence */
872 case ']': /* end set */
876 /* format should be good */