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 )
83 unsigned char netlen[sizeof(ber_len_t)];
85 assert( ber != NULL );
86 assert( len != NULL );
87 assert( BER_VALID( ber ) );
90 * Any ber element looks like this: tag length contents.
91 * Assuming everything's ok, we return the tag byte (we
92 * can assume a single byte), and return the length in len.
96 * 2) primitive encodings used whenever possible
102 * First, we read the tag.
105 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT )
106 return( LBER_DEFAULT );
109 * Next, read the length. The first byte contains the length of
110 * the length. If bit 8 is set, the length is the long form,
111 * otherwise it's the short form. We don't allow a length that's
112 * greater than what we can hold in a ber_len_t.
115 if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
116 return( LBER_DEFAULT );
119 noctets = (lc & 0x7fU);
121 if ( noctets > sizeof(ber_len_t) ) {
122 return( LBER_DEFAULT );
125 if( (unsigned) ber_read( ber, netlen, noctets ) != noctets ) {
126 return( LBER_DEFAULT );
129 for( i = 0; i < noctets; i++ ) {
149 assert( ber_in != NULL );
150 assert( BER_VALID( ber_in ) );
154 ber = ber_dup( ber_in );
160 assert( BER_VALID( ber ) );
162 tag = ber_skip_tag( ber, len );
174 unsigned char buf[sizeof(ber_int_t)];
176 assert( ber != NULL );
177 assert( num != NULL );
179 assert( BER_VALID( ber ) );
182 * The tag and length have already been stripped off. We should
183 * be sitting right before len bytes of 2's complement integer,
184 * ready to be read straight into an int. We may have to sign
185 * extend after we read it in.
188 if ( len > sizeof(ber_int_t) )
191 /* read into the low-order bytes of our buffer */
192 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
197 /* sign extend if necessary */
199 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
201 /* shift in the bytes */
202 for( i=0 ; i<len; i++ ) {
203 netnum = (netnum << 8 ) | buf[i];
223 assert( ber != NULL );
224 assert( BER_VALID( ber ) );
226 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
227 return( LBER_DEFAULT );
229 if ( ber_getnint( ber, num, len ) != len )
230 return( LBER_DEFAULT );
244 #ifdef STR_TRANSLATION
246 #endif /* STR_TRANSLATION */
248 assert( ber != NULL );
249 assert( BER_VALID( ber ) );
251 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
252 return( LBER_DEFAULT );
253 if ( datalen > (*len - 1) )
254 return( LBER_DEFAULT );
256 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen )
257 return( LBER_DEFAULT );
261 #ifdef STR_TRANSLATION
262 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
263 && ber->ber_decode_translate_proc ) {
266 if ( (*(ber->ber_decode_translate_proc))( &transbuf, &datalen,
268 return( LBER_DEFAULT );
270 if ( datalen > *len ) {
271 LBER_FREE( transbuf );
272 return( LBER_DEFAULT );
274 SAFEMEMCPY( buf, transbuf, datalen );
275 LBER_FREE( transbuf );
278 #endif /* STR_TRANSLATION */
285 ber_get_stringa( BerElement *ber, char **buf )
290 assert( ber != NULL );
291 assert( buf != NULL );
293 assert( BER_VALID( ber ) );
295 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
297 return( LBER_DEFAULT );
300 if ( (*buf = (char *) LBER_MALLOC( datalen + 1 )) == NULL )
301 return( LBER_DEFAULT );
303 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
306 return( LBER_DEFAULT );
308 (*buf)[datalen] = '\0';
310 #ifdef STR_TRANSLATION
311 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
312 && ber->ber_decode_translate_proc ) {
314 if ( (*(ber->ber_decode_translate_proc))( buf, &datalen, 1 )
318 return( LBER_DEFAULT );
321 #endif /* STR_TRANSLATION */
327 ber_get_stringal( BerElement *ber, struct berval **bv )
332 assert( ber != NULL );
333 assert( bv != NULL );
335 assert( BER_VALID( ber ) );
337 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
339 return( LBER_DEFAULT );
342 if ( (*bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) )) == NULL )
343 return( LBER_DEFAULT );
345 if ( ((*bv)->bv_val = (char *) LBER_MALLOC( len + 1 )) == NULL ) {
348 return( LBER_DEFAULT );
351 if ( (ber_len_t) ber_read( ber, (*bv)->bv_val, len ) != len ) {
354 return( LBER_DEFAULT );
356 ((*bv)->bv_val)[len] = '\0';
359 #ifdef STR_TRANSLATION
360 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
361 && ber->ber_decode_translate_proc ) {
363 if ( (*(ber->ber_decode_translate_proc))( &((*bv)->bv_val),
367 return( LBER_DEFAULT );
369 (*bv)->bv_len = len - 1;
371 #endif /* STR_TRANSLATION */
384 unsigned char unusedbits;
386 assert( ber != NULL );
387 assert( buf != NULL );
388 assert( blen != NULL );
390 assert( BER_VALID( ber ) );
392 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
394 return( LBER_DEFAULT );
398 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL )
399 return( LBER_DEFAULT );
401 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
404 return( LBER_DEFAULT );
407 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
410 return( LBER_DEFAULT );
413 *blen = datalen * 8 - unusedbits;
418 ber_get_null( BerElement *ber )
423 assert( ber != NULL );
424 assert( BER_VALID( ber ) );
426 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
427 return( LBER_DEFAULT );
430 return( LBER_DEFAULT );
443 assert( ber != NULL );
444 assert( boolval != NULL );
446 assert( BER_VALID( ber ) );
448 rc = ber_get_int( ber, &longbool );
460 assert( ber != NULL );
461 assert( len != NULL );
462 assert( last != NULL );
464 /* skip the sequence header, use the len to mark where to stop */
465 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
467 return( LBER_DEFAULT );
470 *last = ber->ber_ptr + *len;
472 if ( *last == ber->ber_ptr ) {
473 return( LBER_DEFAULT );
476 return( ber_peek_tag( ber, len ) );
483 LDAP_CONST char *last )
485 assert( ber != NULL );
486 assert( len != NULL );
487 assert( last != NULL );
489 assert( BER_VALID( ber ) );
491 if ( ber->ber_ptr == last ) {
492 return( LBER_DEFAULT );
495 return( ber_peek_tag( ber, len ) );
500 ber_scanf ( BerElement *ber,
501 LDAP_CONST char *fmt,
505 LDAP_CONST char *fmt_reset;
507 char *s, **ss, ***sss;
508 struct berval ***bv, **bvp, *bval;
518 assert( ber != NULL );
519 assert( fmt != NULL );
521 assert( BER_VALID( ber ) );
525 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
526 "ber_scanf fmt (%s) ber:\n", fmt );
527 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
529 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
530 /* When this is modified, remember to update
531 * the error-cleanup code below accordingly. */
533 case '!': { /* Hook */
534 BERDecodeCallback *f;
537 f = va_arg( ap, BERDecodeCallback * );
538 p = va_arg( ap, void * );
540 rc = (*f)( ber, p, 0 );
543 case 'a': /* octet string - allocate storage as needed */
544 ss = va_arg( ap, char ** );
545 rc = ber_get_stringa( ber, ss );
548 case 'b': /* boolean */
549 i = va_arg( ap, ber_int_t * );
550 rc = ber_get_boolean( ber, i );
553 case 'e': /* enumerated */
555 i = va_arg( ap, ber_int_t * );
556 rc = ber_get_int( ber, i );
559 case 'l': /* length of next item */
560 l = va_arg( ap, ber_len_t * );
561 rc = ber_peek_tag( ber, l );
565 rc = ber_get_null( ber );
568 case 's': /* octet string - in a buffer */
569 s = va_arg( ap, char * );
570 l = va_arg( ap, ber_len_t * );
571 rc = ber_get_stringb( ber, s, l );
574 case 'o': /* octet string in a supplied berval */
575 bval = va_arg( ap, struct berval * );
576 ber_peek_tag( ber, &bval->bv_len );
577 rc = ber_get_stringa( ber, &bval->bv_val );
580 case 'O': /* octet string - allocate & include length */
581 bvp = va_arg( ap, struct berval ** );
582 rc = ber_get_stringal( ber, bvp );
585 case 'B': /* bit string - allocate storage as needed */
586 ss = va_arg( ap, char ** );
587 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
588 rc = ber_get_bitstringa( ber, ss, l );
591 case 't': /* tag of next item */
592 t = va_arg( ap, ber_tag_t * );
593 *t = rc = ber_peek_tag( ber, &len );
596 case 'T': /* skip tag of next item */
597 t = va_arg( ap, ber_tag_t * );
598 *t = rc = ber_skip_tag( ber, &len );
601 case 'v': /* sequence of strings */
602 sss = va_arg( ap, char *** );
605 for ( tag = ber_first_element( ber, &len, &last );
606 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
607 tag = ber_next_element( ber, &len, last ) )
609 *sss = (char **) LBER_REALLOC( *sss,
610 (j + 2) * sizeof(char *) );
612 rc = ber_get_stringa( ber, &((*sss)[j]) );
619 case 'V': /* sequence of strings + lengths */
620 bv = va_arg( ap, struct berval *** );
623 for ( tag = ber_first_element( ber, &len, &last );
624 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
625 tag = ber_next_element( ber, &len, last ) )
627 *bv = (struct berval **) LBER_REALLOC( *bv,
628 (j + 2) * sizeof(struct berval *) );
630 rc = ber_get_stringal( ber, &((*bv)[j]) );
637 case 'x': /* skip the next element - whatever it is */
638 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
643 case '{': /* begin sequence */
644 case '[': /* begin set */
645 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
646 rc = ber_skip_tag( ber, &len );
649 case '}': /* end sequence */
650 case ']': /* end set */
654 if( ber->ber_debug ) {
655 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
656 "ber_scanf: unknown fmt %c\n", *fmt );
665 if ( rc == LBER_DEFAULT ) {
667 * Error. Reclaim malloced memory that was given to the caller.
668 * Set allocated pointers to NULL, "data length" outvalues to 0.
672 for ( ; fmt_reset < fmt; fmt_reset++ ) {
673 switch ( *fmt_reset ) {
674 case '!': { /* Hook */
675 BERDecodeCallback *f;
678 f = va_arg( ap, BERDecodeCallback * );
679 p = va_arg( ap, void * );
681 (void) (*f)( ber, p, 1 );
684 case 'a': /* octet string - allocate storage as needed */
685 ss = va_arg( ap, char ** );
692 case 'b': /* boolean */
693 case 'e': /* enumerated */
695 (void) va_arg( ap, int * );
698 case 's': /* octet string - in a buffer */
699 (void) va_arg( ap, char * );
700 (void) va_arg( ap, ber_len_t * );
703 case 'l': /* length of next item */
704 (void) va_arg( ap, ber_len_t * );
707 case 't': /* tag of next item */
708 case 'T': /* skip tag of next item */
709 (void) va_arg( ap, ber_tag_t * );
712 case 'o': /* octet string in a supplied berval */
713 bval = va_arg( ap, struct berval * );
714 if ( bval->bv_val != NULL ) {
715 LBER_FREE( bval->bv_val );
721 case 'O': /* octet string - allocate & include length */
722 bvp = va_arg( ap, struct berval ** );
729 case 'B': /* bit string - allocate storage as needed */
730 ss = va_arg( ap, char ** );
735 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
738 case 'v': /* sequence of strings */
739 sss = va_arg( ap, char *** );
741 for (j = 0; (*sss)[j]; j++) {
742 LBER_FREE( (*sss)[j] );
750 case 'V': /* sequence of strings + lengths */
751 bv = va_arg( ap, struct berval *** );
759 case 'x': /* skip the next element - whatever it is */
760 case '{': /* begin sequence */
761 case '[': /* begin set */
762 case '}': /* end sequence */
763 case ']': /* end set */
767 /* format should be good */
779 #ifdef STR_TRANSLATION
781 ber_set_string_translators( BerElement *ber, BERTranslateProc encode_proc,
782 BERTranslateProc decode_proc )
784 assert( ber != NULL );
785 assert( BER_VALID( ber ) );
787 ber->ber_encode_translate_proc = encode_proc;
788 ber->ber_decode_translate_proc = decode_proc;
790 #endif /* STR_TRANSLATION */