source3/smbd/mangle_hash.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Name mangling
   4    Copyright (C) Andrew Tridgell 1992-2002
   5    Copyright (C) Simo Sorce 2001
   6    Copyright (C) Andrew Bartlett 2002
   7    Copyright (C) Jeremy Allison 2007
   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 #include "system/filesys.h"
  25 #include "smbd/smbd.h"
  26 #include "smbd/globals.h"
  27 #include "mangle.h"
  28
  29 /* -------------------------------------------------------------------------- **
  30  * Other stuff...
  31  *
  32  * magic_char     - This is the magic char used for mangling.  It's
  33  *                  global.  There is a call to lp_magicchar() in server.c
  34  *                  that is used to override the initial value.
  35  *
  36  * MANGLE_BASE    - This is the number of characters we use for name mangling.
  37  *
  38  * basechars      - The set characters used for name mangling.  This
  39  *                  is static (scope is this file only).
  40  *
  41  * mangle()       - Macro used to select a character from basechars (i.e.,
  42  *                  mangle(n) will return the nth digit, modulo MANGLE_BASE).
  43  *
  44  * chartest       - array 0..255.  The index range is the set of all possible
  45  *                  values of a byte.  For each byte value, the content is a
  46  *                  two nibble pair.  See BASECHAR_MASK below.
  47  *
  48  * ct_initialized - False until the chartest array has been initialized via
  49  *                  a call to init_chartest().
  50  *
  51  * BASECHAR_MASK  - Masks the upper nibble of a one-byte value.
  52  *
  53  * isbasecahr()   - Given a character, check the chartest array to see
  54  *                  if that character is in the basechars set.  This is
  55  *                  faster than using strchr_m().
  56  *
  57  */
  58
  59 static const char basechars[43]="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_-!@#$%";
  60 #define MANGLE_BASE       (sizeof(basechars)/sizeof(char)-1)
  61
  62 #define mangle(V) ((char)(basechars[(V) % MANGLE_BASE]))
  63 #define BASECHAR_MASK 0xf0
  64 #define isbasechar(C) ( (chartest[ ((C) & 0xff) ]) & BASECHAR_MASK )
  65
  66 /* -------------------------------------------------------------------- */
  67
  68
  69 /*******************************************************************
  70  Determine if a character is valid in a 8.3 name.
  71 ********************************************************************/
  72
  73 /**
  74  * Load the valid character map table from <tt>valid.dat</tt> or
  75  * create from the configured codepage.
  76  *
  77  * This function is called whenever the configuration is reloaded.
  78  * However, the valid character table is not changed if it's loaded
  79  * from a file, because we can't unmap files.
  80  **/
  81
  82 static uint8 *valid_table;
  83 static void init_valid_table(void)
  84 {
  85         if (valid_table) {
  86                 return;
  87         }
  88
  89         valid_table = (uint8 *)map_file(data_path("valid.dat"), 0x10000);
  90         if (!valid_table) {
  91                 smb_panic("Could not load valid.dat file required for mangle method=hash");
  92                 return;
  93         }
  94 }
  95
  96 static bool isvalid83_w(smb_ucs2_t c)
  97 {
  98         init_valid_table();
  99         return valid_table[SVAL(&c,0)] != 0;
 100 }
 101
 102 static NTSTATUS has_valid_83_chars(const smb_ucs2_t *s, bool allow_wildcards)
 103 {
 104         if (!*s) {
 105                 return NT_STATUS_INVALID_PARAMETER;
 106         }
 107
 108         if (!allow_wildcards && ms_has_wild_w(s)) {
 109                 return NT_STATUS_UNSUCCESSFUL;
 110         }
 111
 112         while (*s) {
 113                 if(!isvalid83_w(*s)) {
 114                         return NT_STATUS_UNSUCCESSFUL;
 115                 }
 116                 s++;
 117         }
 118
 119         return NT_STATUS_OK;
 120 }
 121
 122 static NTSTATUS has_illegal_chars(const smb_ucs2_t *s, bool allow_wildcards)
 123 {
 124         if (!allow_wildcards && ms_has_wild_w(s)) {
 125                 return NT_STATUS_UNSUCCESSFUL;
 126         }
 127
 128         while (*s) {
 129                 if (*s <= 0x1f) {
 130                         /* Control characters. */
 131                         return NT_STATUS_UNSUCCESSFUL;
 132                 }
 133                 switch(*s) {
 134                         case UCS2_CHAR('\\'):
 135                         case UCS2_CHAR('/'):
 136                         case UCS2_CHAR('|'):
 137                         case UCS2_CHAR(':'):
 138                                 return NT_STATUS_UNSUCCESSFUL;
 139                 }
 140                 s++;
 141         }
 142
 143         return NT_STATUS_OK;
 144 }
 145
 146 /*******************************************************************
 147  Duplicate string.
 148 ********************************************************************/
 149
 150 static smb_ucs2_t *strdup_w(const smb_ucs2_t *src)
 151 {
 152         smb_ucs2_t *dest;
 153         size_t len = strlen_w(src);
 154         dest = SMB_MALLOC_ARRAY(smb_ucs2_t, len + 1);
 155         if (!dest) {
 156                 DEBUG(0,("strdup_w: out of memory!\n"));
 157                 return NULL;
 158         }
 159
 160         memcpy(dest, src, len * sizeof(smb_ucs2_t));
 161         dest[len] = 0;
 162         return dest;
 163 }
 164
 165 /* return False if something fail and
 166  * return 2 alloced unicode strings that contain prefix and extension
 167  */
 168
 169 static NTSTATUS mangle_get_prefix(const smb_ucs2_t *ucs2_string, smb_ucs2_t **prefix,
 170                 smb_ucs2_t **extension, bool allow_wildcards)
 171 {
 172         size_t ext_len;
 173         smb_ucs2_t *p;
 174
 175         *extension = 0;
 176         *prefix = strdup_w(ucs2_string);
 177         if (!*prefix) {
 178                 return NT_STATUS_NO_MEMORY;
 179         }
 180         if ((p = strrchr_w(*prefix, UCS2_CHAR('.')))) {
 181                 ext_len = strlen_w(p+1);
 182                 if ((ext_len > 0) && (ext_len < 4) && (p != *prefix) &&
 183                     (NT_STATUS_IS_OK(has_valid_83_chars(p+1,allow_wildcards)))) /* check extension */ {
 184                         *p = 0;
 185                         *extension = strdup_w(p+1);
 186                         if (!*extension) {
 187                                 SAFE_FREE(*prefix);
 188                                 return NT_STATUS_NO_MEMORY;
 189                         }
 190                 }
 191         }
 192         return NT_STATUS_OK;
 193 }
 194
 195 /* ************************************************************************** **
 196  * Return NT_STATUS_UNSUCCESSFUL if a name is a special msdos reserved name.
 197  * or contains illegal characters.
 198  *
 199  *  Input:  fname - String containing the name to be tested.
 200  *
 201  *  Output: NT_STATUS_UNSUCCESSFUL, if the condition above is true.
 202  *
 203  *  Notes:  This is a static function called by is_8_3(), below.
 204  *
 205  * ************************************************************************** **
 206  */
 207
 208 static NTSTATUS is_valid_name(const smb_ucs2_t *fname, bool allow_wildcards, bool only_8_3)
 209 {
 210         smb_ucs2_t *str, *p;
 211         size_t num_ucs2_chars;
 212         NTSTATUS ret = NT_STATUS_OK;
 213
 214         if (!fname || !*fname)
 215                 return NT_STATUS_INVALID_PARAMETER;
 216
 217         /* . and .. are valid names. */
 218         if (strcmp_wa(fname, ".")==0 || strcmp_wa(fname, "..")==0)
 219                 return NT_STATUS_OK;
 220
 221         if (only_8_3) {
 222                 ret = has_valid_83_chars(fname, allow_wildcards);
 223                 if (!NT_STATUS_IS_OK(ret))
 224                         return ret;
 225         }
 226
 227         ret = has_illegal_chars(fname, allow_wildcards);
 228         if (!NT_STATUS_IS_OK(ret))
 229                 return ret;
 230
 231         /* Name can't end in '.' or ' ' */
 232         num_ucs2_chars = strlen_w(fname);
 233         if (fname[num_ucs2_chars-1] == UCS2_CHAR('.') || fname[num_ucs2_chars-1] == UCS2_CHAR(' ')) {
 234                 return NT_STATUS_UNSUCCESSFUL;
 235         }
 236
 237         str = strdup_w(fname);
 238
 239         /* Truncate copy after the first dot. */
 240         p = strchr_w(str, UCS2_CHAR('.'));
 241         if (p) {
 242                 *p = 0;
 243         }
 244
 245         strupper_w(str);
 246         p = &str[1];
 247
 248         switch(str[0])
 249         {
 250         case UCS2_CHAR('A'):
 251                 if(strcmp_wa(p, "UX") == 0)
 252                         ret = NT_STATUS_UNSUCCESSFUL;
 253                 break;
 254         case UCS2_CHAR('C'):
 255                 if((strcmp_wa(p, "LOCK$") == 0)
 256                 || (strcmp_wa(p, "ON") == 0)
 257                 || (strcmp_wa(p, "OM1") == 0)
 258                 || (strcmp_wa(p, "OM2") == 0)
 259                 || (strcmp_wa(p, "OM3") == 0)
 260                 || (strcmp_wa(p, "OM4") == 0)
 261                 )
 262                         ret = NT_STATUS_UNSUCCESSFUL;
 263                 break;
 264         case UCS2_CHAR('L'):
 265                 if((strcmp_wa(p, "PT1") == 0)
 266                 || (strcmp_wa(p, "PT2") == 0)
 267                 || (strcmp_wa(p, "PT3") == 0)
 268                 )
 269                         ret = NT_STATUS_UNSUCCESSFUL;
 270                 break;
 271         case UCS2_CHAR('N'):
 272                 if(strcmp_wa(p, "UL") == 0)
 273                         ret = NT_STATUS_UNSUCCESSFUL;
 274                 break;
 275         case UCS2_CHAR('P'):
 276                 if(strcmp_wa(p, "RN") == 0)
 277                         ret = NT_STATUS_UNSUCCESSFUL;
 278                 break;
 279         default:
 280                 break;
 281         }
 282
 283         SAFE_FREE(str);
 284         return ret;
 285 }
 286
 287 static NTSTATUS is_8_3_w(const smb_ucs2_t *fname, bool allow_wildcards)
 288 {
 289         smb_ucs2_t *pref = 0, *ext = 0;
 290         size_t plen;
 291         NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
 292
 293         if (!fname || !*fname)
 294                 return NT_STATUS_INVALID_PARAMETER;
 295
 296         if (strlen_w(fname) > 12)
 297                 return NT_STATUS_UNSUCCESSFUL;
 298
 299         if (strcmp_wa(fname, ".") == 0 || strcmp_wa(fname, "..") == 0)
 300                 return NT_STATUS_OK;
 301
 302         /* Name cannot start with '.' */
 303         if (*fname == UCS2_CHAR('.'))
 304                 return NT_STATUS_UNSUCCESSFUL;
 305
 306         if (!NT_STATUS_IS_OK(is_valid_name(fname, allow_wildcards, True)))
 307                 goto done;
 308
 309         if (!NT_STATUS_IS_OK(mangle_get_prefix(fname, &pref, &ext, allow_wildcards)))
 310                 goto done;
 311         plen = strlen_w(pref);
 312
 313         if (strchr_wa(pref, '.'))
 314                 goto done;
 315         if (plen < 1 || plen > 8)
 316                 goto done;
 317         if (ext && (strlen_w(ext) > 3))
 318                 goto done;
 319
 320         ret = NT_STATUS_OK;
 321
 322 done:
 323         SAFE_FREE(pref);
 324         SAFE_FREE(ext);
 325         return ret;
 326 }
 327
 328 static bool is_8_3(const char *fname, bool check_case, bool allow_wildcards,
 329                    const struct share_params *p)
 330 {
 331         const char *f;
 332         smb_ucs2_t *ucs2name;
 333         NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
 334         size_t size;
 335         char magic_char;
 336
 337         magic_char = lp_magicchar(p);
 338
 339         if (!fname || !*fname)
 340                 return False;
 341         if ((f = strrchr(fname, '/')) == NULL)
 342                 f = fname;
 343         else
 344                 f++;
 345
 346         if (strlen(f) > 12)
 347                 return False;
 348
 349         if (!push_ucs2_talloc(NULL, &ucs2name, f, &size)) {
 350                 DEBUG(0,("is_8_3: internal error push_ucs2_talloc() failed!\n"));
 351                 goto done;
 352         }
 353
 354         ret = is_8_3_w(ucs2name, allow_wildcards);
 355
 356 done:
 357         TALLOC_FREE(ucs2name);
 358
 359         if (!NT_STATUS_IS_OK(ret)) {
 360                 return False;
 361         }
 362
 363         return True;
 364 }
 365
 366 /* -------------------------------------------------------------------------- **
 367  * Functions...
 368  */
 369
 370 /* ************************************************************************** **
 371  * Initialize the static character test array.
 372  *
 373  *  Input:  none
 374  *
 375  *  Output: none
 376  *
 377  *  Notes:  This function changes (loads) the contents of the <chartest>
 378  *          array.  The scope of <chartest> is this file.
 379  *
 380  * ************************************************************************** **
 381  */
 382
 383 static void init_chartest( void )
 384 {
 385         const unsigned char *s;
 386
 387         chartest = SMB_MALLOC_ARRAY(unsigned char, 256);
 388
 389         SMB_ASSERT(chartest != NULL);
 390         memset(chartest, '\0', 256);
 391
 392         for( s = (const unsigned char *)basechars; *s; s++ ) {
 393                 chartest[*s] |= BASECHAR_MASK;
 394         }
 395 }
 396
 397 /* ************************************************************************** **
 398  * Return True if the name *could be* a mangled name.
 399  *
 400  *  Input:  s - A path name - in UNIX pathname format.
 401  *
 402  *  Output: True if the name matches the pattern described below in the
 403  *          notes, else False.
 404  *
 405  *  Notes:  The input name is *not* tested for 8.3 compliance.  This must be
 406  *          done separately.  This function returns true if the name contains
 407  *          a magic character followed by excactly two characters from the
 408  *          basechars list (above), which in turn are followed either by the
 409  *          nul (end of string) byte or a dot (extension) or by a '/' (end of
 410  *          a directory name).
 411  *
 412  * ************************************************************************** **
 413  */
 414
 415 static bool is_mangled(const char *s, const struct share_params *p)
 416 {
 417         char *magic;
 418         char magic_char;
 419
 420         magic_char = lp_magicchar(p);
 421
 422         if (chartest == NULL) {
 423                 init_chartest();
 424         }
 425
 426         magic = strchr_m( s, magic_char );
 427         while( magic && magic[1] && magic[2] ) {         /* 3 chars, 1st is magic. */
 428                 if( ('.' == magic[3] || '/' == magic[3] || !(magic[3]))          /* Ends with '.' or nul or '/' ?  */
 429                                 && isbasechar( toupper_ascii(magic[1]) )           /* is 2nd char basechar?  */
 430                                 && isbasechar( toupper_ascii(magic[2]) ) )         /* is 3rd char basechar?  */
 431                         return( True );                           /* If all above, then true, */
 432                 magic = strchr_m( magic+1, magic_char );      /*    else seek next magic. */
 433         }
 434         return( False );
 435 }
 436
 437 /***************************************************************************
 438  Initializes or clears the mangled cache.
 439 ***************************************************************************/
 440
 441 static void mangle_reset( void )
 442 {
 443         /* We could close and re-open the tdb here... should we ? The old code did
 444            the equivalent... JRA. */
 445 }
 446
 447 /***************************************************************************
 448  Add a mangled name into the cache.
 449  If the extension of the raw name maps directly to the
 450  extension of the mangled name, then we'll store both names
 451  *without* extensions.  That way, we can provide consistent
 452  reverse mangling for all names that match.  The test here is
 453  a bit more careful than the one done in earlier versions of
 454  mangle.c:
 455
 456     - the extension must exist on the raw name,
 457     - it must be all lower case
 458     - it must match the mangled extension (to prove that no
 459       mangling occurred).
 460   crh 07-Apr-1998
 461 **************************************************************************/
 462
 463 static void cache_mangled_name( const char mangled_name[13],
 464                                 const char *raw_name )
 465 {
 466         TDB_DATA data_val;
 467         char mangled_name_key[13];
 468         char *s1 = NULL;
 469         char *s2 = NULL;
 470
 471         /* If the cache isn't initialized, give up. */
 472         if( !tdb_mangled_cache )
 473                 return;
 474
 475         /* Init the string lengths. */
 476         safe_strcpy(mangled_name_key, mangled_name, sizeof(mangled_name_key)-1);
 477
 478         /* See if the extensions are unmangled.  If so, store the entry
 479          * without the extension, thus creating a "group" reverse map.
 480          */
 481         s1 = strrchr( mangled_name_key, '.' );
 482         if( s1 && (s2 = strrchr( raw_name, '.' )) ) {
 483                 size_t i = 1;
 484                 while( s1[i] && (tolower_ascii( s1[i] ) == s2[i]) )
 485                         i++;
 486                 if( !s1[i] && !s2[i] ) {
 487                         /* Truncate at the '.' */
 488                         *s1 = '\0';
 489                         /*
 490                          * DANGER WILL ROBINSON - this
 491                          * is changing a const string via
 492                          * an aliased pointer ! Remember to
 493                          * put it back once we've used it.
 494                          * JRA
 495                          */
 496                         *s2 = '\0';
 497                 }
 498         }
 499
 500         /* Allocate a new cache entry.  If the allocation fails, just return. */
 501         data_val = string_term_tdb_data(raw_name);
 502         if (tdb_store_bystring(tdb_mangled_cache, mangled_name_key, data_val, TDB_REPLACE) != 0) {
 503                 DEBUG(0,("cache_mangled_name: Error storing entry %s -> %s\n", mangled_name_key, raw_name));
 504         } else {
 505                 DEBUG(5,("cache_mangled_name: Stored entry %s -> %s\n", mangled_name_key, raw_name));
 506         }
 507         /* Restore the change we made to the const string. */
 508         if (s2) {
 509                 *s2 = '.';
 510         }
 511 }
 512
 513 /* ************************************************************************** **
 514  * Check for a name on the mangled name stack
 515  *
 516  *  Input:  s - Input *and* output string buffer.
 517  *          maxlen - space in i/o string buffer.
 518  *  Output: True if the name was found in the cache, else False.
 519  *
 520  *  Notes:  If a reverse map is found, the function will overwrite the string
 521  *          space indicated by the input pointer <s>.  This is frightening.
 522  *          It should be rewritten to return NULL if the long name was not
 523  *          found, and a pointer to the long name if it was found.
 524  *
 525  * ************************************************************************** **
 526  */
 527
 528 static bool lookup_name_from_8_3(TALLOC_CTX *ctx,
 529                                 const char *in,
 530                                 char **out, /* talloced on the given context. */
 531                                 const struct share_params *p)
 532 {
 533         TDB_DATA data_val;
 534         char *saved_ext = NULL;
 535         char *s = talloc_strdup(ctx, in);
 536         char magic_char;
 537
 538         magic_char = lp_magicchar(p);
 539
 540         /* If the cache isn't initialized, give up. */
 541         if(!s || !tdb_mangled_cache ) {
 542                 TALLOC_FREE(s);
 543                 return False;
 544         }
 545
 546         data_val = tdb_fetch_bystring(tdb_mangled_cache, s);
 547
 548         /* If we didn't find the name *with* the extension, try without. */
 549         if(data_val.dptr == NULL || data_val.dsize == 0) {
 550                 char *ext_start = strrchr( s, '.' );
 551                 if( ext_start ) {
 552                         if((saved_ext = talloc_strdup(ctx,ext_start)) == NULL) {
 553                                 TALLOC_FREE(s);
 554                                 return False;
 555                         }
 556
 557                         *ext_start = '\0';
 558                         data_val = tdb_fetch_bystring(tdb_mangled_cache, s);
 559                         /*
 560                          * At this point s is the name without the
 561                          * extension. We re-add the extension if saved_ext
 562                          * is not null, before freeing saved_ext.
 563                          */
 564                 }
 565         }
 566
 567         /* Okay, if we haven't found it we're done. */
 568         if(data_val.dptr == NULL || data_val.dsize == 0) {
 569                 TALLOC_FREE(saved_ext);
 570                 TALLOC_FREE(s);
 571                 return False;
 572         }
 573
 574         /* If we *did* find it, we need to talloc it on the given ctx. */
 575         if (saved_ext) {
 576                 *out = talloc_asprintf(ctx, "%s%s",
 577                                         (char *)data_val.dptr,
 578                                         saved_ext);
 579         } else {
 580                 *out = talloc_strdup(ctx, (char *)data_val.dptr);
 581         }
 582
 583         TALLOC_FREE(s);
 584         TALLOC_FREE(saved_ext);
 585         SAFE_FREE(data_val.dptr);
 586
 587         return *out ? True : False;
 588 }
 589
 590 /**
 591  Check if a string is in "normal" case.
 592 **/
 593
 594 static bool strisnormal(const char *s, int case_default)
 595 {
 596         if (case_default == CASE_UPPER)
 597                 return(!strhaslower(s));
 598
 599         return(!strhasupper(s));
 600 }
 601
 602
 603 /*****************************************************************************
 604  Do the actual mangling to 8.3 format.
 605 *****************************************************************************/
 606
 607 static bool to_8_3(char magic_char, const char *in, char out[13], int default_case)
 608 {
 609         int csum;
 610         char *p;
 611         char extension[4];
 612         char base[9];
 613         int baselen = 0;
 614         int extlen = 0;
 615         char *s = SMB_STRDUP(in);
 616
 617         extension[0] = 0;
 618         base[0] = 0;
 619
 620         if (!s) {
 621                 return False;
 622         }
 623
 624         p = strrchr(s,'.');
 625         if( p && (strlen(p+1) < (size_t)4) ) {
 626                 bool all_normal = ( strisnormal(p+1, default_case) ); /* XXXXXXXXX */
 627
 628                 if( all_normal && p[1] != 0 ) {
 629                         *p = 0;
 630                         csum = str_checksum( s );
 631                         *p = '.';
 632                 } else
 633                         csum = str_checksum(s);
 634         } else
 635                 csum = str_checksum(s);
 636
 637         strupper_m( s );
 638
 639         if( p ) {
 640                 if( p == s )
 641                         safe_strcpy( extension, "___", 3 );
 642                 else {
 643                         *p++ = 0;
 644                         while( *p && extlen < 3 ) {
 645                                 if ( *p != '.') {
 646                                         extension[extlen++] = p[0];
 647                                 }
 648                                 p++;
 649                         }
 650                         extension[extlen] = 0;
 651                 }
 652         }
 653
 654         p = s;
 655
 656         while( *p && baselen < 5 ) {
 657                 if (isbasechar(*p)) {
 658                         base[baselen++] = p[0];
 659                 }
 660                 p++;
 661         }
 662         base[baselen] = 0;
 663
 664         csum = csum % (MANGLE_BASE*MANGLE_BASE);
 665
 666         memcpy(out, base, baselen);
 667         out[baselen] = magic_char;
 668         out[baselen+1] = mangle( csum/MANGLE_BASE );
 669         out[baselen+2] = mangle( csum );
 670
 671         if( *extension ) {
 672                 out[baselen+3] = '.';
 673                 safe_strcpy(&out[baselen+4], extension, 3);
 674         }
 675
 676         SAFE_FREE(s);
 677         return True;
 678 }
 679
 680 static bool must_mangle(const char *name,
 681                         const struct share_params *p)
 682 {
 683         smb_ucs2_t *name_ucs2 = NULL;
 684         NTSTATUS status;
 685         size_t converted_size;
 686         char magic_char;
 687
 688         magic_char = lp_magicchar(p);
 689
 690         if (!push_ucs2_talloc(NULL, &name_ucs2, name, &converted_size)) {
 691                 DEBUG(0, ("push_ucs2_talloc failed!\n"));
 692                 return False;
 693         }
 694         status = is_valid_name(name_ucs2, False, False);
 695         TALLOC_FREE(name_ucs2);
 696         /* We return true if we *must* mangle, so if it's
 697          * a valid name (status == OK) then we must return
 698          * false. Bug #6939. */
 699         return !NT_STATUS_IS_OK(status);
 700 }
 701
 702 /*****************************************************************************
 703  * Convert a filename to DOS format.  Return True if successful.
 704  *  Input:  in        Incoming name.
 705  *
 706  *          out       8.3 DOS name.
 707  *
 708  *          cache83 - If False, the mangled name cache will not be updated.
 709  *                    This is usually used to prevent that we overwrite
 710  *                    a conflicting cache entry prematurely, i.e. before
 711  *                    we know whether the client is really interested in the
 712  *                    current name.  (See PR#13758).  UKD.
 713  *
 714  * ****************************************************************************
 715  */
 716
 717 static bool hash_name_to_8_3(const char *in,
 718                         char out[13],
 719                         bool cache83,
 720                         int default_case,
 721                         const struct share_params *p)
 722 {
 723         smb_ucs2_t *in_ucs2 = NULL;
 724         size_t converted_size;
 725         char magic_char;
 726
 727         magic_char = lp_magicchar(p);
 728
 729         DEBUG(5,("hash_name_to_8_3( %s, cache83 = %s)\n", in,
 730                  cache83 ? "True" : "False"));
 731
 732         if (!push_ucs2_talloc(NULL, &in_ucs2, in, &converted_size)) {
 733                 DEBUG(0, ("push_ucs2_talloc failed!\n"));
 734                 return False;
 735         }
 736
 737         /* If it's already 8.3, just copy. */
 738         if (NT_STATUS_IS_OK(is_valid_name(in_ucs2, False, False)) &&
 739                                 NT_STATUS_IS_OK(is_8_3_w(in_ucs2, False))) {
 740                 TALLOC_FREE(in_ucs2);
 741                 safe_strcpy(out, in, 12);
 742                 return True;
 743         }
 744
 745         TALLOC_FREE(in_ucs2);
 746         if (!to_8_3(magic_char, in, out, default_case)) {
 747                 return False;
 748         }
 749
 750         cache_mangled_name(out, in);
 751
 752         DEBUG(5,("hash_name_to_8_3(%s) ==> [%s]\n", in, out));
 753         return True;
 754 }
 755
 756 /*
 757   the following provides the abstraction layer to make it easier
 758   to drop in an alternative mangling implementation
 759 */
 760 static const struct mangle_fns mangle_hash_fns = {
 761         mangle_reset,
 762         is_mangled,
 763         must_mangle,
 764         is_8_3,
 765         lookup_name_from_8_3,
 766         hash_name_to_8_3
 767 };
 768
 769 /* return the methods for this mangling implementation */
 770 const struct mangle_fns *mangle_hash_init(void)
 771 {
 772         mangle_reset();
 773
 774         /* Create the in-memory tdb using our custom hash function. */
 775         tdb_mangled_cache = tdb_open_ex("mangled_cache", 1031, TDB_INTERNAL,
 776                                 (O_RDWR|O_CREAT), 0644, NULL, fast_string_hash);
 777
 778         return &mangle_hash_fns;
 779 }