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 */
45 /* Current state of capture engine. XXX - differentiate states */
47 CAPTURE_STOPPED, /**< stopped */
48 CAPTURE_PREPARING, /**< preparing, but still no response from capture child */
49 CAPTURE_RUNNING /**< capture child signalled ok, capture is running now */
52 #ifdef HAVE_PCAP_REMOTE
53 /* Type of capture source */
55 CAPTURE_IFLOCAL, /**< Local network interface */
56 CAPTURE_IFREMOTE /**< Remote network interface */
59 /* Type of RPCAPD Authentication */
61 CAPTURE_AUTH_NULL, /**< No authentication */
62 CAPTURE_AUTH_PWD /**< User/password authentication */
65 #ifdef HAVE_PCAP_SETSAMPLING
67 * Method of packet sampling (dropping some captured packets),
68 * may require additional integer parameter, marked here as N
71 CAPTURE_SAMP_NONE, /**< No sampling - capture all packets */
72 CAPTURE_SAMP_BY_COUNT, /**< Counter-based sampling -
73 capture 1 packet from every N */
74 CAPTURE_SAMP_BY_TIMER /**< Timer-based sampling -
75 capture no more than 1 packet
92 #ifdef HAVE_PCAP_REMOTE
93 struct remote_host_info {
94 gchar *remote_host; /**< Host name or network address for remote capturing */
95 gchar *remote_port; /**< TCP port of remote RPCAP server */
96 gint auth_type; /**< Authentication type */
97 gchar *auth_username; /**< Remote authentication parameters */
98 gchar *auth_password; /**< Remote authentication parameters */
100 gboolean nocap_rpcap;
101 gboolean nocap_local;
104 typedef struct remote_options_tag {
105 capture_source src_type;
106 struct remote_host_info remote_host_opts;
107 #ifdef HAVE_PCAP_SETSAMPLING
108 capture_sampling sampling_method;
112 #endif /* HAVE_PCAP_REMOTE */
114 typedef struct interface_tag {
117 gchar *friendly_name;
125 gboolean has_snaplen;
129 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
132 #ifdef HAVE_PCAP_CREATE
133 gboolean monitor_mode_enabled;
134 gboolean monitor_mode_supported;
136 #ifdef HAVE_PCAP_REMOTE
137 remote_options remote_opts;
139 guint32 last_packets;
146 typedef struct link_row_tag {
151 typedef struct interface_options_tag {
152 gchar *name; /* the name of the interface provided to winpcap/libpcap to specify the interface */
154 gchar *console_display_name; /* the name displayed in the console, also the basis for autonamed pcap filenames */
156 gboolean has_snaplen;
159 gboolean promisc_mode;
160 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
163 gboolean monitor_mode;
164 #ifdef HAVE_PCAP_REMOTE
165 capture_source src_type;
168 capture_auth auth_type;
169 gchar *auth_username;
170 gchar *auth_password;
172 gboolean nocap_rpcap;
173 gboolean nocap_local;
175 #ifdef HAVE_PCAP_SETSAMPLING
176 capture_sampling sampling_method;
181 /** Capture options coming from user interface */
182 typedef struct capture_options_tag {
184 void *cf; /**< handle to cfile (note: untyped handle) */
185 GArray *ifaces; /**< array of interfaces.
186 Currently only used by dumpcap. */
189 interface_options default_options;
190 gboolean saving_to_file; /**< TRUE if capture is writing to a file */
191 gchar *save_file; /**< the capture file name */
192 gboolean group_read_access; /**< TRUE is group read permission needs to be set */
193 gboolean use_pcapng; /**< TRUE if file format is pcapng */
196 gboolean real_time_mode; /**< Update list of packets in real time */
197 gboolean show_info; /**< show the info dialog */
198 gboolean quit_after_cap; /**< Makes a "capture only mode". Implies -k */
199 gboolean restart; /**< restart after closing is done */
201 /* multiple files (and ringbuffer) */
202 gboolean multi_files_on; /**< TRUE if ring buffer in use */
204 gboolean has_file_duration; /**< TRUE if ring duration specified */
205 gint32 file_duration; /**< Switch file after n seconds */
206 gboolean has_ring_num_files; /**< TRUE if ring num_files specified */
207 guint32 ring_num_files; /**< Number of multiple buffer files */
209 /* autostop conditions */
210 gboolean has_autostop_files; /**< TRUE if maximum number of capture files
212 gint32 autostop_files; /**< Maximum number of capture files */
214 gboolean has_autostop_packets; /**< TRUE if maximum packet count is
216 int autostop_packets; /**< Maximum packet count */
217 gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
219 gint32 autostop_filesize; /**< Maximum capture file size */
220 gboolean has_autostop_duration; /**< TRUE if maximum capture duration
222 gint32 autostop_duration; /**< Maximum capture duration */
224 /* internally used (don't touch from outside) */
225 int fork_child; /**< If not -1, in parent, process ID of child */
226 int fork_child_status; /**< Child exit status */
228 int signal_pipe_write_fd; /**< the pipe to signal the child */
230 capture_state state; /**< current state of the capture engine */
231 gboolean output_to_pipe; /**< save_file is a pipe (named or stdout) */
233 uid_t owner; /**< owner of the cfile */
234 gid_t group; /**< group of the cfile */
238 /* initialize the capture_options with some reasonable values */
240 capture_opts_init(capture_options *capture_opts, void *cf);
242 /* set a command line option value */
244 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
246 /* log content of capture_opts */
248 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
250 /* print interface capabilities, including link layer types */
252 capture_opts_print_if_capabilities(if_capabilities_t *caps, char *name,
253 gboolean monitor_mode);
255 /* print list of interfaces */
257 capture_opts_print_interfaces(GList *if_list);
259 /* trim the snaplen entry */
261 capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min);
263 /* trim the ring_num_files entry */
265 capture_opts_trim_ring_num_files(capture_options *capture_opts);
267 /* trim the interface entry */
269 capture_opts_trim_iface(capture_options *capture_opts, const char *capture_device);
272 collect_ifaces(capture_options *capture_opts);
274 /* Default capture buffer size in Mbytes. */
275 #define DEFAULT_CAPTURE_BUFFER_SIZE 2
279 #endif /* __cplusplus */
281 #endif /* capture_opts.h */