9e62603594a1e8a0a16f3c4b1d15c264a74f7190
[kai/samba.git] / source3 / include / nameserv.h
1 #ifndef _NAMESERV_H_
2 #define _NAMESERV_H_
3 /* 
4    Unix SMB/Netbios implementation.
5    Version 1.9.
6    NBT netbios header - version 2
7    Copyright (C) Andrew Tridgell 1994-1998
8    
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 2 of the License, or
12    (at your option) any later version.
13    
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18    
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22    
23 */
24
25 #define INFO_VERSION    "INFO/version"
26 #define INFO_COUNT      "INFO/num_entries"
27 #define INFO_ID_HIGH    "INFO/id_high"
28 #define INFO_ID_LOW     "INFO/id_low"
29 #define ENTRY_PREFIX    "ENTRY/"
30
31 #define PERMANENT_TTL 0
32
33 /* NTAS uses 2, NT uses 1, WfWg uses 0 */
34 #define MAINTAIN_LIST    2
35 #define ELECTION_VERSION 1
36
37 #define MAX_DGRAM_SIZE (576) /* tcp/ip datagram limit is 576 bytes */
38 #define MIN_DGRAM_SIZE 12
39
40 /*********************************************************
41  Types of reply packet.
42 **********************************************************/
43
44 enum netbios_reply_type_code { NMB_QUERY, NMB_STATUS, NMB_REG, NMB_REG_REFRESH,
45                                NMB_REL, NMB_WAIT_ACK, NMB_MULTIHOMED_REG,
46                                WINS_REG, WINS_QUERY };
47
48 /* From rfc1002, 4.2.1.2 */
49 /* Question types. */
50 #define QUESTION_TYPE_NB_QUERY  0x20
51 #define QUESTION_TYPE_NB_STATUS 0x21
52
53 /* Question class */
54 #define QUESTION_CLASS_IN  0x1
55
56 /* Opcode definitions */
57 #define NMB_NAME_QUERY_OPCODE       0x0
58 #define NMB_NAME_REG_OPCODE         0x05 /* see rfc1002.txt 4.2.2,3,5,6,7,8 */
59 #define NMB_NAME_RELEASE_OPCODE     0x06 /* see rfc1002.txt 4.2.9,10,11 */
60 #define NMB_WACK_OPCODE             0x07 /* see rfc1002.txt 4.2.16 */
61 /* Ambiguity in rfc1002 about which of these is correct. */
62 /* WinNT uses 8 by default but can be made to use 9. */
63 #define NMB_NAME_REFRESH_OPCODE_8   0x08 /* see rfc1002.txt 4.2.4 */
64 #define NMB_NAME_REFRESH_OPCODE_9   0x09 /* see rfc1002.txt 4.2.4 */
65 #define NMB_NAME_MULTIHOMED_REG_OPCODE 0x0F /* Invented by Microsoft. */
66
67 /* XXXX what about all the other types?? 0x1, 0x2, 0x3, 0x4, 0x8? */
68
69 /* Resource record types. rfc1002 4.2.1.3 */
70 #define RR_TYPE_A                  0x1
71 #define RR_TYPE_NS                 0x2
72 #define RR_TYPE_NULL               0xA
73 #define RR_TYPE_NB                0x20
74 #define RR_TYPE_NBSTAT            0x21
75
76 /* Resource record class. */
77 #define RR_CLASS_IN                0x1
78
79 /* NetBIOS flags */
80 #define NB_GROUP  0x80
81 #define NB_PERM   0x02
82 #define NB_ACTIVE 0x04
83 #define NB_CONFL  0x08
84 #define NB_DEREG  0x10
85 #define NB_BFLAG  0x00 /* Broadcast node type. */
86 #define NB_PFLAG  0x20 /* Point-to-point node type. */
87 #define NB_MFLAG  0x40 /* Mixed bcast & p-p node type. */
88 #define NB_HFLAG  0x60 /* Microsoft 'hybrid' node type. */
89 #define NB_NODETYPEMASK 0x60
90 /* Mask applied to outgoing NetBIOS flags. */
91 #define NB_FLGMSK 0xE0
92
93 /* The wins flags. Looks like the nbflags ! */
94 #define WINS_UNIQUE     0x00 /* Unique record */
95 #define WINS_NGROUP     0x01 /* Normal Group eg: 1B */
96 #define WINS_SGROUP     0x02 /* Special Group eg: 1C */
97 #define WINS_MHOMED     0x03 /* MultiHomed */
98
99 #define WINS_ACTIVE     0x00 /* active record */
100 #define WINS_RELEASED   0x04 /* released record */
101 #define WINS_TOMBSTONED 0x08 /* tombstoned record */
102 #define WINS_DELETED    0x0C /* deleted record */
103
104 #define WINS_STATE_MASK 0x0C
105
106 #define WINS_LOCAL      0x00 /* local record */
107 #define WINS_REMOTE     0x10 /* remote record */
108
109 #define WINS_BNODE      0x00 /* Broadcast node */
110 #define WINS_PNODE      0x20 /* PtP node */
111 #define WINS_MNODE      0x40 /* Mixed node */
112 #define WINS_HNODE      0x60 /* Hybrid node */
113
114 #define WINS_NONSTATIC  0x00 /* dynamic record */
115 #define WINS_STATIC     0x80 /* static record */
116
117 #define WINS_STATE_ACTIVE(p) (((p)->data.wins_flags & WINS_STATE_MASK) == WINS_ACTIVE)
118
119
120 /* NetBIOS flag identifier. */
121 #define NAME_GROUP(p)  ((p)->data.nb_flags & NB_GROUP)
122 #define NAME_BFLAG(p) (((p)->data.nb_flags & NB_NODETYPEMASK) == NB_BFLAG)
123 #define NAME_PFLAG(p) (((p)->data.nb_flags & NB_NODETYPEMASK) == NB_PFLAG)
124 #define NAME_MFLAG(p) (((p)->data.nb_flags & NB_NODETYPEMASK) == NB_MFLAG)
125 #define NAME_HFLAG(p) (((p)->data.nb_flags & NB_NODETYPEMASK) == NB_HFLAG)
126
127 /* Samba name state for a name in a namelist. */
128 #define NAME_IS_ACTIVE(p)        ((p)->data.nb_flags & NB_ACTIVE)
129 #define NAME_IN_CONFLICT(p)      ((p)->data.nb_flags & NB_CONFL)
130 #define NAME_IS_DEREGISTERING(p) ((p)->data.nb_flags & NB_DEREG)
131
132 /* Error codes for NetBIOS requests. */
133 #define FMT_ERR   0x1       /* Packet format error. */
134 #define SRV_ERR   0x2       /* Internal server error. */
135 #define NAM_ERR   0x3       /* Name does not exist. */
136 #define IMP_ERR   0x4       /* Request not implemented. */
137 #define RFS_ERR   0x5       /* Request refused. */
138 #define ACT_ERR   0x6       /* Active error - name owned by another host. */
139 #define CFT_ERR   0x7       /* Name in conflict error. */
140
141 #define REFRESH_TIME (15*60)
142 #define NAME_POLL_REFRESH_TIME (5*60)
143 #define NAME_POLL_INTERVAL 15
144
145 /* Workgroup state identifiers. */
146 #define AM_POTENTIAL_MASTER_BROWSER(work) ((work)->mst_state == MST_POTENTIAL)
147 #define AM_LOCAL_MASTER_BROWSER(work) ((work)->mst_state == MST_BROWSER)
148 #define AM_DOMAIN_MASTER_BROWSER(work) ((work)->dom_state == DOMAIN_MST)
149 #define AM_DOMAIN_MEMBER(work) ((work)->log_state == LOGON_SRV)
150
151 /* Microsoft browser NetBIOS name. */
152 #define MSBROWSE "\001\002__MSBROWSE__\002"
153
154 /* Mail slots. */
155 #define BROWSE_MAILSLOT    "\\MAILSLOT\\BROWSE"
156 #define NET_LOGON_MAILSLOT "\\MAILSLOT\\NET\\NETLOGON"
157 #define NT_LOGON_MAILSLOT  "\\MAILSLOT\\NET\\NTLOGON"
158 #define LANMAN_MAILSLOT    "\\MAILSLOT\\LANMAN"
159
160 /* Samba definitions for find_name_on_subnet(). */
161 #define FIND_ANY_NAME   0
162 #define FIND_SELF_NAME  1
163
164 /*
165  * The different name types that can be in namelists.
166  *
167  * SELF_NAME should only be on the broadcast and unicast subnets.
168  * LMHOSTS_NAME should only be in the remote_broadcast_subnet.
169  * REGISTER_NAME, DNS_NAME, DNSFAIL_NAME should only be in the wins_server_subnet.
170  * WINS_PROXY_NAME should only be on the broadcast subnets.
171  * PERMANENT_NAME can be on all subnets except remote_broadcast_subnet.
172  *
173  */
174
175 enum name_source {LMHOSTS_NAME, REGISTER_NAME, SELF_NAME, DNS_NAME, 
176                   DNSFAIL_NAME, PERMANENT_NAME, WINS_PROXY_NAME};
177 enum node_type {B_NODE=0, P_NODE=1, M_NODE=2, NBDD_NODE=3};
178 enum packet_type {NMB_PACKET, DGRAM_PACKET};
179
180 enum master_state
181 {
182   MST_NONE,
183   MST_POTENTIAL,
184   MST_BACKUP,
185   MST_MSB,
186   MST_BROWSER,
187   MST_UNBECOMING_MASTER
188 };
189
190 enum domain_state
191 {
192   DOMAIN_NONE,
193   DOMAIN_WAIT,
194   DOMAIN_MST
195 };
196
197 enum logon_state
198 {
199   LOGON_NONE,
200   LOGON_WAIT,
201   LOGON_SRV
202 };
203
204 struct subnet_record;
205
206 struct nmb_data
207 {
208   uint16 nb_flags;         /* Netbios flags. */
209   int num_ips;             /* Number of ip entries. */
210   struct in_addr *ip;      /* The ip list for this name. */
211
212   enum name_source source; /* Where the name came from. */
213
214   time_t death_time; /* The time the record must be removed (do not remove if 0). */
215   time_t refresh_time; /* The time the record should be refreshed. */
216   
217   SMB_BIG_UINT id;              /* unique id */
218   struct in_addr wins_ip;       /* the adress of the wins server this record comes from */
219
220   int wins_flags;               /* similar to the netbios flags but different ! */
221 };
222
223 /* This structure represents an entry in a local netbios name list. */
224 struct name_record
225   {
226   ubi_trNode            node[1];
227   struct subnet_record *subnet;
228   struct nmb_name       name;    /* The netbios name. */
229   struct nmb_data       data;    /* The netbios data. */
230   };
231
232 /* Browser cache for synchronising browse lists. */
233 struct browse_cache_record
234   {
235   ubi_dlNode     node[1];
236   pstring        lmb_name;
237   pstring        work_group;
238   struct in_addr ip;
239   time_t         sync_time;
240   time_t         death_time; /* The time the record must be removed. */
241   };
242
243 /* This is used to hold the list of servers in my domain, and is
244    contained within lists of domains. */
245
246 struct server_record
247 {
248   struct server_record *next;
249   struct server_record *prev;
250
251   struct subnet_record *subnet;
252
253   struct server_info_struct serv;
254   time_t death_time;  
255 };
256
257 /* A workgroup structure. It contains a list of servers. */
258 struct work_record
259 {
260   struct work_record *next;
261   struct work_record *prev;
262
263   struct subnet_record *subnet;
264
265   struct server_record *serverlist;
266
267   /* Stage of development from non-local-master up to local-master browser. */
268   enum master_state mst_state;
269
270   /* Stage of development from non-domain-master to domain-master browser. */
271   enum domain_state dom_state;
272
273   /* Stage of development from non-logon-server to logon server. */
274   enum logon_state log_state;
275
276   /* Work group info. */
277   fstring work_group;
278   int     token;        /* Used when communicating with backup browsers. */
279   fstring local_master_browser_name;      /* Current local master browser. */
280
281   /* Announce info. */
282   time_t lastannounce_time;
283   int announce_interval;
284   BOOL    needannounce;
285
286   /* Timeout time for this workgroup. 0 means permanent. */
287   time_t death_time;  
288
289   /* Election info */
290   BOOL    RunningElection;
291   BOOL    needelection;
292   int     ElectionCount;
293   uint32  ElectionCriterion;
294
295   /* Domain master browser info. Used for efficient syncs. */
296   struct nmb_name dmb_name;
297   struct in_addr dmb_addr;
298 };
299
300 /* typedefs needed to define copy & free functions for userdata. */
301 struct userdata_struct;
302
303 typedef struct userdata_struct * (*userdata_copy_fn)(struct userdata_struct *);
304 typedef void (*userdata_free_fn)(struct userdata_struct *);
305
306 /* Structure to define any userdata passed around. */
307
308 struct userdata_struct {
309   userdata_copy_fn copy_fn;
310   userdata_free_fn free_fn;
311   unsigned int userdata_len;
312   char data[16]; /* 16 is to ensure alignment/padding on all systems */
313 };
314
315 struct response_record;
316 struct packet_struct;
317 struct res_rec;
318
319 /* typedef to define the function called when this response packet comes in. */
320 typedef void (*response_function)(struct subnet_record *, struct response_record *,
321                                   struct packet_struct *);
322
323 /* typedef to define the function called when this response record times out. */
324 typedef void (*timeout_response_function)(struct subnet_record *,
325                                           struct response_record *);
326
327 /* typedef to define the function called when the request that caused this
328    response record to be created is successful. */
329 typedef void (*success_function)(struct subnet_record *, struct userdata_struct *, ...);
330
331 /* typedef to define the function called when the request that caused this
332    response record to be created is unsuccessful. */
333 typedef void (*fail_function)(struct subnet_record *, struct response_record *, ...);
334
335 /* List of typedefs for success and fail functions of the different query
336    types. Used to catch any compile time prototype errors. */
337
338 typedef void (*register_name_success_function)( struct subnet_record *,
339                                                 struct userdata_struct *,
340                                                 struct nmb_name *,
341                                                 uint16,
342                                                 int,
343                                                 struct in_addr);
344 typedef void (*register_name_fail_function)( struct subnet_record *,
345                                              struct response_record *,
346                                              struct nmb_name *);
347
348 typedef void (*release_name_success_function)( struct subnet_record *,
349                                                struct userdata_struct *, 
350                                                struct nmb_name *,
351                                                struct in_addr);
352 typedef void (*release_name_fail_function)( struct subnet_record *,
353                                             struct response_record *, 
354                                             struct nmb_name *);
355
356 typedef void (*refresh_name_success_function)( struct subnet_record *,
357                                                struct userdata_struct *, 
358                                                struct nmb_name *,
359                                                uint16,
360                                                int,
361                                                struct in_addr);
362 typedef void (*refresh_name_fail_function)( struct subnet_record *,
363                                             struct response_record *,
364                                             struct nmb_name *);
365
366 typedef void (*query_name_success_function)( struct subnet_record *,
367                                              struct userdata_struct *,
368                                              struct nmb_name *,
369                                              struct in_addr,
370                                              struct res_rec *answers);
371
372 typedef void (*query_name_fail_function)( struct subnet_record *,
373                                           struct response_record *,    
374                                           struct nmb_name *,
375                                           int);  
376
377 typedef void (*node_status_success_function)( struct subnet_record *,
378                                               struct userdata_struct *,
379                                               struct res_rec *,
380                                               struct in_addr);
381 typedef void (*node_status_fail_function)( struct subnet_record *,
382                                            struct response_record *);
383
384 /* Initiated name queries are recorded in this list to track any responses. */
385
386 struct response_record
387 {
388   struct response_record *next;
389   struct response_record *prev;
390
391   uint16 response_id;
392
393   /* Callbacks for packets received or not. */ 
394   response_function resp_fn;
395   timeout_response_function timeout_fn;
396
397   /* Callbacks for the request succeeding or not. */
398   success_function success_fn;
399   fail_function fail_fn;
400  
401   struct packet_struct *packet;
402
403   struct userdata_struct *userdata;
404
405   int num_msgs;
406
407   time_t repeat_time;
408   time_t repeat_interval;
409   int    repeat_count;
410
411   /* Recursion protection. */
412   BOOL in_expiration_processing;
413 };
414
415 /* A subnet structure. It contains a list of workgroups and netbios names. */
416
417 /*
418    B nodes will have their own, totally separate subnet record, with their
419    own netbios name set. These do NOT interact with other subnet records'
420    netbios names.
421 */
422
423 enum subnet_type {
424   NORMAL_SUBNET              = 0,  /* Subnet listed in interfaces list. */
425   UNICAST_SUBNET             = 1,  /* Subnet for unicast packets. */
426   REMOTE_BROADCAST_SUBNET    = 2,  /* Subnet for remote broadcasts. */
427   WINS_SERVER_SUBNET         = 3   /* Only created if we are a WINS server. */
428 };
429
430 struct subnet_record
431 {
432   struct subnet_record *next;
433   struct subnet_record *prev;
434
435   char  *subnet_name;      /* For Debug identification. */
436   enum subnet_type type;   /* To catagorize the subnet. */
437
438   struct work_record     *workgrouplist; /* List of workgroups. */
439   ubi_trRoot              namelist[1];   /* List of netbios names. */
440   struct response_record *responselist;  /* List of responses expected. */
441
442   BOOL namelist_changed;
443   BOOL work_changed;
444
445   struct in_addr bcast_ip;
446   struct in_addr mask_ip;
447   struct in_addr myip;
448   int nmb_sock;               /* socket to listen for unicast 137. */
449   int dgram_sock;             /* socket to listen for unicast 138. */
450 };
451
452 /* A resource record. */
453 struct res_rec {
454   struct nmb_name rr_name;
455   int rr_type;
456   int rr_class;
457   int ttl;
458   int rdlength;
459   char rdata[MAX_DGRAM_SIZE];
460 };
461
462 /* An nmb packet. */
463 struct nmb_packet
464 {
465   struct {
466     int name_trn_id;
467     int opcode;
468     BOOL response;
469     struct {
470       BOOL bcast;
471       BOOL recursion_available;
472       BOOL recursion_desired;
473       BOOL trunc;
474       BOOL authoritative;
475     } nm_flags;
476     int rcode;
477     int qdcount;
478     int ancount;
479     int nscount;
480     int arcount;
481   } header;
482
483   struct {
484     struct nmb_name question_name;
485     int question_type;
486     int question_class;
487   } question;
488
489   struct res_rec *answers;
490   struct res_rec *nsrecs;
491   struct res_rec *additional;
492 };
493
494 /* msg_type field options - from rfc1002. */
495
496 #define DGRAM_UNIQUE 0x10
497 #define DGRAM_GROUP 0x11
498 #define DGRAM_BROADCAST 0x12
499 #define DGRAM_ERROR 0x13
500 #define DGRAM_QUERY_REQUEST 0x14
501 #define DGRAM_POSITIVE_QUERY_RESPONSE 0x15
502 #define DGRAM_NEGATIVE_QUERT_RESPONSE 0x16
503
504 /* A datagram - this normally contains SMB data in the data[] array. */
505
506 struct dgram_packet {
507   struct {
508     int msg_type;
509     struct {
510       enum node_type node_type;
511       BOOL first;
512       BOOL more;
513     } flags;
514     int dgm_id;
515     struct in_addr source_ip;
516     int source_port;
517     int dgm_length;
518     int packet_offset;
519   } header;
520   struct nmb_name source_name;
521   struct nmb_name dest_name;
522   int datasize;
523   char data[MAX_DGRAM_SIZE];
524 };
525
526 /* Define a structure used to queue packets. This will be a linked
527  list of nmb packets. */
528
529 struct packet_struct
530 {
531   struct packet_struct *next;
532   struct packet_struct *prev;
533   BOOL locked;
534   struct in_addr ip;
535   int port;
536   int fd;
537   time_t timestamp;
538   enum packet_type packet_type;
539   union {
540     struct nmb_packet nmb;
541     struct dgram_packet dgram;
542   } packet;
543 };
544
545 /* NETLOGON opcodes */
546
547 #define QUERYFORPDC      7 /* Query for PDC. */
548 #define SAM_UAS_CHANGE  10 /* Announce change to UAS or SAM. */
549 #define QUERYFORPDC_R   12 /* Response to Query for PDC. */
550 #define SAMLOGON        18
551 #define SAMLOGON_R      19
552 #define SAMLOGON_UNK_R  21
553
554 /* Ids for netbios packet types. */
555
556 #define ANN_HostAnnouncement         1
557 #define ANN_AnnouncementRequest      2
558 #define ANN_Election                 8
559 #define ANN_GetBackupListReq         9
560 #define ANN_GetBackupListResp       10
561 #define ANN_BecomeBackup            11
562 #define ANN_DomainAnnouncement      12
563 #define ANN_MasterAnnouncement      13
564 #define ANN_ResetBrowserState       14
565 #define ANN_LocalMasterAnnouncement 15
566
567
568 /* Broadcast packet announcement intervals, in minutes. */
569
570 /* Attempt to add domain logon and domain master names. */
571 #define CHECK_TIME_ADD_DOM_NAMES 5 
572
573 /* Search for master browsers of workgroups samba knows about, 
574    except default. */
575 #define CHECK_TIME_MST_BROWSE       5 
576
577 /* Request backup browser announcements from other servers. */
578 #define CHECK_TIME_ANNOUNCE_BACKUP 15
579
580 /* Request host announcements from other servers: min and max of interval. */
581 #define CHECK_TIME_MIN_HOST_ANNCE   3
582 #define CHECK_TIME_MAX_HOST_ANNCE  12
583
584 /* Announce as master to WINS server and any Primary Domain Controllers. */
585 #define CHECK_TIME_MST_ANNOUNCE    15
586
587 /* Time between syncs from domain master browser to local master browsers. */
588 #define CHECK_TIME_DMB_TO_LMB_SYNC    15
589
590 /* Do all remote announcements this often. */
591 #define REMOTE_ANNOUNCE_INTERVAL 180
592
593 /* what is the maximum period between name refreshes. Note that this only
594    affects non-permanent self names (in seconds) */
595 #define MAX_REFRESH_TIME (60*20)
596
597 /* The Extinction interval: 4 days, time a node will stay in released state  */
598 #define EXTINCTION_INTERVAL (4*24*60*60)
599
600 /* The Extinction time-out: 1 day, time a node will stay in deleted state */
601 #define EXTINCTION_TIMEOUT (24*60*60)
602
603 /* Macro's to enumerate subnets either with or without
604    the UNICAST subnet. */
605
606 extern struct subnet_record *subnetlist;
607 extern struct subnet_record *unicast_subnet;
608 extern struct subnet_record *wins_server_subnet;
609 extern struct subnet_record *remote_broadcast_subnet;
610
611 #define FIRST_SUBNET subnetlist
612 #define NEXT_SUBNET_EXCLUDING_UNICAST(x) ((x)->next)
613 #define NEXT_SUBNET_INCLUDING_UNICAST(x) (get_next_subnet_maybe_unicast((x)))
614
615 /* wins replication record used between nmbd and wrepld */
616 typedef struct _WINS_RECORD {
617         char name[17];
618         char type;
619         int nb_flags;
620         int wins_flags;
621         SMB_BIG_UINT id;
622         int num_ips;
623         struct in_addr ip[25];
624         struct in_addr wins_ip;
625 } WINS_RECORD;
626
627 /* To be removed. */
628 enum state_type { TEST };
629 #endif /* _NAMESERV_H_ */