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_int_t netnum, mask;
179 assert( ber != NULL );
180 assert( BER_VALID( ber ) );
185 * high bit is set - look for first non-all-one byte
186 * high bit is clear - look for first non-all-zero byte
188 for ( i = sizeof(ber_int_t) - 1; i > 0; i-- ) {
189 mask = (0xffU << (i * 8));
193 if ( (num & mask) != mask )
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 = (num & (0x80U << (i * 8)));
207 if ( (mask && !sign) || (sign && !mask) )
212 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
215 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 )
218 netnum = LBER_INT_HTON( num );
219 if ( ber_write( ber, (char *) &netnum + (sizeof(ber_int_t) - i), i, 0 )
223 /* length of tag + length + contents */
224 return( taglen + lenlen + i );
233 assert( ber != NULL );
234 assert( BER_VALID( ber ) );
236 if ( tag == LBER_DEFAULT )
237 tag = LBER_ENUMERATED;
239 return( ber_put_int_or_enum( ber, num, tag ) );
248 assert( ber != NULL );
249 assert( BER_VALID( ber ) );
251 if ( tag == LBER_DEFAULT )
254 return( ber_put_int_or_enum( ber, num, tag ) );
260 LDAP_CONST char *str,
264 ber_len_t taglen, lenlen;
266 #ifdef STR_TRANSLATION
268 #endif /* STR_TRANSLATION */
270 assert( ber != NULL );
271 assert( str != NULL );
273 assert( BER_VALID( ber ) );
275 if ( tag == LBER_DEFAULT )
276 tag = LBER_OCTETSTRING;
278 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
281 #ifdef STR_TRANSLATION
282 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0 &&
283 ber->ber_encode_translate_proc ) {
284 if ( (*(ber->ber_encode_translate_proc))( &str, &len, 0 )
292 #endif /* STR_TRANSLATION */
294 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
295 (unsigned long) ber_write( ber, str, len, 0 ) != len ) {
298 /* return length of tag + length + contents */
299 rc = taglen + lenlen + len;
302 #ifdef STR_TRANSLATION
306 #endif /* STR_TRANSLATION */
314 LDAP_CONST struct berval *bv,
317 assert( ber != NULL );
318 assert( bv != NULL );
320 assert( BER_VALID( ber ) );
326 return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
332 LDAP_CONST char *str,
335 assert( ber != NULL );
336 assert( str != NULL );
338 assert( BER_VALID( ber ) );
340 return( ber_put_ostring( ber, str, strlen( str ), tag ));
346 LDAP_CONST char *str,
347 ber_len_t blen /* in bits */,
350 ber_len_t taglen, lenlen, len;
351 unsigned char unusedbits;
353 assert( ber != NULL );
354 assert( str != NULL );
356 assert( BER_VALID( ber ) );
358 if ( tag == LBER_DEFAULT )
359 tag = LBER_BITSTRING;
361 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
364 len = ( blen + 7 ) / 8;
365 unusedbits = (unsigned char) ((len * 8) - blen);
366 if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 )
369 if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 )
372 if ( (ber_len_t) ber_write( ber, str, len, 0 ) != len )
375 /* return length of tag + length + unused bit count + contents */
376 return( taglen + 1 + lenlen + len );
380 ber_put_null( BerElement *ber, ber_tag_t tag )
384 assert( ber != NULL );
385 assert( BER_VALID( ber ) );
387 if ( tag == LBER_DEFAULT )
390 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
393 if ( ber_put_len( ber, 0, 0 ) != 1 )
396 return( taglen + 1 );
406 unsigned char trueval = 0xFFU;
407 unsigned char falseval = 0x00U;
409 assert( ber != NULL );
410 assert( BER_VALID( ber ) );
412 if ( tag == LBER_DEFAULT )
415 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
418 if ( ber_put_len( ber, 1, 0 ) != 1 )
421 if ( ber_write( ber, (char *)(boolval ? &trueval : &falseval), 1, 0 )
425 return( taglen + 2 );
428 #define FOUR_BYTE_LEN 5
437 assert( ber != NULL );
438 assert( BER_VALID( ber ) );
440 new = (Seqorset *) LBER_CALLOC( 1, sizeof(Seqorset) );
446 if ( ber->ber_sos == NULL )
447 new->sos_first = ber->ber_ptr;
449 new->sos_first = ber->ber_sos->sos_ptr;
451 /* Set aside room for a 4 byte length field */
452 new->sos_ptr = new->sos_first + ber_calc_taglen( tag ) + FOUR_BYTE_LEN;
455 new->sos_next = ber->ber_sos;
462 ber_start_seq( BerElement *ber, ber_tag_t tag )
464 assert( ber != NULL );
465 assert( BER_VALID( ber ) );
467 if ( tag == LBER_DEFAULT )
470 return( ber_start_seqorset( ber, tag ) );
474 ber_start_set( 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_put_seqorset( BerElement *ber )
488 ber_len_t len, netlen;
489 ber_len_t taglen, lenlen;
490 unsigned char ltag = 0x80U + FOUR_BYTE_LEN - 1;
492 Seqorset **sos = &ber->ber_sos;
494 assert( ber != NULL );
495 assert( BER_VALID( ber ) );
498 * If this is the toplevel sequence or set, we need to actually
499 * write the stuff out. Otherwise, it's already been put in
500 * the appropriate buffer and will be written when the toplevel
501 * one is written. In this case all we need to do is update the
505 len = (*sos)->sos_clen;
506 netlen = LBER_LEN_HTON( len );
507 if ( sizeof(ber_len_t) > 4 && len > 0xffffffffUL )
510 if ( ber->ber_options & LBER_USE_DER ) {
511 lenlen = ber_calc_lenlen( len );
513 lenlen = FOUR_BYTE_LEN;
516 if ( (next = (*sos)->sos_next) == NULL ) {
518 if ( (taglen = ber_put_tag( ber, (*sos)->sos_tag, 1 )) == -1 )
521 if ( ber->ber_options & LBER_USE_DER ) {
522 /* Write the length in the minimum # of octets */
523 if ( ber_put_len( ber, len, 1 ) == -1 )
526 if (lenlen != FOUR_BYTE_LEN) {
528 * We set aside FOUR_BYTE_LEN bytes for
529 * the length field. Move the data if
530 * we don't actually need that much
532 SAFEMEMCPY( (*sos)->sos_first + taglen +
533 lenlen, (*sos)->sos_first + taglen +
534 FOUR_BYTE_LEN, len );
537 /* Fill FOUR_BYTE_LEN bytes for length field */
538 /* one byte of length length */
539 if ( ber_write( ber, (char *)<ag, 1, 1 ) != 1 )
542 /* the length itself */
543 if ( ber_write( ber, (char *) &netlen + sizeof(long)
544 - (FOUR_BYTE_LEN - 1), FOUR_BYTE_LEN - 1, 1 )
545 != FOUR_BYTE_LEN - 1 )
548 /* The ber_ptr is at the set/seq start - move it to the end */
549 (*sos)->sos_ber->ber_ptr += len;
554 taglen = ber_calc_taglen( (*sos)->sos_tag );
555 ntag = LBER_TAG_HTON( (*sos)->sos_tag );
556 SAFEMEMCPY( (*sos)->sos_first, (char *) &ntag +
557 sizeof(ber_tag_t) - taglen, taglen );
559 if ( ber->ber_options & LBER_USE_DER ) {
561 ? (unsigned char) len
562 : (unsigned char) (0x80U + (lenlen - 1));
565 /* one byte of length length */
566 SAFEMEMCPY( (*sos)->sos_first + 1, <ag, 1 );
568 if ( ber->ber_options & LBER_USE_DER ) {
570 /* Write the length itself */
571 SAFEMEMCPY( (*sos)->sos_first + 2,
572 (char *)&netlen + sizeof(ber_len_t) -
576 if (lenlen != FOUR_BYTE_LEN) {
578 * We set aside FOUR_BYTE_LEN bytes for
579 * the length field. Move the data if
580 * we don't actually need that much
582 SAFEMEMCPY( (*sos)->sos_first + taglen +
583 lenlen, (*sos)->sos_first + taglen +
584 FOUR_BYTE_LEN, len );
587 /* the length itself */
588 SAFEMEMCPY( (*sos)->sos_first + taglen + 1,
589 (char *) &netlen + sizeof(ber_len_t) -
590 (FOUR_BYTE_LEN - 1), FOUR_BYTE_LEN - 1 );
593 next->sos_clen += (taglen + lenlen + len);
594 next->sos_ptr += (taglen + lenlen + len);
597 /* we're done with this seqorset, so free it up */
598 LBER_FREE( (char *) (*sos) );
601 return( taglen + lenlen + len );
605 ber_put_seq( BerElement *ber )
607 assert( ber != NULL );
608 assert( BER_VALID( ber ) );
610 return( ber_put_seqorset( ber ) );
614 ber_put_set( BerElement *ber )
616 assert( ber != NULL );
617 assert( BER_VALID( ber ) );
619 return( ber_put_seqorset( ber ) );
627 LDAP_CONST char *fmt,
640 struct berval *bv, **bvp;
649 ber = va_arg( ap, BerElement * );
650 fmt = va_arg( ap, char * );
653 assert( ber != NULL );
654 assert( fmt != NULL );
656 assert( BER_VALID( ber ) );
658 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
660 case '!': { /* hook */
661 BEREncodeCallback *f;
664 f = va_arg( ap, BEREncodeCallback * );
665 p = va_arg( ap, void * );
670 case 'b': /* boolean */
671 i = va_arg( ap, ber_int_t );
672 rc = ber_put_boolean( ber, i, ber->ber_tag );
676 i = va_arg( ap, ber_int_t );
677 rc = ber_put_int( ber, i, ber->ber_tag );
680 case 'e': /* enumeration */
681 i = va_arg( ap, ber_int_t );
682 rc = ber_put_enum( ber, i, ber->ber_tag );
686 rc = ber_put_null( ber, ber->ber_tag );
689 case 'o': /* octet string (non-null terminated) */
690 s = va_arg( ap, char * );
691 len = va_arg( ap, ber_len_t );
692 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
695 case 'O': /* berval octet string */
696 bv = va_arg( ap, struct berval * );
697 if( bv == NULL ) break;
698 rc = ber_put_berval( ber, bv, ber->ber_tag );
701 case 's': /* string */
702 s = va_arg( ap, char * );
703 rc = ber_put_string( ber, s, ber->ber_tag );
706 case 'B': /* bit string */
707 s = va_arg( ap, char * );
708 len = va_arg( ap, int ); /* in bits */
709 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
712 case 't': /* tag for the next element */
713 ber->ber_tag = va_arg( ap, ber_tag_t );
714 ber->ber_usertag = 1;
717 case 'v': /* vector of strings */
718 if ( (ss = va_arg( ap, char ** )) == NULL )
720 for ( i = 0; ss[i] != NULL; i++ ) {
721 if ( (rc = ber_put_string( ber, ss[i],
722 ber->ber_tag )) == -1 )
727 case 'V': /* sequences of strings + lengths */
728 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
730 for ( i = 0; bvp[i] != NULL; i++ ) {
731 if ( (rc = ber_put_ostring( ber, bvp[i]->bv_val,
732 bvp[i]->bv_len, ber->ber_tag )) == -1 )
737 case '{': /* begin sequence */
738 rc = ber_start_seq( ber, ber->ber_tag );
741 case '}': /* end sequence */
742 rc = ber_put_seqorset( ber );
745 case '[': /* begin set */
746 rc = ber_start_set( ber, ber->ber_tag );
749 case ']': /* end set */
750 rc = ber_put_seqorset( ber );
754 if( ber->ber_debug ) {
755 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
756 "ber_printf: unknown fmt %c\n", *fmt );
762 if ( ber->ber_usertag == 0 )
763 ber->ber_tag = LBER_DEFAULT;
765 ber->ber_usertag = 0;