2 * Capture options (all parameters needed to do the actual capture)
6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
8 * Copyright 1998 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 * Capture options (all parameters needed to do the actual capture)
32 #ifndef __CAPTURE_OPTS_H__
33 #define __CAPTURE_OPTS_H__
35 #ifdef HAVE_SYS_TYPES_H
36 # include <sys/types.h> /* for gid_t */
39 #include "capture_ifinfo.h"
43 #endif /* __cplusplus */
46 for tshark, we're using a leading - in the optstring to prevent getopt()
47 from permuting the argv[] entries, in this case, unknown argv[] entries
48 will be returned as parameters to a dummy-option 1
49 in short: we must not use 1 here */
51 /* this does not clash with tshark's -2 option which returns '2' */
52 #define LONGOPT_NUM_CAP_COMMENT 2
55 #ifdef HAVE_PCAP_REMOTE
56 /* Type of capture source */
58 CAPTURE_IFLOCAL, /**< Local network interface */
59 CAPTURE_IFREMOTE /**< Remote network interface */
62 /* Type of RPCAPD Authentication */
64 CAPTURE_AUTH_NULL, /**< No authentication */
65 CAPTURE_AUTH_PWD /**< User/password authentication */
68 #ifdef HAVE_PCAP_SETSAMPLING
70 * Method of packet sampling (dropping some captured packets),
71 * may require additional integer parameter, marked here as N
74 CAPTURE_SAMP_NONE, /**< No sampling - capture all packets */
75 CAPTURE_SAMP_BY_COUNT, /**< Counter-based sampling -
76 capture 1 packet from every N */
77 CAPTURE_SAMP_BY_TIMER /**< Timer-based sampling -
78 capture no more than 1 packet
83 #ifdef HAVE_PCAP_REMOTE
84 struct remote_host_info {
85 gchar *remote_host; /**< Host name or network address for remote capturing */
86 gchar *remote_port; /**< TCP port of remote RPCAP server */
87 gint auth_type; /**< Authentication type */
88 gchar *auth_username; /**< Remote authentication parameters */
89 gchar *auth_password; /**< Remote authentication parameters */
95 typedef struct remote_options_tag {
96 capture_source src_type;
97 struct remote_host_info remote_host_opts;
98 #ifdef HAVE_PCAP_SETSAMPLING
99 capture_sampling sampling_method;
103 #endif /* HAVE_PCAP_REMOTE */
105 typedef struct interface_tag {
108 gchar *friendly_name;
116 gboolean has_snaplen;
119 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
122 #ifdef HAVE_PCAP_CREATE
123 gboolean monitor_mode_enabled;
124 gboolean monitor_mode_supported;
126 #ifdef HAVE_PCAP_REMOTE
127 remote_options remote_opts;
129 guint32 last_packets;
136 typedef struct link_row_tag {
141 typedef struct interface_options_tag {
142 gchar *name; /* the name of the interface provided to winpcap/libpcap to specify the interface */
144 gchar *console_display_name; /* the name displayed in the console, also the basis for autonamed pcap filenames */
146 gboolean has_snaplen;
149 gboolean promisc_mode;
150 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
153 gboolean monitor_mode;
154 #ifdef HAVE_PCAP_REMOTE
155 capture_source src_type;
158 capture_auth auth_type;
159 gchar *auth_username;
160 gchar *auth_password;
162 gboolean nocap_rpcap;
163 gboolean nocap_local;
165 #ifdef HAVE_PCAP_SETSAMPLING
166 capture_sampling sampling_method;
171 /** Capture options coming from user interface */
172 typedef struct capture_options_tag {
174 GArray *ifaces; /**< array of interfaces.
175 Currently only used by dumpcap. */
178 interface_options default_options;
179 gboolean saving_to_file; /**< TRUE if capture is writing to a file */
180 gchar *save_file; /**< the capture file name */
181 gboolean group_read_access; /**< TRUE is group read permission needs to be set */
182 gboolean use_pcapng; /**< TRUE if file format is pcapng */
185 gboolean real_time_mode; /**< Update list of packets in real time */
186 gboolean show_info; /**< show the info dialog */
187 gboolean quit_after_cap; /**< Makes a "capture only mode". Implies -k */
188 gboolean restart; /**< restart after closing is done */
189 gchar *orig_save_file; /**< the original capture file name (saved for a restart) */
191 /* multiple files (and ringbuffer) */
192 gboolean multi_files_on; /**< TRUE if ring buffer in use */
194 gboolean has_file_duration; /**< TRUE if ring duration specified */
195 gint32 file_duration; /**< Switch file after n seconds */
196 gboolean has_ring_num_files; /**< TRUE if ring num_files specified */
197 guint32 ring_num_files; /**< Number of multiple buffer files */
199 /* autostop conditions */
200 gboolean has_autostop_files; /**< TRUE if maximum number of capture files
202 gint32 autostop_files; /**< Maximum number of capture files */
204 gboolean has_autostop_packets; /**< TRUE if maximum packet count is
206 int autostop_packets; /**< Maximum packet count */
207 gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
209 guint32 autostop_filesize; /**< Maximum capture file size */
210 gboolean has_autostop_duration; /**< TRUE if maximum capture duration
212 gint32 autostop_duration; /**< Maximum capture duration */
214 gchar *capture_comment; /** capture comment to write to the
217 /* internally used (don't touch from outside) */
218 gboolean output_to_pipe; /**< save_file is a pipe (named or stdout) */
219 gboolean capture_child; /**< hidden option: Wireshark child mode */
222 /* initialize the capture_options with some reasonable values */
224 capture_opts_init(capture_options *capture_opts);
226 /* set a command line option value */
228 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
230 /* log content of capture_opts */
232 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
234 /* print interface capabilities, including link layer types */
236 capture_opts_print_if_capabilities(if_capabilities_t *caps, char *name,
237 gboolean monitor_mode);
239 /* print list of interfaces */
241 capture_opts_print_interfaces(GList *if_list);
243 /* trim the snaplen entry */
245 capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min);
247 /* trim the ring_num_files entry */
249 capture_opts_trim_ring_num_files(capture_options *capture_opts);
251 /* pick default interface if none was specified */
253 capture_opts_default_iface_if_necessary(capture_options *capture_opts,
254 const char *capture_device);
257 collect_ifaces(capture_options *capture_opts);
259 /* Default capture buffer size in Mbytes. */
260 #define DEFAULT_CAPTURE_BUFFER_SIZE 2
264 #endif /* __cplusplus */
266 #endif /* capture_opts.h */