smb2: add support for the SMB2_GLOBAL_CAP_ENCRYPTION
[obnox/wireshark/wip.git] / capture_opts.h
index 8d1d5600eaf02955099849a07443a846839bbed8..5e0d2e56ea1cfe05172522bf3757891b6f731ec2 100644 (file)
 #ifndef __CAPTURE_OPTS_H__
 #define __CAPTURE_OPTS_H__
 
+#ifdef HAVE_SYS_TYPES_H
+# include <sys/types.h>            /* for gid_t */
+#endif
+
+#include "capture_ifinfo.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
 
 /* Current state of capture engine. XXX - differentiate states */
 typedef enum {
@@ -40,26 +49,145 @@ typedef enum {
     CAPTURE_RUNNING         /**< capture child signalled ok, capture is running now */
 } capture_state;
 
+#ifdef HAVE_PCAP_REMOTE
+/* Type of capture source */
+typedef enum {
+    CAPTURE_IFLOCAL,        /**< Local network interface */
+    CAPTURE_IFREMOTE        /**< Remote network interface */
+} capture_source;
+
+/* Type of RPCAPD Authentication */
+typedef enum {
+    CAPTURE_AUTH_NULL,      /**< No authentication */
+    CAPTURE_AUTH_PWD        /**< User/password authentication */
+} capture_auth;
+#endif
+#ifdef HAVE_PCAP_SETSAMPLING
+/**
+ * Method of packet sampling (dropping some captured packets),
+ * may require additional integer parameter, marked here as N
+ */
+typedef enum {
+    CAPTURE_SAMP_NONE,      /**< No sampling - capture all packets */
+    CAPTURE_SAMP_BY_COUNT,  /**< Counter-based sampling -
+                                 capture 1 packet from every N */
+    CAPTURE_SAMP_BY_TIMER   /**< Timer-based sampling -
+                                 capture no more than 1 packet
+                                 in N milliseconds */
+} capture_sampling;
+#endif
+
+typedef enum {
+    IF_WIRED,
+    IF_AIRPCAP,
+    IF_PIPE,
+    IF_STDIN,
+    IF_BLUETOOTH,
+    IF_WIRELESS,
+    IF_DIALUP,
+    IF_USB,
+    IF_VIRTUAL
+} interface_type;
+
+#ifdef HAVE_PCAP_REMOTE
+struct remote_host_info {
+    gchar *remote_host;          /**< Host name or network address for remote capturing */
+    gchar *remote_port;          /**< TCP port of remote RPCAP server */
+    gint auth_type;              /**< Authentication type */
+    gchar *auth_username;        /**< Remote authentication parameters */
+    gchar *auth_password;        /**< Remote authentication parameters */
+    gboolean datatx_udp;
+    gboolean nocap_rpcap;
+    gboolean nocap_local;
+};
+
+typedef struct remote_options_tag {
+    capture_source src_type;
+    struct remote_host_info remote_host_opts;
+#ifdef HAVE_PCAP_SETSAMPLING
+    capture_sampling sampling_method;
+    int sampling_param;
+#endif
+} remote_options;
+#endif /* HAVE_PCAP_REMOTE */
+
+typedef struct interface_tag {
+    gchar *name;
+    gchar *display_name;
+    guint type;
+    gchar *addresses;
+    gint no_addresses;
+    gchar *cfilter;
+    GList *links;
+    gint active_dlt;
+    gboolean pmode;
+    gboolean has_snaplen;
+    guint snaplen;
+    gboolean local;
+#if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
+    gint buffer;
+#endif
+#ifdef HAVE_PCAP_CREATE
+    gboolean monitor_mode_enabled;
+    gboolean monitor_mode_supported;
+#endif
+#ifdef HAVE_PCAP_REMOTE
+    remote_options remote_opts;
+#endif
+    guint32     last_packets;
+    if_info_t   if_info;
+    gboolean    selected;
+    gboolean    hidden;
+    gboolean    locked;
+} interface_t;
+
+typedef struct link_row_tag {
+    gchar *name;
+    gint dlt;
+} link_row;
+
+typedef struct interface_options_tag {
+    gchar *name;
+    gchar *descr;
+    gchar *cfilter;
+    gboolean has_snaplen;
+    int snaplen;
+    int linktype;
+    gboolean promisc_mode;
+#if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
+    int buffer_size;
+#endif
+    gboolean monitor_mode;
+#ifdef HAVE_PCAP_REMOTE
+    capture_source src_type;
+    gchar *remote_host;
+    gchar *remote_port;
+    capture_auth auth_type;
+    gchar *auth_username;
+    gchar *auth_password;
+    gboolean datatx_udp;
+    gboolean nocap_rpcap;
+    gboolean nocap_local;
+#endif
+#ifdef HAVE_PCAP_SETSAMPLING
+    capture_sampling sampling_method;
+    int sampling_param;
+#endif
+} interface_options;
 
 /** Capture options coming from user interface */
 typedef struct capture_options_tag {
     /* general */
     void     *cf;                   /**< handle to cfile (note: untyped handle) */
-    gboolean has_cfilter;           /**< TRUE if capture filter specified on command line */
-    gchar    *cfilter;              /**< Capture filter string */
-    gchar    *iface;                /**< the network interface to capture from */
-
-#ifdef _WIN32
-    int      buffer_size;           /**< the capture buffer size (MB) */
-#endif
-    gboolean has_snaplen;           /**< TRUE if maximum capture packet length
-                                         is specified */
-    int      snaplen;               /**< Maximum captured packet length */
-    gboolean promisc_mode;          /**< Capture in promiscuous mode */
-    int      linktype;              /**< Data link type to use, or -1 for
-                                         "use default" */
+    GArray   *ifaces;               /**< array of interfaces.
+                                         Currently only used by dumpcap. */
+    GArray   *all_ifaces;
+    guint    num_selected;
+    interface_options default_options;
     gboolean saving_to_file;        /**< TRUE if capture is writing to a file */
     gchar    *save_file;            /**< the capture file name */
+    gboolean group_read_access;     /**< TRUE is group read permission needs to be set */
+    gboolean use_pcapng;            /**< TRUE if file format is pcapng */
 
     /* GUI related */
     gboolean real_time_mode;        /**< Update list of packets in real time */
@@ -92,37 +220,41 @@ typedef struct capture_options_tag {
 
     /* internally used (don't touch from outside) */
     int fork_child;                 /**< If not -1, in parent, process ID of child */
+    int fork_child_status;          /**< Child exit status */
 #ifdef _WIN32
     int signal_pipe_write_fd;       /**< the pipe to signal the child */
 #endif
     capture_state state;            /**< current state of the capture engine */
     gboolean output_to_pipe;        /**< save_file is a pipe (named or stdout) */
+#ifndef _WIN32
+    uid_t owner;                    /**< owner of the cfile */
+    gid_t group;                    /**< group of the cfile */
+#endif
 } capture_options;
 
-
 /* initialize the capture_options with some reasonable values */
 extern void
-capture_opts_init(capture_options *capture_opts, void *cfile);
+capture_opts_init(capture_options *capture_opts, void *cf);
 
 /* set a command line option value */
 extern int
 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture);
 
+extern int
+capture_opts_add_iface_opt(capture_options *capture_opts, const char *optarg_str_p);
+
 /* log content of capture_opts */
 extern void
 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts);
 
