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 #ifdef HAVE_EXTCAP
  39
  40 /* As boolean flags will be allowed any form of yes, true or any number != 0 (or starting with 0)
  41  * The regex will be matched case-insensitive, so only the lower-case is defined here. */
  42 #define EXTCAP_BOOLEAN_REGEX "^.*([yt1-9])"
  43
  44 /* Prefix for the pipe interfaces */
  45 #define EXTCAP_PIPE_PREFIX "wireshark_extcap"
  46
  47 #define EXTCAP_ARGUMENT_CONFIG                  "--extcap-config"
  48 #define EXTCAP_ARGUMENT_LIST_INTERFACES "--extcap-interfaces"
  49 #define EXTCAP_ARGUMENT_INTERFACE               "--extcap-interface"
  50 #define EXTCAP_ARGUMENT_LIST_DLTS               "--extcap-dlts"
  51
  52 #define EXTCAP_ARGUMENT_RUN_CAPTURE             "--capture"
  53 #define EXTCAP_ARGUMENT_CAPTURE_FILTER          "--extcap-capture-filter"
  54 #define EXTCAP_ARGUMENT_RUN_PIPE                "--fifo"
  55
  56 typedef struct _extcap_info {
  57     gchar * basename;
  58     gchar * full_path;
  59     gchar * version;
  60 } extcap_info;
  61
  62 #ifdef __cplusplus
  63 extern "C" {
  64 #endif /* __cplusplus */
  65
  66 /* Registers preferences for all interfaces */
  67 void
  68 extcap_register_preferences(void);
  69
  70 /* try to get if capabilities from extcap */
  71 if_capabilities_t *
  72 extcap_get_if_dlts(const gchar * ifname, char ** err_str);
  73
  74 /* append a list of all extcap capture interfaces to the specified list */
  75 GList *
  76 append_extcap_interface_list(GList *list, char **err_str);
  77
  78 /* get a list of all available extcap tools */
  79 GHashTable *
  80 extcap_tools_list(void);
  81
  82 /* returns the configuration for the given interface name, or an
  83  * empty list, if no configuration has been found */
  84 GList *
  85 extcap_get_if_configuration(const char * ifname);
  86
  87 gboolean
  88 extcap_has_configuration(const char * ifname, gboolean is_required);
  89
  90 /* converts an extcap setting to its equivalent preference key */
  91 gchar * extcap_settings_key(const gchar * ifname, const gchar * setting);
  92
  93 #ifdef WIN32
  94 HANDLE
  95 extcap_get_win32_handle();
  96 #endif
  97
  98 gboolean
  99 extcap_init_interfaces(capture_options * capture_opts);
 100
 101 gboolean
 102 extcap_create_pipe(char ** fifo);
 103
 104 void
 105 extcap_cleanup(capture_options * capture_opts _U_);
 106
 107 #ifdef __cplusplus
 108 }
 109 #endif /* __cplusplus */
 110
 111 #endif
 112
 113 #endif
 114
 115 /*
 116  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
 117  *
 118  * Local variables:
 119  * c-basic-offset: 4
 120  * tab-width: 8
 121  * indent-tabs-mode: nil
 122  * End:
 123  *
 124  * vi: set shiftwidth=4 tabstop=8 expandtab:
 125  * :indentSize=4:tabSize=8:noTabs=true:
 126  */