1 /* Encode.c - ber output encoding routines */
4 * Copyright 1998-2002 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));
58 if ( tag & mask ) break;
73 unsigned char nettag[sizeof(ber_tag_t)];
75 assert( ber != NULL );
76 assert( LBER_VALID( ber ) );
78 taglen = ber_calc_taglen( tag );
80 for( i=0; i<taglen; i++ ) {
81 nettag[(sizeof(ber_tag_t)-1) - i] = (unsigned char)(tag & 0xffU);
86 &nettag[sizeof(ber_tag_t) - taglen],
93 ber_calc_lenlen( ber_len_t len )
96 * short len if it's less than 128 - one byte giving the len,
100 if ( len <= (ber_len_t) 0x7FU )
104 * long len otherwise - one byte with bit 8 set, giving the
105 * length of the length, followed by the length itself.
108 if ( len <= (ber_len_t) 0xffU )
110 if ( len <= (ber_len_t) 0xffffU )
112 if ( len <= (ber_len_t) 0xffffffU )
119 ber_put_len( BerElement *ber, ber_len_t len, int nosos )
125 unsigned char netlen[sizeof(ber_len_t)];
127 assert( ber != NULL );
128 assert( LBER_VALID( ber ) );
131 * short len if it's less than 128 - one byte giving the len,
136 char length_byte = (char) len;
137 return ber_write( ber, &length_byte, 1, nosos );
141 * long len otherwise - one byte with bit 8 set, giving the
142 * length of the length, followed by the length itself.
145 /* find the first non-all-zero byte */
146 for ( i = sizeof(ber_len_t) - 1; i > 0; i-- ) {
147 mask = ((ber_len_t)0xffU << (i * 8));
149 if ( len & mask ) break;
151 lenlen = (unsigned char) ++i;
157 /* write the length of the length */
158 if ( ber_write( ber, &lenlen, 1, nosos ) != 1 )
161 for( j=0; j<i; j++) {
162 netlen[(sizeof(ber_len_t)-1) - j] = (unsigned char)(len & 0xffU);
166 /* write the length itself */
168 &netlen[sizeof(ber_len_t)-i],
171 return rc == i ? i+1 : -1;
182 ber_len_t len, lenlen, taglen;
183 ber_uint_t unum, mask;
184 unsigned char netnum[sizeof(ber_uint_t)];
186 assert( ber != NULL );
187 assert( LBER_VALID( ber ) );
190 unum = num; /* Bit fiddling should be done with unsigned values */
193 * high bit is set - look for first non-all-one byte
194 * high bit is clear - look for first non-all-zero byte
196 for ( i = sizeof(ber_int_t) - 1; i > 0; i-- ) {
197 mask = ((ber_uint_t)0xffU << (i * 8));
201 if ( (unum & mask) != mask ) break;
204 if ( unum & mask ) break;
209 * we now have the "leading byte". if the high bit on this
210 * byte matches the sign bit, we need to "back up" a byte.
212 mask = (unum & ((ber_uint_t)0x80U << (i * 8)));
213 if ( (mask && !sign) || (sign && !mask) ) {
219 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
223 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 )
227 for( j=0; j<i; j++ ) {
228 netnum[(sizeof(ber_int_t)-1) - j] = (unsigned char)(unum & 0xffU);
233 &netnum[sizeof(ber_int_t) - i],
236 /* length of tag + length + contents */
237 return rc == i ? taglen + lenlen + i : -1;
246 assert( ber != NULL );
247 assert( LBER_VALID( ber ) );
249 if ( tag == LBER_DEFAULT ) {
250 tag = LBER_ENUMERATED;
253 return ber_put_int_or_enum( ber, num, tag );
262 assert( ber != NULL );
263 assert( LBER_VALID( ber ) );
265 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;
282 assert( ber != NULL );
283 assert( str != NULL );
285 assert( LBER_VALID( ber ) );
287 if ( tag == LBER_DEFAULT ) {
288 tag = LBER_OCTETSTRING;
291 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
294 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
295 (ber_len_t) ber_write( ber, str, len, 0 ) != len ) {
298 /* return length of tag + length + contents */
299 rc = taglen + lenlen + len;
311 assert( ber != NULL );
312 assert( LBER_VALID( ber ) );
314 if( bv == NULL || bv->bv_len == 0 ) {
315 return ber_put_ostring( ber, "", (ber_len_t) 0, tag );
318 return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
324 LDAP_CONST char *str,
327 assert( ber != NULL );
328 assert( str != NULL );
330 assert( LBER_VALID( ber ) );
332 return ber_put_ostring( ber, str, strlen( str ), tag );
338 LDAP_CONST char *str,
339 ber_len_t blen /* in bits */,
342 ber_len_t taglen, lenlen, len;
343 unsigned char unusedbits;
345 assert( ber != NULL );
346 assert( str != NULL );
348 assert( LBER_VALID( ber ) );
350 if ( tag == LBER_DEFAULT ) {
351 tag = LBER_BITSTRING;
354 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
358 len = ( blen + 7 ) / 8;
359 unusedbits = (unsigned char) ((len * 8) - blen);
360 if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 ) {
364 if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 ) {
368 if ( (ber_len_t) ber_write( ber, str, len, 0 ) != len ) {
372 /* return length of tag + length + unused bit count + contents */
373 return taglen + 1 + lenlen + len;
377 ber_put_null( BerElement *ber, ber_tag_t tag )
381 assert( ber != NULL );
382 assert( LBER_VALID( ber ) );
384 if ( tag == LBER_DEFAULT ) {
388 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
392 if ( ber_put_len( ber, 0, 0 ) != 1 ) {
408 assert( ber != NULL );
409 assert( LBER_VALID( ber ) );
411 if ( tag == LBER_DEFAULT )
414 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
418 if ( ber_put_len( ber, 1, 0 ) != 1 ) {
422 c = boolval ? (unsigned char) ~0U : (unsigned char) 0U;
424 if ( ber_write( ber, (char *) &c, 1, 0 )
433 #define FOUR_BYTE_LEN 5
442 assert( ber != NULL );
443 assert( LBER_VALID( ber ) );
445 new = (Seqorset *) LBER_CALLOC( 1, sizeof(Seqorset) );
452 if ( ber->ber_sos == NULL ) {
453 new->sos_first = ber->ber_ptr;
455 new->sos_first = ber->ber_sos->sos_ptr;
458 /* Set aside room for a 4 byte length field */
459 new->sos_ptr = new->sos_first + ber_calc_taglen( tag ) + FOUR_BYTE_LEN;
462 new->sos_next = ber->ber_sos;
469 ber_start_seq( BerElement *ber, ber_tag_t tag )
471 assert( ber != NULL );
472 assert( LBER_VALID( ber ) );
474 if ( tag == LBER_DEFAULT ) {
478 return ber_start_seqorset( ber, tag );
482 ber_start_set( BerElement *ber, ber_tag_t tag )
484 assert( ber != NULL );
485 assert( LBER_VALID( ber ) );
487 if ( tag == LBER_DEFAULT ) {
491 return ber_start_seqorset( ber, tag );
495 ber_put_seqorset( BerElement *ber )
499 unsigned char netlen[sizeof(ber_len_t)];
500 ber_len_t taglen, lenlen;
501 unsigned char ltag = 0x80U + FOUR_BYTE_LEN - 1;
503 Seqorset **sos = &ber->ber_sos;
505 assert( ber != NULL );
506 assert( LBER_VALID( ber ) );
508 if( *sos == NULL ) return -1;
511 * If this is the toplevel sequence or set, we need to actually
512 * write the stuff out. Otherwise, it's already been put in
513 * the appropriate buffer and will be written when the toplevel
514 * one is written. In this case all we need to do is update the
518 len = (*sos)->sos_clen;
520 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 ) {
552 if (lenlen != FOUR_BYTE_LEN) {
554 * We set aside FOUR_BYTE_LEN bytes for
555 * the length field. Move the data if
556 * we don't actually need that much
558 AC_MEMCPY( (*sos)->sos_first + taglen +
559 lenlen, (*sos)->sos_first + taglen +
560 FOUR_BYTE_LEN, len );
563 /* Fill FOUR_BYTE_LEN bytes for length field */
564 /* one byte of length length */
565 if ( ber_write( ber, (char *)<ag, 1, 1 ) != 1 ) {
569 /* the length itself */
571 &netlen[sizeof(ber_len_t) - (FOUR_BYTE_LEN-1)],
572 FOUR_BYTE_LEN-1, 1 );
574 if( rc != FOUR_BYTE_LEN - 1 ) {
578 /* The ber_ptr is at the set/seq start - move it to the end */
579 (*sos)->sos_ber->ber_ptr += len;
583 unsigned char nettag[sizeof(ber_tag_t)];
584 ber_tag_t tmptag = (*sos)->sos_tag;
586 if( ber->ber_sos->sos_ptr > ber->ber_end ) {
587 /* The sos_ptr exceeds the end of the BerElement
588 * this can happen, for example, when the sos_ptr
589 * is near the end and no data was written for the
590 * 'V'. We must realloc the BerElement to ensure
591 * we don't overwrite the buffer when writing
592 * the tag and length fields.
594 ber_len_t ext = ber->ber_sos->sos_ptr - ber->ber_end;
596 if( ber_realloc( ber, ext ) != 0 ) {
602 taglen = ber_calc_taglen( tmptag );
604 for( i = 0; i < taglen; i++ ) {
605 nettag[(sizeof(ber_tag_t)-1) - i] = (unsigned char)(tmptag & 0xffU);
609 AC_FMEMCPY( (*sos)->sos_first,
610 &nettag[sizeof(ber_tag_t) - taglen],
613 if ( ber->ber_options & LBER_USE_DER ) {
615 ? (unsigned char) len
616 : (unsigned char) (0x80U + (lenlen - 1));
619 /* one byte of length length */
620 (*sos)->sos_first[1] = ltag;
622 if ( ber->ber_options & LBER_USE_DER ) {
624 /* Write the length itself */
625 AC_FMEMCPY( (*sos)->sos_first + 2,
626 &netlen[sizeof(ber_len_t) - (lenlen - 1)],
629 if (lenlen != FOUR_BYTE_LEN) {
631 * We set aside FOUR_BYTE_LEN bytes for
632 * the length field. Move the data if
633 * we don't actually need that much
635 AC_FMEMCPY( (*sos)->sos_first + taglen +
636 lenlen, (*sos)->sos_first + taglen +
637 FOUR_BYTE_LEN, len );
640 /* the length itself */
641 AC_FMEMCPY( (*sos)->sos_first + taglen + 1,
642 &netlen[sizeof(ber_len_t) - (FOUR_BYTE_LEN - 1)],
646 next->sos_clen += (taglen + lenlen + len);
647 next->sos_ptr += (taglen + lenlen + len);
650 /* we're done with this seqorset, so free it up */
651 LBER_FREE( (char *) (*sos) );
654 return taglen + lenlen + len;
658 ber_put_seq( BerElement *ber )
660 assert( ber != NULL );
661 assert( LBER_VALID( ber ) );
663 return ber_put_seqorset( ber );
667 ber_put_set( BerElement *ber )
669 assert( ber != NULL );
670 assert( LBER_VALID( ber ) );
672 return ber_put_seqorset( ber );
676 static ber_tag_t lber_int_null = 0;
680 ber_printf( BerElement *ber, LDAP_CONST char *fmt, ... )
684 struct berval *bv, **bvp;
689 assert( ber != NULL );
690 assert( fmt != NULL );
692 assert( LBER_VALID( ber ) );
696 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
698 case '!': { /* hook */
699 BEREncodeCallback *f;
702 f = va_arg( ap, BEREncodeCallback * );
703 p = va_arg( ap, void * );
708 case 'b': /* boolean */
709 i = va_arg( ap, ber_int_t );
710 rc = ber_put_boolean( ber, i, ber->ber_tag );
714 i = va_arg( ap, ber_int_t );
715 rc = ber_put_int( ber, i, ber->ber_tag );
718 case 'e': /* enumeration */
719 i = va_arg( ap, ber_int_t );
720 rc = ber_put_enum( ber, i, ber->ber_tag );
724 rc = ber_put_null( ber, ber->ber_tag );
727 case 'N': /* Debug NULL */
728 if( lber_int_null != 0 ) {
729 /* Insert NULL to ensure peer ignores unknown tags */
730 rc = ber_put_null( ber, lber_int_null );
736 case 'o': /* octet string (non-null terminated) */
737 s = va_arg( ap, char * );
738 len = va_arg( ap, ber_len_t );
739 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
742 case 'O': /* berval octet string */
743 bv = va_arg( ap, struct berval * );
744 if( bv == NULL ) break;
745 rc = ber_put_berval( ber, bv, ber->ber_tag );
748 case 's': /* string */
749 s = va_arg( ap, char * );
750 rc = ber_put_string( ber, s, ber->ber_tag );
753 case 'B': /* bit string */
754 case 'X': /* bit string (deprecated) */
755 s = va_arg( ap, char * );
756 len = va_arg( ap, int ); /* in bits */
757 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
760 case 't': /* tag for the next element */
761 ber->ber_tag = va_arg( ap, ber_tag_t );
762 ber->ber_usertag = 1;
765 case 'v': /* vector of strings */
766 if ( (ss = va_arg( ap, char ** )) == NULL )
768 for ( i = 0; ss[i] != NULL; i++ ) {
769 if ( (rc = ber_put_string( ber, ss[i],
770 ber->ber_tag )) == -1 )
775 case 'V': /* sequences of strings + lengths */
776 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
778 for ( i = 0; bvp[i] != NULL; i++ ) {
779 if ( (rc = ber_put_berval( ber, bvp[i],
780 ber->ber_tag )) == -1 )
785 case 'W': /* BerVarray */
786 if ( (bv = va_arg( ap, BerVarray )) == NULL )
788 for ( i = 0; bv[i].bv_val != NULL; i++ ) {
789 if ( (rc = ber_put_berval( ber, &bv[i],
790 ber->ber_tag )) == -1 )
795 case '{': /* begin sequence */
796 rc = ber_start_seq( ber, ber->ber_tag );
799 case '}': /* end sequence */
800 rc = ber_put_seqorset( ber );
803 case '[': /* begin set */
804 rc = ber_start_set( ber, ber->ber_tag );
807 case ']': /* end set */
808 rc = ber_put_seqorset( ber );
812 if( ber->ber_debug ) {
814 LDAP_LOG(( "liblber", LDAP_LEVEL_ERR,
815 "ber_printf: unknown fmt %c\n", *fmt ));
817 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
818 "ber_printf: unknown fmt %c\n", *fmt );
825 if ( ber->ber_usertag == 0 )
826 ber->ber_tag = LBER_DEFAULT;
828 ber->ber_usertag = 0;