Wireshark  4.3.0
The Wireshark network protocol analyzer
/builds/wireshark/wireshark/extcap.h
Go to the documentation of this file.
1 
13 #ifndef __EXTCAP_H__
14 #define __EXTCAP_H__
15 
16 
17 #include <glib.h>
18 
19 #ifdef _WIN32
20 #include <wsutil/unicode-utils.h>
21 #endif
22 
23 #include <wsutil/plugins.h>
24 
26 #include <ui/capture_ui_utils.h>
27 
28 /* As boolean flags will be allowed any form of yes, true or any number != 0 (or starting with 0)
29  * The regex will be matched case-insensitive, so only the lower-case is defined here. */
30 #define EXTCAP_BOOLEAN_REGEX "^.*([yt1-9])"
31 
32 /* Prefix for the pipe interfaces */
33 #define EXTCAP_PIPE_PREFIX "wireshark_extcap"
34 #define EXTCAP_CONTROL_IN_PREFIX "wireshark_control_ext_to_ws"
35 #define EXTCAP_CONTROL_OUT_PREFIX "wireshark_control_ws_to_ext"
36 
37 #define EXTCAP_ARGUMENT_CONFIG "--extcap-config"
38 #define EXTCAP_ARGUMENT_RELOAD_OPTION "--extcap-reload-option"
39 #define EXTCAP_ARGUMENT_LIST_INTERFACES "--extcap-interfaces"
40 #define EXTCAP_ARGUMENT_INTERFACE "--extcap-interface"
41 #define EXTCAP_ARGUMENT_LIST_DLTS "--extcap-dlts"
42 #define EXTCAP_ARGUMENT_VERSION "--extcap-version"
43 
44 #define EXTCAP_ARGUMENT_RUN_CAPTURE "--capture"
45 #define EXTCAP_ARGUMENT_CAPTURE_FILTER "--extcap-capture-filter"
46 #define EXTCAP_ARGUMENT_RUN_PIPE "--fifo"
47 #define EXTCAP_ARGUMENT_CONTROL_IN "--extcap-control-in"
48 #define EXTCAP_ARGUMENT_CONTROL_OUT "--extcap-control-out"
49 
50 typedef struct _extcap_info {
51  gchar * basename;
52  gchar * full_path;
53  gchar * version;
54  gchar * help;
55 
56  GList * interfaces;
57 } extcap_info;
58 
59 typedef enum {
60  EXTCAP_FILTER_UNKNOWN,
61  EXTCAP_FILTER_VALID,
62  EXTCAP_FILTER_INVALID
63 } extcap_filter_status;
64 
65 struct _extcap_arg;
66 
67 #ifdef __cplusplus
68 extern "C" {
69 #endif /* __cplusplus */
70 
75 void
77 
86 extcap_get_if_dlts(const gchar * ifname, char ** err_str);
87 
94 GList *
95 append_extcap_interface_list(GList *list);
96 
103 extcap_info *
104 extcap_get_tool_info(const gchar * toolname);
105 
112 extcap_info *
113 extcap_get_tool_by_ifname(const gchar *ifname);
114 
121 gchar *
122 extcap_get_help_for_ifname(const char *ifname);
123 
127 void
129 
136 void
137 extcap_get_descriptions(plugin_description_callback callback, void *callback_data);
138 
143 void
144 extcap_dump_all(void);
145 
152 GList *
153 extcap_get_if_configuration(const char * ifname);
154 
162 GList *
163 extcap_get_if_configuration_values(const char * ifname, const char * argname, GHashTable * arguments);
164 
173 extcap_filter_status
174 extcap_verify_capture_filter(const char *ifname, const char *filter, gchar **err_str);
175 
182 void
183 extcap_free_if_configuration(GList *list, gboolean free_args);
184 
190 gboolean
191 extcap_has_configuration(const char * ifname);
192 
201 gboolean
202 extcap_requires_configuration(const char * ifname);
203 
210 gboolean
211 extcap_has_toolbar(const char *ifname);
212 
213 #ifdef HAVE_LIBPCAP
219 gboolean
220 extcap_session_stop(capture_session *cap_session);
221 
228 gboolean
229 extcap_init_interfaces(capture_session *cap_session);
230 #endif /* HAVE_LIBPCAP */
231 
237 void
239 
247 struct preference *
248 extcap_pref_for_argument(const gchar *ifname, struct _extcap_arg * arg);
249 
253 void extcap_cleanup(void);
254 
255 #ifdef __cplusplus
256 }
257 #endif /* __cplusplus */
258 
259 #endif
260 
261 /*
262  * Editor modelines - https://www.wireshark.org/tools/modelines.html
263  *
264  * Local variables:
265  * c-basic-offset: 4
266  * tab-width: 8
267  * indent-tabs-mode: nil
268  * End:
269  *
270  * vi: set shiftwidth=4 tabstop=8 expandtab:
271  * :indentSize=4:tabSize=8:noTabs=true:
272  */
extcap_info * extcap_get_tool_by_ifname(const gchar *ifname)
Definition: extcap.c:1866
GList * extcap_get_if_configuration(const char *ifname)
Definition: extcap.c:932
void extcap_request_stop(capture_session *cap_session)
void extcap_cleanup(void)
Definition: extcap.c:744
void extcap_register_preferences(void)
Definition: extcap.c:724
void extcap_free_if_configuration(GList *list, gboolean free_args)
Definition: extcap.c:786
gboolean extcap_requires_configuration(const char *ifname)
Definition: extcap.c:1092
if_capabilities_t * extcap_get_if_dlts(const gchar *ifname, char **err_str)
Definition: extcap.c:590
gchar * extcap_get_help_for_ifname(const char *ifname)
Definition: extcap.c:662
extcap_filter_status extcap_verify_capture_filter(const char *ifname, const char *filter, gchar **err_str)
Definition: extcap.c:1120
void extcap_clear_interfaces(void)
Definition: extcap.c:173
gboolean extcap_has_configuration(const char *ifname)
Definition: extcap.c:1086
extcap_info * extcap_get_tool_info(const gchar *toolname)
Definition: extcap.c:1881
gboolean extcap_has_toolbar(const char *ifname)
Definition: extcap.c:1145
struct preference * extcap_pref_for_argument(const gchar *ifname, struct _extcap_arg *arg)
Definition: extcap.c:809
void extcap_get_descriptions(plugin_description_callback callback, void *callback_data)
Definition: extcap.c:191
void extcap_dump_all(void)
Definition: extcap.c:230
GList * extcap_get_if_configuration_values(const char *ifname, const char *argname, GHashTable *arguments)
Definition: extcap.c:977
GList * append_extcap_interface_list(GList *list)
Definition: extcap.c:671
Definition: capture_session.h:137
Definition: extcap_parser.h:100
Definition: extcap.h:50
Definition: capture_ifinfo.h:102
Definition: prefs.c:200