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 #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 typedef struct interface_options_tag {
  81     gchar *name;
  82     gchar *descr;
  83     gchar *cfilter;
  84     gboolean has_snaplen;
  85     int snaplen;
  86     int linktype;
  87     gboolean promisc_mode;
  88 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
  89     int buffer_size;
  90 #endif
  91     gboolean monitor_mode;
  92 #ifdef HAVE_PCAP_REMOTE
  93     capture_source src_type;
  94     gchar *remote_host;
  95     gchar *remote_port;
  96     capture_auth auth_type;
  97     gchar *auth_username;
  98     gchar *auth_password;
  99     gboolean datatx_udp;
 100     gboolean nocap_rpcap;
 101     gboolean nocap_local;
 102 #endif
 103 #ifdef HAVE_PCAP_SETSAMPLING
 104     capture_sampling sampling_method;
 105     int sampling_param;
 106 #endif
 107 } interface_options;
 108
 109 /** Capture options coming from user interface */
 110 typedef struct capture_options_tag {
 111     /* general */
 112     void     *cf;                   /**< handle to cfile (note: untyped handle) */
 113     GArray   *ifaces;               /**< array of interfaces.
 114                                          Currently only used by dumpcap. */
 115     interface_options default_options;
 116     gboolean saving_to_file;        /**< TRUE if capture is writing to a file */
 117     gchar    *save_file;            /**< the capture file name */
 118     gboolean group_read_access;     /**< TRUE is group read permission needs to be set */
 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     int fork_child_status;          /**< Child exit status */
 153 #ifdef _WIN32
 154     int signal_pipe_write_fd;       /**< the pipe to signal the child */
 155 #endif
 156     capture_state state;            /**< current state of the capture engine */
 157     gboolean output_to_pipe;        /**< save_file is a pipe (named or stdout) */
 158 #ifndef _WIN32
 159     uid_t owner;                    /**< owner of the cfile */
 160     gid_t group;                    /**< group of the cfile */
 161 #endif
 162 } capture_options;
 163
 164 /* initialize the capture_options with some reasonable values */
 165 extern void
 166 capture_opts_init(capture_options *capture_opts, void *cf);
 167
 168 /* set a command line option value */
 169 extern int
 170 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
 171
 172 /* log content of capture_opts */
 173 extern void
 174 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
 175
 176 /* print interface capabilities, including link layer types */
 177 extern void
 178 capture_opts_print_if_capabilities(if_capabilities_t *caps, char *name,
 179                                    gboolean monitor_mode);
 180
 181 /* print list of interfaces */
 182 extern void
 183 capture_opts_print_interfaces(GList *if_list);
 184
 185 /* trim the snaplen entry */
 186 extern void
 187 capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min);
 188
 189 /* trim the ring_num_files entry */
 190 extern void
 191 capture_opts_trim_ring_num_files(capture_options *capture_opts);
 192
 193 /* trim the interface entry */
 194 extern gboolean
 195 capture_opts_trim_iface(capture_options *capture_opts, const char *capture_device);
 196
 197 #ifdef __cplusplus
 198 }
 199 #endif /* __cplusplus */
 200
 201 #endif /* capture_opts.h */