capture_opts.h

   1 /* capture_opts.h
   2  * Capture options (all parameters needed to do the actual capture)
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  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.
  14  *
  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.
  19  *
  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.
  23  */
  24
  25
  26 /** @file
  27  *
  28  *  Capture options (all parameters needed to do the actual capture)
  29  *
  30  */
  31
  32 #ifndef __CAPTURE_OPTS_H__
  33 #define __CAPTURE_OPTS_H__
  34
  35 #ifdef HAVE_SYS_TYPES_H
  36 # include <sys/types.h>     /* for gid_t */
  37 #endif
  38
  39 #include "capture_ifinfo.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif /* __cplusplus */
  44
  45 /* Current state of capture engine. XXX - differentiate states */
  46 typedef enum {
  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 */
  50 } capture_state;
  51
  52 #ifdef HAVE_PCAP_REMOTE
  53 /* Type of capture source */
  54 typedef enum {
  55     CAPTURE_IFLOCAL,        /**< Local network interface */
  56     CAPTURE_IFREMOTE        /**< Remote network interface */
  57 } capture_source;
  58
  59 /* Type of RPCAPD Authentication */
  60 typedef enum {
  61     CAPTURE_AUTH_NULL,      /**< No authentication */
  62     CAPTURE_AUTH_PWD        /**< User/password authentication */
  63 } capture_auth;
  64 #endif
  65 #ifdef HAVE_PCAP_SETSAMPLING
  66 /**
  67  * Method of packet sampling (dropping some captured packets),
  68  * may require additional integer parameter, marked here as N
  69  */
  70 typedef enum {
  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
  76                                  in N milliseconds */
  77 } capture_sampling;
  78 #endif
  79
  80 #ifdef HAVE_PCAP_REMOTE
  81 struct remote_host_info {
  82     gchar *remote_host;          /**< Host name or network address for remote capturing */
  83     gchar *remote_port;          /**< TCP port of remote RPCAP server */
  84     gint auth_type;              /**< Authentication type */
  85     gchar *auth_username;        /**< Remote authentication parameters */
  86     gchar *auth_password;        /**< Remote authentication parameters */
  87     gboolean datatx_udp;
  88     gboolean nocap_rpcap;
  89     gboolean nocap_local;
  90 };
  91
  92 typedef struct remote_options_tag {
  93     capture_source src_type;
  94     struct remote_host_info remote_host_opts;
  95 #ifdef HAVE_PCAP_SETSAMPLING
  96     capture_sampling sampling_method;
  97     int sampling_param;
  98 #endif
  99 } remote_options;
 100 #endif /* HAVE_PCAP_REMOTE */
 101
 102 typedef struct interface_tag {
 103     gchar *name;
 104     gchar *display_name;
 105     gchar *friendly_name;
 106     guint type;
 107     gchar *addresses;
 108     gint no_addresses;
 109     gchar *cfilter;
 110     GList *links;
 111     gint active_dlt;
 112     gboolean pmode;
 113     gboolean has_snaplen;
 114     guint snaplen;
 115     gboolean local;
 116 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
 117     gint buffer;
 118 #endif
 119 #ifdef HAVE_PCAP_CREATE
 120     gboolean monitor_mode_enabled;
 121     gboolean monitor_mode_supported;
 122 #endif
 123 #ifdef HAVE_PCAP_REMOTE
 124     remote_options remote_opts;
 125 #endif
 126     guint32     last_packets;
 127     if_info_t   if_info;
 128     gboolean    selected;
 129     gboolean    hidden;
 130     gboolean    locked;
 131 } interface_t;
 132
 133 typedef struct link_row_tag {
 134     gchar *name;
 135     gint dlt;
 136 } link_row;
 137
 138 typedef struct interface_options_tag {
 139     gchar *name; /* the name of the interface provided to winpcap/libpcap to specify the interface */
 140     gchar *descr;
 141     gchar *console_display_name; /* the name displayed in the console, also the basis for autonamed pcap filenames */
 142     gchar *cfilter;
 143     gboolean has_snaplen;
 144     int snaplen;
 145     int linktype;
 146     gboolean promisc_mode;
 147 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
 148     int buffer_size;
 149 #endif
 150     gboolean monitor_mode;
 151 #ifdef HAVE_PCAP_REMOTE
 152     capture_source src_type;
 153     gchar *remote_host;
 154     gchar *remote_port;
 155     capture_auth auth_type;
 156     gchar *auth_username;
 157     gchar *auth_password;
 158     gboolean datatx_udp;
 159     gboolean nocap_rpcap;
 160     gboolean nocap_local;
 161 #endif
 162 #ifdef HAVE_PCAP_SETSAMPLING
 163     capture_sampling sampling_method;
 164     int sampling_param;
 165 #endif
 166 } interface_options;
 167
 168 /** Capture options coming from user interface */
 169 typedef struct capture_options_tag {
 170     /* general */
 171     void     *cf;                   /**< handle to cfile (note: untyped handle) */
 172     GArray   *ifaces;               /**< array of interfaces.
 173                                          Currently only used by dumpcap. */
 174     GArray   *all_ifaces;
 175     guint    num_selected;
 176     interface_options default_options;
 177     gboolean saving_to_file;        /**< TRUE if capture is writing to a file */
 178     gchar    *save_file;            /**< the capture file name */
 179     gboolean group_read_access;     /**< TRUE is group read permission needs to be set */
 180     gboolean use_pcapng;            /**< TRUE if file format is pcapng */
 181
 182     /* GUI related */
 183     gboolean real_time_mode;        /**< Update list of packets in real time */
 184     gboolean show_info;             /**< show the info dialog */
 185     gboolean quit_after_cap;        /**< Makes a "capture only mode". Implies -k */
 186     gboolean restart;               /**< restart after closing is done */
 187
 188     /* multiple files (and ringbuffer) */
 189     gboolean multi_files_on;        /**< TRUE if ring buffer in use */
 190
 191     gboolean has_file_duration;     /**< TRUE if ring duration specified */
 192     gint32 file_duration;           /**< Switch file after n seconds */
 193     gboolean has_ring_num_files;    /**< TRUE if ring num_files specified */
 194     guint32 ring_num_files;         /**< Number of multiple buffer files */
 195
 196     /* autostop conditions */
 197     gboolean has_autostop_files;    /**< TRUE if maximum number of capture files
 198                                          are specified */
 199     gint32 autostop_files;          /**< Maximum number of capture files */
 200
 201     gboolean has_autostop_packets;  /**< TRUE if maximum packet count is
 202                                          specified */
 203     int autostop_packets;           /**< Maximum packet count */
 204     gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
 205                                          is specified */
 206     gint32 autostop_filesize;       /**< Maximum capture file size */
 207     gboolean has_autostop_duration; /**< TRUE if maximum capture duration
 208                                          is specified */
 209     gint32 autostop_duration;       /**< Maximum capture duration */
 210
 211     /* internally used (don't touch from outside) */
 212     int fork_child;                 /**< If not -1, in parent, process ID of child */
 213     int fork_child_status;          /**< Child exit status */
 214 #ifdef _WIN32
 215     int signal_pipe_write_fd;       /**< the pipe to signal the child */
 216 #endif
 217     capture_state state;            /**< current state of the capture engine */
 218     gboolean output_to_pipe;        /**< save_file is a pipe (named or stdout) */
 219 #ifndef _WIN32
 220     uid_t owner;                    /**< owner of the cfile */
 221     gid_t group;                    /**< group of the cfile */
 222 #endif
 223     gboolean session_started;
 224 } capture_options;
 225
 226 /* initialize the capture_options with some reasonable values */
 227 extern void
 228 capture_opts_init(capture_options *capture_opts, void *cf);
 229
 230 /* set a command line option value */
 231 extern int
 232 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
 233
 234 /* log content of capture_opts */
 235 extern void
 236 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
 237
 238 /* print interface capabilities, including link layer types */
 239 extern void
 240 capture_opts_print_if_capabilities(if_capabilities_t *caps, char *name,
 241                                    gboolean monitor_mode);
 242
 243 /* print list of interfaces */
 244 extern void
 245 capture_opts_print_interfaces(GList *if_list);
 246
 247 /* trim the snaplen entry */
 248 extern void
 249 capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min);
 250
 251 /* trim the ring_num_files entry */
 252 extern void
 253 capture_opts_trim_ring_num_files(capture_options *capture_opts);
 254
 255 /* pick default interface if none was specified */
 256 extern int
 257 capture_opts_default_iface_if_necessary(capture_options *capture_opts,
 258                                         const char *capture_device);
 259
 260 extern void
 261 collect_ifaces(capture_options *capture_opts);
 262
 263 /* Default capture buffer size in Mbytes. */
 264 #define DEFAULT_CAPTURE_BUFFER_SIZE 2
 265
 266 #ifdef __cplusplus
 267 }
 268 #endif /* __cplusplus */
 269
 270 #endif /* capture_opts.h */