2 * Capture options (all parameters needed to do the actual capture)
4 * Wireshark - Network traffic analyzer
5 * By Gerald Combs <gerald@wireshark.org>
6 * Copyright 1998 Gerald Combs
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 * Capture options (all parameters needed to do the actual capture)
30 #ifndef __CAPTURE_OPTS_H__
31 #define __CAPTURE_OPTS_H__
33 #ifdef HAVE_SYS_TYPES_H
34 # include <sys/types.h> /* for gid_t */
37 #include <caputils/capture_ifinfo.h>
41 #endif /* __cplusplus */
45 * We do not currently have long options corresponding to all short
46 * options; we should probably pick appropriate option names for them.
48 * For long options with no corresponding short options, we define values
49 * outside the range of ASCII graphic characters, make that the last
50 * component of the entry for the long option, and have a case for that
51 * option in the switch statement.
54 * for tshark, we're using a leading - in the optstring to prevent getopt()
55 * from permuting the argv[] entries, in this case, unknown argv[] entries
56 * will be returned as parameters to a dummy-option 1.
57 * In short: we must not use 1 here, which is another reason to use
58 * values outside the range of ASCII graphic characters.
60 #define LONGOPT_NUM_CAP_COMMENT 128
63 * Non-capture long-only options should start here, to avoid collision
64 * with capture options.
66 #define MIN_NON_CAPTURE_LONGOPT 129
69 * Options for capturing common to all capturing programs.
71 #ifdef HAVE_PCAP_REMOTE
72 #define OPTSTRING_A "A:"
74 #define OPTSTRING_A ""
77 #ifdef CAN_SET_CAPTURE_BUFFER_SIZE
78 #define LONGOPT_BUFFER_SIZE \
79 {(char *)"buffer-size", required_argument, NULL, 'B'},
80 #define OPTSTRING_B "B:"
82 #define LONGOPT_BUFFER_SIZE
83 #define OPTSTRING_B ""
86 #ifdef HAVE_PCAP_CREATE
87 #define LONGOPT_MONITOR_MODE {(char *)"monitor-mode", no_argument, NULL, 'I'},
88 #define OPTSTRING_I "I"
90 #define LONGOPT_MONITOR_MODE
91 #define OPTSTRING_I ""
94 #define LONGOPT_CAPTURE_COMMON \
95 {(char *)"capture-comment", required_argument, NULL, LONGOPT_NUM_CAP_COMMENT}, \
96 {(char *)"autostop", required_argument, NULL, 'a'}, \
97 {(char *)"ring-buffer", required_argument, NULL, 'b'}, \
99 {(char *)"list-interfaces", no_argument, NULL, 'D'}, \
100 {(char *)"interface", required_argument, NULL, 'i'}, \
101 LONGOPT_MONITOR_MODE \
102 {(char *)"list-data-link-types", no_argument, NULL, 'L'}, \
103 {(char *)"no-promiscuous-mode", no_argument, NULL, 'p'}, \
104 {(char *)"snapshot-length", required_argument, NULL, 's'}, \
105 {(char *)"linktype", required_argument, NULL, 'y'},
107 #define OPTSTRING_CAPTURE_COMMON \
108 "a:" OPTSTRING_A "b:" OPTSTRING_B "c:Df:i:" OPTSTRING_I "Lps:y:"
110 #ifdef HAVE_PCAP_REMOTE
111 /* Type of capture source */
113 CAPTURE_IFLOCAL, /**< Local network interface */
114 CAPTURE_IFREMOTE /**< Remote network interface */
117 /* Type of RPCAPD Authentication */
119 CAPTURE_AUTH_NULL, /**< No authentication */
120 CAPTURE_AUTH_PWD /**< User/password authentication */
123 #ifdef HAVE_PCAP_SETSAMPLING
125 * Method of packet sampling (dropping some captured packets),
126 * may require additional integer parameter, marked here as N
129 CAPTURE_SAMP_NONE, /**< No sampling - capture all packets */
130 CAPTURE_SAMP_BY_COUNT, /**< Counter-based sampling -
131 capture 1 packet from every N */
132 CAPTURE_SAMP_BY_TIMER /**< Timer-based sampling -
133 capture no more than 1 packet
138 #ifdef HAVE_PCAP_REMOTE
139 struct remote_host_info {
140 gchar *remote_host; /**< Host name or network address for remote capturing */
141 gchar *remote_port; /**< TCP port of remote RPCAP server */
142 gint auth_type; /**< Authentication type */
143 gchar *auth_username; /**< Remote authentication parameters */
144 gchar *auth_password; /**< Remote authentication parameters */
146 gboolean nocap_rpcap;
147 gboolean nocap_local;
151 gchar *r_host; /**< Host name or network address for remote capturing */
152 gchar *remote_port; /**< TCP port of remote RPCAP server */
153 gint auth_type; /**< Authentication type */
154 gchar *auth_username; /**< Remote authentication parameters */
155 gchar *auth_password; /**< Remote authentication parameters */
158 typedef struct remote_options_tag {
159 capture_source src_type;
160 struct remote_host_info remote_host_opts;
161 #ifdef HAVE_PCAP_SETSAMPLING
162 capture_sampling sampling_method;
166 #endif /* HAVE_PCAP_REMOTE */
168 typedef struct interface_tag {
171 gchar *friendly_name;
179 gboolean has_snaplen;
182 #ifdef CAN_SET_CAPTURE_BUFFER_SIZE
185 #ifdef HAVE_PCAP_CREATE
186 gboolean monitor_mode_enabled;
187 gboolean monitor_mode_supported;
189 #ifdef HAVE_PCAP_REMOTE
190 remote_options remote_opts;
192 guint32 last_packets;
199 /* External capture cached data */
200 GHashTable *external_cap_args_settings;
204 typedef struct link_row_tag {
210 #define INVALID_EXTCAP_PID INVALID_HANDLE_VALUE
212 #define INVALID_EXTCAP_PID (GPid)-1
215 typedef struct interface_options_tag {
216 gchar *name; /* the name of the interface provided to winpcap/libpcap to specify the interface */
218 gchar *console_display_name; /* the name displayed in the console, also the basis for autonamed pcap filenames */
220 gboolean has_snaplen;
223 gboolean promisc_mode;
224 interface_type if_type;
228 GHashTable *extcap_args;
229 GPid extcap_pid; /* pid of running process or INVALID_EXTCAP_PID */
230 guint extcap_child_watch;
232 #ifdef CAN_SET_CAPTURE_BUFFER_SIZE
235 gboolean monitor_mode;
236 #ifdef HAVE_PCAP_REMOTE
237 capture_source src_type;
240 capture_auth auth_type;
241 gchar *auth_username;
242 gchar *auth_password;
244 gboolean nocap_rpcap;
245 gboolean nocap_local;
247 #ifdef HAVE_PCAP_SETSAMPLING
248 capture_sampling sampling_method;
253 /** Capture options coming from user interface */
254 typedef struct capture_options_tag {
256 GArray *ifaces; /**< the interfaces to use for the
257 next capture, entries are of
258 type interface_options */
259 GArray *all_ifaces; /**< all interfaces, entries are
260 of type interface_t */
261 int ifaces_err; /**< if all_ifaces is null, the error
262 when it was fetched, if any */
263 gchar *ifaces_err_info; /**< error string for that error */
267 * Options to be applied to all interfaces.
269 * Some of these can be set from the GUI, others can't; setting
270 * the link-layer header type, for example, doesn't necessarily
271 * make sense, as different interfaces may support different sets
272 * of link-layer header types.
274 * Some that can't be set from the GUI can be set from the command
275 * line, by specifying them before any interface is specified.
276 * This includes the link-layer header type, so if somebody asks
277 * for a link-layer header type that an interface on which they're
278 * capturing doesn't support, we should report an error and fail
281 * These can be overridden per-interface.
283 interface_options default_options;
285 gboolean saving_to_file; /**< TRUE if capture is writing to a file */
286 gchar *save_file; /**< the capture file name */
287 gboolean group_read_access; /**< TRUE is group read permission needs to be set */
288 gboolean use_pcapng; /**< TRUE if file format is pcapng */
291 gboolean real_time_mode; /**< Update list of packets in real time */
292 gboolean show_info; /**< show the info dialog */
293 gboolean quit_after_cap; /**< Makes a "capture only mode". Implies -k */
294 gboolean restart; /**< restart after closing is done */
295 gchar *orig_save_file; /**< the original capture file name (saved for a restart) */
297 /* multiple files (and ringbuffer) */
298 gboolean multi_files_on; /**< TRUE if ring buffer in use */
300 gboolean has_file_duration; /**< TRUE if ring duration specified */
301 gint32 file_duration; /**< Switch file after n seconds */
302 gboolean has_ring_num_files; /**< TRUE if ring num_files specified */
303 guint32 ring_num_files; /**< Number of multiple buffer files */
305 /* autostop conditions */
306 gboolean has_autostop_files; /**< TRUE if maximum number of capture files
308 gint32 autostop_files; /**< Maximum number of capture files */
310 gboolean has_autostop_packets; /**< TRUE if maximum packet count is
312 int autostop_packets; /**< Maximum packet count */
313 gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
315 guint32 autostop_filesize; /**< Maximum capture file size */
316 gboolean has_autostop_duration; /**< TRUE if maximum capture duration
318 gint32 autostop_duration; /**< Maximum capture duration */
320 gchar *capture_comment; /** capture comment to write to the
323 /* internally used (don't touch from outside) */
324 gboolean output_to_pipe; /**< save_file is a pipe (named or stdout) */
325 gboolean capture_child; /**< hidden option: Wireshark child mode */
328 /* initialize the capture_options with some reasonable values */
330 capture_opts_init(capture_options *capture_opts);
332 /* set a command line option value */
334 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
336 /* log content of capture_opts */
338 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
340 /* print interface capabilities, including link layer types */
342 capture_opts_print_if_capabilities(if_capabilities_t *caps, char *name,
343 gboolean monitor_mode);
345 /* print list of interfaces */
347 capture_opts_print_interfaces(GList *if_list);
349 /* trim the snaplen entry */
351 capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min);
353 /* trim the ring_num_files entry */
355 capture_opts_trim_ring_num_files(capture_options *capture_opts);
357 /* pick default interface if none was specified */
359 capture_opts_default_iface_if_necessary(capture_options *capture_opts,
360 const char *capture_device);
363 capture_opts_del_iface(capture_options *capture_opts, guint if_index);
366 collect_ifaces(capture_options *capture_opts);
368 /* Default capture buffer size in Mbytes. */
369 #define DEFAULT_CAPTURE_BUFFER_SIZE 2
373 #endif /* __cplusplus */
375 #endif /* capture_opts.h */
378 * Editor modelines - http://www.wireshark.org/tools/modelines.html
383 * indent-tabs-mode: nil
386 * vi: set shiftwidth=4 tabstop=8 expandtab:
387 * :indentSize=4:tabSize=8:noTabs=true: