1 /* encode.c - ber output encoding routines */
4 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
8 * Copyright (c) 1990 Regents of the University of Michigan.
11 * Redistribution and use in source and binary forms are permitted
12 * provided that this notice is preserved and that due credit is given
13 * to the University of Michigan at Ann Arbor. The name of the University
14 * may not be used to endorse or promote products derived from this
15 * software without specific prior written permission. This software
16 * is provided ``as is'' without express or implied warranty.
23 #include <ac/stdlib.h>
25 #include <ac/stdarg.h>
26 #include <ac/socket.h>
27 #include <ac/string.h>
30 #define LDAP_F_PRE LDAP_F_EXPORT
34 static int ber_put_len LDAP_P((
39 static int ber_start_seqorset LDAP_P((
43 static int ber_put_seqorset LDAP_P(( BerElement *ber ));
45 static int ber_put_int_or_enum LDAP_P((
52 ber_calc_taglen( ber_tag_t tag )
57 /* find the first non-all-zero byte in the tag */
58 for ( i = sizeof(ber_tag_t) - 1; i > 0; i-- ) {
59 mask = ((ber_tag_t)0xffU << (i * 8));
77 unsigned char nettag[sizeof(ber_tag_t)];
80 assert( ber != NULL );
81 assert( BER_VALID( ber ) );
83 taglen = ber_calc_taglen( tag );
85 for( i=0; i<taglen; i++ ) {
86 nettag[(sizeof(ber_tag_t)-1) - i] = (unsigned char)(tag & 0xffU);
91 &nettag[sizeof(ber_tag_t) - taglen],
98 ber_calc_lenlen( ber_len_t len )
101 * short len if it's less than 128 - one byte giving the len,
105 if ( len <= (ber_len_t) 0x7FU )
109 * long len otherwise - one byte with bit 8 set, giving the
110 * length of the length, followed by the length itself.
113 if ( len <= (ber_len_t) 0xffU )
115 if ( len <= (ber_len_t) 0xffffU )
117 if ( len <= (ber_len_t) 0xffffffU )
124 ber_put_len( BerElement *ber, ber_len_t len, int nosos )
130 unsigned char netlen[sizeof(ber_len_t)];
133 assert( ber != NULL );
134 assert( BER_VALID( ber ) );
137 * short len if it's less than 128 - one byte giving the len,
142 char length_byte = (char) len;
143 return( ber_write( ber, &length_byte, 1, nosos ) );
147 * long len otherwise - one byte with bit 8 set, giving the
148 * length of the length, followed by the length itself.
151 /* find the first non-all-zero byte */
152 for ( i = sizeof(ber_len_t) - 1; i > 0; i-- ) {
153 mask = ((ber_len_t)0xffU << (i * 8));
158 lenlen = (unsigned char) ++i;
164 /* write the length of the length */
165 if ( ber_write( ber, &lenlen, 1, nosos ) != 1 )
168 for( j=0; j<i; j++) {
169 netlen[(sizeof(ber_len_t)-1) - j] = (unsigned char)(len & 0xffU);
173 /* write the length itself */
175 &netlen[sizeof(ber_len_t)-i],
178 return rc == i ? i+1 : -1;
189 ber_len_t len, lenlen, taglen;
190 ber_uint_t unum, mask;
191 unsigned char netnum[sizeof(ber_uint_t)];
193 assert( ber != NULL );
194 assert( BER_VALID( ber ) );
197 unum = num; /* Bit fiddling should be done with unsigned values */
200 * high bit is set - look for first non-all-one byte
201 * high bit is clear - look for first non-all-zero byte
203 for ( i = sizeof(ber_int_t) - 1; i > 0; i-- ) {
204 mask = ((ber_uint_t)0xffU << (i * 8));
208 if ( (unum & mask) != mask )
218 * we now have the "leading byte". if the high bit on this
219 * byte matches the sign bit, we need to "back up" a byte.
221 mask = (unum & ((ber_uint_t)0x80U << (i * 8)));
222 if ( (mask && !sign) || (sign && !mask) )
227 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
230 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 )
234 for( j=0; j<i; j++ ) {
235 netnum[(sizeof(ber_int_t)-1) - j] = (unsigned char)(unum & 0xffU);
240 &netnum[sizeof(ber_int_t) - i],
243 /* length of tag + length + contents */
244 return rc == i ? taglen + lenlen + i : -1;
253 assert( ber != NULL );
254 assert( BER_VALID( ber ) );
256 if ( tag == LBER_DEFAULT )
257 tag = LBER_ENUMERATED;
259 return( ber_put_int_or_enum( ber, num, tag ) );
268 assert( ber != NULL );
269 assert( BER_VALID( ber ) );
271 if ( tag == LBER_DEFAULT )
274 return( ber_put_int_or_enum( ber, num, tag ) );
280 LDAP_CONST char *str,
284 ber_len_t taglen, lenlen;
286 #ifdef STR_TRANSLATION
288 #endif /* STR_TRANSLATION */
290 assert( ber != NULL );
291 assert( str != NULL );
293 assert( BER_VALID( ber ) );
295 if ( tag == LBER_DEFAULT )
296 tag = LBER_OCTETSTRING;
298 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
301 #ifdef STR_TRANSLATION
302 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0 &&
303 ber->ber_encode_translate_proc ) {
304 if ( (*(ber->ber_encode_translate_proc))( &str, &len, 0 )
312 #endif /* STR_TRANSLATION */
314 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
315 (ber_len_t) ber_write( ber, str, len, 0 ) != len ) {
318 /* return length of tag + length + contents */
319 rc = taglen + lenlen + len;
322 #ifdef STR_TRANSLATION
326 #endif /* STR_TRANSLATION */
334 LDAP_CONST struct berval *bv,
337 assert( ber != NULL );
338 assert( BER_VALID( ber ) );
340 if( bv == NULL || bv->bv_len == 0 ) {
341 return ber_put_ostring( ber, "", (ber_len_t) 0, tag );
344 return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
350 LDAP_CONST char *str,
353 assert( ber != NULL );
354 assert( str != NULL );
356 assert( BER_VALID( ber ) );
358 return( ber_put_ostring( ber, str, strlen( str ), tag ));
364 LDAP_CONST char *str,
365 ber_len_t blen /* in bits */,
368 ber_len_t taglen, lenlen, len;
369 unsigned char unusedbits;
371 assert( ber != NULL );
372 assert( str != NULL );
374 assert( BER_VALID( ber ) );
376 if ( tag == LBER_DEFAULT )
377 tag = LBER_BITSTRING;
379 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
382 len = ( blen + 7 ) / 8;
383 unusedbits = (unsigned char) ((len * 8) - blen);
384 if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 )
387 if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 )
390 if ( (ber_len_t) ber_write( ber, str, len, 0 ) != len )
393 /* return length of tag + length + unused bit count + contents */
394 return( taglen + 1 + lenlen + len );
398 ber_put_null( BerElement *ber, ber_tag_t tag )
402 assert( ber != NULL );
403 assert( BER_VALID( ber ) );
405 if ( tag == LBER_DEFAULT )
408 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
411 if ( ber_put_len( ber, 0, 0 ) != 1 )
414 return( taglen + 1 );
424 unsigned char trueval = 0xFFU;
425 unsigned char falseval = 0x00U;
427 assert( ber != NULL );
428 assert( BER_VALID( ber ) );
430 if ( tag == LBER_DEFAULT )
433 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
436 if ( ber_put_len( ber, 1, 0 ) != 1 )
439 if ( ber_write( ber, (char *)(boolval ? &trueval : &falseval), 1, 0 )
443 return( taglen + 2 );
446 #define FOUR_BYTE_LEN 5
455 assert( ber != NULL );
456 assert( BER_VALID( ber ) );
458 new = (Seqorset *) LBER_CALLOC( 1, sizeof(Seqorset) );
464 if ( ber->ber_sos == NULL )
465 new->sos_first = ber->ber_ptr;
467 new->sos_first = ber->ber_sos->sos_ptr;
469 /* Set aside room for a 4 byte length field */
470 new->sos_ptr = new->sos_first + ber_calc_taglen( tag ) + FOUR_BYTE_LEN;
473 new->sos_next = ber->ber_sos;
480 ber_start_seq( BerElement *ber, ber_tag_t tag )
482 assert( ber != NULL );
483 assert( BER_VALID( ber ) );
485 if ( tag == LBER_DEFAULT )
488 return( ber_start_seqorset( ber, tag ) );
492 ber_start_set( BerElement *ber, ber_tag_t tag )
494 assert( ber != NULL );
495 assert( BER_VALID( ber ) );
497 if ( tag == LBER_DEFAULT )
500 return( ber_start_seqorset( ber, tag ) );
504 ber_put_seqorset( BerElement *ber )
508 unsigned char netlen[sizeof(ber_len_t)];
509 ber_len_t taglen, lenlen;
510 unsigned char ltag = 0x80U + FOUR_BYTE_LEN - 1;
512 Seqorset **sos = &ber->ber_sos;
514 assert( ber != NULL );
515 assert( BER_VALID( ber ) );
518 * If this is the toplevel sequence or set, we need to actually
519 * write the stuff out. Otherwise, it's already been put in
520 * the appropriate buffer and will be written when the toplevel
521 * one is written. In this case all we need to do is update the
525 len = (*sos)->sos_clen;
527 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;
539 for( i=0; i < lenlen-1; i++ ) {
540 netlen[(sizeof(ber_len_t)-1) - i] =
541 (unsigned char)((len >> i*8) & 0xffU);
544 netlen[sizeof(ber_len_t)-1] = (unsigned char)(len & 0x7fU);
547 if ( (next = (*sos)->sos_next) == NULL ) {
549 if ( (taglen = ber_put_tag( ber, (*sos)->sos_tag, 1 )) == -1 )
552 if ( ber->ber_options & LBER_USE_DER ) {
553 /* Write the length in the minimum # of octets */
554 if ( ber_put_len( ber, len, 1 ) == -1 )
557 if (lenlen != FOUR_BYTE_LEN) {
559 * We set aside FOUR_BYTE_LEN bytes for
560 * the length field. Move the data if
561 * we don't actually need that much
563 SAFEMEMCPY( (*sos)->sos_first + taglen +
564 lenlen, (*sos)->sos_first + taglen +
565 FOUR_BYTE_LEN, len );
568 /* Fill FOUR_BYTE_LEN bytes for length field */
569 /* one byte of length length */
570 if ( ber_write( ber, (char *)<ag, 1, 1 ) != 1 )
573 /* the length itself */
575 &netlen[sizeof(ber_len_t) - (FOUR_BYTE_LEN-1)],
576 FOUR_BYTE_LEN-1, 1 );
578 if( rc != FOUR_BYTE_LEN - 1 ) {
582 /* The ber_ptr is at the set/seq start - move it to the end */
583 (*sos)->sos_ber->ber_ptr += len;
587 unsigned char nettag[sizeof(ber_tag_t)];
588 ber_tag_t tmptag = (*sos)->sos_tag;
591 taglen = ber_calc_taglen( tmptag );
593 for( i = 0; i < taglen; i++ ) {
594 nettag[(sizeof(ber_tag_t)-1) - i] = (unsigned char)(tmptag & 0xffU);
598 SAFEMEMCPY( (*sos)->sos_first,
599 &nettag[sizeof(ber_tag_t) - taglen],
602 if ( ber->ber_options & LBER_USE_DER ) {
604 ? (unsigned char) len
605 : (unsigned char) (0x80U + (lenlen - 1));
608 /* one byte of length length */
609 SAFEMEMCPY( (*sos)->sos_first + 1, <ag, 1 );
611 if ( ber->ber_options & LBER_USE_DER ) {
613 /* Write the length itself */
614 SAFEMEMCPY( (*sos)->sos_first + 2,
615 &netlen[sizeof(ber_len_t) - (lenlen - 1)],
618 if (lenlen != FOUR_BYTE_LEN) {
620 * We set aside FOUR_BYTE_LEN bytes for
621 * the length field. Move the data if
622 * we don't actually need that much
624 SAFEMEMCPY( (*sos)->sos_first + taglen +
625 lenlen, (*sos)->sos_first + taglen +
626 FOUR_BYTE_LEN, len );
629 /* the length itself */
630 SAFEMEMCPY( (*sos)->sos_first + taglen + 1,
631 &netlen[sizeof(ber_len_t) - (FOUR_BYTE_LEN - 1)],
635 next->sos_clen += (taglen + lenlen + len);
636 next->sos_ptr += (taglen + lenlen + len);
639 /* we're done with this seqorset, so free it up */
640 LBER_FREE( (char *) (*sos) );
643 return( taglen + lenlen + len );
647 ber_put_seq( BerElement *ber )
649 assert( ber != NULL );
650 assert( BER_VALID( ber ) );
652 return( ber_put_seqorset( ber ) );
656 ber_put_set( BerElement *ber )
658 assert( ber != NULL );
659 assert( BER_VALID( ber ) );
661 return( ber_put_seqorset( ber ) );
666 ber_printf( BerElement *ber, LDAP_CONST char *fmt, ... )
670 struct berval *bv, **bvp;
675 assert( ber != NULL );
676 assert( fmt != NULL );
678 assert( BER_VALID( ber ) );
682 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
684 case '!': { /* hook */
685 BEREncodeCallback *f;
688 f = va_arg( ap, BEREncodeCallback * );
689 p = va_arg( ap, void * );
694 case 'b': /* boolean */
695 i = va_arg( ap, ber_int_t );
696 rc = ber_put_boolean( ber, i, ber->ber_tag );
700 i = va_arg( ap, ber_int_t );
701 rc = ber_put_int( ber, i, ber->ber_tag );
704 case 'e': /* enumeration */
705 i = va_arg( ap, ber_int_t );
706 rc = ber_put_enum( ber, i, ber->ber_tag );
710 rc = ber_put_null( ber, ber->ber_tag );
713 case 'o': /* octet string (non-null terminated) */
714 s = va_arg( ap, char * );
715 len = va_arg( ap, ber_len_t );
716 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
719 case 'O': /* berval octet string */
720 bv = va_arg( ap, struct berval * );
721 if( bv == NULL ) break;
722 rc = ber_put_berval( ber, bv, ber->ber_tag );
725 case 's': /* string */
726 s = va_arg( ap, char * );
727 rc = ber_put_string( ber, s, ber->ber_tag );
730 case 'B': /* bit string */
731 case 'X': /* bit string (deprecated) */
732 s = va_arg( ap, char * );
733 len = va_arg( ap, int ); /* in bits */
734 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
737 case 't': /* tag for the next element */
738 ber->ber_tag = va_arg( ap, ber_tag_t );
739 ber->ber_usertag = 1;
742 case 'v': /* vector of strings */
743 if ( (ss = va_arg( ap, char ** )) == NULL )
745 for ( i = 0; ss[i] != NULL; i++ ) {
746 if ( (rc = ber_put_string( ber, ss[i],
747 ber->ber_tag )) == -1 )
752 case 'V': /* sequences of strings + lengths */
753 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
755 for ( i = 0; bvp[i] != NULL; i++ ) {
756 if ( (rc = ber_put_berval( ber, bvp[i],
757 ber->ber_tag )) == -1 )
762 case '{': /* begin sequence */
763 rc = ber_start_seq( ber, ber->ber_tag );
766 case '}': /* end sequence */
767 rc = ber_put_seqorset( ber );
770 case '[': /* begin set */
771 rc = ber_start_set( ber, ber->ber_tag );
774 case ']': /* end set */
775 rc = ber_put_seqorset( ber );
779 if( ber->ber_debug ) {
780 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
781 "ber_printf: unknown fmt %c\n", *fmt );
787 if ( ber->ber_usertag == 0 )
788 ber->ber_tag = LBER_DEFAULT;
790 ber->ber_usertag = 0;