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