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>
37 #include <ac/stdarg.h>
38 #include <ac/string.h>
39 #include <ac/socket.h>
43 static ber_len_t ber_getnint LDAP_P((
48 /* out->bv_len should be the buffer size on input */
50 ber_decode_oid( BerValue *in, BerValue *out )
52 const unsigned char *der;
59 assert( out != NULL );
61 /* need 4 chars/inbyte + \0 for input={7f 7f 7f...} */
62 if ( !out->bv_val || (out->bv_len+3)/4 <= in->bv_len )
66 der = (unsigned char *) in->bv_val;
68 for ( i=0; i < in->bv_len; i++ ) {
70 if ( !( der[i] & 0x80 )) {
72 /* Initial "x.y": val=x*40+y, x<=2, y<40 if x<2 */
74 val1 = (val < 80 ? val/40 : 2);
76 ptr += sprintf( ptr, "%u", val1 );
78 ptr += sprintf( ptr, ".%lu", val );
80 } else if ( val - 1UL < LBER_OID_COMPONENT_MAX >> 7 ) {
83 /* val would overflow, or is 0 from invalid initial 0x80 octet */
87 if ( ptr == NULL || val != 0 )
90 out->bv_len = ptr - out->bv_val;
94 /* return the tag - LBER_DEFAULT returned means trouble */
96 ber_get_tag( BerElement *ber )
102 assert( ber != NULL );
103 assert( LBER_VALID( ber ) );
105 if ( ber_pvt_ber_remaining( ber ) < 1 ) {
109 if ( ber->ber_ptr == ber->ber_buf ) {
110 tag = *(unsigned char *)ber->ber_ptr;
116 if ( (tag & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK ) {
120 for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
121 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 ) {
126 tag |= 0x00ffUL & (ber_tag_t) xbyte;
128 if ( ! (xbyte & LBER_MORE_TAG_MASK) ) {
134 if ( i == sizeof(ber_tag_t) ) {
142 ber_skip_tag( BerElement *ber, ber_len_t *len )
148 assert( ber != NULL );
149 assert( len != NULL );
150 assert( LBER_VALID( ber ) );
155 * Any ber element looks like this: tag length contents.
156 * Assuming everything's ok, we return the tag byte (we
157 * can assume a single byte), and return the length in len.
160 * 1) definite lengths
161 * 2) primitive encodings used whenever possible
167 * First, we read the tag.
170 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT ) {
175 * Next, read the length. The first byte contains the length of
176 * the length. If bit 8 is set, the length is the long form,
177 * otherwise it's the short form. We don't allow a length that's
178 * greater than what we can hold in a ber_len_t.
181 if ( ber_read( ber, (char *) &lc, 1 ) != 1 ) {
186 ber_len_t i, noctets;
187 unsigned char netlen[sizeof(ber_len_t)];
189 noctets = (lc & 0x7fU);
191 if ( noctets > sizeof(ber_len_t) ) {
195 if( (unsigned) ber_read( ber, (char *) netlen, noctets ) != noctets ) {
199 for( i = 0; i < noctets; i++ ) {
208 /* BER element should have enough data left */
209 if( *len > (ber_len_t) (ber_pvt_ber_remaining( ber ) + ber->ber_ptr - save) ) {
212 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
223 * This implementation assumes ber_skip_tag() only
224 * modifies ber_ptr field of the BerElement.
232 tag = ber_skip_tag( ber, len );
245 unsigned char buf[sizeof(ber_int_t)];
247 assert( ber != NULL );
248 assert( num != NULL );
249 assert( LBER_VALID( ber ) );
252 * The tag and length have already been stripped off. We should
253 * be sitting right before len bytes of 2's complement integer,
254 * ready to be read straight into an int. We may have to sign
255 * extend after we read it in.
258 if ( len > sizeof(ber_int_t) ) {
262 /* read into the low-order bytes of our buffer */
263 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
268 /* sign extend if necessary */
270 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
272 /* shift in the bytes */
273 for( i=0 ; i<len; i++ ) {
274 netnum = (netnum << 8 ) | buf[i];
282 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
295 assert( ber != NULL );
296 assert( LBER_VALID( ber ) );
298 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
302 if ( ber_getnint( ber, num, len ) != len ) {
314 return ber_get_int( ber, num );
326 assert( ber != NULL );
327 assert( LBER_VALID( ber ) );
329 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
333 /* must fit within allocated space with termination */
334 if ( datalen >= *len ) {
338 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen ) {
341 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
349 /* Definitions for get_string vector
351 * ChArray, BvArray, and BvVec are self-explanatory.
352 * BvOff is a struct berval embedded in an array of larger structures
353 * of siz bytes at off bytes from the beginning of the struct.
355 enum bgbvc { ChArray, BvArray, BvVec, BvOff };
357 /* Use this single cookie for state, to keep actual
358 * stack use to the absolute minimum.
360 typedef struct bgbvr {
374 ber_get_stringbvl( bgbvr *b, ber_len_t *rlen )
380 struct berval bv, *bvp = NULL;
382 /* For rewinding, just like ber_peek_tag() */
383 orig = b->ber->ber_ptr;
384 tag = b->ber->ber_tag;
386 if ( ber_first_element( b->ber, &len, &last ) != LBER_DEFAULT ) {
387 for ( ; b->ber->ber_ptr < last; i++ ) {
388 if (ber_skip_tag( b->ber, &len ) == LBER_DEFAULT) break;
389 b->ber->ber_ptr += len;
390 b->ber->ber_tag = *(unsigned char *)b->ber->ber_ptr;
394 if ( rlen ) *rlen = i;
403 /* Allocate the result vector */
406 *b->res.c = ber_memalloc_x( (n+1)*sizeof( char * ),
408 if ( *b->res.c == NULL ) return LBER_DEFAULT;
409 (*b->res.c)[n] = NULL;
412 *b->res.ba = ber_memalloc_x( (n+1)*sizeof( struct berval ),
414 if ( *b->res.ba == NULL ) return LBER_DEFAULT;
415 (*b->res.ba)[n].bv_val = NULL;
418 *b->res.bv = ber_memalloc_x( (n+1)*sizeof( struct berval *),
420 if ( *b->res.bv == NULL ) return LBER_DEFAULT;
421 (*b->res.bv)[n] = NULL;
424 *b->res.ba = ber_memalloc_x( (n+1) * b->siz, b->ber->ber_memctx );
425 if ( *b->res.ba == NULL ) return LBER_DEFAULT;
426 ((struct berval *)((char *)(*b->res.ba) + n*b->siz +
427 b->off))->bv_val = NULL;
430 b->ber->ber_ptr = orig;
431 b->ber->ber_tag = tag;
432 ber_skip_tag( b->ber, &len );
436 tag = ber_next_element( b->ber, &len, last );
437 if ( ber_get_stringbv( b->ber, &bv, b->alloc ) == LBER_DEFAULT ) {
441 /* store my result */
444 (*b->res.c)[n] = bv.bv_val;
447 (*b->res.ba)[n] = bv;
450 bvp = ber_memalloc_x( sizeof( struct berval ), b->ber->ber_memctx);
452 LBER_FREE(bv.bv_val);
455 (*b->res.bv)[n] = bvp;
459 *(BerVarray)((char *)(*b->res.ba)+n*b->siz+b->off) = bv;
466 if (b->alloc || b->choice == BvVec) {
467 for (--n; n>=0; n--) {
470 LBER_FREE((*b->res.c)[n]);
473 LBER_FREE((*b->res.ba)[n].bv_val);
476 LBER_FREE((*b->res.bv)[n]->bv_val);
477 LBER_FREE((*b->res.bv)[n]);
484 LBER_FREE(*b->res.c);
490 ber_get_stringbv( BerElement *ber, struct berval *bv, int option )
494 assert( ber != NULL );
495 assert( bv != NULL );
497 assert( LBER_VALID( ber ) );
499 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
504 if ( (ber_len_t) ber_pvt_ber_remaining( ber ) < bv->bv_len ) {
508 if ( option & LBER_BV_ALLOC ) {
509 bv->bv_val = (char *) ber_memalloc_x( bv->bv_len + 1,
511 if ( bv->bv_val == NULL ) {
515 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
516 bv->bv_len ) != bv->bv_len )
518 LBER_FREE( bv->bv_val );
523 bv->bv_val = ber->ber_ptr;
524 ber->ber_ptr += bv->bv_len;
526 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
527 if ( !( option & LBER_BV_NOTERM ))
528 bv->bv_val[bv->bv_len] = '\0';
534 ber_get_stringbv_null( BerElement *ber, struct berval *bv, int option )
538 assert( ber != NULL );
539 assert( bv != NULL );
541 assert( LBER_VALID( ber ) );
543 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
548 if ( (ber_len_t) ber_pvt_ber_remaining( ber ) < bv->bv_len ) {
552 if ( bv->bv_len == 0 ) {
554 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
558 if ( option & LBER_BV_ALLOC ) {
559 bv->bv_val = (char *) ber_memalloc_x( bv->bv_len + 1,
561 if ( bv->bv_val == NULL ) {
565 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
566 bv->bv_len ) != bv->bv_len )
568 LBER_FREE( bv->bv_val );
573 bv->bv_val = ber->ber_ptr;
574 ber->ber_ptr += bv->bv_len;
576 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
577 if ( !( option & LBER_BV_NOTERM ))
578 bv->bv_val[bv->bv_len] = '\0';
584 ber_get_stringa( BerElement *ber, char **buf )
589 assert( buf != NULL );
591 tag = ber_get_stringbv( ber, &bv, LBER_BV_ALLOC );
598 ber_get_stringa_null( BerElement *ber, char **buf )
603 assert( buf != NULL );
605 tag = ber_get_stringbv_null( ber, &bv, LBER_BV_ALLOC );
612 ber_get_stringal( BerElement *ber, struct berval **bv )
616 assert( ber != NULL );
617 assert( bv != NULL );
619 *bv = (struct berval *) ber_memalloc_x( sizeof(struct berval),
625 tag = ber_get_stringbv( ber, *bv, LBER_BV_ALLOC );
626 if ( tag == LBER_DEFAULT ) {
641 unsigned char unusedbits;
643 assert( ber != NULL );
644 assert( buf != NULL );
645 assert( blen != NULL );
647 assert( LBER_VALID( ber ) );
649 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
655 *buf = (char *) ber_memalloc_x( datalen, ber->ber_memctx );
656 if ( *buf == NULL ) {
660 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
666 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
671 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
673 *blen = datalen * 8 - unusedbits;
678 ber_get_null( BerElement *ber )
683 assert( ber != NULL );
684 assert( LBER_VALID( ber ) );
686 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
693 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
706 assert( ber != NULL );
707 assert( boolval != NULL );
709 assert( LBER_VALID( ber ) );
711 rc = ber_get_int( ber, &longbool );
723 assert( ber != NULL );
724 assert( len != NULL );
725 assert( last != NULL );
727 /* skip the sequence header, use the len to mark where to stop */
728 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
732 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
734 *last = ber->ber_ptr + *len;
736 if ( *last == ber->ber_ptr ) {
740 return ber_peek_tag( ber, len );
747 LDAP_CONST char *last )
749 assert( ber != NULL );
750 assert( len != NULL );
751 assert( last != NULL );
753 assert( LBER_VALID( ber ) );
755 if ( ber->ber_ptr >= last ) {
759 return ber_peek_tag( ber, len );
764 ber_scanf ( BerElement *ber,
765 LDAP_CONST char *fmt,
769 LDAP_CONST char *fmt_reset;
771 struct berval **bvp, *bval;
780 assert( ber != NULL );
781 assert( fmt != NULL );
783 assert( LBER_VALID( ber ) );
787 if ( ber->ber_debug & (LDAP_DEBUG_TRACE|LDAP_DEBUG_BER)) {
788 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
789 "ber_scanf fmt (%s) ber:\n", fmt );
790 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
793 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
794 /* When this is modified, remember to update
795 * the error-cleanup code below accordingly. */
797 case '!': { /* Hook */
798 BERDecodeCallback *f;
801 f = va_arg( ap, BERDecodeCallback * );
802 p = va_arg( ap, void * );
804 rc = (*f)( ber, p, 0 );
807 case 'a': /* octet string - allocate storage as needed */
808 ss = va_arg( ap, char ** );
809 rc = ber_get_stringa( ber, ss );
812 case 'A': /* octet string - allocate storage as needed,
813 * but return NULL if len == 0 */
814 ss = va_arg( ap, char ** );
815 rc = ber_get_stringa_null( ber, ss );
818 case 'b': /* boolean */
819 i = va_arg( ap, ber_int_t * );
820 rc = ber_get_boolean( ber, i );
823 case 'B': /* bit string - allocate storage as needed */
824 ss = va_arg( ap, char ** );
825 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
826 rc = ber_get_bitstringa( ber, ss, l );
829 case 'e': /* enumerated */
831 i = va_arg( ap, ber_int_t * );
832 rc = ber_get_int( ber, i );
835 case 'l': /* length of next item */
836 l = va_arg( ap, ber_len_t * );
837 rc = ber_peek_tag( ber, l );
840 case 'm': /* octet string in berval, in-place */
841 bval = va_arg( ap, struct berval * );
842 rc = ber_get_stringbv( ber, bval, 0 );
845 case 'M': /* bvoffarray - must include address of
846 * a record len, and record offset.
847 * number of records will be returned thru
848 * len ptr on finish. parsed in-place.
851 bgbvr cookie = { BvOff };
853 cookie.res.ba = va_arg( ap, struct berval ** );
855 l = va_arg( ap, ber_len_t * );
857 cookie.off = va_arg( ap, ber_len_t );
858 rc = ber_get_stringbvl( &cookie, l );
863 rc = ber_get_null( ber );
866 case 'o': /* octet string in a supplied berval */
867 bval = va_arg( ap, struct berval * );
868 rc = ber_get_stringbv( ber, bval, LBER_BV_ALLOC );
871 case 'O': /* octet string - allocate & include length */
872 bvp = va_arg( ap, struct berval ** );
873 rc = ber_get_stringal( ber, bvp );
876 case 's': /* octet string - in a buffer */
877 s = va_arg( ap, char * );
878 l = va_arg( ap, ber_len_t * );
879 rc = ber_get_stringb( ber, s, l );
882 case 't': /* tag of next item */
883 t = va_arg( ap, ber_tag_t * );
884 *t = rc = ber_peek_tag( ber, &len );
887 case 'T': /* skip tag of next item */
888 t = va_arg( ap, ber_tag_t * );
889 *t = rc = ber_skip_tag( ber, &len );
892 case 'v': /* sequence of strings */
894 bgbvr cookie = { ChArray };
896 cookie.res.c = va_arg( ap, char *** );
897 cookie.alloc = LBER_BV_ALLOC;
898 rc = ber_get_stringbvl( &cookie, NULL );
902 case 'V': /* sequence of strings + lengths */
904 bgbvr cookie = { BvVec };
906 cookie.res.bv = va_arg( ap, struct berval *** );
907 cookie.alloc = LBER_BV_ALLOC;
908 rc = ber_get_stringbvl( &cookie, NULL );
912 case 'W': /* bvarray */
914 bgbvr cookie = { BvArray };
916 cookie.res.ba = va_arg( ap, struct berval ** );
917 cookie.alloc = LBER_BV_ALLOC;
918 rc = ber_get_stringbvl( &cookie, NULL );
922 case 'x': /* skip the next element - whatever it is */
923 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
926 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
929 case '{': /* begin sequence */
930 case '[': /* begin set */
931 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V'
932 && *(fmt + 1) != 'W' && *(fmt + 1) != 'M' )
933 rc = ber_skip_tag( ber, &len );
936 case '}': /* end sequence */
937 case ']': /* end set */
941 if( ber->ber_debug ) {
942 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
943 "ber_scanf: unknown fmt %c\n", *fmt );
951 if ( rc == LBER_DEFAULT ) {
953 * Error. Reclaim malloced memory that was given to the caller.
954 * Set allocated pointers to NULL, "data length" outvalues to 0.
958 for ( ; fmt_reset < fmt; fmt_reset++ ) {
959 switch ( *fmt_reset ) {
960 case '!': { /* Hook */
961 BERDecodeCallback *f;
964 f = va_arg( ap, BERDecodeCallback * );
965 p = va_arg( ap, void * );
967 (void) (*f)( ber, p, 1 );
970 case 'a': /* octet string - allocate storage as needed */
972 ss = va_arg( ap, char ** );
979 case 'b': /* boolean */
980 case 'e': /* enumerated */
982 (void) va_arg( ap, int * );
985 case 'l': /* length of next item */
986 (void) va_arg( ap, ber_len_t * );
989 case 'o': /* octet string in a supplied berval */
990 bval = va_arg( ap, struct berval * );
991 if ( bval->bv_val != NULL ) {
992 LBER_FREE( bval->bv_val );
998 case 'O': /* octet string - allocate & include length */
999 bvp = va_arg( ap, struct berval ** );
1006 case 's': /* octet string - in a buffer */
1007 (void) va_arg( ap, char * );
1008 (void) va_arg( ap, ber_len_t * );
1011 case 't': /* tag of next item */
1012 case 'T': /* skip tag of next item */
1013 (void) va_arg( ap, ber_tag_t * );
1016 case 'B': /* bit string - allocate storage as needed */
1017 ss = va_arg( ap, char ** );
1022 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
1025 case 'm': /* berval in-place */
1026 case 'M': /* BVoff array in-place */
1027 case 'n': /* null */
1028 case 'v': /* sequence of strings */
1029 case 'V': /* sequence of strings + lengths */
1030 case 'W': /* BerVarray */
1031 case 'x': /* skip the next element - whatever it is */
1032 case '{': /* begin sequence */
1033 case '[': /* begin set */
1034 case '}': /* end sequence */
1035 case ']': /* end set */
1039 /* format should be good */