1 /* decode.c - ber input decoding routines */
4 * Copyright 1998-2000 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 )
44 assert( ber != NULL );
45 assert( BER_VALID( ber ) );
47 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
48 return( LBER_DEFAULT );
52 if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
55 for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
56 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 )
57 return( LBER_DEFAULT );
60 tag |= 0x00ffUL & (ber_tag_t) xbyte;
62 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
67 if ( i == sizeof(ber_tag_t) )
68 return( LBER_DEFAULT );
74 ber_skip_tag( BerElement *ber, ber_len_t *len )
79 unsigned char netlen[sizeof(ber_len_t)];
81 assert( ber != NULL );
82 assert( len != NULL );
83 assert( BER_VALID( ber ) );
86 * Any ber element looks like this: tag length contents.
87 * Assuming everything's ok, we return the tag byte (we
88 * can assume a single byte), and return the length in len.
92 * 2) primitive encodings used whenever possible
98 * First, we read the tag.
101 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT )
102 return( LBER_DEFAULT );
105 * Next, read the length. The first byte contains the length of
106 * the length. If bit 8 is set, the length is the long form,
107 * otherwise it's the short form. We don't allow a length that's
108 * greater than what we can hold in a ber_len_t.
111 if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
112 return( LBER_DEFAULT );
115 noctets = (lc & 0x7fU);
117 if ( noctets > sizeof(ber_len_t) ) {
118 return( LBER_DEFAULT );
121 if( (unsigned) ber_read( ber, netlen, noctets ) != noctets ) {
122 return( LBER_DEFAULT );
125 for( i = 0; i < noctets; i++ ) {
145 assert( ber_in != NULL );
146 assert( BER_VALID( ber_in ) );
150 ber = ber_dup( ber_in );
156 assert( BER_VALID( ber ) );
158 tag = ber_skip_tag( ber, len );
170 unsigned char buf[sizeof(ber_int_t)];
172 assert( ber != NULL );
173 assert( num != NULL );
175 assert( BER_VALID( ber ) );
178 * The tag and length have already been stripped off. We should
179 * be sitting right before len bytes of 2's complement integer,
180 * ready to be read straight into an int. We may have to sign
181 * extend after we read it in.
184 if ( len > sizeof(ber_int_t) )
187 /* read into the low-order bytes of our buffer */
188 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
193 /* sign extend if necessary */
195 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
197 /* shift in the bytes */
198 for( i=0 ; i<len; i++ ) {
199 netnum = (netnum << 8 ) | buf[i];
219 assert( ber != NULL );
220 assert( BER_VALID( ber ) );
222 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
223 return( LBER_DEFAULT );
225 if ( ber_getnint( ber, num, len ) != len )
226 return( LBER_DEFAULT );
236 return ber_get_int( ber, num );
248 assert( ber != NULL );
249 assert( BER_VALID( ber ) );
251 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
252 return( LBER_DEFAULT );
253 if ( datalen > (*len - 1) )
254 return( LBER_DEFAULT );
256 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen )
257 return( LBER_DEFAULT );
266 ber_get_stringa( BerElement *ber, char **buf )
271 assert( ber != NULL );
272 assert( buf != NULL );
274 assert( BER_VALID( ber ) );
276 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
278 return( LBER_DEFAULT );
281 if ( (*buf = (char *) LBER_MALLOC( datalen + 1 )) == NULL )
282 return( LBER_DEFAULT );
284 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
287 return( LBER_DEFAULT );
289 (*buf)[datalen] = '\0';
295 ber_get_stringal( BerElement *ber, struct berval **bv )
300 assert( ber != NULL );
301 assert( bv != NULL );
303 assert( BER_VALID( ber ) );
305 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
307 return( LBER_DEFAULT );
310 if ( (*bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) )) == NULL )
311 return( LBER_DEFAULT );
313 if ( ((*bv)->bv_val = (char *) LBER_MALLOC( len + 1 )) == NULL ) {
316 return( LBER_DEFAULT );
319 if ( (ber_len_t) ber_read( ber, (*bv)->bv_val, len ) != len ) {
322 return( LBER_DEFAULT );
324 ((*bv)->bv_val)[len] = '\0';
338 unsigned char unusedbits;
340 assert( ber != NULL );
341 assert( buf != NULL );
342 assert( blen != NULL );
344 assert( BER_VALID( ber ) );
346 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
348 return( LBER_DEFAULT );
352 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL )
353 return( LBER_DEFAULT );
355 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
358 return( LBER_DEFAULT );
361 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
364 return( LBER_DEFAULT );
367 *blen = datalen * 8 - unusedbits;
372 ber_get_null( BerElement *ber )
377 assert( ber != NULL );
378 assert( BER_VALID( ber ) );
380 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
381 return( LBER_DEFAULT );
384 return( LBER_DEFAULT );
397 assert( ber != NULL );
398 assert( boolval != NULL );
400 assert( BER_VALID( ber ) );
402 rc = ber_get_int( ber, &longbool );
414 assert( ber != NULL );
415 assert( len != NULL );
416 assert( last != NULL );
418 /* skip the sequence header, use the len to mark where to stop */
419 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
421 return( LBER_DEFAULT );
424 *last = ber->ber_ptr + *len;
426 if ( *last == ber->ber_ptr ) {
427 return( LBER_DEFAULT );
430 return( ber_peek_tag( ber, len ) );
437 LDAP_CONST char *last )
439 assert( ber != NULL );
440 assert( len != NULL );
441 assert( last != NULL );
443 assert( BER_VALID( ber ) );
445 if ( ber->ber_ptr == last ) {
446 return( LBER_DEFAULT );
449 return( ber_peek_tag( ber, len ) );
454 ber_scanf ( BerElement *ber,
455 LDAP_CONST char *fmt,
459 LDAP_CONST char *fmt_reset;
461 char *s, **ss, ***sss;
462 struct berval ***bv, **bvp, *bval;
472 assert( ber != NULL );
473 assert( fmt != NULL );
475 assert( BER_VALID( ber ) );
479 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
480 "ber_scanf fmt (%s) ber:\n", fmt );
481 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
483 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
484 /* When this is modified, remember to update
485 * the error-cleanup code below accordingly. */
487 case '!': { /* Hook */
488 BERDecodeCallback *f;
491 f = va_arg( ap, BERDecodeCallback * );
492 p = va_arg( ap, void * );
494 rc = (*f)( ber, p, 0 );
497 case 'a': /* octet string - allocate storage as needed */
498 ss = va_arg( ap, char ** );
499 rc = ber_get_stringa( ber, ss );
502 case 'b': /* boolean */
503 i = va_arg( ap, ber_int_t * );
504 rc = ber_get_boolean( ber, i );
507 case 'e': /* enumerated */
509 i = va_arg( ap, ber_int_t * );
510 rc = ber_get_int( ber, i );
513 case 'l': /* length of next item */
514 l = va_arg( ap, ber_len_t * );
515 rc = ber_peek_tag( ber, l );
519 rc = ber_get_null( ber );
522 case 's': /* octet string - in a buffer */
523 s = va_arg( ap, char * );
524 l = va_arg( ap, ber_len_t * );
525 rc = ber_get_stringb( ber, s, l );
528 case 'o': /* octet string in a supplied berval */
529 bval = va_arg( ap, struct berval * );
530 ber_peek_tag( ber, &bval->bv_len );
531 rc = ber_get_stringa( ber, &bval->bv_val );
534 case 'O': /* octet string - allocate & include length */
535 bvp = va_arg( ap, struct berval ** );
536 rc = ber_get_stringal( ber, bvp );
539 case 'B': /* bit string - allocate storage as needed */
540 ss = va_arg( ap, char ** );
541 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
542 rc = ber_get_bitstringa( ber, ss, l );
545 case 't': /* tag of next item */
546 t = va_arg( ap, ber_tag_t * );
547 *t = rc = ber_peek_tag( ber, &len );
550 case 'T': /* skip tag of next item */
551 t = va_arg( ap, ber_tag_t * );
552 *t = rc = ber_skip_tag( ber, &len );
555 case 'v': /* sequence of strings */
556 sss = va_arg( ap, char *** );
559 for ( tag = ber_first_element( ber, &len, &last );
560 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
561 tag = ber_next_element( ber, &len, last ) )
563 *sss = (char **) LBER_REALLOC( *sss,
564 (j + 2) * sizeof(char *) );
566 rc = ber_get_stringa( ber, &((*sss)[j]) );
573 case 'V': /* sequence of strings + lengths */
574 bv = va_arg( ap, struct berval *** );
577 for ( tag = ber_first_element( ber, &len, &last );
578 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
579 tag = ber_next_element( ber, &len, last ) )
581 *bv = (struct berval **) LBER_REALLOC( *bv,
582 (j + 2) * sizeof(struct berval *) );
584 rc = ber_get_stringal( ber, &((*bv)[j]) );
591 case 'x': /* skip the next element - whatever it is */
592 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
597 case '{': /* begin sequence */
598 case '[': /* begin set */
599 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
600 rc = ber_skip_tag( ber, &len );
603 case '}': /* end sequence */
604 case ']': /* end set */
608 if( ber->ber_debug ) {
609 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
610 "ber_scanf: unknown fmt %c\n", *fmt );
619 if ( rc == LBER_DEFAULT ) {
621 * Error. Reclaim malloced memory that was given to the caller.
622 * Set allocated pointers to NULL, "data length" outvalues to 0.
626 for ( ; fmt_reset < fmt; fmt_reset++ ) {
627 switch ( *fmt_reset ) {
628 case '!': { /* Hook */
629 BERDecodeCallback *f;
632 f = va_arg( ap, BERDecodeCallback * );
633 p = va_arg( ap, void * );
635 (void) (*f)( ber, p, 1 );
638 case 'a': /* octet string - allocate storage as needed */
639 ss = va_arg( ap, char ** );
646 case 'b': /* boolean */
647 case 'e': /* enumerated */
649 (void) va_arg( ap, int * );
652 case 's': /* octet string - in a buffer */
653 (void) va_arg( ap, char * );
654 (void) va_arg( ap, ber_len_t * );
657 case 'l': /* length of next item */
658 (void) va_arg( ap, ber_len_t * );
661 case 't': /* tag of next item */
662 case 'T': /* skip tag of next item */
663 (void) va_arg( ap, ber_tag_t * );
666 case 'o': /* octet string in a supplied berval */
667 bval = va_arg( ap, struct berval * );
668 if ( bval->bv_val != NULL ) {
669 LBER_FREE( bval->bv_val );
675 case 'O': /* octet string - allocate & include length */
676 bvp = va_arg( ap, struct berval ** );
683 case 'B': /* bit string - allocate storage as needed */
684 ss = va_arg( ap, char ** );
689 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
692 case 'v': /* sequence of strings */
693 sss = va_arg( ap, char *** );
695 for (j = 0; (*sss)[j]; j++) {
696 LBER_FREE( (*sss)[j] );
704 case 'V': /* sequence of strings + lengths */
705 bv = va_arg( ap, struct berval *** );
713 case 'x': /* skip the next element - whatever it is */
714 case '{': /* begin sequence */
715 case '[': /* begin set */
716 case '}': /* end sequence */
717 case ']': /* end set */
721 /* format should be good */