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 /* broadcast node type */
  52 #define NB_PFLAG  0x20 /* point-to-point node type */
  53 #define NB_MFLAG  0x40 /* mixed bcast & p-p node type */
  54 #define NB_HFLAG  0x60 /* microsoft 'hybrid' node type */
  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_HFLAG(p)     (((p) & NB_FLGMSK) == NB_HFLAG)
  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_DOM_SRV_CHK,
 103         NAME_STATUS_SRV_CHK,
 104         NAME_REGISTER_CHALLENGE,
 105         NAME_REGISTER,
 106         NAME_RELEASE,
 107         NAME_QUERY_CONFIRM,
 108         NAME_QUERY_ANNOUNCE_HOST,
 109         NAME_QUERY_SYNC_LOCAL,
 110         NAME_QUERY_SYNC_REMOTE,
 111         NAME_QUERY_DOM_SRV_CHK,
 112         NAME_QUERY_SRV_CHK,
 113         NAME_QUERY_FIND_MST,
 114         NAME_QUERY_MST_CHK
 115 };
 116
 117 /* a netbios name structure */
 118 struct nmb_name {
 119   char name[17];
 120   char scope[64];
 121   int name_type;
 122 };
 123
 124 /* a netbios flags + ip address structure */
 125 /* this is used for multi-homed systems and for internet group names */
 126 struct nmb_ip
 127 {
 128   struct in_addr ip; /* ip address of host that owns this name */
 129   uint16 nb_flags;      /* netbios flags */
 130 };
 131
 132 /* this is the structure used for the local netbios name list */
 133 struct name_record
 134 {
 135   struct name_record *next;
 136   struct name_record *prev;
 137
 138   struct nmb_name name;    /* the netbios name */
 139   struct nmb_ip *ip_flgs;  /* the ip + flags */
 140   int num_ips;             /* number of ip+flags entries */
 141
 142   enum name_source source; /* where the name came from */
 143
 144   time_t death_time; /* time record must be removed (do not remove if 0) */
 145   time_t refresh_time; /* time record should be refreshed */
 146 };
 147
 148 /* browse and backup server cache for synchronising browse list */
 149 struct browse_cache_record
 150 {
 151         struct browse_cache_record *next;
 152         struct browse_cache_record *prev;
 153
 154         pstring name;
 155         int type;
 156         pstring group;
 157         struct in_addr ip;
 158         time_t sync_time;
 159         BOOL synced;
 160         BOOL local;
 161 };
 162
 163 /* this is used to hold the list of servers in my domain, and is */
 164 /* contained within lists of domains */
 165 struct server_record
 166 {
 167   struct server_record *next;
 168   struct server_record *prev;
 169
 170   struct server_info_struct serv;
 171   time_t death_time;
 172 };
 173
 174 /* a workgroup structure. it contains a list of servers */
 175 struct work_record
 176 {
 177   struct work_record *next;
 178   struct work_record *prev;
 179
 180   struct server_record *serverlist;
 181
 182   /* stage of development from non-master to master browser / domain master */
 183   enum master_state state;
 184
 185   /* work group info */
 186   fstring work_group;
 187   int     token;        /* used when communicating with backup browsers */
 188   int     ServerType;
 189
 190   /* announce info */
 191   time_t lastannounce_time;
 192   int announce_interval;
 193   BOOL    needannounce;
 194
 195
 196   /* election info */
 197   BOOL    RunningElection;
 198   BOOL    needelection;
 199   int     ElectionCount;
 200   uint32  ElectionCriterion;
 201 };
 202
 203 /* initiated name queries recorded in this list to track any responses... */
 204 /* sadly, we need to group everything together. i suppose that if this
 205    gets unwieldy, then a union ought to be considered. oh for c++... */
 206 struct response_record
 207 {
 208   struct response_record *next;
 209   struct response_record *prev;
 210
 211   uint16 response_id;
 212   enum state_type state;
 213
 214   int fd;
 215   int quest_type;
 216   struct nmb_name name;
 217   int nb_flags;
 218   time_t ttl;
 219
 220   int server_type;
 221   fstring my_name;
 222   fstring my_comment;
 223
 224   BOOL bcast;
 225   BOOL recurse;
 226   struct in_addr send_ip;
 227   struct in_addr reply_to_ip;
 228
 229   int num_msgs;
 230
 231   time_t repeat_time;
 232   time_t repeat_interval;
 233   int    repeat_count;
 234 };
 235
 236 /* a subnet structure. it contains a list of workgroups and netbios names*/
 237
 238 /* note that a subnet of 255.255.255.255 contains all the WINS netbios names.
 239    all communication from such nodes are on a non-broadcast basis: they
 240    are point-to-point (P nodes) or mixed point-to-point and broadcast
 241    (M nodes). M nodes use point-to-point as a preference, and will use
 242    broadcasting for certain activities, or will resort to broadcasting as a
 243    last resort, if the WINS server fails (users of wfwg will notice that their
 244    machine often freezes for 30 seconds at a time intermittently, if the WINS
 245    server is down).
 246
 247    B nodes will have their own, totally separate subnet record, with their
 248    own netbios name set. these do NOT interact with other subnet records'
 249    netbios names, INCLUDING the WINS one (with an ip "address", so called,
 250    of 255.255.255.255)
 251
 252    there is a separate response list for each subnet record. in the case of
 253    the 255.255.255.255 subnet record (WINS), the WINS server will be able to
 254    use this to poll (infrequently!) each of its entries, to ensure that the
 255    names are still in use.
 256    XXXX this polling is a planned feature for a really over-cautious WINS server
 257 */
 258
 259 struct subnet_record
 260 {
 261   struct subnet_record *next;
 262   struct subnet_record *prev;
 263
 264   struct work_record *workgrouplist; /* list of workgroups */
 265   struct name_record *namelist;      /* list of netbios names */
 266   struct response_record *responselist; /* list of responses expected */
 267
 268   struct in_addr bcast_ip;
 269   struct in_addr mask_ip;
 270   struct in_addr myip;
 271 };
 272
 273 /* a resource record */
 274 struct res_rec {
 275   struct nmb_name rr_name;
 276   int rr_type;
 277   int rr_class;
 278   int ttl;
 279   int rdlength;
 280   char rdata[MAX_DGRAM_SIZE];
 281 };
 282
 283 /* define a nmb packet. */
 284 struct nmb_packet
 285 {
 286   struct {
 287     int name_trn_id;
 288     int opcode;
 289     BOOL response;
 290     struct {
 291       BOOL bcast;
 292       BOOL recursion_available;
 293       BOOL recursion_desired;
 294       BOOL trunc;
 295       BOOL authoritative;
 296     } nm_flags;
 297     int rcode;
 298     int qdcount;
 299     int ancount;
 300     int nscount;
 301     int arcount;
 302   } header;
 303
 304   struct {
 305     struct nmb_name question_name;
 306     int question_type;
 307     int question_class;
 308   } question;
 309
 310   struct res_rec *answers;
 311   struct res_rec *nsrecs;
 312   struct res_rec *additional;
 313 };
 314
 315
 316 /* a datagram - this normally contains SMB data in the data[] array */
 317 struct dgram_packet {
 318   struct {
 319     int msg_type;
 320     struct {
 321       enum node_type node_type;
 322       BOOL first;
 323       BOOL more;
 324     } flags;
 325     int dgm_id;
 326     struct in_addr source_ip;
 327     int source_port;
 328     int dgm_length;
 329     int packet_offset;
 330   } header;
 331   struct nmb_name source_name;
 332   struct nmb_name dest_name;
 333   int datasize;
 334   char data[MAX_DGRAM_SIZE];
 335 };
 336
 337 /* define a structure used to queue packets. this will be a linked
 338  list of nmb packets */
 339 struct packet_struct
 340 {
 341   struct packet_struct *next;
 342   struct packet_struct *prev;
 343   struct in_addr ip;
 344   int port;
 345   int fd;
 346   time_t timestamp;
 347   enum packet_type packet_type;
 348   union {
 349     struct nmb_packet nmb;
 350     struct dgram_packet dgram;
 351   } packet;
 352 };
 353
 354
 355 /* ids for netbios packet types */
 356 #define ANN_HostAnnouncement         1
 357 #define ANN_AnnouncementRequest      2
 358 #define ANN_Election                 8
 359 #define ANN_GetBackupListReq         9
 360 #define ANN_GetBackupListResp       10
 361 #define ANN_BecomeBackup            11
 362 #define ANN_DomainAnnouncement      12
 363 #define ANN_MasterAnnouncement      13
 364 #define ANN_ResetBrowserState       14
 365 #define ANN_LocalMasterAnnouncement 15
 366
 367
 368 /* broadcast packet announcement intervals, in minutes */
 369
 370 /* search for master browsers of workgroups samba knows about,
 371    except default */
 372 #define CHECK_TIME_MST_BROWSE       5
 373
 374 /* request backup browser announcements from other servers */
 375 #define CHECK_TIME_ANNOUNCE_BACKUP 15
 376
 377 /* request host announcements from other servers: min and max of interval */
 378 #define CHECK_TIME_MIN_HOST_ANNCE   3
 379 #define CHECK_TIME_MAX_HOST_ANNCE  12
 380
 381 /* announce as master to WINS server and any Primary Domain Controllers */
 382 #define CHECK_TIME_MST_ANNOUNCE    15
 383
 384 /* do all remote announcements this often */
 385 #define REMOTE_ANNOUNCE_INTERVAL 180
 386
 387 #define DFLT_SERVER_TYPE (SV_TYPE_WORKSTATION | SV_TYPE_SERVER | \
 388                           SV_TYPE_TIME_SOURCE | SV_TYPE_SERVER_UNIX | \
 389                           SV_TYPE_PRINTQ_SERVER | SV_TYPE_SERVER_NT | \
 390                           SV_TYPE_NT)
 391