/* capture_opts.h
* Capture options (all parameters needed to do the actual capture)
*
- * $Id$
- *
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef __CAPTURE_OPTS_H__
#define __CAPTURE_OPTS_H__
-#ifdef HAVE_SYS_TYPES_H
-# include <sys/types.h> /* for gid_t */
-#endif
+#include <sys/types.h> /* for gid_t */
-#include "capture_ifinfo.h"
+#include <caputils/capture_ifinfo.h>
+
+#ifdef _WIN32
+#include <windows.h>
+#endif
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
-/* Current state of capture engine. XXX - differentiate states */
-typedef enum {
- CAPTURE_STOPPED, /**< stopped */
- CAPTURE_PREPARING, /**< preparing, but still no response from capture child */
- CAPTURE_RUNNING /**< capture child signalled ok, capture is running now */
-} capture_state;
+/*
+ * Long options.
+ * We do not currently have long options corresponding to all short
+ * options; we should probably pick appropriate option names for them.
+ *
+ * For long options with no corresponding short options, we define values
+ * outside the range of ASCII graphic characters, make that the last
+ * component of the entry for the long option, and have a case for that
+ * option in the switch statement.
+ *
+ * We also pick values < 4096, so as to leave values >= 4096 for
+ * other long options.
+ *
+ * NOTE:
+ * for tshark, we're using a leading - in the optstring to prevent getopt()
+ * from permuting the argv[] entries, in this case, unknown argv[] entries
+ * will be returned as parameters to a dummy-option 1.
+ * In short: we must not use 1 here, which is another reason to use
+ * values outside the range of ASCII graphic characters.
+ */
+#define LONGOPT_NUM_CAP_COMMENT 128
+#define LONGOPT_LIST_TSTAMP_TYPES 129
+#define LONGOPT_SET_TSTAMP_TYPE 130
+
+/*
+ * Options for capturing common to all capturing programs.
+ */
+#ifdef HAVE_PCAP_REMOTE
+#define OPTSTRING_A "A:"
+#else
+#define OPTSTRING_A ""
+#endif
+
+#ifdef CAN_SET_CAPTURE_BUFFER_SIZE
+#define LONGOPT_BUFFER_SIZE \
+ {"buffer-size", required_argument, NULL, 'B'},
+#define OPTSTRING_B "B:"
+#else
+#define LONGOPT_BUFFER_SIZE
+#define OPTSTRING_B ""
+#endif
+
+#ifdef HAVE_PCAP_CREATE
+#define LONGOPT_MONITOR_MODE {"monitor-mode", no_argument, NULL, 'I'},
+#define OPTSTRING_I "I"
+#else
+#define LONGOPT_MONITOR_MODE
+#define OPTSTRING_I ""
+#endif
+
+#define LONGOPT_CAPTURE_COMMON \
+ {"capture-comment", required_argument, NULL, LONGOPT_NUM_CAP_COMMENT}, \
+ {"autostop", required_argument, NULL, 'a'}, \
+ {"ring-buffer", required_argument, NULL, 'b'}, \
+ LONGOPT_BUFFER_SIZE \
+ {"list-interfaces", no_argument, NULL, 'D'}, \
+ {"interface", required_argument, NULL, 'i'}, \
+ LONGOPT_MONITOR_MODE \
+ {"list-data-link-types", no_argument, NULL, 'L'}, \
+ {"no-promiscuous-mode", no_argument, NULL, 'p'}, \
+ {"snapshot-length", required_argument, NULL, 's'}, \
+ {"linktype", required_argument, NULL, 'y'}, \
+ {"list-time-stamp-types", no_argument, NULL, LONGOPT_LIST_TSTAMP_TYPES}, \
+ {"time-stamp-type", required_argument, NULL, LONGOPT_SET_TSTAMP_TYPE},
+
+
+#define OPTSTRING_CAPTURE_COMMON \
+ "a:" OPTSTRING_A "b:" OPTSTRING_B "c:Df:i:" OPTSTRING_I "Lps:y:"
#ifdef HAVE_PCAP_REMOTE
/* Type of capture source */
} capture_sampling;
#endif
-typedef enum {
- IF_WIRED,
- IF_AIRPCAP,
- IF_PIPE,
- IF_STDIN,
- IF_BLUETOOTH,
- IF_WIRELESS,
- IF_DIALUP,
- IF_USB,
- IF_VIRTUAL
-} interface_type;
-
#ifdef HAVE_PCAP_REMOTE
struct remote_host_info {
- gchar *remote_host; /**< Host name or network address for remote capturing */
- gchar *remote_port; /**< TCP port of remote RPCAP server */
- gint auth_type; /**< Authentication type */
- gchar *auth_username; /**< Remote authentication parameters */
- gchar *auth_password; /**< Remote authentication parameters */
- gboolean datatx_udp;
- gboolean nocap_rpcap;
- gboolean nocap_local;
+ gchar *remote_host; /**< Host name or network address for remote capturing */
+ gchar *remote_port; /**< TCP port of remote RPCAP server */
+ capture_auth auth_type; /**< Authentication type */
+ gchar *auth_username; /**< Remote authentication parameters */
+ gchar *auth_password; /**< Remote authentication parameters */
+ gboolean datatx_udp;
+ gboolean nocap_rpcap;
+ gboolean nocap_local;
+};
+
+struct remote_host {
+ gchar *r_host; /**< Host name or network address for remote capturing */
+ gchar *remote_port; /**< TCP port of remote RPCAP server */
+ capture_auth auth_type; /**< Authentication type */
+ gchar *auth_username; /**< Remote authentication parameters */
+ gchar *auth_password; /**< Remote authentication parameters */
};
typedef struct remote_options_tag {
#endif /* HAVE_PCAP_REMOTE */
typedef struct interface_tag {
- gchar *name;
- gchar *display_name;
- guint type;
- gchar *addresses;
- gint no_addresses;
- gchar *cfilter;
- GList *links;
- gint active_dlt;
- gboolean pmode;
- gboolean has_snaplen;
- guint snaplen;
- gboolean local;
-#if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
- gint buffer;
- gboolean monitor_mode_enabled;
- gboolean monitor_mode_supported;
+ gchar *name;
+ gchar *display_name;
+ gchar *friendly_name;
+ guint type;
+ gchar *addresses;
+ gint no_addresses;
+ gchar *cfilter;
+ GList *links;
+ gint active_dlt;
+ gboolean pmode;
+ gboolean has_snaplen;
+ int snaplen;
+ gboolean local;
+#ifdef CAN_SET_CAPTURE_BUFFER_SIZE
+ gint buffer;
+#endif
+#ifdef HAVE_PCAP_CREATE
+ gboolean monitor_mode_enabled;
+ gboolean monitor_mode_supported;
#endif
#ifdef HAVE_PCAP_REMOTE
- remote_options remote_opts;
+ remote_options remote_opts;
#endif
- guint32 last_packets;
- if_info_t if_info;
- gboolean selected;
- gboolean hidden;
- gboolean locked;
+ guint32 last_packets;
+ guint32 packet_diff;
+ if_info_t if_info;
+ gboolean selected;
+ gboolean hidden;
+ /* External capture cached data */
+ GHashTable *external_cap_args_settings;
+ gchar *timestamp_type;
} interface_t;
typedef struct link_row_tag {
} link_row;
typedef struct interface_options_tag {
- gchar *name;
- gchar *descr;
- gchar *cfilter;
- gboolean has_snaplen;
- int snaplen;
- int linktype;
- gboolean promisc_mode;
-#if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
- int buffer_size;
+ gchar *name; /* the name of the interface supplied to libpcap/WinPcap/Npcap to specify the interface */
+ gchar *descr; /* a more user-friendly description of the interface; may be NULL if none */
+ gchar *display_name; /* the name displayed in the console and title bar */
+ gchar *cfilter;
+ gboolean has_snaplen;
+ int snaplen;
+ int linktype;
+ gboolean promisc_mode;
+ interface_type if_type;
+ gchar *extcap;
+ gchar *extcap_fifo;
+ GHashTable *extcap_args;
+ GPid extcap_pid; /* pid of running process or WS_INVALID_PID */
+ gpointer extcap_pipedata;
+ guint extcap_child_watch;
+#ifdef _WIN32
+ HANDLE extcap_pipe_h;
+ HANDLE extcap_control_in_h;
+ HANDLE extcap_control_out_h;
#endif
- gboolean monitor_mode;
+ gchar *extcap_control_in;
+ gchar *extcap_control_out;
+#ifdef CAN_SET_CAPTURE_BUFFER_SIZE
+ int buffer_size;
+#endif
+ gboolean monitor_mode;
#ifdef HAVE_PCAP_REMOTE
- capture_source src_type;
- gchar *remote_host;
- gchar *remote_port;
- capture_auth auth_type;
- gchar *auth_username;
- gchar *auth_password;
- gboolean datatx_udp;
- gboolean nocap_rpcap;
- gboolean nocap_local;
+ capture_source src_type;
+ gchar *remote_host;
+ gchar *remote_port;
+ capture_auth auth_type;
+ gchar *auth_username;
+ gchar *auth_password;
+ gboolean datatx_udp;
+ gboolean nocap_rpcap;
+ gboolean nocap_local;
#endif
#ifdef HAVE_PCAP_SETSAMPLING
- capture_sampling sampling_method;
- int sampling_param;
+ capture_sampling sampling_method;
+ int sampling_param;
#endif
+ gchar *timestamp_type; /* requested timestamp as string */
+ int timestamp_type_id; /* Timestamp type to pass to pcap_set_tstamp_type.
+ only valid if timestamp_type != NULL */
} interface_options;
/** Capture options coming from user interface */
typedef struct capture_options_tag {
/* general */
- void *cf; /**< handle to cfile (note: untyped handle) */
- GArray *ifaces; /**< array of interfaces.
- Currently only used by dumpcap. */
- GArray *all_ifaces;
- guint num_selected;
- interface_options default_options;
- gboolean saving_to_file; /**< TRUE if capture is writing to a file */
- gchar *save_file; /**< the capture file name */
- gboolean group_read_access; /**< TRUE is group read permission needs to be set */
- gboolean use_pcapng; /**< TRUE if file format is pcapng */
+ GArray *ifaces; /**< the interfaces to use for the
+ next capture, entries are of
+ type interface_options */
+ GArray *all_ifaces; /**< all interfaces, entries are
+ of type interface_t */
+ int ifaces_err; /**< if all_ifaces is null, the error
+ when it was fetched, if any */
+ gchar *ifaces_err_info; /**< error string for that error */
+ guint num_selected;
+
+ /*
+ * Options to be applied to all interfaces.
+ *
+ * Some of these can be set from the GUI, others can't; setting
+ * the link-layer header type, for example, doesn't necessarily
+ * make sense, as different interfaces may support different sets
+ * of link-layer header types.
+ *
+ * Some that can't be set from the GUI can be set from the command
+ * line, by specifying them before any interface is specified.
+ * This includes the link-layer header type, so if somebody asks
+ * for a link-layer header type that an interface on which they're
+ * capturing doesn't support, we should report an error and fail
+ * to capture.
+ *
+ * These can be overridden per-interface.
+ */
+ interface_options default_options;
+
+ gboolean saving_to_file; /**< TRUE if capture is writing to a file */
+ gchar *save_file; /**< the capture file name */
+ gboolean group_read_access; /**< TRUE is group read permission needs to be set */
+ gboolean use_pcapng; /**< TRUE if file format is pcapng */
/* GUI related */
- gboolean real_time_mode; /**< Update list of packets in real time */
- gboolean show_info; /**< show the info dialog */
- gboolean quit_after_cap; /**< Makes a "capture only mode". Implies -k */
- gboolean restart; /**< restart after closing is done */
+ gboolean real_time_mode; /**< Update list of packets in real time */
+ gboolean show_info; /**< show the info dialog. */
+ gboolean restart; /**< restart after closing is done */
+ gchar *orig_save_file; /**< the original capture file name (saved for a restart) */
/* multiple files (and ringbuffer) */
- gboolean multi_files_on; /**< TRUE if ring buffer in use */
+ gboolean multi_files_on; /**< TRUE if ring buffer in use */
- gboolean has_file_duration; /**< TRUE if ring duration specified */
- gint32 file_duration; /**< Switch file after n seconds */
- gboolean has_ring_num_files; /**< TRUE if ring num_files specified */
- guint32 ring_num_files; /**< Number of multiple buffer files */
+ gboolean has_file_duration; /**< TRUE if ring duration specified */
+ gint32 file_duration; /**< Switch file after n seconds */
+ gboolean has_file_interval; /**< TRUE if ring interval specified */
+ gint32 file_interval; /**< Create time intervals of n seconds */
+ gboolean has_ring_num_files; /**< TRUE if ring num_files specified */
+ guint32 ring_num_files; /**< Number of multiple buffer files */
/* autostop conditions */
- gboolean has_autostop_files; /**< TRUE if maximum number of capture files
- are specified */
- gint32 autostop_files; /**< Maximum number of capture files */
-
- gboolean has_autostop_packets; /**< TRUE if maximum packet count is
- specified */
- int autostop_packets; /**< Maximum packet count */
- gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
- is specified */
- gint32 autostop_filesize; /**< Maximum capture file size */
- gboolean has_autostop_duration; /**< TRUE if maximum capture duration
- is specified */
- gint32 autostop_duration; /**< Maximum capture duration */
+ gboolean has_autostop_files; /**< TRUE if maximum number of capture files
+ are specified */
+ gint32 autostop_files; /**< Maximum number of capture files */
+
+ gboolean has_autostop_packets; /**< TRUE if maximum packet count is
+ specified */
+ int autostop_packets; /**< Maximum packet count */
+ gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
+ is specified */
+ guint32 autostop_filesize; /**< Maximum capture file size */
+ gboolean has_autostop_duration; /**< TRUE if maximum capture duration
+ is specified */
+ gint32 autostop_duration; /**< Maximum capture duration */
+
+ gchar *capture_comment; /** capture comment to write to the
+ output file */
/* internally used (don't touch from outside) */
- int fork_child; /**< If not -1, in parent, process ID of child */
- int fork_child_status; /**< Child exit status */
-#ifdef _WIN32
- int signal_pipe_write_fd; /**< the pipe to signal the child */
-#endif
- capture_state state; /**< current state of the capture engine */
- gboolean output_to_pipe; /**< save_file is a pipe (named or stdout) */
-#ifndef _WIN32
- uid_t owner; /**< owner of the cfile */
- gid_t group; /**< group of the cfile */
-#endif
+ gboolean output_to_pipe; /**< save_file is a pipe (named or stdout) */
+ gboolean capture_child; /**< hidden option: Wireshark child mode */
} capture_options;
/* initialize the capture_options with some reasonable values */
extern void
-capture_opts_init(capture_options *capture_opts, void *cf);
+capture_opts_init(capture_options *capture_opts);
+
+/* clean internal structures */
+extern void
+capture_opts_cleanup(capture_options *capture_opts);
/* set a command line option value */
extern int
capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
-extern int
-capture_opts_add_iface_opt(capture_options *capture_opts, const char *optarg_str_p);
-
/* log content of capture_opts */
extern void
capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
+enum caps_query {
+ CAPS_MONITOR_MODE = 0x1,
+ CAPS_QUERY_LINK_TYPES = 0x2,
+ CAPS_QUERY_TIMESTAMP_TYPES = 0x4
+};
+
/* print interface capabilities, including link layer types */
extern void
-capture_opts_print_if_capabilities(if_capabilities_t *caps, char *name,
- gboolean monitor_mode);
+capture_opts_print_if_capabilities(if_capabilities_t *caps, char *name, int queries);
/* print list of interfaces */
extern void
extern void
capture_opts_trim_ring_num_files(capture_options *capture_opts);
-/* trim the interface entry */
-extern gboolean
-capture_opts_trim_iface(capture_options *capture_opts, const char *capture_device);
+/* pick default interface if none was specified */
+extern int
+capture_opts_default_iface_if_necessary(capture_options *capture_opts,
+ const char *capture_device);
extern void
-collect_ifaces(capture_options *capture_opts);
+capture_opts_del_iface(capture_options *capture_opts, guint if_index);
-typedef struct {
- gboolean monitor_mode;
- int linktype;
-} cap_settings_t;
+extern void
+collect_ifaces(capture_options *capture_opts);
-/** Get capture settings for interface
- *
- * @param if_name interface name
- */
-cap_settings_t
-capture_get_cap_settings (gchar *if_name);
+extern void
+capture_opts_free_interface_t(interface_t *device);
-extern void
-scan_local_interfaces(capture_options* capture_opts, int *error);
+/* Default capture buffer size in Mbytes. */
+#define DEFAULT_CAPTURE_BUFFER_SIZE 2
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* capture_opts.h */
+
+/*
+ * Editor modelines - http://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:
+ */
git.samba.org / metze / wireshark / wip.git / blobdiff