[Diameter] Add a couple of command codes from IANA.
[metze/wireshark/wip.git] / extcap.h
1 /* extcap.h
2  * Definitions for extcap external capture
3  * Copyright 2013, Mike Ryan <mikeryan@lacklustre.net>
4  *
5  * Wireshark - Network traffic analyzer
6  * By Gerald Combs <gerald@wireshark.org>
7  * Copyright 1998 Gerald Combs
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22  */
23
24 #ifndef __EXTCAP_H__
25 #define __EXTCAP_H__
26
27 #include <config.h>
28
29 #include <glib.h>
30
31 #ifdef _WIN32
32 #include <windows.h>
33 #include <wsutil/unicode-utils.h>
34 #endif
35
36 #include <ui/capture_ui_utils.h>
37
38 /* As boolean flags will be allowed any form of yes, true or any number != 0 (or starting with 0)
39  * The regex will be matched case-insensitive, so only the lower-case is defined here. */
40 #define EXTCAP_BOOLEAN_REGEX "^.*([yt1-9])"
41
42 /* Prefix for the pipe interfaces */
43 #define EXTCAP_PIPE_PREFIX "wireshark_extcap"
44
45 #define EXTCAP_ARGUMENT_CONFIG                  "--extcap-config"
46 #define EXTCAP_ARGUMENT_LIST_INTERFACES         "--extcap-interfaces"
47 #define EXTCAP_ARGUMENT_INTERFACE               "--extcap-interface"
48 #define EXTCAP_ARGUMENT_LIST_DLTS               "--extcap-dlts"
49
50 #define EXTCAP_ARGUMENT_RUN_CAPTURE             "--capture"
51 #define EXTCAP_ARGUMENT_CAPTURE_FILTER          "--extcap-capture-filter"
52 #define EXTCAP_ARGUMENT_RUN_PIPE                "--fifo"
53 #define EXTCAP_ARGUMENT_CONTROL_IN              "--extcap-control-in"
54 #define EXTCAP_ARGUMENT_CONTROL_OUT             "--extcap-control-out"
55
56 typedef struct _extcap_info {
57     gchar * basename;
58     gchar * full_path;
59     gchar * version;
60     gchar * help;
61
62     GList * interfaces;
63 } extcap_info;
64
65 typedef enum {
66     EXTCAP_FILTER_UNKNOWN,
67     EXTCAP_FILTER_VALID,
68     EXTCAP_FILTER_INVALID
69 } extcap_filter_status;
70
71 struct _extcap_arg;
72
73 #ifdef __cplusplus
74 extern "C" {
75 #endif /* __cplusplus */
76
77 /* Count the number of extcap binaries */
78 guint
79 extcap_count(void);
80
81 /* Registers preferences for all interfaces */
82 void
83 extcap_register_preferences(void);
84
85 /* try to get if capabilities from extcap */
86 if_capabilities_t *
87 extcap_get_if_dlts(const gchar * ifname, char ** err_str);
88
89 /* append a list of all extcap capture interfaces to the specified list */
90 GList *
91 append_extcap_interface_list(GList *list, char **err_str);
92
93 extcap_info *
94 extcap_get_tool_info(const gchar * toolname);
95
96 extcap_info *
97 extcap_get_tool_by_ifname(const gchar *ifname);
98
99 /* return the help page or NULL for the given ifname */
100 gchar *
101 extcap_get_help_for_ifname(const char *ifname);
102
103 /* get a list of all available extcap executables and their interfaces */
104 GHashTable *
105 extcap_loaded_interfaces(void);
106
107 /* remove all loaded interfaces */
108 void
109 extcap_clear_interfaces(void);
110
111 /* returns the configuration for the given interface name, or an
112  * empty list, if no configuration has been found */
113 GList *
114 extcap_get_if_configuration(const char * ifname);
115
116 /**
117  * Check if the capture filter for the given interface name is valid.
118  * @param ifname Interface to check
119  * @param filter Capture filter to check
120  * @param err_str Error string returned if filter is invalid
121  * @return Filter check status.
122  */
123 extcap_filter_status
124 extcap_verify_capture_filter(const char *ifname, const char *filter, gchar **err_str);
125
126 /**
127  * Frees the memory from extcap_get_if_configuration.
128  * @param list The list returned by extcap_get_if_configuration.
129  * @param free_args TRUE if all arguments in the list must be freed too or FALSE
130  * if the ownership of the arguments is taken by the caller.
131  */
132 void
133 extcap_free_if_configuration(GList *list, gboolean free_args);
134
135 gboolean
136 extcap_has_configuration(const char * ifname, gboolean is_required);
137
138 gboolean
139 extcap_has_toolbar(const char *ifname);
140
141 #ifdef WIN32
142 HANDLE
143 extcap_get_win32_handle();
144 #endif
145
146 gboolean
147 extcap_init_interfaces(capture_options * capture_opts);
148
149 gboolean
150 extcap_create_pipe(char ** fifo);
151
152 /* Clean up all if related stuff */
153 void
154 extcap_if_cleanup(capture_options * capture_opts _U_, gchar ** errormsg);
155
156 struct preference *
157 extcap_pref_for_argument(const gchar *ifname, struct _extcap_arg * arg);
158
159 void
160 extcap_pref_store(struct _extcap_arg * arg, const char * newval);
161
162 /* Clean up global extcap stuff on program exit */
163 void extcap_cleanup(void);
164
165 #ifdef __cplusplus
166 }
167 #endif /* __cplusplus */
168
169 #endif
170
171 /*
172  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
173  *
174  * Local variables:
175  * c-basic-offset: 4
176  * tab-width: 8
177  * indent-tabs-mode: nil
178  * End:
179  *
180  * vi: set shiftwidth=4 tabstop=8 expandtab:
181  * :indentSize=4:tabSize=8:noTabs=true:
182  */