Make us pass SHORTNAME-TEST.
[ira/wip.git] / source3 / smbd / mangle_hash2.c
index 4896cfb17be86505531d1b2e3302075846d5c85e..b9e7d638726f19b016c8eecdcdd0fc26d9611b4c 100644 (file)
@@ -6,7 +6,7 @@
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
@@ -15,8 +15,7 @@
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 /*
@@ -52,6 +51,7 @@
 
 
 #include "includes.h"
+#include "smbd/globals.h"
 
 #if 1
 #define M_DEBUG(level, x) DEBUG(level, x)
 /*the following number is a fnv1 of the string: idra@samba.org 2002 */
 #define FNV1_INIT  0xa6b93095
 
-/* these tables are used to provide fast tests for characters */
-static unsigned char char_flags[256];
-
 #define FLAG_CHECK(c, flag) (char_flags[(unsigned char)(c)] & (flag))
 
-/*
-  this determines how many characters are used from the original filename
-  in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
-  The largest possible value is 6.
-*/
-static unsigned mangle_prefix;
-
-/* we will use a very simple direct mapped prefix cache. The big
-   advantage of this cache structure is speed and low memory usage 
-
-   The cache is indexed by the low-order bits of the hash, and confirmed by
-   hashing the resulting cache entry to match the known hash
-*/
-static char **prefix_cache;
-static u32 *prefix_cache_hashes;
-
 /* these are the characters we use in the 8.3 hash. Must be 36 chars long */
-static const char *basechars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
-static unsigned char base_reverse[256];
+static const char basechars[36] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
 #define base_forward(v) basechars[v]
 
 /* the list of reserved dos names - all of these are illegal */
-static const char *reserved_names[] = 
+static const char * const reserved_names[] =
 { "AUX", "LOCK$", "CON", "COM1", "COM2", "COM3", "COM4",
   "LPT1", "LPT2", "LPT3", "NUL", "PRN", NULL };
 
