source4/libcli/nbt/libnbt.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    a raw async NBT library
   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 #ifndef __LIBNBT_H__
  23 #define __LIBNBT_H__
  24
  25 #include "librpc/gen_ndr/nbt.h"
  26
  27 /*
  28   possible states for pending requests
  29 */
  30 enum nbt_request_state {NBT_REQUEST_SEND,
  31                         NBT_REQUEST_WAIT,
  32                         NBT_REQUEST_DONE,
  33                         NBT_REQUEST_TIMEOUT,
  34                         NBT_REQUEST_ERROR};
  35
  36 /*
  37   a nbt name request
  38 */
  39 struct nbt_name_request {
  40         struct nbt_name_request *next, *prev;
  41
  42         enum nbt_request_state state;
  43
  44         NTSTATUS status;
  45
  46         /* the socket this was on */
  47         struct nbt_name_socket *nbtsock;
  48
  49         /* where to send the request */
  50         struct socket_address *dest;
  51
  52         /* timeout between retries */
  53         int timeout;
  54
  55         /* how many retries to send on timeout */
  56         int num_retries;
  57
  58         /* whether we have received a WACK */
  59         bool received_wack;
  60
  61         /* the timeout event */
  62         struct timed_event *te;
  63
  64         /* the name transaction id */
  65         uint16_t name_trn_id;
  66
  67         /* is it a reply? */
  68         bool is_reply;
  69
  70         /* the encoded request */
  71         DATA_BLOB encoded;
  72
  73         /* shall we allow multiple replies? */
  74         bool allow_multiple_replies;
  75
  76         unsigned int num_replies;
  77         struct nbt_name_reply {
  78                 struct nbt_name_packet *packet;
  79                 struct socket_address *dest;
  80         } *replies;
  81
  82         /* information on what to do on completion */
  83         struct {
  84                 void (*fn)(struct nbt_name_request *);
  85                 void *private;
  86         } async;
  87 };
  88
  89
  90
  91 /*
  92   context structure for operations on name queries
  93 */
  94 struct nbt_name_socket {
  95         struct socket_context *sock;
  96         struct event_context *event_ctx;
  97         struct smb_iconv_convenience *iconv_convenience;
  98
  99         /* a queue of requests pending to be sent */
 100         struct nbt_name_request *send_queue;
 101
 102         /* the fd event */
 103         struct fd_event *fde;
 104
 105         /* mapping from name_trn_id to pending event */
 106         struct idr_context *idr;
 107
 108         /* how many requests are waiting for a reply */
 109         uint16_t num_pending;
 110
 111         /* what to do with incoming request packets */
 112         struct {
 113                 void (*handler)(struct nbt_name_socket *, struct nbt_name_packet *,
 114                                 struct socket_address *);
 115                 void *private;
 116         } incoming;
 117
 118         /* what to do with unexpected replies */
 119         struct {
 120                 void (*handler)(struct nbt_name_socket *, struct nbt_name_packet *,
 121                                 struct socket_address *);
 122                 void *private;
 123         } unexpected;
 124 };
 125
 126
 127 /* a simple name query */
 128 struct nbt_name_query {
 129         struct {
 130                 struct nbt_name name;
 131                 const char *dest_addr;
 132                 uint16_t dest_port;
 133                 bool broadcast;
 134                 bool wins_lookup;
 135                 int timeout; /* in seconds */
 136                 int retries;
 137         } in;
 138         struct {
 139                 const char *reply_from;
 140                 struct nbt_name name;
 141                 int16_t num_addrs;
 142                 const char **reply_addrs;
 143         } out;
 144 };
 145
 146 /* a simple name status query */
 147 struct nbt_name_status {
 148         struct {
 149                 struct nbt_name name;
 150                 const char *dest_addr;
 151                 uint16_t dest_port;
 152                 int timeout; /* in seconds */
 153                 int retries;
 154         } in;
 155         struct {
 156                 const char *reply_from;
 157                 struct nbt_name name;
 158                 struct nbt_rdata_status status;
 159         } out;
 160 };
 161
 162 /* a name registration request */
 163 struct nbt_name_register {
 164         struct {
 165                 struct nbt_name name;
 166                 const char *dest_addr;
 167                 uint16_t dest_port;
 168                 const char *address;
 169                 uint16_t nb_flags;
 170                 bool register_demand;
 171                 bool broadcast;
 172                 bool multi_homed;
 173                 uint32_t ttl;
 174                 int timeout; /* in seconds */
 175                 int retries;
 176         } in;
 177         struct {
 178                 const char *reply_from;
 179                 struct nbt_name name;
 180                 const char *reply_addr;
 181                 uint8_t rcode;
 182         } out;
 183 };
 184
 185 /* a send 3 times then demand name broadcast name registration */
 186 struct nbt_name_register_bcast {
 187         struct {
 188                 struct nbt_name name;
 189                 const char *dest_addr;
 190                 uint16_t dest_port;
 191                 const char *address;
 192                 uint16_t nb_flags;
 193                 uint32_t ttl;
 194         } in;
 195 };
 196
 197
 198 /* wins name register with multiple wins servers to try and multiple
 199    addresses to register */
 200 struct nbt_name_register_wins {
 201         struct {
 202                 struct nbt_name name;
 203                 const char **wins_servers;
 204                 uint16_t wins_port;
 205                 const char **addresses;
 206                 uint16_t nb_flags;
 207                 uint32_t ttl;
 208         } in;
 209         struct {
 210                 const char *wins_server;
 211                 uint8_t rcode;
 212         } out;
 213 };
 214
 215
 216
 217 /* a name refresh request */
 218 struct nbt_name_refresh {
 219         struct {
 220                 struct nbt_name name;
 221                 const char *dest_addr;
 222                 uint16_t dest_port;
 223                 const char *address;
 224                 uint16_t nb_flags;
 225                 bool broadcast;
 226                 uint32_t ttl;
 227                 int timeout; /* in seconds */
 228                 int retries;
 229         } in;
 230         struct {
 231                 const char *reply_from;
 232                 struct nbt_name name;
 233                 const char *reply_addr;
 234                 uint8_t rcode;
 235         } out;
 236 };
 237
 238 /* wins name refresh with multiple wins servers to try and multiple
 239    addresses to register */
 240 struct nbt_name_refresh_wins {
 241         struct {
 242                 struct nbt_name name;
 243                 const char **wins_servers;
 244                 uint16_t wins_port;
 245                 const char **addresses;
 246                 uint16_t nb_flags;
 247                 uint32_t ttl;
 248         } in;
 249         struct {
 250                 const char *wins_server;
 251                 uint8_t rcode;
 252         } out;
 253 };
 254
 255
 256 /* a name release request */
 257 struct nbt_name_release {
 258         struct {
 259                 struct nbt_name name;
 260                 const char *dest_addr;
 261                 uint16_t dest_port;
 262                 const char *address;
 263                 uint16_t nb_flags;
 264                 bool broadcast;
 265                 int timeout; /* in seconds */
 266                 int retries;
 267         } in;
 268         struct {
 269                 const char *reply_from;
 270                 struct nbt_name name;
 271                 const char *reply_addr;
 272                 uint8_t rcode;
 273         } out;
 274 };
 275
 276 #include "libcli/nbt/nbt_proto.h"
 277
 278 #endif /* __LIBNBT_H__ */