Fix is_legal_name() to not emit character conversion error messages.
[samba.git] / source3 / smbd / mangle_hash2.c
index 7066c2a4e5c9ea9651dccb971ebdd5301bfa67d6..90d9498e5392de8428095125fdecbf36f6b91650 100644 (file)
   ===============================================================================
 */
 
+/*
+ * ============================================================================
+ * Whenever you change anything in the FLAG_ or other fields,
+ * re-initialize the tables char_flags and base_reverse by running the
+ * init_tables() routine once and dump its results. To do this, a
+ * single smbd run with
+ *
+ * #define DYNAMIC_MANGLE_TABLES 1
+ *
+ * and debug level 10 should be sufficient.
+ * ============================================================================
+ */
+
 
 #include "includes.h"
+#include "smbd/smbd.h"
+#include "smbd/globals.h"
+#include "memcache.h"
+#include "mangle.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
 
+#define FLAG_CHECK(c, flag) (char_flags[(unsigned char)(c)] & (flag))
+
+/* these are the characters we use in the 8.3 hash. Must be 36 chars long */
+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 * const reserved_names[] =
+{ "AUX", "LOCK$", "CON", "COM1", "COM2", "COM3", "COM4",
+  "LPT1", "LPT2", "LPT3", "NUL", "PRN", NULL };
+
+#define DYNAMIC_MANGLE_TABLES 0
+
+#if DYNAMIC_MANGLE_TABLES
+
 /* these tables are used to provide fast tests for characters */
 static unsigned char char_flags[256];
+static unsigned char base_reverse[256];
 
-#define FLAG_CHECK(c, flag) (char_flags[(unsigned char)(c)] & (flag))
+/* initialise the flags table
 
-/*
-  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.
+  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.
 */
-static unsigned mangle_prefix;
+static void init_tables(void)
+{
+       int i;
 
-/* we will use a very simple direct mapped prefix cache. The big
-   advantage of this cache structure is speed and low memory usage 
+       memset(char_flags, 0, sizeof(char_flags));
 
-   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 unsigned int *prefix_cache_hashes;
+       for (i=1;i<128;i++) {
+               if (i <= 0x1f) {
+                       /* Control characters. */
+                       char_flags[i] |= FLAG_ILLEGAL;
+               }
 
