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