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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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
  40 /* Current state of capture engine. XXX - differentiate states */
  41 typedef enum {
  42     CAPTURE_STOPPED,        /**< stopped */
  43     CAPTURE_PREPARING,      /**< preparing, but still no response from capture child */
  44     CAPTURE_RUNNING         /**< capture child signalled ok, capture is running now */
  45 } capture_state;
  46
  47 #ifdef HAVE_PCAP_REMOTE
  48 /* Type of capture source */
  49 typedef enum {
  50     CAPTURE_IFLOCAL,        /**< Local network interface */
  51     CAPTURE_IFREMOTE        /**< Remote network interface */
  52 } capture_source;
  53
  54 /* Type of RPCAPD Authentication */
  55 typedef enum {
  56     CAPTURE_AUTH_NULL,      /**< No authentication */
  57     CAPTURE_AUTH_PWD        /**< User/password authentication */
  58 } capture_auth;
  59
  60 #ifdef HAVE_PCAP_SETSAMPLING
  61 /**
  62  * Method of packet sampling (dropping some captured packets),
  63  * may require additional integer parameter, marked here as N
  64  */
  65 typedef enum {
  66     CAPTURE_SAMP_NONE,      /**< No sampling - capture all packets */
  67     CAPTURE_SAMP_BY_COUNT,  /**< Counter-based sampling -
  68                                  capture 1 packet from every N */
  69     CAPTURE_SAMP_BY_TIMER   /**< Timer-based sampling -
  70                                  capture no more than 1 packet
  71                                  in N milliseconds */
  72 } capture_sampling;
  73 #endif
  74 #endif
  75
  76 /** Capture options coming from user interface */
  77 typedef struct capture_options_tag {
  78     /* general */
  79     void     *cf;                   /**< handle to cfile (note: untyped handle) */
  80     gboolean has_cfilter;           /**< TRUE if capture filter specified on command line */
  81     gchar    *cfilter;              /**< Capture filter string */
  82     gchar    *iface;                /**< the network interface to capture from */
  83     gchar    *iface_descr;          /**< A human readable description of iface.
  84                                       *< NOTE: capture_opts.c is not able to
  85                                       *< set this field because doing so
  86                                       *< requires too many dependencies.
  87                                       *< Readers of this field should use
  88                                       *< get_iface_description() from
  89                                       *< "capture_ui_utils.h" to access it. */
  90 #ifdef HAVE_PCAP_REMOTE
  91     capture_source src_type;        /**< Capturing on remote interface */
  92     gchar    *remote_host;          /**< Host name or network address
  93                                       *< for remote capturing */
  94     gchar    *remote_port;          /**< TCP port of remote RPCAP server */
  95
  96     capture_auth  auth_type;
  97     gchar    *auth_username;
  98     gchar    *auth_password;        /**< Remote authentication parameters */
  99
 100     gboolean datatx_udp;            /**< Whether to use UDP for data transfer */
 101     gboolean nocap_rpcap;           /**< Whether to capture RPCAP own traffic */
 102     gboolean nocap_local;           /**< TODO: Whether to capture local traffic */
 103 #ifdef HAVE_PCAP_SETSAMPLING
 104     capture_sampling sampling_method; /**< PCAP packet sampling method */
 105     int sampling_param;             /**< PCAP packet sampling parameter */
 106 #endif
 107 #endif
 108 #ifdef _WIN32
 109     int      buffer_size;           /**< the capture buffer size (MB) */
 110 #endif
 111     gboolean has_snaplen;           /**< TRUE if maximum capture packet length
 112                                          is specified */
 113     int      snaplen;               /**< Maximum captured packet length */
 114     gboolean promisc_mode;          /**< Capture in promiscuous mode */
 115     int      linktype;              /**< Data link type to use, or -1 for
 116                                          "use default" */
 117     gboolean saving_to_file;        /**< TRUE if capture is writing to a file */
 118     gchar    *save_file;            /**< the capture file name */
 119     gboolean use_pcapng;            /**< TRUE if file format is pcapng */
 120
 121     /* GUI related */
 122     gboolean real_time_mode;        /**< Update list of packets in real time */
 123     gboolean show_info;             /**< show the info dialog */
 124     gboolean quit_after_cap;        /**< Makes a "capture only mode". Implies -k */
 125     gboolean restart;               /**< restart after closing is done */
 126
 127     /* multiple files (and ringbuffer) */
 128     gboolean multi_files_on;        /**< TRUE if ring buffer in use */
 129
 130     gboolean has_file_duration;     /**< TRUE if ring duration specified */
 131     gint32 file_duration;           /**< Switch file after n seconds */
 132     gboolean has_ring_num_files;    /**< TRUE if ring num_files specified */
 133     guint32 ring_num_files;         /**< Number of multiple buffer files */
 134
 135     /* autostop conditions */
 136     gboolean has_autostop_files;    /**< TRUE if maximum number of capture files
 137                                          are specified */
 138     gint32 autostop_files;          /**< Maximum number of capture files */
 139
 140     gboolean has_autostop_packets;  /**< TRUE if maximum packet count is
 141                                          specified */
 142     int autostop_packets;           /**< Maximum packet count */
 143     gboolean has_autostop_filesize; /**< TRUE if maximum capture file size
 144                                          is specified */
 145     gint32 autostop_filesize;       /**< Maximum capture file size */
 146     gboolean has_autostop_duration; /**< TRUE if maximum capture duration
 147                                          is specified */
 148     gint32 autostop_duration;       /**< Maximum capture duration */
 149
 150     /* internally used (don't touch from outside) */
 151     int fork_child;                 /**< If not -1, in parent, process ID of child */
 152 #ifdef _WIN32
 153     int signal_pipe_write_fd;       /**< the pipe to signal the child */
 154 #endif
 155     capture_state state;            /**< current state of the capture engine */
 156     gboolean output_to_pipe;        /**< save_file is a pipe (named or stdout) */
 157 #ifndef _WIN32
 158     uid_t owner;                    /**< owner of the cfile */
 159     gid_t group;                    /**< group of the cfile */
 160 #endif
 161 } capture_options;
 162
 163 /* initialize the capture_options with some reasonable values */
 164 extern void
 165 capture_opts_init(capture_options *capture_opts, void *cf);
 166
 167 /* set a command line option value */
 168 extern int
 169 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
 170
 171 /* log content of capture_opts */
 172 extern void
 173 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
 174
 175 /* list link layer types */
 176 extern int
 177 capture_opts_list_link_layer_types(capture_options *capture_opts, gboolean machine_readable);
 178
 179 /* list interfaces */
 180 extern int
 181 capture_opts_list_interfaces(gboolean machine_readable);
 182
 183 /* trim the snaplen entry */
 184 extern void
 185 capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min);
 186
 187 /* trim the ring_num_files entry */
 188 extern void
 189 capture_opts_trim_ring_num_files(capture_options *capture_opts);
 190
 191 /* trim the interface entry */
 192 extern gboolean
 193 capture_opts_trim_iface(capture_options *capture_opts, const char *capture_device);
 194
 195 #endif /* capture_opts.h */