2 Unix SMB/CIFS implementation.
4 core wins server handling
6 Copyright (C) Andrew Tridgell 2005
7 Copyright (C) Stefan Metzmacher 2005
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include "nbt_server/nbt_server.h"
26 #include "nbt_server/wins/winsdb.h"
27 #include "system/time.h"
28 #include "smbd/service_task.h"
31 work out the ttl we will use given a client requested ttl
33 uint32_t wins_server_ttl(struct wins_server *winssrv, uint32_t ttl)
35 ttl = MIN(ttl, winssrv->config.max_renew_interval);
36 ttl = MAX(ttl, winssrv->config.min_renew_interval);
40 static enum wrepl_name_type wrepl_type(uint16_t nb_flags, struct nbt_name *name, BOOL mhomed)
42 /* this copes with the nasty hack that is the type 0x1c name */
43 if (name->type == NBT_NAME_LOGON) {
44 return WREPL_TYPE_SGROUP;
46 if (nb_flags & NBT_NM_GROUP) {
47 return WREPL_TYPE_GROUP;
50 return WREPL_TYPE_MHOMED;
52 return WREPL_TYPE_UNIQUE;
56 register a new name with WINS
58 static uint8_t wins_register_new(struct nbt_name_socket *nbtsock,
59 struct nbt_name_packet *packet,
60 const struct nbt_peer_socket *src,
61 enum wrepl_name_type type)
63 struct nbtd_interface *iface = talloc_get_type(nbtsock->incoming.private,
64 struct nbtd_interface);
65 struct wins_server *winssrv = iface->nbtsrv->winssrv;
66 struct nbt_name *name = &packet->questions[0].name;
67 uint32_t ttl = wins_server_ttl(winssrv, packet->additional[0].ttl);
68 uint16_t nb_flags = packet->additional[0].rdata.netbios.addresses[0].nb_flags;
69 const char *address = packet->additional[0].rdata.netbios.addresses[0].ipaddr;
70 struct winsdb_record rec;
71 enum wrepl_name_node node;
73 #define WREPL_NODE_NBT_FLAGS(nb_flags) \
74 ((nb_flags & NBT_NM_OWNER_TYPE)>>13)
76 node = WREPL_NODE_NBT_FLAGS(nb_flags);
80 rec.state = WREPL_STATE_ACTIVE;
82 rec.is_static = False;
83 rec.expire_time = time(NULL) + ttl;
84 rec.version = 0; /* will allocated later */
85 rec.wins_owner = NULL; /* will be set later */
86 rec.registered_by = src->addr;
87 rec.addresses = winsdb_addr_list_make(packet);
88 if (rec.addresses == NULL) return NBT_RCODE_SVR;
90 rec.addresses = winsdb_addr_list_add(rec.addresses,
94 if (rec.addresses == NULL) return NBT_RCODE_SVR;
96 DEBUG(4,("WINS: accepted registration of %s with address %s\n",
97 nbt_name_string(packet, name), rec.addresses[0]->address));
99 return winsdb_add(winssrv->wins_db, &rec, WINSDB_FLAG_ALLOC_VERSION | WINSDB_FLAG_TAKE_OWNERSHIP);
104 update the ttl on an existing record
106 static uint8_t wins_update_ttl(struct nbt_name_socket *nbtsock,
107 struct nbt_name_packet *packet,
108 struct winsdb_record *rec,
109 struct winsdb_addr *winsdb_addr,
110 const struct nbt_peer_socket *src)
112 struct nbtd_interface *iface = talloc_get_type(nbtsock->incoming.private,
113 struct nbtd_interface);
114 struct wins_server *winssrv = iface->nbtsrv->winssrv;
115 uint32_t ttl = wins_server_ttl(winssrv, packet->additional[0].ttl);
116 const char *address = packet->additional[0].rdata.netbios.addresses[0].ipaddr;
117 uint32_t modify_flags = 0;
119 rec->expire_time = time(NULL) + ttl;
120 rec->registered_by = src->addr;
123 winsdb_addr->wins_owner = WINSDB_OWNER_LOCAL;
124 winsdb_addr->expire_time = rec->expire_time;
127 if (strcmp(WINSDB_OWNER_LOCAL, rec->wins_owner) != 0) {
128 modify_flags = WINSDB_FLAG_ALLOC_VERSION | WINSDB_FLAG_TAKE_OWNERSHIP;
131 DEBUG(5,("WINS: refreshed registration of %s at %s\n",
132 nbt_name_string(packet, rec->name), address));
134 return winsdb_modify(winssrv->wins_db, rec, modify_flags);
140 static uint8_t wins_sgroup_merge(struct nbt_name_socket *nbtsock,
141 struct nbt_name_packet *packet,
142 struct winsdb_record *rec,
144 const struct nbt_peer_socket *src)
146 struct nbtd_interface *iface = talloc_get_type(nbtsock->incoming.private,
147 struct nbtd_interface);
148 struct wins_server *winssrv = iface->nbtsrv->winssrv;
149 uint32_t ttl = wins_server_ttl(winssrv, packet->additional[0].ttl);
151 rec->expire_time = time(NULL) + ttl;
152 rec->registered_by = src->addr;
154 rec->addresses = winsdb_addr_list_add(rec->addresses,
158 if (rec->addresses == NULL) return NBT_RCODE_SVR;
160 DEBUG(5,("WINS: sgroup merge of %s at %s\n",
161 nbt_name_string(packet, rec->name), address));
163 return winsdb_modify(winssrv->wins_db, rec, WINSDB_FLAG_ALLOC_VERSION | WINSDB_FLAG_TAKE_OWNERSHIP);
169 static void nbtd_winsserver_register(struct nbt_name_socket *nbtsock,
170 struct nbt_name_packet *packet,
171 const struct nbt_peer_socket *src)
174 struct nbtd_interface *iface = talloc_get_type(nbtsock->incoming.private,
175 struct nbtd_interface);
176 struct wins_server *winssrv = iface->nbtsrv->winssrv;
177 struct nbt_name *name = &packet->questions[0].name;
178 struct winsdb_record *rec;
179 uint8_t rcode = NBT_RCODE_OK;
180 uint16_t nb_flags = packet->additional[0].rdata.netbios.addresses[0].nb_flags;
181 const char *address = packet->additional[0].rdata.netbios.addresses[0].ipaddr;
182 BOOL mhomed = ((packet->operation & NBT_OPCODE) == NBT_OPCODE_MULTI_HOME_REG);
183 enum wrepl_name_type new_type = wrepl_type(nb_flags, name, mhomed);
184 struct winsdb_addr *winsdb_addr = NULL;
187 * as a special case, the local master browser name is always accepted
188 * for registration, but never stored, but w2k3 stores it if it's registered
189 * as a group name, (but a query for the 0x1D name still returns not found!)
191 if (name->type == NBT_NAME_MASTER && !(nb_flags & NBT_NM_GROUP)) {
192 rcode = NBT_RCODE_OK;
196 /* w2k3 refuses 0x1C names with out marked as group */
197 if (name->type == NBT_NAME_LOGON && !(nb_flags & NBT_NM_GROUP)) {
198 rcode = NBT_RCODE_RFS;
202 /* w2k3 refuses 0x1E names with out marked as group */
203 if (name->type == NBT_NAME_BROWSER && !(nb_flags & NBT_NM_GROUP)) {
204 rcode = NBT_RCODE_RFS;
208 status = winsdb_lookup(winssrv->wins_db, name, packet, &rec);
209 if (NT_STATUS_EQUAL(NT_STATUS_OBJECT_NAME_NOT_FOUND, status)) {
210 rcode = wins_register_new(nbtsock, packet, src, new_type);
212 } else if (!NT_STATUS_IS_OK(status)) {
213 rcode = NBT_RCODE_SVR;
215 } else if (rec->is_static) {
216 if (rec->type == WREPL_TYPE_GROUP || rec->type == WREPL_TYPE_SGROUP) {
217 rcode = NBT_RCODE_OK;
220 rcode = NBT_RCODE_ACT;
224 if (rec->type == WREPL_TYPE_GROUP) {
225 if (new_type != WREPL_TYPE_GROUP) {
226 DEBUG(2,("WINS: Attempt to register name %s as non normal group(%u)"
227 " while a normal group is already there\n",
228 nbt_name_string(packet, name), new_type));
229 rcode = NBT_RCODE_ACT;
233 if (rec->state == WREPL_STATE_ACTIVE) {
234 /* TODO: is this correct? */
235 rcode = wins_update_ttl(nbtsock, packet, rec, NULL, src);
239 /* TODO: is this correct? */
240 winsdb_delete(winssrv->wins_db, rec);
241 rcode = wins_register_new(nbtsock, packet, src, new_type);
245 if (rec->state != WREPL_STATE_ACTIVE) {
246 winsdb_delete(winssrv->wins_db, rec);
247 rcode = wins_register_new(nbtsock, packet, src, new_type);
252 case WREPL_TYPE_UNIQUE:
253 case WREPL_TYPE_MHOMED:
255 * if its an active unique name, and the registration is for a group, then
256 * see if the unique name owner still wants the name
257 * TODO: is this correct?
259 if (new_type == WREPL_TYPE_GROUP || new_type == WREPL_TYPE_GROUP) {
260 wins_register_wack(nbtsock, packet, rec, src);
265 * if the registration is for an address that is currently active, then
266 * just update the expiry time of the record and the address
267 * TODO: is this correct?
269 winsdb_addr = winsdb_addr_list_check(rec->addresses, address);
271 rcode = wins_update_ttl(nbtsock, packet, rec, winsdb_addr, src);
276 * we have to do a WACK to see if the current owner is willing
277 * to give up its claim
279 wins_register_wack(nbtsock, packet, rec, src);
282 case WREPL_TYPE_GROUP:
283 /* this should not be reached as normal groups are handled above */
284 DEBUG(0,("BUG at %s\n",__location__));
285 rcode = NBT_RCODE_ACT;
288 case WREPL_TYPE_SGROUP:
289 /* if the new record isn't also a special group, refuse the registration */
290 if (new_type != WREPL_TYPE_SGROUP) {
291 DEBUG(2,("WINS: Attempt to register name %s as non special group(%u)"
292 " while a special group is already there\n",
293 nbt_name_string(packet, name), new_type));
294 rcode = NBT_RCODE_ACT;
299 * if the registration is for an address that is currently active, then
300 * just update the expiry time
301 * just update the expiry time of the record and the address
302 * TODO: is this correct?
304 winsdb_addr = winsdb_addr_list_check(rec->addresses, address);
306 rcode = wins_update_ttl(nbtsock, packet, rec, winsdb_addr, src);
310 rcode = wins_sgroup_merge(nbtsock, packet, rec, address, src);
315 nbtd_name_registration_reply(nbtsock, packet, src, rcode);
321 static void nbtd_winsserver_query(struct nbt_name_socket *nbtsock,
322 struct nbt_name_packet *packet,
323 const struct nbt_peer_socket *src)
326 struct nbtd_interface *iface = talloc_get_type(nbtsock->incoming.private,
327 struct nbtd_interface);
328 struct wins_server *winssrv = iface->nbtsrv->winssrv;
329 struct nbt_name *name = &packet->questions[0].name;
330 struct winsdb_record *rec;
331 const char **addresses;
332 uint16_t nb_flags = 0; /* TODO: ... */
334 if (name->type == NBT_NAME_MASTER) {
338 status = winsdb_lookup(winssrv->wins_db, name, packet, &rec);
339 if (!NT_STATUS_IS_OK(status)) {
344 * for group's we always reply with
345 * 255.255.255.255 as address, even if
346 * the record is released or tombstoned
348 if (rec->type == WREPL_TYPE_GROUP) {
349 addresses = talloc_array(packet, const char *, 2);
350 if (addresses == NULL) {
351 nbtd_negative_name_query_reply(nbtsock, packet, src);
354 addresses[0] = WINSDB_GROUP_ADDRESS;
359 if (rec->state != WREPL_STATE_ACTIVE) {
363 addresses = winsdb_addr_string_list(packet, rec->addresses);
368 nbtd_name_query_reply(nbtsock, packet, src, name,
369 0, nb_flags, addresses);
373 nbtd_negative_name_query_reply(nbtsock, packet, src);
379 static void nbtd_winsserver_release(struct nbt_name_socket *nbtsock,
380 struct nbt_name_packet *packet,
381 const struct nbt_peer_socket *src)
384 struct nbtd_interface *iface = talloc_get_type(nbtsock->incoming.private,
385 struct nbtd_interface);
386 struct wins_server *winssrv = iface->nbtsrv->winssrv;
387 struct nbt_name *name = &packet->questions[0].name;
388 struct winsdb_record *rec;
389 uint32_t modify_flags = 0;
392 status = winsdb_lookup(winssrv->wins_db, name, packet, &rec);
393 if (!NT_STATUS_IS_OK(status)) {
397 if (rec->is_static) {
398 if (rec->type == WREPL_TYPE_UNIQUE || rec->type == WREPL_TYPE_MHOMED) {
401 nbtd_name_release_reply(nbtsock, packet, src, NBT_RCODE_ACT);
405 if (rec->state != WREPL_STATE_ACTIVE) {
410 * TODO: do we need to check if
411 * src->addr matches packet->additional[0].rdata.netbios.addresses[0].ipaddr
416 * we only allow releases from an owner - other releases are
419 if (!winsdb_addr_list_check(rec->addresses, src->addr)) {
423 DEBUG(4,("WINS: released name %s from %s\n", nbt_name_string(rec, rec->name), src->addr));
426 case WREPL_TYPE_UNIQUE:
427 rec->state = WREPL_STATE_RELEASED;
430 case WREPL_TYPE_GROUP:
431 rec->state = WREPL_STATE_RELEASED;
434 case WREPL_TYPE_SGROUP:
435 winsdb_addr_list_remove(rec->addresses, src->addr);
436 /* TODO: do we need to take the ownership here? */
437 if (winsdb_addr_list_length(rec->addresses) == 0) {
438 rec->state = WREPL_STATE_RELEASED;
442 case WREPL_TYPE_MHOMED:
443 winsdb_addr_list_remove(rec->addresses, src->addr);
444 /* TODO: do we need to take the ownership here? */
445 if (winsdb_addr_list_length(rec->addresses) == 0) {
446 rec->state = WREPL_STATE_RELEASED;
451 if (rec->state == WREPL_STATE_RELEASED) {
452 rec->expire_time = time(NULL) + winssrv->config.tombstone_interval;
455 ret = winsdb_modify(winssrv->wins_db, rec, modify_flags);
456 if (ret != NBT_RCODE_OK) {
457 DEBUG(1,("WINS: FAILED: released name %s at %s: error:%u\n",
458 nbt_name_string(rec, rec->name), src->addr, ret));
461 /* we match w2k3 by always giving a positive reply to name releases. */
462 nbtd_name_release_reply(nbtsock, packet, src, NBT_RCODE_OK);
469 void nbtd_winsserver_request(struct nbt_name_socket *nbtsock,
470 struct nbt_name_packet *packet,
471 const struct nbt_peer_socket *src)
473 struct nbtd_interface *iface = talloc_get_type(nbtsock->incoming.private,
474 struct nbtd_interface);
475 struct wins_server *winssrv = iface->nbtsrv->winssrv;
476 if ((packet->operation & NBT_FLAG_BROADCAST) || winssrv == NULL) {
480 switch (packet->operation & NBT_OPCODE) {
481 case NBT_OPCODE_QUERY:
482 nbtd_winsserver_query(nbtsock, packet, src);
485 case NBT_OPCODE_REGISTER:
486 case NBT_OPCODE_REFRESH:
487 case NBT_OPCODE_REFRESH2:
488 case NBT_OPCODE_MULTI_HOME_REG:
489 nbtd_winsserver_register(nbtsock, packet, src);
492 case NBT_OPCODE_RELEASE:
493 nbtd_winsserver_release(nbtsock, packet, src);
500 startup the WINS server, if configured
502 NTSTATUS nbtd_winsserver_init(struct nbtd_server *nbtsrv)
504 uint32_t tombstone_interval;
506 if (!lp_wins_support()) {
507 nbtsrv->winssrv = NULL;
511 nbtsrv->winssrv = talloc_zero(nbtsrv, struct wins_server);
512 NT_STATUS_HAVE_NO_MEMORY(nbtsrv->winssrv);
514 nbtsrv->winssrv->config.max_renew_interval = lp_max_wins_ttl();
515 nbtsrv->winssrv->config.min_renew_interval = lp_min_wins_ttl();
516 tombstone_interval = lp_parm_int(-1,"wreplsrv","tombstone_interval", 6*24*60*60);
517 nbtsrv->winssrv->config.tombstone_interval = tombstone_interval;
519 nbtsrv->winssrv->wins_db = winsdb_connect(nbtsrv->winssrv);
520 if (!nbtsrv->winssrv->wins_db) {
521 return NT_STATUS_INTERNAL_DB_ERROR;
524 irpc_add_name(nbtsrv->task->msg_ctx, "wins_server");