]> git.sur5r.net Git - openldap/blob - libraries/liblber/encode.c
f8aa0e887df690943a3bd73cdc5ccb9ac6f8b31c
[openldap] / libraries / liblber / encode.c
1 /* encode.c - ber output encoding 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/socket.h>
26 #include <ac/string.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_put_len LDAP_P((
34         BerElement *ber,
35         ber_len_t len,
36         int nosos ));
37
38 static int ber_start_seqorset LDAP_P((
39         BerElement *ber,
40         ber_tag_t tag ));
41
42 static int ber_put_seqorset LDAP_P(( BerElement *ber ));
43
44 static int ber_put_int_or_enum LDAP_P((
45         BerElement *ber,
46         ber_int_t num,
47         ber_tag_t tag ));
48
49
50 static ber_len_t
51 ber_calc_taglen( ber_tag_t tag )
52 {
53         int     i;
54         ber_tag_t       mask;
55
56         /* find the first non-all-zero byte in the tag */
57         for ( i = sizeof(ber_tag_t) - 1; i > 0; i-- ) {
58                 mask = ((ber_tag_t)0xffU << (i * 8));
59                 /* not all zero */
60                 if ( tag & mask )
61                         break;
62         }
63
64         return( i + 1 );
65 }
66
67 static int
68 ber_put_tag(
69         BerElement      *ber,
70         ber_tag_t tag,
71         int nosos )
72 {
73         int rc;
74         ber_len_t       taglen;
75         ber_tag_t       ntag;
76
77         assert( ber != NULL );
78         assert( BER_VALID( ber ) );
79
80         taglen = ber_calc_taglen( tag );
81
82         ntag = LBER_TAG_HTON( tag );
83
84         rc = ber_write( ber,
85                 ((char *) &ntag) + sizeof(ber_tag_t) - taglen,
86             taglen, nosos );
87
88         return rc;
89 }
90
91 static ber_len_t
92 ber_calc_lenlen( ber_len_t len )
93 {
94         /*
95          * short len if it's less than 128 - one byte giving the len,
96          * with bit 8 0.
97          */
98
99         if ( len <= (ber_len_t) 0x7FU )
100                 return( 1 );
101
102         /*
103          * long len otherwise - one byte with bit 8 set, giving the
104          * length of the length, followed by the length itself.
105          */
106
107         if ( len <= (ber_len_t) 0xffU )
108                 return( 2 );
109         if ( len <= (ber_len_t) 0xffffU )
110                 return( 3 );
111         if ( len <= (ber_len_t) 0xffffffU )
112                 return( 4 );
113
114         return( 5 );
115 }
116
117 static int
118 ber_put_len( BerElement *ber, ber_len_t len, int nosos )
119 {
120         int             i;
121         char            lenlen;
122         ber_len_t       mask;
123         ber_len_t       netlen;
124
125         assert( ber != NULL );
126         assert( BER_VALID( ber ) );
127
128         /*
129          * short len if it's less than 128 - one byte giving the len,
130          * with bit 8 0.
131          */
132
133         if ( len <= 127 ) {
134                 netlen = LBER_LEN_HTON( len );
135                 return( ber_write( ber, (char *) &netlen + sizeof(long) - 1,
136                     1, nosos ) );
137         }
138
139         /*
140          * long len otherwise - one byte with bit 8 set, giving the
141          * length of the length, followed by the length itself.
142          */
143
144         /* find the first non-all-zero byte */
145         for ( i = sizeof(ber_len_t) - 1; i > 0; i-- ) {
146                 mask = (0xffU << (i * 8));
147                 /* not all zero */
148                 if ( len & mask )
149                         break;
150         }
151         lenlen = (unsigned char) ++i;
152         if ( lenlen > 4 )
153                 return( -1 );
154         lenlen |= 0x80UL;
155
156         /* write the length of the length */
157         if ( ber_write( ber, &lenlen, 1, nosos ) != 1 )
158                 return( -1 );
159
160         /* write the length itself */
161         netlen = LBER_LEN_HTON( len );
162         if ( ber_write( ber, (char *) &netlen + (sizeof(ber_len_t) - i), i, nosos )
163             != i )
164                 return( -1 );
165
166         return( i + 1 );
167 }
168
169 static int
170 ber_put_int_or_enum(
171         BerElement *ber,
172         ber_int_t num,
173         ber_tag_t tag )
174 {
175         int     i, sign;
176         ber_len_t       len, lenlen, taglen;
177         ber_uint_t      unum, netnum, mask;
178
179         assert( ber != NULL );
180         assert( BER_VALID( ber ) );
181
182         sign = (num < 0);
183         unum = num;     /* Bit fiddling should be done with unsigned values */
184
185         /*
186          * high bit is set - look for first non-all-one byte
187          * high bit is clear - look for first non-all-zero byte
188          */
189         for ( i = sizeof(ber_int_t) - 1; i > 0; i-- ) {
190                 mask = (0xffU << (i * 8));
191
192                 if ( sign ) {
193                         /* not all ones */
194                         if ( (unum & mask) != mask )
195                                 break;
196                 } else {
197                         /* not all zero */
198                         if ( unum & mask )
199                                 break;
200                 }
201         }
202
203         /*
204          * we now have the "leading byte".  if the high bit on this
205          * byte matches the sign bit, we need to "back up" a byte.
206          */
207         mask = (unum & (0x80U << (i * 8)));
208         if ( (mask && !sign) || (sign && !mask) )
209                 i++;
210
211         len = i + 1;
212
213         if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
214                 return( -1 );
215
216         if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 )
217                 return( -1 );
218         i++;
219         netnum = LBER_INT_HTON( unum );
220         if ( ber_write( ber, (char *) &netnum + (sizeof(ber_int_t) - i), i, 0 )
221            != i )
222                 return( -1 );
223
224         /* length of tag + length + contents */
225         return( taglen + lenlen + i );
226 }
227
228 int
229 ber_put_enum(
230         BerElement *ber,
231         ber_int_t num,
232         ber_tag_t tag )
233 {
234         assert( ber != NULL );
235         assert( BER_VALID( ber ) );
236
237         if ( tag == LBER_DEFAULT )
238                 tag = LBER_ENUMERATED;
239
240         return( ber_put_int_or_enum( ber, num, tag ) );
241 }
242
243 int
244 ber_put_int(
245         BerElement *ber,
246         ber_int_t num,
247         ber_tag_t tag )
248 {
249         assert( ber != NULL );
250         assert( BER_VALID( ber ) );
251
252         if ( tag == LBER_DEFAULT )
253                 tag = LBER_INTEGER;
254
255         return( ber_put_int_or_enum( ber, num, tag ) );
256 }
257
258 int
259 ber_put_ostring(
260         BerElement *ber,
261         LDAP_CONST char *str,
262         ber_len_t len,
263         ber_tag_t tag )
264 {
265         ber_len_t       taglen, lenlen;
266         int rc;
267 #ifdef STR_TRANSLATION
268         int     free_str;
269 #endif /* STR_TRANSLATION */
270
271         assert( ber != NULL );
272         assert( str != NULL );
273
274         assert( BER_VALID( ber ) );
275
276         if ( tag == LBER_DEFAULT )
277                 tag = LBER_OCTETSTRING;
278
279         if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
280                 return( -1 );
281
282 #ifdef STR_TRANSLATION
283         if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0 &&
284             ber->ber_encode_translate_proc ) {
285                 if ( (*(ber->ber_encode_translate_proc))( &str, &len, 0 )
286                     != 0 ) {
287                         return( -1 );
288                 }
289                 free_str = 1;
290         } else {
291                 free_str = 0;
292         }
293 #endif /* STR_TRANSLATION */
294
295         if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
296                 (unsigned long) ber_write( ber, str, len, 0 ) != len ) {
297                 rc = -1;
298         } else {
299                 /* return length of tag + length + contents */
300                 rc = taglen + lenlen + len;
301         }
302
303 #ifdef STR_TRANSLATION
304         if ( free_str ) {
305                 LBER_FREE( str );
306         }
307 #endif /* STR_TRANSLATION */
308
309         return( rc );
310 }
311
312 int
313 ber_put_berval(
314         BerElement *ber,
315         LDAP_CONST struct berval *bv,
316         ber_tag_t tag )
317 {
318         assert( ber != NULL );
319         assert( BER_VALID( ber ) );
320
321         if( bv == NULL || bv->bv_len == 0 ) {
322                 return ber_put_ostring( ber, "", (ber_len_t) 0, tag );
323         }
324
325         return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
326 }
327
328 int
329 ber_put_string(
330         BerElement *ber,
331         LDAP_CONST char *str,
332         ber_tag_t tag )
333 {
334         assert( ber != NULL );
335         assert( str != NULL );
336
337         assert( BER_VALID( ber ) );
338
339         return( ber_put_ostring( ber, str, strlen( str ), tag ));
340 }
341
342 int
343 ber_put_bitstring(
344         BerElement *ber,
345         LDAP_CONST char *str,
346         ber_len_t blen /* in bits */,
347         ber_tag_t tag )
348 {
349         ber_len_t               taglen, lenlen, len;
350         unsigned char   unusedbits;
351
352         assert( ber != NULL );
353         assert( str != NULL );
354
355         assert( BER_VALID( ber ) );
356
357         if ( tag == LBER_DEFAULT )
358                 tag = LBER_BITSTRING;
359
360         if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
361                 return( -1 );
362
363         len = ( blen + 7 ) / 8;
364         unusedbits = (unsigned char) ((len * 8) - blen);
365         if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 )
366                 return( -1 );
367
368         if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 )
369                 return( -1 );
370
371         if ( (ber_len_t) ber_write( ber, str, len, 0 ) != len )
372                 return( -1 );
373
374         /* return length of tag + length + unused bit count + contents */
375         return( taglen + 1 + lenlen + len );
376 }
377
378 int
379 ber_put_null( BerElement *ber, ber_tag_t tag )
380 {
381         ber_len_t       taglen;
382
383         assert( ber != NULL );
384         assert( BER_VALID( ber ) );
385
386         if ( tag == LBER_DEFAULT )
387                 tag = LBER_NULL;
388
389         if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
390                 return( -1 );
391
392         if ( ber_put_len( ber, 0, 0 ) != 1 )
393                 return( -1 );
394
395         return( taglen + 1 );
396 }
397
398 int
399 ber_put_boolean(
400         BerElement *ber,
401         ber_int_t boolval,
402         ber_tag_t tag )
403 {
404         ber_len_t               taglen;
405         unsigned char   trueval = 0xFFU;
406         unsigned char   falseval = 0x00U;
407
408         assert( ber != NULL );
409         assert( BER_VALID( ber ) );
410
411         if ( tag == LBER_DEFAULT )
412                 tag = LBER_BOOLEAN;
413
414         if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
415                 return( -1 );
416
417         if ( ber_put_len( ber, 1, 0 ) != 1 )
418                 return( -1 );
419
420         if ( ber_write( ber, (char *)(boolval ? &trueval : &falseval), 1, 0 )
421             != 1 )
422                 return( -1 );
423
424         return( taglen + 2 );
425 }
426
427 #define FOUR_BYTE_LEN   5
428
429 static int
430 ber_start_seqorset(
431         BerElement *ber,
432         ber_tag_t tag )
433 {
434         Seqorset        *new;
435
436         assert( ber != NULL );
437         assert( BER_VALID( ber ) );
438
439         new = (Seqorset *) LBER_CALLOC( 1, sizeof(Seqorset) );
440
441         if ( new == NULL )
442                 return( -1 );
443
444         new->sos_ber = ber;
445         if ( ber->ber_sos == NULL )
446                 new->sos_first = ber->ber_ptr;
447         else
448                 new->sos_first = ber->ber_sos->sos_ptr;
449
450         /* Set aside room for a 4 byte length field */
451         new->sos_ptr = new->sos_first + ber_calc_taglen( tag ) + FOUR_BYTE_LEN;
452         new->sos_tag = tag;
453
454         new->sos_next = ber->ber_sos;
455         ber->ber_sos = new;
456
457         return( 0 );
458 }
459
460 int
461 ber_start_seq( BerElement *ber, ber_tag_t tag )
462 {
463         assert( ber != NULL );
464         assert( BER_VALID( ber ) );
465
466         if ( tag == LBER_DEFAULT )
467                 tag = LBER_SEQUENCE;
468
469         return( ber_start_seqorset( ber, tag ) );
470 }
471
472 int
473 ber_start_set( BerElement *ber, ber_tag_t tag )
474 {
475         assert( ber != NULL );
476         assert( BER_VALID( ber ) );
477
478         if ( tag == LBER_DEFAULT )
479                 tag = LBER_SET;
480
481         return( ber_start_seqorset( ber, tag ) );
482 }
483
484 static int
485 ber_put_seqorset( BerElement *ber )
486 {
487         ber_len_t       len, netlen;
488         ber_len_t       taglen, lenlen;
489         unsigned char   ltag = 0x80U + FOUR_BYTE_LEN - 1;
490         Seqorset        *next;
491         Seqorset        **sos = &ber->ber_sos;
492
493         assert( ber != NULL );
494         assert( BER_VALID( ber ) );
495
496         /*
497          * If this is the toplevel sequence or set, we need to actually
498          * write the stuff out.  Otherwise, it's already been put in
499          * the appropriate buffer and will be written when the toplevel
500          * one is written.  In this case all we need to do is update the
501          * length and tag.
502          */
503
504         len = (*sos)->sos_clen;
505         netlen = LBER_LEN_HTON( len );
506         if ( sizeof(ber_len_t) > 4 && len > 0xffffffffUL )
507                 return( -1 );
508
509         if ( ber->ber_options & LBER_USE_DER ) {
510                 lenlen = ber_calc_lenlen( len );
511         } else {
512                 lenlen = FOUR_BYTE_LEN;
513         }
514
515         if ( (next = (*sos)->sos_next) == NULL ) {
516                 /* write the tag */
517                 if ( (taglen = ber_put_tag( ber, (*sos)->sos_tag, 1 )) == -1 )
518                         return( -1 );
519
520                 if ( ber->ber_options & LBER_USE_DER ) {
521                         /* Write the length in the minimum # of octets */
522                         if ( ber_put_len( ber, len, 1 ) == -1 )
523                                 return( -1 );
524
525                         if (lenlen != FOUR_BYTE_LEN) {
526                                 /*
527                                  * We set aside FOUR_BYTE_LEN bytes for
528                                  * the length field.  Move the data if
529                                  * we don't actually need that much
530                                  */
531                                 SAFEMEMCPY( (*sos)->sos_first + taglen +
532                                     lenlen, (*sos)->sos_first + taglen +
533                                     FOUR_BYTE_LEN, len );
534                         }
535                 } else {
536                         /* Fill FOUR_BYTE_LEN bytes for length field */
537                         /* one byte of length length */
538                         if ( ber_write( ber, (char *)&ltag, 1, 1 ) != 1 )
539                                 return( -1 );
540
541                         /* the length itself */
542                         if ( ber_write( ber, (char *) &netlen + sizeof(long)
543                             - (FOUR_BYTE_LEN - 1), FOUR_BYTE_LEN - 1, 1 )
544                             != FOUR_BYTE_LEN - 1 )
545                                 return( -1 );
546                 }
547                 /* The ber_ptr is at the set/seq start - move it to the end */
548                 (*sos)->sos_ber->ber_ptr += len;
549         } else {
550                 ber_tag_t       ntag;
551
552                 /* the tag */
553                 taglen = ber_calc_taglen( (*sos)->sos_tag );
554                 ntag = LBER_TAG_HTON( (*sos)->sos_tag );
555                 SAFEMEMCPY( (*sos)->sos_first, (char *) &ntag +
556                     sizeof(ber_tag_t) - taglen, taglen );
557
558                 if ( ber->ber_options & LBER_USE_DER ) {
559                         ltag = (lenlen == 1)
560                                 ? (unsigned char) len
561                                 : (unsigned char) (0x80U + (lenlen - 1));
562                 }
563
564                 /* one byte of length length */
565                 SAFEMEMCPY( (*sos)->sos_first + 1, &ltag, 1 );
566
567                 if ( ber->ber_options & LBER_USE_DER ) {
568                         if (lenlen > 1) {
569                                 /* Write the length itself */
570                                 SAFEMEMCPY( (*sos)->sos_first + 2,
571                                     (char *)&netlen + sizeof(ber_len_t) -
572                                     (lenlen - 1),
573                                     lenlen - 1 );
574                         }
575                         if (lenlen != FOUR_BYTE_LEN) {
576                                 /*
577                                  * We set aside FOUR_BYTE_LEN bytes for
578                                  * the length field.  Move the data if
579                                  * we don't actually need that much
580                                  */
581                                 SAFEMEMCPY( (*sos)->sos_first + taglen +
582                                     lenlen, (*sos)->sos_first + taglen +
583                                     FOUR_BYTE_LEN, len );
584                         }
585                 } else {
586                         /* the length itself */
587                         SAFEMEMCPY( (*sos)->sos_first + taglen + 1,
588                             (char *) &netlen + sizeof(ber_len_t) -
589                             (FOUR_BYTE_LEN - 1), FOUR_BYTE_LEN - 1 );
590                 }
591
592                 next->sos_clen += (taglen + lenlen + len);
593                 next->sos_ptr += (taglen + lenlen + len);
594         }
595
596         /* we're done with this seqorset, so free it up */
597         LBER_FREE( (char *) (*sos) );
598         *sos = next;
599
600         return( taglen + lenlen + len );
601 }
602
603 int
604 ber_put_seq( BerElement *ber )
605 {
606         assert( ber != NULL );
607         assert( BER_VALID( ber ) );
608
609         return( ber_put_seqorset( ber ) );
610 }
611
612 int
613 ber_put_set( BerElement *ber )
614 {
615         assert( ber != NULL );
616         assert( BER_VALID( ber ) );
617
618         return( ber_put_seqorset( ber ) );
619 }
620
621 /* VARARGS */
622 int
623 ber_printf
624 #ifdef HAVE_STDARG
625         ( BerElement *ber,
626         LDAP_CONST char *fmt,
627         ... )
628 #else
629         ( va_alist )
630 va_dcl
631 #endif
632 {
633         va_list         ap;
634 #ifndef HAVE_STDARG
635         BerElement      *ber;
636         char            *fmt;
637 #endif
638         char            *s, **ss;
639         struct berval   *bv, **bvp;
640         int             rc;
641         ber_int_t       i;
642         ber_len_t       len;
643
644 #ifdef HAVE_STDARG
645         va_start( ap, fmt );
646 #else
647         va_start( ap );
648         ber = va_arg( ap, BerElement * );
649         fmt = va_arg( ap, char * );
650 #endif
651
652         assert( ber != NULL );
653         assert( fmt != NULL );
654
655         assert( BER_VALID( ber ) );
656
657         for ( rc = 0; *fmt && rc != -1; fmt++ ) {
658                 switch ( *fmt ) {
659                 case '!': { /* hook */
660                                 BEREncodeCallback *f;
661                                 void *p;
662
663                                 f = va_arg( ap, BEREncodeCallback * );
664                                 p = va_arg( ap, void * );
665
666                                 rc = (*f)( ber, p );
667                         } break;
668
669                 case 'b':       /* boolean */
670                         i = va_arg( ap, ber_int_t );
671                         rc = ber_put_boolean( ber, i, ber->ber_tag );
672                         break;
673
674                 case 'i':       /* int */
675                         i = va_arg( ap, ber_int_t );
676                         rc = ber_put_int( ber, i, ber->ber_tag );
677                         break;
678
679                 case 'e':       /* enumeration */
680                         i = va_arg( ap, ber_int_t );
681                         rc = ber_put_enum( ber, i, ber->ber_tag );
682                         break;
683
684                 case 'n':       /* null */
685                         rc = ber_put_null( ber, ber->ber_tag );
686                         break;
687
688                 case 'o':       /* octet string (non-null terminated) */
689                         s = va_arg( ap, char * );
690                         len = va_arg( ap, ber_len_t );
691                         rc = ber_put_ostring( ber, s, len, ber->ber_tag );
692                         break;
693
694                 case 'O':       /* berval octet string */
695                         bv = va_arg( ap, struct berval * );
696                         if( bv == NULL ) break;
697                         rc = ber_put_berval( ber, bv, ber->ber_tag );
698                         break;
699
700                 case 's':       /* string */
701                         s = va_arg( ap, char * );
702                         rc = ber_put_string( ber, s, ber->ber_tag );
703                         break;
704
705                 case 'B':       /* bit string */
706                         s = va_arg( ap, char * );
707                         len = va_arg( ap, int );        /* in bits */
708                         rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
709                         break;
710
711                 case 't':       /* tag for the next element */
712                         ber->ber_tag = va_arg( ap, ber_tag_t );
713                         ber->ber_usertag = 1;
714                         break;
715
716                 case 'v':       /* vector of strings */
717                         if ( (ss = va_arg( ap, char ** )) == NULL )
718                                 break;
719                         for ( i = 0; ss[i] != NULL; i++ ) {
720                                 if ( (rc = ber_put_string( ber, ss[i],
721                                     ber->ber_tag )) == -1 )
722                                         break;
723                         }
724                         break;
725
726                 case 'V':       /* sequences of strings + lengths */
727                         if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
728                                 break;
729                         for ( i = 0; bvp[i] != NULL; i++ ) {
730                                 if ( (rc = ber_put_berval( ber, bvp[i],
731                                     ber->ber_tag )) == -1 )
732                                         break;
733                         }
734                         break;
735
736                 case '{':       /* begin sequence */
737                         rc = ber_start_seq( ber, ber->ber_tag );
738                         break;
739
740                 case '}':       /* end sequence */
741                         rc = ber_put_seqorset( ber );
742                         break;
743
744                 case '[':       /* begin set */
745                         rc = ber_start_set( ber, ber->ber_tag );
746                         break;
747
748                 case ']':       /* end set */
749                         rc = ber_put_seqorset( ber );
750                         break;
751
752                 default:
753                         if( ber->ber_debug ) {
754                                 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
755                                         "ber_printf: unknown fmt %c\n", *fmt );
756                         }
757                         rc = -1;
758                         break;
759                 }
760
761                 if ( ber->ber_usertag == 0 )
762                         ber->ber_tag = LBER_DEFAULT;
763                 else
764                         ber->ber_usertag = 0;
765         }
766
767         va_end( ap );
768
769         return( rc );
770 }