-/* list link layer types */
-extern int
-capture_opts_list_link_layer_types(capture_options *capture_opts, gboolean machine_readable);
-
-/* list interfaces */
-extern int
-capture_opts_list_interfaces(gboolean machine_readable);
+/* print interface capabilities, including link layer types */
+extern void
+capture_opts_print_if_capabilities(if_capabilities_t *caps, char *name,
+                                   gboolean monitor_mode);
 
-/* print interface statistics */
-extern int
-capture_opts_print_statistics(gboolean machine_readable);
+/* print list of interfaces */
+extern void
+capture_opts_print_interfaces(GList *if_list);
 
 /* trim the snaplen entry */
 extern void
@@ -136,4 +268,26 @@ capture_opts_trim_ring_num_files(capture_options *capture_opts);
 extern gboolean
 capture_opts_trim_iface(capture_options *capture_opts, const char *capture_device);
 
+extern void
+collect_ifaces(capture_options *capture_opts);
+
+typedef struct {
+    gboolean monitor_mode;
+    int linktype;
+} cap_settings_t;
+
+/** Get capture settings for interface
+ *
+ * @param if_name interface name
+ */
+cap_settings_t
+capture_get_cap_settings (gchar *if_name);
+
+extern void 
+scan_local_interfaces(capture_options* capture_opts, int *error);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
 #endif /* capture_opts.h */