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 {
323 const enum bgbvc choice;
324 const int alloc; /* choice == BvOff ? 0 : LBER_ALLOC */
325 ber_len_t siz; /* input array element size, output count */
326 ber_len_t off; /* BvOff offset to the struct berval */
331 ber_get_stringbvl( BerElement *ber, bgbvr *b )
335 ber_len_t len, tot_size = 0, siz = b->siz;
337 struct berval bv, *bvp = NULL;
339 char **ca; /* ChArray */
340 BerVarray ba; /* BvArray */
341 struct berval **bv; /* BvVec */
342 char *bo; /* BvOff */
345 /* For rewinding, just like ber_peek_tag() */
349 if ( ber_first_element( ber, &len, &last ) != LBER_DEFAULT ) {
350 for ( ; ber->ber_ptr < last; i++, tot_size += siz ) {
351 if ( ber_skip_tag( ber, &len ) == LBER_DEFAULT ) break;
353 ber->ber_tag = *(unsigned char *) ber->ber_ptr;
362 /* Allocate and NULL-terminate the result vector */
363 b->result = ber_memalloc_x( tot_size + siz, ber->ber_memctx );
364 if ( b->result == NULL ) {
374 res.ba[i].bv_val = NULL;
381 res.bo = (char *) b->result + b->off;
382 ((struct berval *) (res.bo + tot_size))->bv_val = NULL;
387 ber_skip_tag( ber, &len );
392 tag = ber_next_element( ber, &len, last );
393 if ( ber_get_stringbv( ber, &bv, b->alloc ) == LBER_DEFAULT ) {
397 /* store my result */
400 res.ca[n] = bv.bv_val;
406 bvp = ber_memalloc_x( sizeof( struct berval ),
409 ber_memfree_x( bv.bv_val, ber->ber_memctx );
416 *(struct berval *)(res.bo + tot_size) = bv;
424 if (b->choice != BvOff) { /* BvOff does not have b->alloc set */
428 ber_memfree_x(res.ca[n], ber->ber_memctx);
431 ber_memfree_x(res.ba[n].bv_val, ber->ber_memctx);
434 ber_memfree_x(res.bv[n]->bv_val, ber->ber_memctx);
435 ber_memfree_x(res.bv[n], ber->ber_memctx);
442 ber_memfree_x(b->result, ber->ber_memctx);
448 ber_get_stringbv( BerElement *ber, struct berval *bv, int option )
452 assert( bv != NULL );
454 tag = ber_skip_tag( ber, &bv->bv_len );
455 if ( tag == LBER_DEFAULT ) {
460 if ( option & LBER_BV_ALLOC ) {
461 bv->bv_val = (char *) ber_memalloc_x( bv->bv_len + 1,
463 if ( bv->bv_val == NULL ) {
467 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
468 bv->bv_len ) != bv->bv_len )
470 ber_memfree_x( bv->bv_val, ber->ber_memctx );
475 bv->bv_val = ber->ber_ptr;
476 ber->ber_ptr += bv->bv_len;
478 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
479 if ( !( option & LBER_BV_NOTERM ))
480 bv->bv_val[bv->bv_len] = '\0';
486 ber_get_stringbv_null( BerElement *ber, struct berval *bv, int option )
490 assert( bv != NULL );
492 tag = ber_skip_tag( ber, &bv->bv_len );
493 if ( tag == LBER_DEFAULT || bv->bv_len == 0 ) {
498 if ( option & LBER_BV_ALLOC ) {
499 bv->bv_val = (char *) ber_memalloc_x( bv->bv_len + 1,
501 if ( bv->bv_val == NULL ) {
505 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
506 bv->bv_len ) != bv->bv_len )
508 ber_memfree_x( bv->bv_val, ber->ber_memctx );
513 bv->bv_val = ber->ber_ptr;
514 ber->ber_ptr += bv->bv_len;
516 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
517 if ( !( option & LBER_BV_NOTERM ))
518 bv->bv_val[bv->bv_len] = '\0';
524 ber_get_stringa( BerElement *ber, char **buf )
529 assert( buf != NULL );
531 tag = ber_get_stringbv( ber, &bv, LBER_BV_ALLOC );
538 ber_get_stringa_null( BerElement *ber, char **buf )
543 assert( buf != NULL );
545 tag = ber_get_stringbv_null( ber, &bv, LBER_BV_ALLOC );
552 ber_get_stringal( BerElement *ber, struct berval **bv )
556 assert( ber != NULL );
557 assert( bv != NULL );
559 *bv = (struct berval *) ber_memalloc_x( sizeof(struct berval),
565 tag = ber_get_stringbv( ber, *bv, LBER_BV_ALLOC );
566 if ( tag == LBER_DEFAULT ) {
567 ber_memfree_x( *bv, ber->ber_memctx );
581 unsigned char unusedbits;
583 assert( buf != NULL );
584 assert( blen != NULL );
586 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
590 if ( --datalen > (ber_len_t)-1 / 8 ) {
593 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
596 if ( unusedbits > 7 ) {
600 *buf = (char *) ber_memalloc_x( datalen, ber->ber_memctx );
601 if ( *buf == NULL ) {
605 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
606 ber_memfree_x( buf, ber->ber_memctx );
610 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
612 *blen = datalen * 8 - unusedbits;
621 ber_get_null( BerElement *ber )
624 ber_tag_t tag = ber_skip_tag( ber, &len );
626 return( len == 0 ? tag : LBER_DEFAULT );
634 return ber_get_int( ber, boolval );
643 assert( last != NULL );
645 /* skip the sequence header, use the len to mark where to stop */
646 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
651 *last = ber->ber_ptr + *len;
657 return ber_peek_tag( ber, len );
664 LDAP_CONST char *last )
666 assert( ber != NULL );
667 assert( last != NULL );
668 assert( LBER_VALID( ber ) );
670 if ( ber->ber_ptr >= last ) {
674 return ber_peek_tag( ber, len );
679 ber_scanf ( BerElement *ber,
680 LDAP_CONST char *fmt,
684 LDAP_CONST char *fmt_reset;
685 char *s, **ss, ***sss;
686 struct berval *bval, **bvp, ***bvpp;
695 assert( ber != NULL );
696 assert( fmt != NULL );
697 assert( LBER_VALID( ber ) );
701 if ( ber->ber_debug & (LDAP_DEBUG_TRACE|LDAP_DEBUG_BER)) {
702 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
703 "ber_scanf fmt (%s) ber:\n", fmt );
704 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
707 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
708 /* When this is modified, remember to update
709 * the error-cleanup code below accordingly. */
711 case '!': { /* Hook */
712 BERDecodeCallback *f;
715 f = va_arg( ap, BERDecodeCallback * );
716 p = va_arg( ap, void * );
718 rc = (*f)( ber, p, 0 );
721 case 'a': /* octet string - allocate storage as needed */
722 ss = va_arg( ap, char ** );
723 rc = ber_get_stringa( ber, ss );
726 case 'A': /* octet string - allocate storage as needed,
727 * but return NULL if len == 0 */
728 ss = va_arg( ap, char ** );
729 rc = ber_get_stringa_null( ber, ss );
732 case 'b': /* boolean */
733 i = va_arg( ap, ber_int_t * );
734 rc = ber_get_boolean( ber, i );
737 case 'B': /* bit string - allocate storage as needed */
738 ss = va_arg( ap, char ** );
739 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
740 rc = ber_get_bitstringa( ber, ss, l );
743 case 'e': /* enumerated */
744 case 'i': /* integer */
745 i = va_arg( ap, ber_int_t * );
746 rc = ber_get_int( ber, i );
749 case 'l': /* length of next item */
750 l = va_arg( ap, ber_len_t * );
751 rc = ber_peek_tag( ber, l );
754 case 'm': /* octet string in berval, in-place */
755 bval = va_arg( ap, struct berval * );
756 rc = ber_get_stringbv( ber, bval, 0 );
759 case 'M': /* bvoffarray - must include address of
760 * a record len, and record offset.
761 * number of records will be returned thru
762 * len ptr on finish. parsed in-place.
765 bgbvr cookie = { BvOff, 0 };
766 bvp = va_arg( ap, struct berval ** );
767 l = va_arg( ap, ber_len_t * );
769 cookie.off = va_arg( ap, ber_len_t );
770 rc = ber_get_stringbvl( ber, &cookie );
771 *bvp = cookie.result;
777 rc = ber_get_null( ber );
780 case 'o': /* octet string in a supplied berval */
781 bval = va_arg( ap, struct berval * );
782 rc = ber_get_stringbv( ber, bval, LBER_BV_ALLOC );
785 case 'O': /* octet string - allocate & include length */
786 bvp = va_arg( ap, struct berval ** );
787 rc = ber_get_stringal( ber, bvp );
790 case 's': /* octet string - in a buffer */
791 s = va_arg( ap, char * );
792 l = va_arg( ap, ber_len_t * );
793 rc = ber_get_stringb( ber, s, l );
796 case 't': /* tag of next item */
797 t = va_arg( ap, ber_tag_t * );
798 *t = rc = ber_peek_tag( ber, &len );
801 case 'T': /* skip tag of next item */
802 t = va_arg( ap, ber_tag_t * );
803 *t = rc = ber_skip_tag( ber, &len );
806 case 'v': /* sequence of strings */
809 ChArray, LBER_BV_ALLOC, sizeof( char * )
811 rc = ber_get_stringbvl( ber, &cookie );
812 *(va_arg( ap, char *** )) = cookie.result;
816 case 'V': /* sequence of strings + lengths */
819 BvVec, LBER_BV_ALLOC, sizeof( struct berval * )
821 rc = ber_get_stringbvl( ber, &cookie );
822 *(va_arg( ap, struct berval *** )) = cookie.result;
826 case 'W': /* bvarray */
829 BvArray, LBER_BV_ALLOC, sizeof( struct berval )
831 rc = ber_get_stringbvl( ber, &cookie );
832 *(va_arg( ap, struct berval ** )) = cookie.result;
836 case 'x': /* skip the next element - whatever it is */
837 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
840 ber->ber_tag = *(unsigned char *)ber->ber_ptr;
843 case '{': /* begin sequence */
844 case '[': /* begin set */
846 case 'v': case 'V': case 'W': case 'M':
849 rc = ber_skip_tag( ber, &len );
854 case '}': /* end sequence */
855 case ']': /* end set */
859 if( ber->ber_debug ) {
860 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
861 "ber_scanf: unknown fmt %c\n", *fmt );
870 if ( rc == LBER_DEFAULT ) {
872 * Error. Reclaim malloced memory that was given to the caller.
873 * Set allocated pointers to NULL, "data length" outvalues to 0.
877 for ( ; fmt_reset < fmt; fmt_reset++ ) {
878 switch ( *fmt_reset ) {
879 case '!': { /* Hook */
880 BERDecodeCallback *f;
883 f = va_arg( ap, BERDecodeCallback * );
884 p = va_arg( ap, void * );
886 (void) (*f)( ber, p, 1 );
889 case 'a': /* octet string - allocate storage as needed */
891 ss = va_arg( ap, char ** );
892 ber_memfree_x( *ss, ber->ber_memctx );
896 case 'b': /* boolean */
897 case 'e': /* enumerated */
898 case 'i': /* integer */
899 (void) va_arg( ap, ber_int_t * );
902 case 'l': /* length of next item */
903 *(va_arg( ap, ber_len_t * )) = 0;
906 case 'm': /* berval in-place */
907 bval = va_arg( ap, struct berval * );
911 case 'M': /* BVoff array in-place */
912 bvp = va_arg( ap, struct berval ** );
913 ber_memfree_x( bvp, ber->ber_memctx );
915 *(va_arg( ap, ber_len_t * )) = 0;
916 (void) va_arg( ap, ber_len_t );
919 case 'o': /* octet string in a supplied berval */
920 bval = va_arg( ap, struct berval * );
921 ber_memfree_x( bval->bv_val, ber->ber_memctx );
925 case 'O': /* octet string - allocate & include length */
926 bvp = va_arg( ap, struct berval ** );
927 ber_bvfree_x( *bvp, ber->ber_memctx );
931 case 's': /* octet string - in a buffer */
932 (void) va_arg( ap, char * );
933 *(va_arg( ap, ber_len_t * )) = 0;
936 case 't': /* tag of next item */
937 case 'T': /* skip tag of next item */
938 (void) va_arg( ap, ber_tag_t * );
941 case 'B': /* bit string - allocate storage as needed */
942 ss = va_arg( ap, char ** );
943 ber_memfree_x( *ss, ber->ber_memctx );
945 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
948 case 'v': /* sequence of strings */
949 sss = va_arg( ap, char *** );
950 ber_memvfree_x( (void **) *sss, ber->ber_memctx );
954 case 'V': /* sequence of strings + lengths */
955 bvpp = va_arg( ap, struct berval *** );
956 ber_bvecfree_x( *bvpp, ber->ber_memctx );
960 case 'W': /* BerVarray */
961 bvp = va_arg( ap, struct berval ** );
962 ber_bvarray_free_x( *bvp, ber->ber_memctx );
967 case 'x': /* skip the next element - whatever it is */
968 case '{': /* begin sequence */
969 case '[': /* begin set */
970 case '}': /* end sequence */
971 case ']': /* end set */
975 /* format should be good */