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