2 Unix SMB/CIFS implementation.
4 NetBIOS name cache module on top of gencache mechanism.
6 Copyright (C) Tim Potter 2002
7 Copyright (C) Rafal Szczesniak 2002
8 Copyright (C) Jeremy Allison 2007
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
26 #define NBTKEY_FMT "NBT/%s#%02X"
29 * Generates a key for netbios name lookups on basis of
30 * netbios name and type.
31 * The caller must free returned key string when finished.
33 * @param name netbios name string (case insensitive)
34 * @param name_type netbios type of the name being looked up
36 * @return string consisted of uppercased name and appended
40 static char* namecache_key(const char *name,
44 asprintf_strupper_m(&keystr, NBTKEY_FMT, name, name_type);
50 * Store a name(s) in the name cache
52 * @param name netbios names array
53 * @param name_type integer netbios name type
54 * @param num_names number of names being stored
55 * @param ip_list array of in_addr structures containing
56 * ip addresses being stored
59 bool namecache_store(const char *name,
62 struct ip_service *ip_list)
65 char *key, *value_string;
69 if (name_type > 255) {
70 return False; /* Don't store non-real name types. */
73 if ( DEBUGLEVEL >= 5 ) {
74 TALLOC_CTX *ctx = talloc_stackframe();
77 DEBUG(5, ("namecache_store: storing %d address%s for %s#%02x: ",
78 num_names, num_names == 1 ? "": "es", name, name_type));
80 for (i = 0; i < num_names; i++) {
81 addr = print_canonical_sockaddr(ctx,
86 DEBUGADD(5, ("%s%s", addr,
87 (i == (num_names - 1) ? "" : ",")));
94 key = namecache_key(name, name_type);
99 expiry = time(NULL) + lp_name_cache_timeout();
102 * Generate string representation of ip addresses list
103 * First, store the number of ip addresses and then
104 * place each single ip
106 if (!ipstr_list_make(&value_string, ip_list, num_names)) {
108 SAFE_FREE(value_string);
113 ret = gencache_set(key, value_string, expiry);
115 SAFE_FREE(value_string);
120 * Look up a name in the cache.
122 * @param name netbios name to look up for
123 * @param name_type netbios name type of @param name
124 * @param ip_list mallocated list of IP addresses if found in the cache,
126 * @param num_names number of entries found
128 * @return true upon successful fetch or
129 * false if name isn't found in the cache or has expired
132 bool namecache_fetch(const char *name,
134 struct ip_service **ip_list,
140 /* exit now if null pointers were passed as they're required further */
141 if (!ip_list || !num_names) {
145 if (name_type > 255) {
146 return False; /* Don't fetch non-real name types. */
152 * Use gencache interface - lookup the key
154 key = namecache_key(name, name_type);
159 if (!gencache_get(key, &value, &timeout)) {
160 DEBUG(5, ("no entry for %s#%02X found.\n", name, name_type));
165 DEBUG(5, ("name %s#%02X found.\n", name, name_type));
168 * Split up the stored value into the list of IP adresses
170 *num_names = ipstr_list_parse(value, ip_list);
175 return *num_names > 0; /* true only if some ip has been fetched */
179 * Remove a namecache entry. Needed for site support.
183 bool namecache_delete(const char *name, int name_type)
188 if (name_type > 255) {
189 return False; /* Don't fetch non-real name types. */
192 key = namecache_key(name, name_type);
196 ret = gencache_del(key);
202 * Delete single namecache entry. Look at the
203 * gencache_iterate definition.
207 static void flush_netbios_name(const char *key,
213 DEBUG(5, ("Deleting entry %s\n", key));
217 * Flush all names from the name cache.
218 * It's done by gencache_iterate()
220 * @return true upon successful deletion or
221 * false in case of an error
224 void namecache_flush(void)
227 * iterate through each NBT cache's entry and flush it
228 * by flush_netbios_name function
230 gencache_iterate(flush_netbios_name, NULL, "NBT/*");
231 DEBUG(5, ("Namecache flushed\n"));
234 /* Construct a name status record key. */
236 static char *namecache_status_record_key(const char *name,
239 const struct sockaddr_storage *keyip)
241 char addr[INET6_ADDRSTRLEN];
244 print_sockaddr(addr, sizeof(addr), keyip);
245 asprintf_strupper_m(&keystr, "NBT/%s#%02X.%02X.%s", name,
246 name_type1, name_type2, addr);
250 /* Store a name status record. */
252 bool namecache_status_store(const char *keyname, int keyname_type,
253 int name_type, const struct sockaddr_storage *keyip,
260 key = namecache_status_record_key(keyname, keyname_type,
265 expiry = time(NULL) + lp_name_cache_timeout();
266 ret = gencache_set(key, srvname, expiry);
269 DEBUG(5, ("namecache_status_store: entry %s -> %s\n",
272 DEBUG(5, ("namecache_status_store: entry %s store failed.\n",
280 /* Fetch a name status record. */
282 bool namecache_status_fetch(const char *keyname,
285 const struct sockaddr_storage *keyip,
292 key = namecache_status_record_key(keyname, keyname_type,
297 if (!gencache_get(key, &value, &timeout)) {
298 DEBUG(5, ("namecache_status_fetch: no entry for %s found.\n",
303 DEBUG(5, ("namecache_status_fetch: key %s -> %s\n",
307 strlcpy(srvname_out, value, 16);