2 Unix SMB/Netbios implementation.
4 NBT netbios header - version 2
5 Copyright (C) Andrew Tridgell 1994-1995
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.
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.
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.
23 /* NTAS uses 2, NT uses 1, WfWg uses 0 */
24 #define MAINTAIN_LIST 2
25 #define ELECTION_VERSION 1
27 #define MAX_DGRAM_SIZE (576) /* tcp/ip datagram limit is 576 bytes */
28 #define MIN_DGRAM_SIZE 12
30 #define NMB_QUERY 0x20
31 #define NMB_STATUS 0x21
33 #define NMB_REG 0x05 /* see rfc1002.txt 4.2.2,3,5,6,7,8 */
34 #define NMB_REG_REFRESH 0x09 /* see rfc1002.txt 4.2.4 */
35 #define NMB_REL 0x06 /* see rfc1002.txt 4.2.9,10,11 */
36 #define NMB_WAIT_ACK 0x07 /* see rfc1002.txt 4.2.17 */
37 /* XXXX what about all the other types?? 0x1, 0x2, 0x3, 0x4, 0x8? */
42 #define NB_ACTIVE 0x04
49 #define NB_FLGMSK 0x60
51 #define REFRESH_TIME (15*60)
52 #define NAME_POLL_REFRESH_TIME (5*60)
53 #define NAME_POLL_INTERVAL 15
55 /* NetBIOS flag identifier */
56 #define NAME_PERMANENT(p) ((p) & NB_PERM)
57 #define NAME_ACTIVE(p) ((p) & NB_ACTIVE)
58 #define NAME_CONFLICT(p) ((p) & NB_CONFL)
59 #define NAME_DEREG(p) ((p) & NB_DEREG)
60 #define NAME_GROUP(p) ((p) & NB_GROUP)
62 #define NAME_BFLAG(p) (((p) & NB_FLGMSK) == NB_BFLAG)
63 #define NAME_PFLAG(p) (((p) & NB_FLGMSK) == NB_PFLAG)
64 #define NAME_MFLAG(p) (((p) & NB_FLGMSK) == NB_MFLAG)
65 #define NAME__FLAG(p) (((p) & NB_FLGMSK) == NB__FLAG)
67 /* server type identifiers */
68 #define AM_MASTER(work) (work->ServerType & SV_TYPE_MASTER_BROWSER)
69 #define AM_BACKUP(work) (work->ServerType & SV_TYPE_BACKUP_BROWSER)
70 #define AM_DOMCTL(work) (work->ServerType & SV_TYPE_DOMAIN_CTRL)
72 /* microsoft browser NetBIOS name */
73 #define MSBROWSE "\001\002__MSBROWSE__\002"
76 #define BROWSE_MAILSLOT "\\MAILSLOT\\BROWSE"
77 #define NET_LOGON_MAILSLOT "\\MAILSLOT\\NET\\NETLOGON"
79 enum name_source {STATUS_QUERY, LMHOSTS, REGISTER, SELF, DNS, DNSFAIL};
80 enum node_type {B_NODE=0, P_NODE=1, M_NODE=2, NBDD_NODE=3};
81 enum packet_type {NMB_PACKET, DGRAM_PACKET};
84 NAME_STATUS_MASTER_CHECK,
90 NAME_QUERY_MST_SRV_CHK,
96 /* a netbios name structure */
103 /* this is the structure used for the local netbios name list */
106 struct name_record *next;
107 struct name_record *prev;
109 struct nmb_name name; /* the netbios name */
110 struct in_addr ip; /* ip address of host that owns this name */
111 int nb_flags; /* netbios flags */
113 enum name_source source; /* where the name came from */
115 time_t death_time; /* time record must be removed (do not remove if 0) */
116 time_t refresh_time; /* time record should be refreshed */
119 /* browse and backup server cache for synchronising browse list */
120 struct browse_cache_record
122 struct browse_cache_record *next;
123 struct browse_cache_record *prev;
133 /* this is used to hold the list of servers in my domain, and is */
134 /* contained within lists of domains */
137 struct server_record *next;
138 struct server_record *prev;
140 struct server_info_struct serv;
144 /* a workgroup structure. it contains a list of servers */
147 struct work_record *next;
148 struct work_record *prev;
150 struct server_record *serverlist;
152 /* work group info */
154 int token; /* used when communicating with backup browsers */
158 time_t lastannounce_time;
159 int announce_interval;
163 BOOL RunningElection;
166 uint32 ElectionCriterion;
169 /* initiated name queries recorded in this list to track any responses... */
170 struct response_record
172 struct response_record *next;
173 struct response_record *prev;
176 enum state_type state;
180 struct nmb_name name;
186 struct in_addr to_ip;
191 time_t repeat_interval;
195 /* a subnet structure. it contains a list of workgroups and netbios names*/
197 /* note that a subnet of 255.255.255.255 contains all the WINS netbios names.
198 all communication from such nodes are on a non-broadcast basis: they
199 are point-to-point (P nodes) or mixed point-to-point and broadcast
200 (M nodes). M nodes use point-to-point as a preference, and will use
201 broadcasting for certain activities, or will resort to broadcasting as a
202 last resort, if the WINS server fails (users of wfwg will notice that their
203 machine often freezes for 30 seconds at a time intermittently, if the WINS
206 B nodes will have their own, totally separate subnet record, with their
207 own netbios name set. these do NOT interact with other subnet records'
208 netbios names, INCLUDING the WINS one (with an ip "address", so called,
211 there is a separate response list for each subnet record. in the case of
212 the 255.255.255.255 subnet record (WINS), the WINS server will be able to
213 use this to poll (infrequently!) each of its entries, to ensure that the
214 names are still in use.
215 XXXX this polling is a planned feature for a really over-cautious WINS server
220 struct subnet_record *next;
221 struct subnet_record *prev;
223 struct work_record *workgrouplist; /* list of workgroups */
224 struct name_record *namelist; /* list of netbios names */
225 struct response_record *responselist; /* list of responses expected */
227 struct in_addr bcast_ip;
228 struct in_addr mask_ip;
234 /* a resource record */
236 struct nmb_name rr_name;
241 char rdata[MAX_DGRAM_SIZE];
244 /* define a nmb packet. */
253 BOOL recursion_available;
254 BOOL recursion_desired;
266 struct nmb_name question_name;
271 struct res_rec *answers;
272 struct res_rec *nsrecs;
273 struct res_rec *additional;
277 /* a datagram - this normally contains SMB data in the data[] array */
278 struct dgram_packet {
282 enum node_type node_type;
287 struct in_addr source_ip;
292 struct nmb_name source_name;
293 struct nmb_name dest_name;
295 char data[MAX_DGRAM_SIZE];
298 /* define a structure used to queue packets. this will be a linked
299 list of nmb packets */
302 struct packet_struct *next;
303 struct packet_struct *prev;
308 enum packet_type packet_type;
310 struct nmb_packet nmb;
311 struct dgram_packet dgram;
316 /* ids for netbios packet types */
317 #define ANN_HostAnnouncement 1
318 #define ANN_AnnouncementRequest 2
319 #define ANN_Election 8
320 #define ANN_GetBackupListReq 9
321 #define ANN_GetBackupListResp 10
322 #define ANN_BecomeBackup 11
323 #define ANN_DomainAnnouncement 12
324 #define ANN_MasterAnnouncement 13
325 #define ANN_ResetBrowserState 14
326 #define ANN_LocalMasterAnnouncement 15
329 /* broadcast packet announcement intervals, in minutes */
331 /* search for master browsers of workgroups samba knows about,
333 #define CHECK_TIME_MST_BROWSE 5
335 /* request backup browser announcements from other servers */
336 #define CHECK_TIME_ANNOUNCE_BACKUP 15
338 /* request host announcements from other servers: min and max of interval */
339 #define CHECK_TIME_MIN_HOST_ANNCE 3
340 #define CHECK_TIME_MAX_HOST_ANNCE 12
342 /* announce as master to WINS server and any Primary Domain Controllers */
343 #define CHECK_TIME_MST_ANNOUNCE 15