-/* 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];
-#define base_forward(v) basechars[v]
+               if ((i >= '0' && i <= '9') ||
+                   (i >= 'a' && i <= 'z') ||
+                   (i >= 'A' && i <= 'Z')) {
+                       char_flags[i] |=  (FLAG_ASCII | FLAG_BASECHAR);
+               }
+               if (strchr("_-$~", i)) {
+                       char_flags[i] |= FLAG_ASCII;
+               }
 
-/* the list of reserved dos names - all of these are illegal */
-static const char *reserved_names[] = 
-{ "AUX", "LOCK$", "CON", "COM1", "COM2", "COM3", "COM4",
-  "LPT1", "LPT2", "LPT3", "NUL", "PRN", NULL };
+               if (strchr("*\\/?<>|\":", i)) {
+                       char_flags[i] |= FLAG_ILLEGAL;
+               }
+
+               if (strchr("*?\"<>", i)) {
+                       char_flags[i] |= FLAG_WILDCARD;
+               }
+       }
+
+       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 */
+       for (i=0; reserved_names[i]; i++) {
+               unsigned char c1, c2, c3, c4;
+
+               c1 = (unsigned char)reserved_names[i][0];
+               c2 = (unsigned char)reserved_names[i][1];
+               c3 = (unsigned char)reserved_names[i][2];
+               c4 = (unsigned char)reserved_names[i][3];
+
+               char_flags[c1] |= FLAG_POSSIBLE1;
+               char_flags[c2] |= FLAG_POSSIBLE2;
+               char_flags[c3] |= FLAG_POSSIBLE3;
+               char_flags[c4] |= FLAG_POSSIBLE4;
+               char_flags[tolower_m(c1)] |= FLAG_POSSIBLE1;
+               char_flags[tolower_m(c2)] |= FLAG_POSSIBLE2;
+               char_flags[tolower_m(c3)] |= FLAG_POSSIBLE3;
+               char_flags[tolower_m(c4)] |= FLAG_POSSIBLE4;
+
+               char_flags[(unsigned char)'.'] |= FLAG_POSSIBLE4;
+       }
+
+#if 0
+       DEBUG(10, ("char_flags\n"));
+       dump_data(10, char_flags, sizeof(char_flags));
+
+       DEBUG(10, ("base_reverse\n"));
+       dump_data(10, base_reverse, sizeof(base_reverse));
+#endif
+}
+
+#else
+
+/*
+ * These tables were initialized by a single run of the above
+ * init_tables() routine, dumping the tables and a simple emacs macro.
+ *
+ * Technically we could leave out the 0's at the end of the array
+ * initializers, but I'll leave it in: less surprise.
+ */
+
+static uint8_t char_flags[256] = {
+       0x80, 0x04, 0x04, 0x04, 0x04, 0x04, 0x04, 0x04,
+       0x04, 0x04, 0x04, 0x04, 0x04, 0x04, 0x04, 0x04,
+       0x04, 0x04, 0x04, 0x04, 0x04, 0x04, 0x04, 0x04,
+       0x04, 0x04, 0x04, 0x04, 0x04, 0x04, 0x04, 0x04,
+       0x00, 0x00, 0x0C, 0x00, 0x02, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x0C, 0x00, 0x00, 0x02, 0x80, 0x04,
+       0x03, 0x83, 0x83, 0x83, 0x83, 0x03, 0x03, 0x03,
+       0x03, 0x03, 0x04, 0x00, 0x0C, 0x00, 0x0C, 0x0C,
+       0x00, 0x13, 0x03, 0x53, 0x03, 0x03, 0x03, 0x03,
+       0x03, 0x03, 0x03, 0x83, 0x53, 0x43, 0x53, 0x23,
+       0x33, 0x03, 0x23, 0x03, 0x43, 0x23, 0x03, 0x03,
+       0x43, 0x03, 0x03, 0x00, 0x04, 0x00, 0x00, 0x02,
+       0x00, 0x13, 0x03, 0x53, 0x03, 0x03, 0x03, 0x03,
+       0x03, 0x03, 0x03, 0x83, 0x53, 0x43, 0x53, 0x23,
+       0x33, 0x03, 0x23, 0x03, 0x43, 0x23, 0x03, 0x03,
+       0x43, 0x03, 0x03, 0x00, 0x04, 0x00, 0x02, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
+};
+
+static uint8_t base_reverse[256] = {
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
+       0x08, 0x09, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10,
+       0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18,
+       0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20,
+       0x21, 0x22, 0x23, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
+};
+
+#endif
 
 /* 
    hash a string of the specified length. The string does not need to be
@@ -147,57 +307,39 @@ static unsigned int 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(unsigned int, MANGLE_CACHE_SIZE);
-       if (!prefix_cache_hashes) {
-               SAFE_FREE(prefix_cache);
-               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, 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(unsigned int 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);
 }
 
 
@@ -287,12 +429,17 @@ static bool is_mangled(const char *name, const struct share_params *parm)
 
 
 /* 
-   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 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;
@@ -344,9 +491,18 @@ static bool is_8_3(const char *name, bool check_case, bool allow_wildcards, cons
 
        /* 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;
                }
        }
 
@@ -377,7 +533,7 @@ static bool lookup_name_from_8_3(TALLOC_CTX *ctx,
 {
        unsigned int hash, multiplier;
        unsigned int i;
-       const char *prefix;
+       char *prefix;
        char extension[4];
 
        *pp_out = NULL;
@@ -397,7 +553,7 @@ static bool lookup_name_from_8_3(TALLOC_CTX *ctx,
        }
 
        /* now look in the prefix cache for that hash */
