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 PERMANENT_TTL 0
  26
  27 /* NTAS uses 2, NT uses 1, WfWg uses 0 */
  28 #define MAINTAIN_LIST    2
  29 #define ELECTION_VERSION 1
  30
  31 #define MAX_DGRAM_SIZE (576) /* tcp/ip datagram limit is 576 bytes */
  32 #define MIN_DGRAM_SIZE 12
  33
  34 /*********************************************************
  35  Types of reply packet.
  36 **********************************************************/
  37
  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 };
  41
  42 /* From rfc1002, 4.2.1.2 */
  43 /* Question types. */
  44 #define QUESTION_TYPE_NB_QUERY  0x20
  45 #define QUESTION_TYPE_NB_STATUS 0x21
  46
  47 /* Question class */
  48 #define QUESTION_CLASS_IN  0x1
  49
  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. */
  60
  61 /* XXXX what about all the other types?? 0x1, 0x2, 0x3, 0x4, 0x8? */
  62
  63 /* Resource record types. rfc1002 4.2.1.3 */
  64 #define RR_TYPE_A                  0x1
  65 #define RR_TYPE_NS                 0x2
  66 #define RR_TYPE_NULL               0xA
  67 #define RR_TYPE_NB                0x20
  68 #define RR_TYPE_NBSTAT            0x21
  69
  70 /* Resource record class. */
  71 #define RR_CLASS_IN                0x1
  72
  73 /* NetBIOS flags */
  74 #define NB_GROUP  0x80
  75 #define NB_PERM   0x02
  76 #define NB_ACTIVE 0x04
  77 #define NB_CONFL  0x08
  78 #define NB_DEREG  0x10
  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
  86
  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)
  93
  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)
  98
  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. */
 107
 108 #define REFRESH_TIME (15*60)
 109 #define NAME_POLL_REFRESH_TIME (5*60)
 110 #define NAME_POLL_INTERVAL 15
 111
 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)
 117
 118 /* Microsoft browser NetBIOS name. */
 119 #define MSBROWSE "\001\002__MSBROWSE__\002"
 120
 121 /* Mail slots. */
 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"
 126
 127 /* Samba definitions for find_name_on_subnet(). */
 128 #define FIND_ANY_NAME   0
 129 #define FIND_SELF_NAME  1
 130
 131 /*
 132  * The different name types that can be in namelists.
 133  *
 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.
 139  *
 140  */
 141
 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};
 146
 147 enum master_state
 148 {
 149   MST_NONE,
 150   MST_POTENTIAL,
 151   MST_BACKUP,
 152   MST_MSB,
 153   MST_BROWSER,
 154   MST_UNBECOMING_MASTER
 155 };
 156
 157 enum domain_state
 158 {
 159   DOMAIN_NONE,
 160   DOMAIN_WAIT,
 161   DOMAIN_MST
 162 };
 163
 164 enum logon_state
 165 {
 166   LOGON_NONE,
 167   LOGON_WAIT,
 168   LOGON_SRV
 169 };
 170
 171 struct subnet_record;
 172
 173 struct nmb_data
 174 {
 175   uint16 nb_flags;         /* Netbios flags. */
 176   int num_ips;             /* Number of ip entries. */
 177   struct in_addr *ip;      /* The ip list for this name. */
 178
 179   enum name_source source; /* Where the name came from. */
 180
 181   time_t death_time; /* The time the record must be removed (do not remove if 0). */
 182   time_t refresh_time; /* The time the record should be refreshed. */
 183 };
 184
 185 /* This structure represents an entry in a local netbios name list. */
 186 struct name_record
 187   {
 188   ubi_trNode            node[1];
 189   struct subnet_record *subnet;
 190   struct nmb_name       name;    /* The netbios name. */
 191   struct nmb_data       data;    /* The netbios data. */
 192   };
 193
 194 /* Browser cache for synchronising browse lists. */
 195 struct browse_cache_record
 196   {
 197   ubi_dlNode     node[1];
 198   pstring        lmb_name;
 199   pstring        work_group;
 200   struct in_addr ip;
 201   time_t         sync_time;
 202   time_t         death_time; /* The time the record must be removed. */
 203   };
 204
 205 /* This is used to hold the list of servers in my domain, and is
 206    contained within lists of domains. */
 207
 208 struct server_record
 209 {
 210   struct server_record *next;
 211   struct server_record *prev;
 212
 213   struct subnet_record *subnet;
 214
 215   struct server_info_struct serv;
 216   time_t death_time;
 217 };
 218
 219 /* A workgroup structure. It contains a list of servers. */
 220 struct work_record
 221 {
 222   struct work_record *next;
 223   struct work_record *prev;
 224
 225   struct subnet_record *subnet;
 226
 227   struct server_record *serverlist;
 228
 229   /* Stage of development from non-local-master up to local-master browser. */
 230   enum master_state mst_state;
 231
 232   /* Stage of development from non-domain-master to domain-master browser. */
 233   enum domain_state dom_state;
 234
 235   /* Stage of development from non-logon-server to logon server. */
 236   enum logon_state log_state;
 237
 238   /* Work group info. */
 239   fstring work_group;
 240   int     token;        /* Used when communicating with backup browsers. */
 241   fstring local_master_browser_name;      /* Current local master browser. */
 242
 243   /* Announce info. */
 244   time_t lastannounce_time;
 245   int announce_interval;
 246   BOOL    needannounce;
 247
 248   /* Timeout time for this workgroup. 0 means permanent. */
 249   time_t death_time;
 250
 251   /* Election info */
 252   BOOL    RunningElection;
 253   BOOL    needelection;
 254   int     ElectionCount;
 255   uint32  ElectionCriterion;
 256
 257   /* Domain master browser info. Used for efficient syncs. */
 258   struct nmb_name dmb_name;
 259   struct in_addr dmb_addr;
 260 };
 261
 262 /* typedefs needed to define copy & free functions for userdata. */
 263 struct userdata_struct;
 264
 265 typedef struct userdata_struct * (*userdata_copy_fn)(struct userdata_struct *);
 266 typedef void (*userdata_free_fn)(struct userdata_struct *);
 267
 268 /* Structure to define any userdata passed around. */
 269
 270 struct userdata_struct {
 271   userdata_copy_fn copy_fn;
 272   userdata_free_fn free_fn;
 273   unsigned int userdata_len;
 274   char data[16]; /* 16 is to ensure alignment/padding on all systems */
 275 };
 276
 277 struct response_record;
 278 struct packet_struct;
 279 struct res_rec;
 280
 281 /* typedef to define the function called when this response packet comes in. */
 282 typedef void (*response_function)(struct subnet_record *, struct response_record *,
 283                                   struct packet_struct *);
 284
 285 /* typedef to define the function called when this response record times out. */
 286 typedef void (*timeout_response_function)(struct subnet_record *,
 287                                           struct response_record *);
 288
 289 /* typedef to define the function called when the request that caused this
 290    response record to be created is successful. */
 291 typedef void (*success_function)(struct subnet_record *, struct userdata_struct *, ...);
 292
 293 /* typedef to define the function called when the request that caused this
 294    response record to be created is unsuccessful. */
 295 typedef void (*fail_function)(struct subnet_record *, struct response_record *, ...);
 296
 297 /* List of typedefs for success and fail functions of the different query
 298    types. Used to catch any compile time prototype errors. */
 299
 300 typedef void (*register_name_success_function)( struct subnet_record *,
 301                                                 struct userdata_struct *,
 302                                                 struct nmb_name *,
 303                                                 uint16,
 304                                                 int,
 305                                                 struct in_addr);
 306 typedef void (*register_name_fail_function)( struct subnet_record *,
 307                                              struct response_record *,
 308                                              struct nmb_name *);
 309
 310 typedef void (*release_name_success_function)( struct subnet_record *,
 311                                                struct userdata_struct *,
 312                                                struct nmb_name *,
 313                                                struct in_addr);
 314 typedef void (*release_name_fail_function)( struct subnet_record *,
 315                                             struct response_record *,
 316                                             struct nmb_name *);
 317
 318 typedef void (*refresh_name_success_function)( struct subnet_record *,
 319                                                struct userdata_struct *,
 320                                                struct nmb_name *,
 321                                                uint16,
 322                                                int,
 323                                                struct in_addr);
 324 typedef void (*refresh_name_fail_function)( struct subnet_record *,
 325                                             struct response_record *,
 326                                             struct nmb_name *);
 327
 328 typedef void (*query_name_success_function)( struct subnet_record *,
 329                                              struct userdata_struct *,
 330                                              struct nmb_name *,
 331                                              struct in_addr,
 332                                              struct res_rec *answers);
 333
 334 typedef void (*query_name_fail_function)( struct subnet_record *,
 335                                           struct response_record *,
 336                                           struct nmb_name *,
 337                                           int);
 338
 339 typedef void (*node_status_success_function)( struct subnet_record *,
 340                                               struct userdata_struct *,
 341                                               struct res_rec *,
 342                                               struct in_addr);
 343 typedef void (*node_status_fail_function)( struct subnet_record *,
 344                                            struct response_record *);
 345
 346 /* Initiated name queries are recorded in this list to track any responses. */
 347
 348 struct response_record
 349 {
 350   struct response_record *next;
 351   struct response_record *prev;
 352
 353   uint16 response_id;
 354
 355   /* Callbacks for packets received or not. */
 356   response_function resp_fn;
 357   timeout_response_function timeout_fn;
 358
 359   /* Callbacks for the request succeeding or not. */
 360   success_function success_fn;
 361   fail_function fail_fn;
 362
 363   struct packet_struct *packet;
 364
 365   struct userdata_struct *userdata;
 366
 367   int num_msgs;
 368
 369   time_t repeat_time;
 370   time_t repeat_interval;
 371   int    repeat_count;
 372
 373   /* Recursion protection. */
 374   BOOL in_expiration_processing;
 375 };
 376
 377 /* A subnet structure. It contains a list of workgroups and netbios names. */
 378
 379 /*
 380    B nodes will have their own, totally separate subnet record, with their
 381    own netbios name set. These do NOT interact with other subnet records'
 382    netbios names.
 383 */
 384
 385 enum subnet_type {
 386   NORMAL_SUBNET              = 0,  /* Subnet listed in interfaces list. */
 387   UNICAST_SUBNET             = 1,  /* Subnet for unicast packets. */
 388   REMOTE_BROADCAST_SUBNET    = 2,  /* Subnet for remote broadcasts. */
 389   WINS_SERVER_SUBNET         = 3   /* Only created if we are a WINS server. */
 390 };
 391
 392 struct subnet_record
 393 {
 394   struct subnet_record *next;
 395   struct subnet_record *prev;
 396
 397   char  *subnet_name;      /* For Debug identification. */
 398   enum subnet_type type;   /* To catagorize the subnet. */
 399
 400   struct work_record     *workgrouplist; /* List of workgroups. */
 401   ubi_trRoot              namelist[1];   /* List of netbios names. */
 402   struct response_record *responselist;  /* List of responses expected. */
 403
 404   BOOL namelist_changed;
 405   BOOL work_changed;
 406
 407   struct in_addr bcast_ip;
 408   struct in_addr mask_ip;
 409   struct in_addr myip;
 410   int nmb_sock;               /* socket to listen for unicast 137. */
 411   int dgram_sock;             /* socket to listen for unicast 138. */
 412 };
 413
 414 /* A resource record. */
 415 struct res_rec {
 416   struct nmb_name rr_name;
 417   int rr_type;
 418   int rr_class;
 419   int ttl;
 420   int rdlength;
 421   char rdata[MAX_DGRAM_SIZE];
 422 };
 423
 424 /* An nmb packet. */
 425 struct nmb_packet
 426 {
 427   struct {
 428     int name_trn_id;
 429     int opcode;
 430     BOOL response;
 431     struct {
 432       BOOL bcast;
 433       BOOL recursion_available;
 434       BOOL recursion_desired;
 435       BOOL trunc;
 436       BOOL authoritative;
 437     } nm_flags;
 438     int rcode;
 439     int qdcount;
 440     int ancount;
 441     int nscount;
 442     int arcount;
 443   } header;
 444
 445   struct {
 446     struct nmb_name question_name;
 447     int question_type;
 448     int question_class;
 449   } question;
 450
 451   struct res_rec *answers;
 452   struct res_rec *nsrecs;
 453   struct res_rec *additional;
 454 };
 455
 456
 457 /* A datagram - this normally contains SMB data in the data[] array. */
 458
 459 struct dgram_packet {
 460   struct {
 461     int msg_type;
 462     struct {
 463       enum node_type node_type;
 464       BOOL first;
 465       BOOL more;
 466     } flags;
 467     int dgm_id;
 468     struct in_addr source_ip;
 469     int source_port;
 470     int dgm_length;
 471     int packet_offset;
 472   } header;
 473   struct nmb_name source_name;
 474   struct nmb_name dest_name;
 475   int datasize;
 476   char data[MAX_DGRAM_SIZE];
 477 };
 478
 479 /* Define a structure used to queue packets. This will be a linked
 480  list of nmb packets. */
 481
 482 struct packet_struct
 483 {
 484   struct packet_struct *next;
 485   struct packet_struct *prev;
 486   BOOL locked;
 487   struct in_addr ip;
 488   int port;
 489   int fd;
 490   time_t timestamp;
 491   enum packet_type packet_type;
 492   union {
 493     struct nmb_packet nmb;
 494     struct dgram_packet dgram;
 495   } packet;
 496 };
 497
 498 /* NETLOGON opcodes */
 499
 500 #define QUERYFORPDC      7 /* Query for PDC. */
 501 #define QUERYFORPDC_R   12 /* Response to Query for PDC. */
 502 #define SAMLOGON        18
 503 #define SAMLOGON_R      19
 504
 505
 506 /* Ids for netbios packet types. */
 507
 508 #define ANN_HostAnnouncement         1
 509 #define ANN_AnnouncementRequest      2
 510 #define ANN_Election                 8
 511 #define ANN_GetBackupListReq         9
 512 #define ANN_GetBackupListResp       10
 513 #define ANN_BecomeBackup            11
 514 #define ANN_DomainAnnouncement      12
 515 #define ANN_MasterAnnouncement      13
 516 #define ANN_ResetBrowserState       14
 517 #define ANN_LocalMasterAnnouncement 15
 518
 519
 520 /* Broadcast packet announcement intervals, in minutes. */
 521
 522 /* Attempt to add domain logon and domain master names. */
 523 #define CHECK_TIME_ADD_DOM_NAMES 5
 524
 525 /* Search for master browsers of workgroups samba knows about,
 526    except default. */
 527 #define CHECK_TIME_MST_BROWSE       5
 528
 529 /* Request backup browser announcements from other servers. */
 530 #define CHECK_TIME_ANNOUNCE_BACKUP 15
 531
 532 /* Request host announcements from other servers: min and max of interval. */
 533 #define CHECK_TIME_MIN_HOST_ANNCE   3
 534 #define CHECK_TIME_MAX_HOST_ANNCE  12
 535
 536 /* Announce as master to WINS server and any Primary Domain Controllers. */
 537 #define CHECK_TIME_MST_ANNOUNCE    15
 538
 539 /* Time between syncs from domain master browser to local master browsers. */
 540 #define CHECK_TIME_DMB_TO_LMB_SYNC    15
 541
 542 /* Do all remote announcements this often. */
 543 #define REMOTE_ANNOUNCE_INTERVAL 180
 544
 545 /* what is the maximum period between name refreshes. Note that this only
 546    affects non-permanent self names (in seconds) */
 547 #define MAX_REFRESH_TIME (60*20)
 548
 549 /* Macro's to enumerate subnets either with or without
 550    the UNICAST subnet. */
 551
 552 extern struct subnet_record *subnetlist;
 553 extern struct subnet_record *unicast_subnet;
 554 extern struct subnet_record *wins_server_subnet;
 555 extern struct subnet_record *remote_broadcast_subnet;
 556
 557 #define FIRST_SUBNET subnetlist
 558 #define NEXT_SUBNET_EXCLUDING_UNICAST(x) ((x)->next)
 559 #define NEXT_SUBNET_INCLUDING_UNICAST(x) (get_next_subnet_maybe_unicast((x)))
 560
 561 /* To be removed. */
 562 enum state_type { TEST };
 563 #endif /* _NAMESERV_H_ */