source3/lib/charcnv.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Character set conversion Extensions
   4    Copyright (C) Igor Vergeichik <iverg@mail.ru> 2001
   5    Copyright (C) Andrew Tridgell 2001
   6    Copyright (C) Simo Sorce 2001
   7    Copyright (C) Martin Pool 2003
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 */
  23 #include "includes.h"
  24
  25 /* We can parameterize this if someone complains.... JRA. */
  26
  27 char lp_failed_convert_char(void)
  28 {
  29         return '_';
  30 }
  31
  32 /**
  33  * @file
  34  *
  35  * @brief Character-set conversion routines built on our iconv.
  36  *
  37  * @note Samba's internal character set (at least in the 3.0 series)
  38  * is always the same as the one for the Unix filesystem.  It is
  39  * <b>not</b> necessarily UTF-8 and may be different on machines that
  40  * need i18n filenames to be compatible with Unix software.  It does
  41  * have to be a superset of ASCII.  All multibyte sequences must start
  42  * with a byte with the high bit set.
  43  *
  44  * @sa lib/iconv.c
  45  */
  46
  47
  48 static smb_iconv_t conv_handles[NUM_CHARSETS][NUM_CHARSETS];
  49 static BOOL conv_silent; /* Should we do a debug if the conversion fails ? */
  50
  51 /**
  52  * Return the name of a charset to give to iconv().
  53  **/
  54 static const char *charset_name(charset_t ch)
  55 {
  56         const char *ret = NULL;
  57
  58         if (ch == CH_UTF16LE) ret = "UTF-16LE";
  59         else if (ch == CH_UTF16BE) ret = "UTF-16BE";
  60         else if (ch == CH_UNIX) ret = lp_unix_charset();
  61         else if (ch == CH_DOS) ret = lp_dos_charset();
  62         else if (ch == CH_DISPLAY) ret = lp_display_charset();
  63         else if (ch == CH_UTF8) ret = "UTF8";
  64
  65 #if defined(HAVE_NL_LANGINFO) && defined(CODESET)
  66         if (ret && !strcmp(ret, "LOCALE")) {
  67                 const char *ln = NULL;
  68
  69 #ifdef HAVE_SETLOCALE
  70                 setlocale(LC_ALL, "");
  71 #endif
  72                 ln = nl_langinfo(CODESET);
  73                 if (ln) {
  74                         /* Check whether the charset name is supported
  75                            by iconv */
  76                         smb_iconv_t handle = smb_iconv_open(ln,"UCS-2LE");
  77                         if (handle == (smb_iconv_t) -1) {
  78                                 DEBUG(5,("Locale charset '%s' unsupported, using ASCII instead\n", ln));
  79                                 ln = NULL;
  80                         } else {
  81                                 DEBUG(5,("Substituting charset '%s' for LOCALE\n", ln));
  82                                 smb_iconv_close(handle);
  83                         }
  84                 }
  85                 ret = ln;
  86         }
  87 #endif
  88
  89         if (!ret || !*ret) ret = "ASCII";
  90         return ret;
  91 }
  92
  93 void lazy_initialize_conv(void)
  94 {
  95         static int initialized = False;
  96
  97         if (!initialized) {
  98                 initialized = True;
  99                 load_case_tables();
 100                 init_iconv();
 101         }
 102 }
 103
 104 /**
 105  * Destroy global objects allocated by init_iconv()
 106  **/
 107 void gfree_charcnv(void)
 108 {
 109         int c1, c2;
 110
 111         for (c1=0;c1<NUM_CHARSETS;c1++) {
 112                 for (c2=0;c2<NUM_CHARSETS;c2++) {
 113                         if ( conv_handles[c1][c2] ) {
 114                                 smb_iconv_close( conv_handles[c1][c2] );
 115                                 conv_handles[c1][c2] = 0;
 116                         }
 117                 }
 118         }
 119 }
 120
 121 /**
 122  * Initialize iconv conversion descriptors.
 123  *
 124  * This is called the first time it is needed, and also called again
 125  * every time the configuration is reloaded, because the charset or
 126  * codepage might have changed.
 127  **/
 128 void init_iconv(void)
 129 {
 130         int c1, c2;
 131         BOOL did_reload = False;
 132
 133         /* so that charset_name() works we need to get the UNIX<->UCS2 going
 134            first */
 135         if (!conv_handles[CH_UNIX][CH_UTF16LE])
 136                 conv_handles[CH_UNIX][CH_UTF16LE] = smb_iconv_open(charset_name(CH_UTF16LE), "ASCII");
 137
 138         if (!conv_handles[CH_UTF16LE][CH_UNIX])
 139                 conv_handles[CH_UTF16LE][CH_UNIX] = smb_iconv_open("ASCII", charset_name(CH_UTF16LE));
 140
 141         for (c1=0;c1<NUM_CHARSETS;c1++) {
 142                 for (c2=0;c2<NUM_CHARSETS;c2++) {
 143                         const char *n1 = charset_name((charset_t)c1);
 144                         const char *n2 = charset_name((charset_t)c2);
 145                         if (conv_handles[c1][c2] &&
 146                             strcmp(n1, conv_handles[c1][c2]->from_name) == 0 &&
 147                             strcmp(n2, conv_handles[c1][c2]->to_name) == 0)
 148                                 continue;
 149
 150                         did_reload = True;
 151
 152                         if (conv_handles[c1][c2])
 153                                 smb_iconv_close(conv_handles[c1][c2]);
 154
 155                         conv_handles[c1][c2] = smb_iconv_open(n2,n1);
 156                         if (conv_handles[c1][c2] == (smb_iconv_t)-1) {
 157                                 DEBUG(0,("init_iconv: Conversion from %s to %s not supported\n",
 158                                          charset_name((charset_t)c1), charset_name((charset_t)c2)));
 159                                 if (c1 != CH_UTF16LE && c1 != CH_UTF16BE) {
 160                                         n1 = "ASCII";
 161                                 }
 162                                 if (c2 != CH_UTF16LE && c2 != CH_UTF16BE) {
 163                                         n2 = "ASCII";
 164                                 }
 165                                 DEBUG(0,("init_iconv: Attempting to replace with conversion from %s to %s\n",
 166                                         n1, n2 ));
 167                                 conv_handles[c1][c2] = smb_iconv_open(n2,n1);
 168                                 if (!conv_handles[c1][c2]) {
 169                                         DEBUG(0,("init_iconv: Conversion from %s to %s failed", n1, n2));
 170                                         smb_panic("init_iconv: conv_handle initialization failed");
 171                                 }
 172                         }
 173                 }
 174         }
 175
 176         if (did_reload) {
 177                 /* XXX: Does this really get called every time the dos
 178                  * codepage changes? */
 179                 /* XXX: Is the did_reload test too strict? */
 180                 conv_silent = True;
 181                 init_doschar_table();
 182                 init_valid_table();
 183                 conv_silent = False;
 184         }
 185 }
 186
 187 /**
 188  * Convert string from one encoding to another, making error checking etc
 189  * Slow path version - uses (slow) iconv.
 190  *
 191  * @param src pointer to source string (multibyte or singlebyte)
 192  * @param srclen length of the source string in bytes
 193  * @param dest pointer to destination string (multibyte or singlebyte)
 194  * @param destlen maximal length allowed for string
 195  * @param allow_bad_conv determines if a "best effort" conversion is acceptable (never returns errors)
 196  * @returns the number of bytes occupied in the destination
 197  *
 198  * Ensure the srclen contains the terminating zero.
 199  *
 200  **/
 201
 202 static size_t convert_string_internal(charset_t from, charset_t to,
 203                       void const *src, size_t srclen,
 204                       void *dest, size_t destlen, BOOL allow_bad_conv)
 205 {
 206         size_t i_len, o_len;
 207         size_t retval;
 208         const char* inbuf = (const char*)src;
 209         char* outbuf = (char*)dest;
 210         smb_iconv_t descriptor;
 211
 212         lazy_initialize_conv();
 213
 214         descriptor = conv_handles[from][to];
 215
 216         if (srclen == (size_t)-1) {
 217                 if (from == CH_UTF16LE || from == CH_UTF16BE) {
 218                         srclen = (strlen_w((const smb_ucs2_t *)src)+1) * 2;
 219                 } else {
 220                         srclen = strlen((const char *)src)+1;
 221                 }
 222         }
 223
 224
 225         if (descriptor == (smb_iconv_t)-1 || descriptor == (smb_iconv_t)0) {
 226                 if (!conv_silent)
 227                         DEBUG(0,("convert_string_internal: Conversion not supported.\n"));
 228                 return (size_t)-1;
 229         }
 230
 231         i_len=srclen;
 232         o_len=destlen;
 233
 234  again:
 235
 236         retval = smb_iconv(descriptor, &inbuf, &i_len, &outbuf, &o_len);
 237         if(retval==(size_t)-1) {
 238                 const char *reason="unknown error";
 239                 switch(errno) {
 240                         case EINVAL:
 241                                 reason="Incomplete multibyte sequence";
 242                                 if (!conv_silent)
 243                                         DEBUG(3,("convert_string_internal: Conversion error: %s(%s)\n",reason,inbuf));
 244                                 if (allow_bad_conv)
 245                                         goto use_as_is;
 246                                 break;
 247                         case E2BIG:
 248                                 reason="No more room";
 249                                 if (!conv_silent) {
 250                                         if (from == CH_UNIX) {
 251                                                 DEBUG(3,("E2BIG: convert_string(%s,%s): srclen=%u destlen=%u - '%s'\n",
 252                                                         charset_name(from), charset_name(to),
 253                                                         (unsigned int)srclen, (unsigned int)destlen, (const char *)src));
 254                                         } else {
 255                                                 DEBUG(3,("E2BIG: convert_string(%s,%s): srclen=%u destlen=%u\n",
 256                                                         charset_name(from), charset_name(to),
 257                                                         (unsigned int)srclen, (unsigned int)destlen));
 258                                         }
 259                                 }
 260                                 break;
 261                         case EILSEQ:
 262                                 reason="Illegal multibyte sequence";
 263                                 if (!conv_silent)
 264                                         DEBUG(3,("convert_string_internal: Conversion error: %s(%s)\n",reason,inbuf));
 265                                 if (allow_bad_conv)
 266                                         goto use_as_is;
 267                                 break;
 268                         default:
 269                                 if (!conv_silent)
 270                                         DEBUG(0,("convert_string_internal: Conversion error: %s(%s)\n",reason,inbuf));
 271                                 break;
 272                 }
 273                 /* smb_panic(reason); */
 274         }
 275         return destlen-o_len;
 276
 277  use_as_is:
 278
 279         /*
 280          * Conversion not supported. This is actually an error, but there are so
 281          * many misconfigured iconv systems and smb.conf's out there we can't just
 282          * fail. Do a very bad conversion instead.... JRA.
 283          */
 284
 285         {
 286                 if (o_len == 0 || i_len == 0)
 287                         return destlen - o_len;
 288
 289                 if (((from == CH_UTF16LE)||(from == CH_UTF16BE)) &&
 290                                 ((to != CH_UTF16LE)||(to != CH_UTF16BE))) {
 291                         /* Can't convert from utf16 any endian to multibyte.
 292                            Replace with the default fail char.
 293                         */
 294                         if (i_len < 2)
 295                                 return destlen - o_len;
 296                         if (i_len >= 2) {
 297                                 *outbuf = lp_failed_convert_char();
 298
 299                                 outbuf++;
 300                                 o_len--;
 301
 302                                 inbuf += 2;
 303                                 i_len -= 2;
 304                         }
 305
 306                         if (o_len == 0 || i_len == 0)
 307                                 return destlen - o_len;
 308
 309                         /* Keep trying with the next char... */
 310                         goto again;
 311
 312                 } else if (from != CH_UTF16LE && from != CH_UTF16BE && to == CH_UTF16LE) {
 313                         /* Can't convert to UTF16LE - just widen by adding the
 314                            default fail char then zero.
 315                         */
 316                         if (o_len < 2)
 317                                 return destlen - o_len;
 318
 319                         outbuf[0] = lp_failed_convert_char();
 320                         outbuf[1] = '\0';
 321
 322                         inbuf++;
 323                         i_len--;
 324
 325                         outbuf += 2;
 326                         o_len -= 2;
 327
 328                         if (o_len == 0 || i_len == 0)
 329                                 return destlen - o_len;
 330
 331                         /* Keep trying with the next char... */
 332                         goto again;
 333
 334                 } else if (from != CH_UTF16LE && from != CH_UTF16BE &&
 335                                 to != CH_UTF16LE && to != CH_UTF16BE) {
 336                         /* Failed multibyte to multibyte. Just copy the default fail char and
 337                                 try again. */
 338                         outbuf[0] = lp_failed_convert_char();
 339
 340                         inbuf++;
 341                         i_len--;
 342
 343                         outbuf++;
 344                         o_len--;
 345
 346                         if (o_len == 0 || i_len == 0)
 347                                 return destlen - o_len;
 348
 349                         /* Keep trying with the next char... */
 350                         goto again;
 351
 352                 } else {
 353                         /* Keep compiler happy.... */
 354                         return destlen - o_len;
 355                 }
 356         }
 357 }
 358
 359 /**
 360  * Convert string from one encoding to another, making error checking etc
 361  * Fast path version - handles ASCII first.
 362  *
 363  * @param src pointer to source string (multibyte or singlebyte)
 364  * @param srclen length of the source string in bytes, or -1 for nul terminated.
 365  * @param dest pointer to destination string (multibyte or singlebyte)
 366  * @param destlen maximal length allowed for string - *NEVER* -1.
 367  * @param allow_bad_conv determines if a "best effort" conversion is acceptable (never returns errors)
 368  * @returns the number of bytes occupied in the destination
 369  *
 370  * Ensure the srclen contains the terminating zero.
 371  *
 372  * This function has been hand-tuned to provide a fast path.
 373  * Don't change unless you really know what you are doing. JRA.
 374  **/
 375
 376 size_t convert_string(charset_t from, charset_t to,
 377                       void const *src, size_t srclen,
 378                       void *dest, size_t destlen, BOOL allow_bad_conv)
 379 {
 380         /*
 381          * NB. We deliberately don't do a strlen here if srclen == -1.
 382          * This is very expensive over millions of calls and is taken
 383          * care of in the slow path in convert_string_internal. JRA.
 384          */
 385
 386 #ifdef DEVELOPER
 387         SMB_ASSERT(destlen != (size_t)-1);
 388 #endif
 389
 390         if (srclen == 0)
 391                 return 0;
 392
 393         if (from != CH_UTF16LE && from != CH_UTF16BE && to != CH_UTF16LE && to != CH_UTF16BE) {
 394                 const unsigned char *p = (const unsigned char *)src;
 395                 unsigned char *q = (unsigned char *)dest;
 396                 size_t slen = srclen;
 397                 size_t dlen = destlen;
 398                 unsigned char lastp = '\0';
 399                 size_t retval = 0;
 400
 401                 /* If all characters are ascii, fast path here. */
 402                 while (slen && dlen) {
 403                         if ((lastp = *p) <= 0x7f) {
 404                                 *q++ = *p++;
 405                                 if (slen != (size_t)-1) {
 406                                         slen--;
 407                                 }
 408                                 dlen--;
 409                                 retval++;
 410                                 if (!lastp)
 411                                         break;
 412                         } else {
 413 #ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
 414                                 goto general_case;
 415 #else
 416                                 return retval + convert_string_internal(from, to, p, slen, q, dlen, allow_bad_conv);
 417 #endif
 418                         }
 419                 }
 420                 if (!dlen) {
 421                         /* Even if we fast path we should note if we ran out of room. */
 422                         if (((slen != (size_t)-1) && slen) ||
 423                                         ((slen == (size_t)-1) && lastp)) {
 424                                 errno = E2BIG;
 425                         }
 426                 }
 427                 return retval;
 428         } else if (from == CH_UTF16LE && to != CH_UTF16LE) {
 429                 const unsigned char *p = (const unsigned char *)src;
 430                 unsigned char *q = (unsigned char *)dest;
 431                 size_t retval = 0;
 432                 size_t slen = srclen;
 433                 size_t dlen = destlen;
 434                 unsigned char lastp = '\0';
 435
 436                 /* If all characters are ascii, fast path here. */
 437                 while (((slen == (size_t)-1) || (slen >= 2)) && dlen) {
 438                         if (((lastp = *p) <= 0x7f) && (p[1] == 0)) {
 439                                 *q++ = *p;
 440                                 if (slen != (size_t)-1) {
 441                                         slen -= 2;
 442                                 }
 443                                 p += 2;
 444                                 dlen--;
 445                                 retval++;
 446                                 if (!lastp)
 447                                         break;
 448                         } else {
 449 #ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
 450                                 goto general_case;
 451 #else
 452                                 return retval + convert_string_internal(from, to, p, slen, q, dlen, allow_bad_conv);
 453 #endif
 454                         }
 455                 }
 456                 if (!dlen) {
 457                         /* Even if we fast path we should note if we ran out of room. */
 458                         if (((slen != (size_t)-1) && slen) ||
 459                                         ((slen == (size_t)-1) && lastp)) {
 460                                 errno = E2BIG;
 461                         }
 462                 }
 463                 return retval;
 464         } else if (from != CH_UTF16LE && from != CH_UTF16BE && to == CH_UTF16LE) {
 465                 const unsigned char *p = (const unsigned char *)src;
 466                 unsigned char *q = (unsigned char *)dest;
 467                 size_t retval = 0;
 468                 size_t slen = srclen;
 469                 size_t dlen = destlen;
 470                 unsigned char lastp = '\0';
 471
 472                 /* If all characters are ascii, fast path here. */
 473                 while (slen && (dlen >= 2)) {
 474                         if ((lastp = *p) <= 0x7F) {
 475                                 *q++ = *p++;
 476                                 *q++ = '\0';
 477                                 if (slen != (size_t)-1) {
 478                                         slen--;
 479                                 }
 480                                 dlen -= 2;
 481                                 retval += 2;
 482                                 if (!lastp)
 483                                         break;
 484                         } else {
 485 #ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
 486                                 goto general_case;
 487 #else
 488                                 return retval + convert_string_internal(from, to, p, slen, q, dlen, allow_bad_conv);
 489 #endif
 490                         }
 491                 }
 492                 if (!dlen) {
 493                         /* Even if we fast path we should note if we ran out of room. */
 494                         if (((slen != (size_t)-1) && slen) ||
 495                                         ((slen == (size_t)-1) && lastp)) {
 496                                 errno = E2BIG;
 497                         }
 498                 }
 499                 return retval;
 500         }
 501
 502 #ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
 503   general_case:
 504 #endif
 505         return convert_string_internal(from, to, src, srclen, dest, destlen, allow_bad_conv);
 506 }
 507
 508 /**
 509  * Convert between character sets, allocating a new buffer for the result.
 510  *
 511  * @param ctx TALLOC_CTX to use to allocate with. If NULL use malloc.
 512  * (this is a bad interface and needs fixing. JRA).
 513  * @param srclen length of source buffer.
 514  * @param dest always set at least to NULL
 515  * @note -1 is not accepted for srclen.
 516  *
 517  * @returns Size in bytes of the converted string; or -1 in case of error.
 518  *
 519  * Ensure the srclen contains the terminating zero.
 520  *
 521  * I hate the goto's in this function. It's embarressing.....
 522  * There has to be a cleaner way to do this. JRA.
 523  **/
 524
 525 size_t convert_string_allocate(TALLOC_CTX *ctx, charset_t from, charset_t to,
 526                                void const *src, size_t srclen, void *dst, BOOL allow_bad_conv)
 527 {
 528         size_t i_len, o_len, destlen = MAX(srclen, 512);
 529         size_t retval;
 530         const char *inbuf = (const char *)src;
 531         char *outbuf = NULL, *ob = NULL;
 532         smb_iconv_t descriptor;
 533         void **dest = (void **)dst;
 534
 535         *dest = NULL;
 536
 537         if (src == NULL || srclen == (size_t)-1)
 538                 return (size_t)-1;
 539         if (srclen == 0)
 540                 return 0;
 541
 542         lazy_initialize_conv();
 543
 544         descriptor = conv_handles[from][to];
 545
 546         if (descriptor == (smb_iconv_t)-1 || descriptor == (smb_iconv_t)0) {
 547                 if (!conv_silent)
 548                         DEBUG(0,("convert_string_allocate: Conversion not supported.\n"));
 549                 return (size_t)-1;
 550         }
 551
 552   convert:
 553
 554         if ((destlen*2) < destlen) {
 555                 /* wrapped ! abort. */
 556                 if (!conv_silent)
 557                         DEBUG(0, ("convert_string_allocate: destlen wrapped !\n"));
 558                 if (!ctx)
 559                         SAFE_FREE(outbuf);
 560                 return (size_t)-1;
 561         } else {
 562                 destlen = destlen * 2;
 563         }
 564
 565         if (ctx) {
 566                 ob = (char *)TALLOC_REALLOC(ctx, ob, destlen);
 567         } else {
 568                 ob = (char *)SMB_REALLOC(ob, destlen);
 569         }
 570
 571         if (!ob) {
 572                 DEBUG(0, ("convert_string_allocate: realloc failed!\n"));
 573                 return (size_t)-1;
 574         }
 575         outbuf = ob;
 576         i_len = srclen;
 577         o_len = destlen;
 578
 579  again:
 580
 581         retval = smb_iconv(descriptor,
 582                            &inbuf, &i_len,
 583                            &outbuf, &o_len);
 584         if(retval == (size_t)-1)                {
 585                 const char *reason="unknown error";
 586                 switch(errno) {
 587                         case EINVAL:
 588                                 reason="Incomplete multibyte sequence";
 589                                 if (!conv_silent)
 590                                         DEBUG(3,("convert_string_allocate: Conversion error: %s(%s)\n",reason,inbuf));
 591                                 if (allow_bad_conv)
 592                                         goto use_as_is;
 593                                 break;
 594                         case E2BIG:
 595                                 goto convert;
 596                         case EILSEQ:
 597                                 reason="Illegal multibyte sequence";
 598                                 if (!conv_silent)
 599                                         DEBUG(3,("convert_string_allocate: Conversion error: %s(%s)\n",reason,inbuf));
 600                                 if (allow_bad_conv)
 601                                         goto use_as_is;
 602                                 break;
 603                 }
 604                 if (!conv_silent)
 605                         DEBUG(0,("Conversion error: %s(%s)\n",reason,inbuf));
 606                 /* smb_panic(reason); */
 607                 if (ctx) {
 608                         TALLOC_FREE(ob);
 609                 } else {
 610                         SAFE_FREE(ob);
 611                 }
 612                 return (size_t)-1;
 613         }
 614
 615   out:
 616
 617         destlen = destlen - o_len;
 618         if (ctx) {
 619                 ob = (char *)TALLOC_REALLOC(ctx,ob,destlen);
 620         } else {
 621                 ob = (char *)SMB_REALLOC(ob,destlen);
 622         }
 623
 624         if (destlen && !ob) {
 625                 DEBUG(0, ("convert_string_allocate: out of memory!\n"));
 626                 return (size_t)-1;
 627         }
 628
 629         *dest = ob;
 630         return destlen;
 631
 632  use_as_is:
 633
 634         /*
 635          * Conversion not supported. This is actually an error, but there are so
 636          * many misconfigured iconv systems and smb.conf's out there we can't just
 637          * fail. Do a very bad conversion instead.... JRA.
 638          */
 639
 640         {
 641                 if (o_len == 0 || i_len == 0)
 642                         goto out;
 643
 644                 if (((from == CH_UTF16LE)||(from == CH_UTF16BE)) &&
 645                                 ((to != CH_UTF16LE)||(to != CH_UTF16BE))) {
 646                         /* Can't convert from utf16 any endian to multibyte.
 647                            Replace with the default fail char.
 648                         */
 649
 650                         if (i_len < 2)
 651                                 goto out;
 652
 653                         if (i_len >= 2) {
 654                                 *outbuf = lp_failed_convert_char();
 655
 656                                 outbuf++;
 657                                 o_len--;
 658
 659                                 inbuf += 2;
 660                                 i_len -= 2;
 661                         }
 662
 663                         if (o_len == 0 || i_len == 0)
 664                                 goto out;
 665
 666                         /* Keep trying with the next char... */
 667                         goto again;
 668
 669                 } else if (from != CH_UTF16LE && from != CH_UTF16BE && to == CH_UTF16LE) {
 670                         /* Can't convert to UTF16LE - just widen by adding the
 671                            default fail char then zero.
 672                         */
 673                         if (o_len < 2)
 674                                 goto out;
 675
 676                         outbuf[0] = lp_failed_convert_char();
 677                         outbuf[1] = '\0';
 678
 679                         inbuf++;
 680                         i_len--;
 681
 682                         outbuf += 2;
 683                         o_len -= 2;
 684
 685                         if (o_len == 0 || i_len == 0)
 686                                 goto out;
 687
 688                         /* Keep trying with the next char... */
 689                         goto again;
 690
 691                 } else if (from != CH_UTF16LE && from != CH_UTF16BE &&
 692                                 to != CH_UTF16LE && to != CH_UTF16BE) {
 693                         /* Failed multibyte to multibyte. Just copy the default fail char and
 694                            try again. */
 695                         outbuf[0] = lp_failed_convert_char();
 696
 697                         inbuf++;
 698                         i_len--;
 699
 700                         outbuf++;
 701                         o_len--;
 702
 703                         if (o_len == 0 || i_len == 0)
 704                                 goto out;
 705
 706                         /* Keep trying with the next char... */
 707                         goto again;
 708
 709                 } else {
 710                         /* Keep compiler happy.... */
 711                         goto out;
 712                 }
 713         }
 714 }
 715
 716 /**
 717  * Convert between character sets, allocating a new buffer using talloc for the result.
 718  *
 719  * @param srclen length of source buffer.
 720  * @param dest always set at least to NULL
 721  * @note -1 is not accepted for srclen.
 722  *
 723  * @returns Size in bytes of the converted string; or -1 in case of error.
 724  **/
 725 size_t convert_string_talloc(TALLOC_CTX *ctx, charset_t from, charset_t to,
 726                              void const *src, size_t srclen, void *dst,
 727                              BOOL allow_bad_conv)
 728 {
 729         void **dest = (void **)dst;
 730         size_t dest_len;
 731
 732         *dest = NULL;
 733         dest_len=convert_string_allocate(ctx, from, to, src, srclen, dest, allow_bad_conv);
 734         if (dest_len == (size_t)-1)
 735                 return (size_t)-1;
 736         if (*dest == NULL)
 737                 return (size_t)-1;
 738         return dest_len;
 739 }
 740
 741 size_t unix_strupper(const char *src, size_t srclen, char *dest, size_t destlen)
 742 {
 743         size_t size;
 744         smb_ucs2_t *buffer;
 745
 746         size = push_ucs2_allocate(&buffer, src);
 747         if (size == (size_t)-1) {
 748                 smb_panic("failed to create UCS2 buffer");
 749         }
 750         if (!strupper_w(buffer) && (dest == src)) {
 751                 free(buffer);
 752                 return srclen;
 753         }
 754
 755         size = convert_string(CH_UTF16LE, CH_UNIX, buffer, size, dest, destlen, True);
 756         free(buffer);
 757         return size;
 758 }
 759
 760 /**
 761  strdup() a unix string to upper case.
 762 **/
 763
 764 char *strdup_upper(const char *s)
 765 {
 766         char *out_buffer = SMB_STRDUP(s);
 767         const unsigned char *p = (const unsigned char *)s;
 768         unsigned char *q = (unsigned char *)out_buffer;
 769
 770         if (!q) {
 771                 return NULL;
 772         }
 773
 774         /* this is quite a common operation, so we want it to be
 775            fast. We optimise for the ascii case, knowing that all our
 776            supported multi-byte character sets are ascii-compatible
 777            (ie. they match for the first 128 chars) */
 778
 779         while (*p) {
 780                 if (*p & 0x80)
 781                         break;
 782                 *q++ = toupper_ascii(*p);
 783                 p++;
 784         }
 785
 786         if (*p) {
 787                 /* MB case. */
 788                 size_t size;
 789                 smb_ucs2_t *buffer = NULL;
 790
 791                 SAFE_FREE(out_buffer);
 792                 size = convert_string_allocate(NULL,
 793                                         CH_UNIX,
 794                                         CH_UTF16LE,
 795                                         s,
 796                                         strlen(s) + 1,
 797                                         (void **)(void *)&buffer,
 798                                         True);
 799                 if (size == (size_t)-1) {
 800                         return NULL;
 801                 }
 802
 803                 strupper_w(buffer);
 804
 805                 size = convert_string_allocate(NULL,
 806                                         CH_UTF16LE,
 807                                         CH_UNIX,
 808                                         buffer,
 809                                         size,
 810                                         (void **)(void *)&out_buffer,
 811                                         True);
 812
 813                 /* Don't need the intermediate buffer
 814                  * anymore.
 815                  */
 816
 817                 TALLOC_FREE(buffer);
 818                 if (size == (size_t)-1) {
 819                         return NULL;
 820                 }
 821         }
 822
 823         return out_buffer;
 824 }
 825
 826 /**
 827  talloc_strdup() a unix string to upper case.
 828 **/
 829
 830 char *talloc_strdup_upper(TALLOC_CTX *ctx, const char *s)
 831 {
 832         char *out_buffer = talloc_strdup(ctx,s);
 833         const unsigned char *p = (const unsigned char *)s;
 834         unsigned char *q = (unsigned char *)out_buffer;
 835
 836         if (!q) {
 837                 return NULL;
 838         }
 839
 840         /* this is quite a common operation, so we want it to be
 841            fast. We optimise for the ascii case, knowing that all our
 842            supported multi-byte character sets are ascii-compatible
 843            (ie. they match for the first 128 chars) */
 844
 845         while (*p) {
 846                 if (*p & 0x80)
 847                         break;
 848                 *q++ = toupper_ascii(*p);
 849                 p++;
 850         }
 851
 852         if (*p) {
 853                 /* MB case. */
 854                 size_t size;
 855                 smb_ucs2_t *ubuf = NULL;
 856
 857                 /* We're not using the ascii buffer above. */
 858                 TALLOC_FREE(out_buffer);
 859
 860                 size = convert_string_talloc(ctx, CH_UNIX, CH_UTF16LE,
 861                                 s, strlen(s)+1,
 862                                 (void *)&ubuf,
 863                                 True);
 864                 if (size == (size_t)-1) {
 865                         return NULL;
 866                 }
 867
 868                 strupper_w(ubuf);
 869
 870                 size = convert_string_talloc(ctx, CH_UTF16LE, CH_UNIX,
 871                                 ubuf, size,
 872                                 (void *)&out_buffer,
 873                                 True);
 874
 875                 /* Don't need the intermediate buffer
 876                  * anymore.
 877                  */
 878
 879                 TALLOC_FREE(ubuf);
 880
 881                 if (size == (size_t)-1) {
 882                         return NULL;
 883                 }
 884         }
 885
 886         return out_buffer;
 887 }
 888
 889 size_t unix_strlower(const char *src, size_t srclen, char *dest, size_t destlen)
 890 {
 891         size_t size;
 892         smb_ucs2_t *buffer = NULL;
 893
 894         size = convert_string_allocate(NULL, CH_UNIX, CH_UTF16LE, src, srclen,
 895                                        (void **)(void *)&buffer, True);
 896         if (size == (size_t)-1 || !buffer) {
 897                 smb_panic("failed to create UCS2 buffer");
 898         }
 899         if (!strlower_w(buffer) && (dest == src)) {
 900                 SAFE_FREE(buffer);
 901                 return srclen;
 902         }
 903         size = convert_string(CH_UTF16LE, CH_UNIX, buffer, size, dest, destlen, True);
 904         SAFE_FREE(buffer);
 905         return size;
 906 }
 907
 908 /**
 909  strdup() a unix string to lower case.
 910 **/
 911
 912 char *strdup_lower(const char *s)
 913 {
 914         size_t size;
 915         smb_ucs2_t *buffer = NULL;
 916         char *out_buffer;
 917
 918         size = push_ucs2_allocate(&buffer, s);
 919         if (size == -1 || !buffer) {
 920                 return NULL;
 921         }
 922
 923         strlower_w(buffer);
 924
 925         size = pull_ucs2_allocate(&out_buffer, buffer);
 926         SAFE_FREE(buffer);
 927
 928         if (size == (size_t)-1) {
 929                 return NULL;
 930         }
 931
 932         return out_buffer;
 933 }
 934
 935 static size_t ucs2_align(const void *base_ptr, const void *p, int flags)
 936 {
 937         if (flags & (STR_NOALIGN|STR_ASCII))
 938                 return 0;
 939         return PTR_DIFF(p, base_ptr) & 1;
 940 }
 941
 942
 943 /**
 944  * Copy a string from a char* unix src to a dos codepage string destination.
 945  *
 946  * @return the number of bytes occupied by the string in the destination.
 947  *
 948  * @param flags can include
 949  * <dl>
 950  * <dt>STR_TERMINATE</dt> <dd>means include the null termination</dd>
 951  * <dt>STR_UPPER</dt> <dd>means uppercase in the destination</dd>
 952  * </dl>
 953  *
 954  * @param dest_len the maximum length in bytes allowed in the
 955  * destination.
 956  **/
 957 size_t push_ascii(void *dest, const char *src, size_t dest_len, int flags)
 958 {
 959         size_t src_len = strlen(src);
 960         char *tmpbuf = NULL;
 961         size_t ret;
 962
 963         /* No longer allow a length of -1. */
 964         if (dest_len == (size_t)-1) {
 965                 smb_panic("push_ascii - dest_len == -1");
 966                 return (size_t)0;
 967         }
 968
 969         if (flags & STR_UPPER) {
 970                 tmpbuf = SMB_STRDUP(src);
 971                 if (!tmpbuf) {
 972                         smb_panic("malloc fail");
 973                         return (size_t)0;
 974                 }
 975                 strupper_m(tmpbuf);
 976                 src = tmpbuf;
 977         }
 978
 979         if (flags & (STR_TERMINATE | STR_TERMINATE_ASCII)) {
 980                 src_len++;
 981         }
 982
 983         ret = convert_string(CH_UNIX, CH_DOS, src, src_len, dest, dest_len, True);
 984         SAFE_FREE(tmpbuf);
 985         if (ret == (size_t)-1) {
 986                 return 0;
 987         }
 988         return ret;
 989 }
 990
 991 size_t push_ascii_fstring(void *dest, const char *src)
 992 {
 993         return push_ascii(dest, src, sizeof(fstring), STR_TERMINATE);
 994 }
 995
 996 size_t push_ascii_pstring(void *dest, const char *src)
 997 {
 998         return push_ascii(dest, src, sizeof(pstring), STR_TERMINATE);
 999 }
