4 IDL structures for NBT operations
6 NBT is not traditionally encoded using IDL/NDR. This is a bit of an
7 experiment, and I may well switch us back to a more traditional
8 encoding if it doesn't work out
11 import "misc.idl", "security.idl";
13 helper("../librpc/ndr/ndr_nbt.h"),
14 helpstring("NBT messages"),
15 uuid("6def41b6-86e4-4c32-997c-ed33af7bcd8e")
19 const int NBT_NAME_SERVICE_PORT = 137;
20 const int NBT_DGRAM_SERVICE_PORT = 138;
22 typedef [bitmap16bit] bitmap {
24 NBT_FLAG_BROADCAST = 0x0010,
25 NBT_FLAG_RECURSION_AVAIL = 0x0080,
26 NBT_FLAG_RECURSION_DESIRED = 0x0100,
27 NBT_FLAG_TRUNCATION = 0x0200,
28 NBT_FLAG_AUTHORITATIVE = 0x0400,
30 NBT_FLAG_REPLY = 0x8000
33 /* the opcodes are in the operation field, masked with
36 NBT_OPCODE_QUERY = (0x0<<11),
37 NBT_OPCODE_REGISTER = (0x5<<11),
38 NBT_OPCODE_RELEASE = (0x6<<11),
39 NBT_OPCODE_WACK = (0x7<<11),
40 NBT_OPCODE_REFRESH = (0x8<<11),
41 NBT_OPCODE_REFRESH2 = (0x9<<11),
42 NBT_OPCODE_MULTI_HOME_REG = (0xf<<11)
57 /* we support any 8bit name type, but by defining the common
58 ones here we get better debug displays */
59 typedef [enum8bit] enum {
60 NBT_NAME_CLIENT = 0x00,
63 NBT_NAME_SERVER = 0x20,
65 NBT_NAME_LOGON = 0x1C,
66 NBT_NAME_MASTER = 0x1D,
67 NBT_NAME_BROWSER = 0x1E
70 /* the ndr parser for nbt_name is separately defined in
71 nbtname.c (along with the parsers for nbt_string) */
72 typedef [public,nopull,nopush] struct {
78 typedef [public,enum16bit] enum {
82 typedef [public,enum16bit] enum {
83 NBT_QTYPE_ADDRESS = 0x0001,
84 NBT_QTYPE_NAMESERVICE = 0x0002,
85 NBT_QTYPE_NULL = 0x000A,
86 NBT_QTYPE_NETBIOS = 0x0020,
87 NBT_QTYPE_STATUS = 0x0021
92 nbt_qtype question_type;
93 nbt_qclass question_class;
96 /* these are the possible values of the NBT_NM_OWNER_TYPE
105 typedef [bitmap16bit] bitmap {
106 NBT_NM_PERMANENT = 0x0200,
107 NBT_NM_ACTIVE = 0x0400,
108 NBT_NM_CONFLICT = 0x0800,
109 NBT_NM_DEREGISTER = 0x1000,
110 NBT_NM_OWNER_TYPE = 0x6000,
111 NBT_NM_GROUP = 0x8000
121 nbt_rdata_address addresses[length/6];
128 uint16 version_number;
129 uint16 period_of_statistics;
130 uint16 number_of_crcs;
131 uint16 number_alignment_errors;
132 uint16 number_of_collisions;
133 uint16 number_send_aborts;
134 uint32 number_good_sends;
135 uint32 number_good_receives;
136 uint16 number_retransmits;
137 uint16 number_no_resource_conditions;
138 uint16 number_free_command_blocks;
139 uint16 total_number_command_blocks;
140 uint16 max_total_number_command_blocks;
141 uint16 number_pending_sessions;
142 uint16 max_number_pending_sessions;
143 uint16 max_total_sessions_possible;
144 uint16 session_data_packet_size;
148 [charset(DOS)] uint8 name[15];
154 [value(num_names * 18 + 47)] uint16 length;
156 nbt_status_name names[num_names];
157 nbt_statistics statistics;
165 typedef [nodiscriminant,public] union {
166 [case(NBT_QTYPE_NETBIOS)] nbt_rdata_netbios netbios;
167 [case(NBT_QTYPE_STATUS)] nbt_rdata_status status;
168 [default] nbt_rdata_data data;
172 * this macro works around the problem
173 * that we need to use nbt_rdata_data
174 * together with NBT_QTYPE_NETBIOS
177 typedef [flag(LIBNDR_PRINT_ARRAY_HEX),nopush] struct {
182 [switch_is(rr_type)] nbt_rdata rdata;
185 typedef [flag(NDR_NOALIGN|NDR_BIG_ENDIAN|NDR_PAHEX),public] struct {
187 nbt_operation operation;
192 nbt_name_question questions[qdcount];
193 nbt_res_rec answers[ancount];
194 nbt_res_rec nsrecs[nscount];
195 nbt_res_rec additional[arcount];
196 [flag(NDR_REMAINING)] DATA_BLOB padding;
201 NBT DGRAM packets (UDP/138)
204 typedef [enum8bit] enum {
205 DGRAM_DIRECT_UNIQUE = 0x10,
206 DGRAM_DIRECT_GROUP = 0x11,
210 DGRAM_QUERY_POSITIVE = 0x15,
211 DGRAM_QUERY_NEGATIVE = 0x16
214 typedef [bitmap8bit] bitmap {
215 DGRAM_FLAG_MORE = 0x01,
216 DGRAM_FLAG_FIRST = 0x02,
217 DGRAM_FLAG_NODE_TYPE = 0x0C
220 typedef [enum8bit] enum {
224 DGRAM_NODE_NBDD = 0x0C
227 /* a dgram_message is the main dgram body in general use */
229 /* the most common datagram type is a SMB_TRANSACTION
230 operation, where a SMB packet is used in the data section
231 of a dgram_message to hold a trans request, which in turn
232 holds a small command structure. It's a very strange beast
233 indeed. To make the code cleaner we define a basic SMB
234 packet in IDL here. This is not a general purpose SMB
235 packet, and won't be used in the core SMB client/server
236 code, but it does make working with these types of dgrams
239 const string NBT_MAILSLOT_NETLOGON = "\\MAILSLOT\\NET\\NETLOGON";
240 const string NBT_MAILSLOT_NTLOGON = "\\MAILSLOT\\NET\\NTLOGON";
241 const string NBT_MAILSLOT_GETDC = "\\MAILSLOT\\NET\\GETDC";
242 const string NBT_MAILSLOT_BROWSE = "\\MAILSLOT\\BROWSE";
244 typedef [enum8bit] enum {
245 SMB_TRANSACTION = 0x25
249 [range(17,17),value(17)] uint8 wct;
250 uint16 total_param_count;
251 uint16 total_data_count;
252 uint16 max_param_count;
253 uint16 max_data_count;
254 uint8 max_setup_count;
263 [range(3,3),value(3)] uint8 setup_count;
268 [value(strlen(mailslot_name)+1+data.length)]
270 astring mailslot_name;
271 [flag(NDR_REMAINING)] DATA_BLOB data;
274 typedef [nodiscriminant] union {
275 [case(SMB_TRANSACTION)] smb_trans_body trans;
279 typedef [flag(NDR_NOALIGN|NDR_LITTLE_ENDIAN|NDR_PAHEX),public] struct {
280 smb_command smb_command;
293 [switch_is(smb_command)] smb_body body;
296 const uint32 DGRAM_SMB = 0xff534d42; /* 0xffSMB */
298 typedef [nodiscriminant] union {
299 [case(DGRAM_SMB)] dgram_smb_packet smb;
300 } dgram_message_body;
305 nbt_name source_name;
307 uint32 dgram_body_type;
308 [switch_is(dgram_body_type)] dgram_message_body body;
311 typedef [enum8bit] enum {
312 DGRAM_ERROR_NAME_NOT_PRESENT = 0x82,
313 DGRAM_ERROR_INVALID_SOURCE = 0x83,
314 DGRAM_ERROR_INVALID_DEST = 0x84
317 typedef [nodiscriminant] union {
318 [case(DGRAM_DIRECT_UNIQUE)] dgram_message msg;
319 [case(DGRAM_DIRECT_GROUP)] dgram_message msg;
320 [case(DGRAM_BCAST)] dgram_message msg;
321 [case(DGRAM_ERROR)] dgram_err_code error;
322 [case(DGRAM_QUERY)] nbt_name dest_name;
323 [case(DGRAM_QUERY_POSITIVE)] nbt_name dest_name;
324 [case(DGRAM_QUERY_NEGATIVE)] nbt_name dest_name;
327 typedef [flag(NDR_NOALIGN|NDR_BIG_ENDIAN|NDR_PAHEX),public] struct {
328 dgram_msg_type msg_type;
331 ipv4address src_addr;
333 [switch_is(msg_type)] dgram_data data;
337 /******************************************
338 * \MAILSLOT\NET\NETLOGON mailslot requests
340 * \MAILSLOT\NET\NTLOGON mailslot requests
343 typedef [public,gensize] struct {
344 uint32 sockaddr_family;
345 [flag(NDR_BIG_ENDIAN)] ipv4address pdc_ip;
346 [flag(NDR_REMAINING)] DATA_BLOB remaining;
349 typedef [bitmap32bit,public] bitmap {
350 NBT_SERVER_PDC = 0x00000001,
351 NBT_SERVER_GC = 0x00000004,
352 NBT_SERVER_LDAP = 0x00000008,
353 NBT_SERVER_DS = 0x00000010,
354 NBT_SERVER_KDC = 0x00000020,
355 NBT_SERVER_TIMESERV = 0x00000040,
356 NBT_SERVER_CLOSEST = 0x00000080,
357 NBT_SERVER_WRITABLE = 0x00000100,
358 NBT_SERVER_GOOD_TIMESERV = 0x00000200,
359 NBT_SERVER_NDNC = 0x00000400,
360 NBT_SERVER_SELECT_SECRET_DOMAIN_6 = 0x00000800,
361 NBT_SERVER_FULL_SECRET_DOMAIN_6 = 0x00001000,
362 NBT_SERVER_ADS_WEB_SERVICE = 0x00002000,
363 NBT_SERVER_DS_8 = 0x00004000,
364 NBT_SERVER_HAS_DNS_NAME = 0x20000000,
365 NBT_SERVER_IS_DEFAULT_NC = 0x40000000,
366 NBT_SERVER_FOREST_ROOT = 0x80000000
369 typedef [bitmap32bit,public] bitmap {
370 NETLOGON_NT_VERSION_1 = 0x00000001,
371 NETLOGON_NT_VERSION_5 = 0x00000002,
372 NETLOGON_NT_VERSION_5EX = 0x00000004,
373 NETLOGON_NT_VERSION_5EX_WITH_IP = 0x00000008,
374 NETLOGON_NT_VERSION_WITH_CLOSEST_SITE = 0x00000010,
375 NETLOGON_NT_VERSION_AVOID_NT4EMUL = 0x01000000,
376 NETLOGON_NT_VERSION_PDC = 0x10000000,
377 NETLOGON_NT_VERSION_IP = 0x20000000,
378 NETLOGON_NT_VERSION_LOCAL = 0x40000000,
379 NETLOGON_NT_VERSION_GC = 0x80000000
380 } netlogon_nt_version_flags;
382 typedef [enum16bit,public] enum {
385 LOGON_PRIMARY_QUERY = 7, /* Was also NETLOGON_QUERY_FOR_PDC */
386 NETLOGON_ANNOUNCE_UAS = 10,
387 NETLOGON_RESPONSE_FROM_PDC = 12,
388 LOGON_SAM_LOGON_REQUEST = 18, /* Was also NETLOGON_QUERY_FOR_PDC2, NTLOGON_SAM_LOGON */
389 LOGON_SAM_LOGON_RESPONSE = 19, /* Was also NTLOGON_SAM_LOGON_REPLY */
390 LOGON_SAM_LOGON_PAUSE_RESPONSE = 20,
391 LOGON_SAM_LOGON_USER_UNKNOWN = 21, /* Was also NTLOGON_SAM_LOGON_REPLY15 */
392 LOGON_SAM_LOGON_RESPONSE_EX = 23, /* was NETLOGON_RESPONSE_FROM_PDC2 */
393 LOGON_SAM_LOGON_PAUSE_RESPONSE_EX = 24,
394 LOGON_SAM_LOGON_USER_UNKNOWN_EX = 25 /* was NETLOGON_RESPONSE_FROM_PDC_USER */
397 /* query to dc hand marshaled, as it has 'optional'
399 typedef [nopull,nopush] struct {
400 uint16 request_count;
401 nstring computer_name;
403 astring mailslot_name;
405 /* samr_AcctFlags acct_control; */
406 [value(ndr_size_dom_sid0(&sid, ndr->flags))] uint32 sid_size;
407 /* The manual alignment is required because this
408 * structure is marked flag(NDR_NOALIGN) via the
409 * nbt_netlogon_packet below.
411 * However, both MUST only be present if sid_size > 0
413 [flag(NDR_ALIGN4)] DATA_BLOB _pad;
414 [subcontext(0),subcontext_size(sid_size)] dom_sid0 sid;
415 netlogon_nt_version_flags nt_version;
418 } NETLOGON_SAM_LOGON_REQUEST;
421 astring computer_name;
423 astring mailslot_name;
427 } NETLOGON_LOGON_REQUEST;
429 typedef [flag(NDR_NOALIGN),public] struct {
430 netlogon_command command;
434 netlogon_nt_version_flags nt_version;
437 } NETLOGON_SAM_LOGON_RESPONSE_NT40;
439 typedef [flag(NDR_NOALIGN),public] struct {
440 netlogon_command command;
447 nbt_string dns_domain;
448 nbt_string pdc_dns_name;
450 nbt_server_type server_type;
451 netlogon_nt_version_flags nt_version;
454 } NETLOGON_SAM_LOGON_RESPONSE;
456 /* response from pdc hand marshaled (we have an additional
457 * function that uses this structure), as it has 'optional'
459 typedef [flag(NDR_NOALIGN),public] struct {
460 netlogon_command command;
461 uint16 sbz; /* From the docs */
462 nbt_server_type server_type;
465 nbt_string dns_domain;
466 nbt_string pdc_dns_name;
467 nbt_string domain_name;
469 nbt_string user_name;
470 nbt_string server_site;
471 nbt_string client_site;
473 /* Optional on NETLOGON_NT_VERSION_5EX_WITH_IP */
474 [value(ndr_size_nbt_sockaddr(&sockaddr, ndr->flags))] uint8 sockaddr_size;
475 [subcontext(0),subcontext_size(sockaddr_size)] nbt_sockaddr sockaddr;
477 /* Optional on NETLOGON_NT_VERSION_WITH_CLOSEST_SITE */
478 nbt_string next_closest_site;
480 netlogon_nt_version_flags nt_version;
483 } NETLOGON_SAM_LOGON_RESPONSE_EX;
485 /* query for pdc request */
487 astring computer_name;
488 astring mailslot_name;
489 [flag(NDR_ALIGN2)] DATA_BLOB _pad;
490 nstring unicode_name;
491 netlogon_nt_version_flags nt_version;
494 } nbt_netlogon_query_for_pdc;
496 /* response from pdc */
497 typedef [public] struct {
498 netlogon_command command;
500 [flag(NDR_ALIGN2)] DATA_BLOB _pad;
501 nstring unicode_pdc_name;
503 netlogon_nt_version_flags nt_version;
506 } nbt_netlogon_response_from_pdc;
508 typedef [flag(NDR_NOALIGN),public] struct {
509 netlogon_command command;
512 } nbt_netlogon_response2;
514 /* used to announce SAM changes - MS-NRPC 2.2.1.5.1 */
516 netr_SamDatabaseID db_index;
519 } nbt_db_change_info;
528 [flag(NDR_ALIGN2)] DATA_BLOB _pad;
529 nstring unicode_pdc_name;
530 nstring unicode_domain;
532 nbt_db_change_info dbchange[db_count];
533 [value(ndr_size_dom_sid0(&sid, ndr->flags))] uint32 sid_size;
534 [subcontext(0),subcontext_size(sid_size)] dom_sid0 sid;
535 uint32 message_format_version;
536 uint32 message_token;
537 } NETLOGON_DB_CHANGE;
539 typedef [nodiscriminant] union {
540 [case(LOGON_REQUEST)] NETLOGON_LOGON_REQUEST logon0;
541 [case(LOGON_SAM_LOGON_REQUEST)] NETLOGON_SAM_LOGON_REQUEST logon;
542 [case(LOGON_PRIMARY_QUERY)] nbt_netlogon_query_for_pdc pdc;
543 [case(NETLOGON_ANNOUNCE_UAS)] NETLOGON_DB_CHANGE uas;
544 } nbt_netlogon_request;
547 /* These responses are all handled manually, as they cannot be encoded in IDL fully
549 See push_nbt_netlogon_response()
551 [case(NETLOGON_RESPONSE_FROM_PDC)] nbt_netlogon_response_from_pdc response;
552 [case(NETLOGON_RESPONSE_FROM_PDC_USER)] nbt_netlogon_response_from_pdc2 response2;
554 [case(LOGON_SAM_LOGON_PAUSE_RESPONSE)] NETLOGON_SAM_LOGON_RESPONSE reply;
555 [case(LOGON_SAM_LOGON_RESPONSE)] NETLOGON_SAM_LOGON_RESPONSE reply;
556 [case(LOGON_SAM_LOGON_USER_UNKNOWN)] NETLOGON_SAM_LOGON_RESPONSE reply;
557 [case(LOGON_SAM_LOGON_RESPONSE_EX)] NETLOGON_SAM_LOGON_RESPONSE_EX reply_ex;
558 [case(LOGON_SAM_LOGON_PAUSE_RESPONSE_EX)] NETLOGON_SAM_LOGON_RESPONSE_EX reply_ex;
559 [case(LOGON_SAM_LOGON_USER_UNKNOWN_EX)] NETLOGON_SAM_LOGON_RESPONSE_EX reply_ex;
562 typedef [flag(NDR_NOALIGN),public] struct {
563 netlogon_command command;
564 [switch_is(command)] nbt_netlogon_request req;
565 } nbt_netlogon_packet;
567 void decode_nbt_netlogon_packet(
568 [in] nbt_netlogon_packet packet
571 /********************************************************/
572 /* \MAILSLOT\BROWSE mailslot requests */
573 /* for details see http://ubiqx.org/cifs/Browsing.html */
574 /********************************************************/
575 typedef bitmap svcctl_ServerType svcctl_ServerType;
577 typedef [enum8bit] enum {
578 HostAnnouncement = 1,
579 AnnouncementRequest = 2,
581 GetBackupListReq = 9,
582 GetBackupListResp = 10,
584 DomainAnnouncement = 12,
585 MasterAnnouncement = 13,
586 ResetBrowserState = 14,
587 LocalMasterAnnouncement = 15
593 [charset(DOS)] uint8 ServerName[16];
596 svcctl_ServerType ServerType;
601 } nbt_browse_host_announcement;
605 astring ResponseName;
606 } nbt_browse_announcement_request;
611 uint32 UpTime; /* In milliseconds */
612 uint32 Reserved; /* Must be zero */
614 } nbt_browse_election_request;
619 } nbt_browse_backup_list_request;
624 nbt_name BackupServerList[BackupCount];/* TODO: this is wrong */
625 } nbt_browse_backup_list_response;
629 } nbt_browse_become_backup;
634 [charset(DOS)] uint8 ServerName[16];
637 svcctl_ServerType ServerType;
638 uint32 MysteriousField;
640 } nbt_browse_domain_announcement;
644 } nbt_browse_master_announcement;
648 } nbt_browse_reset_state;
653 [charset(DOS)] uint8 ServerName[16];
656 svcctl_ServerType ServerType;
661 } nbt_browse_local_master_announcement;
663 typedef [nodiscriminant] union {
664 [case(HostAnnouncement)] nbt_browse_host_announcement host_annoucement;
665 [case(AnnouncementRequest)] nbt_browse_announcement_request announcement_request;
666 [case(Election)] nbt_browse_election_request election_request;
667 [case(GetBackupListReq)] nbt_browse_backup_list_request backup_list_request;
668 [case(GetBackupListResp)] nbt_browse_backup_list_response backup_list_response;
669 [case(BecomeBackup)] nbt_browse_become_backup become_backup;
670 [case(DomainAnnouncement)] nbt_browse_domain_announcement domain_announcement;
671 [case(MasterAnnouncement)] nbt_browse_master_announcement master_announcement;
672 [case(ResetBrowserState)] nbt_browse_reset_state reset_browser_state;
673 [case(LocalMasterAnnouncement)] nbt_browse_local_master_announcement local_master_announcement;
674 } nbt_browse_payload;
676 typedef [public,flag(NDR_NOALIGN)] struct {
677 nbt_browse_opcode opcode;
678 [switch_is(opcode)] nbt_browse_payload payload;