2 Unix SMB/CIFS implementation.
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
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.
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.
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/>.
24 #include "smbd/globals.h"
27 /* -------------------------------------------------------------------------- **
30 * magic_char - This is the magic char used for mangling. It's
31 * global. There is a call to lp_magicchar() in server.c
32 * that is used to override the initial value.
34 * MANGLE_BASE - This is the number of characters we use for name mangling.
36 * basechars - The set characters used for name mangling. This
37 * is static (scope is this file only).
39 * mangle() - Macro used to select a character from basechars (i.e.,
40 * mangle(n) will return the nth digit, modulo MANGLE_BASE).
42 * chartest - array 0..255. The index range is the set of all possible
43 * values of a byte. For each byte value, the content is a
44 * two nibble pair. See BASECHAR_MASK below.
46 * ct_initialized - False until the chartest array has been initialized via
47 * a call to init_chartest().
49 * BASECHAR_MASK - Masks the upper nibble of a one-byte value.
51 * isbasecahr() - Given a character, check the chartest array to see
52 * if that character is in the basechars set. This is
53 * faster than using strchr_m().
57 static const char basechars[43]="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_-!@#$%";
58 #define MANGLE_BASE (sizeof(basechars)/sizeof(char)-1)
60 #define mangle(V) ((char)(basechars[(V) % MANGLE_BASE]))
61 #define BASECHAR_MASK 0xf0
62 #define isbasechar(C) ( (chartest[ ((C) & 0xff) ]) & BASECHAR_MASK )
64 /* -------------------------------------------------------------------- */
66 static NTSTATUS has_valid_83_chars(const smb_ucs2_t *s, bool allow_wildcards)
69 return NT_STATUS_INVALID_PARAMETER;
72 if (!allow_wildcards && ms_has_wild_w(s)) {
73 return NT_STATUS_UNSUCCESSFUL;
77 if(!isvalid83_w(*s)) {
78 return NT_STATUS_UNSUCCESSFUL;
86 static NTSTATUS has_illegal_chars(const smb_ucs2_t *s, bool allow_wildcards)
88 if (!allow_wildcards && ms_has_wild_w(s)) {
89 return NT_STATUS_UNSUCCESSFUL;
94 /* Control characters. */
95 return NT_STATUS_UNSUCCESSFUL;
102 return NT_STATUS_UNSUCCESSFUL;
110 /* return False if something fail and
111 * return 2 alloced unicode strings that contain prefix and extension
114 static NTSTATUS mangle_get_prefix(const smb_ucs2_t *ucs2_string, smb_ucs2_t **prefix,
115 smb_ucs2_t **extension, bool allow_wildcards)
121 *prefix = strdup_w(ucs2_string);
123 return NT_STATUS_NO_MEMORY;
125 if ((p = strrchr_w(*prefix, UCS2_CHAR('.')))) {
126 ext_len = strlen_w(p+1);
127 if ((ext_len > 0) && (ext_len < 4) && (p != *prefix) &&
128 (NT_STATUS_IS_OK(has_valid_83_chars(p+1,allow_wildcards)))) /* check extension */ {
130 *extension = strdup_w(p+1);
133 return NT_STATUS_NO_MEMORY;
140 /* ************************************************************************** **
141 * Return NT_STATUS_UNSUCCESSFUL if a name is a special msdos reserved name.
142 * or contains illegal characters.
144 * Input: fname - String containing the name to be tested.
146 * Output: NT_STATUS_UNSUCCESSFUL, if the condition above is true.
148 * Notes: This is a static function called by is_8_3(), below.
150 * ************************************************************************** **
153 static NTSTATUS is_valid_name(const smb_ucs2_t *fname, bool allow_wildcards, bool only_8_3)
156 size_t num_ucs2_chars;
157 NTSTATUS ret = NT_STATUS_OK;
159 if (!fname || !*fname)
160 return NT_STATUS_INVALID_PARAMETER;
162 /* . and .. are valid names. */
163 if (strcmp_wa(fname, ".")==0 || strcmp_wa(fname, "..")==0)
167 ret = has_valid_83_chars(fname, allow_wildcards);
168 if (!NT_STATUS_IS_OK(ret))
172 ret = has_illegal_chars(fname, allow_wildcards);
173 if (!NT_STATUS_IS_OK(ret))
176 /* Name can't end in '.' or ' ' */
177 num_ucs2_chars = strlen_w(fname);
178 if (fname[num_ucs2_chars-1] == UCS2_CHAR('.') || fname[num_ucs2_chars-1] == UCS2_CHAR(' ')) {
179 return NT_STATUS_UNSUCCESSFUL;
182 str = strdup_w(fname);
184 /* Truncate copy after the first dot. */
185 p = strchr_w(str, UCS2_CHAR('.'));
196 if(strcmp_wa(p, "UX") == 0)
197 ret = NT_STATUS_UNSUCCESSFUL;
200 if((strcmp_wa(p, "LOCK$") == 0)
201 || (strcmp_wa(p, "ON") == 0)
202 || (strcmp_wa(p, "OM1") == 0)
203 || (strcmp_wa(p, "OM2") == 0)
204 || (strcmp_wa(p, "OM3") == 0)
205 || (strcmp_wa(p, "OM4") == 0)
207 ret = NT_STATUS_UNSUCCESSFUL;
210 if((strcmp_wa(p, "PT1") == 0)
211 || (strcmp_wa(p, "PT2") == 0)
212 || (strcmp_wa(p, "PT3") == 0)
214 ret = NT_STATUS_UNSUCCESSFUL;
217 if(strcmp_wa(p, "UL") == 0)
218 ret = NT_STATUS_UNSUCCESSFUL;
221 if(strcmp_wa(p, "RN") == 0)
222 ret = NT_STATUS_UNSUCCESSFUL;
232 static NTSTATUS is_8_3_w(const smb_ucs2_t *fname, bool allow_wildcards)
234 smb_ucs2_t *pref = 0, *ext = 0;
236 NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
238 if (!fname || !*fname)
239 return NT_STATUS_INVALID_PARAMETER;
241 if (strlen_w(fname) > 12)
242 return NT_STATUS_UNSUCCESSFUL;
244 if (strcmp_wa(fname, ".") == 0 || strcmp_wa(fname, "..") == 0)
247 /* Name cannot start with '.' */
248 if (*fname == UCS2_CHAR('.'))
249 return NT_STATUS_UNSUCCESSFUL;
251 if (!NT_STATUS_IS_OK(is_valid_name(fname, allow_wildcards, True)))
254 if (!NT_STATUS_IS_OK(mangle_get_prefix(fname, &pref, &ext, allow_wildcards)))
256 plen = strlen_w(pref);
258 if (strchr_wa(pref, '.'))
260 if (plen < 1 || plen > 8)
262 if (ext && (strlen_w(ext) > 3))
273 static bool is_8_3(const char *fname, bool check_case, bool allow_wildcards,
274 const struct share_params *p)
277 smb_ucs2_t *ucs2name;
278 NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
282 magic_char = lp_magicchar(p);
284 if (!fname || !*fname)
286 if ((f = strrchr(fname, '/')) == NULL)
294 if (!push_ucs2_talloc(NULL, &ucs2name, f, &size)) {
295 DEBUG(0,("is_8_3: internal error push_ucs2_talloc() failed!\n"));
299 ret = is_8_3_w(ucs2name, allow_wildcards);
302 TALLOC_FREE(ucs2name);
304 if (!NT_STATUS_IS_OK(ret)) {
311 /* -------------------------------------------------------------------------- **
315 /* ************************************************************************** **
316 * Initialize the static character test array.
322 * Notes: This function changes (loads) the contents of the <chartest>
323 * array. The scope of <chartest> is this file.
325 * ************************************************************************** **
328 static void init_chartest( void )
330 const unsigned char *s;
332 chartest = SMB_MALLOC_ARRAY(unsigned char, 256);
334 SMB_ASSERT(chartest != NULL);
335 memset(chartest, '\0', 256);
337 for( s = (const unsigned char *)basechars; *s; s++ ) {
338 chartest[*s] |= BASECHAR_MASK;
342 /* ************************************************************************** **
343 * Return True if the name *could be* a mangled name.
345 * Input: s - A path name - in UNIX pathname format.
347 * Output: True if the name matches the pattern described below in the
350 * Notes: The input name is *not* tested for 8.3 compliance. This must be
351 * done separately. This function returns true if the name contains
352 * a magic character followed by excactly two characters from the
353 * basechars list (above), which in turn are followed either by the
354 * nul (end of string) byte or a dot (extension) or by a '/' (end of
357 * ************************************************************************** **
360 static bool is_mangled(const char *s, const struct share_params *p)
365 magic_char = lp_magicchar(p);
367 if (chartest == NULL) {
371 magic = strchr_m( s, magic_char );
372 while( magic && magic[1] && magic[2] ) { /* 3 chars, 1st is magic. */
373 if( ('.' == magic[3] || '/' == magic[3] || !(magic[3])) /* Ends with '.' or nul or '/' ? */
374 && isbasechar( toupper_ascii(magic[1]) ) /* is 2nd char basechar? */
375 && isbasechar( toupper_ascii(magic[2]) ) ) /* is 3rd char basechar? */
376 return( True ); /* If all above, then true, */
377 magic = strchr_m( magic+1, magic_char ); /* else seek next magic. */
382 /***************************************************************************
383 Initializes or clears the mangled cache.
384 ***************************************************************************/
386 static void mangle_reset( void )
388 /* We could close and re-open the tdb here... should we ? The old code did
389 the equivalent... JRA. */
392 /***************************************************************************
393 Add a mangled name into the cache.
394 If the extension of the raw name maps directly to the
395 extension of the mangled name, then we'll store both names
396 *without* extensions. That way, we can provide consistent
397 reverse mangling for all names that match. The test here is
398 a bit more careful than the one done in earlier versions of
401 - the extension must exist on the raw name,
402 - it must be all lower case
403 - it must match the mangled extension (to prove that no
406 **************************************************************************/
408 static void cache_mangled_name( const char mangled_name[13],
409 const char *raw_name )
412 char mangled_name_key[13];
416 /* If the cache isn't initialized, give up. */
417 if( !tdb_mangled_cache )
420 /* Init the string lengths. */
421 safe_strcpy(mangled_name_key, mangled_name, sizeof(mangled_name_key)-1);
423 /* See if the extensions are unmangled. If so, store the entry
424 * without the extension, thus creating a "group" reverse map.
426 s1 = strrchr( mangled_name_key, '.' );
427 if( s1 && (s2 = strrchr( raw_name, '.' )) ) {
429 while( s1[i] && (tolower_ascii( s1[i] ) == s2[i]) )
431 if( !s1[i] && !s2[i] ) {
432 /* Truncate at the '.' */
435 * DANGER WILL ROBINSON - this
436 * is changing a const string via
437 * an aliased pointer ! Remember to
438 * put it back once we've used it.
445 /* Allocate a new cache entry. If the allocation fails, just return. */
446 data_val = string_term_tdb_data(raw_name);
447 if (tdb_store_bystring(tdb_mangled_cache, mangled_name_key, data_val, TDB_REPLACE) != 0) {
448 DEBUG(0,("cache_mangled_name: Error storing entry %s -> %s\n", mangled_name_key, raw_name));
450 DEBUG(5,("cache_mangled_name: Stored entry %s -> %s\n", mangled_name_key, raw_name));
452 /* Restore the change we made to the const string. */
458 /* ************************************************************************** **
459 * Check for a name on the mangled name stack
461 * Input: s - Input *and* output string buffer.
462 * maxlen - space in i/o string buffer.
463 * Output: True if the name was found in the cache, else False.
465 * Notes: If a reverse map is found, the function will overwrite the string
466 * space indicated by the input pointer <s>. This is frightening.
467 * It should be rewritten to return NULL if the long name was not
468 * found, and a pointer to the long name if it was found.
470 * ************************************************************************** **
473 static bool lookup_name_from_8_3(TALLOC_CTX *ctx,
475 char **out, /* talloced on the given context. */
476 const struct share_params *p)
479 char *saved_ext = NULL;
480 char *s = talloc_strdup(ctx, in);
483 magic_char = lp_magicchar(p);
485 /* If the cache isn't initialized, give up. */
486 if(!s || !tdb_mangled_cache ) {
491 data_val = tdb_fetch_bystring(tdb_mangled_cache, s);
493 /* If we didn't find the name *with* the extension, try without. */
494 if(data_val.dptr == NULL || data_val.dsize == 0) {
495 char *ext_start = strrchr( s, '.' );
497 if((saved_ext = talloc_strdup(ctx,ext_start)) == NULL) {
503 data_val = tdb_fetch_bystring(tdb_mangled_cache, s);
505 * At this point s is the name without the
506 * extension. We re-add the extension if saved_ext
507 * is not null, before freeing saved_ext.
512 /* Okay, if we haven't found it we're done. */
513 if(data_val.dptr == NULL || data_val.dsize == 0) {
514 TALLOC_FREE(saved_ext);
519 /* If we *did* find it, we need to talloc it on the given ctx. */
521 *out = talloc_asprintf(ctx, "%s%s",
522 (char *)data_val.dptr,
525 *out = talloc_strdup(ctx, (char *)data_val.dptr);
529 TALLOC_FREE(saved_ext);
530 SAFE_FREE(data_val.dptr);
532 return *out ? True : False;
535 /*****************************************************************************
536 Do the actual mangling to 8.3 format.
537 *****************************************************************************/
539 static bool to_8_3(char magic_char, const char *in, char out[13], int default_case)
547 char *s = SMB_STRDUP(in);
557 if( p && (strlen(p+1) < (size_t)4) ) {
558 bool all_normal = ( strisnormal(p+1, default_case) ); /* XXXXXXXXX */
560 if( all_normal && p[1] != 0 ) {
562 csum = str_checksum( s );
565 csum = str_checksum(s);
567 csum = str_checksum(s);
573 safe_strcpy( extension, "___", 3 );
576 while( *p && extlen < 3 ) {
578 extension[extlen++] = p[0];
582 extension[extlen] = 0;
588 while( *p && baselen < 5 ) {
589 if (isbasechar(*p)) {
590 base[baselen++] = p[0];
596 csum = csum % (MANGLE_BASE*MANGLE_BASE);
598 memcpy(out, base, baselen);
599 out[baselen] = magic_char;
600 out[baselen+1] = mangle( csum/MANGLE_BASE );
601 out[baselen+2] = mangle( csum );
604 out[baselen+3] = '.';
605 safe_strcpy(&out[baselen+4], extension, 3);
612 static bool must_mangle(const char *name,
613 const struct share_params *p)
615 smb_ucs2_t *name_ucs2 = NULL;
617 size_t converted_size;
620 magic_char = lp_magicchar(p);
622 if (!push_ucs2_talloc(NULL, &name_ucs2, name, &converted_size)) {
623 DEBUG(0, ("push_ucs2_talloc failed!\n"));
626 status = is_valid_name(name_ucs2, False, False);
627 TALLOC_FREE(name_ucs2);
628 /* We return true if we *must* mangle, so if it's
629 * a valid name (status == OK) then we must return
630 * false. Bug #6939. */
631 return !NT_STATUS_IS_OK(status);
634 /*****************************************************************************
635 * Convert a filename to DOS format. Return True if successful.
636 * Input: in Incoming name.
640 * cache83 - If False, the mangled name cache will not be updated.
641 * This is usually used to prevent that we overwrite
642 * a conflicting cache entry prematurely, i.e. before
643 * we know whether the client is really interested in the
644 * current name. (See PR#13758). UKD.
646 * ****************************************************************************
649 static bool hash_name_to_8_3(const char *in,
653 const struct share_params *p)
655 smb_ucs2_t *in_ucs2 = NULL;
656 size_t converted_size;
659 magic_char = lp_magicchar(p);
661 DEBUG(5,("hash_name_to_8_3( %s, cache83 = %s)\n", in,
662 cache83 ? "True" : "False"));
664 if (!push_ucs2_talloc(NULL, &in_ucs2, in, &converted_size)) {
665 DEBUG(0, ("push_ucs2_talloc failed!\n"));
669 /* If it's already 8.3, just copy. */
670 if (NT_STATUS_IS_OK(is_valid_name(in_ucs2, False, False)) &&
671 NT_STATUS_IS_OK(is_8_3_w(in_ucs2, False))) {
672 TALLOC_FREE(in_ucs2);
673 safe_strcpy(out, in, 12);
677 TALLOC_FREE(in_ucs2);
678 if (!to_8_3(magic_char, in, out, default_case)) {
682 cache_mangled_name(out, in);
684 DEBUG(5,("hash_name_to_8_3(%s) ==> [%s]\n", in, out));
689 the following provides the abstraction layer to make it easier
690 to drop in an alternative mangling implementation
692 static const struct mangle_fns mangle_hash_fns = {
697 lookup_name_from_8_3,
701 /* return the methods for this mangling implementation */
702 const struct mangle_fns *mangle_hash_init(void)
706 /* Create the in-memory tdb using our custom hash function. */
707 tdb_mangled_cache = tdb_open_ex("mangled_cache", 1031, TDB_INTERNAL,
708 (O_RDWR|O_CREAT), 0644, NULL, fast_string_hash);
710 return &mangle_hash_fns;