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>
31 static int ber_put_len LDAP_P((
36 static int ber_start_seqorset LDAP_P((
40 static int ber_put_seqorset LDAP_P(( BerElement *ber ));
42 static int ber_put_int_or_enum LDAP_P((
49 ber_calc_taglen( ber_tag_t tag )
54 /* find the first non-all-zero byte in the tag */
55 for ( i = sizeof(ber_tag_t) - 1; i > 0; i-- ) {
56 mask = ((ber_tag_t)0xffU << (i * 8));
74 unsigned char nettag[sizeof(ber_tag_t)];
76 assert( ber != NULL );
77 assert( BER_VALID( ber ) );
79 taglen = ber_calc_taglen( tag );
81 for( i=0; i<taglen; i++ ) {
82 nettag[(sizeof(ber_tag_t)-1) - i] = (unsigned char)(tag & 0xffU);
87 &nettag[sizeof(ber_tag_t) - taglen],
94 ber_calc_lenlen( ber_len_t len )
97 * short len if it's less than 128 - one byte giving the len,
101 if ( len <= (ber_len_t) 0x7FU )
105 * long len otherwise - one byte with bit 8 set, giving the
106 * length of the length, followed by the length itself.
109 if ( len <= (ber_len_t) 0xffU )
111 if ( len <= (ber_len_t) 0xffffU )
113 if ( len <= (ber_len_t) 0xffffffU )
120 ber_put_len( BerElement *ber, ber_len_t len, int nosos )
126 unsigned char netlen[sizeof(ber_len_t)];
128 assert( ber != NULL );
129 assert( BER_VALID( ber ) );
132 * short len if it's less than 128 - one byte giving the len,
137 char length_byte = (char) len;
138 return( ber_write( ber, &length_byte, 1, nosos ) );
142 * long len otherwise - one byte with bit 8 set, giving the
143 * length of the length, followed by the length itself.
146 /* find the first non-all-zero byte */
147 for ( i = sizeof(ber_len_t) - 1; i > 0; i-- ) {
148 mask = ((ber_len_t)0xffU << (i * 8));
153 lenlen = (unsigned char) ++i;
159 /* write the length of the length */
160 if ( ber_write( ber, &lenlen, 1, nosos ) != 1 )
163 for( j=0; j<i; j++) {
164 netlen[(sizeof(ber_len_t)-1) - j] = (unsigned char)(len & 0xffU);
168 /* write the length itself */
170 &netlen[sizeof(ber_len_t)-i],
173 return rc == i ? i+1 : -1;
184 ber_len_t len, lenlen, taglen;
185 ber_uint_t unum, mask;
186 unsigned char netnum[sizeof(ber_uint_t)];
188 assert( ber != NULL );
189 assert( BER_VALID( ber ) );
192 unum = num; /* Bit fiddling should be done with unsigned values */
195 * high bit is set - look for first non-all-one byte
196 * high bit is clear - look for first non-all-zero byte
198 for ( i = sizeof(ber_int_t) - 1; i > 0; i-- ) {
199 mask = ((ber_uint_t)0xffU << (i * 8));
203 if ( (unum & mask) != mask )
213 * we now have the "leading byte". if the high bit on this
214 * byte matches the sign bit, we need to "back up" a byte.
216 mask = (unum & ((ber_uint_t)0x80U << (i * 8)));
217 if ( (mask && !sign) || (sign && !mask) )
222 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
225 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 )
229 for( j=0; j<i; j++ ) {
230 netnum[(sizeof(ber_int_t)-1) - j] = (unsigned char)(unum & 0xffU);
235 &netnum[sizeof(ber_int_t) - i],
238 /* length of tag + length + contents */
239 return rc == i ? taglen + lenlen + i : -1;
248 assert( ber != NULL );
249 assert( BER_VALID( ber ) );
251 if ( tag == LBER_DEFAULT )
252 tag = LBER_ENUMERATED;
254 return( ber_put_int_or_enum( ber, num, tag ) );
263 assert( ber != NULL );
264 assert( BER_VALID( ber ) );
266 if ( tag == LBER_DEFAULT )
269 return( ber_put_int_or_enum( ber, num, tag ) );
275 LDAP_CONST char *str,
279 ber_len_t taglen, lenlen;
281 #ifdef STR_TRANSLATION
283 #endif /* STR_TRANSLATION */
285 assert( ber != NULL );
286 assert( str != NULL );
288 assert( BER_VALID( ber ) );
290 if ( tag == LBER_DEFAULT )
291 tag = LBER_OCTETSTRING;
293 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
296 #ifdef STR_TRANSLATION
297 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0 &&
298 ber->ber_encode_translate_proc ) {
299 if ( (*(ber->ber_encode_translate_proc))( &str, &len, 0 ) != 0 ) {
306 #endif /* STR_TRANSLATION */
308 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
309 (ber_len_t) ber_write( ber, str, len, 0 ) != len ) {
312 /* return length of tag + length + contents */
313 rc = taglen + lenlen + len;
316 #ifdef STR_TRANSLATION
320 #endif /* STR_TRANSLATION */
328 LDAP_CONST struct berval *bv,
331 assert( ber != NULL );
332 assert( BER_VALID( ber ) );
334 if( bv == NULL || bv->bv_len == 0 ) {
335 return ber_put_ostring( ber, "", (ber_len_t) 0, tag );
338 return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
344 LDAP_CONST char *str,
347 assert( ber != NULL );
348 assert( str != NULL );
350 assert( BER_VALID( ber ) );
352 return( ber_put_ostring( ber, str, strlen( str ), tag ));
358 LDAP_CONST char *str,
359 ber_len_t blen /* in bits */,
362 ber_len_t taglen, lenlen, len;
363 unsigned char unusedbits;
365 assert( ber != NULL );
366 assert( str != NULL );
368 assert( BER_VALID( ber ) );
370 if ( tag == LBER_DEFAULT )
371 tag = LBER_BITSTRING;
373 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
376 len = ( blen + 7 ) / 8;
377 unusedbits = (unsigned char) ((len * 8) - blen);
378 if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 )
381 if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 )
384 if ( (ber_len_t) ber_write( ber, str, len, 0 ) != len )
387 /* return length of tag + length + unused bit count + contents */
388 return( taglen + 1 + lenlen + len );
392 ber_put_null( BerElement *ber, ber_tag_t tag )
396 assert( ber != NULL );
397 assert( BER_VALID( ber ) );
399 if ( tag == LBER_DEFAULT )
402 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
405 if ( ber_put_len( ber, 0, 0 ) != 1 )
408 return( taglen + 1 );
418 unsigned char trueval = 0xFFU;
419 unsigned char falseval = 0x00U;
421 assert( ber != NULL );
422 assert( BER_VALID( ber ) );
424 if ( tag == LBER_DEFAULT )
427 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
430 if ( ber_put_len( ber, 1, 0 ) != 1 )
433 if ( ber_write( ber, (char *)(boolval ? &trueval : &falseval), 1, 0 )
437 return( taglen + 2 );
440 #define FOUR_BYTE_LEN 5
449 assert( ber != NULL );
450 assert( BER_VALID( ber ) );
452 new = (Seqorset *) LBER_CALLOC( 1, sizeof(Seqorset) );
458 if ( ber->ber_sos == NULL )
459 new->sos_first = ber->ber_ptr;
461 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( BER_VALID( ber ) );
479 if ( tag == LBER_DEFAULT )
482 return( ber_start_seqorset( ber, tag ) );
486 ber_start_set( BerElement *ber, ber_tag_t tag )
488 assert( ber != NULL );
489 assert( BER_VALID( ber ) );
491 if ( tag == LBER_DEFAULT )
494 return( ber_start_seqorset( ber, tag ) );
498 ber_put_seqorset( BerElement *ber )
502 unsigned char netlen[sizeof(ber_len_t)];
503 ber_len_t taglen, lenlen;
504 unsigned char ltag = 0x80U + FOUR_BYTE_LEN - 1;
506 Seqorset **sos = &ber->ber_sos;
508 assert( ber != NULL );
509 assert( BER_VALID( ber ) );
512 * If this is the toplevel sequence or set, we need to actually
513 * write the stuff out. Otherwise, it's already been put in
514 * the appropriate buffer and will be written when the toplevel
515 * one is written. In this case all we need to do is update the
519 len = (*sos)->sos_clen;
521 if ( sizeof(ber_len_t) > 4 && len > 0xffffffffUL )
524 if ( ber->ber_options & LBER_USE_DER ) {
525 lenlen = ber_calc_lenlen( len );
528 lenlen = FOUR_BYTE_LEN;
533 for( i=0; i < lenlen-1; i++ ) {
534 netlen[(sizeof(ber_len_t)-1) - i] =
535 (unsigned char)((len >> i*8) & 0xffU);
538 netlen[sizeof(ber_len_t)-1] = (unsigned char)(len & 0x7fU);
541 if ( (next = (*sos)->sos_next) == NULL ) {
543 if ( (taglen = ber_put_tag( ber, (*sos)->sos_tag, 1 )) == -1 )
546 if ( ber->ber_options & LBER_USE_DER ) {
547 /* Write the length in the minimum # of octets */
548 if ( ber_put_len( ber, len, 1 ) == -1 )
551 if (lenlen != FOUR_BYTE_LEN) {
553 * We set aside FOUR_BYTE_LEN bytes for
554 * the length field. Move the data if
555 * we don't actually need that much
557 SAFEMEMCPY( (*sos)->sos_first + taglen +
558 lenlen, (*sos)->sos_first + taglen +
559 FOUR_BYTE_LEN, len );
562 /* Fill FOUR_BYTE_LEN bytes for length field */
563 /* one byte of length length */
564 if ( ber_write( ber, (char *)<ag, 1, 1 ) != 1 )
567 /* the length itself */
569 &netlen[sizeof(ber_len_t) - (FOUR_BYTE_LEN-1)],
570 FOUR_BYTE_LEN-1, 1 );
572 if( rc != FOUR_BYTE_LEN - 1 ) {
576 /* The ber_ptr is at the set/seq start - move it to the end */
577 (*sos)->sos_ber->ber_ptr += len;
581 unsigned char nettag[sizeof(ber_tag_t)];
582 ber_tag_t tmptag = (*sos)->sos_tag;
585 taglen = ber_calc_taglen( tmptag );
587 for( i = 0; i < taglen; i++ ) {
588 nettag[(sizeof(ber_tag_t)-1) - i] = (unsigned char)(tmptag & 0xffU);
592 SAFEMEMCPY( (*sos)->sos_first,
593 &nettag[sizeof(ber_tag_t) - taglen],
596 if ( ber->ber_options & LBER_USE_DER ) {
598 ? (unsigned char) len
599 : (unsigned char) (0x80U + (lenlen - 1));
602 /* one byte of length length */
603 SAFEMEMCPY( (*sos)->sos_first + 1, <ag, 1 );
605 if ( ber->ber_options & LBER_USE_DER ) {
607 /* Write the length itself */
608 SAFEMEMCPY( (*sos)->sos_first + 2,
609 &netlen[sizeof(ber_len_t) - (lenlen - 1)],
612 if (lenlen != FOUR_BYTE_LEN) {
614 * We set aside FOUR_BYTE_LEN bytes for
615 * the length field. Move the data if
616 * we don't actually need that much
618 SAFEMEMCPY( (*sos)->sos_first + taglen +
619 lenlen, (*sos)->sos_first + taglen +
620 FOUR_BYTE_LEN, len );
623 /* the length itself */
624 SAFEMEMCPY( (*sos)->sos_first + taglen + 1,
625 &netlen[sizeof(ber_len_t) - (FOUR_BYTE_LEN - 1)],
629 next->sos_clen += (taglen + lenlen + len);
630 next->sos_ptr += (taglen + lenlen + len);
633 /* we're done with this seqorset, so free it up */
634 LBER_FREE( (char *) (*sos) );
637 return( taglen + lenlen + len );
641 ber_put_seq( BerElement *ber )
643 assert( ber != NULL );
644 assert( BER_VALID( ber ) );
646 return( ber_put_seqorset( ber ) );
650 ber_put_set( BerElement *ber )
652 assert( ber != NULL );
653 assert( BER_VALID( ber ) );
655 return( ber_put_seqorset( ber ) );
660 ber_printf( BerElement *ber, LDAP_CONST char *fmt, ... )
664 struct berval *bv, **bvp;
669 assert( ber != NULL );
670 assert( fmt != NULL );
672 assert( BER_VALID( ber ) );
676 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
678 case '!': { /* hook */
679 BEREncodeCallback *f;
682 f = va_arg( ap, BEREncodeCallback * );
683 p = va_arg( ap, void * );
688 case 'b': /* boolean */
689 i = va_arg( ap, ber_int_t );
690 rc = ber_put_boolean( ber, i, ber->ber_tag );
694 i = va_arg( ap, ber_int_t );
695 rc = ber_put_int( ber, i, ber->ber_tag );
698 case 'e': /* enumeration */
699 i = va_arg( ap, ber_int_t );
700 rc = ber_put_enum( ber, i, ber->ber_tag );
704 rc = ber_put_null( ber, ber->ber_tag );
707 case 'o': /* octet string (non-null terminated) */
708 s = va_arg( ap, char * );
709 len = va_arg( ap, ber_len_t );
710 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
713 case 'O': /* berval octet string */
714 bv = va_arg( ap, struct berval * );
715 if( bv == NULL ) break;
716 rc = ber_put_berval( ber, bv, ber->ber_tag );
719 case 's': /* string */
720 s = va_arg( ap, char * );
721 rc = ber_put_string( ber, s, ber->ber_tag );
724 case 'B': /* bit string */
725 case 'X': /* bit string (deprecated) */
726 s = va_arg( ap, char * );
727 len = va_arg( ap, int ); /* in bits */
728 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
731 case 't': /* tag for the next element */
732 ber->ber_tag = va_arg( ap, ber_tag_t );
733 ber->ber_usertag = 1;
736 case 'v': /* vector of strings */
737 if ( (ss = va_arg( ap, char ** )) == NULL )
739 for ( i = 0; ss[i] != NULL; i++ ) {
740 if ( (rc = ber_put_string( ber, ss[i],
741 ber->ber_tag )) == -1 )
746 case 'V': /* sequences of strings + lengths */
747 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
749 for ( i = 0; bvp[i] != NULL; i++ ) {
750 if ( (rc = ber_put_berval( ber, bvp[i],
751 ber->ber_tag )) == -1 )
756 case '{': /* begin sequence */
757 rc = ber_start_seq( ber, ber->ber_tag );
760 case '}': /* end sequence */
761 rc = ber_put_seqorset( ber );
764 case '[': /* begin set */
765 rc = ber_start_set( ber, ber->ber_tag );
768 case ']': /* end set */
769 rc = ber_put_seqorset( ber );
773 if( ber->ber_debug ) {
774 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
775 "ber_printf: unknown fmt %c\n", *fmt );
781 if ( ber->ber_usertag == 0 )
782 ber->ber_tag = LBER_DEFAULT;
784 ber->ber_usertag = 0;