4
Unix SMB/CIFS implementation.
5
NBT netbios header - version 2
6
Copyright (C) Andrew Tridgell 1994-1998
8
This program is free software; you can redistribute it and/or modify
9
it under the terms of the GNU General Public License as published by
10
the Free Software Foundation; either version 3 of the License, or
11
(at your option) any later version.
13
This program is distributed in the hope that it will be useful,
14
but WITHOUT ANY WARRANTY; without even the implied warranty of
15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16
GNU General Public License for more details.
18
You should have received a copy of the GNU General Public License
19
along with this program. If not, see <http://www.gnu.org/licenses/>.
23
#define INFO_VERSION "INFO/version"
24
#define INFO_COUNT "INFO/num_entries"
25
#define INFO_ID_HIGH "INFO/id_high"
26
#define INFO_ID_LOW "INFO/id_low"
27
#define ENTRY_PREFIX "ENTRY/"
29
#define PERMANENT_TTL 0
31
/* NTAS uses 2, NT uses 1, WfWg uses 0 */
32
#define MAINTAIN_LIST 2
33
#define ELECTION_VERSION 1
35
#define MAX_DGRAM_SIZE (576) /* tcp/ip datagram limit is 576 bytes */
36
#define MIN_DGRAM_SIZE 12
38
/*********************************************************
39
Types of reply packet.
40
**********************************************************/
42
enum netbios_reply_type_code { NMB_QUERY, NMB_STATUS, NMB_REG, NMB_REG_REFRESH,
43
NMB_REL, NMB_WAIT_ACK, NMB_MULTIHOMED_REG,
44
WINS_REG, WINS_QUERY };
46
/* From rfc1002, 4.2.1.2 */
48
#define QUESTION_TYPE_NB_QUERY 0x20
49
#define QUESTION_TYPE_NB_STATUS 0x21
52
#define QUESTION_CLASS_IN 0x1
54
/* Opcode definitions */
55
#define NMB_NAME_QUERY_OPCODE 0x0
56
#define NMB_NAME_REG_OPCODE 0x05 /* see rfc1002.txt 4.2.2,3,5,6,7,8 */
57
#define NMB_NAME_RELEASE_OPCODE 0x06 /* see rfc1002.txt 4.2.9,10,11 */
58
#define NMB_WACK_OPCODE 0x07 /* see rfc1002.txt 4.2.16 */
59
/* Ambiguity in rfc1002 about which of these is correct. */
60
/* WinNT uses 8 by default but can be made to use 9. */
61
#define NMB_NAME_REFRESH_OPCODE_8 0x08 /* see rfc1002.txt 4.2.4 */
62
#define NMB_NAME_REFRESH_OPCODE_9 0x09 /* see rfc1002.txt 4.2.4 */
63
#define NMB_NAME_MULTIHOMED_REG_OPCODE 0x0F /* Invented by Microsoft. */
65
/* XXXX what about all the other types?? 0x1, 0x2, 0x3, 0x4, 0x8? */
67
/* Resource record types. rfc1002 4.2.1.3 */
69
#define RR_TYPE_NS 0x2
70
#define RR_TYPE_NULL 0xA
71
#define RR_TYPE_NB 0x20
72
#define RR_TYPE_NBSTAT 0x21
74
/* Resource record class. */
75
#define RR_CLASS_IN 0x1
80
#define NB_ACTIVE 0x04
83
#define NB_BFLAG 0x00 /* Broadcast node type. */
84
#define NB_PFLAG 0x20 /* Point-to-point node type. */
85
#define NB_MFLAG 0x40 /* Mixed bcast & p-p node type. */
86
#define NB_HFLAG 0x60 /* Microsoft 'hybrid' node type. */
87
#define NB_NODETYPEMASK 0x60
88
/* Mask applied to outgoing NetBIOS flags. */
89
#define NB_FLGMSK 0xE0
91
/* The wins flags. Looks like the nbflags ! */
92
#define WINS_UNIQUE 0x00 /* Unique record */
93
#define WINS_NGROUP 0x01 /* Normal Group eg: 1B */
94
#define WINS_SGROUP 0x02 /* Special Group eg: 1C */
95
#define WINS_MHOMED 0x03 /* MultiHomed */
97
#define WINS_ACTIVE 0x00 /* active record */
98
#define WINS_RELEASED 0x04 /* released record */
99
#define WINS_TOMBSTONED 0x08 /* tombstoned record */
100
#define WINS_DELETED 0x0C /* deleted record */
102
#define WINS_STATE_MASK 0x0C
104
#define WINS_LOCAL 0x00 /* local record */
105
#define WINS_REMOTE 0x10 /* remote record */
107
#define WINS_BNODE 0x00 /* Broadcast node */
108
#define WINS_PNODE 0x20 /* PtP node */
109
#define WINS_MNODE 0x40 /* Mixed node */
110
#define WINS_HNODE 0x60 /* Hybrid node */
112
#define WINS_NONSTATIC 0x00 /* dynamic record */
113
#define WINS_STATIC 0x80 /* static record */
115
#define WINS_STATE_ACTIVE(p) (((p)->data.wins_flags & WINS_STATE_MASK) == WINS_ACTIVE)
118
/* NetBIOS flag identifier. */
119
#define NAME_GROUP(p) ((p)->data.nb_flags & NB_GROUP)
120
#define NAME_BFLAG(p) (((p)->data.nb_flags & NB_NODETYPEMASK) == NB_BFLAG)
121
#define NAME_PFLAG(p) (((p)->data.nb_flags & NB_NODETYPEMASK) == NB_PFLAG)
122
#define NAME_MFLAG(p) (((p)->data.nb_flags & NB_NODETYPEMASK) == NB_MFLAG)
123
#define NAME_HFLAG(p) (((p)->data.nb_flags & NB_NODETYPEMASK) == NB_HFLAG)
125
/* Samba name state for a name in a namelist. */
126
#define NAME_IS_ACTIVE(p) ((p)->data.nb_flags & NB_ACTIVE)
127
#define NAME_IN_CONFLICT(p) ((p)->data.nb_flags & NB_CONFL)
128
#define NAME_IS_DEREGISTERING(p) ((p)->data.nb_flags & NB_DEREG)
130
/* Error codes for NetBIOS requests. */
131
#define FMT_ERR 0x1 /* Packet format error. */
132
#define SRV_ERR 0x2 /* Internal server error. */
133
#define NAM_ERR 0x3 /* Name does not exist. */
134
#define IMP_ERR 0x4 /* Request not implemented. */
135
#define RFS_ERR 0x5 /* Request refused. */
136
#define ACT_ERR 0x6 /* Active error - name owned by another host. */
137
#define CFT_ERR 0x7 /* Name in conflict error. */
139
#define REFRESH_TIME (15*60)
140
#define NAME_POLL_REFRESH_TIME (5*60)
141
#define NAME_POLL_INTERVAL 15
143
/* Workgroup state identifiers. */
144
#define AM_POTENTIAL_MASTER_BROWSER(work) ((work)->mst_state == MST_POTENTIAL)
145
#define AM_LOCAL_MASTER_BROWSER(work) ((work)->mst_state == MST_BROWSER)
146
#define AM_DOMAIN_MASTER_BROWSER(work) ((work)->dom_state == DOMAIN_MST)
147
#define AM_DOMAIN_MEMBER(work) ((work)->log_state == LOGON_SRV)
149
/* Microsoft browser NetBIOS name. */
150
#define MSBROWSE "\001\002__MSBROWSE__\002"
153
#define BROWSE_MAILSLOT "\\MAILSLOT\\BROWSE"
154
#define NET_LOGON_MAILSLOT "\\MAILSLOT\\NET\\NETLOGON"
155
#define NT_LOGON_MAILSLOT "\\MAILSLOT\\NET\\NTLOGON"
156
#define LANMAN_MAILSLOT "\\MAILSLOT\\LANMAN"
158
/* Samba definitions for find_name_on_subnet(). */
159
#define FIND_ANY_NAME 0
160
#define FIND_SELF_NAME 1
163
* The different name types that can be in namelists.
165
* SELF_NAME should only be on the broadcast and unicast subnets.
166
* LMHOSTS_NAME should only be in the remote_broadcast_subnet.
167
* REGISTER_NAME, DNS_NAME, DNSFAIL_NAME should only be in the wins_server_subnet.
168
* WINS_PROXY_NAME should only be on the broadcast subnets.
169
* PERMANENT_NAME can be on all subnets except remote_broadcast_subnet.
173
enum name_source {LMHOSTS_NAME, REGISTER_NAME, SELF_NAME, DNS_NAME,
174
DNSFAIL_NAME, PERMANENT_NAME, WINS_PROXY_NAME};
175
enum node_type {B_NODE=0, P_NODE=1, M_NODE=2, NBDD_NODE=3};
176
enum packet_type {NMB_PACKET, DGRAM_PACKET};
184
MST_UNBECOMING_MASTER
199
struct subnet_record;
202
uint16 nb_flags; /* Netbios flags. */
203
int num_ips; /* Number of ip entries. */
204
struct in_addr *ip; /* The ip list for this name. */
206
enum name_source source; /* Where the name came from. */
208
time_t death_time; /* The time the record must be removed (do not remove if 0). */
209
time_t refresh_time; /* The time the record should be refreshed. */
211
uint64_t id; /* unique id */
212
struct in_addr wins_ip; /* the adress of the wins server this record comes from */
214
int wins_flags; /* similar to the netbios flags but different ! */
217
/* This structure represents an entry in a local netbios name list. */
219
struct name_record *prev, *next;
220
struct subnet_record *subnet;
221
struct nmb_name name; /* The netbios name. */
222
struct nmb_data data; /* The netbios data. */
225
/* Browser cache for synchronising browse lists. */
226
struct browse_cache_record {
227
struct browse_cache_record *prev, *next;
232
time_t death_time; /* The time the record must be removed. */
235
/* This is used to hold the list of servers in my domain, and is
236
contained within lists of domains. */
238
struct server_record {
239
struct server_record *next;
240
struct server_record *prev;
242
struct subnet_record *subnet;
244
struct server_info_struct serv;
248
/* A workgroup structure. It contains a list of servers. */
250
struct work_record *next;
251
struct work_record *prev;
253
struct subnet_record *subnet;
255
struct server_record *serverlist;
257
/* Stage of development from non-local-master up to local-master browser. */
258
enum master_state mst_state;
260
/* Stage of development from non-domain-master to domain-master browser. */
261
enum domain_state dom_state;
263
/* Stage of development from non-logon-server to logon server. */
264
enum logon_state log_state;
266
/* Work group info. */
268
int token; /* Used when communicating with backup browsers. */
269
unstring local_master_browser_name; /* Current local master browser. */
272
time_t lastannounce_time;
273
int announce_interval;
276
/* Timeout time for this workgroup. 0 means permanent. */
280
bool RunningElection;
283
uint32 ElectionCriterion;
285
/* Domain master browser info. Used for efficient syncs. */
286
struct nmb_name dmb_name;
287
struct in_addr dmb_addr;
290
/* typedefs needed to define copy & free functions for userdata. */
291
struct userdata_struct;
293
typedef struct userdata_struct * (*userdata_copy_fn)(struct userdata_struct *);
294
typedef void (*userdata_free_fn)(struct userdata_struct *);
296
/* Structure to define any userdata passed around. */
298
struct userdata_struct {
299
userdata_copy_fn copy_fn;
300
userdata_free_fn free_fn;
301
unsigned int userdata_len;
302
char data[16]; /* 16 is to ensure alignment/padding on all systems */
305
struct response_record;
306
struct packet_struct;
309
/* typedef to define the function called when this response packet comes in. */
310
typedef void (*response_function)(struct subnet_record *, struct response_record *,
311
struct packet_struct *);
313
/* typedef to define the function called when this response record times out. */
314
typedef void (*timeout_response_function)(struct subnet_record *,
315
struct response_record *);
317
/* typedef to define the function called when the request that caused this
318
response record to be created is successful. */
319
typedef void (*success_function)(struct subnet_record *, struct userdata_struct *, ...);
321
/* typedef to define the function called when the request that caused this
322
response record to be created is unsuccessful. */
323
typedef void (*fail_function)(struct subnet_record *, struct response_record *, ...);
325
/* List of typedefs for success and fail functions of the different query
326
types. Used to catch any compile time prototype errors. */
328
typedef void (*register_name_success_function)( struct subnet_record *,
329
struct userdata_struct *,
334
typedef void (*register_name_fail_function)( struct subnet_record *,
335
struct response_record *,
338
typedef void (*release_name_success_function)( struct subnet_record *,
339
struct userdata_struct *,
342
typedef void (*release_name_fail_function)( struct subnet_record *,
343
struct response_record *,
346
typedef void (*refresh_name_success_function)( struct subnet_record *,
347
struct userdata_struct *,
352
typedef void (*refresh_name_fail_function)( struct subnet_record *,
353
struct response_record *,
356
typedef void (*query_name_success_function)( struct subnet_record *,
357
struct userdata_struct *,
360
struct res_rec *answers);
362
typedef void (*query_name_fail_function)( struct subnet_record *,
363
struct response_record *,
367
typedef void (*node_status_success_function)( struct subnet_record *,
368
struct userdata_struct *,
371
typedef void (*node_status_fail_function)( struct subnet_record *,
372
struct response_record *);
374
/* Initiated name queries are recorded in this list to track any responses. */
376
struct response_record {
377
struct response_record *next;
378
struct response_record *prev;
382
/* Callbacks for packets received or not. */
383
response_function resp_fn;
384
timeout_response_function timeout_fn;
386
/* Callbacks for the request succeeding or not. */
387
success_function success_fn;
388
fail_function fail_fn;
390
struct packet_struct *packet;
392
struct userdata_struct *userdata;
397
time_t repeat_interval;
400
/* Recursion protection. */
401
bool in_expiration_processing;
404
/* A subnet structure. It contains a list of workgroups and netbios names. */
407
B nodes will have their own, totally separate subnet record, with their
408
own netbios name set. These do NOT interact with other subnet records'
413
NORMAL_SUBNET = 0, /* Subnet listed in interfaces list. */
414
UNICAST_SUBNET = 1, /* Subnet for unicast packets. */
415
REMOTE_BROADCAST_SUBNET = 2, /* Subnet for remote broadcasts. */
416
WINS_SERVER_SUBNET = 3 /* Only created if we are a WINS server. */
419
struct subnet_record {
420
struct subnet_record *next;
421
struct subnet_record *prev;
423
char *subnet_name; /* For Debug identification. */
424
enum subnet_type type; /* To catagorize the subnet. */
426
struct work_record *workgrouplist; /* List of workgroups. */
427
struct name_record *namelist; /* List of netbios names. */
428
struct response_record *responselist; /* List of responses expected. */
430
bool namelist_changed;
433
struct in_addr bcast_ip;
434
struct in_addr mask_ip;
436
int nmb_sock; /* socket to listen for unicast 137. */
437
int dgram_sock; /* socket to listen for unicast 138. */
440
/* A resource record. */
442
struct nmb_name rr_name;
447
char rdata[MAX_DGRAM_SIZE];
450
/* Define these so we can pass info back to caller of name_query */
451
#define NM_FLAGS_RS 0x80 /* Response. Cheat */
452
#define NM_FLAGS_AA 0x40 /* Authoritative */
453
#define NM_FLAGS_TC 0x20 /* Truncated */
454
#define NM_FLAGS_RD 0x10 /* Recursion Desired */
455
#define NM_FLAGS_RA 0x08 /* Recursion Available */
456
#define NM_FLAGS_B 0x01 /* Broadcast */
466
bool recursion_available;
467
bool recursion_desired;
479
struct nmb_name question_name;
484
struct res_rec *answers;
485
struct res_rec *nsrecs;
486
struct res_rec *additional;
489
/* msg_type field options - from rfc1002. */
491
#define DGRAM_UNIQUE 0x10
492
#define DGRAM_GROUP 0x11
493
#define DGRAM_BROADCAST 0x12
495
#define DGRAM_ERROR 0x13
497
#define DGRAM_QUERY_REQUEST 0x14
498
#define DGRAM_POSITIVE_QUERY_RESPONSE 0x15
499
#define DGRAM_NEGATIVE_QUERT_RESPONSE 0x16
501
/* A datagram - this normally contains SMB data in the data[] array. */
503
struct dgram_packet {
507
enum node_type node_type;
512
struct in_addr source_ip;
517
struct nmb_name source_name;
518
struct nmb_name dest_name;
520
char data[MAX_DGRAM_SIZE];
523
/* Define a structure used to queue packets. This will be a linked
524
list of nmb packets. */
528
struct packet_struct *next;
529
struct packet_struct *prev;
535
enum packet_type packet_type;
537
struct nmb_packet nmb;
538
struct dgram_packet dgram;
542
/* Ids for netbios packet types. */
544
#define ANN_HostAnnouncement 1
545
#define ANN_AnnouncementRequest 2
546
#define ANN_Election 8
547
#define ANN_GetBackupListReq 9
548
#define ANN_GetBackupListResp 10
549
#define ANN_BecomeBackup 11
550
#define ANN_DomainAnnouncement 12
551
#define ANN_MasterAnnouncement 13
552
#define ANN_ResetBrowserState 14
553
#define ANN_LocalMasterAnnouncement 15
556
/* Broadcast packet announcement intervals, in minutes. */
558
/* Attempt to add domain logon and domain master names. */
559
#define CHECK_TIME_ADD_DOM_NAMES 5
561
/* Search for master browsers of workgroups samba knows about,
563
#define CHECK_TIME_MST_BROWSE 5
565
/* Request backup browser announcements from other servers. */
566
#define CHECK_TIME_ANNOUNCE_BACKUP 15
568
/* Request host announcements from other servers: min and max of interval. */
569
#define CHECK_TIME_MIN_HOST_ANNCE 3
570
#define CHECK_TIME_MAX_HOST_ANNCE 12
572
/* Announce as master to WINS server and any Primary Domain Controllers. */
573
#define CHECK_TIME_MST_ANNOUNCE 15
575
/* Time between syncs from domain master browser to local master browsers. */
576
#define CHECK_TIME_DMB_TO_LMB_SYNC 15
578
/* Do all remote announcements this often. */
579
#define REMOTE_ANNOUNCE_INTERVAL 180
581
/* what is the maximum period between name refreshes. Note that this only
582
affects non-permanent self names (in seconds) */
583
#define MAX_REFRESH_TIME (60*20)
585
/* The Extinction interval: 4 days, time a node will stay in released state */
586
#define EXTINCTION_INTERVAL (4*24*60*60)
588
/* The Extinction time-out: 1 day, time a node will stay in deleted state */
589
#define EXTINCTION_TIMEOUT (24*60*60)
591
/* Macro's to enumerate subnets either with or without
592
the UNICAST subnet. */
594
extern struct subnet_record *subnetlist;
595
extern struct subnet_record *unicast_subnet;
596
extern struct subnet_record *wins_server_subnet;
597
extern struct subnet_record *remote_broadcast_subnet;
599
#define FIRST_SUBNET subnetlist
600
#define NEXT_SUBNET_EXCLUDING_UNICAST(x) ((x)->next)
601
#define NEXT_SUBNET_INCLUDING_UNICAST(x) (get_next_subnet_maybe_unicast((x)))
603
/* wins replication record used between nmbd and wrepld */
604
typedef struct _WINS_RECORD {
611
struct in_addr ip[25];
612
struct in_addr wins_ip;
616
enum state_type { TEST };
617
#endif /* _NAMESERV_H_ */