]> git.sur5r.net Git - openldap/blob - libraries/liblber/decode.c
Use e_nname.bv_len
[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( LBER_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( LBER_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 length should be non-negative */
141         if( *len < 0 ) {
142                 return LBER_DEFAULT;
143         }
144
145         /* BER element should have enough data left */
146         if( *len > (ber_len_t) ber_pvt_ber_remaining( ber ) ) {
147                 return LBER_DEFAULT;
148         }
149
150         return tag;
151 }
152
153 ber_tag_t
154 ber_peek_tag(
155         BerElement *ber,
156         ber_len_t *len )
157 {
158         /*
159          * This implementation assumes ber_skip_tag() only
160          * modifies ber_ptr field of the BerElement.
161          */
162
163         char *save;
164         ber_tag_t       tag;
165
166         save = ber->ber_ptr;
167         tag = ber_skip_tag( ber, len );
168         ber->ber_ptr = save;
169
170         return tag;
171 }
172
173 static ber_len_t
174 ber_getnint(
175         BerElement *ber,
176         ber_int_t *num,
177         ber_len_t len )
178 {
179         unsigned char buf[sizeof(ber_int_t)];
180
181         assert( ber != NULL );
182         assert( num != NULL );
183         assert( LBER_VALID( ber ) );
184
185         /*
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.
190          */
191
192         if ( len > sizeof(ber_int_t) ) {
193                 return -1;
194         }
195
196         /* read into the low-order bytes of our buffer */
197         if ( (ber_len_t) ber_read( ber, (char *) buf, len ) != len ) {
198                 return -1;
199         }
200
201         if( len ) {
202                 /* sign extend if necessary */
203                 ber_len_t i;
204                 ber_int_t netnum = 0x80 & buf[0] ? -1 : 0;
205
206                 /* shift in the bytes */
207                 for( i=0 ; i<len; i++ ) {
208                         netnum = (netnum << 8 ) | buf[i];
209                 }
210
211                 *num = netnum;
212
213         } else {
214                 *num = 0;
215         }
216
217         return len;
218 }
219
220 ber_tag_t
221 ber_get_int(
222         BerElement *ber,
223         ber_int_t *num )
224 {
225         ber_tag_t       tag;
226         ber_len_t       len;
227
228         assert( ber != NULL );
229         assert( LBER_VALID( ber ) );
230
231         if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
232                 return LBER_DEFAULT;
233         }
234
235         if ( ber_getnint( ber, num, len ) != len ) {
236                 return LBER_DEFAULT;
237         }
238         
239         return tag;
240 }
241
242 ber_tag_t
243 ber_get_enum(
244         BerElement *ber,
245         ber_int_t *num )
246 {
247         return ber_get_int( ber, num );
248 }
249
250 ber_tag_t
251 ber_get_stringb(
252         BerElement *ber,
253         char *buf,
254         ber_len_t *len )
255 {
256         ber_len_t       datalen;
257         ber_tag_t       tag;
258
259         assert( ber != NULL );
260         assert( LBER_VALID( ber ) );
261
262         if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
263                 return LBER_DEFAULT;
264         }
265
266         /* must fit within allocated space with termination */
267         if ( datalen >= *len ) {
268                 return LBER_DEFAULT;
269         }
270
271         if ( (ber_len_t) ber_read( ber, buf, datalen ) != datalen ) {
272                 return LBER_DEFAULT;
273         }
274
275         buf[datalen] = '\0';
276
277         *len = datalen;
278         return tag;
279 }
280
281 ber_tag_t
282 ber_get_stringa( BerElement *ber, char **buf )
283 {
284         ber_len_t       datalen;
285         ber_tag_t       tag;
286
287         assert( ber != NULL );
288         assert( buf != NULL );
289
290         assert( LBER_VALID( ber ) );
291
292         if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
293                 *buf = NULL;
294                 return LBER_DEFAULT;
295         }
296
297         if ( (*buf = (char *) LBER_MALLOC( datalen + 1 )) == NULL ) {
298                 return LBER_DEFAULT;
299         }
300
301         if ( datalen > 0 && (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
302                 LBER_FREE( *buf );
303                 *buf = NULL;
304                 return LBER_DEFAULT;
305         }
306         (*buf)[datalen] = '\0';
307
308         return tag;
309 }
310
311 ber_tag_t
312 ber_get_stringal( BerElement *ber, struct berval **bv )
313 {
314         ber_len_t       len;
315         ber_tag_t       tag;
316
317         assert( ber != NULL );
318         assert( bv != NULL );
319
320         assert( LBER_VALID( ber ) );
321
322         if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
323                 *bv = NULL;
324                 return LBER_DEFAULT;
325         }
326
327         *bv = (struct berval *) LBER_MALLOC( sizeof(struct berval) );
328         if ( *bv == NULL ) {
329                 return LBER_DEFAULT;
330         }
331
332         if( len == 0 ) {
333                 (*bv)->bv_val = NULL;
334                 (*bv)->bv_len = 0;
335                 return tag;
336         }
337
338         (*bv)->bv_val = (char *) LBER_MALLOC( len + 1 );
339         if ( (*bv)->bv_val == NULL ) {
340                 LBER_FREE( *bv );
341                 *bv = NULL;
342                 return LBER_DEFAULT;
343         }
344
345         if ( (ber_len_t) ber_read( ber, (*bv)->bv_val, len ) != len ) {
346                 ber_bvfree( *bv );
347                 *bv = NULL;
348                 return LBER_DEFAULT;
349         }
350
351         ((*bv)->bv_val)[len] = '\0';
352         (*bv)->bv_len = len;
353
354         return tag;
355 }
356
357 ber_tag_t
358 ber_get_bitstringa(
359         BerElement *ber,
360         char **buf,
361         ber_len_t *blen )
362 {
363         ber_len_t       datalen;
364         ber_tag_t       tag;
365         unsigned char   unusedbits;
366
367         assert( ber != NULL );
368         assert( buf != NULL );
369         assert( blen != NULL );
370
371         assert( LBER_VALID( ber ) );
372
373         if ( (tag = ber_skip_tag( ber, &datalen )) == LBER_DEFAULT ) {
374                 *buf = NULL;
375                 return LBER_DEFAULT;
376         }
377         --datalen;
378
379         if ( (*buf = (char *) LBER_MALLOC( datalen )) == NULL ) {
380                 return LBER_DEFAULT;
381         }
382
383         if ( ber_read( ber, (char *)&unusedbits, 1 ) != 1 ) {
384                 LBER_FREE( buf );
385                 *buf = NULL;
386                 return LBER_DEFAULT;
387         }
388
389         if ( (ber_len_t) ber_read( ber, *buf, datalen ) != datalen ) {
390                 LBER_FREE( buf );
391                 *buf = NULL;
392                 return LBER_DEFAULT;
393         }
394
395         *blen = datalen * 8 - unusedbits;
396         return tag;
397 }
398
399 ber_tag_t
400 ber_get_null( BerElement *ber )
401 {
402         ber_len_t       len;
403         ber_tag_t       tag;
404
405         assert( ber != NULL );
406         assert( LBER_VALID( ber ) );
407
408         if ( (tag = ber_skip_tag( ber, &len )) == LBER_DEFAULT ) {
409                 return LBER_DEFAULT;
410         }
411
412         if ( len != 0 ) {
413                 return LBER_DEFAULT;
414         }
415
416         return( tag );
417 }
418
419 ber_tag_t
420 ber_get_boolean(
421         BerElement *ber,
422         ber_int_t *boolval )
423 {
424         ber_int_t       longbool;
425         ber_tag_t       rc;
426
427         assert( ber != NULL );
428         assert( boolval != NULL );
429
430         assert( LBER_VALID( ber ) );
431
432         rc = ber_get_int( ber, &longbool );
433         *boolval = longbool;
434
435         return rc;
436 }
437
438 ber_tag_t
439 ber_first_element(
440         BerElement *ber,
441         ber_len_t *len,
442         char **last )
443 {
444         assert( ber != NULL );
445         assert( len != NULL );
446         assert( last != NULL );
447
448         /* skip the sequence header, use the len to mark where to stop */
449         if ( ber_skip_tag( ber, len ) == LBER_DEFAULT ) {
450                 *last = NULL;
451                 return LBER_DEFAULT;
452         }
453
454         *last = ber->ber_ptr + *len;
455
456         if ( *last == ber->ber_ptr ) {
457                 return LBER_DEFAULT;
458         }
459
460         return ber_peek_tag( ber, len );
461 }
462
463 ber_tag_t
464 ber_next_element(
465         BerElement *ber,
466         ber_len_t *len,
467         LDAP_CONST char *last )
468 {
469         assert( ber != NULL );
470         assert( len != NULL );
471         assert( last != NULL );
472
473         assert( LBER_VALID( ber ) );
474
475         if ( ber->ber_ptr == last ) {
476                 return LBER_DEFAULT;
477         }
478
479         return ber_peek_tag( ber, len );
480 }
481
482 /* VARARGS */
483 ber_tag_t
484 ber_scanf ( BerElement *ber,
485         LDAP_CONST char *fmt,
486         ... )
487 {
488         va_list         ap;
489         LDAP_CONST char         *fmt_reset;
490         char            *last;
491         char            *s, **ss, ***sss;
492         struct berval   ***bv, **bvp, *bval;
493         ber_int_t       *i;
494         int j;
495         ber_len_t       *l;
496         ber_tag_t       *t;
497         ber_tag_t       rc, tag;
498         ber_len_t       len;
499
500         va_start( ap, fmt );
501
502         assert( ber != NULL );
503         assert( fmt != NULL );
504
505         assert( LBER_VALID( ber ) );
506
507         fmt_reset = fmt;
508
509 #ifdef NEW_LOGGING
510         LDAP_LOG(( "liblber", LDAP_LEVEL_ENTRY, "ber_scanf fmt (%s) ber:\n", fmt ));
511         BER_DUMP(( "liblber", LDAP_LEVEL_DETAIL2, ber, 1 ));
512 #else
513         ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
514                 "ber_scanf fmt (%s) ber:\n", fmt );
515         ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
516 #endif
517
518         for ( rc = 0; *fmt && rc != LBER_DEFAULT; fmt++ ) {
519                 /* When this is modified, remember to update
520                  * the error-cleanup code below accordingly. */
521                 switch ( *fmt ) {
522                 case '!': { /* Hook */
523                                 BERDecodeCallback *f;
524                                 void *p;
525
526                                 f = va_arg( ap, BERDecodeCallback * );
527                                 p = va_arg( ap, void * );
528
529                                 rc = (*f)( ber, p, 0 );
530                         } break;
531
532                 case 'a':       /* octet string - allocate storage as needed */
533                         ss = va_arg( ap, char ** );
534                         rc = ber_get_stringa( ber, ss );
535                         break;
536
537                 case 'b':       /* boolean */
538                         i = va_arg( ap, ber_int_t * );
539                         rc = ber_get_boolean( ber, i );
540                         break;
541
542                 case 'e':       /* enumerated */
543                 case 'i':       /* int */
544                         i = va_arg( ap, ber_int_t * );
545                         rc = ber_get_int( ber, i );
546                         break;
547
548                 case 'l':       /* length of next item */
549                         l = va_arg( ap, ber_len_t * );
550                         rc = ber_peek_tag( ber, l );
551                         break;
552
553                 case 'n':       /* null */
554                         rc = ber_get_null( ber );
555                         break;
556
557                 case 's':       /* octet string - in a buffer */
558                         s = va_arg( ap, char * );
559                         l = va_arg( ap, ber_len_t * );
560                         rc = ber_get_stringb( ber, s, l );
561                         break;
562
563                 case 'o':       /* octet string in a supplied berval */
564                         bval = va_arg( ap, struct berval * );
565                         ber_peek_tag( ber, &bval->bv_len );
566                         rc = ber_get_stringa( ber, &bval->bv_val );
567                         break;
568
569                 case 'O':       /* octet string - allocate & include length */
570                         bvp = va_arg( ap, struct berval ** );
571                         rc = ber_get_stringal( ber, bvp );
572                         break;
573
574                 case 'B':       /* bit string - allocate storage as needed */
575                         ss = va_arg( ap, char ** );
576                         l = va_arg( ap, ber_len_t * ); /* for length, in bits */
577                         rc = ber_get_bitstringa( ber, ss, l );
578                         break;
579
580                 case 't':       /* tag of next item */
581                         t = va_arg( ap, ber_tag_t * );
582                         *t = rc = ber_peek_tag( ber, &len );
583                         break;
584
585                 case 'T':       /* skip tag of next item */
586                         t = va_arg( ap, ber_tag_t * );
587                         *t = rc = ber_skip_tag( ber, &len );
588                         break;
589
590                 case 'v':       /* sequence of strings */
591                         sss = va_arg( ap, char *** );
592                         *sss = NULL;
593                         j = 0;
594                         for ( tag = ber_first_element( ber, &len, &last );
595                             tag != LBER_DEFAULT && rc != LBER_DEFAULT;
596                             tag = ber_next_element( ber, &len, last ) )
597                         {
598                                 char **save = *sss;
599
600                                 *sss = (char **) LBER_REALLOC( *sss,
601                                         (j + 2) * sizeof(char *) );
602
603                                 if( *sss == NULL ) {
604                                         save[j] = NULL;
605                                         ber_memvfree( (void **) save );
606                                         rc = LBER_DEFAULT;
607                                         goto breakout;
608                                 }
609
610                                 rc = ber_get_stringa( ber, &((*sss)[j]) );
611                                 j++;
612                         }
613                         if ( j > 0 ) (*sss)[j] = NULL;
614                         break;
615
616                 case 'V':       /* sequence of strings + lengths */
617                         bv = va_arg( ap, struct berval *** );
618                         *bv = NULL;
619                         j = 0;
620                         for ( tag = ber_first_element( ber, &len, &last );
621                             tag != LBER_DEFAULT && rc != LBER_DEFAULT;
622                             tag = ber_next_element( ber, &len, last ) )
623                         {
624                                 struct berval **save = *bv;
625
626                                 *bv = (struct berval **) LBER_REALLOC( *bv,
627                                         (j + 2) * sizeof(struct berval *) );
628                 
629                                 if( *bv == NULL ) {
630                                         save[j] = NULL;
631                                         ber_bvecfree( save );
632                                         rc = LBER_DEFAULT;
633                                         goto breakout;
634                                 }
635
636                                 rc = ber_get_stringal( ber, &((*bv)[j]) );
637                                 j++;
638                         }
639                         if ( j > 0 ) (*bv)[j] = NULL;
640                         break;
641
642                 case 'x':       /* skip the next element - whatever it is */
643                         if ( (rc = ber_skip_tag( ber, &len )) == LBER_DEFAULT )
644                                 break;
645                         ber->ber_ptr += len;
646                         break;
647
648                 case '{':       /* begin sequence */
649                 case '[':       /* begin set */
650                         if ( *(fmt + 1) != 'v' && *(fmt + 1) != 'V' )
651                                 rc = ber_skip_tag( ber, &len );
652                         break;
653
654                 case '}':       /* end sequence */
655                 case ']':       /* end set */
656                         break;
657
658                 default:
659                         if( ber->ber_debug ) {
660 #ifdef NEW_LOGGING
661                                 LDAP_LOG(( "liblber", LDAP_LEVEL_ERR,
662                                            "ber_scanf: unknown fmt %c\n", *fmt ));
663 #else
664                                 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
665                                         "ber_scanf: unknown fmt %c\n", *fmt );
666 #endif
667                         }
668                         rc = LBER_DEFAULT;
669                         break;
670                 }
671         }
672
673 breakout:
674         va_end( ap );
675
676         if ( rc == LBER_DEFAULT ) {
677             /*
678              * Error.  Reclaim malloced memory that was given to the caller.
679              * Set allocated pointers to NULL, "data length" outvalues to 0.
680              */
681             va_start( ap, fmt );
682
683             for ( ; fmt_reset < fmt; fmt_reset++ ) {
684                 switch ( *fmt_reset ) {
685                 case '!': { /* Hook */
686                                 BERDecodeCallback *f;
687                                 void *p;
688
689                                 f = va_arg( ap, BERDecodeCallback * );
690                                 p = va_arg( ap, void * );
691
692                                 (void) (*f)( ber, p, 1 );
693                         } break;
694
695                 case 'a':       /* octet string - allocate storage as needed */
696                         ss = va_arg( ap, char ** );
697                         if ( *ss ) {
698                                 LBER_FREE( *ss );
699                                 *ss = NULL;
700                         }
701                         break;
702
703                 case 'b':       /* boolean */
704                 case 'e':       /* enumerated */
705                 case 'i':       /* int */
706                         (void) va_arg( ap, int * );
707                         break;
708
709                 case 's':       /* octet string - in a buffer */
710                         (void) va_arg( ap, char * );
711                         (void) va_arg( ap, ber_len_t * );
712                         break;
713
714                 case 'l':       /* length of next item */
715                         (void) va_arg( ap, ber_len_t * );
716                         break;
717
718                 case 't':       /* tag of next item */
719                 case 'T':       /* skip tag of next item */
720                         (void) va_arg( ap, ber_tag_t * );
721                         break;
722
723                 case 'o':       /* octet string in a supplied berval */
724                         bval = va_arg( ap, struct berval * );
725                         if ( bval->bv_val != NULL ) {
726                                 LBER_FREE( bval->bv_val );
727                                 bval->bv_val = NULL;
728                         }
729                         bval->bv_len = 0;
730                         break;
731
732                 case 'O':       /* octet string - allocate & include length */
733                         bvp = va_arg( ap, struct berval ** );
734                         if ( *bvp ) {
735                                 ber_bvfree( *bvp );
736                                 *bvp = NULL;
737                         }
738                         break;
739
740                 case 'B':       /* bit string - allocate storage as needed */
741                         ss = va_arg( ap, char ** );
742                         if ( *ss ) {
743                                 LBER_FREE( *ss );
744                                 *ss = NULL;
745                         }
746                         *(va_arg( ap, ber_len_t * )) = 0; /* for length, in bits */
747                         break;
748
749                 case 'v':       /* sequence of strings */
750                         sss = va_arg( ap, char *** );
751                         if ( *sss ) {
752                                 ber_memvfree( (void **) *sss );
753                                 *sss = NULL;
754                         }
755                         break;
756
757                 case 'V':       /* sequence of strings + lengths */
758                         bv = va_arg( ap, struct berval *** );
759                         if ( *bv ) {
760                                 ber_bvecfree( *bv );
761                                 *bv = NULL;
762                         }
763                         break;
764
765                 case 'n':       /* null */
766                 case 'x':       /* skip the next element - whatever it is */
767                 case '{':       /* begin sequence */
768                 case '[':       /* begin set */
769                 case '}':       /* end sequence */
770                 case ']':       /* end set */
771                         break;
772
773                 default:
774                         /* format should be good */
775                         assert( 0 );
776                 }
777             }
778
779             va_end( ap );
780         }
781
782         return rc;
783 }