diff options
Diffstat (limited to 'capture/capture_ifinfo.h')
| -rw-r--r-- | capture/capture_ifinfo.h | 138 |
1 files changed, 138 insertions, 0 deletions
diff --git a/capture/capture_ifinfo.h b/capture/capture_ifinfo.h new file mode 100644 index 0000000000..5034ddb720 --- /dev/null +++ b/capture/capture_ifinfo.h @@ -0,0 +1,138 @@ +/* capture_ifinfo.h + * Definitions for routines to get information about capture interfaces + * + * Wireshark - Network traffic analyzer + * By Gerald Combs <gerald@wireshark.org> + * Copyright 1998 Gerald Combs + * + * SPDX-License-Identifier: GPL-2.0-or-later + */ + +#ifndef __CAPTURE_IFINFO_H__ +#define __CAPTURE_IFINFO_H__ + +#include <glib.h> + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +/* + * Explicitly set the interface_type enum values as these values are exposed + * in the preferences gui.interfaces_hidden_types string. + */ +typedef enum { + IF_WIRED = 0, + IF_AIRPCAP = 1, + IF_PIPE = 2, + IF_STDIN = 3, + IF_BLUETOOTH = 4, + IF_WIRELESS = 5, + IF_DIALUP = 6, + IF_USB = 7, + IF_EXTCAP = 8, + IF_VIRTUAL = 9 +} interface_type; + +/* + * The list of interfaces returned by "get_interface_list()" is + * a list of these structures. + */ +typedef struct { + char *name; /* e.g. "eth0" */ + char *friendly_name; /* from OS, e.g. "Local Area Connection", or + NULL if not available */ + char *vendor_description; + /* vendor description from pcap_findalldevs(), + e.g. "Realtek PCIe GBE Family Controller", + or NULL if not available */ + GSList *addrs; /* containing address values of if_addr_t */ + interface_type type; /* type of interface */ + gboolean loopback; /* TRUE if loopback, FALSE otherwise */ + char *extcap; /* extcap arguments, which present the data to call the extcap interface */ +} if_info_t; + +/* + * An address in the "addrs" list. + */ +typedef enum { + IF_AT_IPv4, + IF_AT_IPv6 +} if_address_type; + +typedef struct { + if_address_type ifat_type; + union { + guint32 ip4_addr; /* 4 byte IP V4 address, or */ + guint8 ip6_addr[16];/* 16 byte IP V6 address */ + } addr; +} if_addr_t; + +/** + * Fetch the interface list from a child process. + */ +extern GList *capture_interface_list(int *err, char **err_str, void (*update_cb)(void)); + +/* Error values from "get_interface_list()/capture_interface_list()". */ +#define CANT_GET_INTERFACE_LIST 1 /* error getting list */ +#define DONT_HAVE_PCAP 2 /* couldn't load WinPcap/Npcap */ + +void free_interface_list(GList *if_list); + +/** + * Get an if_info_t for a particular interface. + * (May require privilege, so should only be used by dumpcap.) + */ +extern if_info_t *if_info_get(const char *name); + +/** + * Free an if_info_t. + */ +void if_info_free(if_info_t *if_info); + +/* + * "get_if_capabilities()" and "capture_if_capabilities()" return a pointer + * to an allocated instance of this structure. "free_if_capabilities()" + * frees the returned instance. + */ +typedef struct { + gboolean can_set_rfmon; /* TRUE if can be put into monitor mode */ + GList *data_link_types; /* GList of data_link_info_t's */ + GList *timestamp_types; /* GList of timestamp_info_t's */ +} if_capabilities_t; + +/* + * Information about data link types. + */ +typedef struct { + int dlt; /* e.g. DLT_EN10MB (which is 1) */ + char *name; /* e.g. "EN10MB" or "DLT 1" */ + char *description; /* descriptive name from wiretap e.g. "Ethernet", NULL if unknown */ +} data_link_info_t; + +/* + * Information about timestamp types. + */ +typedef struct { + char *name; /* e.g. "adapter_unsynced" */ + char *description; /* description from libpcap e.g. "Adapter, not synced with system time" */ +} timestamp_info_t; + +/** + * Fetch the linktype list for the specified interface from a child process. + */ +extern if_capabilities_t * +capture_get_if_capabilities(const gchar *devname, gboolean monitor_mode, + const gchar *auth_string, + char **err_primary_msg, char **err_secondary_msg, + void (*update_cb)(void)); + +void free_if_capabilities(if_capabilities_t *caps); + +void add_interface_to_remote_list(if_info_t *if_info); + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#endif /* __CAPTURE_IFINFO_H__ */ |