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>
30 static int ber_put_len LDAP_P(( BerElement *ber,
31 unsigned long len, int nosos ));
33 static int ber_start_seqorset LDAP_P(( BerElement *ber,
36 static int ber_put_seqorset LDAP_P(( BerElement *ber ));
38 static int ber_put_int_or_enum LDAP_P(( BerElement *ber,
39 long num, unsigned long tag ));
43 ber_calc_taglen( unsigned long tag )
48 /* find the first non-all-zero byte in the tag */
49 for ( i = sizeof(long) - 1; i > 0; i-- ) {
50 mask = (0xffUL << (i * 8));
60 ber_put_tag( BerElement *ber, unsigned long tag, int nosos )
65 assert( ber != NULL );
66 assert( BER_VALID( ber ) );
68 taglen = ber_calc_taglen( tag );
70 ntag = AC_HTONL( tag );
72 return( ber_write( ber, ((char *) &ntag) + sizeof(long) - taglen,
77 ber_calc_lenlen( unsigned long len )
80 * short len if it's less than 128 - one byte giving the len,
88 * long len otherwise - one byte with bit 8 set, giving the
89 * length of the length, followed by the length itself.
94 if ( len <= 0xffffUL )
96 if ( len <= 0xffffffUL )
103 ber_put_len( BerElement *ber, unsigned long len, int nosos )
108 unsigned long netlen;
110 assert( ber != NULL );
111 assert( BER_VALID( ber ) );
114 * short len if it's less than 128 - one byte giving the len,
119 netlen = AC_HTONL( len );
120 return( ber_write( ber, (char *) &netlen + sizeof(long) - 1,
125 * long len otherwise - one byte with bit 8 set, giving the
126 * length of the length, followed by the length itself.
129 /* find the first non-all-zero byte */
130 for ( i = sizeof(long) - 1; i > 0; i-- ) {
131 mask = (0xffUL << (i * 8));
136 lenlen = (unsigned char) ++i;
141 /* write the length of the length */
142 if ( ber_write( ber, &lenlen, 1, nosos ) != 1 )
145 /* write the length itself */
146 netlen = AC_HTONL( len );
147 if ( ber_write( ber, (char *) &netlen + (sizeof(long) - i), i, nosos )
155 ber_put_int_or_enum( BerElement *ber, long num, unsigned long tag )
161 assert( ber != NULL );
162 assert( BER_VALID( ber ) );
167 * high bit is set - look for first non-all-one byte
168 * high bit is clear - look for first non-all-zero byte
170 for ( i = sizeof(long) - 1; i > 0; i-- ) {
171 mask = (0xffUL << (i * 8));
175 if ( (num & mask) != mask )
185 * we now have the "leading byte". if the high bit on this
186 * byte matches the sign bit, we need to "back up" a byte.
188 mask = (num & (0x80UL << (i * 8)));
189 if ( (mask && !sign) || (sign && !mask) )
194 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
197 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 )
200 netnum = AC_HTONL( num );
201 if ( ber_write( ber, (char *) &netnum + (sizeof(long) - i), i, 0 )
205 /* length of tag + length + contents */
206 return( taglen + lenlen + i );
210 ber_put_enum( BerElement *ber, long num, unsigned long tag )
212 assert( ber != NULL );
213 assert( BER_VALID( ber ) );
215 if ( tag == LBER_DEFAULT )
216 tag = LBER_ENUMERATED;
218 return( ber_put_int_or_enum( ber, num, tag ) );
222 ber_put_int( BerElement *ber, long num, unsigned long tag )
224 assert( ber != NULL );
225 assert( BER_VALID( ber ) );
227 if ( tag == LBER_DEFAULT )
230 return( ber_put_int_or_enum( ber, num, tag ) );
236 LDAP_CONST char *str,
240 int taglen, lenlen, rc;
241 #ifdef STR_TRANSLATION
243 #endif /* STR_TRANSLATION */
245 assert( ber != NULL );
246 assert( str != NULL );
248 assert( BER_VALID( ber ) );
250 if ( tag == LBER_DEFAULT )
251 tag = LBER_OCTETSTRING;
253 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
256 #ifdef STR_TRANSLATION
257 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0 &&
258 ber->ber_encode_translate_proc ) {
259 if ( (*(ber->ber_encode_translate_proc))( &str, &len, 0 )
267 #endif /* STR_TRANSLATION */
269 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
270 (unsigned long) ber_write( ber, str, len, 0 ) != len ) {
273 /* return length of tag + length + contents */
274 rc = taglen + lenlen + len;
277 #ifdef STR_TRANSLATION
281 #endif /* STR_TRANSLATION */
288 LDAP_CONST struct berval *bv,
291 assert( ber != NULL );
292 assert( bv != NULL );
294 assert( BER_VALID( ber ) );
300 return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
306 LDAP_CONST char *str,
309 assert( ber != NULL );
310 assert( str != NULL );
312 assert( BER_VALID( ber ) );
314 return( ber_put_ostring( ber, str, strlen( str ), tag ));
320 LDAP_CONST char *str,
321 unsigned long blen /* in bits */,
324 int taglen, lenlen, len;
325 unsigned char unusedbits;
327 assert( ber != NULL );
328 assert( str != NULL );
330 assert( BER_VALID( ber ) );
332 if ( tag == LBER_DEFAULT )
333 tag = LBER_BITSTRING;
335 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
338 len = ( blen + 7 ) / 8;
339 unusedbits = (unsigned char) ((len * 8) - blen);
340 if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 )
343 if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 )
346 if ( ber_write( ber, str, len, 0 ) != len )
349 /* return length of tag + length + unused bit count + contents */
350 return( taglen + 1 + lenlen + len );
354 ber_put_null( BerElement *ber, unsigned long tag )
358 assert( ber != NULL );
359 assert( BER_VALID( ber ) );
361 if ( tag == LBER_DEFAULT )
364 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
367 if ( ber_put_len( ber, 0, 0 ) != 1 )
370 return( taglen + 1 );
374 ber_put_boolean( BerElement *ber, int boolval, unsigned long tag )
377 unsigned char trueval = 0xffU;
378 unsigned char falseval = 0x00U;
380 assert( ber != NULL );
381 assert( BER_VALID( ber ) );
383 if ( tag == LBER_DEFAULT )
386 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
389 if ( ber_put_len( ber, 1, 0 ) != 1 )
392 if ( ber_write( ber, (char *)(boolval ? &trueval : &falseval), 1, 0 )
396 return( taglen + 2 );
399 #define FOUR_BYTE_LEN 5
402 ber_start_seqorset( BerElement *ber, unsigned long tag )
406 assert( ber != NULL );
407 assert( BER_VALID( ber ) );
409 new = (Seqorset *) LBER_CALLOC( 1, sizeof(Seqorset) );
411 if ( new == NULLSEQORSET )
415 if ( ber->ber_sos == NULLSEQORSET )
416 new->sos_first = ber->ber_ptr;
418 new->sos_first = ber->ber_sos->sos_ptr;
420 /* Set aside room for a 4 byte length field */
421 new->sos_ptr = new->sos_first + ber_calc_taglen( tag ) + FOUR_BYTE_LEN;
424 new->sos_next = ber->ber_sos;
431 ber_start_seq( BerElement *ber, unsigned long tag )
433 assert( ber != NULL );
434 assert( BER_VALID( ber ) );
436 if ( tag == LBER_DEFAULT )
439 return( ber_start_seqorset( ber, tag ) );
443 ber_start_set( BerElement *ber, unsigned long tag )
445 assert( ber != NULL );
446 assert( BER_VALID( ber ) );
448 if ( tag == LBER_DEFAULT )
451 return( ber_start_seqorset( ber, tag ) );
455 ber_put_seqorset( BerElement *ber )
457 unsigned long len, netlen;
459 unsigned char ltag = 0x80U + FOUR_BYTE_LEN - 1;
461 Seqorset **sos = &ber->ber_sos;
463 assert( ber != NULL );
464 assert( BER_VALID( ber ) );
467 * If this is the toplevel sequence or set, we need to actually
468 * write the stuff out. Otherwise, it's already been put in
469 * the appropriate buffer and will be written when the toplevel
470 * one is written. In this case all we need to do is update the
474 len = (*sos)->sos_clen;
475 netlen = AC_HTONL( len );
476 if ( sizeof(long) > 4 && len > 0xffffffffUL )
479 if ( ber->ber_options & LBER_USE_DER ) {
480 lenlen = ber_calc_lenlen( len );
482 lenlen = FOUR_BYTE_LEN;
485 if ( (next = (*sos)->sos_next) == NULLSEQORSET ) {
487 if ( (taglen = ber_put_tag( ber, (*sos)->sos_tag, 1 )) == -1 )
490 if ( ber->ber_options & LBER_USE_DER ) {
491 /* Write the length in the minimum # of octets */
492 if ( ber_put_len( ber, len, 1 ) == -1 )
495 if (lenlen != FOUR_BYTE_LEN) {
497 * We set aside FOUR_BYTE_LEN bytes for
498 * the length field. Move the data if
499 * we don't actually need that much
501 SAFEMEMCPY( (*sos)->sos_first + taglen +
502 lenlen, (*sos)->sos_first + taglen +
503 FOUR_BYTE_LEN, len );
506 /* Fill FOUR_BYTE_LEN bytes for length field */
507 /* one byte of length length */
508 if ( ber_write( ber, (char *)<ag, 1, 1 ) != 1 )
511 /* the length itself */
512 if ( ber_write( ber, (char *) &netlen + sizeof(long)
513 - (FOUR_BYTE_LEN - 1), FOUR_BYTE_LEN - 1, 1 )
514 != FOUR_BYTE_LEN - 1 )
517 /* The ber_ptr is at the set/seq start - move it to the end */
518 (*sos)->sos_ber->ber_ptr += len;
523 taglen = ber_calc_taglen( (*sos)->sos_tag );
524 ntag = AC_HTONL( (*sos)->sos_tag );
525 SAFEMEMCPY( (*sos)->sos_first, (char *) &ntag +
526 sizeof(long) - taglen, taglen );
528 if ( ber->ber_options & LBER_USE_DER ) {
530 ? (unsigned char) len
531 : (unsigned char) (0x80UL + (lenlen - 1));
534 /* one byte of length length */
535 SAFEMEMCPY( (*sos)->sos_first + 1, <ag, 1 );
537 if ( ber->ber_options & LBER_USE_DER ) {
539 /* Write the length itself */
540 SAFEMEMCPY( (*sos)->sos_first + 2,
541 (char *)&netlen + sizeof(unsigned long) -
545 if (lenlen != FOUR_BYTE_LEN) {
547 * We set aside FOUR_BYTE_LEN bytes for
548 * the length field. Move the data if
549 * we don't actually need that much
551 SAFEMEMCPY( (*sos)->sos_first + taglen +
552 lenlen, (*sos)->sos_first + taglen +
553 FOUR_BYTE_LEN, len );
556 /* the length itself */
557 SAFEMEMCPY( (*sos)->sos_first + taglen + 1,
558 (char *) &netlen + sizeof(long) -
559 (FOUR_BYTE_LEN - 1), FOUR_BYTE_LEN - 1 );
562 next->sos_clen += (taglen + lenlen + len);
563 next->sos_ptr += (taglen + lenlen + len);
566 /* we're done with this seqorset, so free it up */
567 LBER_FREE( (char *) (*sos) );
570 return( taglen + lenlen + len );
574 ber_put_seq( BerElement *ber )
576 assert( ber != NULL );
577 assert( BER_VALID( ber ) );
579 return( ber_put_seqorset( ber ) );
583 ber_put_set( BerElement *ber )
585 assert( ber != NULL );
586 assert( BER_VALID( ber ) );
588 return( ber_put_seqorset( ber ) );
596 LDAP_CONST char *fmt,
609 struct berval *bv, **bvp;
617 ber = va_arg( ap, BerElement * );
618 fmt = va_arg( ap, char * );
621 assert( ber != NULL );
622 assert( fmt != NULL );
624 assert( BER_VALID( ber ) );
626 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
628 case '!': { /* hook */
629 BEREncodeCallback *f;
632 f = va_arg( ap, BEREncodeCallback * );
633 p = va_arg( ap, void * );
638 case 'b': /* boolean */
639 i = va_arg( ap, int );
640 rc = ber_put_boolean( ber, i, ber->ber_tag );
644 i = va_arg( ap, int );
645 rc = ber_put_int( ber, i, ber->ber_tag );
648 case 'e': /* enumeration */
649 i = va_arg( ap, int );
650 rc = ber_put_enum( ber, i, ber->ber_tag );
654 rc = ber_put_null( ber, ber->ber_tag );
657 case 'o': /* octet string (non-null terminated) */
658 s = va_arg( ap, char * );
659 len = va_arg( ap, int );
660 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
663 case 'O': /* berval octet string */
664 bv = va_arg( ap, struct berval * );
665 if( bv == NULL ) break;
666 rc = ber_put_berval( ber, bv, ber->ber_tag );
669 case 's': /* string */
670 s = va_arg( ap, char * );
671 rc = ber_put_string( ber, s, ber->ber_tag );
674 case 'B': /* bit string */
675 s = va_arg( ap, char * );
676 len = va_arg( ap, int ); /* in bits */
677 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
680 case 't': /* tag for the next element */
681 ber->ber_tag = va_arg( ap, unsigned long );
682 ber->ber_usertag = 1;
685 case 'v': /* vector of strings */
686 if ( (ss = va_arg( ap, char ** )) == NULL )
688 for ( i = 0; ss[i] != NULL; i++ ) {
689 if ( (rc = ber_put_string( ber, ss[i],
690 ber->ber_tag )) == -1 )
695 case 'V': /* sequences of strings + lengths */
696 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
698 for ( i = 0; bvp[i] != NULL; i++ ) {
699 if ( (rc = ber_put_ostring( ber, bvp[i]->bv_val,
700 bvp[i]->bv_len, ber->ber_tag )) == -1 )
705 case '{': /* begin sequence */
706 rc = ber_start_seq( ber, ber->ber_tag );
709 case '}': /* end sequence */
710 rc = ber_put_seqorset( ber );
713 case '[': /* begin set */
714 rc = ber_start_set( ber, ber->ber_tag );
717 case ']': /* end set */
718 rc = ber_put_seqorset( ber );
722 if( ber->ber_debug ) {
723 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
724 "ber_printf: unknown fmt %c\n", *fmt );
730 if ( ber->ber_usertag == 0 )
731 ber->ber_tag = LBER_DEFAULT;
733 ber->ber_usertag = 0;