1 /* decode.c - ber input decoding routines */
3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1990 Regents of the University of Michigan.
10 * Redistribution and use in source and binary forms are permitted
11 * provided that this notice is preserved and that due credit is given
12 * to the University of Michigan at Ann Arbor. The name of the University
13 * may not be used to endorse or promote products derived from this
14 * software without specific prior written permission. This software
15 * is provided ``as is'' without express or implied warranty.
22 #include <ac/stdlib.h>
24 #include <ac/stdarg.h>
25 #include <ac/string.h>
26 #include <ac/socket.h>
29 #define LDAP_F_PRE LDAP_F_EXPORT
33 static ber_len_t ber_getnint LDAP_P((
38 /* return the tag - LBER_DEFAULT returned means trouble */
40 ber_get_tag( BerElement *ber )
47 assert( ber != NULL );
48 assert( BER_VALID( ber ) );
50 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
51 return( LBER_DEFAULT );
53 if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
54 return( (ber_tag_t) xbyte );
58 for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
59 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
60 return( LBER_DEFAULT );
64 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
69 if ( i == sizeof(ber_tag_t) )
70 return( LBER_DEFAULT );
72 /* want leading, not trailing 0's */
73 return( tag >> (sizeof(ber_tag_t) - i - 1) );
77 ber_skip_tag( BerElement *ber, ber_len_t *len )
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.
114 if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
115 return( LBER_DEFAULT );
117 noctets = (lc & 0x7fU);
118 if ( noctets > sizeof(ber_len_t) )
119 return( LBER_DEFAULT );
120 diff = sizeof(ber_len_t) - noctets;
121 if ( (unsigned) ber_read( ber, (char *) &netlen + diff, noctets )
123 return( LBER_DEFAULT );
124 *len = LBER_LEN_NTOH( netlen );
134 LDAP_CONST BerElement *ber_in,
140 assert( ber_in != NULL );
141 assert( BER_VALID( ber_in ) );
143 ber = ber_dup( ber_in );
149 assert( BER_VALID( ber ) );
151 tag = ber_skip_tag( ber, len );
163 unsigned char buf[sizeof(ber_int_t)];
165 assert( ber != NULL );
166 assert( num != NULL );
168 assert( BER_VALID( ber ) );
171 * The tag and length have already been stripped off. We should
172 * be sitting right before len bytes of 2's complement integer,
173 * ready to be read straight into an int. We may have to sign
174 * extend after we read it in.
177 if ( len > sizeof(ber_int_t) )
180 /* read into the low-order bytes of our buffer */
181 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
186 /* sign extend if necessary */
188 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
190 /* shift in the bytes */
191 for( i=0 ; i<len; i++ ) {
192 netnum = (netnum << 8 ) | buf[i];
212 assert( ber != NULL );
213 assert( BER_VALID( ber ) );
215 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
216 return( LBER_DEFAULT );
218 if ( ber_getnint( ber, num, len ) != len )
219 return( LBER_DEFAULT );
233 #ifdef STR_TRANSLATION
235 #endif /* STR_TRANSLATION */
237 assert( ber != NULL );
238 assert( BER_VALID( ber ) );
240 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
241 return( LBER_DEFAULT );
242 if ( datalen > (*len - 1) )
243 return( LBER_DEFAULT );
245 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen )
246 return( LBER_DEFAULT );
250 #ifdef STR_TRANSLATION
251 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
252 && ber->ber_decode_translate_proc ) {
255 if ( (*(ber->ber_decode_translate_proc))( &transbuf, &datalen,
257 return( LBER_DEFAULT );
259 if ( datalen > *len ) {
260 LBER_FREE( transbuf );
261 return( LBER_DEFAULT );
263 SAFEMEMCPY( buf, transbuf, datalen );
264 LBER_FREE( transbuf );
267 #endif /* STR_TRANSLATION */
274 ber_get_stringa( BerElement *ber, char **buf )
279 assert( ber != NULL );
280 assert( buf != NULL );
282 assert( BER_VALID( ber ) );
284 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
286 return( LBER_DEFAULT );
289 if ( (*buf = (char *) LBER_MALLOC( datalen + 1 )) == NULL )
290 return( LBER_DEFAULT );
292 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
295 return( LBER_DEFAULT );
297 (*buf)[datalen] = '\0';
299 #ifdef STR_TRANSLATION
300 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
301 && ber->ber_decode_translate_proc ) {
303 if ( (*(ber->ber_decode_translate_proc))( buf, &datalen, 1 )
307 return( LBER_DEFAULT );
310 #endif /* STR_TRANSLATION */
316 ber_get_stringal( BerElement *ber, struct berval **bv )
321 assert( ber != NULL );
322 assert( bv != NULL );
324 assert( BER_VALID( ber ) );
326 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
328 return( LBER_DEFAULT );
331 if ( (*bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) )) == NULL )
332 return( LBER_DEFAULT );
334 if ( ((*bv)->bv_val = (char *) LBER_MALLOC( len + 1 )) == NULL ) {
337 return( LBER_DEFAULT );
340 if ( (ber_len_t) ber_read( ber, (*bv)->bv_val, len ) != len ) {
343 return( LBER_DEFAULT );
345 ((*bv)->bv_val)[len] = '\0';
348 #ifdef STR_TRANSLATION
349 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
350 && ber->ber_decode_translate_proc ) {
352 if ( (*(ber->ber_decode_translate_proc))( &((*bv)->bv_val),
356 return( LBER_DEFAULT );
358 (*bv)->bv_len = len - 1;
360 #endif /* STR_TRANSLATION */
373 unsigned char unusedbits;
375 assert( ber != NULL );
376 assert( buf != NULL );
377 assert( blen != NULL );
379 assert( BER_VALID( ber ) );
381 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
383 return( LBER_DEFAULT );
387 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL )
388 return( LBER_DEFAULT );
390 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
393 return( LBER_DEFAULT );
396 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
399 return( LBER_DEFAULT );
402 *blen = datalen * 8 - unusedbits;
407 ber_get_null( BerElement *ber )
412 assert( ber != NULL );
413 assert( BER_VALID( ber ) );
415 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
416 return( LBER_DEFAULT );
419 return( LBER_DEFAULT );
432 assert( ber != NULL );
433 assert( boolval != NULL );
435 assert( BER_VALID( ber ) );
437 rc = ber_get_int( ber, &longbool );
449 assert( ber != NULL );
450 assert( len != NULL );
451 assert( last != NULL );
453 /* skip the sequence header, use the len to mark where to stop */
454 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
456 return( LBER_DEFAULT );
459 *last = ber->ber_ptr + *len;
461 if ( *last == ber->ber_ptr ) {
462 return( LBER_DEFAULT );
465 return( ber_peek_tag( ber, len ) );
474 assert( ber != NULL );
475 assert( len != NULL );
476 assert( last != NULL );
478 assert( BER_VALID( ber ) );
480 if ( ber->ber_ptr == last ) {
481 return( LBER_DEFAULT );
484 return( ber_peek_tag( ber, len ) );
489 ber_scanf ( BerElement *ber,
490 LDAP_CONST char *fmt,
494 LDAP_CONST char *fmt_reset;
496 char *s, **ss, ***sss;
497 struct berval ***bv, **bvp, *bval;
507 assert( ber != NULL );
508 assert( fmt != NULL );
510 assert( BER_VALID( ber ) );
514 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
515 "ber_scanf fmt (%s) ber:\n", fmt );
516 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
518 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
519 /* When this is modified, remember to update
520 * the error-cleanup code below accordingly. */
522 case '!': { /* Hook */
523 BERDecodeCallback *f;
526 f = va_arg( ap, BERDecodeCallback * );
527 p = va_arg( ap, void * );
529 rc = (*f)( ber, p, 0 );
532 case 'a': /* octet string - allocate storage as needed */
533 ss = va_arg( ap, char ** );
534 rc = ber_get_stringa( ber, ss );
537 case 'b': /* boolean */
538 i = va_arg( ap, ber_int_t * );
539 rc = ber_get_boolean( ber, i );
542 case 'e': /* enumerated */
544 i = va_arg( ap, ber_int_t * );
545 rc = ber_get_int( ber, i );
548 case 'l': /* length of next item */
549 l = va_arg( ap, ber_len_t * );
550 rc = ber_peek_tag( ber, l );
554 rc = ber_get_null( ber );
557 case 's': /* octet string - in a buffer */
558 s = va_arg( ap, char * );
559 l = va_arg( ap, ber_len_t * );
560 rc = ber_get_stringb( ber, s, l );
563 case 'o': /* octet string in a supplied berval */
564 bval = va_arg( ap, struct berval * );
565 ber_peek_tag( ber, &bval->bv_len );
566 rc = ber_get_stringa( ber, &bval->bv_val );
569 case 'O': /* octet string - allocate & include length */
570 bvp = va_arg( ap, struct berval ** );
571 rc = ber_get_stringal( ber, bvp );
574 case 'B': /* bit string - allocate storage as needed */
575 ss = va_arg( ap, char ** );
576 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
577 rc = ber_get_bitstringa( ber, ss, l );
580 case 't': /* tag of next item */
581 t = va_arg( ap, ber_tag_t * );
582 *t = rc = ber_peek_tag( ber, &len );
585 case 'T': /* skip tag of next item */
586 t = va_arg( ap, ber_tag_t * );
587 *t = rc = ber_skip_tag( ber, &len );
590 case 'v': /* sequence of strings */
591 sss = va_arg( ap, char *** );
594 for ( tag = ber_first_element( ber, &len, &last );
595 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
596 tag = ber_next_element( ber, &len, last ) )
598 *sss = (char **) LBER_REALLOC( *sss,
599 (j + 2) * sizeof(char *) );
601 rc = ber_get_stringa( ber, &((*sss)[j]) );
608 case 'V': /* sequence of strings + lengths */
609 bv = va_arg( ap, struct berval *** );
612 for ( tag = ber_first_element( ber, &len, &last );
613 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
614 tag = ber_next_element( ber, &len, last ) )
616 *bv = (struct berval **) LBER_REALLOC( *bv,
617 (j + 2) * sizeof(struct berval *) );
619 rc = ber_get_stringal( ber, &((*bv)[j]) );
626 case 'x': /* skip the next element - whatever it is */
627 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
632 case '{': /* begin sequence */
633 case '[': /* begin set */
634 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
635 rc = ber_skip_tag( ber, &len );
638 case '}': /* end sequence */
639 case ']': /* end set */
643 if( ber->ber_debug ) {
644 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
645 "ber_scanf: unknown fmt %c\n", *fmt );
654 if ( rc == LBER_DEFAULT ) {
656 * Error. Reclaim malloced memory that was given to the caller.
657 * Set allocated pointers to NULL, "data length" outvalues to 0.
661 for ( ; fmt_reset < fmt; fmt_reset++ ) {
662 switch ( *fmt_reset ) {
663 case '!': { /* Hook */
664 BERDecodeCallback *f;
667 f = va_arg( ap, BERDecodeCallback * );
668 p = va_arg( ap, void * );
670 (void) (*f)( ber, p, 1 );
673 case 'a': /* octet string - allocate storage as needed */
674 ss = va_arg( ap, char ** );
681 case 'b': /* boolean */
682 case 'e': /* enumerated */
684 (void) va_arg( ap, int * );
687 case 's': /* octet string - in a buffer */
688 (void) va_arg( ap, char * );
689 (void) va_arg( ap, ber_len_t * );
692 case 'l': /* length of next item */
693 (void) va_arg( ap, ber_len_t * );
696 case 't': /* tag of next item */
697 case 'T': /* skip tag of next item */
698 (void) va_arg( ap, ber_tag_t * );
701 case 'o': /* octet string in a supplied berval */
702 bval = va_arg( ap, struct berval * );
703 if ( bval->bv_val != NULL ) {
704 LBER_FREE( bval->bv_val );
710 case 'O': /* octet string - allocate & include length */
711 bvp = va_arg( ap, struct berval ** );
718 case 'B': /* bit string - allocate storage as needed */
719 ss = va_arg( ap, char ** );
724 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
727 case 'v': /* sequence of strings */
728 sss = va_arg( ap, char *** );
730 for (j = 0; (*sss)[j]; j++) {
731 LBER_FREE( (*sss)[j] );
739 case 'V': /* sequence of strings + lengths */
740 bv = va_arg( ap, struct berval *** );
748 case 'x': /* skip the next element - whatever it is */
749 case '{': /* begin sequence */
750 case '[': /* begin set */
751 case '}': /* end sequence */
752 case ']': /* end set */
756 /* format should be good */
768 #ifdef STR_TRANSLATION
770 ber_set_string_translators( BerElement *ber, BERTranslateProc encode_proc,
771 BERTranslateProc decode_proc )
773 assert( ber != NULL );
774 assert( BER_VALID( ber ) );
776 ber->ber_encode_translate_proc = encode_proc;
777 ber->ber_decode_translate_proc = decode_proc;
779 #endif /* STR_TRANSLATION */