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.
23 #include <ac/stdarg.h>
25 #include <ac/string.h>
26 #include <ac/socket.h>
30 static int ber_getnint LDAP_P(( BerElement *ber, long *num, int len ));
32 /* return the tag - LBER_DEFAULT returned means trouble */
34 ber_get_tag( BerElement *ber )
41 assert( ber != NULL );
43 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
44 return( LBER_DEFAULT );
46 if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
47 return( (unsigned long) xbyte );
51 for ( i = 1; i < sizeof(long); i++ ) {
52 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
53 return( LBER_DEFAULT );
57 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
62 if ( i == sizeof(long) )
63 return( LBER_DEFAULT );
65 /* want leading, not trailing 0's */
66 return( tag >> (sizeof(long) - i - 1) );
70 ber_skip_tag( BerElement *ber, unsigned long *len )
78 assert( ber != NULL );
79 assert( len != NULL );
82 * Any ber element looks like this: tag length contents.
83 * Assuming everything's ok, we return the tag byte (we
84 * can assume a single byte), and return the length in len.
88 * 2) primitive encodings used whenever possible
92 * First, we read the tag.
95 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT )
96 return( LBER_DEFAULT );
99 * Next, read the length. The first byte contains the length of
100 * the length. If bit 8 is set, the length is the long form,
101 * otherwise it's the short form. We don't allow a length that's
102 * greater than what we can hold in an unsigned long.
106 if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
107 return( LBER_DEFAULT );
109 noctets = (lc & 0x7fU);
110 if ( (unsigned) noctets > sizeof(unsigned long) )
111 return( LBER_DEFAULT );
112 diff = sizeof(unsigned long) - noctets;
113 if ( (unsigned) ber_read( ber, (char *) &netlen + diff, noctets )
115 return( LBER_DEFAULT );
116 *len = AC_NTOHL( netlen );
126 LDAP_CONST BerElement *ber_in, /* not const per c-api-02 */
130 BerElement *ber = ber_dup( ber_in );
136 tag = ber_skip_tag( ber, len );
143 ber_getnint( BerElement *ber, long *num, int len )
149 assert( ber != NULL );
150 assert( num != NULL );
153 * The tag and length have already been stripped off. We should
154 * be sitting right before len bytes of 2's complement integer,
155 * ready to be read straight into an int. We may have to sign
156 * extend after we read it in.
159 if ( (unsigned) len > sizeof(long) )
163 diff = sizeof(long) - len;
164 /* read into the low-order bytes of netnum */
165 if ( ber_read( ber, ((char *) &netnum) + diff, len ) != len )
168 /* sign extend if necessary */
169 p = (char *) &netnum;
170 sign = (0x80 & *(p+diff) );
171 if ( sign && ((unsigned) len < sizeof(long)) ) {
172 for ( i = 0; i < diff; i++ ) {
173 *(p+i) = (unsigned char) 0xff;
176 *num = AC_NTOHL( netnum );
182 ber_get_int( BerElement *ber, long *num )
184 unsigned long tag, len;
186 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
187 return( LBER_DEFAULT );
189 if ( (unsigned long) ber_getnint( ber, num, (int)len ) != len )
190 return( LBER_DEFAULT );
196 ber_get_stringb( BerElement *ber, char *buf, unsigned long *len )
198 unsigned long datalen, tag;
199 #ifdef STR_TRANSLATION
201 #endif /* STR_TRANSLATION */
203 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
204 return( LBER_DEFAULT );
205 if ( datalen > (*len - 1) )
206 return( LBER_DEFAULT );
208 if ( (unsigned long) ber_read( ber, buf, datalen ) != datalen )
209 return( LBER_DEFAULT );
213 #ifdef STR_TRANSLATION
214 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
215 && ber->ber_decode_translate_proc ) {
218 if ( (*(ber->ber_decode_translate_proc))( &transbuf, &datalen,
220 return( LBER_DEFAULT );
222 if ( datalen > *len ) {
224 return( LBER_DEFAULT );
226 SAFEMEMCPY( buf, transbuf, datalen );
230 #endif /* STR_TRANSLATION */
237 ber_get_stringa( BerElement *ber, char **buf )
239 unsigned long datalen, tag;
241 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
243 return( LBER_DEFAULT );
246 if ( (*buf = (char *) malloc( (size_t)datalen + 1 )) == NULL )
247 return( LBER_DEFAULT );
249 if ( (unsigned long) ber_read( ber, *buf, datalen ) != datalen ) {
252 return( LBER_DEFAULT );
254 (*buf)[datalen] = '\0';
256 #ifdef STR_TRANSLATION
257 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
258 && ber->ber_decode_translate_proc ) {
260 if ( (*(ber->ber_decode_translate_proc))( buf, &datalen, 1 )
264 return( LBER_DEFAULT );
267 #endif /* STR_TRANSLATION */
273 ber_get_stringal( BerElement *ber, struct berval **bv )
275 unsigned long len, tag;
277 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
279 return( LBER_DEFAULT );
282 if ( (*bv = (struct berval *) malloc( sizeof(struct berval) )) == NULL )
283 return( LBER_DEFAULT );
285 if ( ((*bv)->bv_val = (char *) malloc( (size_t)len + 1 )) == NULL ) {
288 return( LBER_DEFAULT );
291 if ( (unsigned long) ber_read( ber, (*bv)->bv_val, len ) != len ) {
294 return( LBER_DEFAULT );
296 ((*bv)->bv_val)[len] = '\0';
299 #ifdef STR_TRANSLATION
300 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
301 && ber->ber_decode_translate_proc ) {
303 if ( (*(ber->ber_decode_translate_proc))( &((*bv)->bv_val),
307 return( LBER_DEFAULT );
309 (*bv)->bv_len = len - 1;
311 #endif /* STR_TRANSLATION */
317 ber_get_bitstringa( BerElement *ber, char **buf, unsigned long *blen )
319 unsigned long datalen, tag;
320 unsigned char unusedbits;
322 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
324 return( LBER_DEFAULT );
328 if ( (*buf = (char *) malloc( (size_t)datalen )) == NULL )
329 return( LBER_DEFAULT );
331 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
334 return( LBER_DEFAULT );
337 if ( (unsigned long) ber_read( ber, *buf, datalen ) != datalen ) {
340 return( LBER_DEFAULT );
343 *blen = datalen * 8 - unusedbits;
348 ber_get_null( BerElement *ber )
350 unsigned long len, tag;
352 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
353 return( LBER_DEFAULT );
356 return( LBER_DEFAULT );
362 ber_get_boolean( BerElement *ber, int *boolval )
367 rc = ber_get_int( ber, &longbool );
374 ber_first_element( BerElement *ber, unsigned long *len, char **last )
376 /* skip the sequence header, use the len to mark where to stop */
377 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
379 return( LBER_DEFAULT );
382 *last = ber->ber_ptr + *len;
384 if ( *last == ber->ber_ptr ) {
385 #ifdef LBER_END_SEQORSET
386 return( LBER_END_SEQORSET );
388 return( LBER_DEFAULT );
392 return( ber_peek_tag( ber, len ) );
396 ber_next_element( BerElement *ber, unsigned long *len, char *last )
398 if ( ber->ber_ptr == last ) {
399 #ifdef LBER_END_SEQORSET
400 return( LBER_END_SEQORSET );
402 return( LBER_DEFAULT );
406 return( ber_peek_tag( ber, len ) );
414 LDAP_CONST char *fmt,
426 LDAP_CONST char *fmt_reset;
428 char *s, **ss, ***sss;
429 struct berval ***bv, **bvp, *bval;
432 unsigned long rc, tag, len;
434 assert( ber != NULL );
440 ber = va_arg( ap, BerElement * );
441 fmt = va_arg( ap, char * );
444 assert( ber != NULL );
445 assert( fmt != NULL );
449 if ( ber->ber_debug ) {
450 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
451 "ber_scanf fmt (%s) ber:\n", fmt );
452 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
455 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
456 /* When this is modified, remember to update
457 * the error-cleanup code below accordingly. */
459 case '!': { /* Hook */
460 BERDecodeCallback *f;
463 f = va_arg( ap, BERDecodeCallback * );
464 p = va_arg( ap, void * );
466 rc = (*f)( ber, p, 0 );
469 case 'a': /* octet string - allocate storage as needed */
470 ss = va_arg( ap, char ** );
471 rc = ber_get_stringa( ber, ss );
474 case 'b': /* boolean */
475 i = va_arg( ap, int * );
476 rc = ber_get_boolean( ber, i );
479 case 'e': /* enumerated */
481 l = va_arg( ap, long * );
482 rc = ber_get_int( ber, l );
485 case 'l': /* length of next item */
486 l = va_arg( ap, long * );
487 rc = ber_peek_tag( ber, l );
491 rc = ber_get_null( ber );
494 case 's': /* octet string - in a buffer */
495 s = va_arg( ap, char * );
496 l = va_arg( ap, long * );
497 rc = ber_get_stringb( ber, s, l );
500 case 'o': /* octet string in a supplied berval */
501 bval = va_arg( ap, struct berval * );
502 ber_peek_tag( ber, &bval->bv_len );
503 rc = ber_get_stringa( ber, &bval->bv_val );
506 case 'O': /* octet string - allocate & include length */
507 bvp = va_arg( ap, struct berval ** );
508 rc = ber_get_stringal( ber, bvp );
511 case 'B': /* bit string - allocate storage as needed */
512 ss = va_arg( ap, char ** );
513 l = va_arg( ap, long * ); /* for length, in bits */
514 rc = ber_get_bitstringa( ber, ss, l );
517 case 't': /* tag of next item */
518 l = va_arg( ap, long * );
519 *l = rc = ber_peek_tag( ber, &len );
522 case 'T': /* skip tag of next item */
523 l = va_arg( ap, long * );
524 *l = rc = ber_skip_tag( ber, &len );
527 case 'v': /* sequence of strings */
528 sss = va_arg( ap, char *** );
531 for ( tag = ber_first_element( ber, &len, &last );
532 tag != LBER_DEFAULT &&
533 #ifdef LBER_END_SEQORSET
534 tag != LBER_END_SEQORSET &&
537 tag = ber_next_element( ber, &len, last ) )
539 if ( *sss == NULL ) {
540 *sss = (char **) malloc(
541 2 * sizeof(char *) );
543 *sss = (char **) realloc( *sss,
544 (j + 2) * sizeof(char *) );
546 rc = ber_get_stringa( ber, &((*sss)[j]) );
549 #ifdef LBER_END_SEQORSET
550 if (rc != LBER_DEFAULT &&
551 tag != LBER_END_SEQORSET )
560 case 'V': /* sequence of strings + lengths */
561 bv = va_arg( ap, struct berval *** );
564 for ( tag = ber_first_element( ber, &len, &last );
565 tag != LBER_DEFAULT &&
566 #ifdef LBER_END_SEQORSET
567 tag != LBER_END_SEQORSET &&
570 tag = ber_next_element( ber, &len, last ) )
573 *bv = (struct berval **) malloc(
574 2 * sizeof(struct berval *) );
576 *bv = (struct berval **) realloc( *bv,
577 (j + 2) * sizeof(struct berval *) );
579 rc = ber_get_stringal( ber, &((*bv)[j]) );
582 #ifdef LBER_END_SEQORSET
583 if (rc != LBER_DEFAULT &&
584 tag != LBER_END_SEQORSET )
593 case 'x': /* skip the next element - whatever it is */
594 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
599 case '{': /* begin sequence */
600 case '[': /* begin set */
601 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
602 rc = ber_skip_tag( ber, &len );
605 case '}': /* end sequence */
606 case ']': /* end set */
610 if( ber->ber_debug ) {
611 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
612 "ber_scanf: unknown fmt %c\n", *fmt );
621 if ( rc == LBER_DEFAULT ) {
623 * Error. Reclaim malloced memory that was given to the caller.
624 * Set allocated pointers to NULL, "data length" outvalues to 0.
630 (void) va_arg( ap, BerElement * );
631 (void) va_arg( ap, char * );
634 for ( ; fmt_reset < fmt; fmt_reset++ ) {
635 switch ( *fmt_reset ) {
636 case '!': { /* Hook */
637 BERDecodeCallback *f;
640 f = va_arg( ap, BERDecodeCallback * );
641 p = va_arg( ap, void * );
643 (void) (*f)( ber, p, 1 );
646 case 'a': /* octet string - allocate storage as needed */
647 ss = va_arg( ap, char ** );
654 case 'b': /* boolean */
655 (void) va_arg( ap, int * );
658 case 's': /* octet string - in a buffer */
659 (void) va_arg( ap, char * );
660 (void) va_arg( ap, long * );
663 case 'e': /* enumerated */
665 case 'l': /* length of next item */
666 case 't': /* tag of next item */
667 case 'T': /* skip tag of next item */
668 (void) va_arg( ap, long * );
671 case 'o': /* octet string in a supplied berval */
672 bval = va_arg( ap, struct berval * );
673 if ( bval->bv_val ) {
674 free( bval->bv_val );
680 case 'O': /* octet string - allocate & include length */
681 bvp = va_arg( ap, struct berval ** );
688 case 'B': /* bit string - allocate storage as needed */
689 ss = va_arg( ap, char ** );
694 *(va_arg( ap, long * )) = 0; /* for length, in bits */
697 case 'v': /* sequence of strings */
698 sss = va_arg( ap, char *** );
700 for (j = 0; (*sss)[j]; j++) {
709 case 'V': /* sequence of strings + lengths */
710 bv = va_arg( ap, struct berval *** );
718 case 'x': /* skip the next element - whatever it is */
719 case '{': /* begin sequence */
720 case '[': /* begin set */
721 case '}': /* end sequence */
722 case ']': /* end set */
726 /* format should be good */
738 ber_bvfree( struct berval *bv )
740 assert(bv != NULL); /* bv damn better point to something */
742 if ( bv->bv_val != NULL )
748 ber_bvecfree( struct berval **bv )
752 assert(bv != NULL); /* bv damn better point to something */
754 for ( i = 0; bv[i] != NULL; i++ )
761 LDAP_CONST struct berval *bv )
765 assert( bv != NULL );
771 if ( (new = (struct berval *) malloc( sizeof(struct berval) ))
776 if ( bv->bv_val == NULL ) {
782 if ( (new->bv_val = (char *) malloc( bv->bv_len + 1 )) == NULL ) {
787 SAFEMEMCPY( new->bv_val, bv->bv_val, (size_t) bv->bv_len );
788 new->bv_val[bv->bv_len] = '\0';
789 new->bv_len = bv->bv_len;
795 #ifdef STR_TRANSLATION
797 ber_set_string_translators( BerElement *ber, BERTranslateProc encode_proc,
798 BERTranslateProc decode_proc )
800 assert( ber != NULL );
802 ber->ber_encode_translate_proc = encode_proc;
803 ber->ber_decode_translate_proc = decode_proc;
805 #endif /* STR_TRANSLATION */