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/>.
25 #include "lib/gencache.h"
27 #define NBTKEY_FMT "NBT/%s#%02X"
30 * Generates a key for netbios name lookups on basis of
31 * netbios name and type.
32 * The caller must free returned key string when finished.
34 * @param name netbios name string (case insensitive)
35 * @param name_type netbios type of the name being looked up
37 * @return string consisted of uppercased name and appended
41 static char *namecache_key(const char *name
,
45 asprintf_strupper_m(&keystr
, NBTKEY_FMT
, name
, name_type
);
51 * Store a name(s) in the name cache
53 * @param name netbios names array
54 * @param name_type integer netbios name type
55 * @param num_names number of names being stored
56 * @param ip_list array of in_addr structures containing
57 * ip addresses being stored
60 bool namecache_store(const char *name
,
63 struct ip_service
*ip_list
)
66 char *key
, *value_string
;
70 if (name_type
> 255) {
71 return False
; /* Don't store non-real name types. */
74 if ( DEBUGLEVEL
>= 5 ) {
75 TALLOC_CTX
*ctx
= talloc_stackframe();
78 DEBUG(5, ("namecache_store: storing %d address%s for %s#%02x: ",
79 num_names
, num_names
== 1 ? "": "es", name
, name_type
));
81 for (i
= 0; i
< num_names
; i
++) {
82 addr
= print_canonical_sockaddr(ctx
,
87 DEBUGADD(5, ("%s%s", addr
,
88 (i
== (num_names
- 1) ? "" : ",")));
95 key
= namecache_key(name
, name_type
);
100 expiry
= time(NULL
) + lp_name_cache_timeout();
103 * Generate string representation of ip addresses list
104 * First, store the number of ip addresses and then
105 * place each single ip
107 if (!ipstr_list_make(&value_string
, ip_list
, num_names
)) {
109 SAFE_FREE(value_string
);
114 ret
= gencache_set(key
, value_string
, expiry
);
116 SAFE_FREE(value_string
);
121 * Look up a name in the cache.
123 * @param name netbios name to look up for
124 * @param name_type netbios name type of @param name
125 * @param ip_list mallocated list of IP addresses if found in the cache,
127 * @param num_names number of entries found
129 * @return true upon successful fetch or
130 * false if name isn't found in the cache or has expired
133 bool namecache_fetch(const char *name
,
135 struct ip_service
**ip_list
,
141 /* exit now if null pointers were passed as they're required further */
142 if (!ip_list
|| !num_names
) {
146 if (name_type
> 255) {
147 return False
; /* Don't fetch non-real name types. */
153 * Use gencache interface - lookup the key
155 key
= namecache_key(name
, name_type
);
160 if (!gencache_get(key
, talloc_tos(), &value
, &timeout
)) {
161 DEBUG(5, ("no entry for %s#%02X found.\n", name
, name_type
));
166 DEBUG(5, ("name %s#%02X found.\n", name
, name_type
));
169 * Split up the stored value into the list of IP adresses
171 *num_names
= ipstr_list_parse(value
, ip_list
);
176 return *num_names
> 0; /* true only if some ip has been fetched */
180 * Remove a namecache entry. Needed for site support.
184 bool namecache_delete(const char *name
, int name_type
)
189 if (name_type
> 255) {
190 return False
; /* Don't fetch non-real name types. */
193 key
= namecache_key(name
, name_type
);
197 ret
= gencache_del(key
);
203 * Delete single namecache entry. Look at the
204 * gencache_iterate definition.
208 static void flush_netbios_name(const char *key
,
214 DEBUG(5, ("Deleting entry %s\n", key
));
218 * Flush all names from the name cache.
219 * It's done by gencache_iterate()
221 * @return true upon successful deletion or
222 * false in case of an error
225 void namecache_flush(void)
228 * iterate through each NBT cache's entry and flush it
229 * by flush_netbios_name function
231 gencache_iterate(flush_netbios_name
, NULL
, "NBT/*");
232 DEBUG(5, ("Namecache flushed\n"));
235 /* Construct a name status record key. */
237 static char *namecache_status_record_key(const char *name
,
240 const struct sockaddr_storage
*keyip
)
242 char addr
[INET6_ADDRSTRLEN
];
245 print_sockaddr(addr
, sizeof(addr
), keyip
);
246 asprintf_strupper_m(&keystr
, "NBT/%s#%02X.%02X.%s", name
,
247 name_type1
, name_type2
, addr
);
251 /* Store a name status record. */
253 bool namecache_status_store(const char *keyname
, int keyname_type
,
254 int name_type
, const struct sockaddr_storage
*keyip
,
261 key
= namecache_status_record_key(keyname
, keyname_type
,
266 expiry
= time(NULL
) + lp_name_cache_timeout();
267 ret
= gencache_set(key
, srvname
, expiry
);
270 DEBUG(5, ("namecache_status_store: entry %s -> %s\n",
273 DEBUG(5, ("namecache_status_store: entry %s store failed.\n",
281 /* Fetch a name status record. */
283 bool namecache_status_fetch(const char *keyname
,
286 const struct sockaddr_storage
*keyip
,
293 key
= namecache_status_record_key(keyname
, keyname_type
,
298 if (!gencache_get(key
, talloc_tos(), &value
, &timeout
)) {
299 DEBUG(5, ("namecache_status_fetch: no entry for %s found.\n",
304 DEBUG(5, ("namecache_status_fetch: key %s -> %s\n",
308 strlcpy(srvname_out
, value
, 16);