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 assert( ber != NULL );
65 assert( BER_VALID( ber ) );
67 taglen = ber_calc_taglen( tag );
69 ntag = AC_HTONL( tag );
71 return( ber_write( ber, ((char *) &ntag) + sizeof(long) - taglen,
76 ber_calc_lenlen( unsigned long len )
79 * short len if it's less than 128 - one byte giving the len,
87 * long len otherwise - one byte with bit 8 set, giving the
88 * length of the length, followed by the length itself.
93 if ( len <= 0xffffUL )
95 if ( len <= 0xffffffUL )
102 ber_put_len( BerElement *ber, unsigned long len, int nosos )
107 unsigned long netlen;
109 assert( ber != NULL );
110 assert( BER_VALID( ber ) );
113 * short len if it's less than 128 - one byte giving the len,
118 netlen = AC_HTONL( len );
119 return( ber_write( ber, (char *) &netlen + sizeof(long) - 1,
124 * long len otherwise - one byte with bit 8 set, giving the
125 * length of the length, followed by the length itself.
128 /* find the first non-all-zero byte */
129 for ( i = sizeof(long) - 1; i > 0; i-- ) {
130 mask = (0xffUL << (i * 8));
135 lenlen = (unsigned char) ++i;
140 /* write the length of the length */
141 if ( ber_write( ber, &lenlen, 1, nosos ) != 1 )
144 /* write the length itself */
145 netlen = AC_HTONL( len );
146 if ( ber_write( ber, (char *) &netlen + (sizeof(long) - i), i, nosos )
154 ber_put_int_or_enum( BerElement *ber, long num, unsigned long tag )
160 assert( ber != NULL );
161 assert( BER_VALID( ber ) );
166 * high bit is set - look for first non-all-one byte
167 * high bit is clear - look for first non-all-zero byte
169 for ( i = sizeof(long) - 1; i > 0; i-- ) {
170 mask = (0xffUL << (i * 8));
174 if ( (num & mask) != mask )
184 * we now have the "leading byte". if the high bit on this
185 * byte matches the sign bit, we need to "back up" a byte.
187 mask = (num & (0x80UL << (i * 8)));
188 if ( (mask && !sign) || (sign && !mask) )
193 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
196 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 )
199 netnum = AC_HTONL( num );
200 if ( ber_write( ber, (char *) &netnum + (sizeof(long) - i), i, 0 )
204 /* length of tag + length + contents */
205 return( taglen + lenlen + i );
209 ber_put_enum( BerElement *ber, long num, unsigned long tag )
211 assert( ber != NULL );
212 assert( BER_VALID( ber ) );
214 if ( tag == LBER_DEFAULT )
215 tag = LBER_ENUMERATED;
217 return( ber_put_int_or_enum( ber, num, tag ) );
221 ber_put_int( BerElement *ber, long num, unsigned long tag )
223 assert( ber != NULL );
224 assert( BER_VALID( ber ) );
226 if ( tag == LBER_DEFAULT )
229 return( ber_put_int_or_enum( ber, num, tag ) );
235 LDAP_CONST char *str,
239 int taglen, lenlen, rc;
240 #ifdef STR_TRANSLATION
242 #endif /* STR_TRANSLATION */
244 assert( ber != NULL );
245 assert( str != NULL );
247 assert( BER_VALID( ber ) );
249 if ( tag == LBER_DEFAULT )
250 tag = LBER_OCTETSTRING;
252 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
255 #ifdef STR_TRANSLATION
256 if ( len > 0 && ( ber->ber_options & LBER_TRANSLATE_STRINGS ) != 0 &&
257 ber->ber_encode_translate_proc ) {
258 if ( (*(ber->ber_encode_translate_proc))( &str, &len, 0 )
266 #endif /* STR_TRANSLATION */
268 if ( (lenlen = ber_put_len( ber, len, 0 )) == -1 ||
269 (unsigned long) ber_write( ber, str, len, 0 ) != len ) {
272 /* return length of tag + length + contents */
273 rc = taglen + lenlen + len;
276 #ifdef STR_TRANSLATION
280 #endif /* STR_TRANSLATION */
287 LDAP_CONST struct berval *bv,
290 assert( ber != NULL );
291 assert( bv != NULL );
293 assert( BER_VALID( ber ) );
299 return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
305 LDAP_CONST char *str,
308 assert( ber != NULL );
309 assert( str != NULL );
311 assert( BER_VALID( ber ) );
313 return( ber_put_ostring( ber, str, strlen( str ), tag ));
319 LDAP_CONST char *str,
320 unsigned long blen /* in bits */,
323 int taglen, lenlen, len;
324 unsigned char unusedbits;
326 assert( ber != NULL );
327 assert( str != NULL );
329 assert( BER_VALID( ber ) );
331 if ( tag == LBER_DEFAULT )
332 tag = LBER_BITSTRING;
334 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
337 len = ( blen + 7 ) / 8;
338 unusedbits = (unsigned char) ((len * 8) - blen);
339 if ( (lenlen = ber_put_len( ber, len + 1, 0 )) == -1 )
342 if ( ber_write( ber, (char *)&unusedbits, 1, 0 ) != 1 )
345 if ( ber_write( ber, str, len, 0 ) != len )
348 /* return length of tag + length + unused bit count + contents */
349 return( taglen + 1 + lenlen + len );
353 ber_put_null( BerElement *ber, unsigned long tag )
357 assert( ber != NULL );
358 assert( BER_VALID( ber ) );
360 if ( tag == LBER_DEFAULT )
363 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
366 if ( ber_put_len( ber, 0, 0 ) != 1 )
369 return( taglen + 1 );
373 ber_put_boolean( BerElement *ber, int boolval, unsigned long tag )
376 unsigned char trueval = 0xffU;
377 unsigned char falseval = 0x00U;
379 assert( ber != NULL );
380 assert( BER_VALID( ber ) );
382 if ( tag == LBER_DEFAULT )
385 if ( (taglen = ber_put_tag( ber, tag, 0 )) == -1 )
388 if ( ber_put_len( ber, 1, 0 ) != 1 )
391 if ( ber_write( ber, (char *)(boolval ? &trueval : &falseval), 1, 0 )
395 return( taglen + 2 );
398 #define FOUR_BYTE_LEN 5
401 ber_start_seqorset( BerElement *ber, unsigned long tag )
405 assert( ber != NULL );
406 assert( BER_VALID( ber ) );
408 new = (Seqorset *) LBER_CALLOC( 1, sizeof(Seqorset) );
410 if ( new == NULLSEQORSET )
414 if ( ber->ber_sos == NULLSEQORSET )
415 new->sos_first = ber->ber_ptr;
417 new->sos_first = ber->ber_sos->sos_ptr;
419 /* Set aside room for a 4 byte length field */
420 new->sos_ptr = new->sos_first + ber_calc_taglen( tag ) + FOUR_BYTE_LEN;
423 new->sos_next = ber->ber_sos;
430 ber_start_seq( BerElement *ber, unsigned long tag )
432 assert( ber != NULL );
433 assert( BER_VALID( ber ) );
435 if ( tag == LBER_DEFAULT )
438 return( ber_start_seqorset( ber, tag ) );
442 ber_start_set( BerElement *ber, unsigned long tag )
444 assert( ber != NULL );
445 assert( BER_VALID( ber ) );
447 if ( tag == LBER_DEFAULT )
450 return( ber_start_seqorset( ber, tag ) );
454 ber_put_seqorset( BerElement *ber )
456 unsigned long len, netlen;
458 unsigned char ltag = 0x80U + FOUR_BYTE_LEN - 1;
460 Seqorset **sos = &ber->ber_sos;
462 assert( ber != NULL );
463 assert( BER_VALID( ber ) );
466 * If this is the toplevel sequence or set, we need to actually
467 * write the stuff out. Otherwise, it's already been put in
468 * the appropriate buffer and will be written when the toplevel
469 * one is written. In this case all we need to do is update the
473 len = (*sos)->sos_clen;
474 netlen = AC_HTONL( len );
475 if ( sizeof(long) > 4 && len > 0xffffffffUL )
478 if ( ber->ber_options & LBER_USE_DER ) {
479 lenlen = ber_calc_lenlen( len );
481 lenlen = FOUR_BYTE_LEN;
484 if ( (next = (*sos)->sos_next) == NULLSEQORSET ) {
486 if ( (taglen = ber_put_tag( ber, (*sos)->sos_tag, 1 )) == -1 )
489 if ( ber->ber_options & LBER_USE_DER ) {
490 /* Write the length in the minimum # of octets */
491 if ( ber_put_len( ber, len, 1 ) == -1 )
494 if (lenlen != FOUR_BYTE_LEN) {
496 * We set aside FOUR_BYTE_LEN bytes for
497 * the length field. Move the data if
498 * we don't actually need that much
500 SAFEMEMCPY( (*sos)->sos_first + taglen +
501 lenlen, (*sos)->sos_first + taglen +
502 FOUR_BYTE_LEN, len );
505 /* Fill FOUR_BYTE_LEN bytes for length field */
506 /* one byte of length length */
507 if ( ber_write( ber, (char *)<ag, 1, 1 ) != 1 )
510 /* the length itself */
511 if ( ber_write( ber, (char *) &netlen + sizeof(long)
512 - (FOUR_BYTE_LEN - 1), FOUR_BYTE_LEN - 1, 1 )
513 != FOUR_BYTE_LEN - 1 )
516 /* The ber_ptr is at the set/seq start - move it to the end */
517 (*sos)->sos_ber->ber_ptr += len;
522 taglen = ber_calc_taglen( (*sos)->sos_tag );
523 ntag = AC_HTONL( (*sos)->sos_tag );
524 SAFEMEMCPY( (*sos)->sos_first, (char *) &ntag +
525 sizeof(long) - taglen, taglen );
527 if ( ber->ber_options & LBER_USE_DER ) {
529 ? (unsigned char) len
530 : (unsigned char) (0x80UL + (lenlen - 1));
533 /* one byte of length length */
534 SAFEMEMCPY( (*sos)->sos_first + 1, <ag, 1 );
536 if ( ber->ber_options & LBER_USE_DER ) {
538 /* Write the length itself */
539 SAFEMEMCPY( (*sos)->sos_first + 2,
540 (char *)&netlen + sizeof(unsigned long) -
544 if (lenlen != FOUR_BYTE_LEN) {
546 * We set aside FOUR_BYTE_LEN bytes for
547 * the length field. Move the data if
548 * we don't actually need that much
550 SAFEMEMCPY( (*sos)->sos_first + taglen +
551 lenlen, (*sos)->sos_first + taglen +
552 FOUR_BYTE_LEN, len );
555 /* the length itself */
556 SAFEMEMCPY( (*sos)->sos_first + taglen + 1,
557 (char *) &netlen + sizeof(long) -
558 (FOUR_BYTE_LEN - 1), FOUR_BYTE_LEN - 1 );
561 next->sos_clen += (taglen + lenlen + len);
562 next->sos_ptr += (taglen + lenlen + len);
565 /* we're done with this seqorset, so free it up */
566 LBER_FREE( (char *) (*sos) );
569 return( taglen + lenlen + len );
573 ber_put_seq( BerElement *ber )
575 assert( ber != NULL );
576 assert( BER_VALID( ber ) );
578 return( ber_put_seqorset( ber ) );
582 ber_put_set( BerElement *ber )
584 assert( ber != NULL );
585 assert( BER_VALID( ber ) );
587 return( ber_put_seqorset( ber ) );
595 LDAP_CONST char *fmt,
608 struct berval *bv, **bvp;
616 ber = va_arg( ap, BerElement * );
617 fmt = va_arg( ap, char * );
620 assert( ber != NULL );
621 assert( fmt != NULL );
623 assert( BER_VALID( ber ) );
625 for ( rc = 0; *fmt && rc != -1; fmt++ ) {
627 case '!': { /* hook */
628 BEREncodeCallback *f;
631 f = va_arg( ap, BEREncodeCallback * );
632 p = va_arg( ap, void * );
637 case 'b': /* boolean */
638 i = va_arg( ap, int );
639 rc = ber_put_boolean( ber, i, ber->ber_tag );
643 i = va_arg( ap, int );
644 rc = ber_put_int( ber, i, ber->ber_tag );
647 case 'e': /* enumeration */
648 i = va_arg( ap, int );
649 rc = ber_put_enum( ber, i, ber->ber_tag );
653 rc = ber_put_null( ber, ber->ber_tag );
656 case 'o': /* octet string (non-null terminated) */
657 s = va_arg( ap, char * );
658 len = va_arg( ap, int );
659 rc = ber_put_ostring( ber, s, len, ber->ber_tag );
662 case 'O': /* berval octet string */
663 bv = va_arg( ap, struct berval * );
664 if( bv == NULL ) break;
665 rc = ber_put_berval( ber, bv, ber->ber_tag );
668 case 's': /* string */
669 s = va_arg( ap, char * );
670 rc = ber_put_string( ber, s, ber->ber_tag );
673 case 'B': /* bit string */
674 s = va_arg( ap, char * );
675 len = va_arg( ap, int ); /* in bits */
676 rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
679 case 't': /* tag for the next element */
680 ber->ber_tag = va_arg( ap, unsigned long );
681 ber->ber_usertag = 1;
684 case 'v': /* vector of strings */
685 if ( (ss = va_arg( ap, char ** )) == NULL )
687 for ( i = 0; ss[i] != NULL; i++ ) {
688 if ( (rc = ber_put_string( ber, ss[i],
689 ber->ber_tag )) == -1 )
694 case 'V': /* sequences of strings + lengths */
695 if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
697 for ( i = 0; bvp[i] != NULL; i++ ) {
698 if ( (rc = ber_put_ostring( ber, bvp[i]->bv_val,
699 bvp[i]->bv_len, ber->ber_tag )) == -1 )
704 case '{': /* begin sequence */
705 rc = ber_start_seq( ber, ber->ber_tag );
708 case '}': /* end sequence */
709 rc = ber_put_seqorset( ber );
712 case '[': /* begin set */
713 rc = ber_start_set( ber, ber->ber_tag );
716 case ']': /* end set */
717 rc = ber_put_seqorset( ber );
721 if( ber->ber_debug ) {
722 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
723 "ber_printf: unknown fmt %c\n", *fmt );
729 if ( ber->ber_usertag == 0 )
730 ber->ber_tag = LBER_DEFAULT;
732 ber->ber_usertag = 0;