Having waited for *way* too long, this is mimir's namecache and trusted domain
authorAndrew Bartlett <abartlet@samba.org>
Tue, 26 Nov 2002 11:57:30 +0000 (11:57 +0000)
committerAndrew Bartlett <abartlet@samba.org>
Tue, 26 Nov 2002 11:57:30 +0000 (11:57 +0000)
cache code.

This uses gencache, mimir's new caching code that stores at text-based cache
of various data.

Mimir has done a *lot* of work on this patch, and it is finally time to
get it in CVS.

Andrew Bartlett

source/Makefile.in
source/lib/gencache.c
source/lib/util_str.c
source/libsmb/namecache.c
source/libsmb/namequery.c
source/libsmb/trustdom_cache.c [new file with mode: 0644]
source/nsswitch/winbindd.c
source/nsswitch/winbindd_util.c
source/smbd/server.c
source/utils/net_cache.c
source/utils/net_rpc.c

index d42379472ff207577334c3069f26d71bf2dd2fc4..78c4cb1c4010a3284cd36196236b275a94eccf32 100644 (file)
@@ -173,7 +173,7 @@ LIBSMB_OBJ = libsmb/clientgen.o libsmb/cliconnect.o libsmb/clifile.o \
              libsmb/smberr.o libsmb/credentials.o libsmb/pwd_cache.o \
             libsmb/clioplock.o libsmb/errormap.o libsmb/clirap2.o \
             libsmb/passchange.o libsmb/unexpected.o libsmb/doserr.o \
-            libsmb/namecache.o $(RPC_PARSE_OBJ1)
+            libsmb/namecache.o libsmb/trustdom_cache.o $(RPC_PARSE_OBJ1)
 
 LIBMSRPC_OBJ = rpc_client/cli_lsarpc.o rpc_client/cli_samr.o \
               rpc_client/cli_netlogon.o rpc_client/cli_srvsvc.o \
index a872f1331cb716fc5c492d117f7ff957d79b90b0..d0748456f9c1db9151998721abed1e83c7fd7061 100644 (file)
@@ -91,8 +91,8 @@ BOOL gencache_shutdown(void)
 
 
 /**
- * Add one entry to the cache file.
- * (it part of tridge's proposed API)
+ * Set an entry in the cache file. If there's no such
+ * one, then add it.
  *
  * @param key string that represents a key of this entry
  * @param value text representation value being cached
@@ -102,7 +102,7 @@ BOOL gencache_shutdown(void)
  *         false on the attempt's failure
  **/
  
-BOOL gencache_add(const char *keystr, const char *value, time_t timeout)
+BOOL gencache_set(const char *keystr, const char *value, time_t timeout)
 {
        int ret;
        TDB_DATA keybuf, databuf;
@@ -122,7 +122,7 @@ BOOL gencache_add(const char *keystr, const char *value, time_t timeout)
                   = %s (%d seconds %s)\n", keybuf.dptr, value, ctime(&timeout),
                   (int)(timeout - time(NULL)), timeout > time(NULL) ? "ahead" : "in the past"));
                
-       ret = tdb_store(cache, keybuf, databuf, TDB_INSERT);
+       ret = tdb_store(cache, keybuf, databuf, 0);
        SAFE_FREE(valstr);
        SAFE_FREE(keybuf.dptr);
        SAFE_FREE(databuf.dptr);
@@ -133,7 +133,6 @@ BOOL gencache_add(const char *keystr, const char *value, time_t timeout)
 
 /**
  * Set existing entry to the cache file.
- * (it part of tridge's proposed API)
  *
  * @param key string that represents a key of this entry
  * @param value text representation value being cached
@@ -143,7 +142,7 @@ BOOL gencache_add(const char *keystr, const char *value, time_t timeout)
  *         false on the attempt's failure
  **/
 
