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