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