epan/addr_resolv.h

   1 /* addr_resolv.h
   2  * Definitions for network object lookup
   3  *
   4  * Laurent Deniel <laurent.deniel@free.fr>
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * SPDX-License-Identifier: GPL-2.0-or-later
  11  */
  12 /* The buffers returned by these functions are all allocated with a
  13  * packet lifetime and does not have have to be freed.
  14  * However, take into account that when the packet dissection
  15  * completes, these buffers will be automatically reclaimed/freed.
  16  * If you need the buffer to remain for a longer scope than packet lifetime
  17  * you must copy the content to an wmem_file_scope() buffer.
  18  */
  19
  20 #ifndef __RESOLV_H__
  21 #define __RESOLV_H__
  22
  23 #include <epan/address.h>
  24 #include <epan/tvbuff.h>
  25 #include <epan/ipv6.h>
  26 #include <epan/to_str.h>
  27 #include <wiretap/wtap.h>
  28 #include "ws_symbol_export.h"
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif /* __cplusplus */
  33
  34 #ifndef MAXNAMELEN
  35 #define MAXNAMELEN      64      /* max name length (hostname and port name) */
  36 #endif
  37
  38 #ifndef MAXVLANNAMELEN
  39 #define MAXVLANNAMELEN          128     /* max vlan name length */
  40 #endif
  41
  42 #define BASE_ENTERPRISES     BASE_CUSTOM
  43 #define STRINGS_ENTERPRISES  CF_FUNC(enterprises_base_custom)
  44
  45 /**
  46  * @brief Flags to control name resolution.
  47  */
  48 typedef struct _e_addr_resolve {
  49   gboolean mac_name;                          /**< Whether to resolve Ethernet MAC to manufacturer names */
  50   gboolean network_name;                      /**< Whether to resolve IPv4, IPv6, and IPX addresses into host names */
  51   gboolean transport_name;                    /**< Whether to resolve TCP/UDP/DCCP/SCTP ports into service names */
  52   gboolean dns_pkt_addr_resolution;           /**< Whether to resolve addresses using captured DNS packets */
  53   gboolean use_external_net_name_resolver;    /**< Whether to system's configured DNS server to resolve names */
  54   gboolean load_hosts_file_from_profile_only; /**< Whether to only load the hosts in the current profile, not hosts files */
  55   gboolean vlan_name;                         /**< Whether to resolve VLAN IDs to names */
  56   gboolean ss7pc_name;                        /**< Whether to resolve SS7 Point Codes to names */
  57 } e_addr_resolve;
  58
  59 #define ADDR_RESOLV_MACADDR(at) \
  60     (((at)->type == AT_ETHER))
  61
  62 #define ADDR_RESOLV_NETADDR(at) \
  63     (((at)->type == AT_IPv4) || ((at)->type == AT_IPv6) || ((at)->type == AT_IPX))
  64
  65 struct hashether;
  66 typedef struct hashether hashether_t;
  67
  68 struct hashmanuf;
  69 typedef struct hashmanuf hashmanuf_t;
  70
  71 typedef struct serv_port {
  72   gchar            *udp_name;
  73   gchar            *tcp_name;
  74   gchar            *sctp_name;
  75   gchar            *dccp_name;
  76   gchar            *numeric;
  77 } serv_port_t;
  78
  79 /*
  80  * Flags for various IPv4/IPv6 hash table entries.
  81  */
  82 #define TRIED_RESOLVE_ADDRESS    (1U<<0)  /* XXX - what does this bit *really* mean? */
  83 #define NAME_RESOLVED            (1U<<1)  /* the name field contains a host name, not a printable address */
  84 #define RESOLVED_ADDRESS_USED    (1U<<2)  /* a get_hostname* call returned the host name */
  85
  86 #define TRIED_OR_RESOLVED_MASK   (TRIED_RESOLVE_ADDRESS | NAME_RESOLVED)
  87 #define USED_AND_RESOLVED_MASK   (NAME_RESOLVED | RESOLVED_ADDRESS_USED)
  88
  89 /*
  90  * Flag controlling what names to resolve.
  91  */
  92 WS_DLL_PUBLIC e_addr_resolve gbl_resolv_flags;
  93
  94 /* global variables */
  95
  96 extern gchar *g_ethers_path;
  97 extern gchar *g_ipxnets_path;
  98 extern gchar *g_pethers_path;
  99 extern gchar *g_pipxnets_path;
 100
 101 /* Functions in addr_resolv.c */
 102
 103 /*
 104  * udp_port_to_display() returns the port name corresponding to that UDP port,
 105  * or the port number as a string if not found.
 106  */
 107 WS_DLL_PUBLIC gchar *udp_port_to_display(wmem_allocator_t *allocator, guint port);
 108
 109 /*
 110  * tcp_port_to_display() returns the port name corresponding to that TCP port,
 111  * or the port number as a string if not found.
 112  */
 113 WS_DLL_PUBLIC gchar *tcp_port_to_display(wmem_allocator_t *allocator, guint port);
 114
 115 /*
 116  * dccp_port_to_display() returns the port name corresponding to that DCCP port,
 117  * or the port number as a string if not found.
 118  */
 119 extern gchar *dccp_port_to_display(wmem_allocator_t *allocator, guint port);
 120
 121 /*
 122  * sctp_port_to_display() returns the port name corresponding to that SCTP port,
 123  * or the port number as a string if not found.
 124  */
 125 WS_DLL_PUBLIC gchar *sctp_port_to_display(wmem_allocator_t *allocator, guint port);
 126
 127 /*
 128  * serv_name_lookup() returns the well known service name string, or numeric
 129  * representation if one doesn't exist.
 130  */
 131 WS_DLL_PUBLIC const gchar *serv_name_lookup(port_type proto, guint port);
 132
 133 /*
 134  * enterprises_lookup() returns the private enterprise code string, or 'unknown_str'
 135  * if one doesn't exist, or "<Unknown>" if that is NULL.
 136  */
 137 WS_DLL_PUBLIC const gchar *enterprises_lookup(guint32 value, const char *unknown_str);
 138
 139 /*
 140  * try_enterprises_lookup() returns the private enterprise code string, or NULL if not found.
 141  */
 142 WS_DLL_PUBLIC const gchar *try_enterprises_lookup(guint32 value);
 143
 144 /*
 145  * enterprises_base_custom() prints the "name (decimal)" string to 'buf'.
 146  * (Used with BASE_CUSTOM field display).
 147  */
 148 WS_DLL_PUBLIC void enterprises_base_custom(char *buf, guint32 value);
 149
 150 /*
 151  * try_serv_name_lookup() returns the well known service name string, or NULL if
 152  * one doesn't exist.
 153  */
 154 WS_DLL_PUBLIC const gchar *try_serv_name_lookup(port_type proto, guint port);
 155
 156 /*
 157  * port_with_resolution_to_str() prints the "<resolved> (<numerical>)" port
 158  * string.
 159  */
 160 WS_DLL_PUBLIC gchar *port_with_resolution_to_str(wmem_allocator_t *scope,
 161                                         port_type proto, guint port);
 162
 163 /*
 164  * port_with_resolution_to_str_buf() prints the "<resolved> (<numerical>)" port
 165  * string to 'buf'. Return value is the same as g_snprintf().
 166  */
 167 WS_DLL_PUBLIC int port_with_resolution_to_str_buf(gchar *buf, gulong buf_size,
 168                                         port_type proto, guint port);
 169
 170 /*
 171  * Asynchronous host name lookup initialization, processing, and cleanup
 172  */
 173
 174 /* Setup name resolution preferences */
 175 struct pref_module;
 176 extern void addr_resolve_pref_init(struct pref_module *nameres);
 177
 178 /*
 179  * disable_name_resolution() sets all relevant gbl_resolv_flags to FALSE.
 180  */
 181 WS_DLL_PUBLIC void disable_name_resolution(void);
 182
 183 /** If we're using c-ares process outstanding host name lookups.
 184  *  This is called from a GLIB timeout in Wireshark and before processing
 185  *  each packet in TShark.
 186  *
 187  * @return True if any new objects have been resolved since the previous
 188  * call. This can be used to trigger a display update, e.g. in Wireshark.
 189  */
 190 WS_DLL_PUBLIC gboolean host_name_lookup_process(void);
 191
 192 /* get_hostname returns the host name or "%d.%d.%d.%d" if not found */
 193 WS_DLL_PUBLIC const gchar *get_hostname(const guint addr);
 194
 195 /* get_hostname6 returns the host name, or numeric addr if not found */
 196 WS_DLL_PUBLIC const gchar *get_hostname6(const ws_in6_addr *ad);
 197
 198 /* get_ether_name returns the logical name if found in ethers files else
 199    "<vendor>_%02x:%02x:%02x" if the vendor code is known else
 200    "%02x:%02x:%02x:%02x:%02x:%02x" */
 201 WS_DLL_PUBLIC const gchar *get_ether_name(const guint8 *addr);
 202
 203 /* get_hostname_ss7pc returns the logical name if found in ss7pcs file else
 204    '\0' on the first call or the unresolved Point Code in the subsequent calls */
 205 const gchar *get_hostname_ss7pc(const guint8 ni, const guint32 pc);
 206
 207 /* fill_unresolved_ss7pc initializes the unresolved Point Code Address string in the hashtable */
 208 void fill_unresolved_ss7pc(const gchar * pc_addr, const guint8 ni, const guint32 pc);
 209
 210
 211 /* Same as get_ether_name with tvb support */
 212 WS_DLL_PUBLIC const gchar *tvb_get_ether_name(tvbuff_t *tvb, gint offset);
 213
 214 /* get_ether_name_if_known returns the logical name if found in ethers files else NULL */
 215 const gchar *get_ether_name_if_known(const guint8 *addr);
 216
 217 /*
 218  * Given a sequence of 3 octets containing an OID, get_manuf_name()
 219  * returns the vendor name, or "%02x:%02x:%02x" if not known.
 220  */
 221 extern const gchar *get_manuf_name(const guint8 *addr);
 222
 223 /*
 224  * Given a sequence of 3 octets containing an OID, get_manuf_name_if_known()
 225  * returns the vendor name, or NULL if not known.
 226  */
 227 WS_DLL_PUBLIC const gchar *get_manuf_name_if_known(const guint8 *addr);
 228
 229 /*
 230  * Given an integer containing a 24-bit OID, uint_get_manuf_name_if_known()
 231  * returns the vendor name, or NULL if not known.
 232  */
 233 extern const gchar *uint_get_manuf_name_if_known(const guint oid);
 234
 235 /*
 236  * Given a tvbuff and an offset in that tvbuff for a 3-octet OID,
 237  * tvb_get_manuf_name() returns the vendor name, or "%02x:%02x:%02x"
 238  * if not known.
 239  */
 240 WS_DLL_PUBLIC const gchar *tvb_get_manuf_name(tvbuff_t *tvb, gint offset);
 241
 242 /*
 243  * Given a tvbuff and an offset in that tvbuff for a 3-octet OID,
 244  * tvb_get_manuf_name_if_known() returns the vendor name, or NULL
 245  * if not known.
 246  */
 247 WS_DLL_PUBLIC const gchar *tvb_get_manuf_name_if_known(tvbuff_t *tvb, gint offset);
 248
 249 /* eui64_to_display returns "<vendor>_%02x:%02x:%02x:%02x:%02x:%02x" if the vendor code is known
 250    "%02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x" */
 251 extern gchar *eui64_to_display(wmem_allocator_t *allocator, const guint64 addr);
 252
 253 /* get_ipxnet_name returns the logical name if found in an ipxnets file,
 254  * or a string formatted with "%X" if not */
 255 extern gchar *get_ipxnet_name(wmem_allocator_t *allocator, const guint32 addr);
 256
 257 /* get_vlan_name returns the logical name if found in a vlans file,
 258  * or the VLAN ID itself as a string if not found*/
 259 extern gchar *get_vlan_name(wmem_allocator_t *allocator, const guint16 id);
 260
 261 WS_DLL_PUBLIC guint get_hash_ether_status(hashether_t* ether);
 262 WS_DLL_PUBLIC char* get_hash_ether_hexaddr(hashether_t* ether);
 263 WS_DLL_PUBLIC char* get_hash_ether_resolved_name(hashether_t* ether);
 264
 265 WS_DLL_PUBLIC char* get_hash_manuf_resolved_name(hashmanuf_t* manuf);
 266
 267
 268 /* adds a hostname/IPv4 in the hash table */
 269 WS_DLL_PUBLIC void add_ipv4_name(const guint addr, const gchar *name);
 270
 271 /* adds a hostname/IPv6 in the hash table */
 272 WS_DLL_PUBLIC void add_ipv6_name(const ws_in6_addr *addr, const gchar *name);
 273
 274 /** Add an additional "hosts" file for IPv4 and IPv6 name resolution.
 275  *
 276  * The file can be added before host_name_lookup_init() is called and
 277  * will be re-read each time host_name_lookup_init() is called.
 278  *
 279  * @param hosts_file Absolute path to the hosts file.
 280  *
 281  * @return TRUE if the hosts file can be read.
 282  */
 283 WS_DLL_PUBLIC gboolean add_hosts_file (const char *hosts_file);
 284
 285 /* adds a hostname in the hash table */
 286 WS_DLL_PUBLIC gboolean add_ip_name_from_string (const char *addr, const char *name);
 287
 288
 289 /** Get lists of host name to address mappings we know about.
 290  *
 291  * The struct contains two g_lists one with hashipv4_t entries and one with hashipv6_t entries.
 292  *
 293  * @return a struct with lists of known addresses(IPv4 and IPv6). May be NULL.
 294  */
 295 WS_DLL_PUBLIC addrinfo_lists_t *get_addrinfo_list(void);
 296
 297 /* add ethernet address / name corresponding to IP address  */
 298 extern void add_ether_byip(const guint ip, const guint8 *eth);
 299
 300 /** Translates a string representing a hostname or dotted-decimal IPv4 address
 301  *  into a numeric IPv4 address value in network byte order. If compiled with
 302  *  c-ares, the request will wait a maximum of 250ms for the request to finish.
 303  *  Otherwise the wait time will be system-dependent, ususally much longer.
 304  *  Immediately returns FALSE for hostnames if network name resolution is
 305  *  disabled.
 306  *
 307  * @param[in] host The hostname.
 308  * @param[out] addrp The numeric IPv4 address in network byte order.
 309  * @return TRUE on success, FALSE on failure, timeout.
 310  */
 311 WS_DLL_PUBLIC
 312 gboolean get_host_ipaddr(const char *host, guint32 *addrp);
 313
 314 /** Translates a string representing a hostname or colon-hex IPv6 address
 315  *  into a numeric IPv6 address value in network byte order. If compiled with
 316  *  c-ares, the request will wait a maximum of 250ms for the request to finish.
 317  *  Otherwise the wait time will be system-dependent, usually much longer.
 318  *  Immediately returns FALSE for hostnames if network name resolution is
 319  *  disabled.
 320  *
 321  * @param[in] host The hostname.
 322  * @param[out] addrp The numeric IPv6 address in network byte order.
 323  * @return TRUE on success, FALSE on failure or timeout.
 324  */
 325 WS_DLL_PUBLIC
 326 gboolean get_host_ipaddr6(const char *host, ws_in6_addr *addrp);
 327
 328 WS_DLL_PUBLIC
 329 wmem_map_t *get_manuf_hashtable(void);
 330
 331 WS_DLL_PUBLIC
 332 wmem_map_t *get_wka_hashtable(void);
 333
 334 WS_DLL_PUBLIC
 335 wmem_map_t *get_eth_hashtable(void);
 336
 337 WS_DLL_PUBLIC
 338 wmem_map_t *get_serv_port_hashtable(void);
 339
 340 WS_DLL_PUBLIC
 341 wmem_map_t *get_ipxnet_hash_table(void);
 342
 343 WS_DLL_PUBLIC
 344 wmem_map_t *get_vlan_hash_table(void);
 345
 346 WS_DLL_PUBLIC
 347 wmem_map_t *get_ipv4_hash_table(void);
 348
 349 WS_DLL_PUBLIC
 350 wmem_map_t *get_ipv6_hash_table(void);
 351
 352 /*
 353  * XXX - if we ever have per-session host name etc. information, we
 354  * should probably have the "resolve synchronously or asynchronously"
 355  * flag be per-session, set with an epan API.
 356  */
 357 WS_DLL_PUBLIC
 358 void set_resolution_synchrony(gboolean synchronous);
 359
 360 /*
 361  * private functions (should only be called by epan directly)
 362  */
 363
 364 WS_DLL_LOCAL
 365 void name_resolver_init(void);
 366
 367 /* Reinitialize hostname resolution subsystem */
 368 WS_DLL_LOCAL
 369 void host_name_lookup_reset(void);
 370
 371 WS_DLL_LOCAL
 372 void addr_resolv_init(void);
 373
 374 WS_DLL_LOCAL
 375 void addr_resolv_cleanup(void);
 376
 377 WS_DLL_PUBLIC
 378 void manually_resolve_cleanup(void);
 379
 380 WS_DLL_PUBLIC
 381 gboolean str_to_ip(const char *str, void *dst);
 382
 383 WS_DLL_PUBLIC
 384 gboolean str_to_ip6(const char *str, void *dst);
 385
 386 WS_DLL_LOCAL
 387 gboolean str_to_eth(const char *str, char *eth_bytes);
 388
 389 WS_DLL_LOCAL
 390 guint ipv6_oat_hash(gconstpointer key);
 391
 392 WS_DLL_LOCAL
 393 gboolean ipv6_equal(gconstpointer v1, gconstpointer v2);
 394
 395 #ifdef __cplusplus
 396 }
 397 #endif /* __cplusplus */
 398
 399 #endif /* __RESOLV_H__ */