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 enum bgbvc { ChArray, BvArray, BvVec };
285 /* Use this single cookie for state, to keep actual
286 * stack use to the absolute minimum.
288 typedef struct bgbvr {
301 /* Recursive get_string, for decoding a vector of strings. The number
302 * of elements in the vector is limited only by available stack space.
303 * Each invocation consumes 24 bytes of stack on a 32-bit machine.
306 ber_get_stringbvr( bgbvr *b, int n )
308 struct berval bv, *bvp = NULL;
311 b->tag = ber_next_element( b->ber, &b->len, b->last );
313 b->tag = ber_first_element( b->ber, &b->len, &b->last );
315 if ( b->tag == LBER_DEFAULT )
321 /* Allocate the result vector */
324 *b->res.c = LBER_MALLOC( (n+1) * sizeof( char * ));
325 (*b->res.c)[n] = NULL;
328 *b->res.ba = LBER_MALLOC( (n+1) * sizeof( struct berval ));
329 (*b->res.ba)[n].bv_val = NULL;
332 *b->res.bv = LBER_MALLOC( (n+1) * sizeof( struct berval *));
333 (*b->res.bv)[n] = NULL;
336 /* Did the malloc succeed? */
337 if ( *b->res.c == NULL )
342 /* Do all local allocs before the recursion. Then there
343 * cannot possibly be any failures on the return trip.
345 if ( b->choice == BvVec )
346 bvp = LBER_MALLOC( sizeof( struct berval ));
348 if ( ber_get_stringbv( b->ber, &bv ) == LBER_DEFAULT ) {
349 if ( bvp ) LBER_FREE( bvp );
353 b->tag = ber_get_stringbvr( b, n+1 );
357 /* store my result */
360 (*b->res.c)[n] = bv.bv_val;
363 (*b->res.ba)[n] = bv;
366 (*b->res.bv)[n] = bvp;
371 /* Failure will propagate up and free in reverse
372 * order, which is actually ideal.
374 if ( bvp ) LBER_FREE( bvp );
375 LBER_FREE( bv.bv_val );
381 ber_get_stringbv( BerElement *ber, struct berval *bv )
385 assert( ber != NULL );
386 assert( bv != NULL );
388 assert( LBER_VALID( ber ) );
390 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
395 if ( (bv->bv_val = (char *) LBER_MALLOC( bv->bv_len + 1 )) == NULL ) {
399 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
400 bv->bv_len ) != bv->bv_len ) {
401 LBER_FREE( bv->bv_val );
405 bv->bv_val[bv->bv_len] = '\0';
411 ber_get_stringa( BerElement *ber, char **buf )
416 assert( buf != NULL );
418 tag = ber_get_stringbv( ber, &bv );
425 ber_get_stringal( BerElement *ber, struct berval **bv )
429 assert( ber != NULL );
430 assert( bv != NULL );
432 *bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) );
437 tag = ber_get_stringbv( ber, *bv );
438 if ( tag == LBER_DEFAULT ) {
453 unsigned char unusedbits;
455 assert( ber != NULL );
456 assert( buf != NULL );
457 assert( blen != NULL );
459 assert( LBER_VALID( ber ) );
461 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
467 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL ) {
471 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
477 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
483 *blen = datalen * 8 - unusedbits;
488 ber_get_null( BerElement *ber )
493 assert( ber != NULL );
494 assert( LBER_VALID( ber ) );
496 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
515 assert( ber != NULL );
516 assert( boolval != NULL );
518 assert( LBER_VALID( ber ) );
520 rc = ber_get_int( ber, &longbool );
532 assert( ber != NULL );
533 assert( len != NULL );
534 assert( last != NULL );
536 /* skip the sequence header, use the len to mark where to stop */
537 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
542 *last = ber->ber_ptr + *len;
544 if ( *last == ber->ber_ptr ) {
548 return ber_peek_tag( ber, len );
555 LDAP_CONST char *last )
557 assert( ber != NULL );
558 assert( len != NULL );
559 assert( last != NULL );
561 assert( LBER_VALID( ber ) );
563 if ( ber->ber_ptr == last ) {
567 return ber_peek_tag( ber, len );
570 /* Hopefully no one sends vectors with more elements than this */
571 /* Don't define this! ber_get_stringbvr works much much better! */
572 /* #define TMP_SLOTS 1024 */
576 ber_scanf ( BerElement *ber,
577 LDAP_CONST char *fmt,
581 LDAP_CONST char *fmt_reset;
583 char *s, **ss, ***sss;
584 struct berval ***bv, **bvp, *bval;
594 assert( ber != NULL );
595 assert( fmt != NULL );
597 assert( LBER_VALID( ber ) );
602 LDAP_LOG(( "liblber", LDAP_LEVEL_ENTRY, "ber_scanf fmt (%s) ber:\n", fmt ));
603 BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
605 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
606 "ber_scanf fmt (%s) ber:\n", fmt );
607 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
610 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
611 /* When this is modified, remember to update
612 * the error-cleanup code below accordingly. */
614 case '!': { /* Hook */
615 BERDecodeCallback *f;
618 f = va_arg( ap, BERDecodeCallback * );
619 p = va_arg( ap, void * );
621 rc = (*f)( ber, p, 0 );
624 case 'a': /* octet string - allocate storage as needed */
625 ss = va_arg( ap, char ** );
626 rc = ber_get_stringa( ber, ss );
629 case 'b': /* boolean */
630 i = va_arg( ap, ber_int_t * );
631 rc = ber_get_boolean( ber, i );
634 case 'e': /* enumerated */
636 i = va_arg( ap, ber_int_t * );
637 rc = ber_get_int( ber, i );
640 case 'l': /* length of next item */
641 l = va_arg( ap, ber_len_t * );
642 rc = ber_peek_tag( ber, l );
646 rc = ber_get_null( ber );
649 case 's': /* octet string - in a buffer */
650 s = va_arg( ap, char * );
651 l = va_arg( ap, ber_len_t * );
652 rc = ber_get_stringb( ber, s, l );
655 case 'o': /* octet string in a supplied berval */
656 bval = va_arg( ap, struct berval * );
657 rc = ber_get_stringbv( ber, bval );
660 case 'O': /* octet string - allocate & include length */
661 bvp = va_arg( ap, struct berval ** );
662 rc = ber_get_stringal( ber, bvp );
665 case 'B': /* bit string - allocate storage as needed */
666 ss = va_arg( ap, char ** );
667 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
668 rc = ber_get_bitstringa( ber, ss, l );
671 case 't': /* tag of next item */
672 t = va_arg( ap, ber_tag_t * );
673 *t = rc = ber_peek_tag( ber, &len );
676 case 'T': /* skip tag of next item */
677 t = va_arg( ap, ber_tag_t * );
678 *t = rc = ber_skip_tag( ber, &len );
681 case 'v': /* sequence of strings */
684 char *tmp[TMP_SLOTS];
685 sss = va_arg( ap, char *** );
688 for ( tag = ber_first_element( ber, &len, &last );
689 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
690 tag = ber_next_element( ber, &len, last ) )
692 rc = ber_get_stringa( ber, &tmp[j] );
694 assert(j < TMP_SLOTS);
696 if (j > 0 && rc != LBER_DEFAULT ) {
697 *sss = (char **)LBER_MALLOC( (j+1) * sizeof(char *));
706 if ( rc == LBER_DEFAULT ) {
711 bgbvr cookie = { ber, ChArray };
712 cookie.res.c = va_arg( ap, char *** );
713 rc = ber_get_stringbvr( &cookie, 0 );
718 case 'V': /* sequence of strings + lengths */
721 struct berval *tmp[TMP_SLOTS];
722 bv = va_arg( ap, struct berval *** );
725 for ( tag = ber_first_element( ber, &len, &last );
726 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
727 tag = ber_next_element( ber, &len, last ) )
729 rc = ber_get_stringal( ber, &tmp[j] );
731 assert( j < TMP_SLOTS);
733 if (j > 0 && rc != LBER_DEFAULT ) {
734 *bv = (struct berval **)LBER_MALLOC( (j+1) * sizeof(struct berval *));
743 if ( rc == LBER_DEFAULT ) {
748 bgbvr cookie = { ber, BvVec };
749 cookie.res.bv = va_arg( ap, struct berval *** );
750 rc = ber_get_stringbvr( &cookie, 0 );
755 case 'W': /* bvarray */
758 struct berval tmp[TMP_SLOTS];
759 bvp = va_arg( ap, struct berval ** );
762 for ( tag = ber_first_element( ber, &len, &last );
763 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
764 tag = ber_next_element( ber, &len, last ) )
766 rc = ber_get_stringbv( ber, &tmp[j] );
768 assert( j < TMP_SLOTS);
770 if (j > 0 && rc != LBER_DEFAULT ) {
771 *bvp = (struct berval *)LBER_MALLOC( (j+1) * sizeof(struct berval));
775 (*bvp)[j].bv_val = NULL;
776 (*bvp)[j].bv_len = 0;
781 if ( rc == LBER_DEFAULT ) {
783 LBER_FREE(tmp[j].bv_val);
786 bgbvr cookie = { ber, BvArray };
787 cookie.res.ba = va_arg( ap, struct berval ** );
788 rc = ber_get_stringbvr( &cookie, 0 );
793 case 'x': /* skip the next element - whatever it is */
794 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
799 case '{': /* begin sequence */
800 case '[': /* begin set */
801 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V'
802 && *(fmt + 1) != 'W' )
803 rc = ber_skip_tag( ber, &len );
806 case '}': /* end sequence */
807 case ']': /* end set */
811 if( ber->ber_debug ) {
813 LDAP_LOG(( "liblber", LDAP_LEVEL_ERR,
814 "ber_scanf: unknown fmt %c\n", *fmt ));
816 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
817 "ber_scanf: unknown fmt %c\n", *fmt );
826 if ( rc == LBER_DEFAULT ) {
828 * Error. Reclaim malloced memory that was given to the caller.
829 * Set allocated pointers to NULL, "data length" outvalues to 0.
833 for ( ; fmt_reset < fmt; fmt_reset++ ) {
834 switch ( *fmt_reset ) {
835 case '!': { /* Hook */
836 BERDecodeCallback *f;
839 f = va_arg( ap, BERDecodeCallback * );
840 p = va_arg( ap, void * );
842 (void) (*f)( ber, p, 1 );
845 case 'a': /* octet string - allocate storage as needed */
846 ss = va_arg( ap, char ** );
853 case 'b': /* boolean */
854 case 'e': /* enumerated */
856 (void) va_arg( ap, int * );
859 case 's': /* octet string - in a buffer */
860 (void) va_arg( ap, char * );
861 (void) va_arg( ap, ber_len_t * );
864 case 'l': /* length of next item */
865 (void) va_arg( ap, ber_len_t * );
868 case 't': /* tag of next item */
869 case 'T': /* skip tag of next item */
870 (void) va_arg( ap, ber_tag_t * );
873 case 'o': /* octet string in a supplied berval */
874 bval = va_arg( ap, struct berval * );
875 if ( bval->bv_val != NULL ) {
876 LBER_FREE( bval->bv_val );
882 case 'O': /* octet string - allocate & include length */
883 bvp = va_arg( ap, struct berval ** );
890 case 'B': /* bit string - allocate storage as needed */
891 ss = va_arg( ap, char ** );
896 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
899 case 'v': /* sequence of strings */
900 case 'V': /* sequence of strings + lengths */
901 case 'W': /* BVarray */
903 case 'x': /* skip the next element - whatever it is */
904 case '{': /* begin sequence */
905 case '[': /* begin set */
906 case '}': /* end sequence */
907 case ']': /* end set */
911 /* format should be good */