1 /* encode.c - ber output encoding routines */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2007 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;
180 /* out->bv_len should be the buffer size on input */
182 ber_encode_oid( BerValue *in, BerValue *out )
184 unsigned char *der = out->bv_val;
185 unsigned long val, val1;
187 char *ptr, *end, *inend;
189 assert( in != NULL );
190 assert( out != NULL );
192 if ( !out->bv_val || out->bv_len < in->bv_len )
195 /* OIDs must have at least two components */
196 if ( sscanf( in->bv_val, "%ld.%ld", &val, &val1 ) != 2 )
202 inend = in->bv_val + in->bv_len;
204 ptr = strchr( in->bv_val, '.' );
205 ptr = strchr( ptr+1, '.' );
216 i = sizeof(unsigned long) + 1;
222 der[i] = val1 | hibit;
227 AC_MEMCPY( der, der+i, len );
231 if ( ptr >= inend ) break;
232 val = strtol( ptr, &end, 10 );
233 if ( ptr == end ) break;
234 if ( *end && *end != '.' ) break;
237 out->bv_len = (char *)der - out->bv_val;
248 int i, j, sign, taglen, lenlen;
250 ber_uint_t unum, mask;
251 unsigned char netnum[sizeof(ber_uint_t)];
253 assert( ber != NULL );
254 assert( LBER_VALID( ber ) );
257 unum = num; /* Bit fiddling should be done with unsigned values */
260 * high bit is set - look for first non-all-one byte
261 * high bit is clear - look for first non-all-zero byte
263 i = BER_TOP_BYTE(ber_int_t);
264 mask = BER_TOP_MASK(ber_uint_t);
265 for ( ; i > 0; i-- ) {
268 if ( (unum & mask) != mask ) break;
271 if ( unum & mask ) break;
277 * we now have the "leading byte". if the high bit on this
278 * byte matches the sign bit, we need to "back up" a byte.
280 mask = (unum & ((ber_uint_t)0x80U << (i * 8)));
281 if ( (mask && !sign) || (sign && !mask) ) {
287 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
291 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ) {
296 for( j=i-1; j>=0; j-- ) {
297 netnum[j] = (unsigned char)(unum & 0xffU);
301 rc = ber_write( ber, (char *) netnum, i, 0 );
303 /* length of tag + length + contents */
304 return rc == i ? taglen + lenlen + i : -1;
313 assert( ber != NULL );
314 assert( LBER_VALID( ber ) );
316 if ( tag == LBER_DEFAULT ) {
317 tag = LBER_ENUMERATED;
320 return ber_put_int_or_enum( ber, num, tag );
329 assert( ber != NULL );
330 assert( LBER_VALID( ber ) );
332 if ( tag == LBER_DEFAULT ) {
336 return ber_put_int_or_enum( ber, num, tag );
342 LDAP_CONST char *str,
346 int taglen, lenlen, rc;
348 assert( ber != NULL );
349 assert( str != NULL );
351 assert( LBER_VALID( ber ) );
353 if ( tag == LBER_DEFAULT ) {
354 tag = LBER_OCTETSTRING;
357 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
360 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
361 (ber_len_t) ber_write( ber, str, len, 0 ) != len )
365 /* return length of tag + length + contents */
366 rc = taglen + lenlen + len;
378 assert( ber != NULL );
379 assert( LBER_VALID( ber ) );
381 if( bv == NULL || bv->bv_len == 0 ) {
382 return ber_put_ostring( ber, "", (ber_len_t) 0, tag );
385 return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
391 LDAP_CONST char *str,
394 assert( ber != NULL );
395 assert( str != NULL );
397 assert( LBER_VALID( ber ) );
399 return ber_put_ostring( ber, str, strlen( str ), tag );
405 LDAP_CONST char *str,
406 ber_len_t blen /* in bits */,
411 unsigned char unusedbits;
413 assert( ber != NULL );
414 assert( str != NULL );
416 assert( LBER_VALID( ber ) );
418 if ( tag == LBER_DEFAULT ) {
419 tag = LBER_BITSTRING;
422 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
426 len = ( blen + 7 ) / 8;
427 unusedbits = (unsigned char) ((len * 8) - blen);
428 if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 ) {
432 if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 ) {
436 if ( (ber_len_t) ber_write( ber, str, len, 0 ) != len ) {
440 /* return length of tag + length + unused bit count + contents */
441 return taglen + 1 + lenlen + len;
445 ber_put_null( BerElement *ber, ber_tag_t tag )
449 assert( ber != NULL );
450 assert( LBER_VALID( ber ) );
452 if ( tag == LBER_DEFAULT ) {
456 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
460 if ( ber_put_len( ber, 0, 0 ) != 1 ) {
476 assert( ber != NULL );
477 assert( LBER_VALID( ber ) );
479 if ( tag == LBER_DEFAULT )
482 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
486 if ( ber_put_len( ber, 1, 0 ) != 1 ) {
490 c = boolval ? (unsigned char) ~0U : (unsigned char) 0U;
492 if ( ber_write( ber, (char *) &c, 1, 0 ) != 1 ) {
499 #define FOUR_BYTE_LEN 5
508 assert( ber != NULL );
509 assert( LBER_VALID( ber ) );
511 new = (Seqorset *) ber_memcalloc_x( 1, sizeof(Seqorset), ber->ber_memctx );
518 if ( ber->ber_sos == NULL ) {
519 new->sos_first = ber->ber_ptr;
521 new->sos_first = ber->ber_sos->sos_ptr;
524 /* Set aside room for a 4 byte length field */
525 new->sos_ptr = new->sos_first + ber_calc_taglen( tag ) + FOUR_BYTE_LEN;
528 new->sos_next = ber->ber_sos;
535 ber_start_seq( BerElement *ber, ber_tag_t tag )
537 assert( ber != NULL );
538 assert( LBER_VALID( ber ) );
540 if ( tag == LBER_DEFAULT ) {
544 return ber_start_seqorset( ber, tag );
548 ber_start_set( BerElement *ber, ber_tag_t tag )
550 assert( ber != NULL );
551 assert( LBER_VALID( ber ) );
553 if ( tag == LBER_DEFAULT ) {
557 return ber_start_seqorset( ber, tag );
561 ber_put_seqorset( BerElement *ber )
565 unsigned char netlen[sizeof(ber_len_t)];
568 unsigned char ltag = 0x80U + FOUR_BYTE_LEN - 1;
570 Seqorset **sos = &ber->ber_sos;
572 assert( ber != NULL );
573 assert( LBER_VALID( ber ) );
575 if( *sos == NULL ) return -1;
578 * If this is the toplevel sequence or set, we need to actually
579 * write the stuff out. Otherwise, it's already been put in
580 * the appropriate buffer and will be written when the toplevel
581 * one is written. In this case all we need to do is update the
585 len = (*sos)->sos_clen;
587 if ( sizeof(ber_len_t) > 4 && len > 0xffffffffUL ) {
591 if ( ber->ber_options & LBER_USE_DER ) {
592 lenlen = ber_calc_lenlen( len );
595 lenlen = FOUR_BYTE_LEN;
601 for( i=lenlen-2; i >= 0; i-- ) {
602 netlen[i] = j & 0xffU;
606 netlen[0] = (unsigned char)(len & 0x7fU);
609 if ( (next = (*sos)->sos_next) == NULL ) {
611 if ( (taglen = ber_put_tag( ber, (*sos)->sos_tag, 1 )) == -1 ) {
615 if ( ber->ber_options & LBER_USE_DER ) {
616 /* Write the length in the minimum # of octets */
617 if ( ber_put_len( ber, len, 1 ) == -1 ) {
621 if (lenlen != FOUR_BYTE_LEN) {
623 * We set aside FOUR_BYTE_LEN bytes for
624 * the length field. Move the data if
625 * we don't actually need that much
627 AC_MEMCPY( (*sos)->sos_first + taglen +
628 lenlen, (*sos)->sos_first + taglen +
629 FOUR_BYTE_LEN, len );
632 /* Fill FOUR_BYTE_LEN bytes for length field */
633 /* one byte of length length */
634 if ( ber_write( ber, (char *)<ag, 1, 1 ) != 1 ) {
638 /* the length itself */
639 rc = ber_write( ber, (char *) netlen, FOUR_BYTE_LEN-1, 1 );
641 if( rc != FOUR_BYTE_LEN - 1 ) {
645 /* The ber_ptr is at the set/seq start - move it to the end */
646 (*sos)->sos_ber->ber_ptr += len;
650 unsigned char nettag[sizeof(ber_tag_t)];
651 ber_tag_t tmptag = (*sos)->sos_tag;
653 if( ber->ber_sos->sos_ptr > ber->ber_end ) {
654 /* The sos_ptr exceeds the end of the BerElement
655 * this can happen, for example, when the sos_ptr
656 * is near the end and no data was written for the
657 * 'V'. We must realloc the BerElement to ensure
658 * we don't overwrite the buffer when writing
659 * the tag and length fields.
661 ber_len_t ext = ber->ber_sos->sos_ptr - ber->ber_end;
663 if( ber_realloc( ber, ext ) != 0 ) {
669 taglen = ber_calc_taglen( tmptag );
671 for( i = taglen-1; i >= 0; i-- ) {
672 nettag[i] = (unsigned char)(tmptag & 0xffU);
676 AC_FMEMCPY( (*sos)->sos_first, nettag, taglen );
678 if ( ber->ber_options & LBER_USE_DER ) {
680 ? (unsigned char) len
681 : (unsigned char) (0x80U + (lenlen - 1));
684 /* one byte of length length */
685 (*sos)->sos_first[1] = ltag;
687 if ( ber->ber_options & LBER_USE_DER ) {
689 /* Write the length itself */
690 AC_FMEMCPY( (*sos)->sos_first + 2, netlen, lenlen - 1 );
692 if (lenlen != FOUR_BYTE_LEN) {
694 * We set aside FOUR_BYTE_LEN bytes for
695 * the length field. Move the data if
696 * we don't actually need that much
698 AC_FMEMCPY( (*sos)->sos_first + taglen +
699 lenlen, (*sos)->sos_first + taglen +
700 FOUR_BYTE_LEN, len );
703 /* the length itself */
704 AC_FMEMCPY( (*sos)->sos_first + taglen + 1,
705 netlen, FOUR_BYTE_LEN - 1 );
708 next->sos_clen += (taglen + lenlen + len);
709 next->sos_ptr += (taglen + lenlen + len);
712 /* we're done with this seqorset, so free it up */
713 ber_memfree_x( (char *) (*sos), ber->ber_memctx );
716 return taglen + lenlen + len;
720 ber_put_seq( BerElement *ber )
722 assert( ber != NULL );
723 assert( LBER_VALID( ber ) );
725 return ber_put_seqorset( ber );
729 ber_put_set( BerElement *ber )
731 assert( ber != NULL );
732 assert( LBER_VALID( ber ) );
734 return ber_put_seqorset( ber );
738 static ber_tag_t lber_int_null = 0;
742 ber_printf( BerElement *ber, LDAP_CONST char *fmt, ... )
746 struct berval *bv, **bvp;
751 assert( ber != NULL );
752 assert( fmt != NULL );
754 assert( LBER_VALID( ber ) );
758 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
760 case '!': { /* hook */
761 BEREncodeCallback *f;
764 f = va_arg( ap, BEREncodeCallback * );
765 p = va_arg( ap, void * );
770 case 'b': /* boolean */
771 i = va_arg( ap, ber_int_t );
772 rc = ber_put_boolean( ber, i, ber->ber_tag );
776 i = va_arg( ap, ber_int_t );
777 rc = ber_put_int( ber, i, ber->ber_tag );
780 case 'e': /* enumeration */
781 i = va_arg( ap, ber_int_t );
782 rc = ber_put_enum( ber, i, ber->ber_tag );
786 rc = ber_put_null( ber, ber->ber_tag );
789 case 'N': /* Debug NULL */
790 if( lber_int_null != 0 ) {
791 /* Insert NULL to ensure peer ignores unknown tags */
792 rc = ber_put_null( ber, lber_int_null );
798 case 'o': /* octet string (non-null terminated) */
799 s = va_arg( ap, char * );
800 len = va_arg( ap, ber_len_t );
801 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
804 case 'O': /* berval octet string */
805 bv = va_arg( ap, struct berval * );
806 if( bv == NULL ) break;
807 rc = ber_put_berval( ber, bv, ber->ber_tag );
810 case 's': /* string */
811 s = va_arg( ap, char * );
812 rc = ber_put_string( ber, s, ber->ber_tag );
815 case 'B': /* bit string */
816 case 'X': /* bit string (deprecated) */
817 s = va_arg( ap, char * );
818 len = va_arg( ap, int ); /* in bits */
819 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
822 case 't': /* tag for the next element */
823 ber->ber_tag = va_arg( ap, ber_tag_t );
824 ber->ber_usertag = 1;
827 case 'v': /* vector of strings */
828 if ( (ss = va_arg( ap, char ** )) == NULL )
830 for ( i = 0; ss[i] != NULL; i++ ) {
831 if ( (rc = ber_put_string( ber, ss[i],
832 ber->ber_tag )) == -1 )
837 case 'V': /* sequences of strings + lengths */
838 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
840 for ( i = 0; bvp[i] != NULL; i++ ) {
841 if ( (rc = ber_put_berval( ber, bvp[i],
842 ber->ber_tag )) == -1 )
847 case 'W': /* BerVarray */
848 if ( (bv = va_arg( ap, BerVarray )) == NULL )
850 for ( i = 0; bv[i].bv_val != NULL; i++ ) {
851 if ( (rc = ber_put_berval( ber, &bv[i],
852 ber->ber_tag )) == -1 )
857 case '{': /* begin sequence */
858 rc = ber_start_seq( ber, ber->ber_tag );
861 case '}': /* end sequence */
862 rc = ber_put_seqorset( ber );
865 case '[': /* begin set */
866 rc = ber_start_set( ber, ber->ber_tag );
869 case ']': /* end set */
870 rc = ber_put_seqorset( ber );
874 if( ber->ber_debug ) {
875 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
876 "ber_printf: unknown fmt %c\n", *fmt );
882 if ( ber->ber_usertag == 0 ) {
883 ber->ber_tag = LBER_DEFAULT;
885 ber->ber_usertag = 0;