1 /* decode.c - ber input decoding routines */
3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1990 Regents of the University of Michigan.
10 * Redistribution and use in source and binary forms are permitted
11 * provided that this notice is preserved and that due credit is given
12 * to the University of Michigan at Ann Arbor. The name of the University
13 * may not be used to endorse or promote products derived from this
14 * software without specific prior written permission. This software
15 * is provided ``as is'' without express or implied warranty.
23 #include <ac/stdarg.h>
25 #include <ac/string.h>
26 #include <ac/socket.h>
30 static int ber_getnint LDAP_P(( BerElement *ber, long *num, int len ));
32 /* return the tag - LBER_DEFAULT returned means trouble */
34 ber_get_tag( BerElement *ber )
41 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
42 return( LBER_DEFAULT );
44 if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
45 return( (unsigned long) xbyte );
49 for ( i = 1; i < sizeof(long); i++ ) {
50 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
51 return( LBER_DEFAULT );
55 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
60 if ( i == sizeof(long) )
61 return( LBER_DEFAULT );
63 /* want leading, not trailing 0's */
64 return( tag >> (sizeof(long) - i - 1) );
68 ber_skip_tag( BerElement *ber, unsigned long *len )
76 * Any ber element looks like this: tag length contents.
77 * Assuming everything's ok, we return the tag byte (we
78 * can assume a single byte), and return the length in len.
82 * 2) primitive encodings used whenever possible
86 * First, we read the tag.
89 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT )
90 return( LBER_DEFAULT );
93 * Next, read the length. The first byte contains the length of
94 * the length. If bit 8 is set, the length is the long form,
95 * otherwise it's the short form. We don't allow a length that's
96 * greater than what we can hold in an unsigned long.
100 if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
101 return( LBER_DEFAULT );
103 noctets = (lc & 0x7f);
104 if ( noctets > sizeof(unsigned long) )
105 return( LBER_DEFAULT );
106 diff = sizeof(unsigned long) - noctets;
107 if ( ber_read( ber, (char *) &netlen + diff, noctets )
109 return( LBER_DEFAULT );
110 *len = AC_NTOHL( netlen );
119 ber_peek_tag( BerElement *ber, unsigned long *len )
125 tag = ber_skip_tag( ber, len );
132 ber_getnint( BerElement *ber, long *num, int len )
139 * The tag and length have already been stripped off. We should
140 * be sitting right before len bytes of 2's complement integer,
141 * ready to be read straight into an int. We may have to sign
142 * extend after we read it in.
145 if ( len > sizeof(long) )
149 diff = sizeof(long) - len;
150 /* read into the low-order bytes of netnum */
151 if ( ber_read( ber, ((char *) &netnum) + diff, len ) != len )
154 /* sign extend if necessary */
155 p = (char *) &netnum;
156 sign = (0x80 & *(p+diff) );
157 if ( sign && len < sizeof(long) ) {
158 for ( i = 0; i < diff; i++ ) {
159 *(p+i) = (unsigned char) 0xff;
162 *num = AC_NTOHL( netnum );
168 ber_get_int( BerElement *ber, long *num )
170 unsigned long tag, len;
172 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
173 return( LBER_DEFAULT );
175 if ( (unsigned long) ber_getnint( ber, num, (int)len ) != len )
176 return( LBER_DEFAULT );
182 ber_get_stringb( BerElement *ber, char *buf, unsigned long *len )
184 unsigned long datalen, tag;
185 #ifdef STR_TRANSLATION
187 #endif /* STR_TRANSLATION */
189 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
190 return( LBER_DEFAULT );
191 if ( datalen > (*len - 1) )
192 return( LBER_DEFAULT );
194 if ( (unsigned long) ber_read( ber, buf, datalen ) != datalen )
195 return( LBER_DEFAULT );
199 #ifdef STR_TRANSLATION
200 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
201 && ber->ber_decode_translate_proc != NULL ) {
204 if ( (*(ber->ber_decode_translate_proc))( &transbuf, &datalen,
206 return( LBER_DEFAULT );
208 if ( datalen > *len ) {
210 return( LBER_DEFAULT );
212 SAFEMEMCPY( buf, transbuf, datalen );
216 #endif /* STR_TRANSLATION */
223 ber_get_stringa( BerElement *ber, char **buf )
225 unsigned long datalen, tag;
227 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
229 return( LBER_DEFAULT );
232 if ( (*buf = (char *) malloc( (size_t)datalen + 1 )) == NULL )
233 return( LBER_DEFAULT );
235 if ( (unsigned long) ber_read( ber, *buf, datalen ) != datalen ) {
238 return( LBER_DEFAULT );
240 (*buf)[datalen] = '\0';
242 #ifdef STR_TRANSLATION
243 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
244 && ber->ber_decode_translate_proc != NULL ) {
246 if ( (*(ber->ber_decode_translate_proc))( buf, &datalen, 1 )
250 return( LBER_DEFAULT );
253 #endif /* STR_TRANSLATION */
259 ber_get_stringal( BerElement *ber, struct berval **bv )
261 unsigned long len, tag;
263 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
265 return( LBER_DEFAULT );
268 if ( (*bv = (struct berval *) malloc( sizeof(struct berval) )) == NULL )
269 return( LBER_DEFAULT );
271 if ( ((*bv)->bv_val = (char *) malloc( (size_t)len + 1 )) == NULL ) {
274 return( LBER_DEFAULT );
277 if ( (unsigned long) ber_read( ber, (*bv)->bv_val, len ) != len ) {
280 return( LBER_DEFAULT );
282 ((*bv)->bv_val)[len] = '\0';
285 #ifdef STR_TRANSLATION
286 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
287 && ber->ber_decode_translate_proc != NULL ) {
289 if ( (*(ber->ber_decode_translate_proc))( &((*bv)->bv_val),
293 return( LBER_DEFAULT );
295 (*bv)->bv_len = len - 1;
297 #endif /* STR_TRANSLATION */
303 ber_get_bitstringa( BerElement *ber, char **buf, unsigned long *blen )
305 unsigned long datalen, tag;
306 unsigned char unusedbits;
308 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
310 return( LBER_DEFAULT );
314 if ( (*buf = (char *) malloc( (size_t)datalen )) == NULL )
315 return( LBER_DEFAULT );
317 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
320 return( LBER_DEFAULT );
323 if ( (unsigned long) ber_read( ber, *buf, datalen ) != datalen ) {
326 return( LBER_DEFAULT );
329 *blen = datalen * 8 - unusedbits;
334 ber_get_null( BerElement *ber )
336 unsigned long len, tag;
338 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
339 return( LBER_DEFAULT );
342 return( LBER_DEFAULT );
348 ber_get_boolean( BerElement *ber, int *boolval )
353 rc = ber_get_int( ber, &longbool );
360 ber_first_element( BerElement *ber, unsigned long *len, char **last )
362 /* skip the sequence header, use the len to mark where to stop */
363 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
365 return( LBER_DEFAULT );
368 *last = ber->ber_ptr + *len;
370 if ( *last == ber->ber_ptr ) {
371 #ifdef LBER_END_SEQORSET
372 return( LBER_END_SEQORSET );
374 return( LBER_DEFAULT );
378 return( ber_peek_tag( ber, len ) );
382 ber_next_element( BerElement *ber, unsigned long *len, char *last )
384 if ( ber->ber_ptr == last ) {
385 #ifdef LBER_END_SEQORSET
386 return( LBER_END_SEQORSET );
388 return( LBER_DEFAULT );
392 return( ber_peek_tag( ber, len ) );
399 ( BerElement *ber, char *fmt, ... )
412 char *s, **ss, ***sss;
413 struct berval ***bv, **bvp, *bval;
416 unsigned long rc, tag, len;
422 ber = va_arg( ap, BerElement * );
423 fmt = va_arg( ap, char * );
427 if ( ber->ber_debug ) {
428 lber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
429 "ber_scanf fmt (%s) ber:\n", fmt );
430 lber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
433 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
434 /* When this is modified, remember to update
435 * the error-cleanup code below accordingly. */
437 case 'a': /* octet string - allocate storage as needed */
438 ss = va_arg( ap, char ** );
439 rc = ber_get_stringa( ber, ss );
442 case 'b': /* boolean */
443 i = va_arg( ap, int * );
444 rc = ber_get_boolean( ber, i );
447 case 'e': /* enumerated */
449 l = va_arg( ap, long * );
450 rc = ber_get_int( ber, l );
453 case 'l': /* length of next item */
454 l = va_arg( ap, long * );
455 rc = ber_peek_tag( ber, (unsigned long *)l );
459 rc = ber_get_null( ber );
462 case 's': /* octet string - in a buffer */
463 s = va_arg( ap, char * );
464 l = va_arg( ap, long * );
465 rc = ber_get_stringb( ber, s, (unsigned long *)l );
468 case 'o': /* octet string in a supplied berval */
469 bval = va_arg( ap, struct berval * );
470 ber_peek_tag( ber, &bval->bv_len );
471 rc = ber_get_stringa( ber, &bval->bv_val );
474 case 'O': /* octet string - allocate & include length */
475 bvp = va_arg( ap, struct berval ** );
476 rc = ber_get_stringal( ber, bvp );
479 case 'B': /* bit string - allocate storage as needed */
480 ss = va_arg( ap, char ** );
481 l = va_arg( ap, long * ); /* for length, in bits */
482 rc = ber_get_bitstringa( ber, ss, (unsigned long *)l );
485 case 't': /* tag of next item */
486 i = va_arg( ap, int * );
487 *i = rc = ber_peek_tag( ber, &len );
490 case 'T': /* skip tag of next item */
491 i = va_arg( ap, int * );
492 *i = rc = ber_skip_tag( ber, &len );
495 case 'v': /* sequence of strings */
496 sss = va_arg( ap, char *** );
499 for ( tag = ber_first_element( ber, &len, &last );
500 tag != LBER_DEFAULT &&
501 #ifdef LDAP_END_SEQORSET
502 tag != LBER_END_SEQORSET &&
505 tag = ber_next_element( ber, &len, last ) )
507 if ( *sss == NULL ) {
508 *sss = (char **) malloc(
509 2 * sizeof(char *) );
511 *sss = (char **) realloc( *sss,
512 (j + 2) * sizeof(char *) );
514 rc = ber_get_stringa( ber, &((*sss)[j]) );
517 #ifdef LDAP_END_SEQORSET
518 if (rc != LBER_DEFAULT &&
519 tag != LBER_END_SEQORSET )
528 case 'V': /* sequence of strings + lengths */
529 bv = va_arg( ap, struct berval *** );
532 for ( tag = ber_first_element( ber, &len, &last );
533 tag != LBER_DEFAULT &&
534 #ifdef LDAP_END_SEQORSET
535 tag != LBER_END_SEQORSET &&
538 tag = ber_next_element( ber, &len, last ) )
541 *bv = (struct berval **) malloc(
542 2 * sizeof(struct berval *) );
544 *bv = (struct berval **) realloc( *bv,
545 (j + 2) * sizeof(struct berval *) );
547 rc = ber_get_stringal( ber, &((*bv)[j]) );
550 #ifdef LDAP_END_SEQORSET
551 if (rc != LBER_DEFAULT &&
552 tag != LBER_END_SEQORSET )
561 case 'x': /* skip the next element - whatever it is */
562 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
567 case '{': /* begin sequence */
568 case '[': /* begin set */
569 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
570 rc = ber_skip_tag( ber, &len );
573 case '}': /* end sequence */
574 case ']': /* end set */
578 if( ber->ber_debug ) {
579 lber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
580 "ber_scanf: unknown fmt %c\n", *fmt );
589 if ( rc == LBER_DEFAULT ) {
591 * Error. Reclaim malloced memory that was given to the caller.
592 * Set allocated pointers to NULL, "data length" outvalues to 0.
598 (void) va_arg( ap, BerElement * );
599 (void) va_arg( ap, char * );
602 for ( ; fmt_reset < fmt; fmt_reset++ ) {
603 switch ( *fmt_reset ) {
604 case 'a': /* octet string - allocate storage as needed */
605 ss = va_arg( ap, char ** );
612 case 'b': /* boolean */
613 case 't': /* tag of next item */
614 case 'T': /* skip tag of next item */
615 (void) va_arg( ap, int * );
618 case 's': /* octet string - in a buffer */
619 (void) va_arg( ap, char * );
621 case 'e': /* enumerated */
623 case 'l': /* length of next item */
624 (void) va_arg( ap, long * );
627 case 'o': /* octet string in a supplied berval */
628 bval = va_arg( ap, struct berval * );
629 if ( bval->bv_val ) {
630 free( bval->bv_val );
636 case 'O': /* octet string - allocate & include length */
637 bvp = va_arg( ap, struct berval ** );
644 case 'B': /* bit string - allocate storage as needed */
645 ss = va_arg( ap, char ** );
650 *(va_arg( ap, long * )) = 0; /* for length, in bits */
653 case 'v': /* sequence of strings */
654 sss = va_arg( ap, char *** );
656 for (j = 0; (*sss)[j]; j++)
663 case 'V': /* sequence of strings + lengths */
664 bv = va_arg( ap, struct berval *** );
671 #if 0 /* No action for these format characters */
673 case 'x': /* skip the next element - whatever it is */
674 case '{': /* begin sequence */
675 case '[': /* begin set */
676 case '}': /* end sequence */
677 case ']': /* end set */
690 ber_bvfree( struct berval *bv )
693 assert(bv != NULL); /* bv damn better point to something */
695 if ( bv->bv_val != NULL )
701 ber_bvecfree( struct berval **bv )
706 assert(bv != NULL); /* bv damn better point to something */
708 for ( i = 0; bv[i] != NULL; i++ )
714 ber_bvdup( struct berval *bv )
718 if ( (new = (struct berval *) malloc( sizeof(struct berval) ))
723 if ( bv->bv_val == NULL ) {
729 if ( (new->bv_val = (char *) malloc( bv->bv_len + 1 )) == NULL ) {
734 SAFEMEMCPY( new->bv_val, bv->bv_val, (size_t) bv->bv_len );
735 new->bv_val[bv->bv_len] = '\0';
736 new->bv_len = bv->bv_len;
742 #ifdef STR_TRANSLATION
744 ber_set_string_translators( BerElement *ber, BERTranslateProc encode_proc,
745 BERTranslateProc decode_proc )
747 ber->ber_encode_translate_proc = encode_proc;
748 ber->ber_decode_translate_proc = decode_proc;
750 #endif /* STR_TRANSLATION */