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