4 Unix SMB/Netbios implementation.
6 NBT netbios header - version 2
7 Copyright (C) Andrew Tridgell 1994-1998
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.
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.
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.
25 #define PERMANENT_TTL 0
27 /* NTAS uses 2, NT uses 1, WfWg uses 0 */
28 #define MAINTAIN_LIST 2
29 #define ELECTION_VERSION 1
31 #define MAX_DGRAM_SIZE (576) /* tcp/ip datagram limit is 576 bytes */
32 #define MIN_DGRAM_SIZE 12
34 /*********************************************************
35 Types of reply packet.
36 **********************************************************/
38 enum netbios_reply_type_code { NMB_QUERY, NMB_STATUS, NMB_REG, NMB_REG_REFRESH,
39 NMB_REL, NMB_WAIT_ACK, NMB_MULTIHOMED_REG,
40 WINS_REG, WINS_QUERY };
42 /* From rfc1002, 4.2.1.2 */
44 #define QUESTION_TYPE_NB_QUERY 0x20
45 #define QUESTION_TYPE_NB_STATUS 0x21
48 #define QUESTION_CLASS_IN 0x1
50 /* Opcode definitions */
51 #define NMB_NAME_QUERY_OPCODE 0x0
52 #define NMB_NAME_REG_OPCODE 0x05 /* see rfc1002.txt 4.2.2,3,5,6,7,8 */
53 #define NMB_NAME_RELEASE_OPCODE 0x06 /* see rfc1002.txt 4.2.9,10,11 */
54 #define NMB_WACK_OPCODE 0x07 /* see rfc1002.txt 4.2.16 */
55 /* Ambiguity in rfc1002 about which of these is correct. */
56 /* WinNT uses 8 by default but can be made to use 9. */
57 #define NMB_NAME_REFRESH_OPCODE_8 0x08 /* see rfc1002.txt 4.2.4 */
58 #define NMB_NAME_REFRESH_OPCODE_9 0x09 /* see rfc1002.txt 4.2.4 */
59 #define NMB_NAME_MULTIHOMED_REG_OPCODE 0x0F /* Invented by Microsoft. */
61 /* XXXX what about all the other types?? 0x1, 0x2, 0x3, 0x4, 0x8? */
63 /* Resource record types. rfc1002 4.2.1.3 */
65 #define RR_TYPE_NS 0x2
66 #define RR_TYPE_NULL 0xA
67 #define RR_TYPE_NB 0x20
68 #define RR_TYPE_NBSTAT 0x21
70 /* Resource record class. */
71 #define RR_CLASS_IN 0x1
76 #define NB_ACTIVE 0x04
79 #define NB_BFLAG 0x00 /* Broadcast node type. */
80 #define NB_PFLAG 0x20 /* Point-to-point node type. */
81 #define NB_MFLAG 0x40 /* Mixed bcast & p-p node type. */
82 #define NB_HFLAG 0x60 /* Microsoft 'hybrid' node type. */
83 #define NB_NODETYPEMASK 0x60
84 /* Mask applied to outgoing NetBIOS flags. */
85 #define NB_FLGMSK 0xE0
87 /* NetBIOS flag identifier. */
88 #define NAME_GROUP(p) ((p)->data.nb_flags & NB_GROUP)
89 #define NAME_BFLAG(p) (((p)->data.nb_flags & NB_NODETYPEMASK) == NB_BFLAG)
90 #define NAME_PFLAG(p) (((p)->data.nb_flags & NB_NODETYPEMASK) == NB_PFLAG)
91 #define NAME_MFLAG(p) (((p)->data.nb_flags & NB_NODETYPEMASK) == NB_MFLAG)
92 #define NAME_HFLAG(p) (((p)->data.nb_flags & NB_NODETYPEMASK) == NB_HFLAG)
94 /* Samba name state for a name in a namelist. */
95 #define NAME_IS_ACTIVE(p) ((p)->data.nb_flags & NB_ACTIVE)
96 #define NAME_IN_CONFLICT(p) ((p)->data.nb_flags & NB_CONFL)
97 #define NAME_IS_DEREGISTERING(p) ((p)->data.nb_flags & NB_DEREG)
99 /* Error codes for NetBIOS requests. */
100 #define FMT_ERR 0x1 /* Packet format error. */
101 #define SRV_ERR 0x2 /* Internal server error. */
102 #define NAM_ERR 0x3 /* Name does not exist. */
103 #define IMP_ERR 0x4 /* Request not implemented. */
104 #define RFS_ERR 0x5 /* Request refused. */
105 #define ACT_ERR 0x6 /* Active error - name owned by another host. */
106 #define CFT_ERR 0x7 /* Name in conflict error. */
108 #define REFRESH_TIME (15*60)
109 #define NAME_POLL_REFRESH_TIME (5*60)
110 #define NAME_POLL_INTERVAL 15
112 /* Workgroup state identifiers. */
113 #define AM_POTENTIAL_MASTER_BROWSER(work) ((work)->mst_state == MST_POTENTIAL)
114 #define AM_LOCAL_MASTER_BROWSER(work) ((work)->mst_state == MST_BROWSER)
115 #define AM_DOMAIN_MASTER_BROWSER(work) ((work)->dom_state == DOMAIN_MST)
116 #define AM_DOMAIN_MEMBER(work) ((work)->log_state == LOGON_SRV)
118 /* Microsoft browser NetBIOS name. */
119 #define MSBROWSE "\001\002__MSBROWSE__\002"
122 #define BROWSE_MAILSLOT "\\MAILSLOT\\BROWSE"
123 #define NET_LOGON_MAILSLOT "\\MAILSLOT\\NET\\NETLOGON"
124 #define NT_LOGON_MAILSLOT "\\MAILSLOT\\NET\\NTLOGON"
125 #define LANMAN_MAILSLOT "\\MAILSLOT\\LANMAN"
127 /* Samba definitions for find_name_on_subnet(). */
128 #define FIND_ANY_NAME 0
129 #define FIND_SELF_NAME 1
132 * The different name types that can be in namelists.
134 * SELF_NAME should only be on the broadcast and unicast subnets.
135 * LMHOSTS_NAME should only be in the remote_broadcast_subnet.
136 * REGISTER_NAME, DNS_NAME, DNSFAIL_NAME should only be in the wins_server_subnet.
137 * WINS_PROXY_NAME should only be on the broadcast subnets.
138 * PERMANENT_NAME can be on all subnets except remote_broadcast_subnet.
142 enum name_source {LMHOSTS_NAME, REGISTER_NAME, SELF_NAME, DNS_NAME,
143 DNSFAIL_NAME, PERMANENT_NAME, WINS_PROXY_NAME};
144 enum node_type {B_NODE=0, P_NODE=1, M_NODE=2, NBDD_NODE=3};
145 enum packet_type {NMB_PACKET, DGRAM_PACKET};
154 MST_UNBECOMING_MASTER
171 struct subnet_record;
173 /* A netbios name structure. */
177 unsigned int name_type;
182 uint16 nb_flags; /* Netbios flags. */
183 int num_ips; /* Number of ip entries. */
184 struct in_addr *ip; /* The ip list for this name. */
186 enum name_source source; /* Where the name came from. */
188 time_t death_time; /* The time the record must be removed (do not remove if 0). */
189 time_t refresh_time; /* The time the record should be refreshed. */
192 /* This is the structure used for the local netbios name list. */
197 struct subnet_record *subnet;
198 struct nmb_name name; /* The netbios name. */
199 struct nmb_data data; /* The netbios data. */
202 /* Browser cache for synchronising browse lists. */
203 struct browse_cache_record
205 struct browse_cache_record *next;
206 struct browse_cache_record *prev;
212 time_t death_time; /* The time the record must be removed. */
215 /* This is used to hold the list of servers in my domain, and is
216 contained within lists of domains. */
220 struct server_record *next;
221 struct server_record *prev;
223 struct subnet_record *subnet;
225 struct server_info_struct serv;
229 /* A workgroup structure. It contains a list of servers. */
232 struct work_record *next;
233 struct work_record *prev;
235 struct subnet_record *subnet;
237 struct server_record *serverlist;
239 /* Stage of development from non-local-master up to local-master browser. */
240 enum master_state mst_state;
242 /* Stage of development from non-domain-master to domain-master browser. */
243 enum domain_state dom_state;
245 /* Stage of development from non-logon-server to logon server. */
246 enum logon_state log_state;
248 /* Work group info. */
250 int token; /* Used when communicating with backup browsers. */
251 fstring local_master_browser_name; /* Current local master browser. */
254 time_t lastannounce_time;
255 int announce_interval;
258 /* Timeout time for this workgroup. 0 means permanent. */
262 BOOL RunningElection;
265 uint32 ElectionCriterion;
267 /* Domain master browser info. Used for efficient syncs. */
268 struct nmb_name dmb_name;
269 struct in_addr dmb_addr;
272 /* typedefs needed to define copy & free functions for userdata. */
273 struct userdata_struct;
275 typedef struct userdata_struct * (*userdata_copy_fn)(struct userdata_struct *);
276 typedef void (*userdata_free_fn)(struct userdata_struct *);
278 /* Structure to define any userdata passed around. */
280 struct userdata_struct {
281 userdata_copy_fn copy_fn;
282 userdata_free_fn free_fn;
283 unsigned int userdata_len;
287 struct response_record;
288 struct packet_struct;
291 /* typedef to define the function called when this response packet comes in. */
292 typedef void (*response_function)(struct subnet_record *, struct response_record *,
293 struct packet_struct *);
295 /* typedef to define the function called when this response record times out. */
296 typedef void (*timeout_response_function)(struct subnet_record *,
297 struct response_record *);
299 /* typedef to define the function called when the request that caused this
300 response record to be created is successful. */
301 typedef void (*success_function)(struct subnet_record *, struct userdata_struct *, ...);
303 /* typedef to define the function called when the request that caused this
304 response record to be created is unsuccessful. */
305 typedef void (*fail_function)(struct subnet_record *, struct response_record *, ...);
307 /* List of typedefs for success and fail functions of the different query
308 types. Used to catch any compile time prototype errors. */
310 typedef void (*register_name_success_function)( struct subnet_record *,
311 struct userdata_struct *,
316 typedef void (*register_name_fail_function)( struct subnet_record *,
317 struct response_record *,
320 typedef void (*release_name_success_function)( struct subnet_record *,
321 struct userdata_struct *,
324 typedef void (*release_name_fail_function)( struct subnet_record *,
325 struct response_record *,
328 typedef void (*refresh_name_success_function)( struct subnet_record *,
329 struct userdata_struct *,
334 typedef void (*refresh_name_fail_function)( struct subnet_record *,
335 struct response_record *,
338 typedef void (*query_name_success_function)( struct subnet_record *,
339 struct userdata_struct *,
342 struct res_rec *answers);
344 typedef void (*query_name_fail_function)( struct subnet_record *,
345 struct response_record *,
349 typedef void (*node_status_success_function)( struct subnet_record *,
350 struct userdata_struct *,
353 typedef void (*node_status_fail_function)( struct subnet_record *,
354 struct response_record *);
356 /* Initiated name queries are recorded in this list to track any responses. */
358 struct response_record
360 struct response_record *next;
361 struct response_record *prev;
365 /* Callbacks for packets received or not. */
366 response_function resp_fn;
367 timeout_response_function timeout_fn;
369 /* Callbacks for the request succeeding or not. */
370 success_function success_fn;
371 fail_function fail_fn;
373 struct packet_struct *packet;
375 struct userdata_struct *userdata;
380 time_t repeat_interval;
384 /* A subnet structure. It contains a list of workgroups and netbios names. */
387 B nodes will have their own, totally separate subnet record, with their
388 own netbios name set. These do NOT interact with other subnet records'
393 NORMAL_SUBNET = 0, /* Subnet listed in interfaces list. */
394 UNICAST_SUBNET = 1, /* Subnet for unicast packets. */
395 REMOTE_BROADCAST_SUBNET = 2, /* Subnet for remote broadcasts. */
396 WINS_SERVER_SUBNET = 3 /* Only created if we are a WINS server. */
401 struct subnet_record *next;
402 struct subnet_record *prev;
404 char *subnet_name; /* For Debug identification. */
405 enum subnet_type type; /* To catagorize the subnet. */
407 struct work_record *workgrouplist; /* List of workgroups. */
408 ubi_trRoot namelist[1]; /* List of netbios names. */
409 struct response_record *responselist; /* List of responses expected. */
411 BOOL namelist_changed;
414 struct in_addr bcast_ip;
415 struct in_addr mask_ip;
417 int nmb_sock; /* socket to listen for unicast 137. */
418 int dgram_sock; /* socket to listen for unicast 138. */
421 /* A resource record. */
423 struct nmb_name rr_name;
428 char rdata[MAX_DGRAM_SIZE];
440 BOOL recursion_available;
441 BOOL recursion_desired;
453 struct nmb_name question_name;
458 struct res_rec *answers;
459 struct res_rec *nsrecs;
460 struct res_rec *additional;
464 /* A datagram - this normally contains SMB data in the data[] array. */
466 struct dgram_packet {
470 enum node_type node_type;
475 struct in_addr source_ip;
480 struct nmb_name source_name;
481 struct nmb_name dest_name;
483 char data[MAX_DGRAM_SIZE];
486 /* Define a structure used to queue packets. This will be a linked
487 list of nmb packets. */
491 struct packet_struct *next;
492 struct packet_struct *prev;
498 enum packet_type packet_type;
500 struct nmb_packet nmb;
501 struct dgram_packet dgram;
505 /* NETLOGON opcodes */
507 #define QUERYFORPDC 7 /* Query for PDC. */
508 #define QUERYFORPDC_R 12 /* Response to Query for PDC. */
510 #define SAMLOGON_R 19
513 /* Ids for netbios packet types. */
515 #define ANN_HostAnnouncement 1
516 #define ANN_AnnouncementRequest 2
517 #define ANN_Election 8
518 #define ANN_GetBackupListReq 9
519 #define ANN_GetBackupListResp 10
520 #define ANN_BecomeBackup 11
521 #define ANN_DomainAnnouncement 12
522 #define ANN_MasterAnnouncement 13
523 #define ANN_ResetBrowserState 14
524 #define ANN_LocalMasterAnnouncement 15
527 /* Broadcast packet announcement intervals, in minutes. */
529 /* Attempt to add domain logon and domain master names. */
530 #define CHECK_TIME_ADD_DOM_NAMES 5
532 /* Search for master browsers of workgroups samba knows about,
534 #define CHECK_TIME_MST_BROWSE 5
536 /* Request backup browser announcements from other servers. */
537 #define CHECK_TIME_ANNOUNCE_BACKUP 15
539 /* Request host announcements from other servers: min and max of interval. */
540 #define CHECK_TIME_MIN_HOST_ANNCE 3
541 #define CHECK_TIME_MAX_HOST_ANNCE 12
543 /* Announce as master to WINS server and any Primary Domain Controllers. */
544 #define CHECK_TIME_MST_ANNOUNCE 15
546 /* Time between syncs from domain master browser to local master browsers. */
547 #define CHECK_TIME_DMB_TO_LMB_SYNC 15
549 /* Do all remote announcements this often. */
550 #define REMOTE_ANNOUNCE_INTERVAL 180
552 /* Types of machine we can announce as. */
553 #define ANNOUNCE_AS_NT 1
554 #define ANNOUNCE_AS_WIN95 2
555 #define ANNOUNCE_AS_WFW 3
557 /* Macro's to enumerate subnets either with or without
558 the UNICAST subnet. */
560 extern struct subnet_record *subnetlist;
561 extern struct subnet_record *unicast_subnet;
562 extern struct subnet_record *wins_server_subnet;
563 extern struct subnet_record *remote_broadcast_subnet;
565 #define FIRST_SUBNET subnetlist
566 #define NEXT_SUBNET_EXCLUDING_UNICAST(x) ((x)->next)
567 #define NEXT_SUBNET_INCLUDING_UNICAST(x) (get_next_subnet_maybe_unicast((x)))
570 enum state_type { TEST };
571 #endif /* _NAMESERV_H_ */