]> git.sur5r.net Git - openldap/blob - libraries/liblber/decode.c
More contrib cleanout
[openldap] / libraries / liblber / decode.c
1 /* decode.c - ber input decoding routines */
2 /* $OpenLDAP$ */
3 /*
4  * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6  */
7 /* Portions
8  * Copyright (c) 1990 Regents of the University of Michigan.
9  * All rights reserved.
10  *
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.
17  */
18
19 #include "portable.h"
20
21 #include <stdio.h>
22
23 #include <ac/stdlib.h>
24
25 #include <ac/stdarg.h>
26 #include <ac/string.h>
27 #include <ac/socket.h>
28
29 #include "lber-int.h"
30
31 static ber_len_t ber_getnint LDAP_P((
32         BerElement *ber,
33         ber_int_t *num,
34         ber_len_t len ));
35
36 /* return the tag - LBER_DEFAULT returned means trouble */
37 ber_tag_t
38 ber_get_tag( BerElement *ber )
39 {
40         unsigned char   xbyte;
41         ber_tag_t       tag;
42         unsigned int    i;
43
44         assert( ber != NULL );
45         assert( BER_VALID( ber ) );
46
47         if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 ) {
48                 return LBER_DEFAULT;
49         }
50
51         tag = xbyte;
52
53         if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK ) {
54                 return tag;
55         }
56
57         for ( i = 1; i < sizeof(ber_tag_t); i++ ) {
58                 if ( ber_read( ber, (char *) &xbyte, 1 ) != 1 ) {
59                         return LBER_DEFAULT;
60                 }
61
62                 tag <<= 8;
63                 tag |= 0x00ffUL & (ber_tag_t) xbyte;
64
65                 if ( ! (xbyte & LBER_MORE_TAG_MASK) ) {
66                         break;
67                 }
68         }
69
70         /* tag too big! */
71         if ( i == sizeof(ber_tag_t) ) {
72                 return LBER_DEFAULT;
73         }
74
75         return tag;
76 }
77
78 ber_tag_t
79 ber_skip_tag( BerElement *ber, ber_len_t *len )
80 {
81         ber_tag_t       tag;
82         unsigned char   lc;
83         ber_len_t       i, noctets;
84         unsigned char netlen[sizeof(ber_len_t)];
85
86         assert( ber != NULL );
87         assert( len != NULL );
88         assert( BER_VALID( ber ) );
89
90         /*
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.
94          *
95          * Assumptions:
96          *      1) definite lengths
97          *      2) primitive encodings used whenever possible
98          */
99
100         *len = 0;
101
102         /*
103          * First, we read the tag.
104          */
105
106         if ( (tag = ber_get_tag( ber )) == LBER_DEFAULT ) {
107                 return LBER_DEFAULT;
108         }
109
110         /*
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.
115          */
116
117         if ( ber_read( ber, (char *) &lc, 1 ) != 1 )
118                 return LBER_DEFAULT;
119
120         if ( lc & 0x80U ) {
121                 noctets = (lc & 0x7fU);
122
123                 if ( noctets > sizeof(ber_len_t) ) {
124                         return LBER_DEFAULT;
125                 }
126
127                 if( (unsigned) ber_read( ber, netlen, noctets ) != noctets ) {
128                         return LBER_DEFAULT;
129                 }
130
131                 for( i = 0; i < noctets; i++ ) {
132                         *len <<= 8;
133                         *len |= netlen[i];
134                 }
135
136         } else {
137                 *len = lc;
138         }
139
140         /* BER element should have enough data left */
141         if( *len > ber_pvt_ber_remaining( ber ) ) {
142                 return LBER_DEFAULT;
143         }
144
145         return tag;
146 }
147
148 ber_tag_t
149 ber_peek_tag(
150         BerElement *ber,
151         ber_len_t *len )
152 {
153         /*
154          * This implementation assumes ber_skip_tag() only
155          * modifies ber_ptr field of the BerElement.
156          */
157
158         char *save;
159         ber_tag_t       tag;
160
161         save = ber->ber_ptr;
162         tag = ber_skip_tag( ber, len );
163         ber->ber_ptr = save;
164
165         return tag;
166 }
167
168 static ber_len_t
169 ber_getnint(
170         BerElement *ber,
171         ber_int_t *num,
172         ber_len_t len )
173 {
174         unsigned char buf[sizeof(ber_int_t)];
175
176         assert( ber != NULL );
177         assert( num != NULL );
178         assert( BER_VALID( ber ) );
179
180         /*
181          * The tag and length have already been stripped off.  We should
182          * be sitting right before len bytes of 2's complement integer,
183          * ready to be read straight into an int.  We may have to sign
184          * extend after we read it in.
185          */
186
187         if ( len > sizeof(ber_int_t) ) {
188                 return -1;
189         }
190
191         /* read into the low-order bytes of our buffer */
192         if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
193                 return -1;
194         }
195
196         if( len ) {
197                 /* sign extend if necessary */
198                 ber_len_t i;
199                 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
200
201                 /* shift in the bytes */
202                 for( i=0 ; i<len; i++ ) {
203                         netnum = (netnum << 8 ) | buf[i];
204                 }
205
206                 *num = netnum;
207
208         } else {
209                 *num = 0;
210         }
211
212         return len;
213 }
214
215 ber_tag_t
216 ber_get_int(
217         BerElement *ber,
218         ber_int_t *num )
219 {
220         ber_tag_t       tag;
221         ber_len_t       len;
222
223         assert( ber != NULL );
224         assert( BER_VALID( ber ) );
225
226         if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
227                 return LBER_DEFAULT;
228         }
229
230         if ( ber_getnint( ber, num, len ) != len ) {
231                 return LBER_DEFAULT;
232         }
233         
234         return tag;
235 }
236
237 ber_tag_t
238 ber_get_enum(
239         BerElement *ber,
240         ber_int_t *num )
241 {
242         return ber_get_int( ber, num );
243 }
244
245 ber_tag_t
246 ber_get_stringb(
247         BerElement *ber,
248         char *buf,
249         ber_len_t *len )
250 {
251         ber_len_t       datalen;
252         ber_tag_t       tag;
253
254         assert( ber != NULL );
255         assert( BER_VALID( ber ) );
256
257         if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
258                 return LBER_DEFAULT;
259         }
260
261         /* must fit within allocated space with termination */
262         if ( datalen >= *len ) {
263                 return LBER_DEFAULT;
264         }
265
266         if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen ) {
267                 return LBER_DEFAULT;
268         }
269
270         buf[datalen] = '\0';
271
272         *len = datalen;
273         return tag;
274 }
275
276 ber_tag_t
277 ber_get_stringa( BerElement *ber, char **buf )
278 {
279         ber_len_t       datalen;
280         ber_tag_t       tag;
281
282         assert( ber != NULL );
283         assert( buf != NULL );
284
285         assert( BER_VALID( ber ) );
286
287         if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
288                 *buf = NULL;
289                 return LBER_DEFAULT;
290         }
291
292         if ( (*buf = (char *) LBER_MALLOC( datalen + 1 )) == NULL ) {
293                 return LBER_DEFAULT;
294         }
295
296         if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
297                 LBER_FREE( *buf );
298                 *buf = NULL;
299                 return LBER_DEFAULT;
300         }
301         (*buf)[datalen] = '\0';
302
303         return tag;
304 }
305
306 ber_tag_t
307 ber_get_stringal( BerElement *ber, struct berval **bv )
308 {
309         ber_len_t       len;
310         ber_tag_t       tag;
311
312         assert( ber != NULL );
313         assert( bv != NULL );
314
315         assert( BER_VALID( ber ) );
316
317         if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
318                 *bv = NULL;
319                 return LBER_DEFAULT;
320         }
321
322         *bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) );
323         if ( *bv == NULL ) {
324                 return LBER_DEFAULT;
325         }
326
327         if( len == 0 ) {
328                 (*bv)->bv_val = NULL;
329                 (*bv)->bv_len = 0;
330                 return tag;
331         }
332
333         (*bv)->bv_val = (char *) LBER_MALLOC( len + 1 );
334         if ( (*bv)->bv_val == NULL ) {
335                 LBER_FREE( *bv );
336                 *bv = NULL;
337                 return LBER_DEFAULT;
338         }
339
340         if ( (ber_len_t) ber_read( ber, (*bv)->bv_val, len ) != len ) {
341                 ber_bvfree( *bv );
342                 *bv = NULL;
343                 return LBER_DEFAULT;
344         }
345
346         ((*bv)->bv_val)[len] = '\0';
347         (*bv)->bv_len = len;
348
349         return tag;
350 }
351
352 ber_tag_t
353 ber_get_bitstringa(
354         BerElement *ber,
355         char **buf,
356         ber_len_t *blen )
357 {
358         ber_len_t       datalen;
359         ber_tag_t       tag;
360         unsigned char   unusedbits;
361
362         assert( ber != NULL );
363         assert( buf != NULL );
364         assert( blen != NULL );
365
366         assert( BER_VALID( ber ) );
367
368         if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
369                 *buf = NULL;
370                 return LBER_DEFAULT;
371         }
372         --datalen;
373
374         if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL ) {
375                 return LBER_DEFAULT;
376         }
377
378         if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
379                 LBER_FREE( buf );
380                 *buf = NULL;
381                 return LBER_DEFAULT;
382         }
383
384         if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
385                 LBER_FREE( buf );
386                 *buf = NULL;
387                 return LBER_DEFAULT;
388         }
389
390         *blen = datalen * 8 - unusedbits;
391         return tag;
392 }
393
394 ber_tag_t
395 ber_get_null( BerElement *ber )
396 {
397         ber_len_t       len;
398         ber_tag_t       tag;
399
400         assert( ber != NULL );
401         assert( BER_VALID( ber ) );
402
403         if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
404                 return LBER_DEFAULT;
405         }
406
407         if ( len != 0 ) {
408                 return LBER_DEFAULT;
409         }
410
411         return( tag );
412 }
413
414 ber_tag_t
415 ber_get_boolean(
416         BerElement *ber,
417         ber_int_t *boolval )
418 {
419         ber_int_t       longbool;
420         ber_tag_t       rc;
421
422         assert( ber != NULL );
423         assert( boolval != NULL );
424
425         assert( BER_VALID( ber ) );
426
427         rc = ber_get_int( ber, &longbool );
428         *boolval = longbool;
429
430         return rc;
431 }
432
433 ber_tag_t
434 ber_first_element(
435         BerElement *ber,
436         ber_len_t *len,
437         char **last )
438 {
439         assert( ber != NULL );
440         assert( len != NULL );
441         assert( last != NULL );
442
443         /* skip the sequence header, use the len to mark where to stop */
444         if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
445                 *last = NULL;
446                 return LBER_DEFAULT;
447         }
448
449         *last = ber->ber_ptr + *len;
450
451         if ( *last == ber->ber_ptr ) {
452                 return LBER_DEFAULT;
453         }
454
455         return ber_peek_tag( ber, len );
456 }
457
458 ber_tag_t
459 ber_next_element(
460         BerElement *ber,
461         ber_len_t *len,
462         LDAP_CONST char *last )
463 {
464         assert( ber != NULL );
465         assert( len != NULL );
466         assert( last != NULL );
467
468         assert( BER_VALID( ber ) );
469
470         if ( ber->ber_ptr == last ) {
471                 return LBER_DEFAULT;
472         }
473
474         return ber_peek_tag( ber, len );
475 }
476
477 /* VARARGS */
478 ber_tag_t
479 ber_scanf ( BerElement *ber,
480         LDAP_CONST char *fmt,
481         ... )
482 {
483         va_list         ap;
484         LDAP_CONST char         *fmt_reset;
485         char            *last;
486         char            *s, **ss, ***sss;
487         struct berval   ***bv, **bvp, *bval;
488         ber_int_t       *i;
489         int j;
490         ber_len_t       *l;
491         ber_tag_t       *t;
492         ber_tag_t       rc, tag;
493         ber_len_t       len;
494
495         va_start( ap, fmt );
496
497         assert( ber != NULL );
498         assert( fmt != NULL );
499
500         assert( BER_VALID( ber ) );
501
502         fmt_reset = fmt;
503
504 #ifdef NEW_LOGGING
505         LDAP_LOG(( "liblber", LDAP_LEVEL_ENTRY, "ber_scanf fmt (%s) ber:\n", fmt ));
506         BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
507 #else
508         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
509                 "ber_scanf fmt (%s) ber:\n", fmt );
510         ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
511 #endif
512
513         for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
514                 /* When this is modified, remember to update
515                  * the error-cleanup code below accordingly. */
516                 switch ( *fmt ) {
517                 case '!': { /* Hook */
518                                 BERDecodeCallback *f;
519                                 void *p;
520
521                                 f = va_arg( ap, BERDecodeCallback * );
522                                 p = va_arg( ap, void * );
523
524                                 rc = (*f)( ber, p, 0 );
525                         } break;
526
527                 case 'a':       /* octet string - allocate storage as needed */
528                         ss = va_arg( ap, char ** );
529                         rc = ber_get_stringa( ber, ss );
530                         break;
531
532                 case 'b':       /* boolean */
533                         i = va_arg( ap, ber_int_t * );
534                         rc = ber_get_boolean( ber, i );
535                         break;
536
537                 case 'e':       /* enumerated */
538                 case 'i':       /* int */
539                         i = va_arg( ap, ber_int_t * );
540                         rc = ber_get_int( ber, i );
541                         break;
542
543                 case 'l':       /* length of next item */
544                         l = va_arg( ap, ber_len_t * );
545                         rc = ber_peek_tag( ber, l );
546                         break;
547
548                 case 'n':       /* null */
549                         rc = ber_get_null( ber );
550                         break;
551
552                 case 's':       /* octet string - in a buffer */
553                         s = va_arg( ap, char * );
554                         l = va_arg( ap, ber_len_t * );
555                         rc = ber_get_stringb( ber, s, l );
556                         break;
557
558                 case 'o':       /* octet string in a supplied berval */
559                         bval = va_arg( ap, struct berval * );
560                         ber_peek_tag( ber, &bval->bv_len );
561                         rc = ber_get_stringa( ber, &bval->bv_val );
562                         break;
563
564                 case 'O':       /* octet string - allocate & include length */
565                         bvp = va_arg( ap, struct berval ** );
566                         rc = ber_get_stringal( ber, bvp );
567                         break;
568
569                 case 'B':       /* bit string - allocate storage as needed */
570                         ss = va_arg( ap, char ** );
571                         l = va_arg( ap, ber_len_t * ); /* for length, in bits */
572                         rc = ber_get_bitstringa( ber, ss, l );
573                         break;
574
575                 case 't':       /* tag of next item */
576                         t = va_arg( ap, ber_tag_t * );
577                         *t = rc = ber_peek_tag( ber, &len );
578                         break;
579
580                 case 'T':       /* skip tag of next item */
581                         t = va_arg( ap, ber_tag_t * );
582                         *t = rc = ber_skip_tag( ber, &len );
583                         break;
584
585                 case 'v':       /* sequence of strings */
586                         sss = va_arg( ap, char *** );
587                         *sss = NULL;
588                         j = 0;
589                         for ( tag = ber_first_element( ber, &len, &last );
590                             tag != LBER_DEFAULT && rc != LBER_DEFAULT;
591                             tag = ber_next_element( ber, &len, last ) )
592                         {
593                                 *sss = (char **) LBER_REALLOC( *sss,
594                                         (j + 2) * sizeof(char *) );
595
596                                 rc = ber_get_stringa( ber, &((*sss)[j]) );
597                                 j++;
598                         }
599                         if ( j > 0 )
600                                 (*sss)[j] = NULL;
601                         break;
602
603                 case 'V':       /* sequence of strings + lengths */
604                         bv = va_arg( ap, struct berval *** );
605                         *bv = NULL;
606                         j = 0;
607                         for ( tag = ber_first_element( ber, &len, &last );
608                             tag != LBER_DEFAULT && rc != LBER_DEFAULT;
609                             tag = ber_next_element( ber, &len, last ) )
610                         {
611                                 *bv = (struct berval **) LBER_REALLOC( *bv,
612                                         (j + 2) * sizeof(struct berval *) );
613                 
614                                 rc = ber_get_stringal( ber, &((*bv)[j]) );
615                                 j++;
616                         }
617                         if ( j > 0 )
618                                 (*bv)[j] = NULL;
619                         break;
620
621                 case 'x':       /* skip the next element - whatever it is */
622                         if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
623                                 break;
624                         ber->ber_ptr += len;
625                         break;
626
627                 case '{':       /* begin sequence */
628                 case '[':       /* begin set */
629                         if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
630                                 rc = ber_skip_tag( ber, &len );
631                         break;
632
633                 case '}':       /* end sequence */
634                 case ']':       /* end set */
635                         break;
636
637                 default:
638                         if( ber->ber_debug ) {
639 #ifdef NEW_LOGGING
640                                 LDAP_LOG(( "liblber", LDAP_LEVEL_ERR,
641                                            "ber_scanf: unknown fmt %c\n", *fmt ));
642 #else
643                                 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
644                                         "ber_scanf: unknown fmt %c\n", *fmt );
645 #endif
646                         }
647                         rc = LBER_DEFAULT;
648                         break;
649                 }
650         }
651
652         va_end( ap );
653
654         if ( rc == LBER_DEFAULT ) {
655             /*
656              * Error.  Reclaim malloced memory that was given to the caller.
657              * Set allocated pointers to NULL, "data length" outvalues to 0.
658              */
659             va_start( ap, fmt );
660
661             for ( ; fmt_reset < fmt; fmt_reset++ ) {
662                 switch ( *fmt_reset ) {
663                 case '!': { /* Hook */
664                                 BERDecodeCallback *f;
665                                 void *p;
666
667                                 f = va_arg( ap, BERDecodeCallback * );
668                                 p = va_arg( ap, void * );
669
670                                 (void) (*f)( ber, p, 1 );
671                         } break;
672
673                 case 'a':       /* octet string - allocate storage as needed */
674                         ss = va_arg( ap, char ** );
675                         if ( *ss ) {
676                                 LBER_FREE( *ss );
677                                 *ss = NULL;
678                         }
679                         break;
680
681                 case 'b':       /* boolean */
682                 case 'e':       /* enumerated */
683                 case 'i':       /* int */
684                         (void) va_arg( ap, int * );
685                         break;
686
687                 case 's':       /* octet string - in a buffer */
688                         (void) va_arg( ap, char * );
689                         (void) va_arg( ap, ber_len_t * );
690                         break;
691
692                 case 'l':       /* length of next item */
693                         (void) va_arg( ap, ber_len_t * );
694                         break;
695
696                 case 't':       /* tag of next item */
697                 case 'T':       /* skip tag of next item */
698                         (void) va_arg( ap, ber_tag_t * );
699                         break;
700
701                 case 'o':       /* octet string in a supplied berval */
702                         bval = va_arg( ap, struct berval * );
703                         if ( bval->bv_val != NULL ) {
704                                 LBER_FREE( bval->bv_val );
705                                 bval->bv_val = NULL;
706                         }
707                         bval->bv_len = 0;
708                         break;
709
710                 case 'O':       /* octet string - allocate & include length */
711                         bvp = va_arg( ap, struct berval ** );
712                         if ( *bvp ) {
713                                 ber_bvfree( *bvp );
714                                 *bvp = NULL;
715                         }
716                         break;
717
718                 case 'B':       /* bit string - allocate storage as needed */
719                         ss = va_arg( ap, char ** );
720                         if ( *ss ) {
721                                 LBER_FREE( *ss );
722                                 *ss = NULL;
723                         }
724                         *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
725                         break;
726
727                 case 'v':       /* sequence of strings */
728                         sss = va_arg( ap, char *** );
729                         if ( *sss ) {
730                                 for (j = 0;  (*sss)[j];  j++) {
731                                         LBER_FREE( (*sss)[j] );
732                                         (*sss)[j] = NULL;
733                                 }
734                                 LBER_FREE( *sss );
735                                 *sss = NULL;
736                         }
737                         break;
738
739                 case 'V':       /* sequence of strings + lengths */
740                         bv = va_arg( ap, struct berval *** );
741                         if ( *bv ) {
742                                 ber_bvecfree( *bv );
743                                 *bv = NULL;
744                         }
745                         break;
746
747                 case 'n':       /* null */
748                 case 'x':       /* skip the next element - whatever it is */
749                 case '{':       /* begin sequence */
750                 case '[':       /* begin set */
751                 case '}':       /* end sequence */
752                 case ']':       /* end set */
753                         break;
754
755                 default:
756                         /* format should be good */
757                         assert( 0 );
758                 }
759             }
760
761             va_end( ap );
762         }
763
764         return rc;
765 }