1 /* decode.c - ber input decoding routines */
4 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
8 * Copyright (c) 1990 Regents of the University of Michigan.
11 * Redistribution and use in source and binary forms are permitted
12 * provided that this notice is preserved and that due credit is given
13 * to the University of Michigan at Ann Arbor. The name of the University
14 * may not be used to endorse or promote products derived from this
15 * software without specific prior written permission. This software
16 * is provided ``as is'' without express or implied warranty.
23 #include <ac/stdlib.h>
25 #include <ac/stdarg.h>
26 #include <ac/string.h>
27 #include <ac/socket.h>
30 #define LDAP_F_PRE LDAP_F_EXPORT
34 static ber_len_t ber_getnint LDAP_P((
39 /* return the tag - LBER_DEFAULT returned means trouble */
41 ber_get_tag( BerElement *ber )
48 assert( ber != NULL );
49 assert( BER_VALID( ber ) );
51 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
52 return( LBER_DEFAULT );
54 if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
55 return( (ber_tag_t) xbyte );
59 for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
60 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
61 return( LBER_DEFAULT );
65 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
70 if ( i == sizeof(ber_tag_t) )
71 return( LBER_DEFAULT );
73 /* want leading, not trailing 0's */
74 return( tag >> (sizeof(ber_tag_t) - i - 1) );
78 ber_skip_tag( BerElement *ber, ber_len_t *len )
86 assert( ber != NULL );
87 assert( len != NULL );
88 assert( BER_VALID( ber ) );
91 * Any ber element looks like this: tag length contents.
92 * Assuming everything's ok, we return the tag byte (we
93 * can assume a single byte), and return the length in len.
97 * 2) primitive encodings used whenever possible
101 * First, we read the tag.
104 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT )
105 return( LBER_DEFAULT );
108 * Next, read the length. The first byte contains the length of
109 * the length. If bit 8 is set, the length is the long form,
110 * otherwise it's the short form. We don't allow a length that's
111 * greater than what we can hold in a ber_len_t.
115 if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
116 return( LBER_DEFAULT );
118 noctets = (lc & 0x7fU);
119 if ( noctets > sizeof(ber_len_t) )
120 return( LBER_DEFAULT );
121 diff = sizeof(ber_len_t) - noctets;
122 if ( (unsigned) ber_read( ber, (char *) &netlen + diff, noctets )
124 return( LBER_DEFAULT );
125 *len = LBER_LEN_NTOH( netlen );
135 LDAP_CONST BerElement *ber_in,
141 assert( ber_in != NULL );
142 assert( BER_VALID( ber_in ) );
144 ber = ber_dup( ber_in );
150 assert( BER_VALID( ber ) );
152 tag = ber_skip_tag( ber, len );
164 unsigned char buf[sizeof(ber_int_t)];
166 assert( ber != NULL );
167 assert( num != NULL );
169 assert( BER_VALID( ber ) );
172 * The tag and length have already been stripped off. We should
173 * be sitting right before len bytes of 2's complement integer,
174 * ready to be read straight into an int. We may have to sign
175 * extend after we read it in.
178 if ( len > sizeof(ber_int_t) )
181 /* read into the low-order bytes of our buffer */
182 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
187 /* sign extend if necessary */
189 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
191 /* shift in the bytes */
192 for( i=0 ; i<len; i++ ) {
193 netnum = (netnum << 8 ) | buf[i];
213 assert( ber != NULL );
214 assert( BER_VALID( ber ) );
216 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
217 return( LBER_DEFAULT );
219 if ( ber_getnint( ber, num, len ) != len )
220 return( LBER_DEFAULT );
234 #ifdef STR_TRANSLATION
236 #endif /* STR_TRANSLATION */
238 assert( ber != NULL );
239 assert( BER_VALID( ber ) );
241 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
242 return( LBER_DEFAULT );
243 if ( datalen > (*len - 1) )
244 return( LBER_DEFAULT );
246 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen )
247 return( LBER_DEFAULT );
251 #ifdef STR_TRANSLATION
252 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
253 && ber->ber_decode_translate_proc ) {
256 if ( (*(ber->ber_decode_translate_proc))( &transbuf, &datalen,
258 return( LBER_DEFAULT );
260 if ( datalen > *len ) {
261 LBER_FREE( transbuf );
262 return( LBER_DEFAULT );
264 SAFEMEMCPY( buf, transbuf, datalen );
265 LBER_FREE( transbuf );
268 #endif /* STR_TRANSLATION */
275 ber_get_stringa( BerElement *ber, char **buf )
280 assert( ber != NULL );
281 assert( buf != NULL );
283 assert( BER_VALID( ber ) );
285 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
287 return( LBER_DEFAULT );
290 if ( (*buf = (char *) LBER_MALLOC( datalen + 1 )) == NULL )
291 return( LBER_DEFAULT );
293 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
296 return( LBER_DEFAULT );
298 (*buf)[datalen] = '\0';
300 #ifdef STR_TRANSLATION
301 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
302 && ber->ber_decode_translate_proc ) {
304 if ( (*(ber->ber_decode_translate_proc))( buf, &datalen, 1 )
308 return( LBER_DEFAULT );
311 #endif /* STR_TRANSLATION */
317 ber_get_stringal( BerElement *ber, struct berval **bv )
322 assert( ber != NULL );
323 assert( bv != NULL );
325 assert( BER_VALID( ber ) );
327 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
329 return( LBER_DEFAULT );
332 if ( (*bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) )) == NULL )
333 return( LBER_DEFAULT );
335 if ( ((*bv)->bv_val = (char *) LBER_MALLOC( len + 1 )) == NULL ) {
338 return( LBER_DEFAULT );
341 if ( (ber_len_t) ber_read( ber, (*bv)->bv_val, len ) != len ) {
344 return( LBER_DEFAULT );
346 ((*bv)->bv_val)[len] = '\0';
349 #ifdef STR_TRANSLATION
350 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
351 && ber->ber_decode_translate_proc ) {
353 if ( (*(ber->ber_decode_translate_proc))( &((*bv)->bv_val),
357 return( LBER_DEFAULT );
359 (*bv)->bv_len = len - 1;
361 #endif /* STR_TRANSLATION */
374 unsigned char unusedbits;
376 assert( ber != NULL );
377 assert( buf != NULL );
378 assert( blen != NULL );
380 assert( BER_VALID( ber ) );
382 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
384 return( LBER_DEFAULT );
388 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL )
389 return( LBER_DEFAULT );
391 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
394 return( LBER_DEFAULT );
397 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
400 return( LBER_DEFAULT );
403 *blen = datalen * 8 - unusedbits;
408 ber_get_null( BerElement *ber )
413 assert( ber != NULL );
414 assert( BER_VALID( ber ) );
416 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
417 return( LBER_DEFAULT );
420 return( LBER_DEFAULT );
433 assert( ber != NULL );
434 assert( boolval != NULL );
436 assert( BER_VALID( ber ) );
438 rc = ber_get_int( ber, &longbool );
450 assert( ber != NULL );
451 assert( len != NULL );
452 assert( last != NULL );
454 /* skip the sequence header, use the len to mark where to stop */
455 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
457 return( LBER_DEFAULT );
460 *last = ber->ber_ptr + *len;
462 if ( *last == ber->ber_ptr ) {
463 return( LBER_DEFAULT );
466 return( ber_peek_tag( ber, len ) );
475 assert( ber != NULL );
476 assert( len != NULL );
477 assert( last != NULL );
479 assert( BER_VALID( ber ) );
481 if ( ber->ber_ptr == last ) {
482 return( LBER_DEFAULT );
485 return( ber_peek_tag( ber, len ) );
490 ber_scanf ( BerElement *ber,
491 LDAP_CONST char *fmt,
495 LDAP_CONST char *fmt_reset;
497 char *s, **ss, ***sss;
498 struct berval ***bv, **bvp, *bval;
508 assert( ber != NULL );
509 assert( fmt != NULL );
511 assert( BER_VALID( ber ) );
515 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
516 "ber_scanf fmt (%s) ber:\n", fmt );
517 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
519 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
520 /* When this is modified, remember to update
521 * the error-cleanup code below accordingly. */
523 case '!': { /* Hook */
524 BERDecodeCallback *f;
527 f = va_arg( ap, BERDecodeCallback * );
528 p = va_arg( ap, void * );
530 rc = (*f)( ber, p, 0 );
533 case 'a': /* octet string - allocate storage as needed */
534 ss = va_arg( ap, char ** );
535 rc = ber_get_stringa( ber, ss );
538 case 'b': /* boolean */
539 i = va_arg( ap, ber_int_t * );
540 rc = ber_get_boolean( ber, i );
543 case 'e': /* enumerated */
545 i = va_arg( ap, ber_int_t * );
546 rc = ber_get_int( ber, i );
549 case 'l': /* length of next item */
550 l = va_arg( ap, ber_len_t * );
551 rc = ber_peek_tag( ber, l );
555 rc = ber_get_null( ber );
558 case 's': /* octet string - in a buffer */
559 s = va_arg( ap, char * );
560 l = va_arg( ap, ber_len_t * );
561 rc = ber_get_stringb( ber, s, l );
564 case 'o': /* octet string in a supplied berval */
565 bval = va_arg( ap, struct berval * );
566 ber_peek_tag( ber, &bval->bv_len );
567 rc = ber_get_stringa( ber, &bval->bv_val );
570 case 'O': /* octet string - allocate & include length */
571 bvp = va_arg( ap, struct berval ** );
572 rc = ber_get_stringal( ber, bvp );
575 case 'B': /* bit string - allocate storage as needed */
576 ss = va_arg( ap, char ** );
577 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
578 rc = ber_get_bitstringa( ber, ss, l );
581 case 't': /* tag of next item */
582 t = va_arg( ap, ber_tag_t * );
583 *t = rc = ber_peek_tag( ber, &len );
586 case 'T': /* skip tag of next item */
587 t = va_arg( ap, ber_tag_t * );
588 *t = rc = ber_skip_tag( ber, &len );
591 case 'v': /* sequence of strings */
592 sss = va_arg( ap, char *** );
595 for ( tag = ber_first_element( ber, &len, &last );
596 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
597 tag = ber_next_element( ber, &len, last ) )
599 *sss = (char **) LBER_REALLOC( *sss,
600 (j + 2) * sizeof(char *) );
602 rc = ber_get_stringa( ber, &((*sss)[j]) );
609 case 'V': /* sequence of strings + lengths */
610 bv = va_arg( ap, struct berval *** );
613 for ( tag = ber_first_element( ber, &len, &last );
614 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
615 tag = ber_next_element( ber, &len, last ) )
617 *bv = (struct berval **) LBER_REALLOC( *bv,
618 (j + 2) * sizeof(struct berval *) );
620 rc = ber_get_stringal( ber, &((*bv)[j]) );
627 case 'x': /* skip the next element - whatever it is */
628 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
633 case '{': /* begin sequence */
634 case '[': /* begin set */
635 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
636 rc = ber_skip_tag( ber, &len );
639 case '}': /* end sequence */
640 case ']': /* end set */
644 if( ber->ber_debug ) {
645 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
646 "ber_scanf: unknown fmt %c\n", *fmt );
655 if ( rc == LBER_DEFAULT ) {
657 * Error. Reclaim malloced memory that was given to the caller.
658 * Set allocated pointers to NULL, "data length" outvalues to 0.
662 for ( ; fmt_reset < fmt; fmt_reset++ ) {
663 switch ( *fmt_reset ) {
664 case '!': { /* Hook */
665 BERDecodeCallback *f;
668 f = va_arg( ap, BERDecodeCallback * );
669 p = va_arg( ap, void * );
671 (void) (*f)( ber, p, 1 );
674 case 'a': /* octet string - allocate storage as needed */
675 ss = va_arg( ap, char ** );
682 case 'b': /* boolean */
683 case 'e': /* enumerated */
685 (void) va_arg( ap, int * );
688 case 's': /* octet string - in a buffer */
689 (void) va_arg( ap, char * );
690 (void) va_arg( ap, ber_len_t * );
693 case 'l': /* length of next item */
694 (void) va_arg( ap, ber_len_t * );
697 case 't': /* tag of next item */
698 case 'T': /* skip tag of next item */
699 (void) va_arg( ap, ber_tag_t * );
702 case 'o': /* octet string in a supplied berval */
703 bval = va_arg( ap, struct berval * );
704 if ( bval->bv_val != NULL ) {
705 LBER_FREE( bval->bv_val );
711 case 'O': /* octet string - allocate & include length */
712 bvp = va_arg( ap, struct berval ** );
719 case 'B': /* bit string - allocate storage as needed */
720 ss = va_arg( ap, char ** );
725 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
728 case 'v': /* sequence of strings */
729 sss = va_arg( ap, char *** );
731 for (j = 0; (*sss)[j]; j++) {
732 LBER_FREE( (*sss)[j] );
740 case 'V': /* sequence of strings + lengths */
741 bv = va_arg( ap, struct berval *** );
749 case 'x': /* skip the next element - whatever it is */
750 case '{': /* begin sequence */
751 case '[': /* begin set */
752 case '}': /* end sequence */
753 case ']': /* end set */
757 /* format should be good */
769 #ifdef STR_TRANSLATION
771 ber_set_string_translators( BerElement *ber, BERTranslateProc encode_proc,
772 BERTranslateProc decode_proc )
774 assert( ber != NULL );
775 assert( BER_VALID( ber ) );
777 ber->ber_encode_translate_proc = encode_proc;
778 ber->ber_decode_translate_proc = decode_proc;
780 #endif /* STR_TRANSLATION */