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 */
132 assert( ber_in != NULL );
134 ber = ber_dup( ber_in );
140 tag = ber_skip_tag( ber, len );
147 ber_getnint( BerElement *ber, long *num, int len )
153 assert( ber != NULL );
154 assert( num != NULL );
157 * The tag and length have already been stripped off. We should
158 * be sitting right before len bytes of 2's complement integer,
159 * ready to be read straight into an int. We may have to sign
160 * extend after we read it in.
163 if ( (unsigned) len > sizeof(long) )
167 diff = sizeof(long) - len;
168 /* read into the low-order bytes of netnum */
169 if ( ber_read( ber, ((char *) &netnum) + diff, len ) != len )
172 /* sign extend if necessary */
173 p = (char *) &netnum;
174 sign = (0x80 & *(p+diff) );
175 if ( sign && ((unsigned) len < sizeof(long)) ) {
176 for ( i = 0; i < diff; i++ ) {
177 *(p+i) = (unsigned char) 0xff;
180 *num = AC_NTOHL( netnum );
186 ber_get_int( BerElement *ber, long *num )
188 unsigned long tag, len;
190 assert( ber != NULL );
192 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
193 return( LBER_DEFAULT );
195 if ( (unsigned long) ber_getnint( ber, num, (int)len ) != len )
196 return( LBER_DEFAULT );
202 ber_get_stringb( BerElement *ber, char *buf, unsigned long *len )
204 unsigned long datalen, tag;
205 #ifdef STR_TRANSLATION
207 #endif /* STR_TRANSLATION */
209 assert( ber != NULL );
211 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
212 return( LBER_DEFAULT );
213 if ( datalen > (*len - 1) )
214 return( LBER_DEFAULT );
216 if ( (unsigned long) ber_read( ber, buf, datalen ) != datalen )
217 return( LBER_DEFAULT );
221 #ifdef STR_TRANSLATION
222 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
223 && ber->ber_decode_translate_proc ) {
226 if ( (*(ber->ber_decode_translate_proc))( &transbuf, &datalen,
228 return( LBER_DEFAULT );
230 if ( datalen > *len ) {
232 return( LBER_DEFAULT );
234 SAFEMEMCPY( buf, transbuf, datalen );
238 #endif /* STR_TRANSLATION */
245 ber_get_stringa( BerElement *ber, char **buf )
247 unsigned long datalen, tag;
249 assert( ber != NULL );
250 assert( buf != NULL );
252 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
254 return( LBER_DEFAULT );
257 if ( (*buf = (char *) malloc( (size_t)datalen + 1 )) == NULL )
258 return( LBER_DEFAULT );
260 if ( (unsigned long) ber_read( ber, *buf, datalen ) != datalen ) {
263 return( LBER_DEFAULT );
265 (*buf)[datalen] = '\0';
267 #ifdef STR_TRANSLATION
268 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
269 && ber->ber_decode_translate_proc ) {
271 if ( (*(ber->ber_decode_translate_proc))( buf, &datalen, 1 )
275 return( LBER_DEFAULT );
278 #endif /* STR_TRANSLATION */
284 ber_get_stringal( BerElement *ber, struct berval **bv )
286 unsigned long len, tag;
288 assert( ber != NULL );
289 assert( bv != NULL );
291 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
293 return( LBER_DEFAULT );
296 if ( (*bv = (struct berval *) malloc( sizeof(struct berval) )) == NULL )
297 return( LBER_DEFAULT );
299 if ( ((*bv)->bv_val = (char *) malloc( (size_t)len + 1 )) == NULL ) {
302 return( LBER_DEFAULT );
305 if ( (unsigned long) ber_read( ber, (*bv)->bv_val, len ) != len ) {
308 return( LBER_DEFAULT );
310 ((*bv)->bv_val)[len] = '\0';
313 #ifdef STR_TRANSLATION
314 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
315 && ber->ber_decode_translate_proc ) {
317 if ( (*(ber->ber_decode_translate_proc))( &((*bv)->bv_val),
321 return( LBER_DEFAULT );
323 (*bv)->bv_len = len - 1;
325 #endif /* STR_TRANSLATION */
331 ber_get_bitstringa( BerElement *ber, char **buf, unsigned long *blen )
333 unsigned long datalen, tag;
334 unsigned char unusedbits;
336 assert( ber != NULL );
337 assert( buf != NULL );
338 assert( blen != NULL );
340 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
342 return( LBER_DEFAULT );
346 if ( (*buf = (char *) malloc( (size_t)datalen )) == NULL )
347 return( LBER_DEFAULT );
349 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
352 return( LBER_DEFAULT );
355 if ( (unsigned long) ber_read( ber, *buf, datalen ) != datalen ) {
358 return( LBER_DEFAULT );
361 *blen = datalen * 8 - unusedbits;
366 ber_get_null( BerElement *ber )
368 unsigned long len, tag;
370 assert( ber != NULL );
372 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
373 return( LBER_DEFAULT );
376 return( LBER_DEFAULT );
382 ber_get_boolean( BerElement *ber, int *boolval )
387 assert( ber != NULL );
388 assert( boolval != NULL );
390 rc = ber_get_int( ber, &longbool );
397 ber_first_element( BerElement *ber, unsigned long *len, char **last )
399 assert( ber != NULL );
400 assert( len != NULL );
401 assert( last != NULL );
403 /* skip the sequence header, use the len to mark where to stop */
404 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
406 return( LBER_DEFAULT );
409 *last = ber->ber_ptr + *len;
411 if ( *last == ber->ber_ptr ) {
412 #ifdef LBER_END_SEQORSET
413 return( LBER_END_SEQORSET );
415 return( LBER_DEFAULT );
419 return( ber_peek_tag( ber, len ) );
423 ber_next_element( BerElement *ber, unsigned long *len, char *last )
425 assert( ber != NULL );
426 assert( len != NULL );
427 assert( last != NULL );
429 if ( ber->ber_ptr == last ) {
430 #ifdef LBER_END_SEQORSET
431 return( LBER_END_SEQORSET );
433 return( LBER_DEFAULT );
437 return( ber_peek_tag( ber, len ) );
445 LDAP_CONST char *fmt,
457 LDAP_CONST char *fmt_reset;
459 char *s, **ss, ***sss;
460 struct berval ***bv, **bvp, *bval;
463 unsigned long rc, tag, len;
469 ber = va_arg( ap, BerElement * );
470 fmt = va_arg( ap, char * );
473 assert( ber != NULL );
474 assert( fmt != NULL );
478 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
479 "ber_scanf fmt (%s) ber:\n", fmt );
480 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
482 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
483 /* When this is modified, remember to update
484 * the error-cleanup code below accordingly. */
486 case '!': { /* Hook */
487 BERDecodeCallback *f;
490 f = va_arg( ap, BERDecodeCallback * );
491 p = va_arg( ap, void * );
493 rc = (*f)( ber, p, 0 );
496 case 'a': /* octet string - allocate storage as needed */
497 ss = va_arg( ap, char ** );
498 rc = ber_get_stringa( ber, ss );
501 case 'b': /* boolean */
502 i = va_arg( ap, int * );
503 rc = ber_get_boolean( ber, i );
506 case 'e': /* enumerated */
508 l = va_arg( ap, long * );
509 rc = ber_get_int( ber, l );
512 case 'l': /* length of next item */
513 l = va_arg( ap, long * );
514 rc = ber_peek_tag( ber, l );
518 rc = ber_get_null( ber );
521 case 's': /* octet string - in a buffer */
522 s = va_arg( ap, char * );
523 l = va_arg( ap, long * );
524 rc = ber_get_stringb( ber, s, l );
527 case 'o': /* octet string in a supplied berval */
528 bval = va_arg( ap, struct berval * );
529 ber_peek_tag( ber, &bval->bv_len );
530 rc = ber_get_stringa( ber, &bval->bv_val );
533 case 'O': /* octet string - allocate & include length */
534 bvp = va_arg( ap, struct berval ** );
535 rc = ber_get_stringal( ber, bvp );
538 case 'B': /* bit string - allocate storage as needed */
539 ss = va_arg( ap, char ** );
540 l = va_arg( ap, long * ); /* for length, in bits */
541 rc = ber_get_bitstringa( ber, ss, l );
544 case 't': /* tag of next item */
545 l = va_arg( ap, long * );
546 *l = rc = ber_peek_tag( ber, &len );
549 case 'T': /* skip tag of next item */
550 l = va_arg( ap, long * );
551 *l = rc = ber_skip_tag( ber, &len );
554 case 'v': /* sequence of strings */
555 sss = va_arg( ap, char *** );
558 for ( tag = ber_first_element( ber, &len, &last );
559 tag != LBER_DEFAULT &&
560 #ifdef LBER_END_SEQORSET
561 tag != LBER_END_SEQORSET &&
564 tag = ber_next_element( ber, &len, last ) )
566 if ( *sss == NULL ) {
567 *sss = (char **) malloc(
568 2 * sizeof(char *) );
570 *sss = (char **) realloc( *sss,
571 (j + 2) * sizeof(char *) );
573 rc = ber_get_stringa( ber, &((*sss)[j]) );
576 #ifdef LBER_END_SEQORSET
577 if (rc != LBER_DEFAULT &&
578 tag != LBER_END_SEQORSET )
587 case 'V': /* sequence of strings + lengths */
588 bv = va_arg( ap, struct berval *** );
591 for ( tag = ber_first_element( ber, &len, &last );
592 tag != LBER_DEFAULT &&
593 #ifdef LBER_END_SEQORSET
594 tag != LBER_END_SEQORSET &&
597 tag = ber_next_element( ber, &len, last ) )
600 *bv = (struct berval **) malloc(
601 2 * sizeof(struct berval *) );
603 *bv = (struct berval **) realloc( *bv,
604 (j + 2) * sizeof(struct berval *) );
606 rc = ber_get_stringal( ber, &((*bv)[j]) );
609 #ifdef LBER_END_SEQORSET
610 if (rc != LBER_DEFAULT &&
611 tag != LBER_END_SEQORSET )
620 case 'x': /* skip the next element - whatever it is */
621 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
626 case '{': /* begin sequence */
627 case '[': /* begin set */
628 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
629 rc = ber_skip_tag( ber, &len );
632 case '}': /* end sequence */
633 case ']': /* end set */
637 if( ber->ber_debug ) {
638 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
639 "ber_scanf: unknown fmt %c\n", *fmt );
648 if ( rc == LBER_DEFAULT ) {
650 * Error. Reclaim malloced memory that was given to the caller.
651 * Set allocated pointers to NULL, "data length" outvalues to 0.
657 (void) va_arg( ap, BerElement * );
658 (void) va_arg( ap, char * );
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 (void) va_arg( ap, int * );
685 case 's': /* octet string - in a buffer */
686 (void) va_arg( ap, char * );
687 (void) va_arg( ap, long * );
690 case 'e': /* enumerated */
692 case 'l': /* length of next item */
693 case 't': /* tag of next item */
694 case 'T': /* skip tag of next item */
695 (void) va_arg( ap, long * );
698 case 'o': /* octet string in a supplied berval */
699 bval = va_arg( ap, struct berval * );
700 if ( bval->bv_val != NULL ) {
701 free( bval->bv_val );
707 case 'O': /* octet string - allocate & include length */
708 bvp = va_arg( ap, struct berval ** );
715 case 'B': /* bit string - allocate storage as needed */
716 ss = va_arg( ap, char ** );
721 *(va_arg( ap, long * )) = 0; /* for length, in bits */
724 case 'v': /* sequence of strings */
725 sss = va_arg( ap, char *** );
727 for (j = 0; (*sss)[j]; j++) {
736 case 'V': /* sequence of strings + lengths */
737 bv = va_arg( ap, struct berval *** );
745 case 'x': /* skip the next element - whatever it is */
746 case '{': /* begin sequence */
747 case '[': /* begin set */
748 case '}': /* end sequence */
749 case ']': /* end set */
753 /* format should be good */
765 ber_bvfree( struct berval *bv )
767 assert(bv != NULL); /* bv damn better point to something */
769 if ( bv->bv_val != NULL )
775 ber_bvecfree( struct berval **bv )
779 assert(bv != NULL); /* bv damn better point to something */
781 for ( i = 0; bv[i] != NULL; i++ )
788 LDAP_CONST struct berval *bv )
792 assert( bv != NULL );
798 if ( (new = (struct berval *) malloc( sizeof(struct berval) ))
803 if ( bv->bv_val == NULL ) {
809 if ( (new->bv_val = (char *) malloc( bv->bv_len + 1 )) == NULL ) {
814 SAFEMEMCPY( new->bv_val, bv->bv_val, (size_t) bv->bv_len );
815 new->bv_val[bv->bv_len] = '\0';
816 new->bv_len = bv->bv_len;
822 #ifdef STR_TRANSLATION
824 ber_set_string_translators( BerElement *ber, BERTranslateProc encode_proc,
825 BERTranslateProc decode_proc )
827 assert( ber != NULL );
829 ber->ber_encode_translate_proc = encode_proc;
830 ber->ber_decode_translate_proc = decode_proc;
832 #endif /* STR_TRANSLATION */