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.
23 #include <ac/stdarg.h>
24 #include <ac/socket.h>
25 #include <ac/string.h>
29 static int ber_put_len LDAP_P(( BerElement *ber,
30 unsigned long len, int nosos ));
32 static int ber_start_seqorset LDAP_P(( BerElement *ber,
35 static int ber_put_seqorset LDAP_P(( BerElement *ber ));
37 static int ber_put_int_or_enum LDAP_P(( BerElement *ber,
38 long num, unsigned long tag ));
42 ber_calc_taglen( unsigned long tag )
47 /* find the first non-all-zero byte in the tag */
48 for ( i = sizeof(long) - 1; i > 0; i-- ) {
49 mask = (0xffUL << (i * 8));
59 ber_put_tag( BerElement *ber, unsigned long tag, int nosos )
64 taglen = ber_calc_taglen( tag );
66 ntag = AC_HTONL( tag );
68 return( ber_write( ber, ((char *) &ntag) + sizeof(long) - taglen,
73 ber_calc_lenlen( unsigned long len )
76 * short len if it's less than 128 - one byte giving the len,
84 * long len otherwise - one byte with bit 8 set, giving the
85 * length of the length, followed by the length itself.
90 if ( len <= 0xffffUL )
92 if ( len <= 0xffffffUL )
99 ber_put_len( BerElement *ber, unsigned long len, int nosos )
104 unsigned long netlen;
106 assert( ber != NULL );
109 * short len if it's less than 128 - one byte giving the len,
114 netlen = AC_HTONL( len );
115 return( ber_write( ber, (char *) &netlen + sizeof(long) - 1,
120 * long len otherwise - one byte with bit 8 set, giving the
121 * length of the length, followed by the length itself.
124 /* find the first non-all-zero byte */
125 for ( i = sizeof(long) - 1; i > 0; i-- ) {
126 mask = (0xffUL << (i * 8));
131 lenlen = (unsigned char) ++i;
136 /* write the length of the length */
137 if ( ber_write( ber, &lenlen, 1, nosos ) != 1 )
140 /* write the length itself */
141 netlen = AC_HTONL( len );
142 if ( ber_write( ber, (char *) &netlen + (sizeof(long) - i), i, nosos )
150 ber_put_int_or_enum( BerElement *ber, long num, unsigned long tag )
156 assert( ber != NULL );
161 * high bit is set - look for first non-all-one byte
162 * high bit is clear - look for first non-all-zero byte
164 for ( i = sizeof(long) - 1; i > 0; i-- ) {
165 mask = (0xffUL << (i * 8));
169 if ( (num & mask) != mask )
179 * we now have the "leading byte". if the high bit on this
180 * byte matches the sign bit, we need to "back up" a byte.
182 mask = (num & (0x80UL << (i * 8)));
183 if ( (mask && !sign) || (sign && !mask) )
188 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
191 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 )
194 netnum = AC_HTONL( num );
195 if ( ber_write( ber, (char *) &netnum + (sizeof(long) - i), i, 0 )
199 /* length of tag + length + contents */
200 return( taglen + lenlen + i );
204 ber_put_enum( BerElement *ber, long num, unsigned long tag )
206 assert( ber != NULL );
208 if ( tag == LBER_DEFAULT )
209 tag = LBER_ENUMERATED;
211 return( ber_put_int_or_enum( ber, num, tag ) );
215 ber_put_int( BerElement *ber, long num, unsigned long tag )
217 assert( ber != NULL );
219 if ( tag == LBER_DEFAULT )
222 return( ber_put_int_or_enum( ber, num, tag ) );
228 LDAP_CONST char *str,
232 int taglen, lenlen, rc;
233 #ifdef STR_TRANSLATION
235 #endif /* STR_TRANSLATION */
237 assert( ber != NULL );
238 assert( str != NULL );
240 if ( tag == LBER_DEFAULT )
241 tag = LBER_OCTETSTRING;
243 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
246 #ifdef STR_TRANSLATION
247 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0 &&
248 ber->ber_encode_translate_proc ) {
249 if ( (*(ber->ber_encode_translate_proc))( &str, &len, 0 )
257 #endif /* STR_TRANSLATION */
259 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
260 (unsigned long) ber_write( ber, str, len, 0 ) != len ) {
263 /* return length of tag + length + contents */
264 rc = taglen + lenlen + len;
267 #ifdef STR_TRANSLATION
271 #endif /* STR_TRANSLATION */
278 LDAP_CONST struct berval *bv,
281 assert( ber != NULL );
282 assert( bv != NULL );
288 return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
294 LDAP_CONST char *str,
297 assert( ber != NULL );
298 assert( str != NULL );
300 return( ber_put_ostring( ber, str, strlen( str ), tag ));
306 LDAP_CONST char *str,
307 unsigned long blen /* in bits */,
310 int taglen, lenlen, len;
311 unsigned char unusedbits;
313 assert( ber != NULL );
314 assert( str != NULL );
316 if ( tag == LBER_DEFAULT )
317 tag = LBER_BITSTRING;
319 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
322 len = ( blen + 7 ) / 8;
323 unusedbits = (unsigned char) ((len * 8) - blen);
324 if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 )
327 if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 )
330 if ( ber_write( ber, str, len, 0 ) != len )
333 /* return length of tag + length + unused bit count + contents */
334 return( taglen + 1 + lenlen + len );
338 ber_put_null( BerElement *ber, unsigned long tag )
342 if ( tag == LBER_DEFAULT )
345 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
348 if ( ber_put_len( ber, 0, 0 ) != 1 )
351 return( taglen + 1 );
355 ber_put_boolean( BerElement *ber, int boolval, unsigned long tag )
358 unsigned char trueval = 0xffU;
359 unsigned char falseval = 0x00U;
361 assert( ber != NULL );
363 if ( tag == LBER_DEFAULT )
366 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
369 if ( ber_put_len( ber, 1, 0 ) != 1 )
372 if ( ber_write( ber, (char *)(boolval ? &trueval : &falseval), 1, 0 )
376 return( taglen + 2 );
379 #define FOUR_BYTE_LEN 5
382 ber_start_seqorset( BerElement *ber, unsigned long tag )
386 assert( ber != NULL );
388 if ( (new = (Seqorset *) calloc( sizeof(Seqorset), 1 ))
392 if ( ber->ber_sos == NULLSEQORSET )
393 new->sos_first = ber->ber_ptr;
395 new->sos_first = ber->ber_sos->sos_ptr;
397 /* Set aside room for a 4 byte length field */
398 new->sos_ptr = new->sos_first + ber_calc_taglen( tag ) + FOUR_BYTE_LEN;
401 new->sos_next = ber->ber_sos;
408 ber_start_seq( BerElement *ber, unsigned long tag )
410 assert( ber != NULL );
412 if ( tag == LBER_DEFAULT )
415 return( ber_start_seqorset( ber, tag ) );
419 ber_start_set( BerElement *ber, unsigned long tag )
421 assert( ber != NULL );
423 if ( tag == LBER_DEFAULT )
426 return( ber_start_seqorset( ber, tag ) );
430 ber_put_seqorset( BerElement *ber )
432 unsigned long len, netlen;
434 unsigned char ltag = 0x80U + FOUR_BYTE_LEN - 1;
436 Seqorset **sos = &ber->ber_sos;
438 assert( ber != NULL );
441 * If this is the toplevel sequence or set, we need to actually
442 * write the stuff out. Otherwise, it's already been put in
443 * the appropriate buffer and will be written when the toplevel
444 * one is written. In this case all we need to do is update the
448 len = (*sos)->sos_clen;
449 netlen = AC_HTONL( len );
450 if ( sizeof(long) > 4 && len > 0xffffffffUL )
453 if ( ber->ber_options & LBER_USE_DER ) {
454 lenlen = ber_calc_lenlen( len );
456 lenlen = FOUR_BYTE_LEN;
459 if ( (next = (*sos)->sos_next) == NULLSEQORSET ) {
461 if ( (taglen = ber_put_tag( ber, (*sos)->sos_tag, 1 )) == -1 )
464 if ( ber->ber_options & LBER_USE_DER ) {
465 /* Write the length in the minimum # of octets */
466 if ( ber_put_len( ber, len, 1 ) == -1 )
469 if (lenlen != FOUR_BYTE_LEN) {
471 * We set aside FOUR_BYTE_LEN bytes for
472 * the length field. Move the data if
473 * we don't actually need that much
475 SAFEMEMCPY( (*sos)->sos_first + taglen +
476 lenlen, (*sos)->sos_first + taglen +
477 FOUR_BYTE_LEN, len );
480 /* Fill FOUR_BYTE_LEN bytes for length field */
481 /* one byte of length length */
482 if ( ber_write( ber, (char *)<ag, 1, 1 ) != 1 )
485 /* the length itself */
486 if ( ber_write( ber, (char *) &netlen + sizeof(long)
487 - (FOUR_BYTE_LEN - 1), FOUR_BYTE_LEN - 1, 1 )
488 != FOUR_BYTE_LEN - 1 )
491 /* The ber_ptr is at the set/seq start - move it to the end */
492 (*sos)->sos_ber->ber_ptr += len;
497 taglen = ber_calc_taglen( (*sos)->sos_tag );
498 ntag = AC_HTONL( (*sos)->sos_tag );
499 SAFEMEMCPY( (*sos)->sos_first, (char *) &ntag +
500 sizeof(long) - taglen, taglen );
502 if ( ber->ber_options & LBER_USE_DER ) {
504 ? (unsigned char) len
505 : (unsigned char) (0x80UL + (lenlen - 1));
508 /* one byte of length length */
509 SAFEMEMCPY( (*sos)->sos_first + 1, <ag, 1 );
511 if ( ber->ber_options & LBER_USE_DER ) {
513 /* Write the length itself */
514 SAFEMEMCPY( (*sos)->sos_first + 2,
515 (char *)&netlen + sizeof(unsigned long) -
519 if (lenlen != FOUR_BYTE_LEN) {
521 * We set aside FOUR_BYTE_LEN bytes for
522 * the length field. Move the data if
523 * we don't actually need that much
525 SAFEMEMCPY( (*sos)->sos_first + taglen +
526 lenlen, (*sos)->sos_first + taglen +
527 FOUR_BYTE_LEN, len );
530 /* the length itself */
531 SAFEMEMCPY( (*sos)->sos_first + taglen + 1,
532 (char *) &netlen + sizeof(long) -
533 (FOUR_BYTE_LEN - 1), FOUR_BYTE_LEN - 1 );
536 next->sos_clen += (taglen + lenlen + len);
537 next->sos_ptr += (taglen + lenlen + len);
540 /* we're done with this seqorset, so free it up */
541 free( (char *) (*sos) );
544 return( taglen + lenlen + len );
548 ber_put_seq( BerElement *ber )
550 assert( ber != NULL );
551 return( ber_put_seqorset( ber ) );
555 ber_put_set( BerElement *ber )
557 assert( ber != NULL );
558 return( ber_put_seqorset( ber ) );
566 LDAP_CONST char *fmt,
579 struct berval *bv, **bvp;
587 ber = va_arg( ap, BerElement * );
588 fmt = va_arg( ap, char * );
591 assert( ber != NULL );
592 assert( fmt != NULL );
594 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
596 case '!': { /* hook */
597 BEREncodeCallback *f;
600 f = va_arg( ap, BEREncodeCallback * );
601 p = va_arg( ap, void * );
606 case 'b': /* boolean */
607 i = va_arg( ap, int );
608 rc = ber_put_boolean( ber, i, ber->ber_tag );
612 i = va_arg( ap, int );
613 rc = ber_put_int( ber, i, ber->ber_tag );
616 case 'e': /* enumeration */
617 i = va_arg( ap, int );
618 rc = ber_put_enum( ber, i, ber->ber_tag );
622 rc = ber_put_null( ber, ber->ber_tag );
625 case 'o': /* octet string (non-null terminated) */
626 s = va_arg( ap, char * );
627 len = va_arg( ap, int );
628 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
631 case 'O': /* berval octet string */
632 bv = va_arg( ap, struct berval * );
633 if( bv == NULL ) break;
634 rc = ber_put_berval( ber, bv, ber->ber_tag );
637 case 's': /* string */
638 s = va_arg( ap, char * );
639 rc = ber_put_string( ber, s, ber->ber_tag );
642 case 'B': /* bit string */
643 s = va_arg( ap, char * );
644 len = va_arg( ap, int ); /* in bits */
645 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
648 case 't': /* tag for the next element */
649 ber->ber_tag = va_arg( ap, unsigned long );
650 ber->ber_usertag = 1;
653 case 'v': /* vector of strings */
654 if ( (ss = va_arg( ap, char ** )) == NULL )
656 for ( i = 0; ss[i] != NULL; i++ ) {
657 if ( (rc = ber_put_string( ber, ss[i],
658 ber->ber_tag )) == -1 )
663 case 'V': /* sequences of strings + lengths */
664 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
666 for ( i = 0; bvp[i] != NULL; i++ ) {
667 if ( (rc = ber_put_ostring( ber, bvp[i]->bv_val,
668 bvp[i]->bv_len, ber->ber_tag )) == -1 )
673 case '{': /* begin sequence */
674 rc = ber_start_seq( ber, ber->ber_tag );
677 case '}': /* end sequence */
678 rc = ber_put_seqorset( ber );
681 case '[': /* begin set */
682 rc = ber_start_set( ber, ber->ber_tag );
685 case ']': /* end set */
686 rc = ber_put_seqorset( ber );
690 if( ber->ber_debug ) {
691 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
692 "ber_printf: unknown fmt %c\n", *fmt );
698 if ( ber->ber_usertag == 0 )
699 ber->ber_tag = LBER_DEFAULT;
701 ber->ber_usertag = 0;