1000
1001 /********************************************************************
1002  Push an nstring - ensure null terminated. Written by
1003  moriyama@miraclelinux.com (MORIYAMA Masayuki).
1004 ********************************************************************/
1005
1006 size_t push_ascii_nstring(void *dest, const char *src)
1007 {
1008         size_t i, buffer_len, dest_len;
1009         smb_ucs2_t *buffer;
1010
1011         conv_silent = True;
1012         buffer_len = push_ucs2_allocate(&buffer, src);
1013         if (buffer_len == (size_t)-1) {
1014                 smb_panic("failed to create UCS2 buffer");
1015         }
1016
1017         /* We're using buffer_len below to count ucs2 characters, not bytes. */
1018         buffer_len /= sizeof(smb_ucs2_t);
1019
1020         dest_len = 0;
1021         for (i = 0; buffer[i] != 0 && (i < buffer_len); i++) {
1022                 unsigned char mb[10];
1023                 /* Convert one smb_ucs2_t character at a time. */
1024                 size_t mb_len = convert_string(CH_UTF16LE, CH_DOS, buffer+i, sizeof(smb_ucs2_t), mb, sizeof(mb), False);
1025                 if ((mb_len != (size_t)-1) && (dest_len + mb_len <= MAX_NETBIOSNAME_LEN - 1)) {
1026                         memcpy((char *)dest + dest_len, mb, mb_len);
1027                         dest_len += mb_len;
1028                 } else {
1029                         errno = E2BIG;
1030                         break;
1031                 }
1032         }
1033         ((char *)dest)[dest_len] = '\0';
1034
1035         SAFE_FREE(buffer);
1036         conv_silent = False;
1037         return dest_len;
1038 }
1039
1040 /********************************************************************
1041  Push and malloc an ascii string. src and dest null terminated.
1042 ********************************************************************/
1043
1044 size_t push_ascii_allocate(char **dest, const char *src)
1045 {
1046         size_t src_len = strlen(src)+1;
1047
1048         *dest = NULL;
1049         return convert_string_allocate(NULL, CH_UNIX, CH_DOS, src, src_len, (void **)dest, True);
1050 }
1051
1052 /**
1053  * Copy a string from a dos codepage source to a unix char* destination.
1054  *
1055  * The resulting string in "dest" is always null terminated.
1056  *
1057  * @param flags can have:
1058  * <dl>
1059  * <dt>STR_TERMINATE</dt>
1060  * <dd>STR_TERMINATE means the string in @p src
1061  * is null terminated, and src_len is ignored.</dd>
1062  * </dl>
1063  *
1064  * @param src_len is the length of the source area in bytes.
1065  * @returns the number of bytes occupied by the string in @p src.
1066  **/
1067 size_t pull_ascii(char *dest, const void *src, size_t dest_len, size_t src_len, int flags)
1068 {
1069         size_t ret;
1070
1071         if (dest_len == (size_t)-1)
1072                 dest_len = sizeof(pstring);
1073
1074         if (flags & STR_TERMINATE) {
1075                 if (src_len == (size_t)-1) {
1076                         src_len = strlen((const char *)src) + 1;
1077                 } else {
1078                         size_t len = strnlen((const char *)src, src_len);
1079                         if (len < src_len)
1080                                 len++;
1081                         src_len = len;
1082                 }
1083         }
1084
1085         ret = convert_string(CH_DOS, CH_UNIX, src, src_len, dest, dest_len, True);
1086         if (ret == (size_t)-1) {
1087                 ret = 0;
1088                 dest_len = 0;
1089         }
1090
1091         if (dest_len && ret) {
1092                 /* Did we already process the terminating zero ? */
1093                 if (dest[MIN(ret-1, dest_len-1)] != 0) {
1094                         dest[MIN(ret, dest_len-1)] = 0;
1095                 }
1096         } else  {
1097                 dest[0] = 0;
1098         }
1099
1100         return src_len;
1101 }
1102
1103 /**
1104  * Copy a string from a dos codepage source to a unix char* destination.
1105  Talloc version.
1106  Uses malloc if TALLOC_CTX is NULL (this is a bad interface and
1107  needs fixing. JRA).
1108  *
1109  * The resulting string in "dest" is always null terminated.
1110  *
1111  * @param flags can have:
1112  * <dl>
1113  * <dt>STR_TERMINATE</dt>
1114  * <dd>STR_TERMINATE means the string in @p src
1115  * is null terminated, and src_len is ignored.</dd>
1116  * </dl>
1117  *
1118  * @param src_len is the length of the source area in bytes.
1119  * @returns the number of bytes occupied by the string in @p src.
1120  **/
1121
1122 static size_t pull_ascii_base_talloc(TALLOC_CTX *ctx,
1123                                         char **ppdest,
1124                                         const void *src,
1125                                         size_t src_len,
1126                                         int flags)
1127 {
1128         char *dest = NULL;
1129         size_t dest_len = 0;
1130
1131 #ifdef DEVELOPER
1132         /* Ensure we never use the braindead "malloc" varient. */
1133         if (ctx == NULL) {
1134                 smb_panic("NULL talloc CTX in pull_ascii_base_talloc\n");
1135         }
1136 #endif
1137
1138         *ppdest = NULL;
1139
1140         if (flags & STR_TERMINATE) {
1141                 if (src_len == (size_t)-1) {
1142                         src_len = strlen((const char *)src) + 1;
1143                 } else {
1144                         size_t len = strnlen((const char *)src, src_len);
1145                         if (len < src_len)
1146                                 len++;
1147                         src_len = len;
1148                 }
1149                 /* Ensure we don't use an insane length from the client. */
1150                 if (src_len >= 1024*1024) {
1151                         char *msg = talloc_asprintf(ctx,
1152                                         "Bad src length (%u) in "
1153                                         "pull_ascii_base_talloc",
1154                                         (unsigned int)src_len);
1155                         smb_panic(msg);
1156                 }
1157         }
1158
1159         dest_len = convert_string_allocate(ctx,
1160                                 CH_DOS,
1161                                 CH_UNIX,
1162                                 src,
1163                                 src_len,
1164                                 &dest,
1165                                 True);
1166
1167         if (dest_len == (size_t)-1) {
1168                 return 0;
1169         }
1170
1171         if (dest_len && dest) {
1172                 /* Did we already process the terminating zero ? */
1173                 if (dest[dest_len-1] != 0) {
1174                         dest[dest_len-1] = 0;
1175                 }
1176         } else if (dest) {
1177                 dest[0] = 0;
1178         }
1179
1180         *ppdest = dest;
1181         return src_len;
1182 }
1183
1184
1185 size_t pull_ascii_pstring(char *dest, const void *src)
1186 {
1187         return pull_ascii(dest, src, sizeof(pstring), -1, STR_TERMINATE);
1188 }
1189
1190 size_t pull_ascii_fstring(char *dest, const void *src)
1191 {
1192         return pull_ascii(dest, src, sizeof(fstring), -1, STR_TERMINATE);
1193 }
1194
1195 /* When pulling an nstring it can expand into a larger size (dos cp -> utf8). Cope with this. */
1196
1197 size_t pull_ascii_nstring(char *dest, size_t dest_len, const void *src)
1198 {
1199         return pull_ascii(dest, src, dest_len, sizeof(nstring)-1, STR_TERMINATE);
1200 }
1201
1202 /**
1203  * Copy a string from a char* src to a unicode destination.
1204  *
1205  * @returns the number of bytes occupied by the string in the destination.
1206  *
1207  * @param flags can have:
1208  *
1209  * <dl>
1210  * <dt>STR_TERMINATE <dd>means include the null termination.
1211  * <dt>STR_UPPER     <dd>means uppercase in the destination.
1212  * <dt>STR_NOALIGN   <dd>means don't do alignment.
1213  * </dl>
1214  *
1215  * @param dest_len is the maximum length allowed in the
1216  * destination. If dest_len is -1 then no maxiumum is used.
1217  **/
1218
1219 size_t push_ucs2(const void *base_ptr, void *dest, const char *src, size_t dest_len, int flags)
1220 {
1221         size_t len=0;
1222         size_t src_len;
1223         size_t ret;
1224
1225         /* treat a pstring as "unlimited" length */
1226         if (dest_len == (size_t)-1)
1227                 dest_len = sizeof(pstring);
1228
1229         if (flags & STR_TERMINATE)
1230                 src_len = (size_t)-1;
1231         else
1232                 src_len = strlen(src);
1233
1234         if (ucs2_align(base_ptr, dest, flags)) {
1235                 *(char *)dest = 0;
1236                 dest = (void *)((char *)dest + 1);
1237                 if (dest_len)
1238                         dest_len--;
1239                 len++;
1240         }
1241
1242         /* ucs2 is always a multiple of 2 bytes */
1243         dest_len &= ~1;
1244
1245         ret =  convert_string(CH_UNIX, CH_UTF16LE, src, src_len, dest, dest_len, True);
1246         if (ret == (size_t)-1) {
1247                 return 0;
1248         }
1249
1250         len += ret;
1251
1252         if (flags & STR_UPPER) {
1253                 smb_ucs2_t *dest_ucs2 = (smb_ucs2_t *)dest;
1254                 size_t i;
1255
1256                 /* We check for i < (ret / 2) below as the dest string isn't null
1257                    terminated if STR_TERMINATE isn't set. */
1258
1259                 for (i = 0; i < (ret / 2) && i < (dest_len / 2) && dest_ucs2[i]; i++) {
1260                         smb_ucs2_t v = toupper_w(dest_ucs2[i]);
1261                         if (v != dest_ucs2[i]) {
1262                                 dest_ucs2[i] = v;
1263                         }
1264                 }
1265         }
1266
1267         return len;
1268 }
1269
1270
1271 /**
1272  * Copy a string from a unix char* src to a UCS2 destination,
1273  * allocating a buffer using talloc().
1274  *
1275  * @param dest always set at least to NULL
1276  *
1277  * @returns The number of bytes occupied by the string in the destination
1278  *         or -1 in case of error.
1279  **/
1280 size_t push_ucs2_talloc(TALLOC_CTX *ctx, smb_ucs2_t **dest, const char *src)
1281 {
1282         size_t src_len = strlen(src)+1;
1283
1284         *dest = NULL;
1285         return convert_string_talloc(ctx, CH_UNIX, CH_UTF16LE, src, src_len, (void **)dest, True);
1286 }
1287
1288
1289 /**
1290  * Copy a string from a unix char* src to a UCS2 destination, allocating a buffer
1291  *
1292  * @param dest always set at least to NULL
1293  *
1294  * @returns The number of bytes occupied by the string in the destination
1295  *         or -1 in case of error.
1296  **/
1297
1298 size_t push_ucs2_allocate(smb_ucs2_t **dest, const char *src)
1299 {
1300         size_t src_len = strlen(src)+1;
1301
1302         *dest = NULL;
1303         return convert_string_allocate(NULL, CH_UNIX, CH_UTF16LE, src, src_len, (void **)dest, True);
1304 }
1305
1306 /**
1307  Copy a string from a char* src to a UTF-8 destination.
1308  Return the number of bytes occupied by the string in the destination
1309  Flags can have:
1310   STR_TERMINATE means include the null termination
1311   STR_UPPER     means uppercase in the destination
1312  dest_len is the maximum length allowed in the destination. If dest_len
1313  is -1 then no maxiumum is used.
1314 **/
1315
1316 static size_t push_utf8(void *dest, const char *src, size_t dest_len, int flags)
1317 {
1318         size_t src_len = strlen(src);
1319         pstring tmpbuf;
1320
1321         /* treat a pstring as "unlimited" length */
1322         if (dest_len == (size_t)-1)
1323                 dest_len = sizeof(pstring);
1324
1325         if (flags & STR_UPPER) {
1326                 pstrcpy(tmpbuf, src);
1327                 strupper_m(tmpbuf);
1328                 src = tmpbuf;
1329         }
1330
1331         if (flags & STR_TERMINATE)
1332                 src_len++;
1333
1334         return convert_string(CH_UNIX, CH_UTF8, src, src_len, dest, dest_len, True);
1335 }
1336
1337 size_t push_utf8_fstring(void *dest, const char *src)
1338 {
1339         return push_utf8(dest, src, sizeof(fstring), STR_TERMINATE);
1340 }
1341
1342 /**
1343  * Copy a string from a unix char* src to a UTF-8 destination, allocating a buffer using talloc
1344  *
1345  * @param dest always set at least to NULL
1346  *
1347  * @returns The number of bytes occupied by the string in the destination
1348  **/
1349
1350 size_t push_utf8_talloc(TALLOC_CTX *ctx, char **dest, const char *src)
1351 {
1352         size_t src_len = strlen(src)+1;
1353
1354         *dest = NULL;
1355         return convert_string_talloc(ctx, CH_UNIX, CH_UTF8, src, src_len, (void**)dest, True);
1356 }
1357
1358 /**
1359  * Copy a string from a unix char* src to a UTF-8 destination, allocating a buffer
1360  *
1361  * @param dest always set at least to NULL
1362  *
1363  * @returns The number of bytes occupied by the string in the destination
1364  **/
1365
1366 size_t push_utf8_allocate(char **dest, const char *src)
1367 {
1368         size_t src_len = strlen(src)+1;
1369
1370         *dest = NULL;
1371         return convert_string_allocate(NULL, CH_UNIX, CH_UTF8, src, src_len, (void **)dest, True);
1372 }
1373
1374 /**
1375  Copy a string from a ucs2 source to a unix char* destination.
1376  Flags can have:
1377   STR_TERMINATE means the string in src is null terminated.
1378   STR_NOALIGN   means don't try to align.
1379  if STR_TERMINATE is set then src_len is ignored if it is -1.
1380  src_len is the length of the source area in bytes
1381  Return the number of bytes occupied by the string in src.
1382  The resulting string in "dest" is always null terminated.
1383 **/
1384
1385 size_t pull_ucs2(const void *base_ptr, char *dest, const void *src, size_t dest_len, size_t src_len, int flags)
1386 {
1387         size_t ret;
1388
1389         if (!src_len) {
1390                 return 0;
1391         }
1392
1393         if (dest_len == (size_t)-1)
1394                 dest_len = sizeof(pstring);
1395
1396         if (ucs2_align(base_ptr, src, flags)) {
1397                 src = (const void *)((const char *)src + 1);
1398                 if (src_len != (size_t)-1)
1399                         src_len--;
1400         }
1401
1402         if (flags & STR_TERMINATE) {
1403                 /* src_len -1 is the default for null terminated strings. */
1404                 if (src_len != (size_t)-1) {
1405                         size_t len = strnlen_w((const smb_ucs2_t *)src,
1406                                                 src_len/2);
1407                         if (len < src_len/2)
1408                                 len++;
1409                         src_len = len*2;
1410                 }
1411         }
1412
1413         /* ucs2 is always a multiple of 2 bytes */
1414         if (src_len != (size_t)-1)
1415                 src_len &= ~1;
1416
1417         ret = convert_string(CH_UTF16LE, CH_UNIX, src, src_len, dest, dest_len, True);
1418         if (ret == (size_t)-1) {
1419                 return 0;
1420         }
1421
1422         if (src_len == (size_t)-1)
1423                 src_len = ret*2;
1424
1425         if (dest_len && ret) {
1426                 /* Did we already process the terminating zero ? */
1427                 if (dest[MIN(ret-1, dest_len-1)] != 0) {
1428                         dest[MIN(ret, dest_len-1)] = 0;
1429                 }
1430         } else {
1431                 dest[0] = 0;
1432         }
1433
1434         return src_len;
1435 }
1436
1437 /**
1438  Copy a string from a ucs2 source to a unix char* destination.
1439  Talloc version with a base pointer.
1440  Uses malloc if TALLOC_CTX is NULL (this is a bad interface and
1441  needs fixing. JRA).
1442  Flags can have:
1443   STR_TERMINATE means the string in src is null terminated.
1444   STR_NOALIGN   means don't try to align.
1445  if STR_TERMINATE is set then src_len is ignored if it is -1.
1446  src_len is the length of the source area in bytes
1447  Return the number of bytes occupied by the string in src.
1448  The resulting string in "dest" is always null terminated.
1449 **/
1450
1451 static size_t pull_ucs2_base_talloc(TALLOC_CTX *ctx,
1452                         const void *base_ptr,
1453                         char **ppdest,
1454                         const void *src,
1455                         size_t src_len,
1456                         int flags)
1457 {
1458         char *dest;
1459         size_t dest_len;
1460
1461         *ppdest = NULL;
1462
1463 #ifdef DEVELOPER
1464         /* Ensure we never use the braindead "malloc" varient. */
1465         if (ctx == NULL) {
1466                 smb_panic("NULL talloc CTX in pull_ucs2_base_talloc\n");
1467         }
1468 #endif
1469
1470         if (!src_len) {
1471                 return 0;
1472         }
1473
1474         if (ucs2_align(base_ptr, src, flags)) {
1475                 src = (const void *)((const char *)src + 1);
1476                 if (src_len != (size_t)-1)
1477                         src_len--;
1478         }
1479
1480         if (flags & STR_TERMINATE) {
1481                 /* src_len -1 is the default for null terminated strings. */
1482                 if (src_len != (size_t)-1) {
1483                         size_t len = strnlen_w((const smb_ucs2_t *)src,
1484                                                 src_len/2);
1485                         if (len < src_len/2)
1486                                 len++;
1487                         src_len = len*2;
1488                 }
1489                 /* Ensure we don't use an insane length from the client. */
1490                 if (src_len >= 1024*1024) {
1491                         smb_panic("Bad src length in pull_ucs2_base_talloc\n");
1492                 }
1493         }
1494
1495         /* ucs2 is always a multiple of 2 bytes */
1496         if (src_len != (size_t)-1) {
1497                 src_len &= ~1;
1498         }
1499
1500         dest_len = convert_string_talloc(ctx,
1501                                         CH_UTF16LE,
1502                                         CH_UNIX,
1503                                         src,
1504                                         src_len,
1505                                         (void *)&dest,
1506                                         True);
1507         if (dest_len == (size_t)-1) {
1508                 return 0;
1509         }
1510
1511         if (src_len == (size_t)-1)
1512                 src_len = dest_len*2;
1513
1514         if (dest_len) {
1515                 /* Did we already process the terminating zero ? */
1516                 if (dest[dest_len-1] != 0) {
1517                         size_t size = talloc_get_size(dest);
1518                         /* Have we got space to append the '\0' ? */
1519                         if (size <= dest_len) {
1520                                 /* No, realloc. */
1521                                 dest = TALLOC_REALLOC_ARRAY(ctx, dest, char,
1522                                                 dest_len+1);
1523                                 if (!dest) {
1524                                         /* talloc fail. */
1525                                         dest_len = (size_t)-1;
1526                                         return 0;
1527                                 }
1528                         }
1529                         /* Yay - space ! */
1530                         dest[dest_len] = '\0';
1531                         dest_len++;
1532                 }
1533         } else if (dest) {
1534                 dest[0] = 0;
1535         }
1536
1537         *ppdest = dest;
1538         return src_len;
1539 }
1540
1541 size_t pull_ucs2_pstring(char *dest, const void *src)
1542 {
1543         return pull_ucs2(NULL, dest, src, sizeof(pstring), -1, STR_TERMINATE);
1544 }
1545
1546 size_t pull_ucs2_fstring(char *dest, const void *src)
1547 {
1548         return pull_ucs2(NULL, dest, src, sizeof(fstring), -1, STR_TERMINATE);
1549 }
1550
1551 /**
1552  * Copy a string from a UCS2 src to a unix char * destination, allocating a buffer using talloc
1553  *
1554  * @param dest always set at least to NULL
1555  *
1556  * @returns The number of bytes occupied by the string in the destination
1557  **/
1558
1559 size_t pull_ucs2_talloc(TALLOC_CTX *ctx, char **dest, const smb_ucs2_t *src)
1560 {
1561         size_t src_len = (strlen_w(src)+1) * sizeof(smb_ucs2_t);
1562         *dest = NULL;
1563         return convert_string_talloc(ctx, CH_UTF16LE, CH_UNIX, src, src_len, (void **)dest, True);
1564 }
1565
1566 /**
1567  * Copy a string from a UCS2 src to a unix char * destination, allocating a buffer
1568  *
1569  * @param dest always set at least to NULL
1570  *
1571  * @returns The number of bytes occupied by the string in the destination
1572  **/
1573
1574 size_t pull_ucs2_allocate(char **dest, const smb_ucs2_t *src)
1575 {
1576         size_t src_len = (strlen_w(src)+1) * sizeof(smb_ucs2_t);
1577         *dest = NULL;
1578         return convert_string_allocate(NULL, CH_UTF16LE, CH_UNIX, src, src_len, (void **)dest, True);
1579 }
1580
1581 /**
1582  * Copy a string from a UTF-8 src to a unix char * destination, allocating a buffer using talloc
1583  *
1584  * @param dest always set at least to NULL
1585  *
1586  * @returns The number of bytes occupied by the string in the destination
1587  **/
1588
1589 size_t pull_utf8_talloc(TALLOC_CTX *ctx, char **dest, const char *src)
1590 {
1591         size_t src_len = strlen(src)+1;
1592         *dest = NULL;
1593         return convert_string_talloc(ctx, CH_UTF8, CH_UNIX, src, src_len, (void **)dest, True);
1594 }
1595
1596 /**
1597  * Copy a string from a UTF-8 src to a unix char * destination, allocating a buffer
1598  *
1599  * @param dest always set at least to NULL
1600  *
1601  * @returns The number of bytes occupied by the string in the destination
1602  **/
1603
1604 size_t pull_utf8_allocate(char **dest, const char *src)
1605 {
1606         size_t src_len = strlen(src)+1;
1607         *dest = NULL;
1608         return convert_string_allocate(NULL, CH_UTF8, CH_UNIX, src, src_len, (void **)dest, True);
1609 }
1610
1611 /**
1612  * Copy a string from a DOS src to a unix char * destination, allocating a buffer using talloc
1613  *
1614  * @param dest always set at least to NULL
1615  *
1616  * @returns The number of bytes occupied by the string in the destination
1617  **/
1618
1619 size_t pull_ascii_talloc(TALLOC_CTX *ctx, char **dest, const char *src)
1620 {
1621         size_t src_len = strlen(src)+1;
1622         *dest = NULL;
1623         return convert_string_talloc(ctx, CH_DOS, CH_UNIX, src, src_len, (void **)dest, True);
1624 }
1625
1626 /**
1627  Copy a string from a char* src to a unicode or ascii
1628  dos codepage destination choosing unicode or ascii based on the
1629  flags in the SMB buffer starting at base_ptr.
1630  Return the number of bytes occupied by the string in the destination.
1631  flags can have:
1632   STR_TERMINATE means include the null termination.
1633   STR_UPPER     means uppercase in the destination.
1634   STR_ASCII     use ascii even with unicode packet.
1635   STR_NOALIGN   means don't do alignment.
1636  dest_len is the maximum length allowed in the destination. If dest_len
1637  is -1 then no maxiumum is used.
1638 **/
1639
1640 size_t push_string_fn(const char *function, unsigned int line,
1641                       const void *base_ptr, uint16 flags2,
1642                       void *dest, const char *src,
1643                       size_t dest_len, int flags)
1644 {
1645 #ifdef DEVELOPER
1646         /* We really need to zero fill here, not clobber
1647          * region, as we want to ensure that valgrind thinks
1648          * all of the outgoing buffer has been written to
1649          * so a send() or write() won't trap an error.
1650          * JRA.
1651          */
1652 #if 0
1653         if (dest_len != (size_t)-1)
1654                 clobber_region(function, line, dest, dest_len);
1655 #else
1656         if (dest_len != (size_t)-1)
1657                 memset(dest, '\0', dest_len);
1658 #endif
1659 #endif
1660
1661         if (!(flags & STR_ASCII) && \
1662             ((flags & STR_UNICODE || \
1663               (flags2 & FLAGS2_UNICODE_STRINGS)))) {
1664                 return push_ucs2(base_ptr, dest, src, dest_len, flags);
1665         }
1666         return push_ascii(dest, src, dest_len, flags);
1667 }
1668
1669
1670 /**
1671  Copy a string from a unicode or ascii source (depending on
1672  the packet flags) to a char* destination.
1673  Flags can have:
1674   STR_TERMINATE means the string in src is null terminated.
1675   STR_UNICODE   means to force as unicode.
1676   STR_ASCII     use ascii even with unicode packet.
1677   STR_NOALIGN   means don't do alignment.
1678  if STR_TERMINATE is set then src_len is ignored is it is -1
1679  src_len is the length of the source area in bytes.
1680  Return the number of bytes occupied by the string in src.
1681  The resulting string in "dest" is always null terminated.
1682 **/
1683
1684 size_t pull_string_fn(const char *function, unsigned int line,
1685                       const void *base_ptr, uint16 smb_flags2, char *dest,
1686                       const void *src, size_t dest_len, size_t src_len,
1687                       int flags)
1688 {
1689 #ifdef DEVELOPER
1690         if (dest_len != (size_t)-1)
1691                 clobber_region(function, line, dest, dest_len);
1692 #endif
1693
1694         if ((base_ptr == NULL) && ((flags & (STR_ASCII|STR_UNICODE)) == 0)) {
1695                 smb_panic("No base ptr to get flg2 and neither ASCII nor "
1696                           "UNICODE defined");
1697         }
1698
1699         if (!(flags & STR_ASCII) && \
1700             ((flags & STR_UNICODE || \
1701               (smb_flags2 & FLAGS2_UNICODE_STRINGS)))) {
1702                 return pull_ucs2(base_ptr, dest, src, dest_len, src_len, flags);
1703         }
1704         return pull_ascii(dest, src, dest_len, src_len, flags);
1705 }
1706
1707 /**
1708  Copy a string from a unicode or ascii source (depending on
1709  the packet flags) to a char* destination.
1710  Variant that uses talloc.
1711  Flags can have:
1712   STR_TERMINATE means the string in src is null terminated.
1713   STR_UNICODE   means to force as unicode.
1714   STR_ASCII     use ascii even with unicode packet.
1715   STR_NOALIGN   means don't do alignment.
1716  if STR_TERMINATE is set then src_len is ignored is it is -1
1717  src_len is the length of the source area in bytes.
1718  Return the number of bytes occupied by the string in src.
1719  The resulting string in "dest" is always null terminated.
1720 **/
1721
1722 size_t pull_string_talloc_fn(const char *function,
1723                         unsigned int line,
1724                         TALLOC_CTX *ctx,
1725                         const void *base_ptr,
1726                         uint16 smb_flags2,
1727                         char **ppdest,
1728                         const void *src,
1729                         size_t src_len,
1730                         int flags)
1731 {
1732         if ((base_ptr == NULL) && ((flags & (STR_ASCII|STR_UNICODE)) == 0)) {
1733                 smb_panic("No base ptr to get flg2 and neither ASCII nor "
1734                           "UNICODE defined");
1735         }
1736
1737         if (!(flags & STR_ASCII) && \
1738             ((flags & STR_UNICODE || \
1739               (smb_flags2 & FLAGS2_UNICODE_STRINGS)))) {
1740                 return pull_ucs2_base_talloc(ctx,
1741                                         base_ptr,
1742                                         ppdest,
1743                                         src,
1744                                         src_len,
1745                                         flags);
1746         }
1747         return pull_ascii_base_talloc(ctx,
1748                                         ppdest,
1749                                         src,
1750                                         src_len,
1751                                         flags);
1752 }
1753
1754
1755 size_t align_string(const void *base_ptr, const char *p, int flags)
1756 {
1757         if (!(flags & STR_ASCII) && \
1758             ((flags & STR_UNICODE || \
1759               (SVAL(base_ptr, smb_flg2) & FLAGS2_UNICODE_STRINGS)))) {
1760                 return ucs2_align(base_ptr, p, flags);
1761         }
1762         return 0;
1763 }
1764
1765 /*
1766   Return the unicode codepoint for the next multi-byte CH_UNIX character
1767   in the string. The unicode codepoint (codepoint_t) is an unsinged 32 bit value.
1768
1769   Also return the number of bytes consumed (which tells the caller
1770   how many bytes to skip to get to the next CH_UNIX character).
1771
1772   Return INVALID_CODEPOINT if the next character cannot be converted.
1773 */
1774
1775 codepoint_t next_codepoint(const char *str, size_t *size)
1776 {
1777         /* It cannot occupy more than 4 bytes in UTF16 format */
1778         uint8_t buf[4];
1779         smb_iconv_t descriptor;
1780         size_t ilen_orig;
1781         size_t ilen;
1782         size_t olen;
1783         char *outbuf;
1784
1785         if ((str[0] & 0x80) == 0) {
1786                 *size = 1;
1787                 return (codepoint_t)str[0];
1788         }
1789
1790         /* We assume that no multi-byte character can take
1791            more than 5 bytes. This is OK as we only
1792            support codepoints up to 1M */
1793
1794         ilen_orig = strnlen(str, 5);
1795         ilen = ilen_orig;
1796
1797         lazy_initialize_conv();
1798
1799         descriptor = conv_handles[CH_UNIX][CH_UTF16LE];
1800         if (descriptor == (smb_iconv_t)-1 || descriptor == (smb_iconv_t)0) {
1801                 *size = 1;
1802                 return INVALID_CODEPOINT;
1803         }
1804
1805         /* This looks a little strange, but it is needed to cope
1806            with codepoints above 64k which are encoded as per RFC2781. */
1807         olen = 2;
1808         outbuf = (char *)buf;
1809         smb_iconv(descriptor, &str, &ilen, &outbuf, &olen);
1810         if (olen == 2) {
1811                 /* We failed to convert to a 2 byte character.
1812                    See if we can convert to a 4 UTF16-LE byte char encoding.
1813                 */
1814                 olen = 4;
1815                 outbuf = (char *)buf;
1816                 smb_iconv(descriptor,  &str, &ilen, &outbuf, &olen);
1817                 if (olen == 4) {
1818                         /* We didn't convert any bytes */
1819                         *size = 1;
1820                         return INVALID_CODEPOINT;
1821                 }
1822                 olen = 4 - olen;
1823         } else {
1824                 olen = 2 - olen;
1825         }
1826
1827         *size = ilen_orig - ilen;
1828
1829         if (olen == 2) {
1830                 /* 2 byte, UTF16-LE encoded value. */
1831                 return (codepoint_t)SVAL(buf, 0);
1832         }
1833         if (olen == 4) {
1834                 /* Decode a 4 byte UTF16-LE character manually.
1835                    See RFC2871 for the encoding machanism.
1836                 */
1837                 codepoint_t w1 = SVAL(buf,0) & ~0xD800;
1838                 codepoint_t w2 = SVAL(buf,2) & ~0xDC00;
1839
1840                 return (codepoint_t)0x10000 +
1841                                 (w1 << 10) + w2;
1842         }
1843
1844         /* no other length is valid */
1845         return INVALID_CODEPOINT;
1846 }