1 /* encode.c - ber output encoding routines */
3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1990 Regents of the University of Michigan.
10 * Redistribution and use in source and binary forms are permitted
11 * provided that this notice is preserved and that due credit is given
12 * to the University of Michigan at Ann Arbor. The name of the University
13 * may not be used to endorse or promote products derived from this
14 * software without specific prior written permission. This software
15 * is provided ``as is'' without express or implied warranty.
22 #include <ac/stdlib.h>
24 #include <ac/stdarg.h>
25 #include <ac/socket.h>
26 #include <ac/string.h>
29 #define LDAP_F_PRE LDAP_F_EXPORT
33 static int ber_put_len LDAP_P((
38 static int ber_start_seqorset LDAP_P((
42 static int ber_put_seqorset LDAP_P(( BerElement *ber ));
44 static int ber_put_int_or_enum LDAP_P((
51 ber_calc_taglen( ber_tag_t tag )
56 /* find the first non-all-zero byte in the tag */
57 for ( i = sizeof(ber_tag_t) - 1; i > 0; i-- ) {
58 mask = ((ber_tag_t)0xffU << (i * 8));
77 assert( ber != NULL );
78 assert( BER_VALID( ber ) );
80 taglen = ber_calc_taglen( tag );
82 ntag = LBER_TAG_HTON( tag );
85 ((char *) &ntag) + sizeof(ber_tag_t) - taglen,
92 ber_calc_lenlen( ber_len_t len )
95 * short len if it's less than 128 - one byte giving the len,
99 if ( len <= (ber_len_t) 0x7FU )
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 )
109 if ( len <= (ber_len_t) 0xffffU )
111 if ( len <= (ber_len_t) 0xffffffU )
118 ber_put_len( BerElement *ber, ber_len_t len, int nosos )
125 assert( ber != NULL );
126 assert( BER_VALID( ber ) );
129 * short len if it's less than 128 - one byte giving the len,
134 netlen = LBER_LEN_HTON( len );
135 return( ber_write( ber, (char *) &netlen + sizeof(long) - 1,
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 = (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 = (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 & (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 (unsigned long) 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 + sizeof(long)
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 ) );
626 LDAP_CONST char *fmt,
639 struct berval *bv, **bvp;
648 ber = va_arg( ap, BerElement * );
649 fmt = va_arg( ap, char * );
652 assert( ber != NULL );
653 assert( fmt != NULL );
655 assert( BER_VALID( ber ) );
657 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
659 case '!': { /* hook */
660 BEREncodeCallback *f;
663 f = va_arg( ap, BEREncodeCallback * );
664 p = va_arg( ap, void * );
669 case 'b': /* boolean */
670 i = va_arg( ap, ber_int_t );
671 rc = ber_put_boolean( ber, i, ber->ber_tag );
675 i = va_arg( ap, ber_int_t );
676 rc = ber_put_int( ber, i, ber->ber_tag );
679 case 'e': /* enumeration */
680 i = va_arg( ap, ber_int_t );
681 rc = ber_put_enum( ber, i, ber->ber_tag );
685 rc = ber_put_null( ber, ber->ber_tag );
688 case 'o': /* octet string (non-null terminated) */
689 s = va_arg( ap, char * );
690 len = va_arg( ap, ber_len_t );
691 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
694 case 'O': /* berval octet string */
695 bv = va_arg( ap, struct berval * );
696 if( bv == NULL ) break;
697 rc = ber_put_berval( ber, bv, ber->ber_tag );
700 case 's': /* string */
701 s = va_arg( ap, char * );
702 rc = ber_put_string( ber, s, ber->ber_tag );
705 case 'B': /* bit string */
706 s = va_arg( ap, char * );
707 len = va_arg( ap, int ); /* in bits */
708 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
711 case 't': /* tag for the next element */
712 ber->ber_tag = va_arg( ap, ber_tag_t );
713 ber->ber_usertag = 1;
716 case 'v': /* vector of strings */
717 if ( (ss = va_arg( ap, char ** )) == NULL )
719 for ( i = 0; ss[i] != NULL; i++ ) {
720 if ( (rc = ber_put_string( ber, ss[i],
721 ber->ber_tag )) == -1 )
726 case 'V': /* sequences of strings + lengths */
727 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
729 for ( i = 0; bvp[i] != NULL; i++ ) {
730 if ( (rc = ber_put_berval( ber, bvp[i],
731 ber->ber_tag )) == -1 )
736 case '{': /* begin sequence */
737 rc = ber_start_seq( ber, ber->ber_tag );
740 case '}': /* end sequence */
741 rc = ber_put_seqorset( ber );
744 case '[': /* begin set */
745 rc = ber_start_set( ber, ber->ber_tag );
748 case ']': /* end set */
749 rc = ber_put_seqorset( ber );
753 if( ber->ber_debug ) {
754 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
755 "ber_printf: unknown fmt %c\n", *fmt );
761 if ( ber->ber_usertag == 0 )
762 ber->ber_tag = LBER_DEFAULT;
764 ber->ber_usertag = 0;