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 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 length should be non-negative */
149 /* BER element should have enough data left */
150 if( *len > (ber_len_t) ber_pvt_ber_remaining( ber ) ) {
153 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
164 * This implementation assumes ber_skip_tag() only
165 * modifies ber_ptr field of the BerElement.
173 tag = ber_skip_tag( ber, len );
186 unsigned char buf[sizeof(ber_int_t)];
188 assert( ber != NULL );
189 assert( num != NULL );
190 assert( LBER_VALID( ber ) );
193 * The tag and length have already been stripped off. We should
194 * be sitting right before len bytes of 2's complement integer,
195 * ready to be read straight into an int. We may have to sign
196 * extend after we read it in.
199 if ( len > sizeof(ber_int_t) ) {
203 /* read into the low-order bytes of our buffer */
204 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
209 /* sign extend if necessary */
211 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
213 /* shift in the bytes */
214 for( i=0 ; i<len; i++ ) {
215 netnum = (netnum << 8 ) | buf[i];
223 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
236 assert( ber != NULL );
237 assert( LBER_VALID( ber ) );
239 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
243 if ( ber_getnint( ber, num, len ) != len ) {
255 return ber_get_int( ber, num );
267 assert( ber != NULL );
268 assert( LBER_VALID( ber ) );
270 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
274 /* must fit within allocated space with termination */
275 if ( datalen >= *len ) {
279 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen ) {
282 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
290 /* Definitions for recursive get_string
292 * ChArray, BvArray, and BvVec are self-explanatory.
293 * BvOff is a struct berval embedded in an array of larger structures
294 * of siz bytes at off bytes from the beginning of the struct.
296 enum bgbvc { ChArray, BvArray, BvVec, BvOff };
298 /* Use this single cookie for state, to keep actual
299 * stack use to the absolute minimum.
301 typedef struct bgbvr {
317 /* Recursive get_string, for decoding a vector of strings. The number
318 * of elements in the vector is limited only by available stack space.
319 * Each invocation consumes 24 bytes of stack on a 32-bit machine.
322 ber_get_stringbvr( bgbvr *b, int n )
324 struct berval bv, *bvp = NULL;
327 b->tag = ber_next_element( b->ber, &b->len, b->last );
329 b->tag = ber_first_element( b->ber, &b->len, &b->last );
331 if ( b->tag == LBER_DEFAULT )
339 /* Allocate the result vector */
342 *b->res.c = LBER_MALLOC( (n+1) * sizeof( char * ));
343 if ( *b->res.c == NULL )
345 (*b->res.c)[n] = NULL;
348 *b->res.ba = LBER_MALLOC( (n+1) * sizeof( struct berval ));
349 if ( *b->res.ba == NULL )
351 (*b->res.ba)[n].bv_val = NULL;
354 *b->res.bv = LBER_MALLOC( (n+1) * sizeof( struct berval *));
355 if ( *b->res.bv == NULL )
357 (*b->res.bv)[n] = NULL;
360 *b->res.ba = LBER_MALLOC( (n+1) * b->siz );
361 if ( *b->res.ba == NULL )
363 ((struct berval *)((long)(*b->res.ba) + n*b->siz +
364 b->off))->bv_val = NULL;
370 /* Do all local allocs before the recursion. Then there
371 * cannot possibly be any failures on the return trip.
373 if ( b->choice == BvVec )
374 bvp = LBER_MALLOC( sizeof( struct berval ));
376 if ( ber_get_stringbv( b->ber, &bv, b->alloc ) == LBER_DEFAULT ) {
377 if ( bvp ) LBER_FREE( bvp );
381 b->tag = ber_get_stringbvr( b, n+1 );
385 /* store my result */
388 (*b->res.c)[n] = bv.bv_val;
391 (*b->res.ba)[n] = bv;
394 (*b->res.bv)[n] = bvp;
398 *(BerVarray)((long)(*b->res.ba)+n*b->siz+b->off) = bv;
401 /* Failure will propagate up and free in reverse
402 * order, which is actually ideal.
404 if ( b->alloc ) LBER_FREE( bv.bv_val );
405 if ( bvp ) LBER_FREE( bvp );
411 ber_get_stringbv( BerElement *ber, struct berval *bv, int alloc )
415 assert( ber != NULL );
416 assert( bv != NULL );
418 assert( LBER_VALID( ber ) );
420 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
425 if ( (ber_len_t) ber_pvt_ber_remaining( ber ) < bv->bv_len ) {
430 if ( (bv->bv_val = (char *) LBER_MALLOC( bv->bv_len + 1 )) == NULL ) {
434 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
435 bv->bv_len ) != bv->bv_len ) {
436 LBER_FREE( bv->bv_val );
441 bv->bv_val = ber->ber_ptr;
442 ber->ber_ptr += bv->bv_len;
444 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
445 bv->bv_val[bv->bv_len] = '\0';
451 ber_get_stringa( BerElement *ber, char **buf )
456 assert( buf != NULL );
458 tag = ber_get_stringbv( ber, &bv, 1 );
465 ber_get_stringal( BerElement *ber, struct berval **bv )
469 assert( ber != NULL );
470 assert( bv != NULL );
472 *bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) );
477 tag = ber_get_stringbv( ber, *bv, 1 );
478 if ( tag == LBER_DEFAULT ) {
493 unsigned char unusedbits;
495 assert( ber != NULL );
496 assert( buf != NULL );
497 assert( blen != NULL );
499 assert( LBER_VALID( ber ) );
501 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
507 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL ) {
511 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
517 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
522 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
524 *blen = datalen * 8 - unusedbits;
529 ber_get_null( BerElement *ber )
534 assert( ber != NULL );
535 assert( LBER_VALID( ber ) );
537 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
544 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
557 assert( ber != NULL );
558 assert( boolval != NULL );
560 assert( LBER_VALID( ber ) );
562 rc = ber_get_int( ber, &longbool );
574 assert( ber != NULL );
575 assert( len != NULL );
576 assert( last != NULL );
578 /* skip the sequence header, use the len to mark where to stop */
579 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
583 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
585 *last = ber->ber_ptr + *len;
587 if ( *last == ber->ber_ptr ) {
591 return ber_peek_tag( ber, len );
598 LDAP_CONST char *last )
600 assert( ber != NULL );
601 assert( len != NULL );
602 assert( last != NULL );
604 assert( LBER_VALID( ber ) );
606 if ( ber->ber_ptr == last ) {
610 return ber_peek_tag( ber, len );
615 ber_scanf ( BerElement *ber,
616 LDAP_CONST char *fmt,
620 LDAP_CONST char *fmt_reset;
629 struct berval **bvp, *bval;
638 assert( ber != NULL );
639 assert( fmt != NULL );
641 assert( LBER_VALID( ber ) );
646 LDAP_LOG(( "liblber", LDAP_LEVEL_ENTRY, "ber_scanf fmt (%s) ber:\n", fmt ));
647 BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
649 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
650 "ber_scanf fmt (%s) ber:\n", fmt );
651 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
654 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
655 /* When this is modified, remember to update
656 * the error-cleanup code below accordingly. */
658 case '!': { /* Hook */
659 BERDecodeCallback *f;
662 f = va_arg( ap, BERDecodeCallback * );
663 p = va_arg( ap, void * );
665 rc = (*f)( ber, p, 0 );
668 case 'a': /* octet string - allocate storage as needed */
669 ss = va_arg( ap, char ** );
670 rc = ber_get_stringa( ber, ss );
673 case 'b': /* boolean */
674 i = va_arg( ap, ber_int_t * );
675 rc = ber_get_boolean( ber, i );
678 case 'e': /* enumerated */
680 i = va_arg( ap, ber_int_t * );
681 rc = ber_get_int( ber, i );
684 case 'l': /* length of next item */
685 l = va_arg( ap, ber_len_t * );
686 rc = ber_peek_tag( ber, l );
690 rc = ber_get_null( ber );
693 case 's': /* octet string - in a buffer */
694 s = va_arg( ap, char * );
695 l = va_arg( ap, ber_len_t * );
696 rc = ber_get_stringb( ber, s, l );
699 case 'm': /* octet string in berval, in-place */
700 bval = va_arg( ap, struct berval * );
701 rc = ber_get_stringbv( ber, bval, 0 );
704 case 'o': /* octet string in a supplied berval */
705 bval = va_arg( ap, struct berval * );
706 rc = ber_get_stringbv( ber, bval, 1 );
709 case 'O': /* octet string - allocate & include length */
710 bvp = va_arg( ap, struct berval ** );
711 rc = ber_get_stringal( ber, bvp );
714 case 'B': /* bit string - allocate storage as needed */
715 ss = va_arg( ap, char ** );
716 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
717 rc = ber_get_bitstringa( ber, ss, l );
720 case 't': /* tag of next item */
721 t = va_arg( ap, ber_tag_t * );
722 *t = rc = ber_peek_tag( ber, &len );
725 case 'T': /* skip tag of next item */
726 t = va_arg( ap, ber_tag_t * );
727 *t = rc = ber_skip_tag( ber, &len );
730 case 'v': /* sequence of strings */
732 bgbvr cookie = { ChArray };
734 cookie.res.c = va_arg( ap, char *** );
736 rc = ber_get_stringbvr( &cookie, 0 );
740 case 'V': /* sequence of strings + lengths */
742 bgbvr cookie = { BvVec };
744 cookie.res.bv = va_arg( ap, struct berval *** );
746 rc = ber_get_stringbvr( &cookie, 0 );
750 case 'W': /* bvarray */
752 bgbvr cookie = { BvArray };
754 cookie.res.ba = va_arg( ap, struct berval ** );
756 rc = ber_get_stringbvr( &cookie, 0 );
760 case 'M': /* bvoffarray - must include address of
761 * a record len, and record offset.
762 * number of records will be returned thru
763 * len ptr on finish. parsed in-place.
766 bgbvr cookie = { BvOff };
768 cookie.res.ba = va_arg( ap, struct berval ** );
770 l = va_arg( ap, ber_len_t * );
772 cookie.off = va_arg( ap, ber_len_t );
773 rc = ber_get_stringbvr( &cookie, 0 );
778 case 'x': /* skip the next element - whatever it is */
779 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
782 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
785 case '{': /* begin sequence */
786 case '[': /* begin set */
787 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V'
788 && *(fmt + 1) != 'W' && *(fmt + 1) != 'M' )
789 rc = ber_skip_tag( ber, &len );
792 case '}': /* end sequence */
793 case ']': /* end set */
797 if( ber->ber_debug ) {
799 LDAP_LOG(( "liblber", LDAP_LEVEL_ERR,
800 "ber_scanf: unknown fmt %c\n", *fmt ));
802 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
803 "ber_scanf: unknown fmt %c\n", *fmt );
812 if ( rc == LBER_DEFAULT ) {
814 * Error. Reclaim malloced memory that was given to the caller.
815 * Set allocated pointers to NULL, "data length" outvalues to 0.
819 for ( ; fmt_reset < fmt; fmt_reset++ ) {
820 switch ( *fmt_reset ) {
821 case '!': { /* Hook */
822 BERDecodeCallback *f;
825 f = va_arg( ap, BERDecodeCallback * );
826 p = va_arg( ap, void * );
828 (void) (*f)( ber, p, 1 );
831 case 'a': /* octet string - allocate storage as needed */
832 ss = va_arg( ap, char ** );
839 case 'b': /* boolean */
840 case 'e': /* enumerated */
842 (void) va_arg( ap, int * );
845 case 's': /* octet string - in a buffer */
846 (void) va_arg( ap, char * );
847 (void) va_arg( ap, ber_len_t * );
850 case 'l': /* length of next item */
851 (void) va_arg( ap, ber_len_t * );
854 case 't': /* tag of next item */
855 case 'T': /* skip tag of next item */
856 (void) va_arg( ap, ber_tag_t * );
859 case 'o': /* octet string in a supplied berval */
860 bval = va_arg( ap, struct berval * );
861 if ( bval->bv_val != NULL ) {
862 LBER_FREE( bval->bv_val );
868 case 'O': /* octet string - allocate & include length */
869 bvp = va_arg( ap, struct berval ** );
876 case 'B': /* bit string - allocate storage as needed */
877 ss = va_arg( ap, char ** );
882 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
885 case 'v': /* sequence of strings */
886 case 'V': /* sequence of strings + lengths */
887 case 'W': /* BerVarray */
888 case 'm': /* berval in-place */
889 case 'M': /* BVoff array in-place */
891 case 'x': /* skip the next element - whatever it is */
892 case '{': /* begin sequence */
893 case '[': /* begin set */
894 case '}': /* end sequence */
895 case ']': /* end set */
899 /* format should be good */