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 int ber_getnint LDAP_P(( BerElement *ber, long *num, int len ));
35 /* return the tag - LBER_DEFAULT returned means trouble */
37 ber_get_tag( BerElement *ber )
44 assert( ber != NULL );
45 assert( BER_VALID( ber ) );
47 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
48 return( LBER_DEFAULT );
50 if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
51 return( (unsigned long) xbyte );
55 for ( i = 1; i < sizeof(long); i++ ) {
56 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
57 return( LBER_DEFAULT );
61 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
66 if ( i == sizeof(long) )
67 return( LBER_DEFAULT );
69 /* want leading, not trailing 0's */
70 return( tag >> (sizeof(long) - i - 1) );
74 ber_skip_tag( BerElement *ber, unsigned long *len )
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
97 * First, we read the tag.
100 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT )
101 return( LBER_DEFAULT );
104 * Next, read the length. The first byte contains the length of
105 * the length. If bit 8 is set, the length is the long form,
106 * otherwise it's the short form. We don't allow a length that's
107 * greater than what we can hold in an unsigned long.
111 if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
112 return( LBER_DEFAULT );
114 noctets = (lc & 0x7fU);
115 if ( (unsigned) noctets > sizeof(unsigned long) )
116 return( LBER_DEFAULT );
117 diff = sizeof(unsigned long) - noctets;
118 if ( (unsigned) ber_read( ber, (char *) &netlen + diff, noctets )
120 return( LBER_DEFAULT );
121 *len = AC_NTOHL( netlen );
131 LDAP_CONST BerElement *ber_in, /* not const per c-api-02 */
137 assert( ber_in != NULL );
138 assert( BER_VALID( ber_in ) );
140 ber = ber_dup( ber_in );
146 assert( BER_VALID( ber ) );
148 tag = ber_skip_tag( ber, len );
155 ber_getnint( BerElement *ber, long *num, int len )
161 assert( ber != NULL );
162 assert( num != NULL );
164 assert( BER_VALID( ber ) );
167 * The tag and length have already been stripped off. We should
168 * be sitting right before len bytes of 2's complement integer,
169 * ready to be read straight into an int. We may have to sign
170 * extend after we read it in.
173 if ( (unsigned) len > sizeof(long) )
177 diff = sizeof(long) - len;
178 /* read into the low-order bytes of netnum */
179 if ( ber_read( ber, ((char *) &netnum) + diff, len ) != len )
182 /* sign extend if necessary */
183 p = (char *) &netnum;
184 sign = (0x80 & *(p+diff) );
185 if ( sign && ((unsigned) len < sizeof(long)) ) {
186 for ( i = 0; i < diff; i++ ) {
187 *(p+i) = (unsigned char) 0xff;
190 *num = AC_NTOHL( netnum );
196 ber_get_int( BerElement *ber, long *num )
198 unsigned long tag, len;
200 assert( ber != NULL );
201 assert( BER_VALID( ber ) );
203 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
204 return( LBER_DEFAULT );
206 if ( (unsigned long) ber_getnint( ber, num, (int)len ) != len )
207 return( LBER_DEFAULT );
213 ber_get_stringb( BerElement *ber, char *buf, unsigned long *len )
215 unsigned long datalen, tag;
216 #ifdef STR_TRANSLATION
218 #endif /* STR_TRANSLATION */
220 assert( ber != NULL );
221 assert( BER_VALID( ber ) );
223 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
224 return( LBER_DEFAULT );
225 if ( datalen > (*len - 1) )
226 return( LBER_DEFAULT );
228 if ( (unsigned long) ber_read( ber, buf, datalen ) != datalen )
229 return( LBER_DEFAULT );
233 #ifdef STR_TRANSLATION
234 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
235 && ber->ber_decode_translate_proc ) {
238 if ( (*(ber->ber_decode_translate_proc))( &transbuf, &datalen,
240 return( LBER_DEFAULT );
242 if ( datalen > *len ) {
243 LBER_FREE( transbuf );
244 return( LBER_DEFAULT );
246 SAFEMEMCPY( buf, transbuf, datalen );
247 LBER_FREE( transbuf );
250 #endif /* STR_TRANSLATION */
257 ber_get_stringa( BerElement *ber, char **buf )
259 unsigned long datalen, tag;
261 assert( ber != NULL );
262 assert( buf != NULL );
264 assert( BER_VALID( ber ) );
266 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
268 return( LBER_DEFAULT );
271 if ( (*buf = (char *) LBER_MALLOC( (size_t)datalen + 1 )) == NULL )
272 return( LBER_DEFAULT );
274 if ( (unsigned long) ber_read( ber, *buf, datalen ) != datalen ) {
277 return( LBER_DEFAULT );
279 (*buf)[datalen] = '\0';
281 #ifdef STR_TRANSLATION
282 if ( datalen > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
283 && ber->ber_decode_translate_proc ) {
285 if ( (*(ber->ber_decode_translate_proc))( buf, &datalen, 1 )
289 return( LBER_DEFAULT );
292 #endif /* STR_TRANSLATION */
298 ber_get_stringal( BerElement *ber, struct berval **bv )
300 unsigned long len, tag;
302 assert( ber != NULL );
303 assert( bv != NULL );
305 assert( BER_VALID( ber ) );
307 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
309 return( LBER_DEFAULT );
312 if ( (*bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) )) == NULL )
313 return( LBER_DEFAULT );
315 if ( ((*bv)->bv_val = (char *) LBER_MALLOC( (size_t)len + 1 )) == NULL ) {
318 return( LBER_DEFAULT );
321 if ( (unsigned long) ber_read( ber, (*bv)->bv_val, len ) != len ) {
324 return( LBER_DEFAULT );
326 ((*bv)->bv_val)[len] = '\0';
329 #ifdef STR_TRANSLATION
330 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0
331 && ber->ber_decode_translate_proc ) {
333 if ( (*(ber->ber_decode_translate_proc))( &((*bv)->bv_val),
337 return( LBER_DEFAULT );
339 (*bv)->bv_len = len - 1;
341 #endif /* STR_TRANSLATION */
347 ber_get_bitstringa( BerElement *ber, char **buf, unsigned long *blen )
349 unsigned long datalen, tag;
350 unsigned char unusedbits;
352 assert( ber != NULL );
353 assert( buf != NULL );
354 assert( blen != NULL );
356 assert( BER_VALID( ber ) );
358 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
360 return( LBER_DEFAULT );
364 if ( (*buf = (char *) LBER_MALLOC( (size_t)datalen )) == NULL )
365 return( LBER_DEFAULT );
367 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
370 return( LBER_DEFAULT );
373 if ( (unsigned long) ber_read( ber, *buf, datalen ) != datalen ) {
376 return( LBER_DEFAULT );
379 *blen = datalen * 8 - unusedbits;
384 ber_get_null( BerElement *ber )
386 unsigned long len, tag;
388 assert( ber != NULL );
389 assert( BER_VALID( ber ) );
391 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
392 return( LBER_DEFAULT );
395 return( LBER_DEFAULT );
401 ber_get_boolean( BerElement *ber, int *boolval )
406 assert( ber != NULL );
407 assert( boolval != NULL );
409 assert( BER_VALID( ber ) );
411 rc = ber_get_int( ber, &longbool );
418 ber_first_element( BerElement *ber, unsigned long *len, char **last )
420 assert( ber != NULL );
421 assert( len != NULL );
422 assert( last != NULL );
424 /* skip the sequence header, use the len to mark where to stop */
425 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
427 return( LBER_DEFAULT );
430 *last = ber->ber_ptr + *len;
432 if ( *last == ber->ber_ptr ) {
433 return( LBER_DEFAULT );
436 return( ber_peek_tag( ber, len ) );
440 ber_next_element( BerElement *ber, unsigned long *len, char *last )
442 assert( ber != NULL );
443 assert( len != NULL );
444 assert( last != NULL );
446 assert( BER_VALID( ber ) );
448 if ( ber->ber_ptr == last ) {
449 return( LBER_DEFAULT );
452 return( ber_peek_tag( ber, len ) );
460 LDAP_CONST char *fmt,
472 LDAP_CONST char *fmt_reset;
474 char *s, **ss, ***sss;
475 struct berval ***bv, **bvp, *bval;
478 unsigned long rc, tag, len;
484 ber = va_arg( ap, BerElement * );
485 fmt = va_arg( ap, char * );
488 assert( ber != NULL );
489 assert( fmt != NULL );
491 assert( BER_VALID( ber ) );
495 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
496 "ber_scanf fmt (%s) ber:\n", fmt );
497 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
499 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
500 /* When this is modified, remember to update
501 * the error-cleanup code below accordingly. */
503 case '!': { /* Hook */
504 BERDecodeCallback *f;
507 f = va_arg( ap, BERDecodeCallback * );
508 p = va_arg( ap, void * );
510 rc = (*f)( ber, p, 0 );
513 case 'a': /* octet string - allocate storage as needed */
514 ss = va_arg( ap, char ** );
515 rc = ber_get_stringa( ber, ss );
518 case 'b': /* boolean */
519 i = va_arg( ap, int * );
520 rc = ber_get_boolean( ber, i );
523 case 'e': /* enumerated */
525 l = va_arg( ap, long * );
526 rc = ber_get_int( ber, l );
529 case 'l': /* length of next item */
530 l = va_arg( ap, long * );
531 rc = ber_peek_tag( ber, l );
535 rc = ber_get_null( ber );
538 case 's': /* octet string - in a buffer */
539 s = va_arg( ap, char * );
540 l = va_arg( ap, long * );
541 rc = ber_get_stringb( ber, s, l );
544 case 'o': /* octet string in a supplied berval */
545 bval = va_arg( ap, struct berval * );
546 ber_peek_tag( ber, &bval->bv_len );
547 rc = ber_get_stringa( ber, &bval->bv_val );
550 case 'O': /* octet string - allocate & include length */
551 bvp = va_arg( ap, struct berval ** );
552 rc = ber_get_stringal( ber, bvp );
555 case 'B': /* bit string - allocate storage as needed */
556 ss = va_arg( ap, char ** );
557 l = va_arg( ap, long * ); /* for length, in bits */
558 rc = ber_get_bitstringa( ber, ss, l );
561 case 't': /* tag of next item */
562 l = va_arg( ap, long * );
563 *l = rc = ber_peek_tag( ber, &len );
566 case 'T': /* skip tag of next item */
567 l = va_arg( ap, long * );
568 *l = rc = ber_skip_tag( ber, &len );
571 case 'v': /* sequence of strings */
572 sss = va_arg( ap, char *** );
575 for ( tag = ber_first_element( ber, &len, &last );
576 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
577 tag = ber_next_element( ber, &len, last ) )
579 *sss = (char **) LBER_REALLOC( *sss,
580 (j + 2) * sizeof(char *) );
582 rc = ber_get_stringa( ber, &((*sss)[j]) );
589 case 'V': /* sequence of strings + lengths */
590 bv = va_arg( ap, struct berval *** );
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 *bv = (struct berval **) LBER_REALLOC( *bv,
598 (j + 2) * sizeof(struct berval *) );
600 rc = ber_get_stringal( ber, &((*bv)[j]) );
607 case 'x': /* skip the next element - whatever it is */
608 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
613 case '{': /* begin sequence */
614 case '[': /* begin set */
615 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
616 rc = ber_skip_tag( ber, &len );
619 case '}': /* end sequence */
620 case ']': /* end set */
624 if( ber->ber_debug ) {
625 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
626 "ber_scanf: unknown fmt %c\n", *fmt );
635 if ( rc == LBER_DEFAULT ) {
637 * Error. Reclaim malloced memory that was given to the caller.
638 * Set allocated pointers to NULL, "data length" outvalues to 0.
644 (void) va_arg( ap, BerElement * );
645 (void) va_arg( ap, char * );
648 for ( ; fmt_reset < fmt; fmt_reset++ ) {
649 switch ( *fmt_reset ) {
650 case '!': { /* Hook */
651 BERDecodeCallback *f;
654 f = va_arg( ap, BERDecodeCallback * );
655 p = va_arg( ap, void * );
657 (void) (*f)( ber, p, 1 );
660 case 'a': /* octet string - allocate storage as needed */
661 ss = va_arg( ap, char ** );
668 case 'b': /* boolean */
669 (void) va_arg( ap, int * );
672 case 's': /* octet string - in a buffer */
673 (void) va_arg( ap, char * );
674 (void) va_arg( ap, long * );
677 case 'e': /* enumerated */
679 case 'l': /* length of next item */
680 case 't': /* tag of next item */
681 case 'T': /* skip tag of next item */
682 (void) va_arg( ap, long * );
685 case 'o': /* octet string in a supplied berval */
686 bval = va_arg( ap, struct berval * );
687 if ( bval->bv_val != NULL ) {
688 LBER_FREE( bval->bv_val );
694 case 'O': /* octet string - allocate & include length */
695 bvp = va_arg( ap, struct berval ** );
702 case 'B': /* bit string - allocate storage as needed */
703 ss = va_arg( ap, char ** );
708 *(va_arg( ap, long * )) = 0; /* for length, in bits */
711 case 'v': /* sequence of strings */
712 sss = va_arg( ap, char *** );
714 for (j = 0; (*sss)[j]; j++) {
715 LBER_FREE( (*sss)[j] );
723 case 'V': /* sequence of strings + lengths */
724 bv = va_arg( ap, struct berval *** );
732 case 'x': /* skip the next element - whatever it is */
733 case '{': /* begin sequence */
734 case '[': /* begin set */
735 case '}': /* end sequence */
736 case ']': /* end set */
740 /* format should be good */
752 #ifdef STR_TRANSLATION
754 ber_set_string_translators( BerElement *ber, BERTranslateProc encode_proc,
755 BERTranslateProc decode_proc )
757 assert( ber != NULL );
758 assert( BER_VALID( ber ) );
760 ber->ber_encode_translate_proc = encode_proc;
761 ber->ber_decode_translate_proc = decode_proc;
763 #endif /* STR_TRANSLATION */