s3:smbd: it's pointless to have a global magic_char
[abartlet/samba.git/.git] / 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
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 static const char basechars[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_-!@#$%";
56 #define MANGLE_BASE       (sizeof(basechars)/sizeof(char)-1)
57
58 static unsigned char *chartest;
59
60 #define mangle(V) ((char)(basechars[(V) % MANGLE_BASE]))
61 #define BASECHAR_MASK 0xf0
62 #define isbasechar(C) ( (chartest[ ((C) & 0xff) ]) & BASECHAR_MASK )
63
64 static TDB_CONTEXT *tdb_mangled_cache;
65
66 /* -------------------------------------------------------------------- */
67
68 static NTSTATUS has_valid_83_chars(const smb_ucs2_t *s, bool allow_wildcards)
69 {
70         if (!*s) {
71                 return NT_STATUS_INVALID_PARAMETER;
72         }
73
74         if (!allow_wildcards && ms_has_wild_w(s)) {
75                 return NT_STATUS_UNSUCCESSFUL;
76         }
77
78         while (*s) {
79                 if(!isvalid83_w(*s)) {
80                         return NT_STATUS_UNSUCCESSFUL;
81                 }
82                 s++;
83         }
84
85         return NT_STATUS_OK;
86 }
87
88 static NTSTATUS has_illegal_chars(const smb_ucs2_t *s, bool allow_wildcards)
89 {
90         if (!allow_wildcards && ms_has_wild_w(s)) {
91                 return NT_STATUS_UNSUCCESSFUL;
92         }
93
94         while (*s) {
95                 if (*s <= 0x1f) {
96                         /* Control characters. */
97                         return NT_STATUS_UNSUCCESSFUL;
98                 }
99                 switch(*s) {
100                         case UCS2_CHAR('\\'):
101                         case UCS2_CHAR('/'):
102                         case UCS2_CHAR('|'):
103                         case UCS2_CHAR(':'):
104                                 return NT_STATUS_UNSUCCESSFUL;
105                 }
106                 s++;
107         }
108
109         return NT_STATUS_OK;
110 }
111
112 /* return False if something fail and
113  * return 2 alloced unicode strings that contain prefix and extension
114  */
115
116 static NTSTATUS mangle_get_prefix(const smb_ucs2_t *ucs2_string, smb_ucs2_t **prefix,
117                 smb_ucs2_t **extension, bool allow_wildcards)
118 {
119         size_t ext_len;
120         smb_ucs2_t *p;
121
122         *extension = 0;
123         *prefix = strdup_w(ucs2_string);
124         if (!*prefix) {
125                 return NT_STATUS_NO_MEMORY;
126         }
127         if ((p = strrchr_w(*prefix, UCS2_CHAR('.')))) {
128                 ext_len = strlen_w(p+1);
129                 if ((ext_len > 0) && (ext_len < 4) && (p != *prefix) &&
130                     (NT_STATUS_IS_OK(has_valid_83_chars(p+1,allow_wildcards)))) /* check extension */ {
131                         *p = 0;
132                         *extension = strdup_w(p+1);
133                         if (!*extension) {
134                                 SAFE_FREE(*prefix);
135                                 return NT_STATUS_NO_MEMORY;
136                         }
137                 }
138         }
139         return NT_STATUS_OK;
140 }
141
142 /* ************************************************************************** **
143  * Return NT_STATUS_UNSUCCESSFUL if a name is a special msdos reserved name.
144  * or contains illegal characters.
145  *
146  *  Input:  fname - String containing the name to be tested.
147  *
148  *  Output: NT_STATUS_UNSUCCESSFUL, if the condition above is true.
149  *
150  *  Notes:  This is a static function called by is_8_3(), below.
151  *
152  * ************************************************************************** **
153  */
154
155 static NTSTATUS is_valid_name(const smb_ucs2_t *fname, bool allow_wildcards, bool only_8_3)
156 {
157         smb_ucs2_t *str, *p;
158         size_t num_ucs2_chars;
159         NTSTATUS ret = NT_STATUS_OK;
160
161         if (!fname || !*fname)
162                 return NT_STATUS_INVALID_PARAMETER;
163
164         /* . and .. are valid names. */
165         if (strcmp_wa(fname, ".")==0 || strcmp_wa(fname, "..")==0)
166                 return NT_STATUS_OK;
167
168         if (only_8_3) {
169                 ret = has_valid_83_chars(fname, allow_wildcards);
170                 if (!NT_STATUS_IS_OK(ret))
171                         return ret;
172         }
173
174         ret = has_illegal_chars(fname, allow_wildcards);
175         if (!NT_STATUS_IS_OK(ret))
176                 return ret;
177
178         /* Name can't end in '.' or ' ' */
179         num_ucs2_chars = strlen_w(fname);
180         if (fname[num_ucs2_chars-1] == UCS2_CHAR('.') || fname[num_ucs2_chars-1] == UCS2_CHAR(' ')) {
181                 return NT_STATUS_UNSUCCESSFUL;
182         }
183
184         str = strdup_w(fname);
185
186         /* Truncate copy after the first dot. */
187         p = strchr_w(str, UCS2_CHAR('.'));
188         if (p) {
189                 *p = 0;
190         }
191
192         strupper_w(str);
193         p = &str[1];
194
195         switch(str[0])
196         {
197         case UCS2_CHAR('A'):
198                 if(strcmp_wa(p, "UX") == 0)
199                         ret = NT_STATUS_UNSUCCESSFUL;
200                 break;
201         case UCS2_CHAR('C'):
202                 if((strcmp_wa(p, "LOCK$") == 0)
203                 || (strcmp_wa(p, "ON") == 0)
204                 || (strcmp_wa(p, "OM1") == 0)
205                 || (strcmp_wa(p, "OM2") == 0)
206                 || (strcmp_wa(p, "OM3") == 0)
207                 || (strcmp_wa(p, "OM4") == 0)
208                 )
209                         ret = NT_STATUS_UNSUCCESSFUL;
210                 break;
211         case UCS2_CHAR('L'):
212                 if((strcmp_wa(p, "PT1") == 0)
213                 || (strcmp_wa(p, "PT2") == 0)
214                 || (strcmp_wa(p, "PT3") == 0)
215                 )
216                         ret = NT_STATUS_UNSUCCESSFUL;
217                 break;
218         case UCS2_CHAR('N'):
219                 if(strcmp_wa(p, "UL") == 0)
220                         ret = NT_STATUS_UNSUCCESSFUL;
221                 break;
222         case UCS2_CHAR('P'):
223                 if(strcmp_wa(p, "RN") == 0)
224                         ret = NT_STATUS_UNSUCCESSFUL;
225                 break;
226         default:
227                 break;
228         }
229
230         SAFE_FREE(str);
231         return ret;
232 }
233
234 static NTSTATUS is_8_3_w(const smb_ucs2_t *fname, bool allow_wildcards)
235 {
236         smb_ucs2_t *pref = 0, *ext = 0;
237         size_t plen;
238         NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
239
240         if (!fname || !*fname)
241                 return NT_STATUS_INVALID_PARAMETER;
242
243         if (strlen_w(fname) > 12)
244                 return NT_STATUS_UNSUCCESSFUL;
245
246         if (strcmp_wa(fname, ".") == 0 || strcmp_wa(fname, "..") == 0)
247                 return NT_STATUS_OK;
248
249         /* Name cannot start with '.' */
250         if (*fname == UCS2_CHAR('.'))
251                 return NT_STATUS_UNSUCCESSFUL;
252
253         if (!NT_STATUS_IS_OK(is_valid_name(fname, allow_wildcards, True)))
254                 goto done;
255
256         if (!NT_STATUS_IS_OK(mangle_get_prefix(fname, &pref, &ext, allow_wildcards)))
257                 goto done;
258         plen = strlen_w(pref);
259
260         if (strchr_wa(pref, '.'))
261                 goto done;
262         if (plen < 1 || plen > 8)
263                 goto done;
264         if (ext && (strlen_w(ext) > 3))
265                 goto done;
266
267         ret = NT_STATUS_OK;
268
269 done:
270         SAFE_FREE(pref);
271         SAFE_FREE(ext);
272         return ret;
273 }
274
275 static bool is_8_3(const char *fname, bool check_case, bool allow_wildcards,
276                    const struct share_params *p)
277 {
278         const char *f;
279         smb_ucs2_t *ucs2name;
280         NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
281         size_t size;
282         char magic_char;
283
284         magic_char = lp_magicchar(p);
285
286         if (!fname || !*fname)
287                 return False;
288         if ((f = strrchr(fname, '/')) == NULL)
289                 f = fname;
290         else
291                 f++;
292
293         if (strlen(f) > 12)
294                 return False;
295
296         if (!push_ucs2_allocate(&ucs2name, f, &size)) {
297                 DEBUG(0,("is_8_3: internal error push_ucs2_allocate() failed!\n"));
298                 goto done;
299         }
300
301         ret = is_8_3_w(ucs2name, allow_wildcards);
302
303 done:
304         SAFE_FREE(ucs2name);
305
306         if (!NT_STATUS_IS_OK(ret)) {
307                 return False;
308         }
309
310         return True;
311 }
312
313 /* -------------------------------------------------------------------------- **
314  * Functions...
315  */
316
317 /* ************************************************************************** **
318  * Initialize the static character test array.
319  *
320  *  Input:  none
321  *
322  *  Output: none
323  *
324  *  Notes:  This function changes (loads) the contents of the <chartest>
325  *          array.  The scope of <chartest> is this file.
326  *
327  * ************************************************************************** **
328  */
329
330 static void init_chartest( void )
331 {
332         const unsigned char *s;
333
334         chartest = SMB_MALLOC_ARRAY(unsigned char, 256);
335
336         SMB_ASSERT(chartest != NULL);
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;
415         char *s2;
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                         *s2 = '\0';
436                 }
437         }
438
439         /* Allocate a new cache entry.  If the allocation fails, just return. */
440         data_val = string_term_tdb_data(raw_name);
441         if (tdb_store_bystring(tdb_mangled_cache, mangled_name_key, data_val, TDB_REPLACE) != 0) {
442                 DEBUG(0,("cache_mangled_name: Error storing entry %s -> %s\n", mangled_name_key, raw_name));
443         } else {
444                 DEBUG(5,("cache_mangled_name: Stored entry %s -> %s\n", mangled_name_key, raw_name));
445         }
446 }
447
448 /* ************************************************************************** **
449  * Check for a name on the mangled name stack
450  *
451  *  Input:  s - Input *and* output string buffer.
452  *          maxlen - space in i/o string buffer.
453  *  Output: True if the name was found in the cache, else False.
454  *
455  *  Notes:  If a reverse map is found, the function will overwrite the string
456  *          space indicated by the input pointer <s>.  This is frightening.
457  *          It should be rewritten to return NULL if the long name was not
458  *          found, and a pointer to the long name if it was found.
459  *
460  * ************************************************************************** **
461  */
462
463 static bool lookup_name_from_8_3(TALLOC_CTX *ctx,
464                                 const char *in,
465                                 char **out, /* talloced on the given context. */
466                                 const struct share_params *p)
467 {
468         TDB_DATA data_val;
469         char *saved_ext = NULL;
470         char *s = talloc_strdup(ctx, in);
471         char magic_char;
472
473         magic_char = lp_magicchar(p);
474
475         /* If the cache isn't initialized, give up. */
476         if(!s || !tdb_mangled_cache ) {
477                 TALLOC_FREE(s);
478                 return False;
479         }
480
481         data_val = tdb_fetch_bystring(tdb_mangled_cache, s);
482
483         /* If we didn't find the name *with* the extension, try without. */
484         if(data_val.dptr == NULL || data_val.dsize == 0) {
485                 char *ext_start = strrchr( s, '.' );
486                 if( ext_start ) {
487                         if((saved_ext = talloc_strdup(ctx,ext_start)) == NULL) {
488                                 TALLOC_FREE(s);
489                                 return False;
490                         }
491
492                         *ext_start = '\0';
493                         data_val = tdb_fetch_bystring(tdb_mangled_cache, s);
494                         /*
495                          * At this point s is the name without the
496                          * extension. We re-add the extension if saved_ext
497                          * is not null, before freeing saved_ext.
498                          */
499                 }
500         }
501
502         /* Okay, if we haven't found it we're done. */
503         if(data_val.dptr == NULL || data_val.dsize == 0) {
504                 TALLOC_FREE(saved_ext);
505                 TALLOC_FREE(s);
506                 return False;
507         }
508
509         /* If we *did* find it, we need to talloc it on the given ctx. */
510         if (saved_ext) {
511                 *out = talloc_asprintf(ctx, "%s%s",
512                                         (char *)data_val.dptr,
513                                         saved_ext);
514         } else {
515                 *out = talloc_strdup(ctx, (char *)data_val.dptr);
516         }
517
518         TALLOC_FREE(s);
519         TALLOC_FREE(saved_ext);
520         SAFE_FREE(data_val.dptr);
521
522         return *out ? True : False;
523 }
524
525 /*****************************************************************************
526  Do the actual mangling to 8.3 format.
527 *****************************************************************************/
528
529 static bool to_8_3(char magic_char, const char *in, char out[13], int default_case)
530 {
531         int csum;
532         char *p;
533         char extension[4];
534         char base[9];
535         int baselen = 0;
536         int extlen = 0;
537         char *s = SMB_STRDUP(in);
538
539         extension[0] = 0;
540         base[0] = 0;
541
542         if (!s) {
543                 return False;
544         }
545
546         p = strrchr(s,'.');
547         if( p && (strlen(p+1) < (size_t)4) ) {
548                 bool all_normal = ( strisnormal(p+1, default_case) ); /* XXXXXXXXX */
549
550                 if( all_normal && p[1] != 0 ) {
551                         *p = 0;
552                         csum = str_checksum( s );
553                         *p = '.';
554                 } else
555                         csum = str_checksum(s);
556         } else
557                 csum = str_checksum(s);
558
559         strupper_m( s );
560
561         if( p ) {
562                 if( p == s )
563                         safe_strcpy( extension, "___", 3 );
564                 else {
565                         *p++ = 0;
566                         while( *p && extlen < 3 ) {
567                                 if ( *p != '.') {
568                                         extension[extlen++] = p[0];
569                                 }
570                                 p++;
571                         }
572                         extension[extlen] = 0;
573                 }
574         }
575
576         p = s;
577
578         while( *p && baselen < 5 ) {
579                 if (isbasechar(*p)) {
580                         base[baselen++] = p[0];
581                 }
582                 p++;
583         }
584         base[baselen] = 0;
585
586         csum = csum % (MANGLE_BASE*MANGLE_BASE);
587
588         memcpy(out, base, baselen);
589         out[baselen] = magic_char;
590         out[baselen+1] = mangle( csum/MANGLE_BASE );
591         out[baselen+2] = mangle( csum );
592
593         if( *extension ) {
594                 out[baselen+3] = '.';
595                 safe_strcpy(&out[baselen+4], extension, 3);
596         }
597
598         SAFE_FREE(s);
599         return True;
600 }
601
602 static bool must_mangle(const char *name,
603                         const struct share_params *p)
604 {
605         smb_ucs2_t *name_ucs2 = NULL;
606         NTSTATUS status;
607         size_t converted_size;
608         char magic_char;
609
610         magic_char = lp_magicchar(p);
611
612         if (!push_ucs2_allocate(&name_ucs2, name, &converted_size)) {
613                 DEBUG(0, ("push_ucs2_allocate failed!\n"));
614                 return False;
615         }
616         status = is_valid_name(name_ucs2, False, False);
617         SAFE_FREE(name_ucs2);
618         return NT_STATUS_IS_OK(status);
619 }
620
621 /*****************************************************************************
622  * Convert a filename to DOS format.  Return True if successful.
623  *  Input:  in        Incoming name.
624  *
625  *          out       8.3 DOS name.
626  *
627  *          cache83 - If False, the mangled name cache will not be updated.
628  *                    This is usually used to prevent that we overwrite
629  *                    a conflicting cache entry prematurely, i.e. before
630  *                    we know whether the client is really interested in the
631  *                    current name.  (See PR#13758).  UKD.
632  *
633  * ****************************************************************************
634  */
635
636 static bool hash_name_to_8_3(const char *in,
637                         char out[13],
638                         bool cache83,
639                         int default_case,
640                         const struct share_params *p)
641 {
642         smb_ucs2_t *in_ucs2 = NULL;
643         size_t converted_size;
644         char magic_char;
645
646         magic_char = lp_magicchar(p);
647
648         DEBUG(5,("hash_name_to_8_3( %s, cache83 = %s)\n", in,
649                  cache83 ? "True" : "False"));
650
651         if (!push_ucs2_allocate(&in_ucs2, in, &converted_size)) {
652                 DEBUG(0, ("push_ucs2_allocate failed!\n"));
653                 return False;
654         }
655
656         /* If it's already 8.3, just copy. */
657         if (NT_STATUS_IS_OK(is_valid_name(in_ucs2, False, False)) &&
658                                 NT_STATUS_IS_OK(is_8_3_w(in_ucs2, False))) {
659                 SAFE_FREE(in_ucs2);
660                 safe_strcpy(out, in, 12);
661                 return True;
662         }
663
664         SAFE_FREE(in_ucs2);
665         if (!to_8_3(magic_char, in, out, default_case)) {
666                 return False;
667         }
668
669         cache_mangled_name(out, in);
670
671         DEBUG(5,("hash_name_to_8_3(%s) ==> [%s]\n", in, out));
672         return True;
673 }
674
675 /*
676   the following provides the abstraction layer to make it easier
677   to drop in an alternative mangling implementation
678 */
679 static const struct mangle_fns mangle_hash_fns = {
680         mangle_reset,
681         is_mangled,
682         must_mangle,
683         is_8_3,
684         lookup_name_from_8_3,
685         hash_name_to_8_3
686 };
687
688 /* return the methods for this mangling implementation */
689 const struct mangle_fns *mangle_hash_init(void)
690 {
691         mangle_reset();
692
693         /* Create the in-memory tdb using our custom hash function. */
694         tdb_mangled_cache = tdb_open_ex("mangled_cache", 1031, TDB_INTERNAL,
695                                 (O_RDWR|O_CREAT), 0644, NULL, fast_string_hash);
696
697         return &mangle_hash_fns;
698 }