RIP BOOL. Convert BOOL -> bool. I found a few interesting
[sfrench/samba-autobuild/.git] / 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    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 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         size_t num_ucs2_chars;
162         NTSTATUS ret = NT_STATUS_OK;
163
164         if (!fname || !*fname)
165                 return NT_STATUS_INVALID_PARAMETER;
166
167         /* . and .. are valid names. */
168         if (strcmp_wa(fname, ".")==0 || strcmp_wa(fname, "..")==0)
169                 return NT_STATUS_OK;
170
171         if (only_8_3) {
172                 ret = has_valid_83_chars(fname, allow_wildcards);
173                 if (!NT_STATUS_IS_OK(ret))
174                         return ret;
175         }
176
177         ret = has_illegal_chars(fname, allow_wildcards);
178         if (!NT_STATUS_IS_OK(ret))
179                 return ret;
180
181         /* Name can't end in '.' or ' ' */
182         num_ucs2_chars = strlen_w(fname);
183         if (fname[num_ucs2_chars-1] == UCS2_CHAR('.') || fname[num_ucs2_chars-1] == UCS2_CHAR(' ')) {
184                 return NT_STATUS_UNSUCCESSFUL;
185         }
186
187         str = strdup_w(fname);
188
189         /* Truncate copy after the first dot. */
190         p = strchr_w(str, UCS2_CHAR('.'));
191         if (p) {
192                 *p = 0;
193         }
194
195         strupper_w(str);
196         p = &str[1];
197
198         switch(str[0])
199         {
200         case UCS2_CHAR('A'):
201                 if(strcmp_wa(p, "UX") == 0)
202                         ret = NT_STATUS_UNSUCCESSFUL;
203                 break;
204         case UCS2_CHAR('C'):
205                 if((strcmp_wa(p, "LOCK$") == 0)
206                 || (strcmp_wa(p, "ON") == 0)
207                 || (strcmp_wa(p, "OM1") == 0)
208                 || (strcmp_wa(p, "OM2") == 0)
209                 || (strcmp_wa(p, "OM3") == 0)
210                 || (strcmp_wa(p, "OM4") == 0)
211                 )
212                         ret = NT_STATUS_UNSUCCESSFUL;
213                 break;
214         case UCS2_CHAR('L'):
215                 if((strcmp_wa(p, "PT1") == 0)
216                 || (strcmp_wa(p, "PT2") == 0)
217                 || (strcmp_wa(p, "PT3") == 0)
218                 )
219                         ret = NT_STATUS_UNSUCCESSFUL;
220                 break;
221         case UCS2_CHAR('N'):
222                 if(strcmp_wa(p, "UL") == 0)
223                         ret = NT_STATUS_UNSUCCESSFUL;
224                 break;
225         case UCS2_CHAR('P'):
226                 if(strcmp_wa(p, "RN") == 0)
227                         ret = NT_STATUS_UNSUCCESSFUL;
228                 break;
229         default:
230                 break;
231         }
232
233         SAFE_FREE(str);
234         return ret;
235 }
236
237 static NTSTATUS is_8_3_w(const smb_ucs2_t *fname, bool allow_wildcards)
238 {
239         smb_ucs2_t *pref = 0, *ext = 0;
240         size_t plen;
241         NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
242
243         if (!fname || !*fname)
244                 return NT_STATUS_INVALID_PARAMETER;
245
246         if (strlen_w(fname) > 12)
247                 return NT_STATUS_UNSUCCESSFUL;
248
249         if (strcmp_wa(fname, ".") == 0 || strcmp_wa(fname, "..") == 0)
250                 return NT_STATUS_OK;
251
252         /* Name cannot start with '.' */
253         if (*fname == UCS2_CHAR('.'))
254                 return NT_STATUS_UNSUCCESSFUL;
255
256         if (!NT_STATUS_IS_OK(is_valid_name(fname, allow_wildcards, True)))
257                 goto done;
258
259         if (!NT_STATUS_IS_OK(mangle_get_prefix(fname, &pref, &ext, allow_wildcards)))
260                 goto done;
261         plen = strlen_w(pref);
262
263         if (strchr_wa(pref, '.'))
264                 goto done;
265         if (plen < 1 || plen > 8)
266                 goto done;
267         if (ext && (strlen_w(ext) > 3))
268                 goto done;
269
270         ret = NT_STATUS_OK;
271
272 done:
273         SAFE_FREE(pref);
274         SAFE_FREE(ext);
275         return ret;
276 }
277
278 static bool is_8_3(const char *fname, bool check_case, bool allow_wildcards,
279                    const struct share_params *p)
280 {
281         const char *f;
282         smb_ucs2_t *ucs2name;
283         NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
284         size_t size;
285
286         magic_char = lp_magicchar(p);
287
288         if (!fname || !*fname)
289                 return False;
290         if ((f = strrchr(fname, '/')) == NULL)
291                 f = fname;
292         else
293                 f++;
294
295         if (strlen(f) > 12)
296                 return False;
297
298         size = push_ucs2_allocate(&ucs2name, f);
299         if (size == (size_t)-1) {
300                 DEBUG(0,("is_8_3: internal error push_ucs2_allocate() failed!\n"));
301                 goto done;
302         }
303
304         ret = is_8_3_w(ucs2name, allow_wildcards);
305
306 done:
307         SAFE_FREE(ucs2name);
308
309         if (!NT_STATUS_IS_OK(ret)) {
310                 return False;
311         }
312
313         return True;
314 }
315
316 /* -------------------------------------------------------------------------- **
317  * Functions...
318  */
319
320 /* ************************************************************************** **
321  * Initialize the static character test array.
322  *
323  *  Input:  none
324  *
325  *  Output: none
326  *
327  *  Notes:  This function changes (loads) the contents of the <chartest>
328  *          array.  The scope of <chartest> is this file.
329  *
330  * ************************************************************************** **
331  */
332
333 static void init_chartest( void )
334 {
335         const unsigned char *s;
336
337         memset( (char *)chartest, '\0', 256 );
338
339         for( s = (const unsigned char *)basechars; *s; s++ ) {
340                 chartest[*s] |= BASECHAR_MASK;
341         }
342
343         ct_initialized = True;
344 }
345
346 /* ************************************************************************** **
347  * Return True if the name *could be* a mangled name.
348  *
349  *  Input:  s - A path name - in UNIX pathname format.
350  *
351  *  Output: True if the name matches the pattern described below in the
352  *          notes, else False.
353  *
354  *  Notes:  The input name is *not* tested for 8.3 compliance.  This must be
355  *          done separately.  This function returns true if the name contains
356  *          a magic character followed by excactly two characters from the
357  *          basechars list (above), which in turn are followed either by the
358  *          nul (end of string) byte or a dot (extension) or by a '/' (end of
359  *          a directory name).
360  *
361  * ************************************************************************** **
362  */
363
364 static bool is_mangled(const char *s, const struct share_params *p)
365 {
366         char *magic;
367
368         magic_char = lp_magicchar(p);
369
370         if( !ct_initialized )
371                 init_chartest();
372
373         magic = strchr_m( s, magic_char );
374         while( magic && magic[1] && magic[2] ) {         /* 3 chars, 1st is magic. */
375                 if( ('.' == magic[3] || '/' == magic[3] || !(magic[3]))          /* Ends with '.' or nul or '/' ?  */
376                                 && isbasechar( toupper_ascii(magic[1]) )           /* is 2nd char basechar?  */
377                                 && isbasechar( toupper_ascii(magic[2]) ) )         /* is 3rd char basechar?  */
378                         return( True );                           /* If all above, then true, */
379                 magic = strchr_m( magic+1, magic_char );      /*    else seek next magic. */
380         }
381         return( False );
382 }
383
384 /***************************************************************************
385  Initializes or clears the mangled cache.
386 ***************************************************************************/
387
388 static void mangle_reset( void )
389 {
390         /* We could close and re-open the tdb here... should we ? The old code did
391            the equivalent... JRA. */
392 }
393
394 /***************************************************************************
395  Add a mangled name into the cache.
396  If the extension of the raw name maps directly to the
397  extension of the mangled name, then we'll store both names
398  *without* extensions.  That way, we can provide consistent
399  reverse mangling for all names that match.  The test here is
400  a bit more careful than the one done in earlier versions of
401  mangle.c:
402
403     - the extension must exist on the raw name,
404     - it must be all lower case
405     - it must match the mangled extension (to prove that no
406       mangling occurred).
407   crh 07-Apr-1998
408 **************************************************************************/
409
410 static void cache_mangled_name( const char mangled_name[13],
411                                 const char *raw_name )
412 {
413         TDB_DATA data_val;
414         char mangled_name_key[13];
415         char *s1;
416         char *s2;
417
418         /* If the cache isn't initialized, give up. */
419         if( !tdb_mangled_cache )
420                 return;
421
422         /* Init the string lengths. */
423         safe_strcpy(mangled_name_key, mangled_name, sizeof(mangled_name_key)-1);
424
425         /* See if the extensions are unmangled.  If so, store the entry
426          * without the extension, thus creating a "group" reverse map.
427          */
428         s1 = strrchr( mangled_name_key, '.' );
429         if( s1 && (s2 = strrchr( raw_name, '.' )) ) {
430                 size_t i = 1;
431                 while( s1[i] && (tolower_ascii( s1[i] ) == s2[i]) )
432                         i++;
433                 if( !s1[i] && !s2[i] ) {
434                         /* Truncate at the '.' */
435                         *s1 = '\0';
436                         *s2 = '\0';
437                 }
438         }
439
440         /* Allocate a new cache entry.  If the allocation fails, just return. */
441         data_val = string_term_tdb_data(raw_name);
442         if (tdb_store_bystring(tdb_mangled_cache, mangled_name_key, data_val, TDB_REPLACE) != 0) {
443                 DEBUG(0,("cache_mangled_name: Error storing entry %s -> %s\n", mangled_name_key, raw_name));
444         } else {
445                 DEBUG(5,("cache_mangled_name: Stored entry %s -> %s\n", mangled_name_key, raw_name));
446         }
447 }
448
449 /* ************************************************************************** **
450  * Check for a name on the mangled name stack
451  *
452  *  Input:  s - Input *and* output string buffer.
453  *          maxlen - space in i/o string buffer.
454  *  Output: True if the name was found in the cache, else False.
455  *
456  *  Notes:  If a reverse map is found, the function will overwrite the string
457  *          space indicated by the input pointer <s>.  This is frightening.
458  *          It should be rewritten to return NULL if the long name was not
459  *          found, and a pointer to the long name if it was found.
460  *
461  * ************************************************************************** **
462  */
463
464 static bool lookup_name_from_8_3(TALLOC_CTX *ctx,
465                                 const char *in,
466                                 char **out, /* talloced on the given context. */
467                                 const struct share_params *p)
468 {
469         TDB_DATA data_val;
470         char *saved_ext = NULL;
471         char *s = talloc_strdup(ctx, in);
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(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         magic_char = lp_magicchar(p);
608
609         if (push_ucs2_allocate(&name_ucs2, name) == (size_t)-1) {
610                 DEBUG(0, ("push_ucs2_allocate failed!\n"));
611                 return False;
612         }
613         status = is_valid_name(name_ucs2, False, False);
614         SAFE_FREE(name_ucs2);
615         return NT_STATUS_IS_OK(status);
616 }
617
618 /*****************************************************************************
619  * Convert a filename to DOS format.  Return True if successful.
620  *  Input:  in        Incoming name.
621  *
622  *          out       8.3 DOS name.
623  *
624  *          cache83 - If False, the mangled name cache will not be updated.
625  *                    This is usually used to prevent that we overwrite
626  *                    a conflicting cache entry prematurely, i.e. before
627  *                    we know whether the client is really interested in the
628  *                    current name.  (See PR#13758).  UKD.
629  *
630  * ****************************************************************************
631  */
632
633 static bool hash_name_to_8_3(const char *in,
634                         char out[13],
635                         bool cache83,
636                         int default_case,
637                         const struct share_params *p)
638 {
639         smb_ucs2_t *in_ucs2 = NULL;
640         magic_char = lp_magicchar(p);
641
642         DEBUG(5,("hash_name_to_8_3( %s, cache83 = %s)\n", in,
643                  cache83 ? "True" : "False"));
644
645         if (push_ucs2_allocate(&in_ucs2, in) == (size_t)-1) {
646                 DEBUG(0, ("push_ucs2_allocate failed!\n"));
647                 return False;
648         }
649
650         /* If it's already 8.3, just copy. */
651         if (NT_STATUS_IS_OK(is_valid_name(in_ucs2, False, False)) &&
652                                 NT_STATUS_IS_OK(is_8_3_w(in_ucs2, False))) {
653                 SAFE_FREE(in_ucs2);
654                 safe_strcpy(out, in, 12);
655                 return True;
656         }
657
658         SAFE_FREE(in_ucs2);
659         if (!to_8_3(in, out, default_case)) {
660                 return False;
661         }
662
663         cache_mangled_name(out, in);
664
665         DEBUG(5,("hash_name_to_8_3(%s) ==> [%s]\n", in, out));
666         return True;
667 }
668
669 /*
670   the following provides the abstraction layer to make it easier
671   to drop in an alternative mangling implementation
672 */
673 static struct mangle_fns mangle_fns = {
674         mangle_reset,
675         is_mangled,
676         must_mangle,
677         is_8_3,
678         lookup_name_from_8_3,
679         hash_name_to_8_3
680 };
681
682 /* return the methods for this mangling implementation */
683 struct mangle_fns *mangle_hash_init(void)
684 {
685         mangle_reset();
686
687         /* Create the in-memory tdb using our custom hash function. */
688         tdb_mangled_cache = tdb_open_ex("mangled_cache", 1031, TDB_INTERNAL,
689                                 (O_RDWR|O_CREAT), 0644, NULL, fast_string_hash);
690
691         return &mangle_fns;
692 }