ui/capture_opts.h

   1 /* capture_opts.h
   2  * Capture options (all parameters needed to do the actual capture)
   3  *
   4  * Wireshark - Network traffic analyzer
   5  * By Gerald Combs <gerald@wireshark.org>
   6  * Copyright 1998 Gerald Combs
   7  *
   8  * SPDX-License-Identifier: GPL-2.0-or-later
   9  */
  10
  11
  12 /** @file
  13  *
  14  *  Capture options (all parameters needed to do the actual capture)
  15  *
  16  */
  17
  18 #ifndef __CAPTURE_OPTS_H__
  19 #define __CAPTURE_OPTS_H__
  20
  21 #include <sys/types.h>     /* for gid_t */
  22
  23 #include <capture/capture_ifinfo.h>
  24 #include <wsutil/wslog.h>
  25 #include <wsutil/filter_files.h>
  26
  27 #ifdef _WIN32
  28 #include <windows.h>
  29 #endif
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif /* __cplusplus */
  34
  35 /*
  36  * Long options.
  37  * We do not currently have long options corresponding to all short
  38  * options; we should probably pick appropriate option names for them.
  39  *
  40  * NOTE:
  41  * for tshark, we're using a leading - in the optstring to prevent getopt()
  42  * from permuting the argv[] entries, in this case, unknown argv[] entries
  43  * will be returned as parameters to a dummy-option 1.
  44  * In short: we must not use 1 here, which is another reason to use
  45  * values outside the range of ASCII graphic characters.
  46  */
  47 #define LONGOPT_LIST_TSTAMP_TYPES LONGOPT_BASE_CAPTURE+1
  48 #define LONGOPT_SET_TSTAMP_TYPE   LONGOPT_BASE_CAPTURE+2
  49 #define LONGOPT_COMPRESS_TYPE     LONGOPT_BASE_CAPTURE+3
  50 #define LONGOPT_CAPTURE_TMPDIR    LONGOPT_BASE_CAPTURE+4
  51 #define LONGOPT_UPDATE_INTERVAL   LONGOPT_BASE_CAPTURE+5
  52
  53 /*
  54  * Options for capturing common to all capturing programs.
  55  */
  56 #ifdef HAVE_PCAP_REMOTE
  57 #define OPTSTRING_A "A:"
  58 #else
  59 #define OPTSTRING_A
  60 #endif
  61
  62 #define OPTSTRING_B "B:"
  63
  64 #define OPTSTRING_I "I"
  65
  66 #define LONGOPT_CAPTURE_COMMON \
  67     {"autostop",              ws_required_argument, NULL, 'a'}, \
  68     {"ring-buffer",           ws_required_argument, NULL, 'b'}, \
  69     {"buffer-size",           ws_required_argument, NULL, 'B'}, \
  70     {"list-interfaces",       ws_no_argument,       NULL, 'D'}, \
  71     {"interface",             ws_required_argument, NULL, 'i'}, \
  72     {"monitor-mode",          ws_no_argument,       NULL, 'I'}, \
  73     {"list-data-link-types",  ws_no_argument,       NULL, 'L'}, \
  74     {"no-promiscuous-mode",   ws_no_argument,       NULL, 'p'}, \
  75     {"snapshot-length",       ws_required_argument, NULL, 's'}, \
  76     {"linktype",              ws_required_argument, NULL, 'y'}, \
  77     {"list-time-stamp-types", ws_no_argument,       NULL, LONGOPT_LIST_TSTAMP_TYPES}, \
  78     {"time-stamp-type",       ws_required_argument, NULL, LONGOPT_SET_TSTAMP_TYPE}, \
  79     {"compress-type",         ws_required_argument, NULL, LONGOPT_COMPRESS_TYPE}, \
  80     {"temp-dir",              ws_required_argument, NULL, LONGOPT_CAPTURE_TMPDIR},\
  81     {"update-interval",       ws_required_argument, NULL, LONGOPT_UPDATE_INTERVAL},
  82
  83
  84 #define OPTSTRING_CAPTURE_COMMON \
  85     "a:" OPTSTRING_A "b:" OPTSTRING_B "c:Df:F:i:" OPTSTRING_I "Lps:y:"
  86
  87 #ifdef HAVE_PCAP_REMOTE
  88 /* Type of capture source */
  89 typedef enum {
  90     CAPTURE_IFLOCAL,        /**< Local network interface */
  91     CAPTURE_IFREMOTE        /**< Remote network interface */
  92 } capture_source;
  93
  94 /* Type of RPCAPD Authentication */
  95 typedef enum {
  96     CAPTURE_AUTH_NULL,      /**< No authentication */
  97     CAPTURE_AUTH_PWD        /**< User/password authentication */
  98 } capture_auth;
  99 #endif
 100 #ifdef HAVE_PCAP_SETSAMPLING
 101 /**
 102  * Method of packet sampling (dropping some captured packets),
 103  * may require additional integer parameter, marked here as N
 104  */
 105 typedef enum {
 106     CAPTURE_SAMP_NONE,      /**< No sampling - capture all packets */
 107     CAPTURE_SAMP_BY_COUNT,  /**< Counter-based sampling -
 108                                  capture 1 packet from every N */
 109     CAPTURE_SAMP_BY_TIMER   /**< Timer-based sampling -
 110                                  capture no more than 1 packet
 111                                  in N milliseconds */
 112 } capture_sampling;
 113 #endif
 114
 115 #ifdef HAVE_PCAP_REMOTE
 116 struct remote_host_info {
 117     char         *remote_host;      /**< Host name or network address for remote capturing */
 118     char         *remote_port;      /**< TCP port of remote RPCAP server */
 119     capture_auth  auth_type;        /**< Authentication type */
 120     char         *auth_username;    /**< Remote authentication parameters */
 121     char         *auth_password;    /**< Remote authentication parameters */
 122     bool          datatx_udp;
 123     bool          nocap_rpcap;
 124     bool          nocap_local;
 125 };
 126
 127 struct remote_host {
 128     char         *r_host;           /**< Host name or network address for remote capturing */
 129     char         *remote_port;      /**< TCP port of remote RPCAP server */
 130     capture_auth  auth_type;        /**< Authentication type */
 131     char         *auth_username;    /**< Remote authentication parameters */
 132     char         *auth_password;    /**< Remote authentication parameters */
 133 };
 134
 135 typedef struct remote_options_tag {
 136     capture_source src_type;
 137     struct remote_host_info remote_host_opts;
 138 #ifdef HAVE_PCAP_SETSAMPLING
 139     capture_sampling sampling_method;
 140     int sampling_param;
 141 #endif
 142 } remote_options;
 143 #endif /* HAVE_PCAP_REMOTE */
 144
 145 typedef struct interface_tag {
 146     char           *name;
 147     char           *display_name;
 148     char           *addresses;
 149     int             no_addresses;
 150     char           *cfilter;
 151     GList          *links;
 152     int             active_dlt;
 153     bool            pmode;
 154     bool            has_snaplen;
 155     int             snaplen;
 156     bool            local;
 157     int             buffer;
 158     bool            monitor_mode_enabled;
 159     bool            monitor_mode_supported;
 160 #ifdef HAVE_PCAP_REMOTE
 161     remote_options  remote_opts;
 162 #endif
 163     uint32_t        last_packets;
 164     uint32_t        packet_diff;
 165     if_info_t       if_info;
 166     bool            selected;
 167     bool            hidden;
 168     /* External capture cached data */
 169     GHashTable     *external_cap_args_settings;
 170     char           *timestamp_type;
 171 } interface_t;
 172
 173 typedef struct link_row_tag {
 174     char *name;
 175     int dlt;
 176 } link_row;
 177
 178 typedef struct interface_options_tag {
 179     char             *name;                 /* the name of the interface supplied to libpcap/WinPcap/Npcap to specify the interface */
 180     char             *descr;                /* a more user-friendly description of the interface; may be NULL if none */
 181     char             *hardware;             /* description of the hardware */
 182     char             *display_name;         /* the name displayed in the console and title bar */
 183     char             *ifname;               /* if not null, name to use instead of the interface naem in IDBs */
 184     char             *cfilter;
 185     bool              has_snaplen;
 186     int               snaplen;
 187     int               linktype;
 188     bool              promisc_mode;
 189     interface_type    if_type;
 190     char             *extcap;
 191     char             *extcap_fifo;
 192     GHashTable       *extcap_args;
 193     GPid              extcap_pid;           /* pid of running process or WS_INVALID_PID */
 194     void *            extcap_pipedata;
 195     GString          *extcap_stderr;
 196     unsigned          extcap_stdout_watch;
 197     unsigned          extcap_stderr_watch;
 198 #ifdef _WIN32
 199     HANDLE            extcap_pipe_h;
 200     HANDLE            extcap_control_in_h;
 201     HANDLE            extcap_control_out_h;
 202 #endif
 203     char             *extcap_control_in;
 204     char             *extcap_control_out;
 205     int               buffer_size;
 206     bool              monitor_mode;
 207 #ifdef HAVE_PCAP_REMOTE
 208     capture_source    src_type;
 209     char             *remote_host;
 210     char             *remote_port;
 211     capture_auth      auth_type;
 212     char             *auth_username;
 213     char             *auth_password;
 214     bool              datatx_udp;
 215     bool              nocap_rpcap;
 216     bool              nocap_local;
 217 #endif
 218 #ifdef HAVE_PCAP_SETSAMPLING
 219     capture_sampling  sampling_method;
 220     int               sampling_param;
 221 #endif
 222     char             *timestamp_type;       /* requested timestamp as string */
 223     int               timestamp_type_id;    /* Timestamp type to pass to pcap_set_tstamp_type.
 224                                                only valid if timestamp_type != NULL */
 225 } interface_options;
 226
 227 /** Capture options coming from user interface */
 228 typedef struct capture_options_tag {
 229     /* general */
 230     GList             *(*get_iface_list)(int *, char **);
 231                                               /**< routine to call to get the interface list */
 232     GArray            *ifaces;                /**< the interfaces to use for the
 233                                                    next capture, entries are of
 234                                                    type interface_options */
 235     GArray            *all_ifaces;            /**< all interfaces, entries are
 236                                                    of type interface_t */
 237     int                ifaces_err;            /**< if all_ifaces is null, the error
 238                                                    when it was fetched, if any */
 239     char              *ifaces_err_info;       /**< error string for that error */
 240     unsigned           num_selected;
 241
 242     /*
 243      * Options to be applied to all interfaces.
 244      *
 245      * Some of these can be set from the GUI, others can't; setting
 246      * the link-layer header type, for example, doesn't necessarily
 247      * make sense, as different interfaces may support different sets
 248      * of link-layer header types.
 249      *
 250      * Some that can't be set from the GUI can be set from the command
 251      * line, by specifying them before any interface is specified.
 252      * This includes the link-layer header type, so if somebody asks
 253      * for a link-layer header type that an interface on which they're
 254      * capturing doesn't support, we should report an error and fail
 255      * to capture.
 256      *
 257      * These can be overridden per-interface.
 258      */
 259     interface_options  default_options;
 260
 261     bool               saving_to_file;        /**< true if capture is writing to a file */
 262     char              *save_file;             /**< the capture file name */
 263     bool               group_read_access;     /**< true is group read permission needs to be set */
 264     bool               use_pcapng;            /**< true if file format is pcapng */
 265     unsigned           update_interval;       /**< Time in milliseconds. How often to notify parent of new packet counts, check file duration, etc. */
 266
 267     /* GUI related */
 268     bool               real_time_mode;        /**< Update list of packets in real time */
 269     bool               show_info;             /**< show the info dialog. */
 270     bool               restart;               /**< restart after closing is done */
 271     char              *orig_save_file;        /**< the original capture file name (saved for a restart) */
 272
 273     /* multiple files (and ringbuffer) */
 274     bool               multi_files_on;        /**< true if ring buffer in use */
 275
 276     bool               has_file_duration;     /**< true if ring duration specified */
 277     double             file_duration;         /**< Switch file after n seconds */
 278     bool               has_file_interval;     /**< true if ring interval specified */
 279     int32_t            file_interval;         /**< Create time intervals of n seconds */
 280     bool               has_file_packets;      /**< true if ring packet count is
 281                                                    specified */
 282     int                file_packets;          /**< Switch file after n packets */
 283     bool               has_ring_num_files;    /**< true if ring num_files specified */
 284     uint32_t           ring_num_files;        /**< Number of multiple buffer files */
 285     bool               has_nametimenum;       /**< true if file name has date part before num part  */
 286
 287     /* autostop conditions */
 288     bool               has_autostop_files;    /**< true if maximum number of capture files
 289                                                    are specified */
 290     int                autostop_files;        /**< Maximum number of capture files */
 291
 292     bool               has_autostop_packets;  /**< true if maximum packet count is
 293                                                    specified */
 294     int                autostop_packets;      /**< Maximum packet count */
 295     bool               has_autostop_written_packets;  /**< true if maximum packet count is
 296                                                    specified */
 297     int                autostop_written_packets;      /**< Maximum packet count */
 298     bool               has_autostop_filesize; /**< true if maximum capture file size
 299                                                    is specified */
 300     uint32_t           autostop_filesize;     /**< Maximum capture file size in kB */
 301     bool               has_autostop_duration; /**< true if maximum capture duration
 302                                                    is specified */
 303     double             autostop_duration;     /**< Maximum capture duration */
 304
 305     bool               print_file_names;      /**< true if printing names of completed
 306                                                    files as we close them */
 307     char              *print_name_to;         /**< output file name */
 308     char              *temp_dir;              /**< temporary directory path */
 309
 310     /* internally used (don't touch from outside) */
 311     bool               output_to_pipe;        /**< save_file is a pipe (named or stdout) */
 312     bool               capture_child;         /**< hidden option: Wireshark child mode */
 313     bool               stop_after_extcaps;    /**< request dumpcap stop after last extcap */
 314     bool               wait_for_extcap_cbs;   /**< extcaps terminated, waiting for callbacks */
 315     char              *compress_type;         /**< compress type */
 316     char              *closed_msg;            /**< Dumpcap capture closed message */
 317     unsigned           extcap_terminate_id;   /**< extcap process termination source ID */
 318     filter_list_t     *capture_filters_list;  /**< list of saved capture filters */
 319 } capture_options;
 320
 321 /*
 322  * Initialize the capture_options with some reasonable values, and
 323  * provide a routine it can use to fetch a list of capture options
 324  * if it needs it.
 325  *
 326  * (Getting that list might involve running dumpcap, so we don't want
 327  * to waste time doing that if we don't have to.)
 328  */
 329 extern void
 330 capture_opts_init(capture_options *capture_opts, GList *(*get_iface_list)(int *, char **));
 331
 332 /* clean internal structures */
 333 extern void
 334 capture_opts_cleanup(capture_options *capture_opts);
 335
 336 /* set a command line option value */
 337 extern int
 338 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *ws_optarg);
 339
 340 /* log content of capture_opts */
 341 extern void
 342 capture_opts_log(const char *domain, enum ws_log_level level, capture_options *capture_opts);
 343
 344 /* List supported file types for capturing. This is intentionally smaller
 345  * than the list supported by libwiretap (and dumpcap isn't linked with
 346  * libwiretap.) */
 347 extern void
 348 capture_opts_list_file_types(void);
 349
 350 enum caps_query {
 351     CAPS_QUERY_LINK_TYPES      = 0x1,
 352     CAPS_QUERY_TIMESTAMP_TYPES = 0x2
 353 };
 354
 355 /* print interface capabilities, including link layer types */
 356 extern int
 357 capture_opts_print_if_capabilities(if_capabilities_t *caps,
 358                                    const interface_options *interface_opts,
 359                                    int queries);
 360
 361 /* print list of interfaces */
 362 extern void
 363 capture_opts_print_interfaces(GList *if_list);
 364
 365 /* trim the snaplen entry */
 366 extern void
 367 capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min);
 368
 369 /* trim the ring_num_files entry */
 370 extern void
 371 capture_opts_trim_ring_num_files(capture_options *capture_opts);
 372
 373 /* pick default interface if none was specified */
 374 extern int
 375 capture_opts_default_iface_if_necessary(capture_options *capture_opts,
 376                                         const char *capture_device);
 377
 378 extern void
 379 capture_opts_del_iface(capture_options *capture_opts, unsigned if_index);
 380
 381 extern void
 382 interface_opts_free(interface_options *interface_opts);
 383
 384 extern interface_options*
 385 interface_opts_from_if_info(capture_options *capture_opts, const if_info_t *if_info);
 386
 387 extern void
 388 collect_ifaces(capture_options *capture_opts);
 389
 390 extern void
 391 capture_opts_free_link_row(void *elem);
 392
 393 extern void
 394 capture_opts_free_interface_t(interface_t *device);
 395
 396 /* Default capture buffer size in Mbytes. */
 397 #define DEFAULT_CAPTURE_BUFFER_SIZE 2
 398
 399 /* Default update interval in milliseconds */
 400 #define DEFAULT_UPDATE_INTERVAL 100
 401
 402 #ifdef __cplusplus
 403 }
 404 #endif /* __cplusplus */
 405
 406 #endif /* __CAPTURE_OPTS_H__ */
 407
 408 /*
 409  * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 410  *
 411  * Local variables:
 412  * c-basic-offset: 4
 413  * tab-width: 8
 414  * indent-tabs-mode: nil
 415  * End:
 416  *
 417  * vi: set shiftwidth=4 tabstop=8 expandtab:
 418  * :indentSize=4:tabSize=8:noTabs=true:
 419  */