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 );
142 assert( ber_in != NULL );
143 assert( BER_VALID( ber_in ) );
148 tag = ber_skip_tag( ber, len );
162 unsigned char buf[sizeof(ber_int_t)];
164 assert( ber != NULL );
165 assert( num != NULL );
167 assert( BER_VALID( ber ) );
170 * The tag and length have already been stripped off. We should
171 * be sitting right before len bytes of 2's complement integer,
172 * ready to be read straight into an int. We may have to sign
173 * extend after we read it in.
176 if ( len > sizeof(ber_int_t) )
179 /* read into the low-order bytes of our buffer */
180 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
185 /* sign extend if necessary */
187 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
189 /* shift in the bytes */
190 for( i=0 ; i<len; i++ ) {
191 netnum = (netnum << 8 ) | buf[i];
211 assert( ber != NULL );
212 assert( BER_VALID( ber ) );
214 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
215 return( LBER_DEFAULT );
217 if ( ber_getnint( ber, num, len ) != len )
218 return( LBER_DEFAULT );
232 #ifdef STR_TRANSLATION
234 #endif /* STR_TRANSLATION */
236 assert( ber != NULL );
237 assert( BER_VALID( ber ) );
239 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
240 return( LBER_DEFAULT );
241 if ( datalen > (*len - 1) )
242 return( LBER_DEFAULT );
244 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen )
245 return( LBER_DEFAULT );
249 #ifdef STR_TRANSLATION
250 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
251 && ber->ber_decode_translate_proc ) {
254 if ( (*(ber->ber_decode_translate_proc))( &transbuf, &datalen,
256 return( LBER_DEFAULT );
258 if ( datalen > *len ) {
259 LBER_FREE( transbuf );
260 return( LBER_DEFAULT );
262 SAFEMEMCPY( buf, transbuf, datalen );
263 LBER_FREE( transbuf );
266 #endif /* STR_TRANSLATION */
273 ber_get_stringa( BerElement *ber, char **buf )
278 assert( ber != NULL );
279 assert( buf != NULL );
281 assert( BER_VALID( ber ) );
283 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
285 return( LBER_DEFAULT );
288 if ( (*buf = (char *) LBER_MALLOC( datalen + 1 )) == NULL )
289 return( LBER_DEFAULT );
291 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
294 return( LBER_DEFAULT );
296 (*buf)[datalen] = '\0';
298 #ifdef STR_TRANSLATION
299 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
300 && ber->ber_decode_translate_proc ) {
302 if ( (*(ber->ber_decode_translate_proc))( buf, &datalen, 1 )
306 return( LBER_DEFAULT );
309 #endif /* STR_TRANSLATION */
315 ber_get_stringal( BerElement *ber, struct berval **bv )
320 assert( ber != NULL );
321 assert( bv != NULL );
323 assert( BER_VALID( ber ) );
325 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
327 return( LBER_DEFAULT );
330 if ( (*bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) )) == NULL )
331 return( LBER_DEFAULT );
333 if ( ((*bv)->bv_val = (char *) LBER_MALLOC( len + 1 )) == NULL ) {
336 return( LBER_DEFAULT );
339 if ( (ber_len_t) ber_read( ber, (*bv)->bv_val, len ) != len ) {
342 return( LBER_DEFAULT );
344 ((*bv)->bv_val)[len] = '\0';
347 #ifdef STR_TRANSLATION
348 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
349 && ber->ber_decode_translate_proc ) {
351 if ( (*(ber->ber_decode_translate_proc))( &((*bv)->bv_val),
355 return( LBER_DEFAULT );
357 (*bv)->bv_len = len - 1;
359 #endif /* STR_TRANSLATION */
372 unsigned char unusedbits;
374 assert( ber != NULL );
375 assert( buf != NULL );
376 assert( blen != NULL );
378 assert( BER_VALID( ber ) );
380 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
382 return( LBER_DEFAULT );
386 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL )
387 return( LBER_DEFAULT );
389 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
392 return( LBER_DEFAULT );
395 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
398 return( LBER_DEFAULT );
401 *blen = datalen * 8 - unusedbits;
406 ber_get_null( BerElement *ber )
411 assert( ber != NULL );
412 assert( BER_VALID( ber ) );
414 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
415 return( LBER_DEFAULT );
418 return( LBER_DEFAULT );
431 assert( ber != NULL );
432 assert( boolval != NULL );
434 assert( BER_VALID( ber ) );
436 rc = ber_get_int( ber, &longbool );
448 assert( ber != NULL );
449 assert( len != NULL );
450 assert( last != NULL );
452 /* skip the sequence header, use the len to mark where to stop */
453 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
454 return( LBER_ERROR );
457 *last = ber->ber_ptr + *len;
459 if ( *last == ber->ber_ptr ) {
460 return( LBER_DEFAULT );
463 return( ber_peek_tag( ber, len ) );
470 LDAP_CONST char *last )
472 assert( ber != NULL );
473 assert( len != NULL );
474 assert( last != NULL );
476 assert( BER_VALID( ber ) );
478 if ( ber->ber_ptr == last ) {
479 /* set last to NULL on end of SEQUENCE */
480 return( LBER_DEFAULT );
483 return( ber_peek_tag( ber, len ) );
488 ber_scanf ( BerElement *ber,
489 LDAP_CONST char *fmt,
493 LDAP_CONST char *fmt_reset;
495 char *s, **ss, ***sss;
496 struct berval ***bv, **bvp, *bval;
506 assert( ber != NULL );
507 assert( fmt != NULL );
509 assert( BER_VALID( ber ) );
513 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
514 "ber_scanf fmt (%s) ber:\n", fmt );
515 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
517 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
518 /* When this is modified, remember to update
519 * the error-cleanup code below accordingly. */
521 case '!': { /* Hook */
522 BERDecodeCallback *f;
525 f = va_arg( ap, BERDecodeCallback * );
526 p = va_arg( ap, void * );
528 rc = (*f)( ber, p, 0 );
531 case 'a': /* octet string - allocate storage as needed */
532 ss = va_arg( ap, char ** );
533 rc = ber_get_stringa( ber, ss );
536 case 'b': /* boolean */
537 i = va_arg( ap, ber_int_t * );
538 rc = ber_get_boolean( ber, i );
541 case 'e': /* enumerated */
543 i = va_arg( ap, ber_int_t * );
544 rc = ber_get_int( ber, i );
547 case 'l': /* length of next item */
548 l = va_arg( ap, ber_len_t * );
549 rc = ber_peek_tag( ber, l );
553 rc = ber_get_null( ber );
556 case 's': /* octet string - in a buffer */
557 s = va_arg( ap, char * );
558 l = va_arg( ap, ber_len_t * );
559 rc = ber_get_stringb( ber, s, l );
562 case 'o': /* octet string in a supplied berval */
563 bval = va_arg( ap, struct berval * );
564 ber_peek_tag( ber, &bval->bv_len );
565 rc = ber_get_stringa( ber, &bval->bv_val );
568 case 'O': /* octet string - allocate & include length */
569 bvp = va_arg( ap, struct berval ** );
570 rc = ber_get_stringal( ber, bvp );
573 case 'B': /* bit string - allocate storage as needed */
574 ss = va_arg( ap, char ** );
575 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
576 rc = ber_get_bitstringa( ber, ss, l );
579 case 't': /* tag of next item */
580 t = va_arg( ap, ber_tag_t * );
581 *t = rc = ber_peek_tag( ber, &len );
584 case 'T': /* skip tag of next item */
585 t = va_arg( ap, ber_tag_t * );
586 *t = rc = ber_skip_tag( ber, &len );
589 case 'v': /* sequence of strings */
590 sss = va_arg( ap, char *** );
593 for ( tag = ber_first_element( ber, &len, &last );
594 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
595 tag = ber_next_element( ber, &len, last ) )
597 *sss = (char **) LBER_REALLOC( *sss,
598 (j + 2) * sizeof(char *) );
600 rc = ber_get_stringa( ber, &((*sss)[j]) );
607 case 'V': /* sequence of strings + lengths */
608 bv = va_arg( ap, struct berval *** );
611 for ( tag = ber_first_element( ber, &len, &last );
612 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
613 tag = ber_next_element( ber, &len, last ) )
615 *bv = (struct berval **) LBER_REALLOC( *bv,
616 (j + 2) * sizeof(struct berval *) );
618 rc = ber_get_stringal( ber, &((*bv)[j]) );
625 case 'x': /* skip the next element - whatever it is */
626 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
631 case '{': /* begin sequence */
632 case '[': /* begin set */
633 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
634 rc = ber_skip_tag( ber, &len );
637 case '}': /* end sequence */
638 case ']': /* end set */
642 if( ber->ber_debug ) {
643 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
644 "ber_scanf: unknown fmt %c\n", *fmt );
653 if ( rc == LBER_DEFAULT ) {
655 * Error. Reclaim malloced memory that was given to the caller.
656 * Set allocated pointers to NULL, "data length" outvalues to 0.
660 for ( ; fmt_reset < fmt; fmt_reset++ ) {
661 switch ( *fmt_reset ) {
662 case '!': { /* Hook */
663 BERDecodeCallback *f;
666 f = va_arg( ap, BERDecodeCallback * );
667 p = va_arg( ap, void * );
669 (void) (*f)( ber, p, 1 );
672 case 'a': /* octet string - allocate storage as needed */
673 ss = va_arg( ap, char ** );
680 case 'b': /* boolean */
681 case 'e': /* enumerated */
683 (void) va_arg( ap, int * );
686 case 's': /* octet string - in a buffer */
687 (void) va_arg( ap, char * );
688 (void) va_arg( ap, ber_len_t * );
691 case 'l': /* length of next item */
692 (void) va_arg( ap, ber_len_t * );
695 case 't': /* tag of next item */
696 case 'T': /* skip tag of next item */
697 (void) va_arg( ap, ber_tag_t * );
700 case 'o': /* octet string in a supplied berval */
701 bval = va_arg( ap, struct berval * );
702 if ( bval->bv_val != NULL ) {
703 LBER_FREE( bval->bv_val );
709 case 'O': /* octet string - allocate & include length */
710 bvp = va_arg( ap, struct berval ** );
717 case 'B': /* bit string - allocate storage as needed */
718 ss = va_arg( ap, char ** );
723 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
726 case 'v': /* sequence of strings */
727 sss = va_arg( ap, char *** );
729 for (j = 0; (*sss)[j]; j++) {
730 LBER_FREE( (*sss)[j] );
738 case 'V': /* sequence of strings + lengths */
739 bv = va_arg( ap, struct berval *** );
747 case 'x': /* skip the next element - whatever it is */
748 case '{': /* begin sequence */
749 case '[': /* begin set */
750 case '}': /* end sequence */
751 case ']': /* end set */
755 /* format should be good */
767 #ifdef STR_TRANSLATION
769 ber_set_string_translators( BerElement *ber, BERTranslateProc encode_proc,
770 BERTranslateProc decode_proc )
772 assert( ber != NULL );
773 assert( BER_VALID( ber ) );
775 ber->ber_encode_translate_proc = encode_proc;
776 ber->ber_decode_translate_proc = decode_proc;
778 #endif /* STR_TRANSLATION */