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