Make smb_bytes_push_str deal with a NULL buf returning NULL
[nivanova/samba-autobuild/.git] / source3 / libsmb / namecache.c
index d3541b7719d9a991ea030c89406f0415936d96e6..ba706e5ee26488c7ea533a1db7bfec03550e1c0d 100644 (file)
@@ -1,45 +1,44 @@
-/* 
+/*
    Unix SMB/CIFS implementation.
 
    NetBIOS name cache module on top of gencache mechanism.
-   
+
    Copyright (C) Tim Potter         2002
    Copyright (C) Rafal Szczesniak   2002
-   
+   Copyright (C) Jeremy Allison     2007
+
    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,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    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/>.
 */
 
 #include "includes.h"
 
 #define NBTKEY_FMT  "NBT/%s#%02X"
 
-
 /**
  * Initialise namecache system. Function calls gencache
  * initialisation function to perform necessary actions
- * 
+ *
  * @return true upon successful initialisation of the cache or
  *         false on failure
  **/
 
-BOOL namecache_enable(void)
+bool namecache_enable(void)
 {
        /*
         * Check if name caching disabled by setting the name cache
         * timeout to zero.
-        */ 
+        */
 
        if (lp_name_cache_timeout() == 0) {
                DEBUG(5, ("namecache_enable: disabling netbios name cache\n"));
@@ -49,18 +48,19 @@ BOOL namecache_enable(void)
        /* Init namecache by calling gencache initialisation */
 
        if (!gencache_init()) {
-               DEBUG(2, ("namecache_enable: Couldn't initialise namecache on top of gencache.\n"));
+               DEBUG(2, ("namecache_enable: "
+                       "Couldn't initialise namecache on top of gencache.\n"));
                return False;
        }
 
-       /* I leave it for now, though I don't think we really need this (mimir, 27.09.2002) */
+       /* I leave it for now, though I don't think we really
+        * need this (mimir, 27.09.2002) */
        DEBUG(5, ("namecache_enable: enabling netbios namecache, timeout %d "
                  "seconds\n", lp_name_cache_timeout()));
 
        return True;
 }
 
-
 /**
  * Shutdown namecache. Routine calls gencache close function
  * to safely close gencache file.
@@ -68,19 +68,20 @@ BOOL namecache_enable(void)
  * @return true upon successful shutdown of the cache or
  *         false on failure
  **/
-BOOL namecache_shutdown(void)
+
+bool namecache_shutdown(void)
 {
        if (!gencache_shutdown()) {
-               DEBUG(2, ("namecache_shutdown: Couldn't close namecache on top of gencache.\n"));
+               DEBUG(2, ("namecache_shutdown: "
+                       "Couldn't close namecache on top of gencache.\n"));
                return False;
        }
-       
-       DEBUG(5, ("namecache_shutdown: netbios namecache closed successfully.\n"));
+
+       DEBUG(5, ("namecache_shutdown: "
+               "netbios namecache closed successfully.\n"));
        return True;
 }
 
-
 /**
  * Generates a key for netbios name lookups on basis of
  * netbios name and type.
@@ -93,15 +94,15 @@ BOOL namecache_shutdown(void)
  *         type number
  */
 
-static char* namecache_key(const char *name, int name_type)
+static char* namecache_key(const char *name,
+                               int name_type)
 {
        char *keystr;
-       asprintf(&keystr, NBTKEY_FMT, strupper_static(name), name_type);
+       asprintf_strupper_m(&keystr, NBTKEY_FMT, name, name_type);
 
        return keystr;
 }
 
-
 /**
  * Store a name(s) in the name cache
  *
@@ -112,41 +113,55 @@ static char* namecache_key(const char *name, int name_type)
  *        ip addresses being stored
  **/
 
-BOOL namecache_store(const char *name, int name_type,
-                     int num_names, struct in_addr *ip_list)
+bool namecache_store(const char *name,
+                       int name_type,
+                       int num_names,
+                       struct ip_service *ip_list)
 {
        time_t expiry;
        char *key, *value_string;
        int i;
-       BOOL ret;
+       bool ret;
 
        /*
         * we use gecache call to avoid annoying debug messages about
         * initialised namecache again and again...
         */
-       if (!gencache_init()) return False;
-
-       DEBUG(5, ("namecache_store: storing %d address%s for %s#%02x: ",
-                 num_names, num_names == 1 ? "": "es", name, name_type));
+       if (!gencache_init()) {
+               return False;
+       }
 
-       for (i = 0; i < num_names; i++) 
-               DEBUGADD(5, ("%s%s", inet_ntoa(ip_list[i]),
-                            i == (num_names - 1) ? "" : ", "));
+       if (name_type > 255) {
+               return False; /* Don't store non-real name types. */
+       }
 
-       DEBUGADD(5, ("\n"));
+       if ( DEBUGLEVEL >= 5 ) {
+               TALLOC_CTX *ctx = talloc_stackframe();
+               char *addr = NULL;
+
+               DEBUG(5, ("namecache_store: storing %d address%s for %s#%02x: ",
+                       num_names, num_names == 1 ? "": "es", name, name_type));
+
+               for (i = 0; i < num_names; i++) {
+                       addr = print_canonical_sockaddr(ctx,
+                                                       &ip_list[i].ss);
+                       if (!addr) {
+                               continue;
+                       }
+                       DEBUGADD(5, ("%s%s", addr,
+                               (i == (num_names - 1) ? "" : ",")));
+
+               }
+               DEBUGADD(5, ("\n"));
+               TALLOC_FREE(ctx);
+       }
 
        key = namecache_key(name, name_type);
+       if (!key) {
+               return False;
+       }
 
-       /* 
-        * Cache pdc location or dc lists for only a little while
-        * otherwise if we lock on to a bad DC we can potentially be
-        * out of action for the entire cache timeout time!
-        */
-
-       if (name_type == 0x1b || name_type == 0x1c)
-               expiry = time(NULL) + 10;
-       else
-               expiry = time(NULL) + lp_name_cache_timeout();
+       expiry = time(NULL) + lp_name_cache_timeout();
 
        /*
         * Generate string representation of ip addresses list
@@ -156,9 +171,9 @@ BOOL namecache_store(const char *name, int name_type,
        if (!ipstr_list_make(&value_string, ip_list, num_names)) {
                SAFE_FREE(key);
                SAFE_FREE(value_string);
-               return False;
+               return false;
        }
-       
+
        /* set the entry */
        ret = gencache_set(key, value_string, expiry);
        SAFE_FREE(key);
@@ -166,7 +181,6 @@ BOOL namecache_store(const char *name, int name_type,
        return ret;
 }
 
-
 /**
  * Look up a name in the cache.
  *
@@ -180,24 +194,36 @@ BOOL namecache_store(const char *name, int name_type,
  *         false if name isn't found in the cache or has expired
  **/
 
-BOOL namecache_fetch(const char *name, int name_type, struct in_addr **ip_list,
-                     int *num_names)
+bool namecache_fetch(const char *name,
+                       int name_type,
+                       struct ip_service **ip_list,
+                       int *num_names)
 {
        char *key, *value;
        time_t timeout;
 
-       *num_names = 0;
-
        /* exit now if null pointers were passed as they're required further */
-       if (!ip_list || !num_names) return False;
+       if (!ip_list || !num_names) {
+               return False;
+       }
 
-       if (!gencache_init())
+       if (!gencache_init()) {
                return False;
+       }
+
+       if (name_type > 255) {
+               return False; /* Don't fetch non-real name types. */
+       }
 
-       /* 
+       *num_names = 0;
+
+       /*
         * Use gencache interface - lookup the key
         */
        key = namecache_key(name, name_type);
+       if (!key) {
+               return False;
+       }
 
        if (!gencache_get(key, &value, &timeout)) {
                DEBUG(5, ("no entry for %s#%02X found.\n", name, name_type));
@@ -206,17 +232,43 @@ BOOL namecache_fetch(const char *name, int name_type, struct in_addr **ip_list,
        } else {
                DEBUG(5, ("name %s#%02X found.\n", name, name_type));
        }
-       
+
        /*
         * Split up the stored value into the list of IP adresses
         */
        *num_names = ipstr_list_parse(value, ip_list);
-       
+
        SAFE_FREE(key);
-       SAFE_FREE(value);                
-       return *num_names > 0;          /* true only if some ip has been fetched */
+       SAFE_FREE(value);
+
+       return *num_names > 0; /* true only if some ip has been fetched */
 }
 
+/**
+ * Remove a namecache entry. Needed for site support.
+ *
+ **/
+
+bool namecache_delete(const char *name, int name_type)
+{
+       bool ret;
+       char *key;
+
+       if (!gencache_init())
+               return False;
+
+       if (name_type > 255) {
+               return False; /* Don't fetch non-real name types. */
+       }
+
+       key = namecache_key(name, name_type);
+       if (!key) {
+               return False;
+       }
+       ret = gencache_del(key);
+       SAFE_FREE(key);
+       return ret;
+}
 
 /**
  * Delete single namecache entry. Look at the
@@ -224,27 +276,30 @@ BOOL namecache_fetch(const char *name, int name_type, struct in_addr **ip_list,
  *
  **/
 
-static void flush_netbios_name(const char* key, const char *value, time_t timeout, void* dptr)
+static void flush_netbios_name(const char *key,
+                       const char *value,
+                       time_t timeout,
+                       void *dptr)
 {
        gencache_del(key);
        DEBUG(5, ("Deleting entry %s\n", key));
 }
 
-
 /**
  * Flush all names from the name cache.
  * It's done by gencache_iterate()
  *
- * @return True upon successful deletion or
- *         False in case of an error
+ * @return true upon successful deletion or
+ *         false in case of an error
  **/
 
 void namecache_flush(void)
 {
-       if (!gencache_init())
+       if (!gencache_init()) {
                return;
+       }
 
-       /* 
+       /*
         * iterate through each NBT cache's entry and flush it
         * by flush_netbios_name function
         */
@@ -252,3 +307,88 @@ void namecache_flush(void)
        DEBUG(5, ("Namecache flushed\n"));
 }
 
+/* Construct a name status record key. */
+
+static char *namecache_status_record_key(const char *name,
+                               int name_type1,
+                               int name_type2,
+                               const struct sockaddr_storage *keyip)
+{
+       char addr[INET6_ADDRSTRLEN];
+       char *keystr;
+
+       print_sockaddr(addr, sizeof(addr), keyip);
+       asprintf_strupper_m(&keystr, "NBT/%s#%02X.%02X.%s", name,
+                           name_type1, name_type2, addr);
+       return keystr;
+}
+
+/* Store a name status record. */
+
+bool namecache_status_store(const char *keyname, int keyname_type,
+               int name_type, const struct sockaddr_storage *keyip,
+               const char *srvname)
+{
+       char *key;
+       time_t expiry;
+       bool ret;
+
+       if (!gencache_init()) {
+               return False;
+       }
+
+       key = namecache_status_record_key(keyname, keyname_type,
+                       name_type, keyip);
+       if (!key)
+               return False;
+
+       expiry = time(NULL) + lp_name_cache_timeout();
+       ret = gencache_set(key, srvname, expiry);
+
+       if (ret) {
+               DEBUG(5, ("namecache_status_store: entry %s -> %s\n",
+                                       key, srvname ));
+       } else {
+               DEBUG(5, ("namecache_status_store: entry %s store failed.\n",
+                                       key ));
+       }
+
+       SAFE_FREE(key);
+       return ret;
+}
+
+/* Fetch a name status record. */
+
+bool namecache_status_fetch(const char *keyname,
+                               int keyname_type,
+                               int name_type,
+                               const struct sockaddr_storage *keyip,
+                               char *srvname_out)
+{
+       char *key = NULL;
+       char *value = NULL;
+       time_t timeout;
+
+       if (!gencache_init())
+               return False;
+
+       key = namecache_status_record_key(keyname, keyname_type,
+                       name_type, keyip);
+       if (!key)
+               return False;
+
+       if (!gencache_get(key, &value, &timeout)) {
+               DEBUG(5, ("namecache_status_fetch: no entry for %s found.\n",
+                                       key));
+               SAFE_FREE(key);
+               return False;
+       } else {
+               DEBUG(5, ("namecache_status_fetch: key %s -> %s\n",
+                                       key, value ));
+       }
+
+       strlcpy(srvname_out, value, 16);
+       SAFE_FREE(key);
+       SAFE_FREE(value);
+       return True;
+}