-       prefix = cache_lookup(hash);
+       prefix = cache_lookup(ctx, hash);
        if (!prefix) {
                M_DEBUG(10,("lookup_name_from_8_3: %s -> %08X -> not found\n",
                                        name, hash));
@@ -421,7 +577,9 @@ static bool lookup_name_from_8_3(TALLOC_CTX *ctx,
                *pp_out = talloc_strdup(ctx, prefix);
        }
 
-       if (!pp_out) {
+       TALLOC_FREE(prefix);
+
+       if (!*pp_out) {
                M_DEBUG(0,("talloc_fail"));
                return False;
        }
@@ -468,7 +626,8 @@ static bool is_legal_name(const char *name)
        while (*name) {
                if (((unsigned int)name[0]) > 128 && (name[1] != 0)) {
                        /* Possible start of mb character. */
-                       char mbc[2];
+                       size_t size = 0;
+                       (void)next_codepoint(name, &size);
                        /*
                         * Note that if CH_UNIX is utf8 a string may be 3
                         * bytes, but this is ok as mb utf8 characters don't
@@ -476,9 +635,9 @@ static bool is_legal_name(const char *name)
                         * for mb UNIX asian characters like Japanese (SJIS) here.
                         * JRA.
                         */
-                       if (convert_string(CH_UNIX, CH_UTF16LE, name, 2, mbc, 2, False) == 2) {
-                               /* Was a good mb string. */
-                               name += 2;
+                       if (size > 1) {
+                               /* Was a mb string. */
+                               name += size;
                                continue;
                        }
                }
@@ -576,7 +735,7 @@ static bool hash2_name_to_8_3(const char *name,
                if (! FLAG_CHECK(lead_chars[i], FLAG_ASCII)) {
                        lead_chars[i] = '_';
                }
-               lead_chars[i] = toupper_ascii(lead_chars[i]);
+               lead_chars[i] = toupper_m(lead_chars[i]);
        }
        for (;i<mangle_prefix;i++) {
                lead_chars[i] = '_';
@@ -597,7 +756,7 @@ static bool hash2_name_to_8_3(const char *name,
                        char c = dot_p[i];
                        if (FLAG_CHECK(c, FLAG_ASCII)) {
                                extension[extension_length++] =
-                                       toupper_ascii(c);
+                                       toupper_m(c);
                        }
                }
        }
@@ -636,75 +795,10 @@ static bool hash2_name_to_8_3(const char *name,
        return True;
 }
 
-/* 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.
-*/
-static void init_tables(void)
-{
-       int i;
-
-       memset(char_flags, 0, sizeof(char_flags));
-
-       for (i=1;i<128;i++) {
-               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);
-               }
-               if (strchr("_-$~", i)) {
-                       char_flags[i] |= FLAG_ASCII;
-               }
-
-               if (strchr("*\\/?<>|\":", i)) {
-                       char_flags[i] |= FLAG_ILLEGAL;
-               }
-
-               if (strchr("*?\"<>", i)) {
-                       char_flags[i] |= FLAG_WILDCARD;
-               }
-       }
-
-       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 */
-       for (i=0; reserved_names[i]; i++) {
-               unsigned char c1, c2, c3, c4;
-
-               c1 = (unsigned char)reserved_names[i][0];
-               c2 = (unsigned char)reserved_names[i][1];
-               c3 = (unsigned char)reserved_names[i][2];
-               c4 = (unsigned char)reserved_names[i][3];
-
-               char_flags[c1] |= FLAG_POSSIBLE1;
-               char_flags[c2] |= FLAG_POSSIBLE2;
-               char_flags[c3] |= FLAG_POSSIBLE3;
-               char_flags[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,
@@ -714,7 +808,7 @@ static struct mangle_fns mangle_fns = {
 };
 
 /* 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();
@@ -725,14 +819,12 @@ struct mangle_fns *mangle_hash2_init(void)
                mangle_prefix = 1;
        }
 
+#if DYNAMIC_MANGLE_TABLES
        init_tables();
+#endif
        mangle_reset();
 
-       if (!cache_init()) {
-               return NULL;
-       }
-
-       return &mangle_fns;
+       return &mangle_hash2_fns;
 }
 
 static void posix_mangle_reset(void)
@@ -775,7 +867,7 @@ static bool posix_name_to_8_3(const char *in,
 }
 
 /* POSIX paths backend - no mangle. */
-static struct mangle_fns posix_mangle_fns = {
+static const struct mangle_fns posix_mangle_fns = {
        posix_mangle_reset,
        posix_is_mangled,
        posix_must_mangle,
@@ -784,7 +876,7 @@ static struct mangle_fns posix_mangle_fns = {
        posix_name_to_8_3
 };
 
-struct mangle_fns *posix_mangle_init(void)
+const struct mangle_fns *posix_mangle_init(void)
 {
        return &posix_mangle_fns;
 }