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
100 * First, we read the tag.
103 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT )
104 return( LBER_DEFAULT );
107 * Next, read the length. The first byte contains the length of
108 * the length. If bit 8 is set, the length is the long form,
109 * otherwise it's the short form. We don't allow a length that's
110 * 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 ) );
152 ber = ber_dup( ber_in );
158 assert( BER_VALID( ber ) );
160 tag = ber_skip_tag( ber, len );
172 unsigned char buf[sizeof(ber_int_t)];
174 assert( ber != NULL );
175 assert( num != NULL );
177 assert( BER_VALID( ber ) );
180 * The tag and length have already been stripped off. We should
181 * be sitting right before len bytes of 2's complement integer,
182 * ready to be read straight into an int. We may have to sign
183 * extend after we read it in.
186 if ( len > sizeof(ber_int_t) )
189 /* read into the low-order bytes of our buffer */
190 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
195 /* sign extend if necessary */
197 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
199 /* shift in the bytes */
200 for( i=0 ; i<len; i++ ) {
201 netnum = (netnum << 8 ) | buf[i];
221 assert( ber != NULL );
222 assert( BER_VALID( ber ) );
224 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
225 return( LBER_DEFAULT );
227 if ( ber_getnint( ber, num, len ) != len )
228 return( LBER_DEFAULT );
242 #ifdef STR_TRANSLATION
244 #endif /* STR_TRANSLATION */
246 assert( ber != NULL );
247 assert( BER_VALID( ber ) );
249 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
250 return( LBER_DEFAULT );
251 if ( datalen > (*len - 1) )
252 return( LBER_DEFAULT );
254 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen )
255 return( LBER_DEFAULT );
259 #ifdef STR_TRANSLATION
260 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
261 && ber->ber_decode_translate_proc ) {
264 if ( (*(ber->ber_decode_translate_proc))( &transbuf, &datalen,
266 return( LBER_DEFAULT );
268 if ( datalen > *len ) {
269 LBER_FREE( transbuf );
270 return( LBER_DEFAULT );
272 SAFEMEMCPY( buf, transbuf, datalen );
273 LBER_FREE( transbuf );
276 #endif /* STR_TRANSLATION */
283 ber_get_stringa( BerElement *ber, char **buf )
288 assert( ber != NULL );
289 assert( buf != NULL );
291 assert( BER_VALID( ber ) );
293 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
295 return( LBER_DEFAULT );
298 if ( (*buf = (char *) LBER_MALLOC( datalen + 1 )) == NULL )
299 return( LBER_DEFAULT );
301 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
304 return( LBER_DEFAULT );
306 (*buf)[datalen] = '\0';
308 #ifdef STR_TRANSLATION
309 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
310 && ber->ber_decode_translate_proc ) {
312 if ( (*(ber->ber_decode_translate_proc))( buf, &datalen, 1 )
316 return( LBER_DEFAULT );
319 #endif /* STR_TRANSLATION */
325 ber_get_stringal( BerElement *ber, struct berval **bv )
330 assert( ber != NULL );
331 assert( bv != NULL );
333 assert( BER_VALID( ber ) );
335 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
337 return( LBER_DEFAULT );
340 if ( (*bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) )) == NULL )
341 return( LBER_DEFAULT );
343 if ( ((*bv)->bv_val = (char *) LBER_MALLOC( len + 1 )) == NULL ) {
346 return( LBER_DEFAULT );
349 if ( (ber_len_t) ber_read( ber, (*bv)->bv_val, len ) != len ) {
352 return( LBER_DEFAULT );
354 ((*bv)->bv_val)[len] = '\0';
357 #ifdef STR_TRANSLATION
358 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
359 && ber->ber_decode_translate_proc ) {
361 if ( (*(ber->ber_decode_translate_proc))( &((*bv)->bv_val),
365 return( LBER_DEFAULT );
367 (*bv)->bv_len = len - 1;
369 #endif /* STR_TRANSLATION */
382 unsigned char unusedbits;
384 assert( ber != NULL );
385 assert( buf != NULL );
386 assert( blen != NULL );
388 assert( BER_VALID( ber ) );
390 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
392 return( LBER_DEFAULT );
396 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL )
397 return( LBER_DEFAULT );
399 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
402 return( LBER_DEFAULT );
405 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
408 return( LBER_DEFAULT );
411 *blen = datalen * 8 - unusedbits;
416 ber_get_null( BerElement *ber )
421 assert( ber != NULL );
422 assert( BER_VALID( ber ) );
424 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
425 return( LBER_DEFAULT );
428 return( LBER_DEFAULT );
441 assert( ber != NULL );
442 assert( boolval != NULL );
444 assert( BER_VALID( ber ) );
446 rc = ber_get_int( ber, &longbool );
458 assert( ber != NULL );
459 assert( len != NULL );
460 assert( last != NULL );
462 /* skip the sequence header, use the len to mark where to stop */
463 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
465 return( LBER_DEFAULT );
468 *last = ber->ber_ptr + *len;
470 if ( *last == ber->ber_ptr ) {
471 return( LBER_DEFAULT );
474 return( ber_peek_tag( ber, len ) );
481 LDAP_CONST char *last )
483 assert( ber != NULL );
484 assert( len != NULL );
485 assert( last != NULL );
487 assert( BER_VALID( ber ) );
489 if ( ber->ber_ptr == last ) {
490 return( LBER_DEFAULT );
493 return( ber_peek_tag( ber, len ) );
498 ber_scanf ( BerElement *ber,
499 LDAP_CONST char *fmt,
503 LDAP_CONST char *fmt_reset;
505 char *s, **ss, ***sss;
506 struct berval ***bv, **bvp, *bval;
516 assert( ber != NULL );
517 assert( fmt != NULL );
519 assert( BER_VALID( ber ) );
523 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
524 "ber_scanf fmt (%s) ber:\n", fmt );
525 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
527 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
528 /* When this is modified, remember to update
529 * the error-cleanup code below accordingly. */
531 case '!': { /* Hook */
532 BERDecodeCallback *f;
535 f = va_arg( ap, BERDecodeCallback * );
536 p = va_arg( ap, void * );
538 rc = (*f)( ber, p, 0 );
541 case 'a': /* octet string - allocate storage as needed */
542 ss = va_arg( ap, char ** );
543 rc = ber_get_stringa( ber, ss );
546 case 'b': /* boolean */
547 i = va_arg( ap, ber_int_t * );
548 rc = ber_get_boolean( ber, i );
551 case 'e': /* enumerated */
553 i = va_arg( ap, ber_int_t * );
554 rc = ber_get_int( ber, i );
557 case 'l': /* length of next item */
558 l = va_arg( ap, ber_len_t * );
559 rc = ber_peek_tag( ber, l );
563 rc = ber_get_null( ber );
566 case 's': /* octet string - in a buffer */
567 s = va_arg( ap, char * );
568 l = va_arg( ap, ber_len_t * );
569 rc = ber_get_stringb( ber, s, l );
572 case 'o': /* octet string in a supplied berval */
573 bval = va_arg( ap, struct berval * );
574 ber_peek_tag( ber, &bval->bv_len );
575 rc = ber_get_stringa( ber, &bval->bv_val );
578 case 'O': /* octet string - allocate & include length */
579 bvp = va_arg( ap, struct berval ** );
580 rc = ber_get_stringal( ber, bvp );
583 case 'B': /* bit string - allocate storage as needed */
584 ss = va_arg( ap, char ** );
585 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
586 rc = ber_get_bitstringa( ber, ss, l );
589 case 't': /* tag of next item */
590 t = va_arg( ap, ber_tag_t * );
591 *t = rc = ber_peek_tag( ber, &len );
594 case 'T': /* skip tag of next item */
595 t = va_arg( ap, ber_tag_t * );
596 *t = rc = ber_skip_tag( ber, &len );
599 case 'v': /* sequence of strings */
600 sss = va_arg( ap, char *** );
603 for ( tag = ber_first_element( ber, &len, &last );
604 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
605 tag = ber_next_element( ber, &len, last ) )
607 *sss = (char **) LBER_REALLOC( *sss,
608 (j + 2) * sizeof(char *) );
610 rc = ber_get_stringa( ber, &((*sss)[j]) );
617 case 'V': /* sequence of strings + lengths */
618 bv = va_arg( ap, struct berval *** );
621 for ( tag = ber_first_element( ber, &len, &last );
622 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
623 tag = ber_next_element( ber, &len, last ) )
625 *bv = (struct berval **) LBER_REALLOC( *bv,
626 (j + 2) * sizeof(struct berval *) );
628 rc = ber_get_stringal( ber, &((*bv)[j]) );
635 case 'x': /* skip the next element - whatever it is */
636 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
641 case '{': /* begin sequence */
642 case '[': /* begin set */
643 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
644 rc = ber_skip_tag( ber, &len );
647 case '}': /* end sequence */
648 case ']': /* end set */
652 if( ber->ber_debug ) {
653 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
654 "ber_scanf: unknown fmt %c\n", *fmt );
663 if ( rc == LBER_DEFAULT ) {
665 * Error. Reclaim malloced memory that was given to the caller.
666 * Set allocated pointers to NULL, "data length" outvalues to 0.
670 for ( ; fmt_reset < fmt; fmt_reset++ ) {
671 switch ( *fmt_reset ) {
672 case '!': { /* Hook */
673 BERDecodeCallback *f;
676 f = va_arg( ap, BERDecodeCallback * );
677 p = va_arg( ap, void * );
679 (void) (*f)( ber, p, 1 );
682 case 'a': /* octet string - allocate storage as needed */
683 ss = va_arg( ap, char ** );
690 case 'b': /* boolean */
691 case 'e': /* enumerated */
693 (void) va_arg( ap, int * );
696 case 's': /* octet string - in a buffer */
697 (void) va_arg( ap, char * );
698 (void) va_arg( ap, ber_len_t * );
701 case 'l': /* length of next item */
702 (void) va_arg( ap, ber_len_t * );
705 case 't': /* tag of next item */
706 case 'T': /* skip tag of next item */
707 (void) va_arg( ap, ber_tag_t * );
710 case 'o': /* octet string in a supplied berval */
711 bval = va_arg( ap, struct berval * );
712 if ( bval->bv_val != NULL ) {
713 LBER_FREE( bval->bv_val );
719 case 'O': /* octet string - allocate & include length */
720 bvp = va_arg( ap, struct berval ** );
727 case 'B': /* bit string - allocate storage as needed */
728 ss = va_arg( ap, char ** );
733 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
736 case 'v': /* sequence of strings */
737 sss = va_arg( ap, char *** );
739 for (j = 0; (*sss)[j]; j++) {
740 LBER_FREE( (*sss)[j] );
748 case 'V': /* sequence of strings + lengths */
749 bv = va_arg( ap, struct berval *** );
757 case 'x': /* skip the next element - whatever it is */
758 case '{': /* begin sequence */
759 case '[': /* begin set */
760 case '}': /* end sequence */
761 case ']': /* end set */
765 /* format should be good */
777 #ifdef STR_TRANSLATION
779 ber_set_string_translators( BerElement *ber, BERTranslateProc encode_proc,
780 BERTranslateProc decode_proc )
782 assert( ber != NULL );
783 assert( BER_VALID( ber ) );
785 ber->ber_encode_translate_proc = encode_proc;
786 ber->ber_decode_translate_proc = decode_proc;
788 #endif /* STR_TRANSLATION */