-BOOL gencache_set(const char *keystr, const char *valstr, time_t timeout)
+BOOL gencache_set_only(const char *keystr, const char *valstr, time_t timeout)
 {
        int ret = -1;
        TDB_DATA keybuf, databuf;
@@ -189,7 +188,6 @@ BOOL gencache_set(const char *keystr, const char *valstr, time_t timeout)
 
 /**
  * Delete one entry from the cache file.
- * (it part of tridge's proposed API)
  *
  * @param key string that represents a key of this entry
  *
@@ -219,11 +217,10 @@ BOOL gencache_del(const char *keystr)
 
 /**
  * Get existing entry from the cache file.
- * (it part of tridge's proposed API)
  *
  * @param key string that represents a key of this entry
  * @param value buffer that is allocated and filled with the entry value
- *        buffer's disposing is done outside
+ *        buffer's disposing must be done outside
  * @param timeout pointer to a time_t that is filled with entry's
  *        timeout
  *
@@ -272,12 +269,14 @@ BOOL gencache_get(const char *keystr, char **valstr, time_t *timeout)
  *
  * @param fn pointer to the function that will be supplied with each single
  *        matching cache entry (key, value and timeout) as an arguments
+ * @param data void pointer to an arbitrary data that is passed directly to the fn
+ *        function on each call
  * @param keystr_pattern pattern the existing entries' keys are matched to
  *
  **/
 
-void gencache_iterate(void (*fn)(const char* key, const char *value, time_t timeout),
-                      const char* keystr_pattern)
+void gencache_iterate(void (*fn)(const char* key, const char *value, time_t timeout, void* dptr),
+                      void* data, const char* keystr_pattern)
 {
        TDB_LIST_NODE *node, *first_node;
        TDB_DATA databuf;
@@ -289,7 +288,7 @@ void gencache_iterate(void (*fn)(const char* key, const char *value, time_t time
 
        if (!gencache_init()) return;
 
-       DEBUG(5, ("Searching cache keys with pattern %s", keystr_pattern));
+       DEBUG(5, ("Searching cache keys with pattern %s\n", keystr_pattern));
        node = tdb_search_keys(cache, keystr_pattern);
        first_node = node;
        
@@ -314,7 +313,7 @@ void gencache_iterate(void (*fn)(const char* key, const char *value, time_t time
                
                DEBUG(10, ("Calling function with arguments (key = %s, value = %s, timeout = %s)\n",
                           keystr, valstr, ctime(&timeout)));
-               fn(keystr, valstr, timeout);
+               fn(keystr, valstr, timeout, data);
                
                SAFE_FREE(valstr);
                SAFE_FREE(entry);
@@ -323,3 +322,4 @@ void gencache_iterate(void (*fn)(const char* key, const char *value, time_t time
        
        tdb_search_list_free(first_node);
 }
+
index dfadac0e47ef554a01fcbf570debbca368da4964..2e1b79f2e59f5efbf860bf42fd76177012c21bbd 100644 (file)
@@ -1367,6 +1367,117 @@ BOOL str_list_substitute(char **list, const char *pattern, const char *insert)
        return True;
 }
 
+
+#define IPSTR_LIST_SEP ","
+
+/**
+ * Add ip string representation to ipstr list. Used also
+ * as part of @function ipstr_list_make
+ *
+ * @param ipstr_list pointer to string containing ip list;
+ *        MUST BE already allocated and IS reallocated if necessary
+ * @param ipstr_size pointer to current size of ipstr_list (might be changed
+ *        as a result of reallocation)
+ * @param ip IP address which is to be added to list
+ * @return pointer to string appended with new ip and possibly
+ *         reallocated to new length
+ **/
+
+char* ipstr_list_add(char** ipstr_list, const struct in_addr *ip)
+{
+       char* new_ipstr = NULL;
+       
+       /* arguments checking */
+       if (!ipstr_list || !ip) return NULL;
+
+       /* attempt to convert ip to a string and append colon separator to it */
+       if (*ipstr_list) {
+               asprintf(&new_ipstr, "%s%s%s", *ipstr_list, IPSTR_LIST_SEP,inet_ntoa(*ip));
+               SAFE_FREE(*ipstr_list);
+       } else {
+               asprintf(&new_ipstr, "%s", inet_ntoa(*ip));
+       }
+       *ipstr_list = new_ipstr;
+       return *ipstr_list;
+}
+
+
+/**
+ * Allocate and initialise an ipstr list using ip adresses
+ * passed as arguments.
+ *
+ * @param ipstr_list pointer to string meant to be allocated and set
+ * @param ip_list array of ip addresses to place in the list
+ * @param ip_count number of addresses stored in ip_list
+ * @return pointer to allocated ip string
+ **/
+char* ipstr_list_make(char** ipstr_list, const struct in_addr* ip_list, int ip_count)
+{
+       int i;
+       
+       /* arguments checking */
+       if (!ip_list && !ipstr_list) return 0;
+
+       *ipstr_list = NULL;
+       
+       /* process ip addresses given as arguments */
+       for (i = 0; i < ip_count; i++)
+               *ipstr_list = ipstr_list_add(ipstr_list, &ip_list[i]);
+       
+       return (*ipstr_list);
+}
+
+
+/**
+ * Parse given ip string list into array of ip addresses
+ * (as in_addr structures)
+ *
+ * @param ipstr ip string list to be parsed 
+ * @param ip_list pointer to array of ip addresses which is
+ *        allocated by this function and must be freed by caller
+ * @return number of succesfully parsed addresses
+ **/
+int ipstr_list_parse(const char* ipstr_list, struct in_addr** ip_list)
+{
+       fstring token_str;
+       int count;
+
+       if (!ipstr_list || !ip_list) return 0;
+       
+       for (*ip_list = NULL, count = 0;
+            next_token(&ipstr_list, token_str, IPSTR_LIST_SEP, FSTRING_LEN);
+            count++) {
+            
+               struct in_addr addr;
+
+               /* convert single token to ip address */
+               if (!inet_aton(token_str, &addr)) break;
+               
+               /* prepare place for another in_addr structure */
+               *ip_list = Realloc(*ip_list, (count + 1) * sizeof(struct in_addr));
+               if (!*ip_list) return -1;
+               
+               (*ip_list)[count] = addr;
+       }
+       
+       return count;
+}
+
+
+/**
+ * Safely free ip string list
+ *
+ * @param ipstr_list ip string list to be freed
+ **/
+
+void ipstr_list_free(char* ipstr_list)
+{
+       SAFE_FREE(ipstr_list);
+}
+
+
 /***********************************************************
  Unescape a URL encoded string, in place.
 ***********************************************************/
index ce4cbc048c72f8bad0f151cdc9e4492a48c22086..40777011a1d07ac64fd81e06df7d73f28cc50243 100644 (file)
@@ -1,9 +1,10 @@
 /* 
    Unix SMB/CIFS implementation.
 
-   NetBIOS name cache module.
-
-   Copyright (C) Tim Potter, 2002
+   NetBIOS name cache module on top of gencache mechanism.
+   
+   Copyright (C) Tim Potter         2002
+   Copyright (C) Rafal Szczesniak   2002
    
    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
 
 #include "includes.h"
 
-static BOOL done_namecache_init;
-static BOOL enable_namecache;
-static TDB_CONTEXT *namecache_tdb;
+#define NBTKEY_FMT  "NBT/%s#%02X"
 
-struct nc_value {
-       time_t expiry;               /* When entry expires */
-       int count;                   /* Number of addresses */
-       struct in_addr ip_list[1];   /* Address list */
-};
 
-/* Initialise namecache system */
+/**
+ * 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)
 {
-       /* Check if we have been here before, or name caching disabled
-           by setting the name cache timeout to zero. */ 
-
-       if (done_namecache_init)
-               return False;
-
-       done_namecache_init = True;
+       /*
+        * Check if name caching disabled by setting the name cache
+        * timeout to zero.
+        */ 
 
        if (lp_name_cache_timeout() == 0) {
-               DEBUG(5, ("namecache_init: disabling netbios name cache\n"));
+               DEBUG(5, ("namecache_enable: disabling netbios name cache\n"));
                return False;
        }
 
-       /* Open namecache tdb in read/write or readonly mode */
+       /* Init namecache by calling gencache initialisation */
 
-       namecache_tdb = tdb_open_log(
-               lock_path("namecache.tdb"), 0,
-               TDB_DEFAULT, O_RDWR | O_CREAT, 0644);
-
-       if (!namecache_tdb) {
-               DEBUG(5, ("namecache_init: could not open %s\n",
-                         lock_path("namecache.tdb")));
+       if (!gencache_init()) {
+               DEBUG(2, ("namecache_enable: Couldn't initialise namecache on top of gencache.\n"));
                return False;
        }
 
-       DEBUG(5, ("namecache_init: enabling netbios namecache, timeout %d "
+       /* 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()));
 
-       enable_namecache = True;
-
        return True;
 }
 
-/* Return a key for a name and name type.  The caller must free
-   retval.dptr when finished. */
 
-static TDB_DATA namecache_key(const char *name, int name_type)
+/**
+ * Shutdown namecache. Routine calls gencache close function
+ * to safely close gencache file.
+ *
+ * @return true upon successful shutdown of the cache or
+ *         false on failure
+ **/
+BOOL namecache_shutdown(void)
 {
-       TDB_DATA retval;
-       char *keystr;
-
-       asprintf(&keystr, "%s#%02X", strupper_static(name), name_type);
-
-       retval.dsize = strlen(keystr) + 1;
-       retval.dptr = keystr;
-
-       return retval;
+       if (!gencache_shutdown()) {
+               DEBUG(2, ("namecache_shutdown: Couldn't close namecache on top of gencache.\n"));
+               return False;
+       }
+       
+       DEBUG(5, ("namecache_shutdown: netbios namecache closed successfully.\n"));
+       return True;
 }
 
-/* Return a data value for an IP list.  The caller must free
-   retval.dptr when finished. */
-
-static TDB_DATA namecache_value(struct in_addr *ip_list, int num_names, 
-                               time_t expiry)
-{
-       TDB_DATA retval;
-       struct nc_value *value;
-       int size = sizeof(struct nc_value);
 
-       if (num_names > 0)
-               size += sizeof(struct in_addr) * (num_names-1);
+/**
+ * Generates a key for netbios name lookups on basis of
+ * netbios name and type.
+ * The caller must free returned key string when finished.
+ *
+ * @param name netbios name string (case insensitive)
+ * @param name_type netbios type of the name being looked up
+ *
+ * @return string consisted of uppercased name and appended
+ *         type number
+ */
 
-       value = (struct nc_value *)malloc(size);
-
-       memset(value, 0, size);
-
-       value->expiry = expiry;
-       value->count = num_names;
-
-       if (ip_list)
-               memcpy(value->ip_list, ip_list, sizeof(struct in_addr) * num_names);
-
-       retval.dptr = (char *)value;
-       retval.dsize = size;
+static char* namecache_key(const char *name, int name_type)
+{
+       char *keystr;
+       asprintf(&keystr, NBTKEY_FMT, strupper_static(name), name_type);
 
-       return retval;
+       return keystr;
 }
 
-/* Store a name in the name cache */
 
-void namecache_store(const char *name, int name_type,
-                    int num_names, struct in_addr *ip_list)
+/**
+ * Store a name(s) in the name cache
+ *
+ * @param name netbios names array
+ * @param name_type integer netbios name type
+ * @param num_names number of names being stored
+ * @param ip_list array of in_addr structures containing
+ *        ip addresses being stored
+ **/
+
+BOOL namecache_store(const char *name, int name_type,
+                     int num_names, struct in_addr *ip_list)
 {
-       TDB_DATA key, value;
        time_t expiry;
+       char *key, *value_string;
        int i;
 
-       if (!enable_namecache)
-               return;
+       /*
+        * 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));
+                 num_names, num_names == 1 ? "": "es", name, name_type));
 
        for (i = 0; i < num_names; i++) 
                DEBUGADD(5, ("%s%s", inet_ntoa(ip_list[i]),
-                            i == (num_names - 1) ? "" : ", "));
+                            i == (num_names - 1) ? "" : ", "));
 
        DEBUGADD(5, ("\n"));
 
        key = namecache_key(name, name_type);
 
-       /* 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! */
+       /* 
+        * 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)
+       if (name_type == 0x1b || name_type == 0x1c)
                expiry = time(NULL) + 10;
        else
                expiry = time(NULL) + lp_name_cache_timeout();
 
-       value = namecache_value(ip_list, num_names, expiry);
-
-       tdb_store(namecache_tdb, key, value, TDB_REPLACE);
-
-       free(key.dptr);
-       free(value.dptr);
+       /*
+        * Generate string representation of ip addresses list
+        * First, store the number of ip addresses and then
+        * place each single ip
+        */
+       ipstr_list_make(&value_string, ip_list, num_names);
+       
+       /* set the entry */
+       return (gencache_set(key, value_string, expiry));
 }
 
-/* Look up a name in the name cache.  Return a mallocated list of IP
-   addresses if the name is contained in the cache. */
+
+/**
+ * Look up a name in the cache.
+ *
+ * @param name netbios name to look up for
+ * @param name_type netbios name type of @param name
+ * @param ip_list mallocated list of IP addresses if found in the cache,
+ *        NULL otherwise
+ * @param num_names number of entries found
+ *
+ * @return true upon successful fetch or
+ *         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)
+                     int *num_names)
 {
-       TDB_DATA key, value;
-       struct nc_value *data;
-       time_t now;
-       int i;
+       char *key, *value;
+       time_t timeout;
 
-       *ip_list = NULL;
        *num_names = 0;
 
-       if (!enable_namecache)
-               return False;
+       /* exit now if null pointers were passed as they're required further */
+       if (!ip_list || !num_names) return False;
 
-       /* Read value */
+       if (!gencache_init())
+               return False;
 
+       /* 
+        * Use gencache interface - lookup the key
+        */
        key = namecache_key(name, name_type);
 
-       value = tdb_fetch(namecache_tdb, key);
-       
-       if (!value.dptr) {
-               DEBUG(5, ("namecache_fetch: %s#%02x not found\n",
-                         name, name_type));
-               goto done;
-       }
-
-       data = (struct nc_value *)value.dptr;
-
-       /* Check expiry time */
-
-       now = time(NULL);
-
-       if (now > data->expiry) {
-
-               DEBUG(5, ("namecache_fetch: entry for %s#%02x expired\n",
-                         name, name_type));
-
-               tdb_delete(namecache_tdb, key);
-
-               SAFE_FREE(value.dptr);
-               value = tdb_null;
-
-               goto done;
-       }
-
-       if ((data->expiry - now) > lp_name_cache_timeout()) {
-
-               /* Someone may have changed the system time on us */
-
-               DEBUG(5, ("namecache_fetch: entry for %s#%02x has bad expiry\n",
-                         name, name_type));
-
-               tdb_delete(namecache_tdb, key);
-
-               SAFE_FREE(value.dptr);
-               value = tdb_null;
-
-               goto done;
-       }
-
-       /* Extract and return namelist */
-
-       DEBUG(5, ("namecache_fetch: returning %d address%s for %s#%02x: ",
-                 data->count, data->count == 1 ? "" : "es", name, name_type));
-
-       if (data->count) {
-
-               *ip_list = (struct in_addr *)malloc(
-                       sizeof(struct in_addr) * data->count);
-               
-               memcpy(*ip_list, data->ip_list, sizeof(struct in_addr) * data->count);
-               
-               *num_names = data->count;
-               
-               for (i = 0; i < *num_names; i++)
-                       DEBUGADD(5, ("%s%s", inet_ntoa((*ip_list)[i]),
-                                    i == (*num_names - 1) ? "" : ", "));
-
+       if (!gencache_get(key, &value, &timeout)) {
+               DEBUG(5, ("no entry for %s#%02X found.\n", name, name_type));
+               SAFE_FREE(key);
+               return False;
+       } 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 */
+}
 
-       DEBUGADD(5, ("\n"));
 
-done:
-       SAFE_FREE(key.dptr);
-       SAFE_FREE(value.dptr);
+/**
+ * Delete single namecache entry. Look at the
+ * gencache_iterate definition.
+ *
+ **/
 
-       return value.dsize > 0;
+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 */
+
+/**
+ * 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
+ **/
 
 void namecache_flush(void)
 {
-       int result;
-
-       if (!namecache_tdb)
+       if (!gencache_init())
                return;
 
-       result = tdb_traverse(namecache_tdb, tdb_traverse_delete_fn, NULL);
-
-       if (result == -1)
-               DEBUG(5, ("namecache_flush: error deleting cache entries\n"));
-       else
-               DEBUG(5, ("namecache_flush: deleted %d cache entr%s\n", 
-                         result, result == 1 ? "y" : "ies"));
+       /* 
+        * iterate through each NBT cache's entry and flush it
+        * by flush_netbios_name function
+        */
+       gencache_iterate(flush_netbios_name, NULL, "NBT/*");
+       DEBUG(5, ("Namecache flushed\n"));
 }
+
index 6190c872ee20930598bf4b005761a3493e71b7ad..1c5af8bff0f3eba6fd575e49589abedd3ad396c2 100644 (file)
@@ -837,11 +837,6 @@ static BOOL internal_resolve_name(const char *name, int name_type,
                          if (resolve_hosts(name, return_iplist, return_count)) {
                                  result = True;
                                  goto done;
-                         } else {
-
-                                 /* Store negative lookup result */
-
-                                 namecache_store(name, name_type, 0, NULL);
                          }
                  }
          } else if(strequal( tok, "lmhosts")) {
@@ -916,7 +911,10 @@ static BOOL internal_resolve_name(const char *name, int name_type,
   }
  
   /* Save in name cache */
-
+  for (i = 0; i < *return_count && DEBUGLEVEL == 100; i++)
+    DEBUG(100, ("Storing name %s of type %d (ip: %s)\n", name,
+                name_type, inet_ntoa(*return_iplist[i])));
+    
   namecache_store(name, name_type, *return_count, *return_iplist);
 
   /* Display some debugging info */
diff --git a/source/libsmb/trustdom_cache.c b/source/libsmb/trustdom_cache.c
new file mode 100644 (file)
index 0000000..cddbb2d
--- /dev/null
@@ -0,0 +1,215 @@
+/* 
+   Unix SMB/CIFS implementation.
+
+   Trusted domain names cache on top of gencache.
+
+   Copyright (C) Rafal Szczesniak      2002
+   
+   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
+   (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.
+*/
+
+#include "includes.h"
+
+#undef DBGC_CLASS
+#define DBGC_CLASS DBGC_ALL    /* there's no proper class yet */
+
+#define TDOMKEY_FMT  "TDOM/%s"
+
+
+/**
+ * @file trustdom_cache.c
+ *
+ * Implementation of trusted domain names cache useful when
+ * samba acts as domain member server. In such case, caching
+ * domain names currently trusted gives a performance gain
+ * because there's no need to query PDC each time we need
+ * list of trusted domains
+ **/
+
+/**
+ * Initialise trustdom name caching system. Call gencache
+ * initialisation routine to perform necessary activities.
+ *
+ * @return true upon successful cache initialisation or
+ *         false if cache init failed
+ **/
+BOOL trustdom_cache_enable(void)
+{
+       /* Init trustdom cache by calling gencache initialisation */
+       if (!gencache_init()) {
+               DEBUG(2, ("trustdomcache_enable: Couldn't initialise trustdom cache on top of gencache.\n"));
+               return False;
+       }
+
+       return True;
+}
+
+
+/**
+ * Shutdown trustdom name caching system. Calls gencache
+ * shutdown function.
+ *
+ * @return true upon successful cache close or
+ *         false if it failed
+ **/
+BOOL trustdom_cache_shutdown(void)
+{
+       /* Close trustdom cache by calling gencache shutdown */
+       if (!gencache_shutdown()) {
+               DEBUG(2, ("trustdomcache_shutdown: Couldn't shutdown trustdom cache on top of gencache.\n"));
+               return False;
+       }
+       
+       return True;
+}
+
+
+/**
+ * Form up trustdom name key. It is based only
+ * on domain name now.
+ *
+ * @param name trusted domain name
+ * @return cache key for use in gencache mechanism
+ **/
+
+static char* trustdom_cache_key(const char* name)
+{
+       char* keystr;
+       asprintf(&keystr, TDOMKEY_FMT, strupper_static(name));
+       
+       return keystr;
+}
+
+
+/**
+ * Store trusted domain in gencache as the domain name (key)
+ * and ip address of domain controller (value)
+ *
+ * @param name trusted domain name
+ * @param alt_name alternative trusted domain name (used in ADS domains)
+ * @param sid trusted domain's SID
+ * @param timeout cache entry expiration time
+ * @return true upon successful value storing or
+ *         false if store attempt failed
+ **/
+BOOL trustdom_cache_store(char* name, char* alt_name, const DOM_SID *sid,
+                          time_t timeout)
+{
+       char *key, *alt_key;
+       fstring sid_string;
+
+       /*
+        * we use gecache call to avoid annoying debug messages
+        * about initialised trustdom 
+        */
+       if (!gencache_init()) return False;
+
+       DEBUG(5, ("trustdom_store: storing SID %s of domain %s\n",
+                 sid_string_static(sid), name));
+
+       key = trustdom_cache_key(name);
+       alt_key = alt_name ? trustdom_cache_key(alt_name) : NULL;
+
+       /* Generate string representation domain SID */
+       sid_to_string(sid_string, sid);
+
+       /*
+        * try to put the names in the cache
+        */
+       if (alt_key) {
+               return (gencache_set(alt_key, sid_string, timeout)
+                       && gencache_set(key, sid_string, timeout));
+       }
+                
+       return gencache_set(key, sid_string, timeout);
+}
+
+
+/**
+ * Fetch trusted domain's dc from the gencache.
+ * This routine can also be used to check whether given
+ * domain is currently trusted one.
+ *
+ * @param name trusted domain name
+ * @param sid trusted domain's SID to be returned
+ * @return true if entry is found or
+ *         false if has expired/doesn't exist
+ **/
+BOOL trustdom_cache_fetch(const char* name, DOM_SID* sid)
+{
+       char *key, *value;
+       time_t timeout;
+
+       /* init the cache */
+       if (!gencache_init()) return False;
+       
+       /* exit now if null pointers were passed as they're required further */
+       if (!sid) return False;
+
+       /* prepare a key and get the value */
+       key = trustdom_cache_key(name);
+       
+       if (!gencache_get(key, &value, &timeout)) {
+               DEBUG(5, ("no entry for trusted domain %s found.\n", name));
+               return False;
+       } else {
+               DEBUG(5, ("trusted domain %s found (%s)\n", name, value));
+       }
+
+       /* convert ip string representation into in_addr structure */
+       if(! string_to_sid(sid, value)) {
+               sid = NULL;
+               return False;
+       }
+       
+       return True;
+}
+
+
+/**
+ * Delete single trustdom entry. Look at the
+ * gencache_iterate definition.
+ *
+ **/
+
+static void flush_trustdom_name(const char* key, const char *value, time_t timeout, void* dptr)
+{
+       gencache_del(key);
+       DEBUG(5, ("Deleting entry %s\n", key));
+}
+
+
+/**
+ * Flush all the trusted domains entries from the cache.
+ **/
+
+void trustdom_cache_flush(void)
+{
+       if (!gencache_init())
+               return;
+
+       /* 
+        * iterate through each TDOM cache's entry and flush it
+        * by flush_trustdom_name function
+        */
+       gencache_iterate(flush_trustdom_name, NULL, trustdom_cache_key("*"));
+       DEBUG(5, ("Trusted domains cache flushed\n"));
+}
+
index 4bfec1afe49338387de64b90fcc42b561631b027..773e3a84f3c90a5a50783998c3105975120ee698 100644 (file)
@@ -863,6 +863,7 @@ static void usage(void)
 
        process_loop();
 
+       trustdom_cache_shutdown();
        uni_group_cache_shutdown();
        return 0;
 }
index 5ad4bada3758aae0ab9c176d7f979ba913d8babe..c1bb5cec7cac2bac3035967b6835742ac2df971d 100644 (file)
@@ -178,7 +178,7 @@ void rescan_trusted_domains(void)
                int i;
 
                result = domain->methods->trusted_domains(domain, mem_ctx, &num_domains,
-                                                         &names, &alt_names, &dom_sids);
+                                                         &names, &alt_names, &dom_sids);
                if (!NT_STATUS_IS_OK(result)) {
                        continue;
                }
@@ -187,9 +187,12 @@ void rescan_trusted_domains(void)
                   the access methods of its parent */
                for(i = 0; i < num_domains; i++) {
                        DEBUG(10,("Found domain %s\n", names[i]));
-                       add_trusted_domain(names[i], 
-                                          alt_names?alt_names[i]:NULL, 
-                                          domain->methods, &dom_sids[i]);
+                       add_trusted_domain(names[i], alt_names?alt_names[i]:NULL,
+                                          domain->methods, &dom_sids[i]);
+                       
+                       /* store trusted domain in the cache */
+                       trustdom_cache_store(names[i], alt_names ? alt_names[i] : NULL,
+                                            &dom_sids[i], t + WINBINDD_RESCAN_FREQ);
                }
        }
 
@@ -209,8 +212,10 @@ BOOL init_domain_list(void)
        /* Add ourselves as the first entry */
        domain = add_trusted_domain(lp_workgroup(), NULL, &cache_methods, NULL);
 
-       /* Now we *must* get the domain sid for our primary domain. Go into
-          a holding pattern until that is available */
+       /* 
+        * Now we *must* get the domain sid for our primary domain. Go into
+        * a holding pattern until that is available
+        */
 
        result = cache_methods.domain_sid(domain, &domain->sid);
        while (!NT_STATUS_IS_OK(result)) {
index e9092858f4bf95fee31712b9e4bcc42b60726890..68792117ea15335977690f1de7b3d9bbb632ea94 100644 (file)
@@ -849,6 +849,7 @@ static BOOL init_structs(void )
        smbd_process();
        
        uni_group_cache_shutdown();
+       namecache_shutdown();
        exit_server("normal exit");
        return(0);
 }
index 359c06d1aa3f9ee97491f5398e63ee3bc7de5c05..93c4f1aa1dfa41ef966b08eb6469e4c6291a3c43 100644 (file)
  * (print_cache_entry) and to flush it (delete_cache_entry).
  * Both of them are defined by first arg of gencache_iterate() routine.
  */
-static void print_cache_entry(const char* keystr, const char* datastr, const time_t timeout)
+static void print_cache_entry(const char* keystr, const char* datastr,
+                              const time_t timeout, void* dptr)
 {
-       char* timeout_str = ctime(&timeout);
-       timeout_str[strlen(timeout_str) - 1] = '\0';
-       d_printf("Key: %s\t\t Value: %s\t\t Timeout: %s %s\n", keystr, datastr,
-                timeout_str, timeout > time(NULL) ? "": "(expired)");
+       char* timeout_str;
+       time_t now_t = time(NULL);
+       struct tm timeout_tm, *now_tm;
+       /* localtime returns statically allocated pointer, so timeout_tm
+          has to be copied somewhere else */
+       memcpy(&timeout_tm, localtime(&timeout), sizeof(struct tm));
+       now_tm = localtime(&now_t);
+
+       /* form up timeout string depending whether it's today's date or not */
+       if (timeout_tm.tm_year != now_tm->tm_year ||
+           timeout_tm.tm_mon != now_tm->tm_mon ||
+           timeout_tm.tm_mday != now_tm->tm_mday) {
+           
+           timeout_str = asctime(&timeout_tm);
+           timeout_str[strlen(timeout_str) - 1] = '\0';        /* remove tailing CR */
+       } else
+               asprintf(&timeout_str, "%.2d:%.2d:%.2d", timeout_tm.tm_hour,
+                        timeout_tm.tm_min, timeout_tm.tm_sec);
+       
+       d_printf("Key: %s\t Timeout: %s\t Value: %s  %s\n", keystr,
+                timeout_str, datastr, timeout > now_t ? "": "(expired)");
 }
 
-static void delete_cache_entry(const char* keystr, const char* datastr, const time_t timeout)
+static void delete_cache_entry(const char* keystr, const char* datastr,
+                               const time_t timeout, void* dptr)
 {
        if (!gencache_del(keystr))
                d_printf("Couldn't delete entry! key = %s", keystr);
@@ -106,7 +125,7 @@ static time_t parse_timeout(const char* timeout_str)
 
 
 /**
- * Add an entry to the cache
+ * Add an entry to the cache. If it does exist, then set it.
  * 
  * @param argv key, value and timeout are passed in command line
  * @return 0 on success, otherwise failure
@@ -132,12 +151,12 @@ static int net_cache_add(int argc, const char **argv)
                return -1;
        }
        
-       if (gencache_add(keystr, datastr, timeout)) {
+       if (gencache_set(keystr, datastr, timeout)) {
                d_printf("New cache entry stored successfully.\n");
                gencache_shutdown();
                return 0;
-       } 
-
+       }
+       
        d_printf("Entry couldn't be added. Perhaps there's already such a key.\n");
        gencache_shutdown();
        return -1;
@@ -145,7 +164,8 @@ static int net_cache_add(int argc, const char **argv)
 
 
 /**
- * Set new value of an existing entry in the cache
+ * Set new value of an existing entry in the cache. Fail If the entry doesn't
+ * exist.
  * 
  * @param argv key being searched and new value and timeout to set in the entry
  * @return 0 on success, otherwise failure
@@ -171,7 +191,7 @@ static int net_cache_set(int argc, const char **argv)
                return -1;
        }
        
-       if (gencache_set(keystr, datastr, timeout)) {
+       if (gencache_set_only(keystr, datastr, timeout)) {
                d_printf("Cache entry set successfully.\n");
                gencache_shutdown();
                return 0;
@@ -201,7 +221,7 @@ static int net_cache_del(int argc, const char **argv)
        if(gencache_del(keystr)) {
                d_printf("Entry deleted.\n");
                return 0;
-       } 
+       }
 
        d_printf("Couldn't delete specified entry\n");
        return -1;
@@ -226,9 +246,9 @@ static int net_cache_get(int argc, const char **argv)
        }
        
        if (gencache_get(keystr, &valuestr, &timeout)) {
-               print_cache_entry(keystr, valuestr, timeout);
+               print_cache_entry(keystr, valuestr, timeout, NULL);
                return 0;
-       } 
+       }
 
        d_printf("Failed to find entry\n");
        return -1;
@@ -251,7 +271,7 @@ static int net_cache_search(int argc, const char **argv)
        }
        
        pattern = argv[0];
-       gencache_iterate(print_cache_entry, pattern);
+       gencache_iterate(print_cache_entry, NULL, pattern);
        return 0;
 }
 
@@ -265,7 +285,7 @@ static int net_cache_search(int argc, const char **argv)
 static int net_cache_list(int argc, const char **argv)
 {
        const char* pattern = "*";
-       gencache_iterate(print_cache_entry, pattern);
+       gencache_iterate(print_cache_entry, NULL, pattern);
        gencache_shutdown();
        return 0;
 }
@@ -280,7 +300,7 @@ static int net_cache_list(int argc, const char **argv)
 static int net_cache_flush(int argc, const char **argv)
 {
        const char* pattern = "*";
-       gencache_iterate(delete_cache_entry, pattern);
+       gencache_iterate(delete_cache_entry, NULL, pattern);
        gencache_shutdown();
        return 0;
 }
index d5af6e3fb8889891427280ccd9418ca572a46082..092d625ae50d0ba1ca65c211de36b1fe9ec7b963 100644 (file)
@@ -1659,6 +1659,10 @@ static int rpc_trustdom_establish(int argc, const char **argv)
 
        domain_name = smb_xstrdup(argv[0]);
        strupper(domain_name);
+
+       /* account name used at first is our domain's name with '$' */
+       asprintf(&acct_name, "%s$", lp_workgroup());
+       strupper(acct_name);
        
        /*
         * opt_workgroup will be used by connection functions further,
@@ -1669,9 +1673,6 @@ static int rpc_trustdom_establish(int argc, const char **argv)
                opt_workgroup = smb_xstrdup(domain_name);
        };
        
-       asprintf(&acct_name, "%s$", lp_workgroup());
-       strupper(acct_name);
-       
        opt_user_name = acct_name;
 
        /* find the domain controller */