1 /* encode.c - ber output encoding routines */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2005 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
16 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
17 * All rights reserved.
19 * Redistribution and use in source and binary forms are permitted
20 * provided that this notice is preserved and that due credit is given
21 * to the University of Michigan at Ann Arbor. The name of the University
22 * may not be used to endorse or promote products derived from this
23 * software without specific prior written permission. This software
24 * is provided ``as is'' without express or implied warranty.
27 * This work was originally developed by the University of Michigan
28 * (as part of U-MICH LDAP).
35 #include <ac/stdlib.h>
37 #include <ac/stdarg.h>
38 #include <ac/socket.h>
39 #include <ac/string.h>
43 static int ber_put_len LDAP_P((
48 static int ber_start_seqorset LDAP_P((
52 static int ber_put_seqorset LDAP_P(( BerElement *ber ));
54 static int ber_put_int_or_enum LDAP_P((
59 #define BER_TOP_BYTE(type) (sizeof(type)-1)
60 #define BER_TOP_MASK(type) ((type)0xffU << (BER_TOP_BYTE(type)*8))
63 ber_calc_taglen( ber_tag_t tag )
65 int i = BER_TOP_BYTE(ber_tag_t);
66 ber_tag_t mask = BER_TOP_MASK(ber_tag_t);
68 /* find the first non-all-zero byte in the tag */
69 for ( ; i > 0; i-- ) {
71 if ( tag & mask ) break;
87 unsigned char nettag[sizeof(ber_tag_t)];
89 assert( ber != NULL );
90 assert( LBER_VALID( ber ) );
92 taglen = ber_calc_taglen( tag );
94 for( i=taglen-1; i>=0; i-- ) {
95 nettag[i] = (unsigned char)(tag & 0xffU);
99 rc = ber_write( ber, (char *) nettag, taglen, nosos );
105 ber_calc_lenlen( ber_len_t len )
108 * short len if it's less than 128 - one byte giving the len,
112 if ( len <= (ber_len_t) 0x7FU ) return 1;
115 * long len otherwise - one byte with bit 8 set, giving the
116 * length of the length, followed by the length itself.
119 if ( len <= (ber_len_t) 0xffU ) return 2;
120 if ( len <= (ber_len_t) 0xffffU ) return 3;
121 if ( len <= (ber_len_t) 0xffffffU ) return 4;
127 ber_put_len( BerElement *ber, ber_len_t len, int nosos )
133 unsigned char netlen[sizeof(ber_len_t)];
135 assert( ber != NULL );
136 assert( LBER_VALID( ber ) );
139 * short len if it's less than 128 - one byte giving the len,
144 char length_byte = (char) len;
145 return ber_write( ber, &length_byte, 1, nosos );
149 * long len otherwise - one byte with bit 8 set, giving the
150 * length of the length, followed by the length itself.
153 /* find the first non-all-zero byte */
154 i = BER_TOP_BYTE(ber_len_t);
155 mask = BER_TOP_MASK(ber_len_t);
156 for ( ; i > 0; i-- ) {
158 if ( len & mask ) break;
161 lenlen = (unsigned char) ++i;
162 if ( lenlen > 4 ) return -1;
166 /* write the length of the length */
167 if ( ber_write( ber, &lenlen, 1, nosos ) != 1 ) return -1;
169 for( j=i-1; j>=0; j-- ) {
170 netlen[j] = (unsigned char)(len & 0xffU);
174 /* write the length itself */
175 rc = ber_write( ber, (char *) netlen, i, nosos );
177 return rc == i ? i+1 : -1;
187 int i, j, sign, taglen, lenlen;
189 ber_uint_t unum, mask;
190 unsigned char netnum[sizeof(ber_uint_t)];
192 assert( ber != NULL );
193 assert( LBER_VALID( ber ) );
196 unum = num; /* Bit fiddling should be done with unsigned values */
199 * high bit is set - look for first non-all-one byte
200 * high bit is clear - look for first non-all-zero byte
202 i = BER_TOP_BYTE(ber_int_t);
203 mask = BER_TOP_MASK(ber_uint_t);
204 for ( ; i > 0; i-- ) {
207 if ( (unum & mask) != mask ) break;
210 if ( unum & mask ) break;
216 * we now have the "leading byte". if the high bit on this
217 * byte matches the sign bit, we need to "back up" a byte.
219 mask = (unum & ((ber_uint_t)0x80U << (i * 8)));
220 if ( (mask && !sign) || (sign && !mask) ) {
226 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
230 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ) {
235 for( j=i-1; j>=0; j-- ) {
236 netnum[j] = (unsigned char)(unum & 0xffU);
240 rc = ber_write( ber, (char *) netnum, i, 0 );
242 /* length of tag + length + contents */
243 return rc == i ? taglen + lenlen + i : -1;
252 assert( ber != NULL );
253 assert( LBER_VALID( ber ) );
255 if ( tag == LBER_DEFAULT ) {
256 tag = LBER_ENUMERATED;
259 return ber_put_int_or_enum( ber, num, tag );
268 assert( ber != NULL );
269 assert( LBER_VALID( ber ) );
271 if ( tag == LBER_DEFAULT ) {
275 return ber_put_int_or_enum( ber, num, tag );
281 LDAP_CONST char *str,
285 int taglen, lenlen, rc;
287 assert( ber != NULL );
288 assert( str != NULL );
290 assert( LBER_VALID( ber ) );
292 if ( tag == LBER_DEFAULT ) {
293 tag = LBER_OCTETSTRING;
296 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
299 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
300 (ber_len_t) ber_write( ber, str, len, 0 ) != len )
304 /* return length of tag + length + contents */
305 rc = taglen + lenlen + len;
317 assert( ber != NULL );
318 assert( LBER_VALID( ber ) );
320 if( bv == NULL || bv->bv_len == 0 ) {
321 return ber_put_ostring( ber, "", (ber_len_t) 0, tag );
324 return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
330 LDAP_CONST char *str,
333 assert( ber != NULL );
334 assert( str != NULL );
336 assert( LBER_VALID( ber ) );
338 return ber_put_ostring( ber, str, strlen( str ), tag );
344 LDAP_CONST char *str,
345 ber_len_t blen /* in bits */,
350 unsigned char unusedbits;
352 assert( ber != NULL );
353 assert( str != NULL );
355 assert( LBER_VALID( ber ) );
357 if ( tag == LBER_DEFAULT ) {
358 tag = LBER_BITSTRING;
361 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
365 len = ( blen + 7 ) / 8;
366 unusedbits = (unsigned char) ((len * 8) - blen);
367 if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 ) {
371 if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 ) {
375 if ( (ber_len_t) ber_write( ber, str, len, 0 ) != len ) {
379 /* return length of tag + length + unused bit count + contents */
380 return taglen + 1 + lenlen + len;
384 ber_put_null( BerElement *ber, ber_tag_t tag )
388 assert( ber != NULL );
389 assert( LBER_VALID( ber ) );
391 if ( tag == LBER_DEFAULT ) {
395 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
399 if ( ber_put_len( ber, 0, 0 ) != 1 ) {
415 assert( ber != NULL );
416 assert( LBER_VALID( ber ) );
418 if ( tag == LBER_DEFAULT )
421 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
425 if ( ber_put_len( ber, 1, 0 ) != 1 ) {
429 c = boolval ? (unsigned char) ~0U : (unsigned char) 0U;
431 if ( ber_write( ber, (char *) &c, 1, 0 ) != 1 ) {
438 #define FOUR_BYTE_LEN 5
447 assert( ber != NULL );
448 assert( LBER_VALID( ber ) );
450 new = (Seqorset *) ber_memcalloc_x( 1, sizeof(Seqorset), ber->ber_memctx );
457 if ( ber->ber_sos == NULL ) {
458 new->sos_first = ber->ber_ptr;
460 new->sos_first = ber->ber_sos->sos_ptr;
463 /* Set aside room for a 4 byte length field */
464 new->sos_ptr = new->sos_first + ber_calc_taglen( tag ) + FOUR_BYTE_LEN;
467 new->sos_next = ber->ber_sos;
474 ber_start_seq( BerElement *ber, ber_tag_t tag )
476 assert( ber != NULL );
477 assert( LBER_VALID( ber ) );
479 if ( tag == LBER_DEFAULT ) {
483 return ber_start_seqorset( ber, tag );
487 ber_start_set( BerElement *ber, ber_tag_t tag )
489 assert( ber != NULL );
490 assert( LBER_VALID( ber ) );
492 if ( tag == LBER_DEFAULT ) {
496 return ber_start_seqorset( ber, tag );
500 ber_put_seqorset( BerElement *ber )
504 unsigned char netlen[sizeof(ber_len_t)];
507 unsigned char ltag = 0x80U + FOUR_BYTE_LEN - 1;
509 Seqorset **sos = &ber->ber_sos;
511 assert( ber != NULL );
512 assert( LBER_VALID( ber ) );
514 if( *sos == NULL ) return -1;
517 * If this is the toplevel sequence or set, we need to actually
518 * write the stuff out. Otherwise, it's already been put in
519 * the appropriate buffer and will be written when the toplevel
520 * one is written. In this case all we need to do is update the
524 len = (*sos)->sos_clen;
526 if ( sizeof(ber_len_t) > 4 && len > 0xffffffffUL ) {
530 if ( ber->ber_options & LBER_USE_DER ) {
531 lenlen = ber_calc_lenlen( len );
534 lenlen = FOUR_BYTE_LEN;
540 for( i=lenlen-2; i >= 0; i-- ) {
541 netlen[i] = j & 0xffU;
545 netlen[0] = (unsigned char)(len & 0x7fU);
548 if ( (next = (*sos)->sos_next) == NULL ) {
550 if ( (taglen = ber_put_tag( ber, (*sos)->sos_tag, 1 )) == -1 ) {
554 if ( ber->ber_options & LBER_USE_DER ) {
555 /* Write the length in the minimum # of octets */
556 if ( ber_put_len( ber, len, 1 ) == -1 ) {
560 if (lenlen != FOUR_BYTE_LEN) {
562 * We set aside FOUR_BYTE_LEN bytes for
563 * the length field. Move the data if
564 * we don't actually need that much
566 AC_MEMCPY( (*sos)->sos_first + taglen +
567 lenlen, (*sos)->sos_first + taglen +
568 FOUR_BYTE_LEN, len );
571 /* Fill FOUR_BYTE_LEN bytes for length field */
572 /* one byte of length length */
573 if ( ber_write( ber, (char *)<ag, 1, 1 ) != 1 ) {
577 /* the length itself */
578 rc = ber_write( ber, (char *) netlen, FOUR_BYTE_LEN-1, 1 );
580 if( rc != FOUR_BYTE_LEN - 1 ) {
584 /* The ber_ptr is at the set/seq start - move it to the end */
585 (*sos)->sos_ber->ber_ptr += len;
589 unsigned char nettag[sizeof(ber_tag_t)];
590 ber_tag_t tmptag = (*sos)->sos_tag;
592 if( ber->ber_sos->sos_ptr > ber->ber_end ) {
593 /* The sos_ptr exceeds the end of the BerElement
594 * this can happen, for example, when the sos_ptr
595 * is near the end and no data was written for the
596 * 'V'. We must realloc the BerElement to ensure
597 * we don't overwrite the buffer when writing
598 * the tag and length fields.
600 ber_len_t ext = ber->ber_sos->sos_ptr - ber->ber_end;
602 if( ber_realloc( ber, ext ) != 0 ) {
608 taglen = ber_calc_taglen( tmptag );
610 for( i = taglen-1; i >= 0; i-- ) {
611 nettag[i] = (unsigned char)(tmptag & 0xffU);
615 AC_FMEMCPY( (*sos)->sos_first, nettag, taglen );
617 if ( ber->ber_options & LBER_USE_DER ) {
619 ? (unsigned char) len
620 : (unsigned char) (0x80U + (lenlen - 1));
623 /* one byte of length length */
624 (*sos)->sos_first[1] = ltag;
626 if ( ber->ber_options & LBER_USE_DER ) {
628 /* Write the length itself */
629 AC_FMEMCPY( (*sos)->sos_first + 2, netlen, lenlen - 1 );
631 if (lenlen != FOUR_BYTE_LEN) {
633 * We set aside FOUR_BYTE_LEN bytes for
634 * the length field. Move the data if
635 * we don't actually need that much
637 AC_FMEMCPY( (*sos)->sos_first + taglen +
638 lenlen, (*sos)->sos_first + taglen +
639 FOUR_BYTE_LEN, len );
642 /* the length itself */
643 AC_FMEMCPY( (*sos)->sos_first + taglen + 1,
644 netlen, FOUR_BYTE_LEN - 1 );
647 next->sos_clen += (taglen + lenlen + len);
648 next->sos_ptr += (taglen + lenlen + len);
651 /* we're done with this seqorset, so free it up */
652 ber_memfree_x( (char *) (*sos), ber->ber_memctx );
655 return taglen + lenlen + len;
659 ber_put_seq( BerElement *ber )
661 assert( ber != NULL );
662 assert( LBER_VALID( ber ) );
664 return ber_put_seqorset( ber );
668 ber_put_set( BerElement *ber )
670 assert( ber != NULL );
671 assert( LBER_VALID( ber ) );
673 return ber_put_seqorset( ber );
677 static ber_tag_t lber_int_null = 0;
681 ber_printf( BerElement *ber, LDAP_CONST char *fmt, ... )
685 struct berval *bv, **bvp;
690 assert( ber != NULL );
691 assert( fmt != NULL );
693 assert( LBER_VALID( ber ) );
697 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
699 case '!': { /* hook */
700 BEREncodeCallback *f;
703 f = va_arg( ap, BEREncodeCallback * );
704 p = va_arg( ap, void * );
709 case 'b': /* boolean */
710 i = va_arg( ap, ber_int_t );
711 rc = ber_put_boolean( ber, i, ber->ber_tag );
715 i = va_arg( ap, ber_int_t );
716 rc = ber_put_int( ber, i, ber->ber_tag );
719 case 'e': /* enumeration */
720 i = va_arg( ap, ber_int_t );
721 rc = ber_put_enum( ber, i, ber->ber_tag );
725 rc = ber_put_null( ber, ber->ber_tag );
728 case 'N': /* Debug NULL */
729 if( lber_int_null != 0 ) {
730 /* Insert NULL to ensure peer ignores unknown tags */
731 rc = ber_put_null( ber, lber_int_null );
737 case 'o': /* octet string (non-null terminated) */
738 s = va_arg( ap, char * );
739 len = va_arg( ap, ber_len_t );
740 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
743 case 'O': /* berval octet string */
744 bv = va_arg( ap, struct berval * );
745 if( bv == NULL ) break;
746 rc = ber_put_berval( ber, bv, ber->ber_tag );
749 case 's': /* string */
750 s = va_arg( ap, char * );
751 rc = ber_put_string( ber, s, ber->ber_tag );
754 case 'B': /* bit string */
755 case 'X': /* bit string (deprecated) */
756 s = va_arg( ap, char * );
757 len = va_arg( ap, int ); /* in bits */
758 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
761 case 't': /* tag for the next element */
762 ber->ber_tag = va_arg( ap, ber_tag_t );
763 ber->ber_usertag = 1;
766 case 'v': /* vector of strings */
767 if ( (ss = va_arg( ap, char ** )) == NULL )
769 for ( i = 0; ss[i] != NULL; i++ ) {
770 if ( (rc = ber_put_string( ber, ss[i],
771 ber->ber_tag )) == -1 )
776 case 'V': /* sequences of strings + lengths */
777 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
779 for ( i = 0; bvp[i] != NULL; i++ ) {
780 if ( (rc = ber_put_berval( ber, bvp[i],
781 ber->ber_tag )) == -1 )
786 case 'W': /* BerVarray */
787 if ( (bv = va_arg( ap, BerVarray )) == NULL )
789 for ( i = 0; bv[i].bv_val != NULL; i++ ) {
790 if ( (rc = ber_put_berval( ber, &bv[i],
791 ber->ber_tag )) == -1 )
796 case '{': /* begin sequence */
797 rc = ber_start_seq( ber, ber->ber_tag );
800 case '}': /* end sequence */
801 rc = ber_put_seqorset( ber );
804 case '[': /* begin set */
805 rc = ber_start_set( ber, ber->ber_tag );
808 case ']': /* end set */
809 rc = ber_put_seqorset( ber );
813 if( ber->ber_debug ) {
814 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
815 "ber_printf: unknown fmt %c\n", *fmt );
821 if ( ber->ber_usertag == 0 ) {
822 ber->ber_tag = LBER_DEFAULT;
824 ber->ber_usertag = 0;