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++ ) {
143 * This implementation assumes ber_skip_tag() only
144 * modifies ber_ptr field of the BerElement.
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 );
229 return ber_get_int( ber, num );
241 assert( ber != NULL );
242 assert( BER_VALID( ber ) );
244 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT )
245 return( LBER_DEFAULT );
246 if ( datalen > (*len - 1) )
247 return( LBER_DEFAULT );
249 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen )
250 return( LBER_DEFAULT );
259 ber_get_stringa( BerElement *ber, char **buf )
264 assert( ber != NULL );
265 assert( buf != NULL );
267 assert( BER_VALID( ber ) );
269 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
271 return( LBER_DEFAULT );
274 if ( (*buf = (char *) LBER_MALLOC( datalen + 1 )) == NULL )
275 return( LBER_DEFAULT );
277 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
280 return( LBER_DEFAULT );
282 (*buf)[datalen] = '\0';
288 ber_get_stringal( BerElement *ber, struct berval **bv )
293 assert( ber != NULL );
294 assert( bv != NULL );
296 assert( BER_VALID( ber ) );
298 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
303 *bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) );
309 (*bv)->bv_val = NULL;
314 (*bv)->bv_val = (char *) LBER_MALLOC( len + 1 );
315 if ( (*bv)->bv_val == NULL ) {
321 if ( (ber_len_t) ber_read( ber, (*bv)->bv_val, len ) != len ) {
327 ((*bv)->bv_val)[len] = '\0';
341 unsigned char unusedbits;
343 assert( ber != NULL );
344 assert( buf != NULL );
345 assert( blen != NULL );
347 assert( BER_VALID( ber ) );
349 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
351 return( LBER_DEFAULT );
355 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL )
356 return( LBER_DEFAULT );
358 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
361 return( LBER_DEFAULT );
364 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
367 return( LBER_DEFAULT );
370 *blen = datalen * 8 - unusedbits;
375 ber_get_null( BerElement *ber )
380 assert( ber != NULL );
381 assert( BER_VALID( ber ) );
383 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
384 return( LBER_DEFAULT );
387 return( LBER_DEFAULT );
400 assert( ber != NULL );
401 assert( boolval != NULL );
403 assert( BER_VALID( ber ) );
405 rc = ber_get_int( ber, &longbool );
417 assert( ber != NULL );
418 assert( len != NULL );
419 assert( last != NULL );
421 /* skip the sequence header, use the len to mark where to stop */
422 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
424 return( LBER_DEFAULT );
427 *last = ber->ber_ptr + *len;
429 if ( *last == ber->ber_ptr ) {
430 return( LBER_DEFAULT );
433 return( ber_peek_tag( ber, len ) );
440 LDAP_CONST 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 ) );
457 ber_scanf ( BerElement *ber,
458 LDAP_CONST char *fmt,
462 LDAP_CONST char *fmt_reset;
464 char *s, **ss, ***sss;
465 struct berval ***bv, **bvp, *bval;
475 assert( ber != NULL );
476 assert( fmt != NULL );
478 assert( BER_VALID( ber ) );
482 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
483 "ber_scanf fmt (%s) ber:\n", fmt );
484 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
486 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
487 /* When this is modified, remember to update
488 * the error-cleanup code below accordingly. */
490 case '!': { /* Hook */
491 BERDecodeCallback *f;
494 f = va_arg( ap, BERDecodeCallback * );
495 p = va_arg( ap, void * );
497 rc = (*f)( ber, p, 0 );
500 case 'a': /* octet string - allocate storage as needed */
501 ss = va_arg( ap, char ** );
502 rc = ber_get_stringa( ber, ss );
505 case 'b': /* boolean */
506 i = va_arg( ap, ber_int_t * );
507 rc = ber_get_boolean( ber, i );
510 case 'e': /* enumerated */
512 i = va_arg( ap, ber_int_t * );
513 rc = ber_get_int( ber, i );
516 case 'l': /* length of next item */
517 l = va_arg( ap, ber_len_t * );
518 rc = ber_peek_tag( ber, l );
522 rc = ber_get_null( ber );
525 case 's': /* octet string - in a buffer */
526 s = va_arg( ap, char * );
527 l = va_arg( ap, ber_len_t * );
528 rc = ber_get_stringb( ber, s, l );
531 case 'o': /* octet string in a supplied berval */
532 bval = va_arg( ap, struct berval * );
533 ber_peek_tag( ber, &bval->bv_len );
534 rc = ber_get_stringa( ber, &bval->bv_val );
537 case 'O': /* octet string - allocate & include length */
538 bvp = va_arg( ap, struct berval ** );
539 rc = ber_get_stringal( ber, bvp );
542 case 'B': /* bit string - allocate storage as needed */
543 ss = va_arg( ap, char ** );
544 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
545 rc = ber_get_bitstringa( ber, ss, l );
548 case 't': /* tag of next item */
549 t = va_arg( ap, ber_tag_t * );
550 *t = rc = ber_peek_tag( ber, &len );
553 case 'T': /* skip tag of next item */
554 t = va_arg( ap, ber_tag_t * );
555 *t = rc = ber_skip_tag( ber, &len );
558 case 'v': /* sequence of strings */
559 sss = va_arg( ap, char *** );
562 for ( tag = ber_first_element( ber, &len, &last );
563 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
564 tag = ber_next_element( ber, &len, last ) )
566 *sss = (char **) LBER_REALLOC( *sss,
567 (j + 2) * sizeof(char *) );
569 rc = ber_get_stringa( ber, &((*sss)[j]) );
576 case 'V': /* sequence of strings + lengths */
577 bv = va_arg( ap, struct berval *** );
580 for ( tag = ber_first_element( ber, &len, &last );
581 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
582 tag = ber_next_element( ber, &len, last ) )
584 *bv = (struct berval **) LBER_REALLOC( *bv,
585 (j + 2) * sizeof(struct berval *) );
587 rc = ber_get_stringal( ber, &((*bv)[j]) );
594 case 'x': /* skip the next element - whatever it is */
595 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
600 case '{': /* begin sequence */
601 case '[': /* begin set */
602 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
603 rc = ber_skip_tag( ber, &len );
606 case '}': /* end sequence */
607 case ']': /* end set */
611 if( ber->ber_debug ) {
612 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
613 "ber_scanf: unknown fmt %c\n", *fmt );
622 if ( rc == LBER_DEFAULT ) {
624 * Error. Reclaim malloced memory that was given to the caller.
625 * Set allocated pointers to NULL, "data length" outvalues to 0.
629 for ( ; fmt_reset < fmt; fmt_reset++ ) {
630 switch ( *fmt_reset ) {
631 case '!': { /* Hook */
632 BERDecodeCallback *f;
635 f = va_arg( ap, BERDecodeCallback * );
636 p = va_arg( ap, void * );
638 (void) (*f)( ber, p, 1 );
641 case 'a': /* octet string - allocate storage as needed */
642 ss = va_arg( ap, char ** );
649 case 'b': /* boolean */
650 case 'e': /* enumerated */
652 (void) va_arg( ap, int * );
655 case 's': /* octet string - in a buffer */
656 (void) va_arg( ap, char * );
657 (void) va_arg( ap, ber_len_t * );
660 case 'l': /* length of next item */
661 (void) va_arg( ap, ber_len_t * );
664 case 't': /* tag of next item */
665 case 'T': /* skip tag of next item */
666 (void) va_arg( ap, ber_tag_t * );
669 case 'o': /* octet string in a supplied berval */
670 bval = va_arg( ap, struct berval * );
671 if ( bval->bv_val != NULL ) {
672 LBER_FREE( bval->bv_val );
678 case 'O': /* octet string - allocate & include length */
679 bvp = va_arg( ap, struct berval ** );
686 case 'B': /* bit string - allocate storage as needed */
687 ss = va_arg( ap, char ** );
692 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
695 case 'v': /* sequence of strings */
696 sss = va_arg( ap, char *** );
698 for (j = 0; (*sss)[j]; j++) {
699 LBER_FREE( (*sss)[j] );
707 case 'V': /* sequence of strings + lengths */
708 bv = va_arg( ap, struct berval *** );
716 case 'x': /* skip the next element - whatever it is */
717 case '{': /* begin sequence */
718 case '[': /* begin set */
719 case '}': /* end sequence */
720 case ']': /* end set */
724 /* format should be good */