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));
78 assert( ber != NULL );
79 assert( BER_VALID( ber ) );
81 taglen = ber_calc_taglen( tag );
83 ntag = LBER_TAG_HTON( tag );
86 ((char *) &ntag) + 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 )
126 assert( ber != NULL );
127 assert( BER_VALID( ber ) );
130 * short len if it's less than 128 - one byte giving the len,
135 char length_byte = (char) len;
136 return( ber_write( ber, &length_byte, 1, nosos ) );
140 * long len otherwise - one byte with bit 8 set, giving the
141 * length of the length, followed by the length itself.
144 /* find the first non-all-zero byte */
145 for ( i = sizeof(ber_len_t) - 1; i > 0; i-- ) {
146 mask = ((ber_len_t)0xffU << (i * 8));
151 lenlen = (unsigned char) ++i;
156 /* write the length of the length */
157 if ( ber_write( ber, &lenlen, 1, nosos ) != 1 )
160 /* write the length itself */
161 netlen = LBER_LEN_HTON( len );
162 if ( ber_write( ber, (char *) &netlen + (sizeof(ber_len_t) - i), i, nosos )
176 ber_len_t len, lenlen, taglen;
177 ber_uint_t unum, netnum, mask;
179 assert( ber != NULL );
180 assert( BER_VALID( ber ) );
183 unum = num; /* Bit fiddling should be done with unsigned values */
186 * high bit is set - look for first non-all-one byte
187 * high bit is clear - look for first non-all-zero byte
189 for ( i = sizeof(ber_int_t) - 1; i > 0; i-- ) {
190 mask = ((ber_uint_t)0xffU << (i * 8));
194 if ( (unum & mask) != mask )
204 * we now have the "leading byte". if the high bit on this
205 * byte matches the sign bit, we need to "back up" a byte.
207 mask = (unum & ((ber_uint_t)0x80U << (i * 8)));
208 if ( (mask && !sign) || (sign && !mask) )
213 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
216 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 )
219 netnum = LBER_INT_HTON( unum );
220 if ( ber_write( ber, (char *) &netnum + (sizeof(ber_int_t) - i), i, 0 )
224 /* length of tag + length + contents */
225 return( taglen + lenlen + i );
234 assert( ber != NULL );
235 assert( BER_VALID( ber ) );
237 if ( tag == LBER_DEFAULT )
238 tag = LBER_ENUMERATED;
240 return( ber_put_int_or_enum( ber, num, tag ) );
249 assert( ber != NULL );
250 assert( BER_VALID( ber ) );
252 if ( tag == LBER_DEFAULT )
255 return( ber_put_int_or_enum( ber, num, tag ) );
261 LDAP_CONST char *str,
265 ber_len_t taglen, lenlen;
267 #ifdef STR_TRANSLATION
269 #endif /* STR_TRANSLATION */
271 assert( ber != NULL );
272 assert( str != NULL );
274 assert( BER_VALID( ber ) );
276 if ( tag == LBER_DEFAULT )
277 tag = LBER_OCTETSTRING;
279 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
282 #ifdef STR_TRANSLATION
283 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0 &&
284 ber->ber_encode_translate_proc ) {
285 if ( (*(ber->ber_encode_translate_proc))( &str, &len, 0 )
293 #endif /* STR_TRANSLATION */
295 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
296 (ber_len_t) ber_write( ber, str, len, 0 ) != len ) {
299 /* return length of tag + length + contents */
300 rc = taglen + lenlen + len;
303 #ifdef STR_TRANSLATION
307 #endif /* STR_TRANSLATION */
315 LDAP_CONST struct berval *bv,
318 assert( ber != NULL );
319 assert( BER_VALID( ber ) );
321 if( bv == NULL || bv->bv_len == 0 ) {
322 return ber_put_ostring( ber, "", (ber_len_t) 0, tag );
325 return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
331 LDAP_CONST char *str,
334 assert( ber != NULL );
335 assert( str != NULL );
337 assert( BER_VALID( ber ) );
339 return( ber_put_ostring( ber, str, strlen( str ), tag ));
345 LDAP_CONST char *str,
346 ber_len_t blen /* in bits */,
349 ber_len_t taglen, lenlen, len;
350 unsigned char unusedbits;
352 assert( ber != NULL );
353 assert( str != NULL );
355 assert( BER_VALID( ber ) );
357 if ( tag == LBER_DEFAULT )
358 tag = LBER_BITSTRING;
360 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
363 len = ( blen + 7 ) / 8;
364 unusedbits = (unsigned char) ((len * 8) - blen);
365 if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 )
368 if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 )
371 if ( (ber_len_t) ber_write( ber, str, len, 0 ) != len )
374 /* return length of tag + length + unused bit count + contents */
375 return( taglen + 1 + lenlen + len );
379 ber_put_null( BerElement *ber, ber_tag_t tag )
383 assert( ber != NULL );
384 assert( BER_VALID( ber ) );
386 if ( tag == LBER_DEFAULT )
389 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
392 if ( ber_put_len( ber, 0, 0 ) != 1 )
395 return( taglen + 1 );
405 unsigned char trueval = 0xFFU;
406 unsigned char falseval = 0x00U;
408 assert( ber != NULL );
409 assert( BER_VALID( ber ) );
411 if ( tag == LBER_DEFAULT )
414 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
417 if ( ber_put_len( ber, 1, 0 ) != 1 )
420 if ( ber_write( ber, (char *)(boolval ? &trueval : &falseval), 1, 0 )
424 return( taglen + 2 );
427 #define FOUR_BYTE_LEN 5
436 assert( ber != NULL );
437 assert( BER_VALID( ber ) );
439 new = (Seqorset *) LBER_CALLOC( 1, sizeof(Seqorset) );
445 if ( ber->ber_sos == NULL )
446 new->sos_first = ber->ber_ptr;
448 new->sos_first = ber->ber_sos->sos_ptr;
450 /* Set aside room for a 4 byte length field */
451 new->sos_ptr = new->sos_first + ber_calc_taglen( tag ) + FOUR_BYTE_LEN;
454 new->sos_next = ber->ber_sos;
461 ber_start_seq( BerElement *ber, ber_tag_t tag )
463 assert( ber != NULL );
464 assert( BER_VALID( ber ) );
466 if ( tag == LBER_DEFAULT )
469 return( ber_start_seqorset( ber, tag ) );
473 ber_start_set( BerElement *ber, ber_tag_t tag )
475 assert( ber != NULL );
476 assert( BER_VALID( ber ) );
478 if ( tag == LBER_DEFAULT )
481 return( ber_start_seqorset( ber, tag ) );
485 ber_put_seqorset( BerElement *ber )
487 ber_len_t len, netlen;
488 ber_len_t taglen, lenlen;
489 unsigned char ltag = 0x80U + FOUR_BYTE_LEN - 1;
491 Seqorset **sos = &ber->ber_sos;
493 assert( ber != NULL );
494 assert( BER_VALID( ber ) );
497 * If this is the toplevel sequence or set, we need to actually
498 * write the stuff out. Otherwise, it's already been put in
499 * the appropriate buffer and will be written when the toplevel
500 * one is written. In this case all we need to do is update the
504 len = (*sos)->sos_clen;
505 netlen = LBER_LEN_HTON( len );
506 if ( sizeof(ber_len_t) > 4 && len > 0xffffffffUL )
509 if ( ber->ber_options & LBER_USE_DER ) {
510 lenlen = ber_calc_lenlen( len );
512 lenlen = FOUR_BYTE_LEN;
515 if ( (next = (*sos)->sos_next) == NULL ) {
517 if ( (taglen = ber_put_tag( ber, (*sos)->sos_tag, 1 )) == -1 )
520 if ( ber->ber_options & LBER_USE_DER ) {
521 /* Write the length in the minimum # of octets */
522 if ( ber_put_len( ber, len, 1 ) == -1 )
525 if (lenlen != FOUR_BYTE_LEN) {
527 * We set aside FOUR_BYTE_LEN bytes for
528 * the length field. Move the data if
529 * we don't actually need that much
531 SAFEMEMCPY( (*sos)->sos_first + taglen +
532 lenlen, (*sos)->sos_first + taglen +
533 FOUR_BYTE_LEN, len );
536 /* Fill FOUR_BYTE_LEN bytes for length field */
537 /* one byte of length length */
538 if ( ber_write( ber, (char *)<ag, 1, 1 ) != 1 )
541 /* the length itself */
542 if ( ber_write( ber, (char *) (&netlen + 1)
543 - (FOUR_BYTE_LEN - 1), FOUR_BYTE_LEN - 1, 1 )
544 != FOUR_BYTE_LEN - 1 )
547 /* The ber_ptr is at the set/seq start - move it to the end */
548 (*sos)->sos_ber->ber_ptr += len;
553 taglen = ber_calc_taglen( (*sos)->sos_tag );
554 ntag = LBER_TAG_HTON( (*sos)->sos_tag );
555 SAFEMEMCPY( (*sos)->sos_first, (char *) &ntag +
556 sizeof(ber_tag_t) - taglen, taglen );
558 if ( ber->ber_options & LBER_USE_DER ) {
560 ? (unsigned char) len
561 : (unsigned char) (0x80U + (lenlen - 1));
564 /* one byte of length length */
565 SAFEMEMCPY( (*sos)->sos_first + 1, <ag, 1 );
567 if ( ber->ber_options & LBER_USE_DER ) {
569 /* Write the length itself */
570 SAFEMEMCPY( (*sos)->sos_first + 2,
571 (char *)&netlen + sizeof(ber_len_t) -
575 if (lenlen != FOUR_BYTE_LEN) {
577 * We set aside FOUR_BYTE_LEN bytes for
578 * the length field. Move the data if
579 * we don't actually need that much
581 SAFEMEMCPY( (*sos)->sos_first + taglen +
582 lenlen, (*sos)->sos_first + taglen +
583 FOUR_BYTE_LEN, len );
586 /* the length itself */
587 SAFEMEMCPY( (*sos)->sos_first + taglen + 1,
588 (char *) &netlen + sizeof(ber_len_t) -
589 (FOUR_BYTE_LEN - 1), FOUR_BYTE_LEN - 1 );
592 next->sos_clen += (taglen + lenlen + len);
593 next->sos_ptr += (taglen + lenlen + len);
596 /* we're done with this seqorset, so free it up */
597 LBER_FREE( (char *) (*sos) );
600 return( taglen + lenlen + len );
604 ber_put_seq( BerElement *ber )
606 assert( ber != NULL );
607 assert( BER_VALID( ber ) );
609 return( ber_put_seqorset( ber ) );
613 ber_put_set( BerElement *ber )
615 assert( ber != NULL );
616 assert( BER_VALID( ber ) );
618 return( ber_put_seqorset( ber ) );
623 ber_printf( BerElement *ber, LDAP_CONST char *fmt, ... )
627 struct berval *bv, **bvp;
632 assert( ber != NULL );
633 assert( fmt != NULL );
635 assert( BER_VALID( ber ) );
639 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
641 case '!': { /* hook */
642 BEREncodeCallback *f;
645 f = va_arg( ap, BEREncodeCallback * );
646 p = va_arg( ap, void * );
651 case 'b': /* boolean */
652 i = va_arg( ap, ber_int_t );
653 rc = ber_put_boolean( ber, i, ber->ber_tag );
657 i = va_arg( ap, ber_int_t );
658 rc = ber_put_int( ber, i, ber->ber_tag );
661 case 'e': /* enumeration */
662 i = va_arg( ap, ber_int_t );
663 rc = ber_put_enum( ber, i, ber->ber_tag );
667 rc = ber_put_null( ber, ber->ber_tag );
670 case 'o': /* octet string (non-null terminated) */
671 s = va_arg( ap, char * );
672 len = va_arg( ap, ber_len_t );
673 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
676 case 'O': /* berval octet string */
677 bv = va_arg( ap, struct berval * );
678 if( bv == NULL ) break;
679 rc = ber_put_berval( ber, bv, ber->ber_tag );
682 case 's': /* string */
683 s = va_arg( ap, char * );
684 rc = ber_put_string( ber, s, ber->ber_tag );
687 case 'B': /* bit string */
688 s = va_arg( ap, char * );
689 len = va_arg( ap, int ); /* in bits */
690 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
693 case 't': /* tag for the next element */
694 ber->ber_tag = va_arg( ap, ber_tag_t );
695 ber->ber_usertag = 1;
698 case 'v': /* vector of strings */
699 if ( (ss = va_arg( ap, char ** )) == NULL )
701 for ( i = 0; ss[i] != NULL; i++ ) {
702 if ( (rc = ber_put_string( ber, ss[i],
703 ber->ber_tag )) == -1 )
708 case 'V': /* sequences of strings + lengths */
709 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
711 for ( i = 0; bvp[i] != NULL; i++ ) {
712 if ( (rc = ber_put_berval( ber, bvp[i],
713 ber->ber_tag )) == -1 )
718 case '{': /* begin sequence */
719 rc = ber_start_seq( ber, ber->ber_tag );
722 case '}': /* end sequence */
723 rc = ber_put_seqorset( ber );
726 case '[': /* begin set */
727 rc = ber_start_set( ber, ber->ber_tag );
730 case ']': /* end set */
731 rc = ber_put_seqorset( ber );
735 if( ber->ber_debug ) {
736 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
737 "ber_printf: unknown fmt %c\n", *fmt );
743 if ( ber->ber_usertag == 0 )
744 ber->ber_tag = LBER_DEFAULT;
746 ber->ber_usertag = 0;