/builds/wireshark/wireshark/extcap.h

Go to the documentation of this file.

 
#ifndef __EXTCAP_H__
#define __EXTCAP_H__
 
 
#include <glib.h>
 
#ifdef _WIN32
#include <wsutil/unicode-utils.h>
#endif
 
#include <wsutil/plugins.h>
#include "epan/register.h"
 
#include "capture/capture_session.h"
#include <ui/capture_ui_utils.h>
 
/* As boolean flags will be allowed any form of yes, true or any number != 0 (or starting with 0)
 * The regex will be matched case-insensitive, so only the lower-case is defined here. */
#define EXTCAP_BOOLEAN_REGEX "^.*([yt1-9])"
 
/* Prefix for the pipe interfaces */
#define EXTCAP_PIPE_PREFIX "wireshark_extcap"
#define EXTCAP_CONTROL_IN_PREFIX  "wireshark_control_ext_to_ws"
#define EXTCAP_CONTROL_OUT_PREFIX "wireshark_control_ws_to_ext"
 
#define EXTCAP_CONTROL_NONE 0
#define EXTCAP_CONTROL_TOOLBAR 1
#define EXTCAP_CONTROL_QUIT 2
 
#define EXTCAP_ARGUMENT_CONFIG                  "--extcap-config"
#define EXTCAP_ARGUMENT_CONFIG_OPTION_NAME      "--extcap-config-option-name"
#define EXTCAP_ARGUMENT_CONFIG_OPTION_VALUE     "--extcap-config-option-value"
#define EXTCAP_ARGUMENT_RELOAD_OPTION           "--extcap-reload-option"
#define EXTCAP_ARGUMENT_LIST_INTERFACES         "--extcap-interfaces"
#define EXTCAP_ARGUMENT_INTERFACE               "--extcap-interface"
#define EXTCAP_ARGUMENT_LIST_DLTS               "--extcap-dlts"
#define EXTCAP_ARGUMENT_VERSION                 "--extcap-version"
 
#define EXTCAP_ARGUMENT_RUN_CAPTURE             "--capture"
#define EXTCAP_ARGUMENT_CAPTURE_FILTER          "--extcap-capture-filter"
#define EXTCAP_ARGUMENT_RUN_PIPE                "--fifo"
#define EXTCAP_ARGUMENT_CLEANUP_POSTKILL        "--extcap-cleanup-postkill"
#define EXTCAP_ARGUMENT_CONTROL_IN              "--extcap-control-in"
#define EXTCAP_ARGUMENT_CONTROL_OUT             "--extcap-control-out"

typedef struct _extcap_info {
    char  *basename;    
    char  *full_path;   
    char  *version;     
    char  *help;        
    unsigned control;   
    GList *interfaces;  
} extcap_info;

typedef enum {
    EXTCAP_FILTER_UNKNOWN, 
    EXTCAP_FILTER_VALID,   
    EXTCAP_FILTER_INVALID  
} extcap_filter_status;

typedef enum {
    EXTCAP_ARGUMENT_SUFFICIENT_NOTSET,   
    EXTCAP_ARGUMENT_SUFFICIENT_REQUIRED, 
    EXTCAP_ARGUMENT_SUFFICIENT_OK        
} extcap_argument_sufficient;
 
typedef void (*extcap_plugin_description_callback)(const char *, const char *,
                                                  const char *, const char *,
                                                  void *);
 
struct _extcap_arg;
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

void
extcap_register_preferences(register_cb cb, void *client_data);

void
extcap_read_preferences(void);

void
extcap_write_preferences(void);

char *
extcap_get_bookmark_name(const char *ifname);

char *
extcap_set_bookmark(const char *ifname, const char *bookmark_name);

if_capabilities_t *
extcap_get_if_dlts(const char * ifname, char ** err_str);

GList *
extcap_get_if_list_dlts(GList *queries, GHashTable *caps_hash);

GList *
append_extcap_interface_list(GList *list);

extcap_info *
extcap_get_tool_info(const char * toolname);

extcap_info *
extcap_get_tool_by_ifname(const char *ifname);

char *
extcap_get_help_for_ifname(const char *ifname);

void
extcap_clear_interfaces(void);

void
extcap_get_descriptions(extcap_plugin_description_callback callback, void *callback_data);

void
extcap_dump_all(void);

GList *
extcap_get_if_configuration(const char * ifname);

GList*
extcap_get_if_configuration_option(const char* ifname, const char* argname, const char* argvalue);

GList *
extcap_get_if_configuration_values(const char * ifname, const char * argname, GHashTable * arguments);

extcap_filter_status
extcap_verify_capture_filter(const char *ifname, const char *filter, char **err_str);

void
extcap_free_if_configuration(GList *list, bool free_args);

bool
extcap_has_configuration(const char * ifname);

bool
extcap_requires_configuration(const char * ifname);

bool
extcap_has_toolbar(const char *ifname);
 
#ifdef HAVE_LIBPCAP
bool
extcap_session_stop(capture_session *cap_session);

bool
extcap_init_interfaces(capture_session *cap_session);
#endif /* HAVE_LIBPCAP */

void
extcap_request_stop(capture_session *cap_session);

pref_t *
extcap_pref_for_argument(const char *ifname, struct _extcap_arg * arg);

void extcap_cleanup(void);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif
 
/*
 * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 *
 * Local variables:
 * c-basic-offset: 4
 * tab-width: 8
 * indent-tabs-mode: nil
 * End:
 *
 * vi: set shiftwidth=4 tabstop=8 expandtab:
 * :indentSize=4:tabSize=8:noTabs=true:
 */