git.sur5r.net Git - openldap/blob - libraries/liblber/encode.c

   1 /* encode.c - ber output encoding routines */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1998-2009 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
  17  * All rights reserved.
  18  *
  19  * Redistribution and use in source and binary forms are permitted
  20  * provided that this notice is preserved and that due credit is given
  21  * to the University of Michigan at Ann Arbor. The name of the University
  22  * may not be used to endorse or promote products derived from this
  23  * software without specific prior written permission. This software
  24  * is provided ``as is'' without express or implied warranty.
  25  */
  26 /* ACKNOWLEDGEMENTS:
  27  * This work was originally developed by the University of Michigan
  28  * (as part of U-MICH LDAP).
  29  */
  30
  31 #include "portable.h"
  32
  33 #include <ctype.h>
  34 #include <limits.h>
  35 #include <stdio.h>
  36
  37 #include <ac/stdlib.h>
  38
  39 #include <ac/stdarg.h>
  40 #include <ac/socket.h>
  41 #include <ac/string.h>
  42
  43 #include "lber-int.h"
  44
  45
  46 #define OCTET_SIZE(type) ((ber_len_t) (sizeof(type)*CHAR_BIT + 7) / 8)
  47 #define TAGBUF_SIZE OCTET_SIZE(ber_tag_t)
  48 #define LENBUF_SIZE (1 + OCTET_SIZE(ber_len_t))
  49 #define HEADER_SIZE (TAGBUF_SIZE + LENBUF_SIZE)
  50
  51 /*
  52  * BER element size constrains:
  53  *
  54  * - We traditionally support a length of max 0xffffffff.  However
  55  *   some functions return an int length so that is their max.
  56  *   MAXINT_BERSIZE is the max for those functions.
  57  *
  58  * - MAXINT_BERSIZE must fit in MAXINT_BERSIZE_OCTETS octets.
  59  *
  60  * - sizeof(ber_elem_size_t) is normally MAXINT_BERSIZE_OCTETS:
  61  *   Big enough for MAXINT_BERSIZE, but not more.  (Larger wastes
  62  *   space in the working encoding and DER encoding of a sequence
  63  *   or set.  Smaller further limits sizes near a sequence/set.)
  64  *
  65  * ber_len_t is mostly unrelated to this.  Which may be for the best,
  66  * since it is also used for lengths of data that are never encoded.
  67  */
  68 #define MAXINT_BERSIZE \
  69         (INT_MAX>0xffffffffUL ? (ber_len_t) 0xffffffffUL : INT_MAX-HEADER_SIZE)
  70 #define MAXINT_BERSIZE_OCTETS 4
  71 typedef ber_uint_t ber_elem_size_t; /* normally 32 bits */
  72
  73
  74 /* Prepend tag to ptr, which points to the end of a tag buffer */
  75 static unsigned char *
  76 ber_prepend_tag( unsigned char *ptr, ber_tag_t tag )
  77 {
  78         do {
  79                 *--ptr = (unsigned char) tag & 0xffU;
  80         } while ( (tag >>= 8) != 0 );
  81
  82         return ptr;
  83 }
  84
  85 /* Prepend ber length to ptr, which points to the end of a length buffer */
  86 static unsigned char *
  87 ber_prepend_len( unsigned char *ptr, ber_len_t len )
  88 {
  89         /*
  90          * short len if it's less than 128 - one byte giving the len,
  91          * with bit 8 0.
  92          * long len otherwise - one byte with bit 8 set, giving the
  93          * length of the length, followed by the length itself.
  94          */
  95
  96         *--ptr = (unsigned char) len & 0xffU;
  97
  98         if ( len >= 0x80 ) {
  99                 unsigned char *endptr = ptr--;
 100
 101                 while ( (len >>= 8) != 0 ) {
 102                         *ptr-- = (unsigned char) len & 0xffU;
 103                 }
 104                 *ptr = (unsigned char) (endptr - ptr) + 0x80U;
 105         }
 106
 107         return ptr;
 108 }
 109
 110 /* out->bv_len should be the buffer size on input */
 111 int
 112 ber_encode_oid( BerValue *in, BerValue *out )
 113 {
 114         unsigned char *der;
 115         unsigned long val1, val;
 116         int i, j, len;
 117         char *ptr, *end, *inend;
 118
 119         assert( in != NULL );
 120         assert( out != NULL );
 121
 122         if ( !out->bv_val || out->bv_len < in->bv_len/2 )
 123                 return -1;
 124
 125         der = (unsigned char *) out->bv_val;
 126         ptr = in->bv_val;
 127         inend = ptr + in->bv_len;
 128
 129         /* OIDs start with <0-1>.<0-39> or 2.<any>, DER-encoded 40*val1+val2 */
 130         if ( !isdigit( (unsigned char) *ptr )) return -1;
 131         val1 = strtoul( ptr, &end, 10 );
 132         if ( end == ptr || val1 > 2 ) return -1;
 133         if ( *end++ != '.' || !isdigit( (unsigned char) *end )) return -1;
 134         val = strtoul( end, &ptr, 10 );
 135         if ( ptr == end ) return -1;
 136         if ( val > (val1 < 2 ? 39 : LBER_OID_COMPONENT_MAX - 80) ) return -1;
 137         val += val1 * 40;
 138
 139         for (;;) {
 140                 if ( ptr > inend ) return -1;
 141
 142                 /* Write the OID component little-endian, then reverse it */
 143                 len = 0;
 144                 do {
 145                         der[len++] = (val & 0xff) | 0x80;
 146                 } while ( (val >>= 7) != 0 );
 147                 der[0] &= 0x7f;
 148                 for ( i = 0, j = len; i < --j; i++ ) {
 149                         unsigned char tmp = der[i];
 150                         der[i] = der[j];
 151                         der[j] = tmp;
 152                 }
 153                 der += len;
 154                 if ( ptr == inend )
 155                         break;
 156
 157                 if ( *ptr++ != '.' ) return -1;
 158                 if ( !isdigit( (unsigned char) *ptr )) return -1;
 159                 val = strtoul( ptr, &end, 10 );
 160                 if ( end == ptr || val > LBER_OID_COMPONENT_MAX ) return -1;
 161                 ptr = end;
 162         }
 163
 164         out->bv_len = (char *)der - out->bv_val;
 165         return 0;
 166 }
 167
 168 static int
 169 ber_put_int_or_enum(
 170         BerElement *ber,
 171         ber_int_t num,
 172         ber_tag_t tag )
 173 {
 174         ber_uint_t unum;
 175         unsigned char sign, data[TAGBUF_SIZE+1 + OCTET_SIZE(ber_int_t)], *ptr;
 176
 177         sign = 0;
 178         unum = num;     /* Bit fiddling should be done with unsigned values */
 179         if ( num < 0 ) {
 180                 sign = 0xffU;
 181                 unum = ~unum;
 182         }
 183         for ( ptr = &data[sizeof(data) - 1] ;; unum >>= 8 ) {
 184                 *ptr-- = (sign ^ (unsigned char) unum) & 0xffU;
 185                 if ( unum < 0x80 )      /* top bit at *ptr is sign bit */
 186                         break;
 187         }
 188
 189         *ptr = (unsigned char) (&data[sizeof(data) - 1] - ptr); /* length */
 190         ptr = ber_prepend_tag( ptr, tag );
 191
 192         return ber_write( ber, (char *) ptr, &data[sizeof(data)] - ptr, 0 );
 193 }
 194
 195 int
 196 ber_put_enum(
 197         BerElement *ber,
 198         ber_int_t num,
 199         ber_tag_t tag )
 200 {
 201         if ( tag == LBER_DEFAULT ) {
 202                 tag = LBER_ENUMERATED;
 203         }
 204
 205         return ber_put_int_or_enum( ber, num, tag );
 206 }
 207
 208 int
 209 ber_put_int(
 210         BerElement *ber,
 211         ber_int_t num,
 212         ber_tag_t tag )
 213 {
 214         if ( tag == LBER_DEFAULT ) {
 215                 tag = LBER_INTEGER;
 216         }
 217
 218         return ber_put_int_or_enum( ber, num, tag );
 219 }
 220
 221 int
 222 ber_put_ostring(
 223         BerElement *ber,
 224         LDAP_CONST char *str,
 225         ber_len_t len,
 226         ber_tag_t tag )
 227 {
 228         int rc;
 229         unsigned char header[HEADER_SIZE], *ptr;
 230
 231         if ( tag == LBER_DEFAULT ) {
 232                 tag = LBER_OCTETSTRING;
 233         }
 234
 235         if ( len > MAXINT_BERSIZE ) {
 236                 return -1;
 237         }
 238
 239         ptr = ber_prepend_len( &header[sizeof(header)], len );
 240         ptr = ber_prepend_tag( ptr, tag );
 241
 242         rc = ber_write( ber, (char *) ptr, &header[sizeof(header)] - ptr, 0 );
 243         if ( rc >= 0 && ber_write( ber, str, len, 0 ) >= 0 ) {
 244                 /* length(tag + length + contents) */
 245                 rc += (int) len;
 246         }
 247
 248         return rc;
 249 }
 250
 251 int
 252 ber_put_berval(
 253         BerElement *ber,
 254         struct berval *bv,
 255         ber_tag_t tag )
 256 {
 257         if( bv == NULL || bv->bv_len == 0 ) {
 258                 return ber_put_ostring( ber, "", (ber_len_t) 0, tag );
 259         }
 260
 261         return ber_put_ostring( ber, bv->bv_val, bv->bv_len, tag );
 262 }
 263
 264 int
 265 ber_put_string(
 266         BerElement *ber,
 267         LDAP_CONST char *str,
 268         ber_tag_t tag )
 269 {
 270         assert( str != NULL );
 271
 272         return ber_put_ostring( ber, str, strlen( str ), tag );
 273 }
 274
 275 int
 276 ber_put_bitstring(
 277         BerElement *ber,
 278         LDAP_CONST char *str,
 279         ber_len_t blen /* in bits */,
 280         ber_tag_t tag )
 281 {
 282         int rc;
 283         ber_len_t               len;
 284         unsigned char   unusedbits, header[HEADER_SIZE + 1], *ptr;
 285
 286         if ( tag == LBER_DEFAULT ) {
 287                 tag = LBER_BITSTRING;
 288         }
 289
 290         unusedbits = (unsigned char) -blen & 7;
 291         len = blen / 8 + (unusedbits != 0); /* (blen+7)/8 without overflow */
 292         if ( len >= MAXINT_BERSIZE ) {
 293                 return -1;
 294         }
 295
 296         header[sizeof(header) - 1] = unusedbits;
 297         ptr = ber_prepend_len( &header[sizeof(header) - 1], len + 1 );
 298         ptr = ber_prepend_tag( ptr, tag );
 299
 300         rc = ber_write( ber, (char *) ptr, &header[sizeof(header)] - ptr, 0 );
 301         if ( rc >= 0 && ber_write( ber, str, len, 0 ) >= 0 ) {
 302                 /* length(tag + length + unused bit count + bitstring) */
 303                 rc += (int) len;
 304         }
 305
 306         return rc;
 307 }
 308
 309 int
 310 ber_put_null( BerElement *ber, ber_tag_t tag )
 311 {
 312         unsigned char data[TAGBUF_SIZE + 1], *ptr;
 313
 314         if ( tag == LBER_DEFAULT ) {
 315                 tag = LBER_NULL;
 316         }
 317
 318         data[sizeof(data) - 1] = 0;                     /* length */
 319         ptr = ber_prepend_tag( &data[sizeof(data) - 1], tag );
 320
 321         return ber_write( ber, (char *) ptr, &data[sizeof(data)] - ptr, 0 );
 322 }
 323
 324 int
 325 ber_put_boolean(
 326         BerElement *ber,
 327         ber_int_t boolval,
 328         ber_tag_t tag )
 329 {
 330         unsigned char data[TAGBUF_SIZE + 2], *ptr;
 331
 332         if ( tag == LBER_DEFAULT )
 333                 tag = LBER_BOOLEAN;
 334
 335         data[sizeof(data) - 1] = boolval ? 0xff : 0;
 336         data[sizeof(data) - 2] = 1;                     /* length */
 337         ptr = ber_prepend_tag( &data[sizeof(data) - 2], tag );
 338
 339         return ber_write( ber, (char *) ptr, &data[sizeof(data)] - ptr, 0 );
 340 }
 341
 342
 343 /* Max number of length octets in a sequence or set, normally 5 */
 344 #define SOS_LENLEN (1 + (sizeof(ber_elem_size_t) > MAXINT_BERSIZE_OCTETS ? \
 345                 (ber_len_t) sizeof(ber_elem_size_t) : MAXINT_BERSIZE_OCTETS))
 346
 347 /* Header of incomplete sequence or set */
 348 typedef struct seqorset_header {
 349         char xtagbuf[TAGBUF_SIZE + 1];  /* room for tag + len(tag or len) */
 350         union {
 351                 ber_elem_size_t offset;         /* enclosing seqence/set */
 352                 char padding[SOS_LENLEN-1];     /* for final length encoding */
 353         } next_sos;
 354 #       define SOS_TAG_END(header) ((unsigned char *) &(header).next_sos - 1)
 355 } Seqorset_header;
 356
 357 /* Start a sequence or set */
 358 static int
 359 ber_start_seqorset(
 360         BerElement *ber,
 361         ber_tag_t tag )
 362 {
 363         /*
 364          * Write the tag and SOS_LENLEN octets reserved for length, to ber.
 365          * For now, length octets = (tag length, previous ber_sos_inner).
 366          *
 367          * Update ber_sos_inner and the write-cursor ber_sos_ptr.  ber_ptr
 368          * will not move until the outermost sequence or set is complete.
 369          */
 370
 371         Seqorset_header header;
 372         unsigned char   *headptr;
 373         ber_len_t               taglen, headlen;
 374         char                    *dest, **p;
 375
 376         assert( ber != NULL );
 377         assert( LBER_VALID( ber ) );
 378
 379         if ( ber->ber_sos_ptr == NULL ) {       /* outermost sequence/set? */
 380                 header.next_sos.offset = 0;
 381                 p = &ber->ber_ptr;
 382         } else {
 383                 if ( (ber_len_t) -1 > (ber_elem_size_t) -1 ) {
 384                         if ( ber->ber_sos_inner > (ber_elem_size_t) -1 )
 385                                 return -1;
 386                 }
 387                 header.next_sos.offset = ber->ber_sos_inner;
 388                 p = &ber->ber_sos_ptr;
 389         }
 390         headptr = ber_prepend_tag( SOS_TAG_END(header), tag );
 391         *SOS_TAG_END(header) = taglen = SOS_TAG_END(header) - headptr;
 392         headlen = taglen + SOS_LENLEN;
 393
 394         /* As ber_write(,headptr,headlen,) except update ber_sos_ptr, not *p */
 395         if ( headlen > (ber_len_t) (ber->ber_end - *p) ) {
 396                 if ( ber_realloc( ber, headlen ) != 0 )
 397                         return -1;
 398         }
 399         dest = *p;
 400         AC_MEMCPY( dest, headptr, headlen );
 401         ber->ber_sos_ptr = dest + headlen;
 402
 403         ber->ber_sos_inner = dest + taglen - ber->ber_buf;
 404
 405         /*
 406          * Do not return taglen + SOS_LENLEN here - then ber_put_seqorset()
 407          * should return lenlen - SOS_LENLEN + len, which can be < 0.
 408          */
 409         return 0;
 410 }
 411
 412 int
 413 ber_start_seq( BerElement *ber, ber_tag_t tag )
 414 {
 415         if ( tag == LBER_DEFAULT ) {
 416                 tag = LBER_SEQUENCE;
 417         }
 418
 419         return ber_start_seqorset( ber, tag );
 420 }
 421
 422 int
 423 ber_start_set( BerElement *ber, ber_tag_t tag )
 424 {
 425         if ( tag == LBER_DEFAULT ) {
 426                 tag = LBER_SET;
 427         }
 428
 429         return ber_start_seqorset( ber, tag );
 430 }
 431
 432 /* End a sequence or set */
 433 static int
 434 ber_put_seqorset( BerElement *ber )
 435 {
 436         Seqorset_header header;
 437         unsigned char   *lenptr;        /* length octets in the sequence/set */
 438         ber_len_t               len;            /* length(contents) */
 439         ber_len_t               xlen;           /* len + length(length) */
 440
 441         assert( ber != NULL );
 442         assert( LBER_VALID( ber ) );
 443
 444         if ( ber->ber_sos_ptr == NULL ) return -1;
 445
 446         lenptr = (unsigned char *) ber->ber_buf + ber->ber_sos_inner;
 447         xlen = ber->ber_sos_ptr - (char *) lenptr;
 448         if ( xlen > MAXINT_BERSIZE + SOS_LENLEN ) {
 449                 return -1;
 450         }
 451
 452         /* Extract sequence/set information from length octets */
 453         memcpy( SOS_TAG_END(header), lenptr, SOS_LENLEN );
 454
 455         /* Store length, and close gap of leftover reserved length octets */
 456         len = xlen - SOS_LENLEN;
 457         if ( ber->ber_options & LBER_USE_DER ) {
 458                 int i;
 459                 lenptr[0] = SOS_LENLEN - 1 + 0x80; /* length(length)-1 */
 460                 for( i = SOS_LENLEN; --i > 0; len >>= 8 ) {
 461                         lenptr[i] = len & 0xffU;
 462                 }
 463         } else {
 464                 unsigned char *p = ber_prepend_len( lenptr + SOS_LENLEN, len );
 465                 ber_len_t unused = p - lenptr;
 466                 if ( unused != 0 ) {
 467                         /* length(length) < the reserved SOS_LENLEN bytes */
 468                         xlen -= unused;
 469                         AC_MEMCPY( lenptr, p, xlen );
 470                         ber->ber_sos_ptr = (char *) lenptr + xlen;
 471                 }
 472         }
 473
 474         ber->ber_sos_inner = header.next_sos.offset;
 475         if ( header.next_sos.offset == 0 ) { /* outermost sequence/set? */
 476                 /* The ber_ptr is at the set/seq start - move it to the end */
 477                 ber->ber_ptr = ber->ber_sos_ptr;
 478                 ber->ber_sos_ptr = NULL;
 479         }
 480
 481         return xlen + *SOS_TAG_END(header); /* lenlen + len + taglen */
 482 }
 483
 484 int
 485 ber_put_seq( BerElement *ber )
 486 {
 487         return ber_put_seqorset( ber );
 488 }
 489
 490 int
 491 ber_put_set( BerElement *ber )
 492 {
 493         return ber_put_seqorset( ber );
 494 }
 495
 496 /* N tag */
 497 static ber_tag_t lber_int_null = 0;
 498
 499 /* VARARGS */
 500 int
 501 ber_printf( BerElement *ber, LDAP_CONST char *fmt, ... )
 502 {
 503         va_list         ap;
 504         char            *s, **ss;
 505         struct berval   *bv, **bvp;
 506         int             rc;
 507         ber_int_t       i;
 508         ber_len_t       len;
 509
 510         assert( ber != NULL );
 511         assert( fmt != NULL );
 512         assert( LBER_VALID( ber ) );
 513
 514         va_start( ap, fmt );
 515
 516         for ( rc = 0; *fmt && rc != -1; fmt++ ) {
 517                 switch ( *fmt ) {
 518                 case '!': { /* hook */
 519                                 BEREncodeCallback *f;
 520                                 void *p;
 521
 522                                 ber->ber_usertag = 0;
 523
 524                                 f = va_arg( ap, BEREncodeCallback * );
 525                                 p = va_arg( ap, void * );
 526                                 rc = (*f)( ber, p );
 527
 528                                 if ( ber->ber_usertag ) {
 529                                         ber->ber_usertag = 0;
 530                                         goto next;
 531                                 }
 532                         } break;
 533
 534                 case 'b':       /* boolean */
 535                         i = va_arg( ap, ber_int_t );
 536                         rc = ber_put_boolean( ber, i, ber->ber_tag );
 537                         break;
 538
 539                 case 'i':       /* int */
 540                         i = va_arg( ap, ber_int_t );
 541                         rc = ber_put_int( ber, i, ber->ber_tag );
 542                         break;
 543
 544                 case 'e':       /* enumeration */
 545                         i = va_arg( ap, ber_int_t );
 546                         rc = ber_put_enum( ber, i, ber->ber_tag );
 547                         break;
 548
 549                 case 'n':       /* null */
 550                         rc = ber_put_null( ber, ber->ber_tag );
 551                         break;
 552
 553                 case 'N':       /* Debug NULL */
 554                         rc = 0;
 555                         if( lber_int_null != 0 ) {
 556                                 /* Insert NULL to ensure peer ignores unknown tags */
 557                                 rc = ber_put_null( ber, lber_int_null );
 558                         }
 559                         break;
 560
 561                 case 'o':       /* octet string (non-null terminated) */
 562                         s = va_arg( ap, char * );
 563                         len = va_arg( ap, ber_len_t );
 564                         rc = ber_put_ostring( ber, s, len, ber->ber_tag );
 565                         break;
 566
 567                 case 'O':       /* berval octet string */
 568                         bv = va_arg( ap, struct berval * );
 569                         if( bv == NULL ) break;
 570                         rc = ber_put_berval( ber, bv, ber->ber_tag );
 571                         break;
 572
 573                 case 's':       /* string */
 574                         s = va_arg( ap, char * );
 575                         rc = ber_put_string( ber, s, ber->ber_tag );
 576                         break;
 577
 578                 case 'B':       /* bit string */
 579                 case 'X':       /* bit string (deprecated) */
 580                         s = va_arg( ap, char * );
 581                         len = va_arg( ap, ber_len_t );  /* in bits */
 582                         rc = ber_put_bitstring( ber, s, len, ber->ber_tag );
 583                         break;
 584
 585                 case 't':       /* tag for the next element */
 586                         ber->ber_tag = va_arg( ap, ber_tag_t );
 587                         ber->ber_usertag = 1;
 588                         goto next;
 589
 590                 case 'v':       /* vector of strings */
 591                         if ( (ss = va_arg( ap, char ** )) == NULL )
 592                                 break;
 593                         for ( i = 0; ss[i] != NULL; i++ ) {
 594                                 if ( (rc = ber_put_string( ber, ss[i],
 595                                     ber->ber_tag )) == -1 )
 596                                         break;
 597                         }
 598                         break;
 599
 600                 case 'V':       /* sequences of strings + lengths */
 601                         if ( (bvp = va_arg( ap, struct berval ** )) == NULL )
 602                                 break;
 603                         for ( i = 0; bvp[i] != NULL; i++ ) {
 604                                 if ( (rc = ber_put_berval( ber, bvp[i],
 605                                     ber->ber_tag )) == -1 )
 606                                         break;
 607                         }
 608                         break;
 609
 610                 case 'W':       /* BerVarray */
 611                         if ( (bv = va_arg( ap, BerVarray )) == NULL )
 612                                 break;
 613                         for ( i = 0; bv[i].bv_val != NULL; i++ ) {
 614                                 if ( (rc = ber_put_berval( ber, &bv[i],
 615                                     ber->ber_tag )) == -1 )
 616                                         break;
 617                         }
 618                         break;
 619
 620                 case '{':       /* begin sequence */
 621                         rc = ber_start_seq( ber, ber->ber_tag );
 622                         break;
 623
 624                 case '}':       /* end sequence */
 625                         rc = ber_put_seqorset( ber );
 626                         break;
 627
 628                 case '[':       /* begin set */
 629                         rc = ber_start_set( ber, ber->ber_tag );
 630                         break;
 631
 632                 case ']':       /* end set */
 633                         rc = ber_put_seqorset( ber );
 634                         break;
 635
 636                 default:
 637                         if( ber->ber_debug ) {
 638                                 ber_log_printf( LDAP_DEBUG_ANY, ber->ber_debug,
 639                                         "ber_printf: unknown fmt %c\n", *fmt );
 640                         }
 641                         rc = -1;
 642                         break;
 643                 }
 644
 645                 ber->ber_tag = LBER_DEFAULT;
 646         next:;
 647         }
 648
 649         va_end( ap );
 650
 651         return rc;
 652 }