capture/capture-pcap-util.h

   1 /** @file
   2  *
   3  * Utility definitions for packet capture
   4  *
   5  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald@wireshark.org>
   7  * Copyright 1998 Gerald Combs
   8  *
   9  * SPDX-License-Identifier: GPL-2.0-or-later
  10  */
  11
  12 #ifndef __CAPTURE_PCAP_UTIL_H__
  13 #define __CAPTURE_PCAP_UTIL_H__
  14
  15 #include <wsutil/feature_list.h>
  16
  17 #ifdef HAVE_LIBPCAP
  18
  19 #include <pcap.h>
  20
  21 #include "capture_opts.h"
  22
  23 #endif
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29 #ifdef HAVE_LIBPCAP
  30 /*
  31  * A snapshot length of 0 is useless - and libpcap/WinPcap/Npcap don't guarantee
  32  * that a snapshot length of 0 will work, and, on some platforms, it won't
  33  * (with BPF, for example, the kernel is told the snapshot length via the
  34  * return value of the BPF program, and a return value of 0 means "drop
  35  * the packet"), so the minimum packet size is 1 byte.
  36  */
  37 #define MIN_PACKET_SIZE 1       /* minimum amount of packet data we can read */
  38
  39 GList *get_interface_list(int *err, char **err_str);
  40 #ifdef HAVE_PCAP_REMOTE
  41 GList *get_remote_interface_list(const char *hostname, const char *port,
  42                                  int auth_type, const char *username,
  43                                  const char *passwd, int *err, char **err_str);
  44 #endif /* HAVE_PCAP_REMOTE */
  45
  46 const char *linktype_val_to_name(int dlt);
  47 int linktype_name_to_val(const char *linktype);
  48
  49 int get_pcap_datalink(pcap_t *pch, const char *devicename);
  50
  51 bool set_pcap_datalink(pcap_t *pcap_h, int datalink, char *name,
  52     char *errmsg, size_t errmsg_len,
  53     char *secondary_errmsg, size_t secondary_errmsg_len);
  54
  55 #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION
  56 /*
  57  * Return true if the pcap_t in question is set up for high-precision
  58  * time stamps, false otherwise.
  59  */
  60 bool have_high_resolution_timestamp(pcap_t *pcap_h);
  61 #endif /* HAVE_PCAP_SET_TSTAMP_PRECISION */
  62
  63 /*
  64  * Capture device open status values.
  65  */
  66 typedef enum {
  67     /* No error and no warning */
  68     CAP_DEVICE_OPEN_NO_ERR,
  69
  70     /* Errors corresponding to libpcap errors */
  71     CAP_DEVICE_OPEN_ERROR_NO_SUCH_DEVICE,
  72     CAP_DEVICE_OPEN_ERROR_RFMON_NOTSUP,
  73     CAP_DEVICE_OPEN_ERROR_PERM_DENIED,
  74     CAP_DEVICE_OPEN_ERROR_IFACE_NOT_UP,
  75     CAP_DEVICE_OPEN_ERROR_PROMISC_PERM_DENIED,
  76
  77     /* Error, none of the above */
  78     CAP_DEVICE_OPEN_ERROR_OTHER,
  79
  80     /* Error from pcap_open_live() or pcap_open() rather than pcap_activate() */
  81     CAP_DEVICE_OPEN_ERROR_GENERIC,
  82
  83     /* Warnings corresponding to libpcap warnings */
  84     CAP_DEVICE_OPEN_WARNING_PROMISC_NOTSUP,
  85     CAP_DEVICE_OPEN_WARNING_TSTAMP_TYPE_NOTSUP,
  86
  87     /* Warning, none of the above */
  88     CAP_DEVICE_OPEN_WARNING_OTHER
  89 } cap_device_open_status;
  90 extern if_capabilities_t *get_if_capabilities(interface_options *interface_opts,
  91     cap_device_open_status *status, char **status_str);
  92 extern pcap_t *open_capture_device(capture_options *capture_opts,
  93     interface_options *interface_opts,
  94     int timeout, cap_device_open_status *open_status,
  95     char (*open_status_str)[PCAP_ERRBUF_SIZE]);
  96
  97 #endif /* HAVE_LIBPCAP */
  98
  99 extern void gather_caplibs_compile_info(feature_list l);
 100
 101 /*
 102  * Append to a GString an indication of the version of capture libraries
 103  * with which we're running, or an indication that we're not running
 104  * with capture libraries, if we were compiled with WinPcap or Npcap but
 105  * WinPcap/Npcap wasn't loaded, or nothing, if we weren't compiled with
 106  * libpcap/WinPcap/Npcap.
 107  */
 108 extern void gather_caplibs_runtime_info(feature_list l);
 109
 110 #ifdef _WIN32
 111 extern bool caplibs_have_npcap(void);
 112 extern bool caplibs_get_npcap_version(unsigned int *major,
 113     unsigned int *minor);
 114 #endif
 115
 116 #ifdef __cplusplus
 117 }
 118 #endif /* __cplusplus */
 119
 120 #endif /* __CAPTURE_PCAP_UTIL_H__ */