forked from osmocom/wireshark
![Guy Harris](/assets/img/avatar_default.png)
Otherwise, the first N packets printed, for a value of N dependent on various factors, won't get IP addresses resolved to names, even if the user wants them resolved. Unlike Wireshark, which, when a name is resolved in asynchronously, can go back and fix up the displayed packet when the asynchronous operation completes, once TShark has written packet data to the standard output, it can't go back and fix it if it did name resolution asynchronously. Bug: 14711 Change-Id: I8ebbd83103e5780c903b5560e01b7b92fa39c924 Reviewed-on: https://code.wireshark.org/review/27668 Reviewed-by: Guy Harris <guy@alum.mit.edu>
403 lines
13 KiB
C
403 lines
13 KiB
C
/* addr_resolv.h
|
|
* Definitions for network object lookup
|
|
*
|
|
* Laurent Deniel <laurent.deniel@free.fr>
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
/* The buffers returned by these functions are all allocated with a
|
|
* packet lifetime and does not have have to be freed.
|
|
* However, take into account that when the packet dissection
|
|
* completes, these buffers will be automatically reclaimed/freed.
|
|
* If you need the buffer to remain for a longer scope than packet lifetime
|
|
* you must copy the content to an wmem_file_scope() buffer.
|
|
*/
|
|
|
|
#ifndef __RESOLV_H__
|
|
#define __RESOLV_H__
|
|
|
|
#include <epan/address.h>
|
|
#include <epan/tvbuff.h>
|
|
#include <epan/ipv6.h>
|
|
#include <epan/to_str.h>
|
|
#include <wiretap/wtap.h>
|
|
#include "ws_symbol_export.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
#ifndef MAXNAMELEN
|
|
#define MAXNAMELEN 64 /* max name length (hostname and port name) */
|
|
#endif
|
|
|
|
#ifndef MAXVLANNAMELEN
|
|
#define MAXVLANNAMELEN 128 /* max vlan name length */
|
|
#endif
|
|
|
|
#define BASE_ENTERPRISES BASE_CUSTOM
|
|
#define STRINGS_ENTERPRISES CF_FUNC(enterprises_base_custom)
|
|
|
|
/**
|
|
* @brief Flags to control name resolution.
|
|
*/
|
|
typedef struct _e_addr_resolve {
|
|
gboolean mac_name; /**< Whether to resolve Ethernet MAC to manufacturer names */
|
|
gboolean network_name; /**< Whether to resolve IPv4, IPv6, and IPX addresses into host names */
|
|
gboolean transport_name; /**< Whether to resolve TCP/UDP/DCCP/SCTP ports into service names */
|
|
gboolean dns_pkt_addr_resolution; /**< Whether to resolve addresses using captured DNS packets */
|
|
gboolean use_external_net_name_resolver; /**< Whether to system's configured DNS server to resolve names */
|
|
gboolean load_hosts_file_from_profile_only; /**< Whether to only load the hosts in the current profile, not hosts files */
|
|
gboolean vlan_name; /**< Whether to resolve VLAN IDs to names */
|
|
gboolean ss7pc_name; /**< Whether to resolve SS7 Point Codes to names */
|
|
} e_addr_resolve;
|
|
|
|
#define ADDR_RESOLV_MACADDR(at) \
|
|
(((at)->type == AT_ETHER))
|
|
|
|
#define ADDR_RESOLV_NETADDR(at) \
|
|
(((at)->type == AT_IPv4) || ((at)->type == AT_IPv6) || ((at)->type == AT_IPX))
|
|
|
|
struct hashether;
|
|
typedef struct hashether hashether_t;
|
|
|
|
struct hashmanuf;
|
|
typedef struct hashmanuf hashmanuf_t;
|
|
|
|
typedef struct serv_port {
|
|
gchar *udp_name;
|
|
gchar *tcp_name;
|
|
gchar *sctp_name;
|
|
gchar *dccp_name;
|
|
gchar *numeric;
|
|
} serv_port_t;
|
|
|
|
/*
|
|
* Flags for various IPv4/IPv6 hash table entries.
|
|
*/
|
|
#define TRIED_RESOLVE_ADDRESS (1U<<0) /* XXX - what does this bit *really* mean? */
|
|
#define NAME_RESOLVED (1U<<1) /* the name field contains a host name, not a printable address */
|
|
#define RESOLVED_ADDRESS_USED (1U<<2) /* a get_hostname* call returned the host name */
|
|
|
|
#define TRIED_OR_RESOLVED_MASK (TRIED_RESOLVE_ADDRESS | NAME_RESOLVED)
|
|
#define USED_AND_RESOLVED_MASK (NAME_RESOLVED | RESOLVED_ADDRESS_USED)
|
|
|
|
/*
|
|
* Flag controlling what names to resolve.
|
|
*/
|
|
WS_DLL_PUBLIC e_addr_resolve gbl_resolv_flags;
|
|
|
|
/* global variables */
|
|
|
|
extern gchar *g_ethers_path;
|
|
extern gchar *g_ipxnets_path;
|
|
extern gchar *g_pethers_path;
|
|
extern gchar *g_pipxnets_path;
|
|
|
|
/* Functions in addr_resolv.c */
|
|
|
|
/*
|
|
* udp_port_to_display() returns the port name corresponding to that UDP port,
|
|
* or the port number as a string if not found.
|
|
*/
|
|
WS_DLL_PUBLIC gchar *udp_port_to_display(wmem_allocator_t *allocator, guint port);
|
|
|
|
/*
|
|
* tcp_port_to_display() returns the port name corresponding to that TCP port,
|
|
* or the port number as a string if not found.
|
|
*/
|
|
WS_DLL_PUBLIC gchar *tcp_port_to_display(wmem_allocator_t *allocator, guint port);
|
|
|
|
/*
|
|
* dccp_port_to_display() returns the port name corresponding to that DCCP port,
|
|
* or the port number as a string if not found.
|
|
*/
|
|
extern gchar *dccp_port_to_display(wmem_allocator_t *allocator, guint port);
|
|
|
|
/*
|
|
* sctp_port_to_display() returns the port name corresponding to that SCTP port,
|
|
* or the port number as a string if not found.
|
|
*/
|
|
WS_DLL_PUBLIC gchar *sctp_port_to_display(wmem_allocator_t *allocator, guint port);
|
|
|
|
/*
|
|
* serv_name_lookup() returns the well known service name string, or numeric
|
|
* representation if one doesn't exist.
|
|
*/
|
|
WS_DLL_PUBLIC const gchar *serv_name_lookup(port_type proto, guint port);
|
|
|
|
/*
|
|
* enterprises_lookup() returns the private enterprise code string, or 'unknown_str'
|
|
* if one doesn't exist, or "<Unknown>" if that is NULL.
|
|
*/
|
|
WS_DLL_PUBLIC const gchar *enterprises_lookup(guint32 value, const char *unknown_str);
|
|
|
|
/*
|
|
* try_enterprises_lookup() returns the private enterprise code string, or NULL if not found.
|
|
*/
|
|
WS_DLL_PUBLIC const gchar *try_enterprises_lookup(guint32 value);
|
|
|
|
/*
|
|
* enterprises_base_custom() prints the "name (decimal)" string to 'buf'.
|
|
* (Used with BASE_CUSTOM field display).
|
|
*/
|
|
WS_DLL_PUBLIC void enterprises_base_custom(char *buf, guint32 value);
|
|
|
|
/*
|
|
* try_serv_name_lookup() returns the well known service name string, or NULL if
|
|
* one doesn't exist.
|
|
*/
|
|
WS_DLL_PUBLIC const gchar *try_serv_name_lookup(port_type proto, guint port);
|
|
|
|
/*
|
|
* port_with_resolution_to_str() prints the "<resolved> (<numerical>)" port
|
|
* string.
|
|
*/
|
|
WS_DLL_PUBLIC gchar *port_with_resolution_to_str(wmem_allocator_t *scope,
|
|
port_type proto, guint port);
|
|
|
|
/*
|
|
* port_with_resolution_to_str_buf() prints the "<resolved> (<numerical>)" port
|
|
* string to 'buf'. Return value is the same as g_snprintf().
|
|
*/
|
|
WS_DLL_PUBLIC int port_with_resolution_to_str_buf(gchar *buf, gulong buf_size,
|
|
port_type proto, guint port);
|
|
|
|
/*
|
|
* Asynchronous host name lookup initialization, processing, and cleanup
|
|
*/
|
|
|
|
/* Setup name resolution preferences */
|
|
struct pref_module;
|
|
extern void addr_resolve_pref_init(struct pref_module *nameres);
|
|
|
|
/*
|
|
* disable_name_resolution() sets all relevant gbl_resolv_flags to FALSE.
|
|
*/
|
|
WS_DLL_PUBLIC void disable_name_resolution(void);
|
|
|
|
/** If we're using c-ares process outstanding host name lookups.
|
|
* This is called from a GLIB timeout in Wireshark and before processing
|
|
* each packet in TShark.
|
|
*
|
|
* @return True if any new objects have been resolved since the previous
|
|
* call. This can be used to trigger a display update, e.g. in Wireshark.
|
|
*/
|
|
WS_DLL_PUBLIC gboolean host_name_lookup_process(void);
|
|
|
|
/* get_hostname returns the host name or "%d.%d.%d.%d" if not found */
|
|
WS_DLL_PUBLIC const gchar *get_hostname(const guint addr);
|
|
|
|
/* get_hostname6 returns the host name, or numeric addr if not found */
|
|
WS_DLL_PUBLIC const gchar *get_hostname6(const ws_in6_addr *ad);
|
|
|
|
/* get_ether_name returns the logical name if found in ethers files else
|
|
"<vendor>_%02x:%02x:%02x" if the vendor code is known else
|
|
"%02x:%02x:%02x:%02x:%02x:%02x" */
|
|
WS_DLL_PUBLIC const gchar *get_ether_name(const guint8 *addr);
|
|
|
|
/* get_hostname_ss7pc returns the logical name if found in ss7pcs file else
|
|
'\0' on the first call or the unresolved Point Code in the subsequent calls */
|
|
const gchar *get_hostname_ss7pc(const guint8 ni, const guint32 pc);
|
|
|
|
/* fill_unresolved_ss7pc initializes the unresolved Point Code Address string in the hashtable */
|
|
void fill_unresolved_ss7pc(const gchar * pc_addr, const guint8 ni, const guint32 pc);
|
|
|
|
|
|
/* Same as get_ether_name with tvb support */
|
|
WS_DLL_PUBLIC const gchar *tvb_get_ether_name(tvbuff_t *tvb, gint offset);
|
|
|
|
/* get_ether_name_if_known returns the logical name if found in ethers files else NULL */
|
|
const gchar *get_ether_name_if_known(const guint8 *addr);
|
|
|
|
/*
|
|
* Given a sequence of 3 octets containing an OID, get_manuf_name()
|
|
* returns the vendor name, or "%02x:%02x:%02x" if not known.
|
|
*/
|
|
extern const gchar *get_manuf_name(const guint8 *addr);
|
|
|
|
/*
|
|
* Given a sequence of 3 octets containing an OID, get_manuf_name_if_known()
|
|
* returns the vendor name, or NULL if not known.
|
|
*/
|
|
WS_DLL_PUBLIC const gchar *get_manuf_name_if_known(const guint8 *addr);
|
|
|
|
/*
|
|
* Given an integer containing a 24-bit OID, uint_get_manuf_name_if_known()
|
|
* returns the vendor name, or NULL if not known.
|
|
*/
|
|
extern const gchar *uint_get_manuf_name_if_known(const guint oid);
|
|
|
|
/*
|
|
* Given a tvbuff and an offset in that tvbuff for a 3-octet OID,
|
|
* tvb_get_manuf_name() returns the vendor name, or "%02x:%02x:%02x"
|
|
* if not known.
|
|
*/
|
|
WS_DLL_PUBLIC const gchar *tvb_get_manuf_name(tvbuff_t *tvb, gint offset);
|
|
|
|
/*
|
|
* Given a tvbuff and an offset in that tvbuff for a 3-octet OID,
|
|
* tvb_get_manuf_name_if_known() returns the vendor name, or NULL
|
|
* if not known.
|
|
*/
|
|
WS_DLL_PUBLIC const gchar *tvb_get_manuf_name_if_known(tvbuff_t *tvb, gint offset);
|
|
|
|
/* eui64_to_display returns "<vendor>_%02x:%02x:%02x:%02x:%02x:%02x" if the vendor code is known
|
|
"%02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x" */
|
|
extern gchar *eui64_to_display(wmem_allocator_t *allocator, const guint64 addr);
|
|
|
|
/* get_ipxnet_name returns the logical name if found in an ipxnets file,
|
|
* or a string formatted with "%X" if not */
|
|
extern gchar *get_ipxnet_name(wmem_allocator_t *allocator, const guint32 addr);
|
|
|
|
/* get_vlan_name returns the logical name if found in a vlans file,
|
|
* or the VLAN ID itself as a string if not found*/
|
|
extern gchar *get_vlan_name(wmem_allocator_t *allocator, const guint16 id);
|
|
|
|
WS_DLL_PUBLIC guint get_hash_ether_status(hashether_t* ether);
|
|
WS_DLL_PUBLIC char* get_hash_ether_hexaddr(hashether_t* ether);
|
|
WS_DLL_PUBLIC char* get_hash_ether_resolved_name(hashether_t* ether);
|
|
|
|
WS_DLL_PUBLIC char* get_hash_manuf_resolved_name(hashmanuf_t* manuf);
|
|
|
|
|
|
/* adds a hostname/IPv4 in the hash table */
|
|
WS_DLL_PUBLIC void add_ipv4_name(const guint addr, const gchar *name);
|
|
|
|
/* adds a hostname/IPv6 in the hash table */
|
|
WS_DLL_PUBLIC void add_ipv6_name(const ws_in6_addr *addr, const gchar *name);
|
|
|
|
/** Add an additional "hosts" file for IPv4 and IPv6 name resolution.
|
|
*
|
|
* The file can be added before host_name_lookup_init() is called and
|
|
* will be re-read each time host_name_lookup_init() is called.
|
|
*
|
|
* @param hosts_file Absolute path to the hosts file.
|
|
*
|
|
* @return TRUE if the hosts file can be read.
|
|
*/
|
|
WS_DLL_PUBLIC gboolean add_hosts_file (const char *hosts_file);
|
|
|
|
/* adds a hostname in the hash table */
|
|
WS_DLL_PUBLIC gboolean add_ip_name_from_string (const char *addr, const char *name);
|
|
|
|
|
|
/** Get lists of host name to address mappings we know about.
|
|
*
|
|
* The struct contains two g_lists one with hashipv4_t entries and one with hashipv6_t entries.
|
|
*
|
|
* @return a struct with lists of known addresses(IPv4 and IPv6). May be NULL.
|
|
*/
|
|
WS_DLL_PUBLIC addrinfo_lists_t *get_addrinfo_list(void);
|
|
|
|
/* add ethernet address / name corresponding to IP address */
|
|
extern void add_ether_byip(const guint ip, const guint8 *eth);
|
|
|
|
/** Translates a string representing a hostname or dotted-decimal IPv4 address
|
|
* into a numeric IPv4 address value in network byte order. If compiled with
|
|
* c-ares, the request will wait a maximum of 250ms for the request to finish.
|
|
* Otherwise the wait time will be system-dependent, ususally much longer.
|
|
* Immediately returns FALSE for hostnames if network name resolution is
|
|
* disabled.
|
|
*
|
|
* @param[in] host The hostname.
|
|
* @param[out] addrp The numeric IPv4 address in network byte order.
|
|
* @return TRUE on success, FALSE on failure, timeout.
|
|
*/
|
|
WS_DLL_PUBLIC
|
|
gboolean get_host_ipaddr(const char *host, guint32 *addrp);
|
|
|
|
/** Translates a string representing a hostname or colon-hex IPv6 address
|
|
* into a numeric IPv6 address value in network byte order. If compiled with
|
|
* c-ares, the request will wait a maximum of 250ms for the request to finish.
|
|
* Otherwise the wait time will be system-dependent, usually much longer.
|
|
* Immediately returns FALSE for hostnames if network name resolution is
|
|
* disabled.
|
|
*
|
|
* @param[in] host The hostname.
|
|
* @param[out] addrp The numeric IPv6 address in network byte order.
|
|
* @return TRUE on success, FALSE on failure or timeout.
|
|
*/
|
|
WS_DLL_PUBLIC
|
|
gboolean get_host_ipaddr6(const char *host, ws_in6_addr *addrp);
|
|
|
|
WS_DLL_PUBLIC
|
|
wmem_map_t *get_manuf_hashtable(void);
|
|
|
|
WS_DLL_PUBLIC
|
|
wmem_map_t *get_wka_hashtable(void);
|
|
|
|
WS_DLL_PUBLIC
|
|
wmem_map_t *get_eth_hashtable(void);
|
|
|
|
WS_DLL_PUBLIC
|
|
wmem_map_t *get_serv_port_hashtable(void);
|
|
|
|
WS_DLL_PUBLIC
|
|
wmem_map_t *get_ipxnet_hash_table(void);
|
|
|
|
WS_DLL_PUBLIC
|
|
wmem_map_t *get_vlan_hash_table(void);
|
|
|
|
WS_DLL_PUBLIC
|
|
wmem_map_t *get_ipv4_hash_table(void);
|
|
|
|
WS_DLL_PUBLIC
|
|
wmem_map_t *get_ipv6_hash_table(void);
|
|
|
|
/*
|
|
* XXX - if we ever have per-session host name etc. information, we
|
|
* should probably have the "resolve synchronously or asynchronously"
|
|
* flag be per-session, set with an epan API.
|
|
*/
|
|
WS_DLL_PUBLIC
|
|
void set_resolution_synchrony(gboolean synchronous);
|
|
|
|
/*
|
|
* private functions (should only be called by epan directly)
|
|
*/
|
|
|
|
WS_DLL_LOCAL
|
|
void name_resolver_init(void);
|
|
|
|
/* (Re)Initialize hostname resolution subsystem */
|
|
WS_DLL_LOCAL
|
|
void host_name_lookup_init(void);
|
|
|
|
/* Clean up only hostname resolutions (so they don't "leak" from one
|
|
* file to the next).
|
|
*/
|
|
WS_DLL_LOCAL
|
|
void host_name_lookup_cleanup(void);
|
|
|
|
WS_DLL_LOCAL
|
|
void addr_resolv_init(void);
|
|
|
|
WS_DLL_LOCAL
|
|
void addr_resolv_cleanup(void);
|
|
|
|
WS_DLL_PUBLIC
|
|
void manually_resolve_cleanup(void);
|
|
|
|
WS_DLL_PUBLIC
|
|
gboolean str_to_ip(const char *str, void *dst);
|
|
|
|
WS_DLL_PUBLIC
|
|
gboolean str_to_ip6(const char *str, void *dst);
|
|
|
|
WS_DLL_LOCAL
|
|
guint ipv6_oat_hash(gconstpointer key);
|
|
|
|
WS_DLL_LOCAL
|
|
gboolean ipv6_equal(gconstpointer v1, gconstpointer v2);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* __RESOLV_H__ */
|