1 /* decode.c - ber input decoding routines */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2007 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 unsigned char *der = in->bv_val;
53 unsigned long val, val1;
58 assert( out != NULL );
60 /* expands by 5/2, and we add dots - call it 3 */
61 if ( !out->bv_val || out->bv_len < in->bv_len * 3 )
65 val = der[0] - val1 * 40;
67 len = sprintf( out->bv_val, "%ld.%ld", val1, val );
68 ptr = out->bv_val + len;
70 for ( i=1; i<in->bv_len; i++ ) {
73 if ( !( der[i] & 0x80 )) {
74 ptr += sprintf( ptr, ".%ld", val );
78 out->bv_len = ptr - out->bv_val;
82 /* return the tag - LBER_DEFAULT returned means trouble */
84 ber_get_tag( BerElement *ber )
90 assert( ber != NULL );
91 assert( LBER_VALID( ber ) );
93 if ( ber_pvt_ber_remaining( ber ) < 1 ) {
97 if ( ber->ber_ptr == ber->ber_buf ) {
98 tag = *(unsigned char *)ber->ber_ptr;
104 if ( (tag & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK ) {
108 for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
109 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 ) {
114 tag |= 0x00ffUL & (ber_tag_t) xbyte;
116 if ( ! (xbyte & LBER_MORE_TAG_MASK) ) {
122 if ( i == sizeof(ber_tag_t) ) {
130 ber_skip_tag( BerElement *ber, ber_len_t *len )
134 ber_len_t i, noctets;
135 unsigned char netlen[sizeof(ber_len_t)];
137 assert( ber != NULL );
138 assert( len != NULL );
139 assert( LBER_VALID( ber ) );
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 len.
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 byte contains the length of
163 * the length. If bit 8 is set, the length is the long form,
164 * otherwise it's the short form. We don't allow a length that's
165 * greater than what we can hold in a ber_len_t.
168 if ( ber_read( ber, (char *) &lc, 1 ) != 1 ) {
173 noctets = (lc & 0x7fU);
175 if ( noctets > sizeof(ber_len_t) ) {
179 if( (unsigned) ber_read( ber, (char *) netlen, noctets ) != noctets ) {
183 for( i = 0; i < noctets; i++ ) {
192 /* BER element should have enough data left */
193 if( *len > (ber_len_t) ber_pvt_ber_remaining( ber ) ) {
196 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
207 * This implementation assumes ber_skip_tag() only
208 * modifies ber_ptr field of the BerElement.
216 tag = ber_skip_tag( ber, len );
229 unsigned char buf[sizeof(ber_int_t)];
231 assert( ber != NULL );
232 assert( num != NULL );
233 assert( LBER_VALID( ber ) );
236 * The tag and length have already been stripped off. We should
237 * be sitting right before len bytes of 2's complement integer,
238 * ready to be read straight into an int. We may have to sign
239 * extend after we read it in.
242 if ( len > sizeof(ber_int_t) ) {
246 /* read into the low-order bytes of our buffer */
247 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
252 /* sign extend if necessary */
254 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
256 /* shift in the bytes */
257 for( i=0 ; i<len; i++ ) {
258 netnum = (netnum << 8 ) | buf[i];
266 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
279 assert( ber != NULL );
280 assert( LBER_VALID( ber ) );
282 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
286 if ( ber_getnint( ber, num, len ) != len ) {
298 return ber_get_int( ber, num );
310 assert( ber != NULL );
311 assert( LBER_VALID( ber ) );
313 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
317 /* must fit within allocated space with termination */
318 if ( datalen >= *len ) {
322 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen ) {
325 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
333 /* Definitions for get_string vector
335 * ChArray, BvArray, and BvVec are self-explanatory.
336 * BvOff is a struct berval embedded in an array of larger structures
337 * of siz bytes at off bytes from the beginning of the struct.
339 enum bgbvc { ChArray, BvArray, BvVec, BvOff };
341 /* Use this single cookie for state, to keep actual
342 * stack use to the absolute minimum.
344 typedef struct bgbvr {
358 ber_get_stringbvl( bgbvr *b, ber_len_t *rlen )
364 struct berval bv, *bvp = NULL;
366 /* For rewinding, just like ber_peek_tag() */
367 orig = b->ber->ber_ptr;
368 tag = b->ber->ber_tag;
370 if ( ber_first_element( b->ber, &len, &last ) != LBER_DEFAULT ) {
371 for ( ; b->ber->ber_ptr < last; i++ ) {
372 if (ber_skip_tag( b->ber, &len ) == LBER_DEFAULT) break;
373 b->ber->ber_ptr += len;
374 b->ber->ber_tag = *(unsigned char *)b->ber->ber_ptr;
378 if ( rlen ) *rlen = i;
387 /* Allocate the result vector */
390 *b->res.c = ber_memalloc_x( (n+1)*sizeof( char * ),
392 if ( *b->res.c == NULL ) return LBER_DEFAULT;
393 (*b->res.c)[n] = NULL;
396 *b->res.ba = ber_memalloc_x( (n+1)*sizeof( struct berval ),
398 if ( *b->res.ba == NULL ) return LBER_DEFAULT;
399 (*b->res.ba)[n].bv_val = NULL;
402 *b->res.bv = ber_memalloc_x( (n+1)*sizeof( struct berval *),
404 if ( *b->res.bv == NULL ) return LBER_DEFAULT;
405 (*b->res.bv)[n] = NULL;
408 *b->res.ba = ber_memalloc_x( (n+1) * b->siz, b->ber->ber_memctx );
409 if ( *b->res.ba == NULL ) return LBER_DEFAULT;
410 ((struct berval *)((long)(*b->res.ba) + n*b->siz +
411 b->off))->bv_val = NULL;
414 b->ber->ber_ptr = orig;
415 b->ber->ber_tag = tag;
416 ber_skip_tag( b->ber, &len );
420 tag = ber_next_element( b->ber, &len, last );
421 if ( ber_get_stringbv( b->ber, &bv, b->alloc ) == LBER_DEFAULT ) {
425 /* store my result */
428 (*b->res.c)[n] = bv.bv_val;
431 (*b->res.ba)[n] = bv;
434 bvp = ber_memalloc_x( sizeof( struct berval ), b->ber->ber_memctx);
436 LBER_FREE(bv.bv_val);
439 (*b->res.bv)[n] = bvp;
443 *(BerVarray)((long)(*b->res.ba)+n*b->siz+b->off) = bv;
450 if (b->alloc || b->choice == BvVec) {
451 for (--n; n>=0; n--) {
454 LBER_FREE((*b->res.c)[n]);
457 LBER_FREE((*b->res.ba)[n].bv_val);
460 LBER_FREE((*b->res.bv)[n]->bv_val);
461 LBER_FREE((*b->res.bv)[n]);
468 LBER_FREE(*b->res.c);
474 ber_get_stringbv( BerElement *ber, struct berval *bv, int option )
478 assert( ber != NULL );
479 assert( bv != NULL );
481 assert( LBER_VALID( ber ) );
483 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
488 if ( (ber_len_t) ber_pvt_ber_remaining( ber ) < bv->bv_len ) {
492 if ( option & LBER_BV_ALLOC ) {
493 bv->bv_val = (char *) ber_memalloc_x( bv->bv_len + 1,
495 if ( bv->bv_val == NULL ) {
499 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
500 bv->bv_len ) != bv->bv_len )
502 LBER_FREE( bv->bv_val );
507 bv->bv_val = ber->ber_ptr;
508 ber->ber_ptr += bv->bv_len;
510 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
511 if ( !( option & LBER_BV_NOTERM ))
512 bv->bv_val[bv->bv_len] = '\0';
518 ber_get_stringbv_null( BerElement *ber, struct berval *bv, int option )
522 assert( ber != NULL );
523 assert( bv != NULL );
525 assert( LBER_VALID( ber ) );
527 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
532 if ( (ber_len_t) ber_pvt_ber_remaining( ber ) < bv->bv_len ) {
536 if ( bv->bv_len == 0 ) {
538 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
542 if ( option & LBER_BV_ALLOC ) {
543 bv->bv_val = (char *) ber_memalloc_x( bv->bv_len + 1,
545 if ( bv->bv_val == NULL ) {
549 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
550 bv->bv_len ) != bv->bv_len )
552 LBER_FREE( bv->bv_val );
557 bv->bv_val = ber->ber_ptr;
558 ber->ber_ptr += bv->bv_len;
560 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
561 if ( !( option & LBER_BV_NOTERM ))
562 bv->bv_val[bv->bv_len] = '\0';
568 ber_get_stringa( BerElement *ber, char **buf )
573 assert( buf != NULL );
575 tag = ber_get_stringbv( ber, &bv, LBER_BV_ALLOC );
582 ber_get_stringa_null( BerElement *ber, char **buf )
587 assert( buf != NULL );
589 tag = ber_get_stringbv_null( ber, &bv, LBER_BV_ALLOC );
596 ber_get_stringal( BerElement *ber, struct berval **bv )
600 assert( ber != NULL );
601 assert( bv != NULL );
603 *bv = (struct berval *) ber_memalloc_x( sizeof(struct berval),
609 tag = ber_get_stringbv( ber, *bv, LBER_BV_ALLOC );
610 if ( tag == LBER_DEFAULT ) {
625 unsigned char unusedbits;
627 assert( ber != NULL );
628 assert( buf != NULL );
629 assert( blen != NULL );
631 assert( LBER_VALID( ber ) );
633 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
639 *buf = (char *) ber_memalloc_x( datalen, ber->ber_memctx );
640 if ( *buf == NULL ) {
644 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
650 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
655 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
657 *blen = datalen * 8 - unusedbits;
662 ber_get_null( BerElement *ber )
667 assert( ber != NULL );
668 assert( LBER_VALID( ber ) );
670 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
677 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
690 assert( ber != NULL );
691 assert( boolval != NULL );
693 assert( LBER_VALID( ber ) );
695 rc = ber_get_int( ber, &longbool );
707 assert( ber != NULL );
708 assert( len != NULL );
709 assert( last != NULL );
711 /* skip the sequence header, use the len to mark where to stop */
712 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
716 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
718 *last = ber->ber_ptr + *len;
720 if ( *last == ber->ber_ptr ) {
724 return ber_peek_tag( ber, len );
731 LDAP_CONST char *last )
733 assert( ber != NULL );
734 assert( len != NULL );
735 assert( last != NULL );
737 assert( LBER_VALID( ber ) );
739 if ( ber->ber_ptr >= last ) {
743 return ber_peek_tag( ber, len );
748 ber_scanf ( BerElement *ber,
749 LDAP_CONST char *fmt,
753 LDAP_CONST char *fmt_reset;
755 struct berval **bvp, *bval;
764 assert( ber != NULL );
765 assert( fmt != NULL );
767 assert( LBER_VALID( ber ) );
771 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
772 "ber_scanf fmt (%s) ber:\n", fmt );
773 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
775 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
776 /* When this is modified, remember to update
777 * the error-cleanup code below accordingly. */
779 case '!': { /* Hook */
780 BERDecodeCallback *f;
783 f = va_arg( ap, BERDecodeCallback * );
784 p = va_arg( ap, void * );
786 rc = (*f)( ber, p, 0 );
789 case 'a': /* octet string - allocate storage as needed */
790 ss = va_arg( ap, char ** );
791 rc = ber_get_stringa( ber, ss );
794 case 'A': /* octet string - allocate storage as needed,
795 * but return NULL if len == 0 */
796 ss = va_arg( ap, char ** );
797 rc = ber_get_stringa_null( ber, ss );
800 case 'b': /* boolean */
801 i = va_arg( ap, ber_int_t * );
802 rc = ber_get_boolean( ber, i );
805 case 'B': /* bit string - allocate storage as needed */
806 ss = va_arg( ap, char ** );
807 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
808 rc = ber_get_bitstringa( ber, ss, l );
811 case 'e': /* enumerated */
813 i = va_arg( ap, ber_int_t * );
814 rc = ber_get_int( ber, i );
817 case 'l': /* length of next item */
818 l = va_arg( ap, ber_len_t * );
819 rc = ber_peek_tag( ber, l );
822 case 'm': /* octet string in berval, in-place */
823 bval = va_arg( ap, struct berval * );
824 rc = ber_get_stringbv( ber, bval, 0 );
827 case 'M': /* bvoffarray - must include address of
828 * a record len, and record offset.
829 * number of records will be returned thru
830 * len ptr on finish. parsed in-place.
833 bgbvr cookie = { BvOff };
835 cookie.res.ba = va_arg( ap, struct berval ** );
837 l = va_arg( ap, ber_len_t * );
839 cookie.off = va_arg( ap, ber_len_t );
840 rc = ber_get_stringbvl( &cookie, l );
845 rc = ber_get_null( ber );
848 case 'o': /* octet string in a supplied berval */
849 bval = va_arg( ap, struct berval * );
850 rc = ber_get_stringbv( ber, bval, LBER_BV_ALLOC );
853 case 'O': /* octet string - allocate & include length */
854 bvp = va_arg( ap, struct berval ** );
855 rc = ber_get_stringal( ber, bvp );
858 case 's': /* octet string - in a buffer */
859 s = va_arg( ap, char * );
860 l = va_arg( ap, ber_len_t * );
861 rc = ber_get_stringb( ber, s, l );
864 case 't': /* tag of next item */
865 t = va_arg( ap, ber_tag_t * );
866 *t = rc = ber_peek_tag( ber, &len );
869 case 'T': /* skip tag of next item */
870 t = va_arg( ap, ber_tag_t * );
871 *t = rc = ber_skip_tag( ber, &len );
874 case 'v': /* sequence of strings */
876 bgbvr cookie = { ChArray };
878 cookie.res.c = va_arg( ap, char *** );
879 cookie.alloc = LBER_BV_ALLOC;
880 rc = ber_get_stringbvl( &cookie, NULL );
884 case 'V': /* sequence of strings + lengths */
886 bgbvr cookie = { BvVec };
888 cookie.res.bv = va_arg( ap, struct berval *** );
889 cookie.alloc = LBER_BV_ALLOC;
890 rc = ber_get_stringbvl( &cookie, NULL );
894 case 'W': /* bvarray */
896 bgbvr cookie = { BvArray };
898 cookie.res.ba = va_arg( ap, struct berval ** );
899 cookie.alloc = LBER_BV_ALLOC;
900 rc = ber_get_stringbvl( &cookie, NULL );
904 case 'x': /* skip the next element - whatever it is */
905 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
908 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
911 case '{': /* begin sequence */
912 case '[': /* begin set */
913 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V'
914 && *(fmt + 1) != 'W' && *(fmt + 1) != 'M' )
915 rc = ber_skip_tag( ber, &len );
918 case '}': /* end sequence */
919 case ']': /* end set */
923 if( ber->ber_debug ) {
924 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
925 "ber_scanf: unknown fmt %c\n", *fmt );
933 if ( rc == LBER_DEFAULT ) {
935 * Error. Reclaim malloced memory that was given to the caller.
936 * Set allocated pointers to NULL, "data length" outvalues to 0.
940 for ( ; fmt_reset < fmt; fmt_reset++ ) {
941 switch ( *fmt_reset ) {
942 case '!': { /* Hook */
943 BERDecodeCallback *f;
946 f = va_arg( ap, BERDecodeCallback * );
947 p = va_arg( ap, void * );
949 (void) (*f)( ber, p, 1 );
952 case 'a': /* octet string - allocate storage as needed */
954 ss = va_arg( ap, char ** );
961 case 'b': /* boolean */
962 case 'e': /* enumerated */
964 (void) va_arg( ap, int * );
967 case 'l': /* length of next item */
968 (void) va_arg( ap, ber_len_t * );
971 case 'o': /* octet string in a supplied berval */
972 bval = va_arg( ap, struct berval * );
973 if ( bval->bv_val != NULL ) {
974 LBER_FREE( bval->bv_val );
980 case 'O': /* octet string - allocate & include length */
981 bvp = va_arg( ap, struct berval ** );
988 case 's': /* octet string - in a buffer */
989 (void) va_arg( ap, char * );
990 (void) va_arg( ap, ber_len_t * );
993 case 't': /* tag of next item */
994 case 'T': /* skip tag of next item */
995 (void) va_arg( ap, ber_tag_t * );
998 case 'B': /* bit string - allocate storage as needed */
999 ss = va_arg( ap, char ** );
1004 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
1007 case 'm': /* berval in-place */
1008 case 'M': /* BVoff array in-place */
1009 case 'n': /* null */
1010 case 'v': /* sequence of strings */
1011 case 'V': /* sequence of strings + lengths */
1012 case 'W': /* BerVarray */
1013 case 'x': /* skip the next element - whatever it is */
1014 case '{': /* begin sequence */
1015 case '[': /* begin set */
1016 case '}': /* end sequence */
1017 case ']': /* end set */
1021 /* format should be good */