2a7bb290709eaad7d9ff6fcdfad33b7999d10967
[samba.git] / source / 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-1997
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_ANY_NAME   0
42 #define FIND_SELF_NAME  1
43
44 /* NetBIOS flags */
45 #define NB_GROUP  0x80
46 #define NB_PERM   0x02
47 #define NB_ACTIVE 0x04
48 #define NB_CONFL  0x08
49 #define NB_DEREG  0x10
50 #define NB_BFLAG  0x00 /* broadcast node type */
51 #define NB_PFLAG  0x20 /* point-to-point node type */
52 #define NB_MFLAG  0x40 /* mixed bcast & p-p node type */
53 #define NB_HFLAG  0x60 /* microsoft 'hybrid' node type */
54 #define NB_FLGMSK 0x60
55
56 #define REFRESH_TIME (15*60)
57 #define NAME_POLL_REFRESH_TIME (5*60)
58 #define NAME_POLL_INTERVAL 15
59
60 /* NetBIOS flag identifier */
61 #define NAME_PERMANENT(p) ((p) & NB_PERM)
62 #define NAME_ACTIVE(p)    ((p) & NB_ACTIVE)
63 #define NAME_CONFLICT(p)  ((p) & NB_CONFL)
64 #define NAME_DEREG(p)     ((p) & NB_DEREG)
65 #define NAME_GROUP(p)     ((p) & NB_GROUP)
66
67 #define NAME_BFLAG(p)     (((p) & NB_FLGMSK) == NB_BFLAG)
68 #define NAME_PFLAG(p)     (((p) & NB_FLGMSK) == NB_PFLAG)
69 #define NAME_MFLAG(p)     (((p) & NB_FLGMSK) == NB_MFLAG)
70 #define NAME_HFLAG(p)     (((p) & NB_FLGMSK) == NB_HFLAG)
71
72 /* server type identifiers */
73 #define AM_MASTER(work) (work->ServerType & SV_TYPE_MASTER_BROWSER)
74 #define AM_BACKUP(work) (work->ServerType & SV_TYPE_BACKUP_BROWSER)
75 #define AM_DOMMST(work) (work->ServerType & SV_TYPE_DOMAIN_MASTER)
76 #define AM_DOMMEM(work) (work->ServerType & SV_TYPE_DOMAIN_MEMBER)
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 #define NT_LOGON_MAILSLOT  "\\MAILSLOT\\NET\\NTLOGON"
85
86 enum name_source {STATUS_QUERY, LMHOSTS, REGISTER, SELF, DNS, DNSFAIL};
87 enum node_type {B_NODE=0, P_NODE=1, M_NODE=2, NBDD_NODE=3};
88 enum packet_type {NMB_PACKET, DGRAM_PACKET};
89
90 enum master_state
91 {
92    MST_POTENTIAL,
93    MST_BACK,
94    MST_MSB,
95    MST_BROWSER
96 };
97
98 enum domain_state
99 {
100    DOMAIN_NONE,
101    DOMAIN_WAIT,
102    DOMAIN_MST
103 };
104
105 enum logon_state
106 {
107    LOGON_NONE,
108    LOGON_WAIT,
109    LOGON_SRV
110 };
111
112 enum state_type
113 {
114         NAME_STATUS_DOM_SRV_CHK,
115         NAME_STATUS_SRV_CHK,
116         NAME_REGISTER_CHALLENGE,
117         NAME_REGISTER,
118         NAME_RELEASE,
119         NAME_QUERY_CONFIRM,
120         NAME_QUERY_SYNC_LOCAL,
121         NAME_QUERY_SYNC_REMOTE,
122         NAME_QUERY_DOM_SRV_CHK,
123         NAME_QUERY_SRV_CHK,
124         NAME_QUERY_FIND_MST,
125         NAME_QUERY_MST_CHK,
126         NAME_QUERY_DOMAIN
127 };
128
129 /* a netbios name structure */
130 struct nmb_name {
131   char name[17];
132   char scope[64];
133   int name_type;
134 };
135
136 /* a netbios flags + ip address structure */
137 /* this is used for multi-homed systems and for internet group names */
138 struct nmb_ip
139 {
140   struct in_addr ip; /* ip address of host that owns this name */
141   uint16 nb_flags;      /* netbios flags */
142 };
143
144 /* this is the structure used for the local netbios name list */
145 struct name_record
146 {
147   struct name_record *next;
148   struct name_record *prev;
149
150   struct nmb_name name;    /* the netbios name */
151   struct nmb_ip *ip_flgs;  /* the ip + flags */
152   int num_ips;             /* number of ip+flags entries */
153
154   enum name_source source; /* where the name came from */
155
156   time_t death_time; /* time record must be removed (do not remove if 0) */
157   time_t refresh_time; /* time record should be refreshed */
158 };
159
160 struct subnet_record;
161
162 /* browse and backup server cache for synchronising browse list */
163 struct browse_cache_record
164 {
165         struct browse_cache_record *next;
166         struct browse_cache_record *prev;
167
168         pstring name;
169         int type;
170         pstring group;
171         struct in_addr ip;
172         time_t sync_time;
173         BOOL synced;
174         BOOL local;
175         struct subnet_record *subnet;
176 };
177
178 /* this is used to hold the list of servers in my domain, and is */
179 /* contained within lists of domains */
180 struct server_record
181 {
182   struct server_record *next;
183   struct server_record *prev;
184
185   struct server_info_struct serv;
186   time_t death_time;  
187 };
188
189 /* a workgroup structure. it contains a list of servers */
190 struct work_record
191 {
192   struct work_record *next;
193   struct work_record *prev;
194
195   struct server_record *serverlist;
196
197   /* stage of development from non-local-master up to local-master browser */
198   enum master_state mst_state;
199
200   /* stage of development from non-domain-master to domain master browser */
201   enum domain_state dom_state;
202
203   /* stage of development from non-logon-server to logon server */
204   enum logon_state log_state;
205
206   /* work group info */
207   fstring work_group;
208   int     token;        /* used when communicating with backup browsers */
209   int     ServerType;
210
211   /* announce info */
212   time_t lastannounce_time;
213   int announce_interval;
214   BOOL    needannounce;
215
216
217   /* election info */
218   BOOL    RunningElection;
219   BOOL    needelection;
220   int     ElectionCount;
221   uint32  ElectionCriterion;
222 };
223
224 /* initiated name queries recorded in this list to track any responses... */
225 /* sadly, we need to group everything together. i suppose that if this
226    gets unwieldy, then a union ought to be considered. oh for c++... */
227 struct response_record
228 {
229   struct response_record *next;
230   struct response_record *prev;
231
232   uint16 response_id;
233   enum state_type state;
234
235   int fd;
236   int quest_type;
237   struct nmb_name name;
238   int nb_flags;
239   time_t ttl;
240
241   int server_type;
242   fstring my_name;
243   fstring my_comment;
244
245   BOOL bcast;
246   BOOL recurse;
247   struct in_addr send_ip;
248   struct in_addr reply_to_ip;
249   int reply_id;
250
251   int num_msgs;
252
253   time_t repeat_time;
254   time_t repeat_interval;
255   int    repeat_count;
256 };
257
258 /* a subnet structure. it contains a list of workgroups and netbios names*/
259
260 /* note that a subnet of 255.255.255.255 contains all the WINS netbios names.
261    all communication from such nodes are on a non-broadcast basis: they
262    are point-to-point (P nodes) or mixed point-to-point and broadcast
263    (M nodes). M nodes use point-to-point as a preference, and will use
264    broadcasting for certain activities, or will resort to broadcasting as a
265    last resort, if the WINS server fails (users of wfwg will notice that their
266    machine often freezes for 30 seconds at a time intermittently, if the WINS
267    server is down).
268
269    B nodes will have their own, totally separate subnet record, with their
270    own netbios name set. these do NOT interact with other subnet records'
271    netbios names, INCLUDING the WINS one (with an ip "address", so called,
272    of 255.255.255.255)
273
274    there is a separate response list for each subnet record. in the case of
275    the 255.255.255.255 subnet record (WINS), the WINS server will be able to
276    use this to poll (infrequently!) each of its entries, to ensure that the
277    names are still in use.
278    XXXX this polling is a planned feature for a really over-cautious WINS server 
279 */
280
281 struct subnet_record
282 {
283   struct subnet_record *next;
284   struct subnet_record *prev;
285
286   struct work_record *workgrouplist; /* list of workgroups */
287   struct name_record *namelist;      /* list of netbios names */
288   struct response_record *responselist; /* list of responses expected */
289
290   struct in_addr bcast_ip;
291   struct in_addr mask_ip;
292   struct in_addr myip;
293   int nmb_sock;               /* socket to listen for unicast 137. */
294   int dgram_sock;             /* socket to listen for unicast 138. */
295 };
296
297 /* a resource record */
298 struct res_rec {
299   struct nmb_name rr_name;
300   int rr_type;
301   int rr_class;
302   int ttl;
303   int rdlength;
304   char rdata[MAX_DGRAM_SIZE];
305 };
306
307 /* define a nmb packet. */
308 struct nmb_packet
309 {
310   struct {
311     int name_trn_id;
312     int opcode;
313     BOOL response;
314     struct {
315       BOOL bcast;
316       BOOL recursion_available;
317       BOOL recursion_desired;
318       BOOL trunc;
319       BOOL authoritative;
320     } nm_flags;
321     int rcode;
322     int qdcount;
323     int ancount;
324     int nscount;
325     int arcount;
326   } header;
327
328   struct {
329     struct nmb_name question_name;
330     int question_type;
331     int question_class;
332   } question;
333
334   struct res_rec *answers;
335   struct res_rec *nsrecs;
336   struct res_rec *additional;
337 };
338
339
340 /* a datagram - this normally contains SMB data in the data[] array */
341 struct dgram_packet {
342   struct {
343     int msg_type;
344     struct {
345       enum node_type node_type;
346       BOOL first;
347       BOOL more;
348     } flags;
349     int dgm_id;
350     struct in_addr source_ip;
351     int source_port;
352     int dgm_length;
353     int packet_offset;
354   } header;
355   struct nmb_name source_name;
356   struct nmb_name dest_name;
357   int datasize;
358   char data[MAX_DGRAM_SIZE];
359 };
360
361 /* define a structure used to queue packets. this will be a linked
362  list of nmb packets */
363 struct packet_struct
364 {
365         struct packet_struct *next;
366         struct packet_struct *prev;
367         BOOL locked;
368         struct in_addr ip;
369         int port;
370         int fd;
371         time_t timestamp;
372         enum packet_type packet_type;
373         union {
374                 struct nmb_packet nmb;
375                 struct dgram_packet dgram;
376         } packet;
377 };
378
379 /* NETLOGON opcodes */
380 #define QUERYFORPDC     7 /* Query for PDC */
381 #define QUERYFORPDC_R   12 /* Response to Query for PDC */
382 #define SAMLOGON        18
383 #define SAMLOGON_R      19
384
385
386 /* ids for netbios packet types */
387 #define ANN_HostAnnouncement         1
388 #define ANN_AnnouncementRequest      2
389 #define ANN_Election                 8
390 #define ANN_GetBackupListReq         9
391 #define ANN_GetBackupListResp       10
392 #define ANN_BecomeBackup            11
393 #define ANN_DomainAnnouncement      12
394 #define ANN_MasterAnnouncement      13
395 #define ANN_ResetBrowserState       14
396 #define ANN_LocalMasterAnnouncement 15
397
398
399 /* broadcast packet announcement intervals, in minutes */
400
401 /* attempt to add domain logon and domain master names */
402 #define CHECK_TIME_ADD_DOM_NAMES 5 
403
404 /* search for master browsers of workgroups samba knows about, 
405    except default */
406 #define CHECK_TIME_MST_BROWSE       5 
407
408 /* request backup browser announcements from other servers */
409 #define CHECK_TIME_ANNOUNCE_BACKUP 15
410
411 /* request host announcements from other servers: min and max of interval */
412 #define CHECK_TIME_MIN_HOST_ANNCE   3
413 #define CHECK_TIME_MAX_HOST_ANNCE  12
414
415 /* announce as master to WINS server and any Primary Domain Controllers */
416 #define CHECK_TIME_MST_ANNOUNCE    15
417
418 /* do all remote announcements this often */
419 #define REMOTE_ANNOUNCE_INTERVAL 180
420
421 /* Types of machine we can announce as */
422 #define ANNOUNCE_AS_NT 1
423 #define ANNOUNCE_AS_WIN95 2
424 #define ANNOUNCE_AS_WFW 3
425
426 /* Macro's to enumerate subnets either with or without
427    the WINS subnet. */
428
429 extern struct subnet_record *subnetlist;
430 extern struct subnet_record *wins_client_subnet;
431
432 #define FIRST_SUBNET subnetlist
433 #define NEXT_SUBNET_EXCLUDING_WINS(x) ((x)->next)
434 #define NEXT_SUBNET_INCLUDING_WINS(x) ( ((x) == wins_client_subnet) ? NULL : \
435                                         (((x)->next == NULL) ? wins_client_subnet : \
436                                          (x)->next))
437