1 /* decode.c - ber input decoding routines */
3 * Copyright (c) 1990 Regents of the University of Michigan.
6 * Redistribution and use in source and binary forms are permitted
7 * provided that this notice is preserved and that due credit is given
8 * to the University of Michigan at Ann Arbor. The name of the University
9 * may not be used to endorse or promote products derived from this
10 * software without specific prior written permission. This software
11 * is provided ``as is'' without express or implied warranty.
19 #include <ac/stdarg.h>
21 #include <ac/string.h>
22 #include <ac/socket.h>
26 static int ber_getnint LDAP_P(( BerElement *ber, long *num, int len ));
28 /* return the tag - LBER_DEFAULT returned means trouble */
30 ber_get_tag( BerElement *ber )
37 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
38 return( LBER_DEFAULT );
40 if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
41 return( (unsigned long) xbyte );
45 for ( i = 1; i < sizeof(long); i++ ) {
46 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
47 return( LBER_DEFAULT );
51 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
56 if ( i == sizeof(long) )
57 return( LBER_DEFAULT );
59 /* want leading, not trailing 0's */
60 return( tag >> (sizeof(long) - i - 1) );
64 ber_skip_tag( BerElement *ber, unsigned long *len )
72 * Any ber element looks like this: tag length contents.
73 * Assuming everything's ok, we return the tag byte (we
74 * can assume a single byte), and return the length in len.
78 * 2) primitive encodings used whenever possible
82 * First, we read the tag.
85 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT )
86 return( LBER_DEFAULT );
89 * Next, read the length. The first byte contains the length of
90 * the length. If bit 8 is set, the length is the long form,
91 * otherwise it's the short form. We don't allow a length that's
92 * greater than what we can hold in an unsigned long.
96 if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
97 return( LBER_DEFAULT );
99 noctets = (lc & 0x7f);
100 if ( noctets > sizeof(unsigned long) )
101 return( LBER_DEFAULT );
102 diff = sizeof(unsigned long) - noctets;
103 if ( ber_read( ber, (char *) &netlen + diff, noctets )
105 return( LBER_DEFAULT );
106 *len = AC_NTOHL( netlen );
115 ber_peek_tag( BerElement *ber, unsigned long *len )
121 tag = ber_skip_tag( ber, len );
128 ber_getnint( BerElement *ber, long *num, int len )
135 * The tag and length have already been stripped off. We should
136 * be sitting right before len bytes of 2's complement integer,
137 * ready to be read straight into an int. We may have to sign
138 * extend after we read it in.
141 if ( len > sizeof(long) )
145 diff = sizeof(long) - len;
146 /* read into the low-order bytes of netnum */
147 if ( ber_read( ber, ((char *) &netnum) + diff, len ) != len )
150 /* sign extend if necessary */
151 p = (char *) &netnum;
152 sign = (0x80 & *(p+diff) );
153 if ( sign && len < sizeof(long) ) {
154 for ( i = 0; i < diff; i++ ) {
155 *(p+i) = (unsigned char) 0xff;
158 *num = AC_NTOHL( netnum );
164 ber_get_int( BerElement *ber, long *num )
166 unsigned long tag, len;
168 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
169 return( LBER_DEFAULT );
171 if ( (unsigned long) ber_getnint( ber, num, (int)len ) != len )
172 return( LBER_DEFAULT );
178 ber_get_stringb( BerElement *ber, char *buf, unsigned long *len )
180 unsigned long datalen, tag;
181 #ifdef STR_TRANSLATION
183 #endif /* STR_TRANSLATION */
185 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
186 return( LBER_DEFAULT );
187 if ( datalen > (*len - 1) )
188 return( LBER_DEFAULT );
190 if ( (unsigned long) ber_read( ber, buf, datalen ) != datalen )
191 return( LBER_DEFAULT );
195 #ifdef STR_TRANSLATION
196 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
197 && ber->ber_decode_translate_proc != NULL ) {
200 if ( (*(ber->ber_decode_translate_proc))( &transbuf, &datalen,
202 return( LBER_DEFAULT );
204 if ( datalen > *len ) {
206 return( LBER_DEFAULT );
208 SAFEMEMCPY( buf, transbuf, datalen );
212 #endif /* STR_TRANSLATION */
219 ber_get_stringa( BerElement *ber, char **buf )
221 unsigned long datalen, tag;
223 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
225 return( LBER_DEFAULT );
228 if ( (*buf = (char *) malloc( (size_t)datalen + 1 )) == NULL )
229 return( LBER_DEFAULT );
231 if ( (unsigned long) ber_read( ber, *buf, datalen ) != datalen ) {
234 return( LBER_DEFAULT );
236 (*buf)[datalen] = '\0';
238 #ifdef STR_TRANSLATION
239 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
240 && ber->ber_decode_translate_proc != NULL ) {
242 if ( (*(ber->ber_decode_translate_proc))( buf, &datalen, 1 )
246 return( LBER_DEFAULT );
249 #endif /* STR_TRANSLATION */
255 ber_get_stringal( BerElement *ber, struct berval **bv )
257 unsigned long len, tag;
259 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
261 return( LBER_DEFAULT );
264 if ( (*bv = (struct berval *) malloc( sizeof(struct berval) )) == NULL )
265 return( LBER_DEFAULT );
267 if ( ((*bv)->bv_val = (char *) malloc( (size_t)len + 1 )) == NULL ) {
270 return( LBER_DEFAULT );
273 if ( (unsigned long) ber_read( ber, (*bv)->bv_val, len ) != len ) {
276 return( LBER_DEFAULT );
278 ((*bv)->bv_val)[len] = '\0';
281 #ifdef STR_TRANSLATION
282 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
283 && ber->ber_decode_translate_proc != NULL ) {
285 if ( (*(ber->ber_decode_translate_proc))( &((*bv)->bv_val),
289 return( LBER_DEFAULT );
291 (*bv)->bv_len = len - 1;
293 #endif /* STR_TRANSLATION */
299 ber_get_bitstringa( BerElement *ber, char **buf, unsigned long *blen )
301 unsigned long datalen, tag;
302 unsigned char unusedbits;
304 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
306 return( LBER_DEFAULT );
310 if ( (*buf = (char *) malloc( (size_t)datalen )) == NULL )
311 return( LBER_DEFAULT );
313 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
316 return( LBER_DEFAULT );
319 if ( (unsigned long) ber_read( ber, *buf, datalen ) != datalen ) {
322 return( LBER_DEFAULT );
325 *blen = datalen * 8 - unusedbits;
330 ber_get_null( BerElement *ber )
332 unsigned long len, tag;
334 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
335 return( LBER_DEFAULT );
338 return( LBER_DEFAULT );
344 ber_get_boolean( BerElement *ber, int *boolval )
349 rc = ber_get_int( ber, &longbool );
356 ber_first_element( BerElement *ber, unsigned long *len, char **last )
358 /* skip the sequence header, use the len to mark where to stop */
359 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
361 return( LBER_DEFAULT );
364 *last = ber->ber_ptr + *len;
366 if ( *last == ber->ber_ptr ) {
367 #ifdef LBER_END_SEQORSET
368 return( LBER_END_SEQORSET );
370 return( LBER_DEFAULT );
374 return( ber_peek_tag( ber, len ) );
378 ber_next_element( BerElement *ber, unsigned long *len, char *last )
380 if ( ber->ber_ptr == last ) {
381 #ifdef LBER_END_SEQORSET
382 return( LBER_END_SEQORSET );
384 return( LBER_DEFAULT );
388 return( ber_peek_tag( ber, len ) );
395 ( BerElement *ber, char *fmt, ... )
408 char *s, **ss, ***sss;
409 struct berval ***bv, **bvp, *bval;
412 unsigned long rc, tag, len;
418 ber = va_arg( ap, BerElement * );
419 fmt = va_arg( ap, char * );
423 if ( ber->ber_debug ) {
424 lber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
425 "ber_scanf fmt (%s) ber:\n", fmt );
426 lber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
429 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
430 /* When this is modified, remember to update
431 * the error-cleanup code below accordingly. */
433 case 'a': /* octet string - allocate storage as needed */
434 ss = va_arg( ap, char ** );
435 rc = ber_get_stringa( ber, ss );
438 case 'b': /* boolean */
439 i = va_arg( ap, int * );
440 rc = ber_get_boolean( ber, i );
443 case 'e': /* enumerated */
445 l = va_arg( ap, long * );
446 rc = ber_get_int( ber, l );
449 case 'l': /* length of next item */
450 l = va_arg( ap, long * );
451 rc = ber_peek_tag( ber, (unsigned long *)l );
455 rc = ber_get_null( ber );
458 case 's': /* octet string - in a buffer */
459 s = va_arg( ap, char * );
460 l = va_arg( ap, long * );
461 rc = ber_get_stringb( ber, s, (unsigned long *)l );
464 case 'o': /* octet string in a supplied berval */
465 bval = va_arg( ap, struct berval * );
466 ber_peek_tag( ber, &bval->bv_len );
467 rc = ber_get_stringa( ber, &bval->bv_val );
470 case 'O': /* octet string - allocate & include length */
471 bvp = va_arg( ap, struct berval ** );
472 rc = ber_get_stringal( ber, bvp );
475 case 'B': /* bit string - allocate storage as needed */
476 ss = va_arg( ap, char ** );
477 l = va_arg( ap, long * ); /* for length, in bits */
478 rc = ber_get_bitstringa( ber, ss, (unsigned long *)l );
481 case 't': /* tag of next item */
482 i = va_arg( ap, int * );
483 *i = rc = ber_peek_tag( ber, &len );
486 case 'T': /* skip tag of next item */
487 i = va_arg( ap, int * );
488 *i = rc = ber_skip_tag( ber, &len );
491 case 'v': /* sequence of strings */
492 sss = va_arg( ap, char *** );
495 for ( tag = ber_first_element( ber, &len, &last );
496 tag != LBER_DEFAULT &&
497 #ifdef LDAP_END_SEQORSET
498 tag != LBER_END_SEQORSET &&
501 tag = ber_next_element( ber, &len, last ) )
503 if ( *sss == NULL ) {
504 *sss = (char **) malloc(
505 2 * sizeof(char *) );
507 *sss = (char **) realloc( *sss,
508 (j + 2) * sizeof(char *) );
510 rc = ber_get_stringa( ber, &((*sss)[j]) );
513 #ifdef LDAP_END_SEQORSET
514 if (rc != LBER_DEFAULT &&
515 tag != LBER_END_SEQORSET )
524 case 'V': /* sequence of strings + lengths */
525 bv = va_arg( ap, struct berval *** );
528 for ( tag = ber_first_element( ber, &len, &last );
529 tag != LBER_DEFAULT &&
530 #ifdef LDAP_END_SEQORSET
531 tag != LBER_END_SEQORSET &&
534 tag = ber_next_element( ber, &len, last ) )
537 *bv = (struct berval **) malloc(
538 2 * sizeof(struct berval *) );
540 *bv = (struct berval **) realloc( *bv,
541 (j + 2) * sizeof(struct berval *) );
543 rc = ber_get_stringal( ber, &((*bv)[j]) );
546 #ifdef LDAP_END_SEQORSET
547 if (rc != LBER_DEFAULT &&
548 tag != LBER_END_SEQORSET )
557 case 'x': /* skip the next element - whatever it is */
558 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
563 case '{': /* begin sequence */
564 case '[': /* begin set */
565 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
566 rc = ber_skip_tag( ber, &len );
569 case '}': /* end sequence */
570 case ']': /* end set */
574 if( ber->ber_debug ) {
575 lber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
576 "ber_scanf: unknown fmt %c\n", *fmt );
585 if ( rc == LBER_DEFAULT ) {
587 * Error. Reclaim malloced memory that was given to the caller.
588 * Set allocated pointers to NULL, "data length" outvalues to 0.
594 (void) va_arg( ap, BerElement * );
595 (void) va_arg( ap, char * );
598 for ( ; fmt_reset < fmt; fmt_reset++ ) {
599 switch ( *fmt_reset ) {
600 case 'a': /* octet string - allocate storage as needed */
601 ss = va_arg( ap, char ** );
608 case 'b': /* boolean */
609 case 't': /* tag of next item */
610 case 'T': /* skip tag of next item */
611 (void) va_arg( ap, int * );
614 case 's': /* octet string - in a buffer */
615 (void) va_arg( ap, char * );
617 case 'e': /* enumerated */
619 case 'l': /* length of next item */
620 (void) va_arg( ap, long * );
623 case 'o': /* octet string in a supplied berval */
624 bval = va_arg( ap, struct berval * );
625 if ( bval->bv_val ) {
626 free( bval->bv_val );
632 case 'O': /* octet string - allocate & include length */
633 bvp = va_arg( ap, struct berval ** );
640 case 'B': /* bit string - allocate storage as needed */
641 ss = va_arg( ap, char ** );
646 *(va_arg( ap, long * )) = 0; /* for length, in bits */
649 case 'v': /* sequence of strings */
650 sss = va_arg( ap, char *** );
652 for (j = 0; (*sss)[j]; j++)
659 case 'V': /* sequence of strings + lengths */
660 bv = va_arg( ap, struct berval *** );
667 #if 0 /* No action for these format characters */
669 case 'x': /* skip the next element - whatever it is */
670 case '{': /* begin sequence */
671 case '[': /* begin set */
672 case '}': /* end sequence */
673 case ']': /* end set */
686 ber_bvfree( struct berval *bv )
689 assert(bv != NULL); /* bv damn better point to something */
691 if ( bv->bv_val != NULL )
697 ber_bvecfree( struct berval **bv )
702 assert(bv != NULL); /* bv damn better point to something */
704 for ( i = 0; bv[i] != NULL; i++ )
710 ber_bvdup( struct berval *bv )
714 if ( (new = (struct berval *) malloc( sizeof(struct berval) ))
719 if ( bv->bv_val == NULL ) {
725 if ( (new->bv_val = (char *) malloc( bv->bv_len + 1 )) == NULL ) {
730 SAFEMEMCPY( new->bv_val, bv->bv_val, (size_t) bv->bv_len );
731 new->bv_val[bv->bv_len] = '\0';
732 new->bv_len = bv->bv_len;
738 #ifdef STR_TRANSLATION
740 ber_set_string_translators( BerElement *ber, BERTranslateProc encode_proc,
741 BERTranslateProc decode_proc )
743 ber->ber_encode_translate_proc = encode_proc;
744 ber->ber_decode_translate_proc = decode_proc;
746 #endif /* STR_TRANSLATION */