Wireshark  4.3.0
The Wireshark network protocol analyzer
addr_resolv.h
Go to the documentation of this file.
1 
12 /* The buffers returned by these functions are all allocated with a
13  * packet lifetime and does not 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 
48 typedef struct _e_addr_resolve {
49  gboolean mac_name;
50  gboolean network_name;
51  gboolean transport_name;
55  gboolean vlan_name;
56  gboolean ss7pc_name;
57  gboolean maxmind_geoip;
59 
60 #define ADDR_RESOLV_MACADDR(at) \
61  (((at)->type == AT_ETHER))
62 
63 #define ADDR_RESOLV_NETADDR(at) \
64  (((at)->type == AT_IPv4) || ((at)->type == AT_IPv6) || ((at)->type == AT_IPX))
65 
66 struct hashether;
67 typedef struct hashether hashether_t;
68 
69 struct hashmanuf;
70 typedef struct hashmanuf hashmanuf_t;
71 
72 typedef struct serv_port {
73  gchar *udp_name;
74  gchar *tcp_name;
75  gchar *sctp_name;
76  gchar *dccp_name;
77  gchar *numeric;
78 } serv_port_t;
79 
80 typedef struct _resolved_name {
81  char name[MAXNAMELEN];
83 
84 /*
85  * Flags for various IPv4/IPv6 hash table entries.
86  */
87 #define TRIED_RESOLVE_ADDRESS (1U<<0) /* XXX - what does this bit *really* mean? */
88 #define NAME_RESOLVED (1U<<1) /* the name field contains a host name, not a printable address */
89 #define RESOLVED_ADDRESS_USED (1U<<2) /* a get_hostname* call returned the host name */
90 #define STATIC_HOSTNAME (1U<<3) /* do not update entries from hosts file with DNS responses */
91 
92 #define TRIED_OR_RESOLVED_MASK (TRIED_RESOLVE_ADDRESS | NAME_RESOLVED)
93 #define USED_AND_RESOLVED_MASK (NAME_RESOLVED | RESOLVED_ADDRESS_USED)
94 
95 /*
96  * Flag controlling what names to resolve.
97  */
98 WS_DLL_PUBLIC e_addr_resolve gbl_resolv_flags;
99 
100 /* global variables */
101 
102 extern gchar *g_ethers_path;
103 extern gchar *g_ipxnets_path;
104 extern gchar *g_pethers_path;
105 extern gchar *g_pipxnets_path;
106 
107 /* Functions in addr_resolv.c */
108 
109 /*
110  * udp_port_to_display() returns the port name corresponding to that UDP port,
111  * or the port number as a string if not found.
112  */
113 WS_DLL_PUBLIC gchar *udp_port_to_display(wmem_allocator_t *allocator, guint port);
114 
115 /*
116  * tcp_port_to_display() returns the port name corresponding to that TCP port,
117  * or the port number as a string if not found.
118  */
119 WS_DLL_PUBLIC gchar *tcp_port_to_display(wmem_allocator_t *allocator, guint port);
120 
121 /*
122  * dccp_port_to_display() returns the port name corresponding to that DCCP port,
123  * or the port number as a string if not found.
124  */
125 extern gchar *dccp_port_to_display(wmem_allocator_t *allocator, guint port);
126 
127 /*
128  * sctp_port_to_display() returns the port name corresponding to that SCTP port,
129  * or the port number as a string if not found.
130  */
131 WS_DLL_PUBLIC gchar *sctp_port_to_display(wmem_allocator_t *allocator, guint port);
132 
133 /*
134  * serv_name_lookup() returns the well known service name string, or numeric
135  * representation if one doesn't exist.
136  */
137 WS_DLL_PUBLIC const gchar *serv_name_lookup(port_type proto, guint port);
138 
139 /*
140  * enterprises_lookup() returns the private enterprise code string, or 'unknown_str'
141  * if one doesn't exist, or "<Unknown>" if that is NULL.
142  */
143 WS_DLL_PUBLIC const gchar *enterprises_lookup(guint32 value, const char *unknown_str);
144 
145 /*
146  * try_enterprises_lookup() returns the private enterprise code string, or NULL if not found.
147  */
148 WS_DLL_PUBLIC const gchar *try_enterprises_lookup(guint32 value);
149 
150 /*
151  * enterprises_base_custom() prints the "name (decimal)" string to 'buf'.
152  * (Used with BASE_CUSTOM field display).
153  */
154 WS_DLL_PUBLIC void enterprises_base_custom(char *buf, guint32 value);
155 
156 /*
157  * try_serv_name_lookup() returns the well known service name string, or NULL if
158  * one doesn't exist.
159  */
160 WS_DLL_PUBLIC const gchar *try_serv_name_lookup(port_type proto, guint port);
161 
162 /*
163  * port_with_resolution_to_str() prints the "<resolved> (<numerical>)" port
164  * string.
165  */
166 WS_DLL_PUBLIC gchar *port_with_resolution_to_str(wmem_allocator_t *scope,
167  port_type proto, guint port);
168 
169 /*
170  * port_with_resolution_to_str_buf() prints the "<resolved> (<numerical>)" port
171  * string to 'buf'. Return value is the same as snprintf().
172  */
173 WS_DLL_PUBLIC int port_with_resolution_to_str_buf(gchar *buf, gulong buf_size,
174  port_type proto, guint port);
175 
176 /*
177  * Asynchronous host name lookup initialization, processing, and cleanup
178  */
179 
180 /* Setup name resolution preferences */
181 struct pref_module;
182 extern void addr_resolve_pref_init(struct pref_module *nameres);
183 extern void addr_resolve_pref_apply(void);
184 
185 /*
186  * disable_name_resolution() sets all relevant gbl_resolv_flags to FALSE.
187  */
188 WS_DLL_PUBLIC void disable_name_resolution(void);
189 
197 WS_DLL_PUBLIC gboolean host_name_lookup_process(void);
198 
199 /* get_hostname returns the host name or "%d.%d.%d.%d" if not found */
200 WS_DLL_PUBLIC const gchar *get_hostname(const guint addr);
201 
202 /* get_hostname6 returns the host name, or numeric addr if not found */
203 WS_DLL_PUBLIC const gchar *get_hostname6(const ws_in6_addr *ad);
204 
205 /* get_ether_name returns the logical name if found in ethers files else
206  "<vendor>_%02x:%02x:%02x" if the vendor code is known else
207  "%02x:%02x:%02x:%02x:%02x:%02x" */
208 WS_DLL_PUBLIC const gchar *get_ether_name(const guint8 *addr);
209 
210 /* get_hostname_ss7pc returns the logical name if found in ss7pcs file else
211  '\0' on the first call or the unresolved Point Code in the subsequent calls */
212 const gchar *get_hostname_ss7pc(const guint8 ni, const guint32 pc);
213 
214 /* fill_unresolved_ss7pc initializes the unresolved Point Code Address string in the hashtable */
215 void fill_unresolved_ss7pc(const gchar * pc_addr, const guint8 ni, const guint32 pc);
216 
217 
218 /* Same as get_ether_name with tvb support */
219 WS_DLL_PUBLIC const gchar *tvb_get_ether_name(tvbuff_t *tvb, gint offset);
220 
221 /* get_ether_name_if_known returns the logical name if found in ethers files else NULL */
222 const gchar *get_ether_name_if_known(const guint8 *addr);
223 
224 /*
225  * Given a sequence of 3 octets containing an OID, get_manuf_name()
226  * returns the vendor name, or "%02x:%02x:%02x" if not known.
227  */
228 extern const gchar *get_manuf_name(const guint8 *addr, size_t size);
229 
230 /*
231  * Given a sequence of 3 octets containing an OID, get_manuf_name_if_known()
232  * returns the vendor name, or NULL if not known.
233  */
234 WS_DLL_PUBLIC const gchar *get_manuf_name_if_known(const guint8 *addr, size_t size);
235 
236 /*
237  * Given an integer containing a 24-bit OID, uint_get_manuf_name_if_known()
238  * returns the vendor name, or NULL if not known.
239  */
240 extern const gchar *uint_get_manuf_name_if_known(const guint32 oid);
241 
242 /*
243  * Given a tvbuff and an offset in that tvbuff for a 3-octet OID,
244  * tvb_get_manuf_name() returns the vendor name, or "%02x:%02x:%02x"
245  * if not known.
246  */
247 WS_DLL_PUBLIC const gchar *tvb_get_manuf_name(tvbuff_t *tvb, gint offset);
248 
249 /*
250  * Given a tvbuff and an offset in that tvbuff for a 3-octet OID,
251  * tvb_get_manuf_name_if_known() returns the vendor name, or NULL
252  * if not known.
253  */
254 WS_DLL_PUBLIC const gchar *tvb_get_manuf_name_if_known(tvbuff_t *tvb, gint offset);
255 
256 /* eui64_to_display returns "<vendor>_%02x:%02x:%02x:%02x:%02x:%02x" if the vendor code is known
257  "%02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x" */
258 extern gchar *eui64_to_display(wmem_allocator_t *allocator, const guint64 addr);
259 
260 /* get_ipxnet_name returns the logical name if found in an ipxnets file,
261  * or a string formatted with "%X" if not */
262 extern gchar *get_ipxnet_name(wmem_allocator_t *allocator, const guint32 addr);
263 
264 /* get_vlan_name returns the logical name if found in a vlans file,
265  * or the VLAN ID itself as a string if not found*/
266 extern gchar *get_vlan_name(wmem_allocator_t *allocator, const guint16 id);
267 
268 WS_DLL_PUBLIC guint get_hash_ether_status(hashether_t* ether);
269 WS_DLL_PUBLIC char* get_hash_ether_hexaddr(hashether_t* ether);
270 WS_DLL_PUBLIC char* get_hash_ether_resolved_name(hashether_t* ether);
271 
272 WS_DLL_PUBLIC char* get_hash_manuf_resolved_name(hashmanuf_t* manuf);
273 
274 
275 /* adds a hostname/IPv4 in the hash table */
276 WS_DLL_PUBLIC void add_ipv4_name(const guint addr, const gchar *name, const gboolean static_entry);
277 
278 /* adds a hostname/IPv6 in the hash table */
279 WS_DLL_PUBLIC void add_ipv6_name(const ws_in6_addr *addr, const gchar *name, const gboolean static_entry);
280 
290 WS_DLL_PUBLIC gboolean add_hosts_file (const char *hosts_file);
291 
292 /* adds a hostname in the hash table */
293 WS_DLL_PUBLIC gboolean add_ip_name_from_string (const char *addr, const char *name);
294 
295 /* Get the user defined name, for a given address */
296 WS_DLL_PUBLIC resolved_name_t* get_edited_resolved_name(const char* addr);
297 
298 
305 WS_DLL_PUBLIC addrinfo_lists_t *get_addrinfo_list(void);
306 
307 /* add ethernet address / name corresponding to IP address */
308 extern void add_ether_byip(const guint ip, const guint8 *eth);
309 
321 WS_DLL_PUBLIC
322 gboolean get_host_ipaddr(const char *host, guint32 *addrp);
323 
335 WS_DLL_PUBLIC
336 gboolean get_host_ipaddr6(const char *host, ws_in6_addr *addrp);
337 
338 WS_DLL_PUBLIC
339 wmem_map_t *get_manuf_hashtable(void);
340 
341 WS_DLL_PUBLIC
342 wmem_map_t *get_wka_hashtable(void);
343 
344 WS_DLL_PUBLIC
345 wmem_map_t *get_eth_hashtable(void);
346 
347 WS_DLL_PUBLIC
348 wmem_map_t *get_serv_port_hashtable(void);
349 
350 WS_DLL_PUBLIC
351 wmem_map_t *get_ipxnet_hash_table(void);
352 
353 WS_DLL_PUBLIC
354 wmem_map_t *get_vlan_hash_table(void);
355 
356 WS_DLL_PUBLIC
357 wmem_map_t *get_ipv4_hash_table(void);
358 
359 WS_DLL_PUBLIC
360 wmem_map_t *get_ipv6_hash_table(void);
361 
362 /*
363  * XXX - if we ever have per-session host name etc. information, we
364  * should probably have the "resolve synchronously or asynchronously"
365  * flag be per-session, set with an epan API.
366  */
367 WS_DLL_PUBLIC
368 void set_resolution_synchrony(gboolean synchronous);
369 
370 /*
371  * private functions (should only be called by epan directly)
372  */
373 
374 WS_DLL_LOCAL
375 void name_resolver_init(void);
376 
377 /* Reinitialize hostname resolution subsystem */
378 WS_DLL_LOCAL
379 void host_name_lookup_reset(void);
380 
381 WS_DLL_LOCAL
382 void addr_resolv_init(void);
383 
384 WS_DLL_LOCAL
385 void addr_resolv_cleanup(void);
386 
387 WS_DLL_PUBLIC
388 gboolean str_to_ip(const char *str, void *dst);
389 
390 WS_DLL_PUBLIC
391 gboolean str_to_ip6(const char *str, void *dst);
392 
393 WS_DLL_LOCAL
394 gboolean str_to_eth(const char *str, char *eth_bytes);
395 
396 WS_DLL_LOCAL
397 guint ipv6_oat_hash(gconstpointer key);
398 
399 WS_DLL_LOCAL
400 gboolean ipv6_equal(gconstpointer v1, gconstpointer v2);
401 
402 #ifdef __cplusplus
403 }
404 #endif /* __cplusplus */
405 
406 #endif /* __RESOLV_H__ */
WS_DLL_PUBLIC gboolean get_host_ipaddr(const char *host, guint32 *addrp)
Definition: addr_resolv.c:3623
WS_DLL_PUBLIC gboolean host_name_lookup_process(void)
Definition: addr_resolv.c:3025
WS_DLL_PUBLIC gboolean add_hosts_file(const char *hosts_file)
Definition: addr_resolv.c:2422
WS_DLL_PUBLIC gboolean get_host_ipaddr6(const char *host, ws_in6_addr *addrp)
Definition: addr_resolv.c:3685
WS_DLL_PUBLIC addrinfo_lists_t * get_addrinfo_list(void)
Definition: addr_resolv.c:2549
struct _e_addr_resolve e_addr_resolve
Flags to control name resolution.
Flags to control name resolution.
Definition: addr_resolv.h:48
gboolean network_name
Definition: addr_resolv.h:50
gboolean transport_name
Definition: addr_resolv.h:51
gboolean use_external_net_name_resolver
Definition: addr_resolv.h:53
gboolean ss7pc_name
Definition: addr_resolv.h:56
gboolean mac_name
Definition: addr_resolv.h:49
gboolean load_hosts_file_from_profile_only
Definition: addr_resolv.h:54
gboolean maxmind_geoip
Definition: addr_resolv.h:57
gboolean dns_pkt_addr_resolution
Definition: addr_resolv.h:52
gboolean vlan_name
Definition: addr_resolv.h:55
Definition: addr_resolv.h:80
Definition: wmem_allocator.h:27
Definition: wmem_map.c:44
Definition: wtap.h:1468
Definition: inet_ipv6.h:21
Definition: addr_resolv.c:168
Definition: addr_resolv.c:175
Definition: prefs-int.h:27
const char * name
Definition: prefs-int.h:28
Definition: addr_resolv.h:72
Definition: tvbuff-int.h:35