@@ -119,10 +99,10 @@ static const char *reserved_names[] =
 
    this hash needs to be fast with a low collision rate (what hash doesn't?)
 */
-static u32 mangle_hash(const char *key, unsigned int length)
+static unsigned int mangle_hash(const char *key, unsigned int length)
 {
-       u32 value;
-       u32   i;
+       unsigned int value;
+       unsigned int   i;
        fstring str;
 
        /* we have to uppercase here to ensure that the mangled name
@@ -139,8 +119,8 @@ static u32 mangle_hash(const char *key, unsigned int length)
 
        /* Set the initial value from the key size. */
        for (value = FNV1_INIT, i=0; i < length; i++) {
-                value *= (u32)FNV1_PRIME;
-                value ^= (u32)(str[i]);
+                value *= (unsigned int)FNV1_PRIME;
+                value ^= (unsigned int)(str[i]);
         }
 
        /* note that we force it to a 31 bit hash, to keep within the limits
@@ -148,56 +128,39 @@ static u32 mangle_hash(const char *key, unsigned int length)
        return value & ~0x80000000;  
 }
 
-/* 
-   initialise (ie. allocate) the prefix cache
- */
-static BOOL cache_init(void)
-{
-       if (prefix_cache) {
-               return True;
-       }
-
-       prefix_cache = SMB_CALLOC_ARRAY(char *,MANGLE_CACHE_SIZE);
-       if (!prefix_cache) {
-               return False;
-       }
-
-       prefix_cache_hashes = SMB_CALLOC_ARRAY(u32, MANGLE_CACHE_SIZE);
-       if (!prefix_cache_hashes) {
-               return False;
-       }
-
-       return True;
-}
-
 /*
   insert an entry into the prefix cache. The string might not be null
   terminated */
-static void cache_insert(const char *prefix, int length, u32 hash)
+static void cache_insert(const char *prefix, int length, unsigned int hash)
 {
-       int i = hash % MANGLE_CACHE_SIZE;
+       char *str = SMB_STRNDUP(prefix, length);
 
-       if (prefix_cache[i]) {
-               free(prefix_cache[i]);
+       if (str == NULL) {
+               return;
        }
 
-       prefix_cache[i] = SMB_STRNDUP(prefix, length);
-       prefix_cache_hashes[i] = hash;
+       memcache_add(smbd_memcache(), MANGLE_HASH2_CACHE,
+                    data_blob_const(&hash, sizeof(hash)),
+                    data_blob_const(str, length+1));
+       SAFE_FREE(str);
 }
 
 /*
   lookup an entry in the prefix cache. Return NULL if not found.
 */
-static const char *cache_lookup(u32 hash)
+static char *cache_lookup(TALLOC_CTX *mem_ctx, unsigned int hash)
 {
-       int i = hash % MANGLE_CACHE_SIZE;
+       DATA_BLOB value;
 
-       if (!prefix_cache[i] || hash != prefix_cache_hashes[i]) {
+       if (!memcache_lookup(smbd_memcache(), MANGLE_HASH2_CACHE,
+                            data_blob_const(&hash, sizeof(hash)), &value)) {
                return NULL;
        }
 
-       /* yep, it matched */
-       return prefix_cache[i];
+       SMB_ASSERT((value.length > 0)
+                  && (value.data[value.length-1] == '\0'));
+
+       return talloc_strdup(mem_ctx, (char *)value.data);
 }
 
 
@@ -208,11 +171,11 @@ static const char *cache_lookup(u32 hash)
    In this algorithm, mangled names use only pure ascii characters (no
    multi-byte) so we can avoid doing a UCS2 conversion 
  */
-static BOOL is_mangled_component(const char *name, size_t len)
+static bool is_mangled_component(const char *name, size_t len)
 {
        unsigned int i;
 
-       M_DEBUG(10,("is_mangled_component %s (len %u) ?\n", name, (unsigned int)len));
+       M_DEBUG(10,("is_mangled_component %s (len %lu) ?\n", name, (unsigned long)len));
 
        /* check the length */
        if (len > 12 || len < 8)
@@ -250,7 +213,7 @@ static BOOL is_mangled_component(const char *name, size_t len)
                }
        }
 
-       M_DEBUG(10,("is_mangled_component %s (len %u) -> yes\n", name, (unsigned int)len));
+       M_DEBUG(10,("is_mangled_component %s (len %lu) -> yes\n", name, (unsigned long)len));
 
        return True;
 }
@@ -268,7 +231,7 @@ static BOOL is_mangled_component(const char *name, size_t len)
    directory separators. It should return true if any component is
    mangled
  */
-static BOOL is_mangled(const char *name)
+static bool is_mangled(const char *name, const struct share_params *parm)
 {
        const char *p;
        const char *s;
@@ -287,13 +250,18 @@ static BOOL is_mangled(const char *name)
 
 
 /* 
-   see if a filename is an allowable 8.3 name.
+   see if a filename is an allowable 8.3 name to return to the client.
+   Note this is not testing if this is a valid Samba mangled name, so
+   the rules are different for is_mangled.
 
    we are only going to allow ascii characters in 8.3 names, as this
    simplifies things greatly (it means that we know the string won't
    get larger when converted from UNIX to DOS formats)
 */
-static BOOL is_8_3(const char *name, BOOL check_case, BOOL allow_wildcards)
+
+static char force_shortname_chars[] = " +,[];=";
+
+static bool is_8_3(const char *name, bool check_case, bool allow_wildcards, const struct share_params *p)
 {
        int len, i;
        char *dot_p;
@@ -344,9 +312,18 @@ static BOOL is_8_3(const char *name, BOOL check_case, BOOL allow_wildcards)
 
        /* the length are all OK. Now check to see if the characters themselves are OK */
        for (i=0; name[i]; i++) {
+               if (FLAG_CHECK(name[i], FLAG_ILLEGAL)) {
+                       return false;
+               }
                /* note that we may allow wildcard petterns! */
-               if (!FLAG_CHECK(name[i], FLAG_ASCII|(allow_wildcards ? FLAG_WILDCARD : 0)) && name[i] != '.') {
-                       return False;
+               if (!allow_wildcards && FLAG_CHECK(name[i], FLAG_WILDCARD)) {
+                       return false;
+               }
+               if (((unsigned char)name[i]) > 0x7e) {
+                       return false;
+               }
+               if (strchr(force_shortname_chars, name[i])) {
+                       return false;
                }
        }
 
@@ -368,33 +345,39 @@ static void mangle_reset(void)
 
 /*
   try to find a 8.3 name in the cache, and if found then
-  replace the string with the original long name. 
+  replace the string with the original long name.
 */
-static BOOL check_cache(char *name, size_t maxlen)
+static bool lookup_name_from_8_3(TALLOC_CTX *ctx,
+                       const char *name,
+                       char **pp_out, /* talloced on the given context. */
+                       const struct share_params *p)
 {
-       u32 hash, multiplier;
+       unsigned int hash, multiplier;
        unsigned int i;
-       const char *prefix;
+       char *prefix;
        char extension[4];
 
+       *pp_out = NULL;
+
        /* make sure that this is a mangled name from this cache */
-       if (!is_mangled(name)) {
-               M_DEBUG(10,("check_cache: %s -> not mangled\n", name));
+       if (!is_mangled(name, p)) {
+               M_DEBUG(10,("lookup_name_from_8_3: %s -> not mangled\n", name));
                return False;
        }
 
        /* we need to extract the hash from the 8.3 name */
        hash = base_reverse[(unsigned char)name[7]];
        for (multiplier=36, i=5;i>=mangle_prefix;i--) {
-               u32 v = base_reverse[(unsigned char)name[i]];
+               unsigned int v = base_reverse[(unsigned char)name[i]];
                hash += multiplier * v;
                multiplier *= 36;
        }
 
        /* now look in the prefix cache for that hash */
-       prefix = cache_lookup(hash);
+       prefix = cache_lookup(ctx, hash);
        if (!prefix) {
-               M_DEBUG(10,("check_cache: %s -> %08X -> not found\n", name, hash));
+               M_DEBUG(10,("lookup_name_from_8_3: %s -> %08X -> not found\n",
+                                       name, hash));
                return False;
        }
 
@@ -407,21 +390,28 @@ static BOOL check_cache(char *name, size_t maxlen)
        }
 
        if (extension[0]) {
-               M_DEBUG(10,("check_cache: %s -> %s.%s\n", name, prefix, extension));
-               slprintf(name, maxlen, "%s.%s", prefix, extension);
+               M_DEBUG(10,("lookup_name_from_8_3: %s -> %s.%s\n",
+                                       name, prefix, extension));
+               *pp_out = talloc_asprintf(ctx, "%s.%s", prefix, extension);
        } else {
-               M_DEBUG(10,("check_cache: %s -> %s\n", name, prefix));
-               safe_strcpy(name, prefix, maxlen);
+               M_DEBUG(10,("lookup_name_from_8_3: %s -> %s\n", name, prefix));
+               *pp_out = talloc_strdup(ctx, prefix);
+       }
+
+       TALLOC_FREE(prefix);
+
+       if (!*pp_out) {
+               M_DEBUG(0,("talloc_fail"));
+               return False;
        }
 
        return True;
 }
 
-
 /*
   look for a DOS reserved name
 */
-static BOOL is_reserved_name(const char *name)
+static bool is_reserved_name(const char *name)
 {
        if (FLAG_CHECK(name[0], FLAG_POSSIBLE1) &&
            FLAG_CHECK(name[1], FLAG_POSSIBLE2) &&
@@ -445,12 +435,13 @@ static BOOL is_reserved_name(const char *name)
 /*
  See if a filename is a legal long filename.
  A filename ending in a '.' is not legal unless it's "." or "..". JRA.
+ A filename ending in ' ' is not legal either. See bug id #2769.
 */
 
-static BOOL is_legal_name(const char *name)
+static bool is_legal_name(const char *name)
 {
        const char *dot_pos = NULL;
-       BOOL alldots = True;
+       bool alldots = True;
        size_t numdots = 0;
 
        while (*name) {
@@ -464,7 +455,7 @@ static BOOL is_legal_name(const char *name)
                         * for mb UNIX asian characters like Japanese (SJIS) here.
                         * JRA.
                         */
-                       if (convert_string(CH_UNIX, CH_UCS2, name, 2, mbc, 2, False) == 2) {
+                       if (convert_string(CH_UNIX, CH_UTF16LE, name, 2, mbc, 2, False) == 2) {
                                /* Was a good mb string. */
                                name += 2;
                                continue;
@@ -480,6 +471,10 @@ static BOOL is_legal_name(const char *name)
                } else {
                        alldots = False;
                }
+               if ((name[0] == ' ') && (name[1] == '\0')) {
+                       /* Can't end in ' ' */
+                       return False;
+               }
                name++;
        }
 
@@ -491,43 +486,45 @@ static BOOL is_legal_name(const char *name)
                if (dot_pos[1] == '\0')
                        return False;
        }
-
        return True;
 }
 
+static bool must_mangle(const char *name,
+                       const struct share_params *p)
+{
+       if (is_reserved_name(name)) {
+               return True;
+       }
+       return !is_legal_name(name);
+}
+
 /*
   the main forward mapping function, which converts a long filename to 
   a 8.3 name
 
-  if need83 is not set then we only do the mangling if the name is illegal
-  as a long name
-
   if cache83 is not set then we don't cache the result
 
-  the name parameter must be able to hold 13 bytes
 */
-static void name_map(fstring name, BOOL need83, BOOL cache83, int default_case)
+static bool hash2_name_to_8_3(const char *name,
+                       char new_name[13],
+                       bool cache83,
+                       int default_case,
+                       const struct share_params *p)
 {
        char *dot_p;
        char lead_chars[7];
        char extension[4];
        unsigned int extension_length, i;
        unsigned int prefix_len;
-       u32 hash, v;
-       char new_name[13];
+       unsigned int hash, v;
 
        /* reserved names are handled specially */
        if (!is_reserved_name(name)) {
-               /* if the name is already a valid 8.3 name then we don't need to 
-                  do anything */
-               if (is_8_3(name, False, False)) {
-                       return;
-               }
-
-               /* if the caller doesn't strictly need 8.3 then just check for illegal 
-                  filenames */
-               if (!need83 && is_legal_name(name)) {
-                       return;
+               /* if the name is already a valid 8.3 name then we don't need to
+                * change anything */
+               if (is_legal_name(name) && is_8_3(name, False, False, p)) {
+                       safe_strcpy(new_name, name, 12);
+                       return True;
                }
        }
 
@@ -544,7 +541,9 @@ static void name_map(fstring name, BOOL need83, BOOL cache83, int default_case)
                                break;
                        }
                }
-               if (i == 0 || i == 4) dot_p = NULL;
+               if (i == 0 || i == 4) {
+                       dot_p = NULL;
+               }
        }
 
        /* the leading characters in the mangled name is taken from
@@ -556,7 +555,7 @@ static void name_map(fstring name, BOOL need83, BOOL cache83, int default_case)
                if (! FLAG_CHECK(lead_chars[i], FLAG_ASCII)) {
                        lead_chars[i] = '_';
                }
-               lead_chars[i] = toupper(lead_chars[i]);
+               lead_chars[i] = toupper_ascii(lead_chars[i]);
        }
        for (;i<mangle_prefix;i++) {
                lead_chars[i] = '_';
@@ -576,11 +575,12 @@ static void name_map(fstring name, BOOL need83, BOOL cache83, int default_case)
                for (i=1; extension_length < 3 && dot_p[i]; i++) {
                        char c = dot_p[i];
                        if (FLAG_CHECK(c, FLAG_ASCII)) {
-                               extension[extension_length++] = toupper(c);
+                               extension[extension_length++] =
+                                       toupper_ascii(c);
                        }
                }
        }
-          
+
        /* find the hash for this prefix */
        v = hash = mangle_hash(name, prefix_len);
 
@@ -589,7 +589,7 @@ static void name_map(fstring name, BOOL need83, BOOL cache83, int default_case)
                new_name[i] = lead_chars[i];
        }
        new_name[7] = base_forward(v % 36);
-       new_name[6] = '~';      
+       new_name[6] = '~';
        for (i=5; i>=mangle_prefix; i--) {
                v = v / 36;
                new_name[i] = base_forward(v % 36);
@@ -609,22 +609,18 @@ static void name_map(fstring name, BOOL need83, BOOL cache83, int default_case)
                cache_insert(name, prefix_len, hash);
        }
 
-       M_DEBUG(10,("name_map: %s -> %08X -> %s (cache=%d)\n", 
+       M_DEBUG(10,("hash2_name_to_8_3: %s -> %08X -> %s (cache=%d)\n",
                   name, hash, new_name, cache83));
 
-       /* and overwrite the old name */
-       fstrcpy(name, new_name);
-
-       /* all done, we've managed to mangle it */
+       return True;
 }
 
-
-/* initialise the flags table 
+/* initialise the flags table
 
   we allow only a very restricted set of characters as 'ascii' in this
   mangling backend. This isn't a significant problem as modern clients
   use the 'long' filenames anyway, and those don't have these
-  restrictions. 
+  restrictions.
 */
 static void init_tables(void)
 {
@@ -633,8 +629,13 @@ static void init_tables(void)
        memset(char_flags, 0, sizeof(char_flags));
 
        for (i=1;i<128;i++) {
-               if ((i >= '0' && i <= '9') || 
-                   (i >= 'a' && i <= 'z') || 
+               if (i <= 0x1f) {
+                       /* Control characters. */
+                       char_flags[i] |= FLAG_ILLEGAL;
+               }
+
+               if ((i >= '0' && i <= '9') ||
+                   (i >= 'a' && i <= 'z') ||
                    (i >= 'A' && i <= 'Z')) {
                        char_flags[i] |=  (FLAG_ASCII | FLAG_BASECHAR);
                }
@@ -654,7 +655,7 @@ static void init_tables(void)
        memset(base_reverse, 0, sizeof(base_reverse));
        for (i=0;i<36;i++) {
                base_reverse[(unsigned char)base_forward(i)] = i;
-       }       
+       }
 
        /* fill in the reserved names flags. These are used as a very
           fast filter for finding possible DOS reserved filenames */
@@ -670,29 +671,29 @@ static void init_tables(void)
                char_flags[c2] |= FLAG_POSSIBLE2;
                char_flags[c3] |= FLAG_POSSIBLE3;
                char_flags[c4] |= FLAG_POSSIBLE4;
-               char_flags[tolower(c1)] |= FLAG_POSSIBLE1;
-               char_flags[tolower(c2)] |= FLAG_POSSIBLE2;
-               char_flags[tolower(c3)] |= FLAG_POSSIBLE3;
-               char_flags[tolower(c4)] |= FLAG_POSSIBLE4;
+               char_flags[tolower_ascii(c1)] |= FLAG_POSSIBLE1;
+               char_flags[tolower_ascii(c2)] |= FLAG_POSSIBLE2;
+               char_flags[tolower_ascii(c3)] |= FLAG_POSSIBLE3;
+               char_flags[tolower_ascii(c4)] |= FLAG_POSSIBLE4;
 
                char_flags[(unsigned char)'.'] |= FLAG_POSSIBLE4;
        }
 }
 
-
 /*
   the following provides the abstraction layer to make it easier
   to drop in an alternative mangling implementation */
-static struct mangle_fns mangle_fns = {
+static const struct mangle_fns mangle_hash2_fns = {
+       mangle_reset,
        is_mangled,
+       must_mangle,
        is_8_3,
-       mangle_reset,
-       check_cache,
-       name_map
+       lookup_name_from_8_3,
+       hash2_name_to_8_3
 };
 
 /* return the methods for this mangling implementation */
-struct mangle_fns *mangle_hash2_init(void)
+const struct mangle_fns *mangle_hash2_init(void)
 {
        /* the mangle prefix can only be in the mange 1 to 6 */
        mangle_prefix = lp_mangle_prefix();
@@ -706,9 +707,59 @@ struct mangle_fns *mangle_hash2_init(void)
        init_tables();
        mangle_reset();
 
-       if (!cache_init()) {
-               return NULL;
-       }
+       return &mangle_hash2_fns;
+}
+
+static void posix_mangle_reset(void)
+{;}
 
-       return &mangle_fns;
+static bool posix_is_mangled(const char *s, const struct share_params *p)
+{
+       return False;
+}
+
+static bool posix_must_mangle(const char *s, const struct share_params *p)
+{
+       return False;
+}
+
+static bool posix_is_8_3(const char *fname,
+                       bool check_case,
+                       bool allow_wildcards,
+                       const struct share_params *p)
+{
+       return False;
+}
+
+static bool posix_lookup_name_from_8_3(TALLOC_CTX *ctx,
+                               const char *in,
+                               char **out, /* talloced on the given context. */
+                               const struct share_params *p)
+{
+       return False;
+}
+
+static bool posix_name_to_8_3(const char *in,
+                               char out[13],
+                               bool cache83,
+                               int default_case,
+                               const struct share_params *p)
+{
+       memset(out, '\0', 13);
+       return True;
+}
+
+/* POSIX paths backend - no mangle. */
+static const struct mangle_fns posix_mangle_fns = {
+       posix_mangle_reset,
+       posix_is_mangled,
+       posix_must_mangle,
+       posix_is_8_3,
+       posix_lookup_name_from_8_3,
+       posix_name_to_8_3
+};
+
+const struct mangle_fns *posix_mangle_init(void)
+{
+       return &posix_mangle_fns;
 }