1 /* decode.c - ber input decoding routines */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2009 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
16 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
17 * All rights reserved.
19 * Redistribution and use in source and binary forms are permitted
20 * provided that this notice is preserved and that due credit is given
21 * to the University of Michigan at Ann Arbor. The name of the University
22 * may not be used to endorse or promote products derived from this
23 * software without specific prior written permission. This software
24 * is provided ``as is'' without express or implied warranty.
27 * This work was originally developed by the University of Michigan
28 * (as part of U-MICH LDAP).
35 #include <ac/stdlib.h>
36 #include <ac/stdarg.h>
37 #include <ac/string.h>
38 #include <ac/socket.h>
43 /* out->bv_len should be the buffer size on input */
45 ber_decode_oid( BerValue *in, BerValue *out )
47 const unsigned char *der;
54 assert( out != NULL );
56 /* need 4 chars/inbyte + \0 for input={7f 7f 7f...} */
57 if ( !out->bv_val || (out->bv_len+3)/4 <= in->bv_len )
61 der = (unsigned char *) in->bv_val;
63 for ( i=0; i < in->bv_len; i++ ) {
65 if ( !( der[i] & 0x80 )) {
67 /* Initial "x.y": val=x*40+y, x<=2, y<40 if x<2 */
69 val1 = (val < 80 ? val/40 : 2);
71 ptr += sprintf( ptr, "%u", val1 );
73 ptr += sprintf( ptr, ".%lu", val );
75 } else if ( val - 1UL < LBER_OID_COMPONENT_MAX >> 7 ) {
78 /* val would overflow, or is 0 from invalid initial 0x80 octet */
82 if ( ptr == NULL || val != 0 )
85 out->bv_len = ptr - out->bv_val;
89 /* return the tag - LBER_DEFAULT returned means trouble */
91 ber_get_tag( BerElement *ber )
96 assert( ber != NULL );
97 assert( LBER_VALID( ber ) );
99 if ( ber_pvt_ber_remaining( ber ) < 1 ) {
103 if ( ber->ber_ptr == ber->ber_buf ) {
104 tag = *(unsigned char *)ber->ber_ptr;
110 if ( (tag & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK ) {
115 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 ) {
120 tag |= 0x00ffUL & (ber_tag_t) xbyte;
122 if ( ! (xbyte & LBER_MORE_TAG_MASK) ) {
125 } while ( tag <= (ber_tag_t)-1 / 256 );
127 return LBER_DEFAULT; /* error or tag too big */
131 ber_skip_tag( BerElement *ber, ber_len_t *lenp )
137 unsigned char netlen[sizeof(ber_len_t)];
139 assert( lenp != NULL );
142 * Any ber element looks like this: tag length contents.
143 * Assuming everything's ok, we return the tag byte (we
144 * can assume a single byte), and return the length in lenp.
147 * 1) definite lengths
148 * 2) primitive encodings used whenever possible
154 * First, we read the tag.
157 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT ) {
162 * Next, read the length. The first octet determines the length
163 * of the length. If bit 8 is 0, the length is the short form,
164 * otherwise if the octet != 0x80 it's the long form, otherwise
165 * the ber element has the unsupported indefinite-length format.
166 * Lengths that do not fit in a ber_len_t are not accepted.
169 if ( ber_read( ber, (char *) &lc, 1 ) != 1 ) {
175 noctets = (lc & 0x7fU);
177 if ( noctets - 1U > sizeof(ber_len_t) - 1U ) {
178 /* Indefinite-length or too long length */
182 if( (unsigned) ber_read( ber, (char *) netlen, noctets ) != noctets ) {
187 for( i = 1; i < noctets; i++ ) {
195 /* BER element should have enough data left */
196 if( len > (ber_len_t) ber_pvt_ber_remaining( ber ) ) {
199 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
210 * This implementation assumes ber_skip_tag() only
211 * modifies ber_ptr field of the BerElement.
219 tag = ber_skip_tag( ber, len );
233 unsigned char buf[sizeof(ber_int_t)];
235 assert( num != NULL );
237 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
241 if ( len > sizeof(ber_int_t) ) {
245 /* read into the low-order bytes of our buffer */
246 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
250 /* parse two's complement integer */
253 ber_int_t netnum = buf[0] & 0xff;
256 netnum -= (netnum & 0x80) << 1;
258 /* shift in the bytes */
259 for( i = 1; i < len; i++ ) {
260 netnum = (netnum << 8 ) | buf[i];
269 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
279 return ber_get_int( ber, num );
291 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
295 /* must fit within allocated space with termination */
296 if ( datalen >= *len ) {
300 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen ) {
303 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
311 /* Definitions for get_string vector
313 * ChArray, BvArray, and BvVec are self-explanatory.
314 * BvOff is a struct berval embedded in an array of larger structures
315 * of siz bytes at off bytes from the beginning of the struct.
317 enum bgbvc { ChArray, BvArray, BvVec, BvOff };
319 /* Use this single cookie for state, to keep actual
320 * stack use to the absolute minimum.
322 typedef struct bgbvr {
336 ber_get_stringbvl( bgbvr *b, ber_len_t *rlen )
342 struct berval bv, *bvp = NULL;
344 /* For rewinding, just like ber_peek_tag() */
345 orig = b->ber->ber_ptr;
346 tag = b->ber->ber_tag;
348 if ( ber_first_element( b->ber, &len, &last ) != LBER_DEFAULT ) {
349 for ( ; b->ber->ber_ptr < last; i++ ) {
350 if (ber_skip_tag( b->ber, &len ) == LBER_DEFAULT) break;
351 b->ber->ber_ptr += len;
352 b->ber->ber_tag = *(unsigned char *)b->ber->ber_ptr;
356 if ( rlen ) *rlen = i;
365 /* Allocate the result vector */
368 *b->res.c = ber_memalloc_x( (n+1)*sizeof( char * ),
370 if ( *b->res.c == NULL ) return LBER_DEFAULT;
371 (*b->res.c)[n] = NULL;
374 *b->res.ba = ber_memalloc_x( (n+1)*sizeof( struct berval ),
376 if ( *b->res.ba == NULL ) return LBER_DEFAULT;
377 (*b->res.ba)[n].bv_val = NULL;
380 *b->res.bv = ber_memalloc_x( (n+1)*sizeof( struct berval *),
382 if ( *b->res.bv == NULL ) return LBER_DEFAULT;
383 (*b->res.bv)[n] = NULL;
386 *b->res.ba = ber_memalloc_x( (n+1) * b->siz, b->ber->ber_memctx );
387 if ( *b->res.ba == NULL ) return LBER_DEFAULT;
388 ((struct berval *)((char *)(*b->res.ba) + n*b->siz +
389 b->off))->bv_val = NULL;
392 b->ber->ber_ptr = orig;
393 b->ber->ber_tag = tag;
394 ber_skip_tag( b->ber, &len );
398 tag = ber_next_element( b->ber, &len, last );
399 if ( ber_get_stringbv( b->ber, &bv, b->alloc ) == LBER_DEFAULT ) {
403 /* store my result */
406 (*b->res.c)[n] = bv.bv_val;
409 (*b->res.ba)[n] = bv;
412 bvp = ber_memalloc_x( sizeof( struct berval ), b->ber->ber_memctx);
414 ber_memfree_x( bv.bv_val, b->ber->ber_memctx );
417 (*b->res.bv)[n] = bvp;
421 *(BerVarray)((char *)(*b->res.ba)+n*b->siz+b->off) = bv;
428 if (b->alloc || b->choice == BvVec) {
429 for (--n; n>=0; n--) {
432 ber_memfree_x((*b->res.c)[n], b->ber->ber_memctx);
435 ber_memfree_x((*b->res.ba)[n].bv_val, b->ber->ber_memctx);
438 ber_memfree_x((*b->res.bv)[n]->bv_val, b->ber->ber_memctx);
439 ber_memfree_x((*b->res.bv)[n], b->ber->ber_memctx);
446 ber_memfree_x(*b->res.c, b->ber->ber_memctx);
452 ber_get_stringbv( BerElement *ber, struct berval *bv, int option )
456 assert( bv != NULL );
458 tag = ber_skip_tag( ber, &bv->bv_len );
459 if ( tag == LBER_DEFAULT ) {
464 if ( option & LBER_BV_ALLOC ) {
465 bv->bv_val = (char *) ber_memalloc_x( bv->bv_len + 1,
467 if ( bv->bv_val == NULL ) {
471 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
472 bv->bv_len ) != bv->bv_len )
474 ber_memfree_x( bv->bv_val, ber->ber_memctx );
479 bv->bv_val = ber->ber_ptr;
480 ber->ber_ptr += bv->bv_len;
482 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
483 if ( !( option & LBER_BV_NOTERM ))
484 bv->bv_val[bv->bv_len] = '\0';
490 ber_get_stringbv_null( BerElement *ber, struct berval *bv, int option )
494 assert( bv != NULL );
496 tag = ber_skip_tag( ber, &bv->bv_len );
497 if ( tag == LBER_DEFAULT || bv->bv_len == 0 ) {
502 if ( option & LBER_BV_ALLOC ) {
503 bv->bv_val = (char *) ber_memalloc_x( bv->bv_len + 1,
505 if ( bv->bv_val == NULL ) {
509 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
510 bv->bv_len ) != bv->bv_len )
512 ber_memfree_x( bv->bv_val, ber->ber_memctx );
517 bv->bv_val = ber->ber_ptr;
518 ber->ber_ptr += bv->bv_len;
520 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
521 if ( !( option & LBER_BV_NOTERM ))
522 bv->bv_val[bv->bv_len] = '\0';
528 ber_get_stringa( BerElement *ber, char **buf )
533 assert( buf != NULL );
535 tag = ber_get_stringbv( ber, &bv, LBER_BV_ALLOC );
542 ber_get_stringa_null( BerElement *ber, char **buf )
547 assert( buf != NULL );
549 tag = ber_get_stringbv_null( ber, &bv, LBER_BV_ALLOC );
556 ber_get_stringal( BerElement *ber, struct berval **bv )
560 assert( ber != NULL );
561 assert( bv != NULL );
563 *bv = (struct berval *) ber_memalloc_x( sizeof(struct berval),
569 tag = ber_get_stringbv( ber, *bv, LBER_BV_ALLOC );
570 if ( tag == LBER_DEFAULT ) {
571 ber_memfree_x( *bv, ber->ber_memctx );
585 unsigned char unusedbits;
587 assert( buf != NULL );
588 assert( blen != NULL );
590 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
594 if ( --datalen > (ber_len_t)-1 / 8 ) {
597 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
600 if ( unusedbits > 7 ) {
604 *buf = (char *) ber_memalloc_x( datalen, ber->ber_memctx );
605 if ( *buf == NULL ) {
609 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
610 ber_memfree_x( buf, ber->ber_memctx );
614 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
616 *blen = datalen * 8 - unusedbits;
625 ber_get_null( BerElement *ber )
628 ber_tag_t tag = ber_skip_tag( ber, &len );
630 return( len == 0 ? tag : LBER_DEFAULT );
638 return ber_get_int( ber, boolval );
647 assert( last != NULL );
649 /* skip the sequence header, use the len to mark where to stop */
650 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
655 *last = ber->ber_ptr + *len;
661 return ber_peek_tag( ber, len );
668 LDAP_CONST char *last )
670 assert( ber != NULL );
671 assert( last != NULL );
672 assert( LBER_VALID( ber ) );
674 if ( ber->ber_ptr >= last ) {
678 return ber_peek_tag( ber, len );
683 ber_scanf ( BerElement *ber,
684 LDAP_CONST char *fmt,
688 LDAP_CONST char *fmt_reset;
689 char *s, **ss, ***sss;
690 struct berval *bval, **bvp, ***bvpp;
699 assert( ber != NULL );
700 assert( fmt != NULL );
701 assert( LBER_VALID( ber ) );
705 if ( ber->ber_debug & (LDAP_DEBUG_TRACE|LDAP_DEBUG_BER)) {
706 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
707 "ber_scanf fmt (%s) ber:\n", fmt );
708 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
711 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
712 /* When this is modified, remember to update
713 * the error-cleanup code below accordingly. */
715 case '!': { /* Hook */
716 BERDecodeCallback *f;
719 f = va_arg( ap, BERDecodeCallback * );
720 p = va_arg( ap, void * );
722 rc = (*f)( ber, p, 0 );
725 case 'a': /* octet string - allocate storage as needed */
726 ss = va_arg( ap, char ** );
727 rc = ber_get_stringa( ber, ss );
730 case 'A': /* octet string - allocate storage as needed,
731 * but return NULL if len == 0 */
732 ss = va_arg( ap, char ** );
733 rc = ber_get_stringa_null( ber, ss );
736 case 'b': /* boolean */
737 i = va_arg( ap, ber_int_t * );
738 rc = ber_get_boolean( ber, i );
741 case 'B': /* bit string - allocate storage as needed */
742 ss = va_arg( ap, char ** );
743 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
744 rc = ber_get_bitstringa( ber, ss, l );
747 case 'e': /* enumerated */
749 i = va_arg( ap, ber_int_t * );
750 rc = ber_get_int( ber, i );
753 case 'l': /* length of next item */
754 l = va_arg( ap, ber_len_t * );
755 rc = ber_peek_tag( ber, l );
758 case 'm': /* octet string in berval, in-place */
759 bval = va_arg( ap, struct berval * );
760 rc = ber_get_stringbv( ber, bval, 0 );
763 case 'M': /* bvoffarray - must include address of
764 * a record len, and record offset.
765 * number of records will be returned thru
766 * len ptr on finish. parsed in-place.
769 bgbvr cookie = { BvOff };
771 cookie.res.ba = va_arg( ap, struct berval ** );
773 l = va_arg( ap, ber_len_t * );
775 cookie.off = va_arg( ap, ber_len_t );
776 rc = ber_get_stringbvl( &cookie, l );
781 rc = ber_get_null( ber );
784 case 'o': /* octet string in a supplied berval */
785 bval = va_arg( ap, struct berval * );
786 rc = ber_get_stringbv( ber, bval, LBER_BV_ALLOC );
789 case 'O': /* octet string - allocate & include length */
790 bvp = va_arg( ap, struct berval ** );
791 rc = ber_get_stringal( ber, bvp );
794 case 's': /* octet string - in a buffer */
795 s = va_arg( ap, char * );
796 l = va_arg( ap, ber_len_t * );
797 rc = ber_get_stringb( ber, s, l );
800 case 't': /* tag of next item */
801 t = va_arg( ap, ber_tag_t * );
802 *t = rc = ber_peek_tag( ber, &len );
805 case 'T': /* skip tag of next item */
806 t = va_arg( ap, ber_tag_t * );
807 *t = rc = ber_skip_tag( ber, &len );
810 case 'v': /* sequence of strings */
812 bgbvr cookie = { ChArray };
814 cookie.res.c = va_arg( ap, char *** );
815 cookie.alloc = LBER_BV_ALLOC;
816 rc = ber_get_stringbvl( &cookie, NULL );
820 case 'V': /* sequence of strings + lengths */
822 bgbvr cookie = { BvVec };
824 cookie.res.bv = va_arg( ap, struct berval *** );
825 cookie.alloc = LBER_BV_ALLOC;
826 rc = ber_get_stringbvl( &cookie, NULL );
830 case 'W': /* bvarray */
832 bgbvr cookie = { BvArray };
834 cookie.res.ba = va_arg( ap, struct berval ** );
835 cookie.alloc = LBER_BV_ALLOC;
836 rc = ber_get_stringbvl( &cookie, NULL );
840 case 'x': /* skip the next element - whatever it is */
841 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
844 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
847 case '{': /* begin sequence */
848 case '[': /* begin set */
850 case 'v': case 'V': case 'W': case 'M':
853 rc = ber_skip_tag( ber, &len );
858 case '}': /* end sequence */
859 case ']': /* end set */
863 if( ber->ber_debug ) {
864 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
865 "ber_scanf: unknown fmt %c\n", *fmt );
874 if ( rc == LBER_DEFAULT ) {
876 * Error. Reclaim malloced memory that was given to the caller.
877 * Set allocated pointers to NULL, "data length" outvalues to 0.
881 for ( ; fmt_reset < fmt; fmt_reset++ ) {
882 switch ( *fmt_reset ) {
883 case '!': { /* Hook */
884 BERDecodeCallback *f;
887 f = va_arg( ap, BERDecodeCallback * );
888 p = va_arg( ap, void * );
890 (void) (*f)( ber, p, 1 );
893 case 'a': /* octet string - allocate storage as needed */
895 ss = va_arg( ap, char ** );
896 ber_memfree_x( *ss, ber->ber_memctx );
900 case 'b': /* boolean */
901 case 'e': /* enumerated */
903 (void) va_arg( ap, int * );
906 case 'l': /* length of next item */
907 *(va_arg( ap, ber_len_t * )) = 0;
910 case 'm': /* berval in-place */
911 bval = va_arg( ap, struct berval * );
915 case 'M': /* BVoff array in-place */
916 bvp = va_arg( ap, struct berval ** );
917 ber_memfree_x( bvp, ber->ber_memctx );
919 *(va_arg( ap, ber_len_t * )) = 0;
920 (void) va_arg( ap, ber_len_t );
923 case 'o': /* octet string in a supplied berval */
924 bval = va_arg( ap, struct berval * );
925 ber_memfree_x( bval->bv_val, ber->ber_memctx );
929 case 'O': /* octet string - allocate & include length */
930 bvp = va_arg( ap, struct berval ** );
931 ber_bvfree_x( *bvp, ber->ber_memctx );
935 case 's': /* octet string - in a buffer */
936 (void) va_arg( ap, char * );
937 *(va_arg( ap, ber_len_t * )) = 0;
940 case 't': /* tag of next item */
941 case 'T': /* skip tag of next item */
942 (void) va_arg( ap, ber_tag_t * );
945 case 'B': /* bit string - allocate storage as needed */
946 ss = va_arg( ap, char ** );
947 ber_memfree_x( *ss, ber->ber_memctx );
949 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
952 case 'v': /* sequence of strings */
953 sss = va_arg( ap, char *** );
954 ber_memvfree_x( (void **) *sss, ber->ber_memctx );
958 case 'V': /* sequence of strings + lengths */
959 bvpp = va_arg( ap, struct berval *** );
960 ber_bvecfree_x( *bvpp, ber->ber_memctx );
964 case 'W': /* BerVarray */
965 bvp = va_arg( ap, struct berval ** );
966 ber_bvarray_free_x( *bvp, ber->ber_memctx );
971 case 'x': /* skip the next element - whatever it is */
972 case '{': /* begin sequence */
973 case '[': /* begin set */
974 case '}': /* end sequence */
975 case ']': /* end set */
979 /* format should be good */