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( LBER_VALID( ber ) );
47 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 ) {
53 if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK ) {
57 for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
58 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 ) {
63 tag |= 0x00ffUL & (ber_tag_t) xbyte;
65 if ( ! (xbyte & LBER_MORE_TAG_MASK) ) {
71 if ( i == sizeof(ber_tag_t) ) {
79 ber_skip_tag( BerElement *ber, ber_len_t *len )
84 unsigned char netlen[sizeof(ber_len_t)];
86 assert( ber != NULL );
87 assert( len != NULL );
88 assert( LBER_VALID( ber ) );
91 * Any ber element looks like this: tag length contents.
92 * Assuming everything's ok, we return the tag byte (we
93 * can assume a single byte), and return the length in len.
97 * 2) primitive encodings used whenever possible
103 * First, we read the tag.
106 if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT ) {
111 * Next, read the length. The first byte contains the length of
112 * the length. If bit 8 is set, the length is the long form,
113 * otherwise it's the short form. We don't allow a length that's
114 * greater than what we can hold in a ber_len_t.
117 if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
121 noctets = (lc & 0x7fU);
123 if ( noctets > sizeof(ber_len_t) ) {
127 if( (unsigned) ber_read( ber, netlen, noctets ) != noctets ) {
131 for( i = 0; i < noctets; i++ ) {
140 /* BER length should be non-negative */
145 /* BER element should have enough data left */
146 if( *len > (ber_len_t) ber_pvt_ber_remaining( ber ) ) {
159 * This implementation assumes ber_skip_tag() only
160 * modifies ber_ptr field of the BerElement.
167 tag = ber_skip_tag( ber, len );
179 unsigned char buf[sizeof(ber_int_t)];
181 assert( ber != NULL );
182 assert( num != NULL );
183 assert( LBER_VALID( ber ) );
186 * The tag and length have already been stripped off. We should
187 * be sitting right before len bytes of 2's complement integer,
188 * ready to be read straight into an int. We may have to sign
189 * extend after we read it in.
192 if ( len > sizeof(ber_int_t) ) {
196 /* read into the low-order bytes of our buffer */
197 if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
202 /* sign extend if necessary */
204 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
206 /* shift in the bytes */
207 for( i=0 ; i<len; i++ ) {
208 netnum = (netnum << 8 ) | buf[i];
228 assert( ber != NULL );
229 assert( LBER_VALID( ber ) );
231 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
235 if ( ber_getnint( ber, num, len ) != len ) {
247 return ber_get_int( ber, num );
259 assert( ber != NULL );
260 assert( LBER_VALID( ber ) );
262 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
266 /* must fit within allocated space with termination */
267 if ( datalen >= *len ) {
271 if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen ) {
281 enum bgbvc { ChArray, BvArray, BvVec };
283 typedef struct bgbvr {
297 ber_get_stringbvr( bgbvr *b, int n )
302 b->tag = ber_next_element( b->ber, &b->len, b->last );
304 b->tag = ber_first_element( b->ber, &b->len, &b->last );
306 if ( b->tag == LBER_DEFAULT )
312 /* do the allocation */
315 *b->res.c = LBER_MALLOC( (n+1) * sizeof( char * ));
316 (*b->res.c)[n] = NULL;
319 *b->res.ba = LBER_MALLOC( (n+1) * sizeof( struct berval ));
320 (*b->res.ba)[n].bv_val = NULL;
323 *b->res.bv = LBER_MALLOC( (n+1) * sizeof( struct berval *));
324 (*b->res.bv)[n] = NULL;
330 if ( ber_get_stringbv( b->ber, &bv ) == LBER_DEFAULT )
333 b->tag = ber_get_stringbvr( b, n+1 );
336 /* store my result */
339 (*b->res.c)[n] = bv.bv_val;
342 (*b->res.ba)[n] = bv;
345 (*b->res.bv)[n] = ber_bvdup( &bv );
349 LBER_FREE( bv.bv_val );
355 ber_get_stringbv( BerElement *ber, struct berval *bv )
359 assert( ber != NULL );
360 assert( bv != NULL );
362 assert( LBER_VALID( ber ) );
364 if ( (tag = ber_skip_tag( ber, &bv->bv_len )) == LBER_DEFAULT ) {
369 if ( (bv->bv_val = (char *) LBER_MALLOC( bv->bv_len + 1 )) == NULL ) {
373 if ( bv->bv_len > 0 && (ber_len_t) ber_read( ber, bv->bv_val,
374 bv->bv_len ) != bv->bv_len ) {
375 LBER_FREE( bv->bv_val );
379 bv->bv_val[bv->bv_len] = '\0';
385 ber_get_stringa( BerElement *ber, char **buf )
390 assert( buf != NULL );
392 tag = ber_get_stringbv( ber, &bv );
399 ber_get_stringal( BerElement *ber, struct berval **bv )
403 assert( ber != NULL );
404 assert( bv != NULL );
406 *bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) );
411 tag = ber_get_stringbv( ber, *bv );
412 if ( tag == LBER_DEFAULT ) {
427 unsigned char unusedbits;
429 assert( ber != NULL );
430 assert( buf != NULL );
431 assert( blen != NULL );
433 assert( LBER_VALID( ber ) );
435 if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
441 if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL ) {
445 if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
451 if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
457 *blen = datalen * 8 - unusedbits;
462 ber_get_null( BerElement *ber )
467 assert( ber != NULL );
468 assert( LBER_VALID( ber ) );
470 if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
489 assert( ber != NULL );
490 assert( boolval != NULL );
492 assert( LBER_VALID( ber ) );
494 rc = ber_get_int( ber, &longbool );
506 assert( ber != NULL );
507 assert( len != NULL );
508 assert( last != NULL );
510 /* skip the sequence header, use the len to mark where to stop */
511 if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
516 *last = ber->ber_ptr + *len;
518 if ( *last == ber->ber_ptr ) {
522 return ber_peek_tag( ber, len );
529 LDAP_CONST char *last )
531 assert( ber != NULL );
532 assert( len != NULL );
533 assert( last != NULL );
535 assert( LBER_VALID( ber ) );
537 if ( ber->ber_ptr == last ) {
541 return ber_peek_tag( ber, len );
544 /* Hopefully no one sends vectors with more elements than this */
545 /* #define TMP_SLOTS 1024 */
549 ber_scanf ( BerElement *ber,
550 LDAP_CONST char *fmt,
554 LDAP_CONST char *fmt_reset;
556 char *s, **ss, ***sss;
557 struct berval ***bv, **bvp, *bval;
567 assert( ber != NULL );
568 assert( fmt != NULL );
570 assert( LBER_VALID( ber ) );
575 LDAP_LOG(( "liblber", LDAP_LEVEL_ENTRY, "ber_scanf fmt (%s) ber:\n", fmt ));
576 BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
578 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
579 "ber_scanf fmt (%s) ber:\n", fmt );
580 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
583 for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
584 /* When this is modified, remember to update
585 * the error-cleanup code below accordingly. */
587 case '!': { /* Hook */
588 BERDecodeCallback *f;
591 f = va_arg( ap, BERDecodeCallback * );
592 p = va_arg( ap, void * );
594 rc = (*f)( ber, p, 0 );
597 case 'a': /* octet string - allocate storage as needed */
598 ss = va_arg( ap, char ** );
599 rc = ber_get_stringa( ber, ss );
602 case 'b': /* boolean */
603 i = va_arg( ap, ber_int_t * );
604 rc = ber_get_boolean( ber, i );
607 case 'e': /* enumerated */
609 i = va_arg( ap, ber_int_t * );
610 rc = ber_get_int( ber, i );
613 case 'l': /* length of next item */
614 l = va_arg( ap, ber_len_t * );
615 rc = ber_peek_tag( ber, l );
619 rc = ber_get_null( ber );
622 case 's': /* octet string - in a buffer */
623 s = va_arg( ap, char * );
624 l = va_arg( ap, ber_len_t * );
625 rc = ber_get_stringb( ber, s, l );
628 case 'o': /* octet string in a supplied berval */
629 bval = va_arg( ap, struct berval * );
630 rc = ber_get_stringbv( ber, bval );
633 case 'O': /* octet string - allocate & include length */
634 bvp = va_arg( ap, struct berval ** );
635 rc = ber_get_stringal( ber, bvp );
638 case 'B': /* bit string - allocate storage as needed */
639 ss = va_arg( ap, char ** );
640 l = va_arg( ap, ber_len_t * ); /* for length, in bits */
641 rc = ber_get_bitstringa( ber, ss, l );
644 case 't': /* tag of next item */
645 t = va_arg( ap, ber_tag_t * );
646 *t = rc = ber_peek_tag( ber, &len );
649 case 'T': /* skip tag of next item */
650 t = va_arg( ap, ber_tag_t * );
651 *t = rc = ber_skip_tag( ber, &len );
654 case 'v': /* sequence of strings */
657 char *tmp[TMP_SLOTS];
658 sss = va_arg( ap, char *** );
661 for ( tag = ber_first_element( ber, &len, &last );
662 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
663 tag = ber_next_element( ber, &len, last ) )
665 rc = ber_get_stringa( ber, &tmp[j] );
667 assert(j < TMP_SLOTS);
669 if (j > 0 && rc != LBER_DEFAULT ) {
670 *sss = (char **)LBER_MALLOC( (j+1) * sizeof(char *));
679 if ( rc == LBER_DEFAULT ) {
684 bgbvr cookie = { ber, ChArray };
685 cookie.res.c = va_arg( ap, char *** );
686 rc = ber_get_stringbvr( &cookie, 0 );
691 case 'V': /* sequence of strings + lengths */
694 struct berval *tmp[TMP_SLOTS];
695 bv = va_arg( ap, struct berval *** );
698 for ( tag = ber_first_element( ber, &len, &last );
699 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
700 tag = ber_next_element( ber, &len, last ) )
702 rc = ber_get_stringal( ber, &tmp[j] );
704 assert( j < TMP_SLOTS);
706 if (j > 0 && rc != LBER_DEFAULT ) {
707 *bv = (struct berval **)LBER_MALLOC( (j+1) * sizeof(struct berval *));
716 if ( rc == LBER_DEFAULT ) {
721 bgbvr cookie = { ber, BvVec };
722 cookie.res.bv = va_arg( ap, struct berval *** );
723 rc = ber_get_stringbvr( &cookie, 0 );
728 case 'W': /* bvarray */
731 struct berval tmp[TMP_SLOTS];
732 bvp = va_arg( ap, struct berval ** );
735 for ( tag = ber_first_element( ber, &len, &last );
736 tag != LBER_DEFAULT && rc != LBER_DEFAULT;
737 tag = ber_next_element( ber, &len, last ) )
739 rc = ber_get_stringbv( ber, &tmp[j] );
741 assert( j < TMP_SLOTS);
743 if (j > 0 && rc != LBER_DEFAULT ) {
744 *bvp = (struct berval *)LBER_MALLOC( (j+1) * sizeof(struct berval));
748 (*bvp)[j].bv_val = NULL;
749 (*bvp)[j].bv_len = 0;
754 if ( rc == LBER_DEFAULT ) {
756 LBER_FREE(tmp[j].bv_val);
759 bgbvr cookie = { ber, BvArray };
760 cookie.res.ba = va_arg( ap, struct berval ** );
761 rc = ber_get_stringbvr( &cookie, 0 );
766 case 'x': /* skip the next element - whatever it is */
767 if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
772 case '{': /* begin sequence */
773 case '[': /* begin set */
774 if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V'
775 && *(fmt + 1) != 'W' )
776 rc = ber_skip_tag( ber, &len );
779 case '}': /* end sequence */
780 case ']': /* end set */
784 if( ber->ber_debug ) {
786 LDAP_LOG(( "liblber", LDAP_LEVEL_ERR,
787 "ber_scanf: unknown fmt %c\n", *fmt ));
789 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
790 "ber_scanf: unknown fmt %c\n", *fmt );
799 if ( rc == LBER_DEFAULT ) {
801 * Error. Reclaim malloced memory that was given to the caller.
802 * Set allocated pointers to NULL, "data length" outvalues to 0.
806 for ( ; fmt_reset < fmt; fmt_reset++ ) {
807 switch ( *fmt_reset ) {
808 case '!': { /* Hook */
809 BERDecodeCallback *f;
812 f = va_arg( ap, BERDecodeCallback * );
813 p = va_arg( ap, void * );
815 (void) (*f)( ber, p, 1 );
818 case 'a': /* octet string - allocate storage as needed */
819 ss = va_arg( ap, char ** );
826 case 'b': /* boolean */
827 case 'e': /* enumerated */
829 (void) va_arg( ap, int * );
832 case 's': /* octet string - in a buffer */
833 (void) va_arg( ap, char * );
834 (void) va_arg( ap, ber_len_t * );
837 case 'l': /* length of next item */
838 (void) va_arg( ap, ber_len_t * );
841 case 't': /* tag of next item */
842 case 'T': /* skip tag of next item */
843 (void) va_arg( ap, ber_tag_t * );
846 case 'o': /* octet string in a supplied berval */
847 bval = va_arg( ap, struct berval * );
848 if ( bval->bv_val != NULL ) {
849 LBER_FREE( bval->bv_val );
855 case 'O': /* octet string - allocate & include length */
856 bvp = va_arg( ap, struct berval ** );
863 case 'B': /* bit string - allocate storage as needed */
864 ss = va_arg( ap, char ** );
869 *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
872 case 'v': /* sequence of strings */
873 case 'V': /* sequence of strings + lengths */
874 case 'W': /* BVarray */
876 case 'x': /* skip the next element - whatever it is */
877 case '{': /* begin sequence */
878 case '[': /* begin set */
879 case '}': /* end sequence */
880 case ']': /* end set */
884 /* format should be good */