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