source3/include/nameserv.h

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 1.9.
   4    NBT netbios header - version 2
   5    Copyright (C) Andrew Tridgell 1994-1995
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20
  21 */
  22
  23 #define GET_TTL(ttl) ((ttl)?MIN(ttl,lp_max_ttl()):lp_max_ttl())
  24
  25 /* NTAS uses 2, NT uses 1, WfWg uses 0 */
  26 #define MAINTAIN_LIST    2
  27 #define ELECTION_VERSION 1
  28
  29 #define MAX_DGRAM_SIZE (576) /* tcp/ip datagram limit is 576 bytes */
  30 #define MIN_DGRAM_SIZE 12
  31
  32 #define NMB_QUERY  0x20
  33 #define NMB_STATUS 0x21
  34
  35 #define NMB_REG         0x05 /* see rfc1002.txt 4.2.2,3,5,6,7,8 */
  36 #define NMB_REG_REFRESH 0x09 /* see rfc1002.txt 4.2.4 */
  37 #define NMB_REL         0x06 /* see rfc1002.txt 4.2.9,10,11 */
  38 #define NMB_WAIT_ACK    0x07 /* see rfc1002.txt 4.2.16 */
  39 /* XXXX what about all the other types?? 0x1, 0x2, 0x3, 0x4, 0x8? */
  40
  41 #define FIND_SELF  0x01
  42 #define FIND_WINS  0x02
  43 #define FIND_LOCAL 0x04
  44
  45 /* NetBIOS flags */
  46 #define NB_GROUP  0x80
  47 #define NB_PERM   0x02
  48 #define NB_ACTIVE 0x04
  49 #define NB_CONFL  0x08
  50 #define NB_DEREG  0x10
  51 #define NB_BFLAG  0x00
  52 #define NB_PFLAG  0x20
  53 #define NB_MFLAG  0x40
  54 #define NB__FLAG  0x60
  55 #define NB_FLGMSK 0x60
  56
  57 #define REFRESH_TIME (15*60)
  58 #define NAME_POLL_REFRESH_TIME (5*60)
  59 #define NAME_POLL_INTERVAL 15
  60
  61 /* NetBIOS flag identifier */
  62 #define NAME_PERMANENT(p) ((p) & NB_PERM)
  63 #define NAME_ACTIVE(p)    ((p) & NB_ACTIVE)
  64 #define NAME_CONFLICT(p)  ((p) & NB_CONFL)
  65 #define NAME_DEREG(p)     ((p) & NB_DEREG)
  66 #define NAME_GROUP(p)     ((p) & NB_GROUP)
  67
  68 #define NAME_BFLAG(p)     (((p) & NB_FLGMSK) == NB_BFLAG)
  69 #define NAME_PFLAG(p)     (((p) & NB_FLGMSK) == NB_PFLAG)
  70 #define NAME_MFLAG(p)     (((p) & NB_FLGMSK) == NB_MFLAG)
  71 #define NAME__FLAG(p)     (((p) & NB_FLGMSK) == NB__FLAG)
  72
  73 /* server type identifiers */
  74 #define AM_MASTER(work) (work->ServerType & SV_TYPE_MASTER_BROWSER)
  75 #define AM_BACKUP(work) (work->ServerType & SV_TYPE_BACKUP_BROWSER)
  76 #define AM_DOMCTL(work) (work->ServerType & SV_TYPE_DOMAIN_CTRL)
  77
  78 /* microsoft browser NetBIOS name */
  79 #define MSBROWSE "\001\002__MSBROWSE__\002"
  80
  81 /* mail slots */
  82 #define BROWSE_MAILSLOT    "\\MAILSLOT\\BROWSE"
  83 #define NET_LOGON_MAILSLOT "\\MAILSLOT\\NET\\NETLOGON"
  84
  85 enum name_source {STATUS_QUERY, LMHOSTS, REGISTER, SELF, DNS, DNSFAIL};
  86 enum node_type {B_NODE=0, P_NODE=1, M_NODE=2, NBDD_NODE=3};
  87 enum packet_type {NMB_PACKET, DGRAM_PACKET};
  88 enum master_state
  89 {
  90    MST_NONE,
  91    MST_WON,
  92    MST_MSB,
  93    MST_BROWSER,
  94    MST_DOMAIN_NONE,
  95    MST_DOMAIN_MEM,
  96    MST_DOMAIN_TST,
  97    MST_DOMAIN
  98 };
  99
 100 enum state_type
 101 {
 102         NAME_STATUS_PDC_SRV_CHK,
 103         NAME_STATUS_SRV_CHK,
 104         NAME_REGISTER_CHALLENGE,
 105         NAME_REGISTER,
 106         NAME_RELEASE,
 107         NAME_QUERY_CONFIRM,
 108         NAME_QUERY_SYNC,
 109         NAME_QUERY_PDC_SRV_CHK,
 110         NAME_QUERY_SRV_CHK,
 111         NAME_QUERY_FIND_MST,
 112         NAME_QUERY_MST_CHK
 113 };
 114
 115 /* a netbios name structure */
 116 struct nmb_name {
 117   char name[17];
 118   char scope[64];
 119   int name_type;
 120 };
 121
 122 /* this is the structure used for the local netbios name list */
 123 struct name_record
 124 {
 125   struct name_record *next;
 126   struct name_record *prev;
 127
 128   struct nmb_name name;    /* the netbios name */
 129   struct in_addr ip;       /* ip address of host that owns this name */
 130   int nb_flags;            /* netbios flags */
 131
 132   enum name_source source; /* where the name came from */
 133
 134   time_t death_time; /* time record must be removed (do not remove if 0) */
 135   time_t refresh_time; /* time record should be refreshed */
 136 };
 137
 138 /* browse and backup server cache for synchronising browse list */
 139 struct browse_cache_record
 140 {
 141         struct browse_cache_record *next;
 142         struct browse_cache_record *prev;
 143
 144         pstring name;
 145         int type;
 146         pstring group;
 147         struct in_addr ip;
 148         time_t sync_time;
 149         BOOL synced;
 150 };
 151
 152 /* this is used to hold the list of servers in my domain, and is */
 153 /* contained within lists of domains */
 154 struct server_record
 155 {
 156   struct server_record *next;
 157   struct server_record *prev;
 158
 159   struct server_info_struct serv;
 160   time_t death_time;
 161 };
 162
 163 /* a workgroup structure. it contains a list of servers */
 164 struct work_record
 165 {
 166   struct work_record *next;
 167   struct work_record *prev;
 168
 169   struct server_record *serverlist;
 170
 171   /* stage of development from non-master to master browser / domain master */
 172   enum master_state state;
 173
 174   /* work group info */
 175   fstring work_group;
 176   int     token;        /* used when communicating with backup browsers */
 177   int     ServerType;
 178
 179   /* announce info */
 180   time_t lastannounce_time;
 181   int announce_interval;
 182   BOOL    needannounce;
 183
 184
 185   /* election info */
 186   BOOL    RunningElection;
 187   BOOL    needelection;
 188   int     ElectionCount;
 189   uint32  ElectionCriterion;
 190 };
 191
 192 /* initiated name queries recorded in this list to track any responses... */
 193 struct response_record
 194 {
 195   struct response_record *next;
 196   struct response_record *prev;
 197
 198   uint16 response_id;
 199   enum state_type state;
 200
 201   int fd;
 202   int quest_type;
 203   struct nmb_name name;
 204   int nb_flags;
 205   time_t ttl;
 206
 207   BOOL bcast;
 208   BOOL recurse;
 209   struct in_addr send_ip;
 210   struct in_addr reply_to_ip;
 211
 212   int num_msgs;
 213
 214   time_t repeat_time;
 215   time_t repeat_interval;
 216   int    repeat_count;
 217 };
 218
 219 /* a subnet structure. it contains a list of workgroups and netbios names*/
 220
 221 /* note that a subnet of 255.255.255.255 contains all the WINS netbios names.
 222    all communication from such nodes are on a non-broadcast basis: they
 223    are point-to-point (P nodes) or mixed point-to-point and broadcast
 224    (M nodes). M nodes use point-to-point as a preference, and will use
 225    broadcasting for certain activities, or will resort to broadcasting as a
 226    last resort, if the WINS server fails (users of wfwg will notice that their
 227    machine often freezes for 30 seconds at a time intermittently, if the WINS
 228    server is down).
 229
 230    B nodes will have their own, totally separate subnet record, with their
 231    own netbios name set. these do NOT interact with other subnet records'
 232    netbios names, INCLUDING the WINS one (with an ip "address", so called,
 233    of 255.255.255.255)
 234
 235    there is a separate response list for each subnet record. in the case of
 236    the 255.255.255.255 subnet record (WINS), the WINS server will be able to
 237    use this to poll (infrequently!) each of its entries, to ensure that the
 238    names are still in use.
 239    XXXX this polling is a planned feature for a really over-cautious WINS server
 240 */
 241
 242 struct subnet_record
 243 {
 244   struct subnet_record *next;
 245   struct subnet_record *prev;
 246
 247   struct work_record *workgrouplist; /* list of workgroups */
 248   struct name_record *namelist;      /* list of netbios names */
 249   struct response_record *responselist; /* list of responses expected */
 250
 251   struct in_addr bcast_ip;
 252   struct in_addr mask_ip;
 253   struct in_addr myip;
 254
 255   BOOL my_interface;
 256 };
 257
 258 /* a resource record */
 259 struct res_rec {
 260   struct nmb_name rr_name;
 261   int rr_type;
 262   int rr_class;
 263   int ttl;
 264   int rdlength;
 265   char rdata[MAX_DGRAM_SIZE];
 266 };
 267
 268 /* define a nmb packet. */
 269 struct nmb_packet
 270 {
 271   struct {
 272     int name_trn_id;
 273     int opcode;
 274     BOOL response;
 275     struct {
 276       BOOL bcast;
 277       BOOL recursion_available;
 278       BOOL recursion_desired;
 279       BOOL trunc;
 280       BOOL authoritative;
 281     } nm_flags;
 282     int rcode;
 283     int qdcount;
 284     int ancount;
 285     int nscount;
 286     int arcount;
 287   } header;
 288
 289   struct {
 290     struct nmb_name question_name;
 291     int question_type;
 292     int question_class;
 293   } question;
 294
 295   struct res_rec *answers;
 296   struct res_rec *nsrecs;
 297   struct res_rec *additional;
 298 };
 299
 300
 301 /* a datagram - this normally contains SMB data in the data[] array */
 302 struct dgram_packet {
 303   struct {
 304     int msg_type;
 305     struct {
 306       enum node_type node_type;
 307       BOOL first;
 308       BOOL more;
 309     } flags;
 310     int dgm_id;
 311     struct in_addr source_ip;
 312     int source_port;
 313     int dgm_length;
 314     int packet_offset;
 315   } header;
 316   struct nmb_name source_name;
 317   struct nmb_name dest_name;
 318   int datasize;
 319   char data[MAX_DGRAM_SIZE];
 320 };
 321
 322 /* define a structure used to queue packets. this will be a linked
 323  list of nmb packets */
 324 struct packet_struct
 325 {
 326   struct packet_struct *next;
 327   struct packet_struct *prev;
 328   struct in_addr ip;
 329   int port;
 330   int fd;
 331   time_t timestamp;
 332   enum packet_type packet_type;
 333   union {
 334     struct nmb_packet nmb;
 335     struct dgram_packet dgram;
 336   } packet;
 337 };
 338
 339
 340 /* ids for netbios packet types */
 341 #define ANN_HostAnnouncement         1
 342 #define ANN_AnnouncementRequest      2
 343 #define ANN_Election                 8
 344 #define ANN_GetBackupListReq         9
 345 #define ANN_GetBackupListResp       10
 346 #define ANN_BecomeBackup            11
 347 #define ANN_DomainAnnouncement      12
 348 #define ANN_MasterAnnouncement      13
 349 #define ANN_ResetBrowserState       14
 350 #define ANN_LocalMasterAnnouncement 15
 351
 352
 353 /* broadcast packet announcement intervals, in minutes */
 354
 355 /* search for master browsers of workgroups samba knows about,
 356    except default */
 357 #define CHECK_TIME_MST_BROWSE       5
 358
 359 /* request backup browser announcements from other servers */
 360 #define CHECK_TIME_ANNOUNCE_BACKUP 15
 361
 362 /* request host announcements from other servers: min and max of interval */
 363 #define CHECK_TIME_MIN_HOST_ANNCE   3
 364 #define CHECK_TIME_MAX_HOST_ANNCE  12
 365
 366 /* announce as master to WINS server and any Primary Domain Controllers */
 367 #define CHECK_TIME_MST_ANNOUNCE    15
 368