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, 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 recursive get_string
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 {
312 /* Recursive get_string, for decoding a vector of strings. The number
313 * of elements in the vector is limited only by available stack space.
314 * Each invocation consumes 24 bytes of stack on a 32-bit machine.
317 ber_get_stringbvr( bgbvr *b, int n )
319 struct berval bv, *bvp = NULL;
322 b->tag = ber_next_element( b->ber, &b->len, b->last );
324 b->tag = ber_first_element( b->ber, &b->len, &b->last );
326 if ( b->tag == LBER_DEFAULT )
334 /* Allocate the result vector */
337 *b->res.c = LBER_MALLOC( (n+1) * sizeof( char * ));
338 if ( *b->res.c == NULL )
340 (*b->res.c)[n] = NULL;
343 *b->res.ba = LBER_MALLOC( (n+1) * sizeof( struct berval ));
344 if ( *b->res.ba == NULL )
346 (*b->res.ba)[n].bv_val = NULL;
349 *b->res.bv = LBER_MALLOC( (n+1) * sizeof( struct berval *));
350 if ( *b->res.bv == NULL )
352 (*b->res.bv)[n] = NULL;
355 *b->res.ba = LBER_MALLOC( (n+1) * b->siz );
356 if ( *b->res.ba == NULL )
358 ((struct berval *)((long)(*b->res.ba) + n*b->siz +
359 b->off))->bv_val = NULL;
365 /* Do all local allocs before the recursion. Then there
366 * cannot possibly be any failures on the return trip.
368 if ( b->choice == BvVec )
369 bvp = LBER_MALLOC( sizeof( struct berval ));
371 if ( ber_get_stringbv( b->ber, &bv, b->alloc ) == LBER_DEFAULT ) {
372 if ( bvp ) LBER_FREE( bvp );
376 b->tag = ber_get_stringbvr( b, n+1 );
380 /* store my result */
383 (*b->res.c)[n] = bv.bv_val;
386 (*b->res.ba)[n] = bv;
389 (*b->res.bv)[n] = bvp;
393 *(BerVarray)((long)(*b->res.ba)+n*b->siz+b->off) = bv;
396 /* Failure will propagate up and free in reverse
397 * order, which is actually ideal.
399 if ( b->alloc ) LBER_FREE( bv.bv_val );
400 if ( bvp ) LBER_FREE( bvp );
406 ber_get_stringbv( BerElement *ber, struct berval *bv, int alloc )
410 assert( ber != NULL );
411 assert( bv != NULL );
413 assert( LBER_VALID( ber ) );
415 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
420 if ( (ber_len_t) ber_pvt_ber_remaining( ber ) < bv->bv_len ) {
425 if ( (bv->bv_val = (char *) LBER_MALLOC( bv->bv_len + 1 )) == NULL ) {
429 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
430 bv->bv_len ) != bv->bv_len ) {
431 LBER_FREE( bv->bv_val );
436 bv->bv_val = ber->ber_ptr;
437 ber->ber_ptr += bv->bv_len;
439 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
440 bv->bv_val[bv->bv_len] = '\0';
446 ber_get_stringa( BerElement *ber, char **buf )
451 assert( buf != NULL );
453 tag = ber_get_stringbv( ber, &bv, 1 );
460 ber_get_stringal( BerElement *ber, struct berval **bv )
464 assert( ber != NULL );
465 assert( bv != NULL );
467 *bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) );
472 tag = ber_get_stringbv( ber, *bv, 1 );
473 if ( tag == LBER_DEFAULT ) {
488 unsigned char unusedbits;
490 assert( ber != NULL );
491 assert( buf != NULL );
492 assert( blen != NULL );
494 assert( LBER_VALID( ber ) );
496 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
502 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL ) {
506 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
512 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
517 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
519 *blen = datalen * 8 - unusedbits;
524 ber_get_null( BerElement *ber )
529 assert( ber != NULL );
530 assert( LBER_VALID( ber ) );
532 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
539 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
552 assert( ber != NULL );
553 assert( boolval != NULL );
555 assert( LBER_VALID( ber ) );
557 rc = ber_get_int( ber, &longbool );
569 assert( ber != NULL );
570 assert( len != NULL );
571 assert( last != NULL );
573 /* skip the sequence header, use the len to mark where to stop */
574 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
578 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
580 *last = ber->ber_ptr + *len;
582 if ( *last == ber->ber_ptr ) {
586 return ber_peek_tag( ber, len );
593 LDAP_CONST char *last )
595 assert( ber != NULL );
596 assert( len != NULL );
597 assert( last != NULL );
599 assert( LBER_VALID( ber ) );
601 if ( ber->ber_ptr >= last ) {
605 return ber_peek_tag( ber, len );
610 ber_scanf ( BerElement *ber,
611 LDAP_CONST char *fmt,
615 LDAP_CONST char *fmt_reset;
617 struct berval **bvp, *bval;
626 assert( ber != NULL );
627 assert( fmt != NULL );
629 assert( LBER_VALID( ber ) );
634 LDAP_LOG( BER, ENTRY, "ber_scanf fmt (%s) ber:\n", fmt, 0, 0 );
636 if ( LDAP_LOGS_TEST(BER, DETAIL2 ))
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 'm': /* octet string in berval, in-place */
690 bval = va_arg( ap, struct berval * );
691 rc = ber_get_stringbv( ber, bval, 0 );
694 case 'o': /* octet string in a supplied berval */
695 bval = va_arg( ap, struct berval * );
696 rc = ber_get_stringbv( ber, bval, 1 );
699 case 'O': /* octet string - allocate & include length */
700 bvp = va_arg( ap, struct berval ** );
701 rc = ber_get_stringal( ber, bvp );
704 case 'B': /* bit string - allocate storage as needed */
705 ss = va_arg( ap, char ** );
706 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
707 rc = ber_get_bitstringa( ber, ss, l );
710 case 't': /* tag of next item */
711 t = va_arg( ap, ber_tag_t * );
712 *t = rc = ber_peek_tag( ber, &len );
715 case 'T': /* skip tag of next item */
716 t = va_arg( ap, ber_tag_t * );
717 *t = rc = ber_skip_tag( ber, &len );
720 case 'v': /* sequence of strings */
722 bgbvr cookie = { ChArray };
724 cookie.res.c = va_arg( ap, char *** );
726 rc = ber_get_stringbvr( &cookie, 0 );
730 case 'V': /* sequence of strings + lengths */
732 bgbvr cookie = { BvVec };
734 cookie.res.bv = va_arg( ap, struct berval *** );
736 rc = ber_get_stringbvr( &cookie, 0 );
740 case 'W': /* bvarray */
742 bgbvr cookie = { BvArray };
744 cookie.res.ba = va_arg( ap, struct berval ** );
746 rc = ber_get_stringbvr( &cookie, 0 );
750 case 'M': /* bvoffarray - must include address of
751 * a record len, and record offset.
752 * number of records will be returned thru
753 * len ptr on finish. parsed in-place.
756 bgbvr cookie = { BvOff };
758 cookie.res.ba = va_arg( ap, struct berval ** );
760 l = va_arg( ap, ber_len_t * );
762 cookie.off = va_arg( ap, ber_len_t );
763 rc = ber_get_stringbvr( &cookie, 0 );
768 case 'x': /* skip the next element - whatever it is */
769 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
772 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
775 case '{': /* begin sequence */
776 case '[': /* begin set */
777 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V'
778 && *(fmt + 1) != 'W' && *(fmt + 1) != 'M' )
779 rc = ber_skip_tag( ber, &len );
782 case '}': /* end sequence */
783 case ']': /* end set */
787 if( ber->ber_debug ) {
790 "ber_scanf: unknown fmt %c\n", *fmt, 0, 0 );
792 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
793 "ber_scanf: unknown fmt %c\n", *fmt );
802 if ( rc == LBER_DEFAULT ) {
804 * Error. Reclaim malloced memory that was given to the caller.
805 * Set allocated pointers to NULL, "data length" outvalues to 0.
809 for ( ; fmt_reset < fmt; fmt_reset++ ) {
810 switch ( *fmt_reset ) {
811 case '!': { /* Hook */
812 BERDecodeCallback *f;
815 f = va_arg( ap, BERDecodeCallback * );
816 p = va_arg( ap, void * );
818 (void) (*f)( ber, p, 1 );
821 case 'a': /* octet string - allocate storage as needed */
822 ss = va_arg( ap, char ** );
829 case 'b': /* boolean */
830 case 'e': /* enumerated */
832 (void) va_arg( ap, int * );
835 case 's': /* octet string - in a buffer */
836 (void) va_arg( ap, char * );
837 (void) va_arg( ap, ber_len_t * );
840 case 'l': /* length of next item */
841 (void) va_arg( ap, ber_len_t * );
844 case 't': /* tag of next item */
845 case 'T': /* skip tag of next item */
846 (void) va_arg( ap, ber_tag_t * );
849 case 'o': /* octet string in a supplied berval */
850 bval = va_arg( ap, struct berval * );
851 if ( bval->bv_val != NULL ) {
852 LBER_FREE( bval->bv_val );
858 case 'O': /* octet string - allocate & include length */
859 bvp = va_arg( ap, struct berval ** );
866 case 'B': /* bit string - allocate storage as needed */
867 ss = va_arg( ap, char ** );
872 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
875 case 'v': /* sequence of strings */
876 case 'V': /* sequence of strings + lengths */
877 case 'W': /* BerVarray */
878 case 'm': /* berval in-place */
879 case 'M': /* BVoff array in-place */
881 case 'x': /* skip the next element - whatever it is */
882 case '{': /* begin sequence */
883 case '[': /* begin set */
884 case '}': /* end sequence */
885 case ']': /* end set */
889 /* format should be good */