1 /* Encode.c - ber output encoding routines */
4 * Copyright 1998-2003 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 (char *) &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 ) return 1;
103 * long len otherwise - one byte with bit 8 set, giving the
104 * length of the length, followed by the length itself.
107 if ( len <= (ber_len_t) 0xffU ) return 2;
108 if ( len <= (ber_len_t) 0xffffU ) return 3;
109 if ( len <= (ber_len_t) 0xffffffU ) return 4;
115 ber_put_len( BerElement *ber, ber_len_t len, int nosos )
121 unsigned char netlen[sizeof(ber_len_t)];
123 assert( ber != NULL );
124 assert( LBER_VALID( ber ) );
127 * short len if it's less than 128 - one byte giving the len,
132 char length_byte = (char) len;
133 return ber_write( ber, &length_byte, 1, nosos );
137 * long len otherwise - one byte with bit 8 set, giving the
138 * length of the length, followed by the length itself.
141 /* find the first non-all-zero byte */
142 for ( i = sizeof(ber_len_t) - 1; i > 0; i-- ) {
143 mask = ((ber_len_t)0xffU << (i * 8));
145 if ( len & mask ) break;
147 lenlen = (unsigned char) ++i;
148 if ( lenlen > 4 ) return -1;
152 /* write the length of the length */
153 if ( ber_write( ber, &lenlen, 1, nosos ) != 1 ) return -1;
155 for( j=0; j<i; j++) {
156 netlen[(sizeof(ber_len_t)-1) - j] = (unsigned char)(len & 0xffU);
160 /* write the length itself */
162 (char *) &netlen[sizeof(ber_len_t)-i],
165 return rc == i ? i+1 : -1;
175 int i, j, sign, taglen, lenlen;
177 ber_uint_t unum, mask;
178 unsigned char netnum[sizeof(ber_uint_t)];
180 assert( ber != NULL );
181 assert( LBER_VALID( ber ) );
184 unum = num; /* Bit fiddling should be done with unsigned values */
187 * high bit is set - look for first non-all-one byte
188 * high bit is clear - look for first non-all-zero byte
190 for ( i = sizeof(ber_int_t) - 1; i > 0; i-- ) {
191 mask = ((ber_uint_t)0xffU << (i * 8));
195 if ( (unum & mask) != mask ) break;
198 if ( unum & mask ) break;
203 * we now have the "leading byte". if the high bit on this
204 * byte matches the sign bit, we need to "back up" a byte.
206 mask = (unum & ((ber_uint_t)0x80U << (i * 8)));
207 if ( (mask && !sign) || (sign && !mask) ) {
213 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
217 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ) {
222 for( j=0; j<i; j++ ) {
223 netnum[(sizeof(ber_int_t)-1) - j] = (unsigned char)(unum & 0xffU);
228 (char *) &netnum[sizeof(ber_int_t) - i],
231 /* length of tag + length + contents */
232 return rc == i ? taglen + lenlen + i : -1;
241 assert( ber != NULL );
242 assert( LBER_VALID( ber ) );
244 if ( tag == LBER_DEFAULT ) {
245 tag = LBER_ENUMERATED;
248 return ber_put_int_or_enum( ber, num, tag );
257 assert( ber != NULL );
258 assert( LBER_VALID( ber ) );
260 if ( tag == LBER_DEFAULT ) {
264 return ber_put_int_or_enum( ber, num, tag );
270 LDAP_CONST char *str,
274 int taglen, lenlen, rc;
276 assert( ber != NULL );
277 assert( str != NULL );
279 assert( LBER_VALID( ber ) );
281 if ( tag == LBER_DEFAULT ) {
282 tag = LBER_OCTETSTRING;
285 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
288 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
289 (ber_len_t) ber_write( ber, str, len, 0 ) != len )
293 /* return length of tag + length + contents */
294 rc = taglen + lenlen + len;
306 assert( ber != NULL );
307 assert( LBER_VALID( ber ) );
309 if( bv == NULL || bv->bv_len == 0 ) {
310 return ber_put_ostring( ber, "", (ber_len_t) 0, tag );
313 return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
319 LDAP_CONST char *str,
322 assert( ber != NULL );
323 assert( str != NULL );
325 assert( LBER_VALID( ber ) );
327 return ber_put_ostring( ber, str, strlen( str ), tag );
333 LDAP_CONST char *str,
334 ber_len_t blen /* in bits */,
339 unsigned char unusedbits;
341 assert( ber != NULL );
342 assert( str != NULL );
344 assert( LBER_VALID( ber ) );
346 if ( tag == LBER_DEFAULT ) {
347 tag = LBER_BITSTRING;
350 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
354 len = ( blen + 7 ) / 8;
355 unusedbits = (unsigned char) ((len * 8) - blen);
356 if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 ) {
360 if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 ) {
364 if ( (ber_len_t) ber_write( ber, str, len, 0 ) != len ) {
368 /* return length of tag + length + unused bit count + contents */
369 return taglen + 1 + lenlen + len;
373 ber_put_null( BerElement *ber, ber_tag_t tag )
377 assert( ber != NULL );
378 assert( LBER_VALID( ber ) );
380 if ( tag == LBER_DEFAULT ) {
384 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
388 if ( ber_put_len( ber, 0, 0 ) != 1 ) {
404 assert( ber != NULL );
405 assert( LBER_VALID( ber ) );
407 if ( tag == LBER_DEFAULT )
410 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 ) {
414 if ( ber_put_len( ber, 1, 0 ) != 1 ) {
418 c = boolval ? (unsigned char) ~0U : (unsigned char) 0U;
420 if ( ber_write( ber, (char *) &c, 1, 0 ) != 1 ) {
427 #define FOUR_BYTE_LEN 5
436 assert( ber != NULL );
437 assert( LBER_VALID( ber ) );
439 new = (Seqorset *) ber_memcalloc_x( 1, sizeof(Seqorset), ber->ber_memctx );
446 if ( ber->ber_sos == NULL ) {
447 new->sos_first = ber->ber_ptr;
449 new->sos_first = ber->ber_sos->sos_ptr;
452 /* Set aside room for a 4 byte length field */
453 new->sos_ptr = new->sos_first + ber_calc_taglen( tag ) + FOUR_BYTE_LEN;
456 new->sos_next = ber->ber_sos;
463 ber_start_seq( BerElement *ber, ber_tag_t tag )
465 assert( ber != NULL );
466 assert( LBER_VALID( ber ) );
468 if ( tag == LBER_DEFAULT ) {
472 return ber_start_seqorset( ber, tag );
476 ber_start_set( BerElement *ber, ber_tag_t tag )
478 assert( ber != NULL );
479 assert( LBER_VALID( ber ) );
481 if ( tag == LBER_DEFAULT ) {
485 return ber_start_seqorset( ber, tag );
489 ber_put_seqorset( BerElement *ber )
493 unsigned char netlen[sizeof(ber_len_t)];
496 unsigned char ltag = 0x80U + FOUR_BYTE_LEN - 1;
498 Seqorset **sos = &ber->ber_sos;
500 assert( ber != NULL );
501 assert( LBER_VALID( ber ) );
503 if( *sos == NULL ) return -1;
506 * If this is the toplevel sequence or set, we need to actually
507 * write the stuff out. Otherwise, it's already been put in
508 * the appropriate buffer and will be written when the toplevel
509 * one is written. In this case all we need to do is update the
513 len = (*sos)->sos_clen;
515 if ( sizeof(ber_len_t) > 4 && len > 0xffffffffUL ) {
519 if ( ber->ber_options & LBER_USE_DER ) {
520 lenlen = ber_calc_lenlen( len );
523 lenlen = FOUR_BYTE_LEN;
528 for( i=0; i < lenlen-1; i++ ) {
529 netlen[(sizeof(ber_len_t)-1) - i] =
530 (unsigned char)((len >> i*8) & 0xffU);
533 netlen[sizeof(ber_len_t)-1] = (unsigned char)(len & 0x7fU);
536 if ( (next = (*sos)->sos_next) == NULL ) {
538 if ( (taglen = ber_put_tag( ber, (*sos)->sos_tag, 1 )) == -1 )
541 if ( ber->ber_options & LBER_USE_DER ) {
542 /* Write the length in the minimum # of octets */
543 if ( ber_put_len( ber, len, 1 ) == -1 ) {
547 if (lenlen != FOUR_BYTE_LEN) {
549 * We set aside FOUR_BYTE_LEN bytes for
550 * the length field. Move the data if
551 * we don't actually need that much
553 AC_MEMCPY( (*sos)->sos_first + taglen +
554 lenlen, (*sos)->sos_first + taglen +
555 FOUR_BYTE_LEN, len );
558 /* Fill FOUR_BYTE_LEN bytes for length field */
559 /* one byte of length length */
560 if ( ber_write( ber, (char *)<ag, 1, 1 ) != 1 ) {
564 /* the length itself */
566 (char *) &netlen[sizeof(ber_len_t) - (FOUR_BYTE_LEN-1)],
567 FOUR_BYTE_LEN-1, 1 );
569 if( rc != FOUR_BYTE_LEN - 1 ) {
573 /* The ber_ptr is at the set/seq start - move it to the end */
574 (*sos)->sos_ber->ber_ptr += len;
578 unsigned char nettag[sizeof(ber_tag_t)];
579 ber_tag_t tmptag = (*sos)->sos_tag;
581 if( ber->ber_sos->sos_ptr > ber->ber_end ) {
582 /* The sos_ptr exceeds the end of the BerElement
583 * this can happen, for example, when the sos_ptr
584 * is near the end and no data was written for the
585 * 'V'. We must realloc the BerElement to ensure
586 * we don't overwrite the buffer when writing
587 * the tag and length fields.
589 ber_len_t ext = ber->ber_sos->sos_ptr - ber->ber_end;
591 if( ber_realloc( ber, ext ) != 0 ) {
597 taglen = ber_calc_taglen( tmptag );
599 for( i = 0; i < taglen; i++ ) {
600 nettag[(sizeof(ber_tag_t)-1) - i] = (unsigned char)(tmptag & 0xffU);
604 AC_FMEMCPY( (*sos)->sos_first,
605 &nettag[sizeof(ber_tag_t) - taglen],
608 if ( ber->ber_options & LBER_USE_DER ) {
610 ? (unsigned char) len
611 : (unsigned char) (0x80U + (lenlen - 1));
614 /* one byte of length length */
615 (*sos)->sos_first[1] = ltag;
617 if ( ber->ber_options & LBER_USE_DER ) {
619 /* Write the length itself */
620 AC_FMEMCPY( (*sos)->sos_first + 2,
621 &netlen[sizeof(ber_len_t) - (lenlen - 1)],
624 if (lenlen != FOUR_BYTE_LEN) {
626 * We set aside FOUR_BYTE_LEN bytes for
627 * the length field. Move the data if
628 * we don't actually need that much
630 AC_FMEMCPY( (*sos)->sos_first + taglen +
631 lenlen, (*sos)->sos_first + taglen +
632 FOUR_BYTE_LEN, len );
635 /* the length itself */
636 AC_FMEMCPY( (*sos)->sos_first + taglen + 1,
637 &netlen[sizeof(ber_len_t) - (FOUR_BYTE_LEN - 1)],
641 next->sos_clen += (taglen + lenlen + len);
642 next->sos_ptr += (taglen + lenlen + len);
645 /* we're done with this seqorset, so free it up */
646 ber_memfree_x( (char *) (*sos), ber->ber_memctx );
649 return taglen + lenlen + len;
653 ber_put_seq( BerElement *ber )
655 assert( ber != NULL );
656 assert( LBER_VALID( ber ) );
658 return ber_put_seqorset( ber );
662 ber_put_set( BerElement *ber )
664 assert( ber != NULL );
665 assert( LBER_VALID( ber ) );
667 return ber_put_seqorset( ber );
671 static ber_tag_t lber_int_null = 0;
675 ber_printf( BerElement *ber, LDAP_CONST char *fmt, ... )
679 struct berval *bv, **bvp;
684 assert( ber != NULL );
685 assert( fmt != NULL );
687 assert( LBER_VALID( ber ) );
691 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
693 case '!': { /* hook */
694 BEREncodeCallback *f;
697 f = va_arg( ap, BEREncodeCallback * );
698 p = va_arg( ap, void * );
703 case 'b': /* boolean */
704 i = va_arg( ap, ber_int_t );
705 rc = ber_put_boolean( ber, i, ber->ber_tag );
709 i = va_arg( ap, ber_int_t );
710 rc = ber_put_int( ber, i, ber->ber_tag );
713 case 'e': /* enumeration */
714 i = va_arg( ap, ber_int_t );
715 rc = ber_put_enum( ber, i, ber->ber_tag );
719 rc = ber_put_null( ber, ber->ber_tag );
722 case 'N': /* Debug NULL */
723 if( lber_int_null != 0 ) {
724 /* Insert NULL to ensure peer ignores unknown tags */
725 rc = ber_put_null( ber, lber_int_null );
731 case 'o': /* octet string (non-null terminated) */
732 s = va_arg( ap, char * );
733 len = va_arg( ap, ber_len_t );
734 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
737 case 'O': /* berval octet string */
738 bv = va_arg( ap, struct berval * );
739 if( bv == NULL ) break;
740 rc = ber_put_berval( ber, bv, ber->ber_tag );
743 case 's': /* string */
744 s = va_arg( ap, char * );
745 rc = ber_put_string( ber, s, ber->ber_tag );
748 case 'B': /* bit string */
749 case 'X': /* bit string (deprecated) */
750 s = va_arg( ap, char * );
751 len = va_arg( ap, int ); /* in bits */
752 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
755 case 't': /* tag for the next element */
756 ber->ber_tag = va_arg( ap, ber_tag_t );
757 ber->ber_usertag = 1;
760 case 'v': /* vector of strings */
761 if ( (ss = va_arg( ap, char ** )) == NULL )
763 for ( i = 0; ss[i] != NULL; i++ ) {
764 if ( (rc = ber_put_string( ber, ss[i],
765 ber->ber_tag )) == -1 )
770 case 'V': /* sequences of strings + lengths */
771 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
773 for ( i = 0; bvp[i] != NULL; i++ ) {
774 if ( (rc = ber_put_berval( ber, bvp[i],
775 ber->ber_tag )) == -1 )
780 case 'W': /* BerVarray */
781 if ( (bv = va_arg( ap, BerVarray )) == NULL )
783 for ( i = 0; bv[i].bv_val != NULL; i++ ) {
784 if ( (rc = ber_put_berval( ber, &bv[i],
785 ber->ber_tag )) == -1 )
790 case '{': /* begin sequence */
791 rc = ber_start_seq( ber, ber->ber_tag );
794 case '}': /* end sequence */
795 rc = ber_put_seqorset( ber );
798 case '[': /* begin set */
799 rc = ber_start_set( ber, ber->ber_tag );
802 case ']': /* end set */
803 rc = ber_put_seqorset( ber );
807 if( ber->ber_debug ) {
810 "ber_printf: unknown fmt %c\n", *fmt, 0, 0 );
812 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
813 "ber_printf: unknown fmt %c\n", *fmt );
820 if ( ber->ber_usertag == 0 ) {
821 ber->ber_tag = LBER_DEFAULT;
823 ber->ber_usertag = 0;