source4/nbt_server/wins/winsclient.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    wins client name registration and refresh
   5
   6    Copyright (C) Andrew Tridgell        2005
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "includes.h"
  23 #include "nbt_server/nbt_server.h"
  24 #include "nbt_server/wins/winsserver.h"
  25 #include "libcli/composite/composite.h"
  26 #include "lib/events/events.h"
  27 #include "librpc/gen_ndr/ndr_nbt.h"
  28 #include "smbd/service_task.h"
  29 #include "param/param.h"
  30
  31 /* we send WINS client requests using our primary network interface
  32 */
  33 static struct nbt_name_socket *wins_socket(struct nbtd_interface *iface)
  34 {
  35         struct nbtd_server *nbtsrv = iface->nbtsrv;
  36         return nbtsrv->interfaces->nbtsock;
  37 }
  38
  39
  40 static void nbtd_wins_refresh(struct tevent_context *ev, struct tevent_timer *te,
  41                               struct timeval t, void *private_data);
  42
  43 /*
  44   retry a WINS name registration
  45 */
  46 static void nbtd_wins_register_retry(struct tevent_context *ev, struct tevent_timer *te,
  47                                      struct timeval t, void *private_data)
  48 {
  49         struct nbtd_iface_name *iname = talloc_get_type(private_data, struct nbtd_iface_name);
  50         nbtd_winsclient_register(iname);
  51 }
  52
  53 /*
  54   start a timer to refresh this name
  55 */
  56 static void nbtd_wins_start_refresh_timer(struct nbtd_iface_name *iname)
  57 {
  58         uint32_t refresh_time;
  59         uint32_t max_refresh_time = lpcfg_parm_int(iname->iface->nbtsrv->task->lp_ctx, NULL, "nbtd", "max_refresh_time", 7200);
  60
  61         refresh_time = MIN(max_refresh_time, iname->ttl/2);
  62
  63         tevent_add_timer(iname->iface->nbtsrv->task->event_ctx,
  64                         iname,
  65                         timeval_add(&iname->registration_time, refresh_time, 0),
  66                         nbtd_wins_refresh, iname);
  67 }
  68
  69 struct nbtd_wins_refresh_state {
  70         struct nbtd_iface_name *iname;
  71         struct nbt_name_refresh_wins io;
  72 };
  73
  74 /*
  75   called when a wins name refresh has completed
  76 */
  77 static void nbtd_wins_refresh_handler(struct tevent_req *subreq)
  78 {
  79         NTSTATUS status;
  80         struct nbtd_wins_refresh_state *state =
  81                 tevent_req_callback_data(subreq,
  82                 struct nbtd_wins_refresh_state);
  83         struct nbtd_iface_name *iname = state->iname;
  84
  85         status = nbt_name_refresh_wins_recv(subreq, state, &state->io);
  86         TALLOC_FREE(subreq);
  87         if (NT_STATUS_EQUAL(status, NT_STATUS_IO_TIMEOUT)) {
  88                 /* our WINS server is dead - start registration over
  89                    from scratch */
  90                 DEBUG(2,("Failed to refresh %s with WINS server %s\n",
  91                          nbt_name_string(state, &iname->name), iname->wins_server));
  92                 talloc_free(state);
  93                 nbtd_winsclient_register(iname);
  94                 return;
  95         }
  96
  97         if (!NT_STATUS_IS_OK(status)) {
  98                 DEBUG(1,("Name refresh failure with WINS for %s - %s\n",
  99                          nbt_name_string(state, &iname->name), nt_errstr(status)));
 100                 talloc_free(state);
 101                 return;
 102         }
 103
 104         if (state->io.out.rcode != 0) {
 105                 DEBUG(1,("WINS server %s rejected name refresh of %s - %s\n",
 106                          state->io.out.wins_server,
 107                          nbt_name_string(state, &iname->name),
 108                          nt_errstr(nbt_rcode_to_ntstatus(state->io.out.rcode))));
 109                 iname->nb_flags |= NBT_NM_CONFLICT;
 110                 talloc_free(state);
 111                 return;
 112         }
 113
 114         DEBUG(4,("Refreshed name %s with WINS server %s\n",
 115                  nbt_name_string(state, &iname->name), iname->wins_server));
 116         /* success - start a periodic name refresh */
 117         iname->nb_flags |= NBT_NM_ACTIVE;
 118         if (iname->wins_server) {
 119                 /*
 120                  * talloc_free() would generate a warning,
 121                  * so steal it into the tmp context
 122                  */
 123                 talloc_steal(state, iname->wins_server);
 124         }
 125         iname->wins_server = talloc_move(iname, &state->io.out.wins_server);
 126         iname->registration_time = timeval_current();
 127
 128         talloc_free(state);
 129
 130         nbtd_wins_start_refresh_timer(iname);
 131 }
 132
 133
 134 /*
 135   refresh a WINS name registration
 136 */
 137 static void nbtd_wins_refresh(struct tevent_context *ev, struct tevent_timer *te,
 138                               struct timeval t, void *private_data)
 139 {
 140         struct nbtd_iface_name *iname = talloc_get_type(private_data, struct nbtd_iface_name);
 141         struct nbtd_interface *iface = iname->iface;
 142         struct nbt_name_socket *nbtsock = wins_socket(iface);
 143         struct tevent_req *subreq;
 144         struct nbtd_wins_refresh_state *state;
 145
 146         state = talloc_zero(iname, struct nbtd_wins_refresh_state);
 147         if (state == NULL) {
 148                 return;
 149         }
 150
 151         state->iname = iname;
 152
 153         /* setup a wins name refresh request */
 154         state->io.in.name            = iname->name;
 155         state->io.in.wins_servers    = (const char **)str_list_make_single(state, iname->wins_server);
 156         state->io.in.wins_port       = lpcfg_nbt_port(iface->nbtsrv->task->lp_ctx);
 157         state->io.in.addresses       = nbtd_address_list(iface, state);
 158         state->io.in.nb_flags        = iname->nb_flags;
 159         state->io.in.ttl             = iname->ttl;
 160
 161         if (!state->io.in.addresses) {
 162                 talloc_free(state);
 163                 return;
 164         }
 165
 166         subreq = nbt_name_refresh_wins_send(state, ev, nbtsock, &state->io);
 167         if (subreq == NULL) {
 168                 talloc_free(state);
 169                 return;
 170         }
 171
 172         tevent_req_set_callback(subreq, nbtd_wins_refresh_handler, state);
 173 }
 174
 175 struct nbtd_wins_register_state {
 176         struct nbtd_iface_name *iname;
 177         struct nbt_name_register_wins io;
 178 };
 179
 180 /*
 181   called when a wins name register has completed
 182 */
 183 static void nbtd_wins_register_handler(struct tevent_req *subreq)
 184 {
 185         NTSTATUS status;
 186         struct nbtd_wins_register_state *state =
 187                 tevent_req_callback_data(subreq,
 188                 struct nbtd_wins_register_state);
 189         struct nbtd_iface_name *iname = state->iname;
 190
 191         status = nbt_name_register_wins_recv(subreq, state, &state->io);
 192         TALLOC_FREE(subreq);
 193         if (NT_STATUS_EQUAL(status, NT_STATUS_IO_TIMEOUT)) {
 194                 /* none of the WINS servers responded - try again
 195                    periodically */
 196                 int wins_retry_time = lpcfg_parm_int(iname->iface->nbtsrv->task->lp_ctx, NULL, "nbtd", "wins_retry", 300);
 197                 tevent_add_timer(iname->iface->nbtsrv->task->event_ctx,
 198                                 iname,
 199                                 timeval_current_ofs(wins_retry_time, 0),
 200                                 nbtd_wins_register_retry,
 201                                 iname);
 202                 talloc_free(state);
 203                 return;
 204         }
 205
 206         if (!NT_STATUS_IS_OK(status)) {
 207                 DEBUG(1,("Name register failure with WINS for %s - %s\n",
 208                          nbt_name_string(state, &iname->name), nt_errstr(status)));
 209                 talloc_free(state);
 210                 return;
 211         }
 212
 213         if (state->io.out.rcode != 0) {
 214                 DEBUG(1,("WINS server %s rejected name register of %s - %s\n",
 215                          state->io.out.wins_server,
 216                          nbt_name_string(state, &iname->name),
 217                          nt_errstr(nbt_rcode_to_ntstatus(state->io.out.rcode))));
 218                 iname->nb_flags |= NBT_NM_CONFLICT;
 219                 talloc_free(state);
 220                 return;
 221         }
 222
 223         /* success - start a periodic name refresh */
 224         iname->nb_flags |= NBT_NM_ACTIVE;
 225         if (iname->wins_server) {
 226                 /*
 227                  * talloc_free() would generate a warning,
 228                  * so steal it into the tmp context
 229                  */
 230                 talloc_steal(state, iname->wins_server);
 231         }
 232         iname->wins_server = talloc_move(iname, &state->io.out.wins_server);
 233
 234         iname->registration_time = timeval_current();
 235
 236         DEBUG(3,("Registered %s with WINS server %s\n",
 237                  nbt_name_string(state, &iname->name), iname->wins_server));
 238
 239         talloc_free(state);
 240
 241         nbtd_wins_start_refresh_timer(iname);
 242 }
 243
 244 /*
 245   register a name with our WINS servers
 246 */
 247 void nbtd_winsclient_register(struct nbtd_iface_name *iname)
 248 {
 249         struct nbtd_interface *iface = iname->iface;
 250         struct nbt_name_socket *nbtsock = wins_socket(iface);
 251         struct nbtd_wins_register_state *state;
 252         struct tevent_req *subreq;
 253
 254         state = talloc_zero(iname, struct nbtd_wins_register_state);
 255         if (state == NULL) {
 256                 return;
 257         }
 258
 259         state->iname = iname;
 260
 261         /* setup a wins name register request */
 262         state->io.in.name         = iname->name;
 263         state->io.in.wins_port    = lpcfg_nbt_port(iface->nbtsrv->task->lp_ctx);
 264         state->io.in.wins_servers = lpcfg_wins_server_list(iface->nbtsrv->task->lp_ctx);
 265         state->io.in.addresses    = nbtd_address_list(iface, state);
 266         state->io.in.nb_flags     = iname->nb_flags;
 267         state->io.in.ttl          = iname->ttl;
 268
 269         if (state->io.in.addresses == NULL) {
 270                 talloc_free(state);
 271                 return;
 272         }
 273
 274         subreq = nbt_name_register_wins_send(state, iface->nbtsrv->task->event_ctx,
 275                                              nbtsock, &state->io);
 276         if (subreq == NULL) {
 277                 talloc_free(state);
 278                 return;
 279         }
 280
 281         tevent_req_set_callback(subreq, nbtd_wins_register_handler, state);
 282 }