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 {
316 /* Recursive get_string, for decoding a vector of strings. The number
317 * of elements in the vector is limited only by available stack space.
318 * Each invocation consumes 24 bytes of stack on a 32-bit machine.
321 ber_get_stringbvr( bgbvr *b, int n )
323 struct berval bv, *bvp = NULL;
326 b->tag = ber_next_element( b->ber, &b->len, b->last );
328 b->tag = ber_first_element( b->ber, &b->len, &b->last );
330 if ( b->tag == LBER_DEFAULT )
338 /* Allocate the result vector */
341 *b->res.c = LBER_MALLOC( (n+1) * sizeof( char * ));
342 if ( *b->res.c == NULL )
344 (*b->res.c)[n] = NULL;
347 *b->res.ba = LBER_MALLOC( (n+1) * sizeof( struct berval ));
348 if ( *b->res.ba == NULL )
350 (*b->res.ba)[n].bv_val = NULL;
353 *b->res.bv = LBER_MALLOC( (n+1) * sizeof( struct berval *));
354 if ( *b->res.bv == NULL )
356 (*b->res.bv)[n] = NULL;
359 *b->res.ba = LBER_MALLOC( (n+1) * b->siz );
360 if ( *b->res.ba == NULL )
362 ((struct berval *)((long)(*b->res.ba) + n*b->siz +
363 b->off))->bv_val = NULL;
369 /* Do all local allocs before the recursion. Then there
370 * cannot possibly be any failures on the return trip.
372 if ( b->choice == BvVec )
373 bvp = LBER_MALLOC( sizeof( struct berval ));
375 if ( ber_get_stringbv( b->ber, &bv ) == LBER_DEFAULT ) {
376 if ( bvp ) LBER_FREE( bvp );
380 b->tag = ber_get_stringbvr( b, n+1 );
384 /* store my result */
387 (*b->res.c)[n] = bv.bv_val;
390 (*b->res.ba)[n] = bv;
393 (*b->res.bv)[n] = bvp;
397 *(BVarray)((long)(*b->res.ba)+n*b->siz+b->off) = bv;
400 /* Failure will propagate up and free in reverse
401 * order, which is actually ideal.
403 if ( bvp ) LBER_FREE( bvp );
404 LBER_FREE( bv.bv_val );
410 ber_get_stringbv( BerElement *ber, struct berval *bv )
414 assert( ber != NULL );
415 assert( bv != NULL );
417 assert( LBER_VALID( ber ) );
419 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
424 if ( (bv->bv_val = (char *) LBER_MALLOC( bv->bv_len + 1 )) == NULL ) {
428 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
429 bv->bv_len ) != bv->bv_len ) {
430 LBER_FREE( bv->bv_val );
434 bv->bv_val[bv->bv_len] = '\0';
435 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
441 ber_get_stringa( BerElement *ber, char **buf )
446 assert( buf != NULL );
448 tag = ber_get_stringbv( ber, &bv );
455 ber_get_stringal( BerElement *ber, struct berval **bv )
459 assert( ber != NULL );
460 assert( bv != NULL );
462 *bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) );
467 tag = ber_get_stringbv( ber, *bv );
468 if ( tag == LBER_DEFAULT ) {
483 unsigned char unusedbits;
485 assert( ber != NULL );
486 assert( buf != NULL );
487 assert( blen != NULL );
489 assert( LBER_VALID( ber ) );
491 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
497 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL ) {
501 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
507 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
512 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
514 *blen = datalen * 8 - unusedbits;
519 ber_get_null( BerElement *ber )
524 assert( ber != NULL );
525 assert( LBER_VALID( ber ) );
527 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
534 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
547 assert( ber != NULL );
548 assert( boolval != NULL );
550 assert( LBER_VALID( ber ) );
552 rc = ber_get_int( ber, &longbool );
564 assert( ber != NULL );
565 assert( len != NULL );
566 assert( last != NULL );
568 /* skip the sequence header, use the len to mark where to stop */
569 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
573 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
575 *last = ber->ber_ptr + *len;
577 if ( *last == ber->ber_ptr ) {
581 return ber_peek_tag( ber, len );
588 LDAP_CONST char *last )
590 assert( ber != NULL );
591 assert( len != NULL );
592 assert( last != NULL );
594 assert( LBER_VALID( ber ) );
596 if ( ber->ber_ptr == last ) {
600 return ber_peek_tag( ber, len );
605 ber_scanf ( BerElement *ber,
606 LDAP_CONST char *fmt,
610 LDAP_CONST char *fmt_reset;
619 struct berval **bvp, *bval;
628 assert( ber != NULL );
629 assert( fmt != NULL );
631 assert( LBER_VALID( ber ) );
636 LDAP_LOG(( "liblber", LDAP_LEVEL_ENTRY, "ber_scanf fmt (%s) ber:\n", fmt ));
637 BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
639 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
640 "ber_scanf fmt (%s) ber:\n", fmt );
641 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
644 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
645 /* When this is modified, remember to update
646 * the error-cleanup code below accordingly. */
648 case '!': { /* Hook */
649 BERDecodeCallback *f;
652 f = va_arg( ap, BERDecodeCallback * );
653 p = va_arg( ap, void * );
655 rc = (*f)( ber, p, 0 );
658 case 'a': /* octet string - allocate storage as needed */
659 ss = va_arg( ap, char ** );
660 rc = ber_get_stringa( ber, ss );
663 case 'b': /* boolean */
664 i = va_arg( ap, ber_int_t * );
665 rc = ber_get_boolean( ber, i );
668 case 'e': /* enumerated */
670 i = va_arg( ap, ber_int_t * );
671 rc = ber_get_int( ber, i );
674 case 'l': /* length of next item */
675 l = va_arg( ap, ber_len_t * );
676 rc = ber_peek_tag( ber, l );
680 rc = ber_get_null( ber );
683 case 's': /* octet string - in a buffer */
684 s = va_arg( ap, char * );
685 l = va_arg( ap, ber_len_t * );
686 rc = ber_get_stringb( ber, s, l );
689 case 'o': /* octet string in a supplied berval */
690 bval = va_arg( ap, struct berval * );
691 rc = ber_get_stringbv( ber, bval );
694 case 'O': /* octet string - allocate & include length */
695 bvp = va_arg( ap, struct berval ** );
696 rc = ber_get_stringal( ber, bvp );
699 case 'B': /* bit string - allocate storage as needed */
700 ss = va_arg( ap, char ** );
701 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
702 rc = ber_get_bitstringa( ber, ss, l );
705 case 't': /* tag of next item */
706 t = va_arg( ap, ber_tag_t * );
707 *t = rc = ber_peek_tag( ber, &len );
710 case 'T': /* skip tag of next item */
711 t = va_arg( ap, ber_tag_t * );
712 *t = rc = ber_skip_tag( ber, &len );
715 case 'v': /* sequence of strings */
717 bgbvr cookie = { ber, ChArray };
718 cookie.res.c = va_arg( ap, char *** );
719 rc = ber_get_stringbvr( &cookie, 0 );
723 case 'V': /* sequence of strings + lengths */
725 bgbvr cookie = { ber, BvVec };
726 cookie.res.bv = va_arg( ap, struct berval *** );
727 rc = ber_get_stringbvr( &cookie, 0 );
731 case 'W': /* bvarray */
733 bgbvr cookie = { ber, BvArray };
734 cookie.res.ba = va_arg( ap, struct berval ** );
735 rc = ber_get_stringbvr( &cookie, 0 );
739 case 'w': /* bvoffarray - must include address of
740 * a record len, and record offset.
741 * number of records will be returned thru
745 bgbvr cookie = { ber, BvOff };
746 cookie.res.ba = va_arg( ap, struct berval ** );
747 l = va_arg( ap, ber_len_t * );
749 cookie.off = va_arg( ap, ber_len_t );
750 rc = ber_get_stringbvr( &cookie, 0 );
755 case 'x': /* skip the next element - whatever it is */
756 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
759 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
762 case '{': /* begin sequence */
763 case '[': /* begin set */
764 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V'
765 && *(fmt + 1) != 'W' && *(fmt + 1) != 'w' )
766 rc = ber_skip_tag( ber, &len );
769 case '}': /* end sequence */
770 case ']': /* end set */
774 if( ber->ber_debug ) {
776 LDAP_LOG(( "liblber", LDAP_LEVEL_ERR,
777 "ber_scanf: unknown fmt %c\n", *fmt ));
779 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
780 "ber_scanf: unknown fmt %c\n", *fmt );
789 if ( rc == LBER_DEFAULT ) {
791 * Error. Reclaim malloced memory that was given to the caller.
792 * Set allocated pointers to NULL, "data length" outvalues to 0.
796 for ( ; fmt_reset < fmt; fmt_reset++ ) {
797 switch ( *fmt_reset ) {
798 case '!': { /* Hook */
799 BERDecodeCallback *f;
802 f = va_arg( ap, BERDecodeCallback * );
803 p = va_arg( ap, void * );
805 (void) (*f)( ber, p, 1 );
808 case 'a': /* octet string - allocate storage as needed */
809 ss = va_arg( ap, char ** );
816 case 'b': /* boolean */
817 case 'e': /* enumerated */
819 (void) va_arg( ap, int * );
822 case 's': /* octet string - in a buffer */
823 (void) va_arg( ap, char * );
824 (void) va_arg( ap, ber_len_t * );
827 case 'l': /* length of next item */
828 (void) va_arg( ap, ber_len_t * );
831 case 't': /* tag of next item */
832 case 'T': /* skip tag of next item */
833 (void) va_arg( ap, ber_tag_t * );
836 case 'o': /* octet string in a supplied berval */
837 bval = va_arg( ap, struct berval * );
838 if ( bval->bv_val != NULL ) {
839 LBER_FREE( bval->bv_val );
845 case 'O': /* octet string - allocate & include length */
846 bvp = va_arg( ap, struct berval ** );
853 case 'B': /* bit string - allocate storage as needed */
854 ss = va_arg( ap, char ** );
859 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
862 case 'v': /* sequence of strings */
863 case 'V': /* sequence of strings + lengths */
864 case 'W': /* BVarray */
866 case 'x': /* skip the next element - whatever it is */
867 case '{': /* begin sequence */
868 case '[': /* begin set */
869 case '}': /* end sequence */
870 case ']': /* end set */
874 /* format should be good */