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>
31 static ber_len_t ber_getnint LDAP_P((
36 /* return the tag - LBER_DEFAULT returned means trouble */
38 ber_get_tag( BerElement *ber )
45 assert( ber != NULL );
46 assert( BER_VALID( ber ) );
48 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
49 return( LBER_DEFAULT );
51 if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
52 return( (ber_tag_t) xbyte );
56 for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
57 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
58 return( LBER_DEFAULT );
62 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
67 if ( i == sizeof(ber_tag_t) )
68 return( LBER_DEFAULT );
70 /* want leading, not trailing 0's */
71 return( tag >> (sizeof(ber_tag_t) - i - 1) );
75 ber_skip_tag( BerElement *ber, ber_len_t *len )
80 unsigned char netlen[sizeof(ber_len_t)];
82 assert( ber != NULL );
83 assert( len != NULL );
84 assert( BER_VALID( ber ) );
87 * Any ber element looks like this: tag length contents.
88 * Assuming everything's ok, we return the tag byte (we
89 * can assume a single byte), and return the length in len.
93 * 2) primitive encodings used whenever possible
99 * First, we read the tag.
102 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT )
103 return( LBER_DEFAULT );
106 * Next, read the length. The first byte contains the length of
107 * the length. If bit 8 is set, the length is the long form,
108 * otherwise it's the short form. We don't allow a length that's
109 * greater than what we can hold in a ber_len_t.
112 if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
113 return( LBER_DEFAULT );
116 noctets = (lc & 0x7fU);
118 if ( noctets > sizeof(ber_len_t) ) {
119 return( LBER_DEFAULT );
122 if( (unsigned) ber_read( ber, netlen, noctets ) != noctets ) {
123 return( LBER_DEFAULT );
126 for( i = 0; i < noctets; i++ ) {
146 assert( ber_in != NULL );
147 assert( BER_VALID( ber_in ) );
151 ber = ber_dup( ber_in );
157 assert( BER_VALID( ber ) );
159 tag = ber_skip_tag( ber, len );
171 unsigned char buf[sizeof(ber_int_t)];
173 assert( ber != NULL );
174 assert( num != NULL );
176 assert( BER_VALID( ber ) );
179 * The tag and length have already been stripped off. We should
180 * be sitting right before len bytes of 2's complement integer,
181 * ready to be read straight into an int. We may have to sign
182 * extend after we read it in.
185 if ( len > sizeof(ber_int_t) )
188 /* read into the low-order bytes of our buffer */
189 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
194 /* sign extend if necessary */
196 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
198 /* shift in the bytes */
199 for( i=0 ; i<len; i++ ) {
200 netnum = (netnum << 8 ) | buf[i];
220 assert( ber != NULL );
221 assert( BER_VALID( ber ) );
223 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
224 return( LBER_DEFAULT );
226 if ( ber_getnint( ber, num, len ) != len )
227 return( LBER_DEFAULT );
241 #ifdef STR_TRANSLATION
243 #endif /* STR_TRANSLATION */
245 assert( ber != NULL );
246 assert( BER_VALID( ber ) );
248 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
249 return( LBER_DEFAULT );
250 if ( datalen > (*len - 1) )
251 return( LBER_DEFAULT );
253 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen )
254 return( LBER_DEFAULT );
258 #ifdef STR_TRANSLATION
259 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
260 && ber->ber_decode_translate_proc ) {
263 if ( (*(ber->ber_decode_translate_proc))( &transbuf, &datalen,
265 return( LBER_DEFAULT );
267 if ( datalen > *len ) {
268 LBER_FREE( transbuf );
269 return( LBER_DEFAULT );
271 SAFEMEMCPY( buf, transbuf, datalen );
272 LBER_FREE( transbuf );
275 #endif /* STR_TRANSLATION */
282 ber_get_stringa( BerElement *ber, char **buf )
287 assert( ber != NULL );
288 assert( buf != NULL );
290 assert( BER_VALID( ber ) );
292 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
294 return( LBER_DEFAULT );
297 if ( (*buf = (char *) LBER_MALLOC( datalen + 1 )) == NULL )
298 return( LBER_DEFAULT );
300 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
303 return( LBER_DEFAULT );
305 (*buf)[datalen] = '\0';
307 #ifdef STR_TRANSLATION
308 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
309 && ber->ber_decode_translate_proc ) {
311 if ( (*(ber->ber_decode_translate_proc))( buf, &datalen, 1 )
315 return( LBER_DEFAULT );
318 #endif /* STR_TRANSLATION */
324 ber_get_stringal( BerElement *ber, struct berval **bv )
329 assert( ber != NULL );
330 assert( bv != NULL );
332 assert( BER_VALID( ber ) );
334 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
336 return( LBER_DEFAULT );
339 if ( (*bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) )) == NULL )
340 return( LBER_DEFAULT );
342 if ( ((*bv)->bv_val = (char *) LBER_MALLOC( len + 1 )) == NULL ) {
345 return( LBER_DEFAULT );
348 if ( (ber_len_t) ber_read( ber, (*bv)->bv_val, len ) != len ) {
351 return( LBER_DEFAULT );
353 ((*bv)->bv_val)[len] = '\0';
356 #ifdef STR_TRANSLATION
357 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
358 && ber->ber_decode_translate_proc ) {
360 if ( (*(ber->ber_decode_translate_proc))( &((*bv)->bv_val),
364 return( LBER_DEFAULT );
366 (*bv)->bv_len = len - 1;
368 #endif /* STR_TRANSLATION */
381 unsigned char unusedbits;
383 assert( ber != NULL );
384 assert( buf != NULL );
385 assert( blen != NULL );
387 assert( BER_VALID( ber ) );
389 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
391 return( LBER_DEFAULT );
395 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL )
396 return( LBER_DEFAULT );
398 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
401 return( LBER_DEFAULT );
404 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
407 return( LBER_DEFAULT );
410 *blen = datalen * 8 - unusedbits;
415 ber_get_null( BerElement *ber )
420 assert( ber != NULL );
421 assert( BER_VALID( ber ) );
423 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
424 return( LBER_DEFAULT );
427 return( LBER_DEFAULT );
440 assert( ber != NULL );
441 assert( boolval != NULL );
443 assert( BER_VALID( ber ) );
445 rc = ber_get_int( ber, &longbool );
457 assert( ber != NULL );
458 assert( len != NULL );
459 assert( last != NULL );
461 /* skip the sequence header, use the len to mark where to stop */
462 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
464 return( LBER_DEFAULT );
467 *last = ber->ber_ptr + *len;
469 if ( *last == ber->ber_ptr ) {
470 return( LBER_DEFAULT );
473 return( ber_peek_tag( ber, len ) );
480 LDAP_CONST char *last )
482 assert( ber != NULL );
483 assert( len != NULL );
484 assert( last != NULL );
486 assert( BER_VALID( ber ) );
488 if ( ber->ber_ptr == last ) {
489 return( LBER_DEFAULT );
492 return( ber_peek_tag( ber, len ) );
497 ber_scanf ( BerElement *ber,
498 LDAP_CONST char *fmt,
502 LDAP_CONST char *fmt_reset;
504 char *s, **ss, ***sss;
505 struct berval ***bv, **bvp, *bval;
515 assert( ber != NULL );
516 assert( fmt != NULL );
518 assert( BER_VALID( ber ) );
522 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
523 "ber_scanf fmt (%s) ber:\n", fmt );
524 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
526 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
527 /* When this is modified, remember to update
528 * the error-cleanup code below accordingly. */
530 case '!': { /* Hook */
531 BERDecodeCallback *f;
534 f = va_arg( ap, BERDecodeCallback * );
535 p = va_arg( ap, void * );
537 rc = (*f)( ber, p, 0 );
540 case 'a': /* octet string - allocate storage as needed */
541 ss = va_arg( ap, char ** );
542 rc = ber_get_stringa( ber, ss );
545 case 'b': /* boolean */
546 i = va_arg( ap, ber_int_t * );
547 rc = ber_get_boolean( ber, i );
550 case 'e': /* enumerated */
552 i = va_arg( ap, ber_int_t * );
553 rc = ber_get_int( ber, i );
556 case 'l': /* length of next item */
557 l = va_arg( ap, ber_len_t * );
558 rc = ber_peek_tag( ber, l );
562 rc = ber_get_null( ber );
565 case 's': /* octet string - in a buffer */
566 s = va_arg( ap, char * );
567 l = va_arg( ap, ber_len_t * );
568 rc = ber_get_stringb( ber, s, l );
571 case 'o': /* octet string in a supplied berval */
572 bval = va_arg( ap, struct berval * );
573 ber_peek_tag( ber, &bval->bv_len );
574 rc = ber_get_stringa( ber, &bval->bv_val );
577 case 'O': /* octet string - allocate & include length */
578 bvp = va_arg( ap, struct berval ** );
579 rc = ber_get_stringal( ber, bvp );
582 case 'B': /* bit string - allocate storage as needed */
583 ss = va_arg( ap, char ** );
584 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
585 rc = ber_get_bitstringa( ber, ss, l );
588 case 't': /* tag of next item */
589 t = va_arg( ap, ber_tag_t * );
590 *t = rc = ber_peek_tag( ber, &len );
593 case 'T': /* skip tag of next item */
594 t = va_arg( ap, ber_tag_t * );
595 *t = rc = ber_skip_tag( ber, &len );
598 case 'v': /* sequence of strings */
599 sss = va_arg( ap, char *** );
602 for ( tag = ber_first_element( ber, &len, &last );
603 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
604 tag = ber_next_element( ber, &len, last ) )
606 *sss = (char **) LBER_REALLOC( *sss,
607 (j + 2) * sizeof(char *) );
609 rc = ber_get_stringa( ber, &((*sss)[j]) );
616 case 'V': /* sequence of strings + lengths */
617 bv = va_arg( ap, struct berval *** );
620 for ( tag = ber_first_element( ber, &len, &last );
621 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
622 tag = ber_next_element( ber, &len, last ) )
624 *bv = (struct berval **) LBER_REALLOC( *bv,
625 (j + 2) * sizeof(struct berval *) );
627 rc = ber_get_stringal( ber, &((*bv)[j]) );
634 case 'x': /* skip the next element - whatever it is */
635 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
640 case '{': /* begin sequence */
641 case '[': /* begin set */
642 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
643 rc = ber_skip_tag( ber, &len );
646 case '}': /* end sequence */
647 case ']': /* end set */
651 if( ber->ber_debug ) {
652 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
653 "ber_scanf: unknown fmt %c\n", *fmt );
662 if ( rc == LBER_DEFAULT ) {
664 * Error. Reclaim malloced memory that was given to the caller.
665 * Set allocated pointers to NULL, "data length" outvalues to 0.
669 for ( ; fmt_reset < fmt; fmt_reset++ ) {
670 switch ( *fmt_reset ) {
671 case '!': { /* Hook */
672 BERDecodeCallback *f;
675 f = va_arg( ap, BERDecodeCallback * );
676 p = va_arg( ap, void * );
678 (void) (*f)( ber, p, 1 );
681 case 'a': /* octet string - allocate storage as needed */
682 ss = va_arg( ap, char ** );
689 case 'b': /* boolean */
690 case 'e': /* enumerated */
692 (void) va_arg( ap, int * );
695 case 's': /* octet string - in a buffer */
696 (void) va_arg( ap, char * );
697 (void) va_arg( ap, ber_len_t * );
700 case 'l': /* length of next item */
701 (void) va_arg( ap, ber_len_t * );
704 case 't': /* tag of next item */
705 case 'T': /* skip tag of next item */
706 (void) va_arg( ap, ber_tag_t * );
709 case 'o': /* octet string in a supplied berval */
710 bval = va_arg( ap, struct berval * );
711 if ( bval->bv_val != NULL ) {
712 LBER_FREE( bval->bv_val );
718 case 'O': /* octet string - allocate & include length */
719 bvp = va_arg( ap, struct berval ** );
726 case 'B': /* bit string - allocate storage as needed */
727 ss = va_arg( ap, char ** );
732 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
735 case 'v': /* sequence of strings */
736 sss = va_arg( ap, char *** );
738 for (j = 0; (*sss)[j]; j++) {
739 LBER_FREE( (*sss)[j] );
747 case 'V': /* sequence of strings + lengths */
748 bv = va_arg( ap, struct berval *** );
756 case 'x': /* skip the next element - whatever it is */
757 case '{': /* begin sequence */
758 case '[': /* begin set */
759 case '}': /* end sequence */
760 case ']': /* end set */
764 /* format should be good */
776 #ifdef STR_TRANSLATION
778 ber_set_string_translators( BerElement *ber, BERTranslateProc encode_proc,
779 BERTranslateProc decode_proc )
781 assert( ber != NULL );
782 assert( BER_VALID( ber ) );
784 ber->ber_encode_translate_proc = encode_proc;
785 ber->ber_decode_translate_proc = decode_proc;
787 #endif /* STR_TRANSLATION */