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