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