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)];
79 assert( ber != NULL );
80 assert( BER_VALID( ber ) );
82 taglen = ber_calc_taglen( tag );
84 for( i=0; i<taglen; i++ ) {
85 nettag[(sizeof(ber_tag_t)-1) - i] = (unsigned char)(tag & 0xffU);
90 &nettag[sizeof(ber_tag_t) - taglen],
97 ber_calc_lenlen( ber_len_t len )
100 * short len if it's less than 128 - one byte giving the len,
104 if ( len <= (ber_len_t) 0x7FU )
108 * long len otherwise - one byte with bit 8 set, giving the
109 * length of the length, followed by the length itself.
112 if ( len <= (ber_len_t) 0xffU )
114 if ( len <= (ber_len_t) 0xffffU )
116 if ( len <= (ber_len_t) 0xffffffU )
123 ber_put_len( BerElement *ber, ber_len_t len, int nosos )
129 unsigned char netlen[sizeof(ber_len_t)];
131 assert( ber != NULL );
132 assert( BER_VALID( ber ) );
135 * short len if it's less than 128 - one byte giving the len,
140 char length_byte = (char) len;
141 return( ber_write( ber, &length_byte, 1, nosos ) );
145 * long len otherwise - one byte with bit 8 set, giving the
146 * length of the length, followed by the length itself.
149 /* find the first non-all-zero byte */
150 for ( i = sizeof(ber_len_t) - 1; i > 0; i-- ) {
151 mask = ((ber_len_t)0xffU << (i * 8));
156 lenlen = (unsigned char) ++i;
162 /* write the length of the length */
163 if ( ber_write( ber, &lenlen, 1, nosos ) != 1 )
166 for( j=0; j<i; j++) {
167 netlen[(sizeof(ber_len_t)-1) - j] = (unsigned char)(len & 0xffU);
171 /* write the length itself */
173 &netlen[sizeof(ber_len_t)-i],
176 return rc == i ? i+1 : -1;
187 ber_len_t len, lenlen, taglen;
188 ber_uint_t unum, mask;
189 unsigned char netnum[sizeof(ber_uint_t)];
191 assert( ber != NULL );
192 assert( BER_VALID( ber ) );
195 unum = num; /* Bit fiddling should be done with unsigned values */
198 * high bit is set - look for first non-all-one byte
199 * high bit is clear - look for first non-all-zero byte
201 for ( i = sizeof(ber_int_t) - 1; i > 0; i-- ) {
202 mask = ((ber_uint_t)0xffU << (i * 8));
206 if ( (unum & mask) != mask )
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) )
225 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
228 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 )
232 for( j=0; j<i; j++ ) {
233 netnum[(sizeof(ber_int_t)-1) - j] = (unsigned char)(unum & 0xffU);
238 &netnum[sizeof(ber_int_t) - i],
241 /* length of tag + length + contents */
242 return rc == i ? taglen + lenlen + i : -1;
251 assert( ber != NULL );
252 assert( BER_VALID( ber ) );
254 if ( tag == LBER_DEFAULT )
255 tag = LBER_ENUMERATED;
257 return( ber_put_int_or_enum( ber, num, tag ) );
266 assert( ber != NULL );
267 assert( BER_VALID( ber ) );
269 if ( tag == LBER_DEFAULT )
272 return( ber_put_int_or_enum( ber, num, tag ) );
278 LDAP_CONST char *str,
282 ber_len_t taglen, lenlen;
284 #ifdef STR_TRANSLATION
286 #endif /* STR_TRANSLATION */
288 assert( ber != NULL );
289 assert( str != NULL );
291 assert( BER_VALID( ber ) );
293 if ( tag == LBER_DEFAULT )
294 tag = LBER_OCTETSTRING;
296 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
299 #ifdef STR_TRANSLATION
300 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0 &&
301 ber->ber_encode_translate_proc ) {
302 if ( (*(ber->ber_encode_translate_proc))( &str, &len, 0 ) != 0 ) {
309 #endif /* STR_TRANSLATION */
311 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
312 (ber_len_t) ber_write( ber, str, len, 0 ) != len ) {
315 /* return length of tag + length + contents */
316 rc = taglen + lenlen + len;
319 #ifdef STR_TRANSLATION
323 #endif /* STR_TRANSLATION */
331 LDAP_CONST struct berval *bv,
334 assert( ber != NULL );
335 assert( BER_VALID( ber ) );
337 if( bv == NULL || bv->bv_len == 0 ) {
338 return ber_put_ostring( ber, "", (ber_len_t) 0, tag );
341 return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
347 LDAP_CONST char *str,
350 assert( ber != NULL );
351 assert( str != NULL );
353 assert( BER_VALID( ber ) );
355 return( ber_put_ostring( ber, str, strlen( str ), tag ));
361 LDAP_CONST char *str,
362 ber_len_t blen /* in bits */,
365 ber_len_t taglen, lenlen, len;
366 unsigned char unusedbits;
368 assert( ber != NULL );
369 assert( str != NULL );
371 assert( BER_VALID( ber ) );
373 if ( tag == LBER_DEFAULT )
374 tag = LBER_BITSTRING;
376 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
379 len = ( blen + 7 ) / 8;
380 unusedbits = (unsigned char) ((len * 8) - blen);
381 if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 )
384 if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 )
387 if ( (ber_len_t) ber_write( ber, str, len, 0 ) != len )
390 /* return length of tag + length + unused bit count + contents */
391 return( taglen + 1 + lenlen + len );
395 ber_put_null( BerElement *ber, ber_tag_t tag )
399 assert( ber != NULL );
400 assert( BER_VALID( ber ) );
402 if ( tag == LBER_DEFAULT )
405 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
408 if ( ber_put_len( ber, 0, 0 ) != 1 )
411 return( taglen + 1 );
421 unsigned char trueval = 0xFFU;
422 unsigned char falseval = 0x00U;
424 assert( ber != NULL );
425 assert( BER_VALID( ber ) );
427 if ( tag == LBER_DEFAULT )
430 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
433 if ( ber_put_len( ber, 1, 0 ) != 1 )
436 if ( ber_write( ber, (char *)(boolval ? &trueval : &falseval), 1, 0 )
440 return( taglen + 2 );
443 #define FOUR_BYTE_LEN 5
452 assert( ber != NULL );
453 assert( BER_VALID( ber ) );
455 new = (Seqorset *) LBER_CALLOC( 1, sizeof(Seqorset) );
461 if ( ber->ber_sos == NULL )
462 new->sos_first = ber->ber_ptr;
464 new->sos_first = ber->ber_sos->sos_ptr;
466 /* Set aside room for a 4 byte length field */
467 new->sos_ptr = new->sos_first + ber_calc_taglen( tag ) + FOUR_BYTE_LEN;
470 new->sos_next = ber->ber_sos;
477 ber_start_seq( BerElement *ber, ber_tag_t tag )
479 assert( ber != NULL );
480 assert( BER_VALID( ber ) );
482 if ( tag == LBER_DEFAULT )
485 return( ber_start_seqorset( ber, tag ) );
489 ber_start_set( BerElement *ber, ber_tag_t tag )
491 assert( ber != NULL );
492 assert( BER_VALID( ber ) );
494 if ( tag == LBER_DEFAULT )
497 return( ber_start_seqorset( ber, tag ) );
501 ber_put_seqorset( BerElement *ber )
505 unsigned char netlen[sizeof(ber_len_t)];
506 ber_len_t taglen, lenlen;
507 unsigned char ltag = 0x80U + FOUR_BYTE_LEN - 1;
509 Seqorset **sos = &ber->ber_sos;
511 assert( ber != NULL );
512 assert( BER_VALID( ber ) );
515 * If this is the toplevel sequence or set, we need to actually
516 * write the stuff out. Otherwise, it's already been put in
517 * the appropriate buffer and will be written when the toplevel
518 * one is written. In this case all we need to do is update the
522 len = (*sos)->sos_clen;
524 if ( sizeof(ber_len_t) > 4 && len > 0xffffffffUL )
527 if ( ber->ber_options & LBER_USE_DER ) {
528 lenlen = ber_calc_lenlen( len );
531 lenlen = FOUR_BYTE_LEN;
536 for( i=0; i < lenlen-1; i++ ) {
537 netlen[(sizeof(ber_len_t)-1) - i] =
538 (unsigned char)((len >> i*8) & 0xffU);
541 netlen[sizeof(ber_len_t)-1] = (unsigned char)(len & 0x7fU);
544 if ( (next = (*sos)->sos_next) == NULL ) {
546 if ( (taglen = ber_put_tag( ber, (*sos)->sos_tag, 1 )) == -1 )
549 if ( ber->ber_options & LBER_USE_DER ) {
550 /* Write the length in the minimum # of octets */
551 if ( ber_put_len( ber, len, 1 ) == -1 )
554 if (lenlen != FOUR_BYTE_LEN) {
556 * We set aside FOUR_BYTE_LEN bytes for
557 * the length field. Move the data if
558 * we don't actually need that much
560 SAFEMEMCPY( (*sos)->sos_first + taglen +
561 lenlen, (*sos)->sos_first + taglen +
562 FOUR_BYTE_LEN, len );
565 /* Fill FOUR_BYTE_LEN bytes for length field */
566 /* one byte of length length */
567 if ( ber_write( ber, (char *)<ag, 1, 1 ) != 1 )
570 /* the length itself */
572 &netlen[sizeof(ber_len_t) - (FOUR_BYTE_LEN-1)],
573 FOUR_BYTE_LEN-1, 1 );
575 if( rc != FOUR_BYTE_LEN - 1 ) {
579 /* The ber_ptr is at the set/seq start - move it to the end */
580 (*sos)->sos_ber->ber_ptr += len;
584 unsigned char nettag[sizeof(ber_tag_t)];
585 ber_tag_t tmptag = (*sos)->sos_tag;
588 taglen = ber_calc_taglen( tmptag );
590 for( i = 0; i < taglen; i++ ) {
591 nettag[(sizeof(ber_tag_t)-1) - i] = (unsigned char)(tmptag & 0xffU);
595 SAFEMEMCPY( (*sos)->sos_first,
596 &nettag[sizeof(ber_tag_t) - taglen],
599 if ( ber->ber_options & LBER_USE_DER ) {
601 ? (unsigned char) len
602 : (unsigned char) (0x80U + (lenlen - 1));
605 /* one byte of length length */
606 SAFEMEMCPY( (*sos)->sos_first + 1, <ag, 1 );
608 if ( ber->ber_options & LBER_USE_DER ) {
610 /* Write the length itself */
611 SAFEMEMCPY( (*sos)->sos_first + 2,
612 &netlen[sizeof(ber_len_t) - (lenlen - 1)],
615 if (lenlen != FOUR_BYTE_LEN) {
617 * We set aside FOUR_BYTE_LEN bytes for
618 * the length field. Move the data if
619 * we don't actually need that much
621 SAFEMEMCPY( (*sos)->sos_first + taglen +
622 lenlen, (*sos)->sos_first + taglen +
623 FOUR_BYTE_LEN, len );
626 /* the length itself */
627 SAFEMEMCPY( (*sos)->sos_first + taglen + 1,
628 &netlen[sizeof(ber_len_t) - (FOUR_BYTE_LEN - 1)],
632 next->sos_clen += (taglen + lenlen + len);
633 next->sos_ptr += (taglen + lenlen + len);
636 /* we're done with this seqorset, so free it up */
637 LBER_FREE( (char *) (*sos) );
640 return( taglen + lenlen + len );
644 ber_put_seq( BerElement *ber )
646 assert( ber != NULL );
647 assert( BER_VALID( ber ) );
649 return( ber_put_seqorset( ber ) );
653 ber_put_set( BerElement *ber )
655 assert( ber != NULL );
656 assert( BER_VALID( ber ) );
658 return( ber_put_seqorset( ber ) );
663 ber_printf( BerElement *ber, LDAP_CONST char *fmt, ... )
667 struct berval *bv, **bvp;
672 assert( ber != NULL );
673 assert( fmt != NULL );
675 assert( BER_VALID( ber ) );
679 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
681 case '!': { /* hook */
682 BEREncodeCallback *f;
685 f = va_arg( ap, BEREncodeCallback * );
686 p = va_arg( ap, void * );
691 case 'b': /* boolean */
692 i = va_arg( ap, ber_int_t );
693 rc = ber_put_boolean( ber, i, ber->ber_tag );
697 i = va_arg( ap, ber_int_t );
698 rc = ber_put_int( ber, i, ber->ber_tag );
701 case 'e': /* enumeration */
702 i = va_arg( ap, ber_int_t );
703 rc = ber_put_enum( ber, i, ber->ber_tag );
707 rc = ber_put_null( ber, ber->ber_tag );
710 case 'o': /* octet string (non-null terminated) */
711 s = va_arg( ap, char * );
712 len = va_arg( ap, ber_len_t );
713 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
716 case 'O': /* berval octet string */
717 bv = va_arg( ap, struct berval * );
718 if( bv == NULL ) break;
719 rc = ber_put_berval( ber, bv, ber->ber_tag );
722 case 's': /* string */
723 s = va_arg( ap, char * );
724 rc = ber_put_string( ber, s, ber->ber_tag );
727 case 'B': /* bit string */
728 case 'X': /* bit string (deprecated) */
729 s = va_arg( ap, char * );
730 len = va_arg( ap, int ); /* in bits */
731 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
734 case 't': /* tag for the next element */
735 ber->ber_tag = va_arg( ap, ber_tag_t );
736 ber->ber_usertag = 1;
739 case 'v': /* vector of strings */
740 if ( (ss = va_arg( ap, char ** )) == NULL )
742 for ( i = 0; ss[i] != NULL; i++ ) {
743 if ( (rc = ber_put_string( ber, ss[i],
744 ber->ber_tag )) == -1 )
749 case 'V': /* sequences of strings + lengths */
750 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
752 for ( i = 0; bvp[i] != NULL; i++ ) {
753 if ( (rc = ber_put_berval( ber, bvp[i],
754 ber->ber_tag )) == -1 )
759 case '{': /* begin sequence */
760 rc = ber_start_seq( ber, ber->ber_tag );
763 case '}': /* end sequence */
764 rc = ber_put_seqorset( ber );
767 case '[': /* begin set */
768 rc = ber_start_set( ber, ber->ber_tag );
771 case ']': /* end set */
772 rc = ber_put_seqorset( ber );
776 if( ber->ber_debug ) {
777 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
778 "ber_printf: unknown fmt %c\n", *fmt );
784 if ( ber->ber_usertag == 0 )
785 ber->ber_tag = LBER_DEFAULT;
787 ber->ber_usertag = 0;