]> The Tcpdump Group git mirrors - libpcap/blobdiff - pcap-int.h
Update config.{guess,sub}, timestamps 2023-01-01,2023-01-21
[libpcap] / pcap-int.h
index 65b7b52d15ad8d576b47d37ea592d310c2e99a2c..894e74afa85305b1db1524ff251670aba9a71b50 100644 (file)
 #ifndef pcap_int_h
 #define        pcap_int_h
 
+#include <stddef.h>
+
+#include <signal.h>
+
 #include <pcap/pcap.h>
 
-#ifdef __cplusplus
-extern "C" {
+#ifdef MSDOS
+  #include <fcntl.h>
+  #include <io.h>
 #endif
 
-#if defined(_WIN32)
+#include "varattrs.h"
+#include "fmtutils.h"
+
+#include <stdarg.h>
+
+#include "portability.h"
+
+/*
+ * If we're compiling with Visual Studio, make sure we have at least
+ * VS 2015 or later, so we have sufficient C99 support.
+ *
+ * XXX - verify that we have at least C99 support on UN*Xes?
+ *
+ * What about MinGW or various DOS toolchains?  We're currently assuming
+ * sufficient C99 support there.
+ */
+#if defined(_MSC_VER)
   /*
-   * Make sure Packet32.h doesn't define BPF structures that we've
-   * probably already defined as a result of including <pcap/pcap.h>.
+   * Compiler is MSVC.  Make sure we have VS 2015 or later.
    */
-  #define BPF_MAJOR_VERSION
-  #include <Packet32.h>
-#elif defined(MSDOS)
-  #include <fcntl.h>
-  #include <io.h>
+  #if _MSC_VER < 1900
+    #error "Building libpcap requires VS 2015 or later"
+  #endif
 #endif
 
-#if (defined(_MSC_VER) && (_MSC_VER <= 1200)) /* we are compiling with Visual Studio 6, that doesn't support the LL suffix*/
+/*
+ * Version string.
+ * Uses PACKAGE_VERSION from config.h.
+ */
+#define PCAP_VERSION_STRING "libpcap version " PACKAGE_VERSION
+
+#ifdef __cplusplus
+extern "C" {
+#endif
 
 /*
- * Swap byte ordering of unsigned long long timestamp on a big endian
- * machine.
+ * If pcap_new_api is set, we disable pcap_lookupdev(), because:
+ *
+ *    it's not thread-safe, and is marked as deprecated, on all
+ *    platforms;
+ *
+ *    on Windows, it may return UTF-16LE strings, which the program
+ *    might then pass to pcap_create() (or to pcap_open_live(), which
+ *    then passes them to pcap_create()), requiring pcap_create() to
+ *    check for UTF-16LE strings using a hack, and that hack 1)
+ *    *cannot* be 100% reliable and 2) runs the risk of going past the
+ *    end of the string.
+ *
+ * We keep it around in legacy mode for compatibility.
+ *
+ * We also disable the aforementioned hack in pcap_create().
  */
-#define SWAPLL(ull)  ((ull & 0xff00000000000000) >> 56) | \
-                      ((ull & 0x00ff000000000000) >> 40) | \
-                      ((ull & 0x0000ff0000000000) >> 24) | \
-                      ((ull & 0x000000ff00000000) >> 8)  | \
-                      ((ull & 0x00000000ff000000) << 8)  | \
-                      ((ull & 0x0000000000ff0000) << 24) | \
-                      ((ull & 0x000000000000ff00) << 40) | \
-                      ((ull & 0x00000000000000ff) << 56)
+extern int pcap_new_api;
 
-#else /* A recent Visual studio compiler or not VC */
+/*
+ * If pcap_utf_8_mode is set, on Windows we treat strings as UTF-8.
+ *
+ * On UN*Xes, we assume all strings are and should be in UTF-8, regardless
+ * of the setting of this flag.
+ */
+extern int pcap_utf_8_mode;
 
 /*
  * Swap byte ordering of unsigned long long timestamp on a big endian
@@ -82,8 +120,6 @@ extern "C" {
                       ((ull & 0x000000000000ff00ULL) << 40) | \
                       ((ull & 0x00000000000000ffULL) << 56)
 
-#endif /* _MSC_VER */
-
 /*
  * Maximum snapshot length.
  *
@@ -92,7 +128,7 @@ extern "C" {
  *    1) big enough for maximum-size Linux loopback packets (65549)
  *       and some USB packets captured with USBPcap:
  *
- *           http://desowin.org/usbpcap/
+ *           https://desowin.org/usbpcap/
  *
  *       (> 131072, < 262144)
  *
@@ -101,12 +137,29 @@ extern "C" {
  *    2) small enough not to cause attempts to allocate huge amounts of
  *       memory; some applications might use the snapshot length in a
  *       savefile header to control the size of the buffer they allocate,
- *       so a size of, say, 2^31-1 might not work well.
+ *       so a size of, say, 2^31-1 might not work well.  (libpcap uses it
+ *       as a hint, but doesn't start out allocating a buffer bigger than
+ *       2 KiB, and grows the buffer as necessary, but not beyond the
+ *       per-linktype maximum snapshot length.  Other code might naively
+ *       use it; we want to avoid writing a too-large snapshot length,
+ *       in order not to cause that code problems.)
  *
  * We don't enforce this in pcap_set_snaplen(), but we use it internally.
  */
 #define MAXIMUM_SNAPLEN                262144
 
+/*
+ * Locale-independent macros for testing character types.
+ * These can be passed any integral value, without worrying about, for
+ * example, sign-extending char values, unlike the C macros.
+ */
+#define PCAP_ISDIGIT(c) \
+       ((c) >= '0' && (c) <= '9')
+#define PCAP_ISXDIGIT(c) \
+       (((c) >= '0' && (c) <= '9') || \
+        ((c) >= 'A' && (c) <= 'F') || \
+        ((c) >= 'a' && (c) <= 'f'))
+
 struct pcap_opt {
        char    *device;
        int     timeout;        /* timeout for buffering */
@@ -114,20 +167,34 @@ struct pcap_opt {
        int     promisc;
        int     rfmon;          /* monitor mode */
        int     immediate;      /* immediate mode - deliver packets as soon as they arrive */
+       int     nonblock;       /* non-blocking mode - don't wait for packets to be delivered, return "no packets available" */
        int     tstamp_type;
        int     tstamp_precision;
+
+       /*
+        * Platform-dependent options.
+        */
+#ifdef __linux__
+       int     protocol;       /* protocol to use when creating PF_PACKET socket */
+#endif
+#ifdef _WIN32
+       int     nocapture_local;/* disable NPF loopback */
+#endif
 };
 
 typedef int    (*activate_op_t)(pcap_t *);
 typedef int    (*can_set_rfmon_op_t)(pcap_t *);
 typedef int    (*read_op_t)(pcap_t *, int cnt, pcap_handler, u_char *);
-typedef int    (*inject_op_t)(pcap_t *, const void *, size_t);
+typedef int    (*next_packet_op_t)(pcap_t *, struct pcap_pkthdr *, u_char **);
+typedef int    (*inject_op_t)(pcap_t *, const void *, int);
+typedef void   (*save_current_filter_op_t)(pcap_t *, const char *);
 typedef int    (*setfilter_op_t)(pcap_t *, struct bpf_program *);
 typedef int    (*setdirection_op_t)(pcap_t *, pcap_direction_t);
 typedef int    (*set_datalink_op_t)(pcap_t *, int);
-typedef int    (*getnonblock_op_t)(pcap_t *, char *);
-typedef int    (*setnonblock_op_t)(pcap_t *, int, char *);
+typedef int    (*getnonblock_op_t)(pcap_t *);
+typedef int    (*setnonblock_op_t)(pcap_t *, int);
 typedef int    (*stats_op_t)(pcap_t *, struct pcap_stat *);
+typedef void   (*breakloop_op_t)(pcap_t *);
 #ifdef _WIN32
 typedef struct pcap_stat *(*stats_ex_op_t)(pcap_t *, int *);
 typedef int    (*setbuff_op_t)(pcap_t *, int);
@@ -155,15 +222,14 @@ struct pcap {
        read_op_t read_op;
 
        /*
-        * Method to call to read packets from a savefile.
+        * Method to call to read the next packet from a savefile.
         */
-       int (*next_packet_op)(pcap_t *, struct pcap_pkthdr *, u_char **);
+       next_packet_op_t next_packet_op;
 
 #ifdef _WIN32
-       ADAPTER *adapter;
+       HANDLE handle;
 #else
        int fd;
-       int selectable_fd;
 #endif /* _WIN32 */
 
        /*
@@ -174,10 +240,14 @@ struct pcap {
        u_char *bp;
        int cc;
 
-       int break_loop;         /* flag set to force break from packet-reading loop */
+       sig_atomic_t break_loop; /* flag set to force break from packet-reading loop */
 
        void *priv;             /* private data for methods */
 
+#ifdef ENABLE_REMOTE
+       struct pcap_samp rmt_samp;      /* parameters related to the sampling process. */
+#endif
+
        int swapped;
        FILE *rfile;            /* null if live capture, non-null if savefile */
        u_int fddipad;
@@ -194,8 +264,7 @@ struct pcap {
 
        int snapshot;
        int linktype;           /* Network linktype */
-       int linktype_ext;       /* Extended information stored in the linktype field of a file */
-       int tzoff;              /* timezone offset */
+       int linktype_ext;       /* Extended information stored in the linktype field of a file */
        int offset;             /* offset for proper alignment */
        int activated;          /* true if the capture is really started */
        int oldstyle;           /* if we're opening with pcap_open_live() */
@@ -208,7 +277,7 @@ struct pcap {
        u_char *pkt;
 
 #ifdef _WIN32
-       struct pcap_stat stat;          /* used for pcap_stats_ex() */
+       struct pcap_stat stat;  /* used for pcap_stats_ex() */
 #endif
 
        /* We're accepting only packets in this direction/these directions. */
@@ -219,12 +288,32 @@ struct pcap {
         */
        int bpf_codegen_flags;
 
+#if !defined(_WIN32) && !defined(MSDOS)
+       int selectable_fd;      /* FD on which select()/poll()/epoll_wait()/kevent()/etc. can be done */
+
+       /*
+        * In case there either is no selectable FD, or there is but
+        * it doesn't necessarily work (e.g., if it doesn't get notified
+        * if the packet capture timeout expires before the buffer
+        * fills up), this points to a timeout that should be used
+        * in select()/poll()/epoll_wait()/kevent() call.  The pcap_t should
+        * be put into non-blocking mode, and, if the timeout expires on
+        * the call, an attempt should be made to read packets from all
+        * pcap_t's with a required timeout, and the code must be
+        * prepared not to see any packets from the attempt.
+        */
+       const struct timeval *required_select_timeout;
+#endif
+
        /*
         * Placeholder for filter code if bpf not in kernel.
         */
        struct bpf_program fcode;
 
        char errbuf[PCAP_ERRBUF_SIZE + 1];
+#ifdef _WIN32
+       char acp_errbuf[PCAP_ERRBUF_SIZE + 1];  /* buffer for local code page error strings */
+#endif
        int dlt_count;
        u_int *dlt_list;
        int tstamp_type_count;
@@ -240,12 +329,14 @@ struct pcap {
        activate_op_t activate_op;
        can_set_rfmon_op_t can_set_rfmon_op;
        inject_op_t inject_op;
+       save_current_filter_op_t save_current_filter_op;
        setfilter_op_t setfilter_op;
        setdirection_op_t setdirection_op;
        set_datalink_op_t set_datalink_op;
        getnonblock_op_t getnonblock_op;
        setnonblock_op_t setnonblock_op;
        stats_op_t stats_op;
+       breakloop_op_t breakloop_op;
 
        /*
         * Routine to use as callback for pcap_next()/pcap_next_ex().
@@ -316,7 +407,7 @@ struct pcap_timeval {
  *
  * Then supply the changes by forking the branch at
  *
- *     https://github.com/the-tcpdump-group/libpcap/issues
+ *     https://github.com/the-tcpdump-group/libpcap/tree/master
  *
  * and issuing a pull request, so that future versions of libpcap and
  * programs that use it (such as tcpdump) will be able to read your new
@@ -326,7 +417,7 @@ struct pcap_timeval {
 struct pcap_sf_pkthdr {
     struct pcap_timeval ts;    /* time stamp */
     bpf_u_int32 caplen;                /* length of portion present */
-    bpf_u_int32 len;           /* length this packet (off wire) */
+    bpf_u_int32 len;           /* length of this packet (off wire) */
 };
 
 /*
@@ -342,7 +433,7 @@ struct pcap_sf_pkthdr {
 struct pcap_sf_patched_pkthdr {
     struct pcap_timeval ts;    /* time stamp */
     bpf_u_int32 caplen;                /* length of portion present */
-    bpf_u_int32 len;           /* length this packet (off wire) */
+    bpf_u_int32 len;           /* length of this packet (off wire) */
     int                index;
     unsigned short protocol;
     unsigned char pkt_type;
@@ -364,10 +455,6 @@ struct oneshot_userdata {
 
 int    pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
 
-#include <stdarg.h>
-
-#include "portability.h"
-
 /*
  * Does the packet count argument to a module's read routine say
  * "supply packets until you run out of packets"?
@@ -378,8 +465,8 @@ int pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
  * Routines that most pcap implementations can use for non-blocking mode.
  */
 #if !defined(_WIN32) && !defined(MSDOS)
-int    pcap_getnonblock_fd(pcap_t *, char *);
-int    pcap_setnonblock_fd(pcap_t *p, int, char *);
+int    pcap_getnonblock_fd(pcap_t *);
+int    pcap_setnonblock_fd(pcap_t *p, int);
 #endif
 
 /*
@@ -394,16 +481,34 @@ int       pcap_setnonblock_fd(pcap_t *p, int, char *);
  * by pcap_create routines.
  */
 pcap_t *pcap_create_interface(const char *, char *);
-pcap_t *pcap_create_common(char *, size_t);
+
+/*
+ * This wrapper takes an error buffer pointer and a type to use for the
+ * private data, and calls pcap_create_common(), passing it the error
+ * buffer pointer, the size for the private data type, in bytes, and the
+ * offset of the private data from the beginning of the structure, in
+ * bytes.
+ */
+#define PCAP_CREATE_COMMON(ebuf, type) \
+       pcap_create_common(ebuf, \
+           sizeof (struct { pcap_t __common; type __private; }), \
+           offsetof (struct { pcap_t __common; type __private; }, __private))
+pcap_t *pcap_create_common(char *, size_t, size_t);
 int    pcap_do_addexit(pcap_t *);
 void   pcap_add_to_pcaps_to_close(pcap_t *);
 void   pcap_remove_from_pcaps_to_close(pcap_t *);
 void   pcap_cleanup_live_common(pcap_t *);
 int    pcap_check_activated(pcap_t *);
+void   pcap_breakloop_common(pcap_t *);
 
 /*
  * Internal interfaces for "pcap_findalldevs()".
  *
+ * A pcap_if_list_t * is a reference to a list of devices.
+ *
+ * A get_if_flags_func is a platform-dependent function called to get
+ * additional interface flags.
+ *
  * "pcap_platform_finddevs()" is the platform-dependent routine to
  * find local network interfaces.
  *
@@ -417,38 +522,115 @@ int      pcap_check_activated(pcap_t *);
  * "find_or_add_dev()" checks whether a device is already in a pcap_if_list_t
  * and, if not, adds an entry for it.
  */
-int    pcap_platform_finddevs(pcap_if_t **, char *);
+struct pcap_if_list;
+typedef struct pcap_if_list pcap_if_list_t;
+typedef int (*get_if_flags_func)(const char *, bpf_u_int32 *, char *);
+int    pcap_platform_finddevs(pcap_if_list_t *, char *);
 #if !defined(_WIN32) && !defined(MSDOS)
-int    pcap_findalldevs_interfaces(pcap_if_t **, char *,
-           int (*)(const char *));
+int    pcap_findalldevs_interfaces(pcap_if_list_t *, char *,
+           int (*)(const char *), get_if_flags_func);
 #endif
-pcap_if_t *find_or_add_dev(pcap_if_t **, const char *, bpf_u_int32,
-           const char *, char *);
-pcap_if_t *find_dev(pcap_if_t **, const char *);
-pcap_if_t *add_dev(pcap_if_t **, const char *, bpf_u_int32, const char *,
+pcap_if_t *find_or_add_dev(pcap_if_list_t *, const char *, bpf_u_int32,
+           get_if_flags_func, const char *, char *);
+pcap_if_t *find_dev(pcap_if_list_t *, const char *);
+pcap_if_t *add_dev(pcap_if_list_t *, const char *, bpf_u_int32, const char *,
            char *);
 int    add_addr_to_dev(pcap_if_t *, struct sockaddr *, size_t,
            struct sockaddr *, size_t, struct sockaddr *, size_t,
            struct sockaddr *dstaddr, size_t, char *errbuf);
 #ifndef _WIN32
-bpf_u_int32 if_flags_to_pcap_flags(const char *, u_int);
-int    add_addr_to_iflist(pcap_if_t **, const char *, bpf_u_int32,
+pcap_if_t *find_or_add_if(pcap_if_list_t *, const char *, bpf_u_int32,
+           get_if_flags_func, char *);
+int    add_addr_to_if(pcap_if_list_t *, const char *, bpf_u_int32,
+           get_if_flags_func,
            struct sockaddr *, size_t, struct sockaddr *, size_t,
            struct sockaddr *, size_t, struct sockaddr *, size_t, char *);
 #endif
 
 /*
- * Internal interfaces for "pcap_open_offline()".
+ * Internal interfaces for "pcap_open_offline()" and other savefile
+ * I/O routines.
  *
  * "pcap_open_offline_common()" allocates and fills in a pcap_t, for use
  * by pcap_open_offline routines.
  *
+ * "pcap_adjust_snapshot()" adjusts the snapshot to be non-zero and
+ * fit within an int.
+ *
  * "sf_cleanup()" closes the file handle associated with a pcap_t, if
  * appropriate, and frees all data common to all modules for handling
  * savefile types.
+ *
+ * "charset_fopen()", in UTF-8 mode on Windows, does an fopen() that
+ * treats the pathname as being in UTF-8, rather than the local
+ * code page, on Windows.
  */
-pcap_t *pcap_open_offline_common(char *ebuf, size_t size);
+
+/*
+ * This wrapper takes an error buffer pointer and a type to use for the
+ * private data, and calls pcap_create_common(), passing it the error
+ * buffer pointer, the size for the private data type, in bytes, and the
+ * offset of the private data from the beginning of the structure, in
+ * bytes.
+ */
+#define PCAP_OPEN_OFFLINE_COMMON(ebuf, type) \
+       pcap_open_offline_common(ebuf, \
+           sizeof (struct { pcap_t __common; type __private; }), \
+           offsetof (struct { pcap_t __common; type __private; }, __private))
+pcap_t *pcap_open_offline_common(char *ebuf, size_t total_size,
+    size_t private_data);
+bpf_u_int32 pcap_adjust_snapshot(bpf_u_int32 linktype, bpf_u_int32 snaplen);
 void   sf_cleanup(pcap_t *p);
+#ifdef _WIN32
+FILE   *charset_fopen(const char *path, const char *mode);
+#else
+/*
+ * On other OSes, just use Boring Old fopen().
+ */
+#define charset_fopen(path, mode)      fopen((path), (mode))
+#endif
+
+/*
+ * Internal interfaces for loading code at run time.
+ */
+#ifdef _WIN32
+#define pcap_code_handle_t     HMODULE
+#define pcap_funcptr_t         FARPROC
+
+pcap_code_handle_t     pcap_load_code(const char *);
+pcap_funcptr_t         pcap_find_function(pcap_code_handle_t, const char *);
+#endif
+
+/*
+ * Internal interfaces for doing user-mode filtering of packets and
+ * validating filter programs.
+ */
+/*
+ * Auxiliary data, for use when interpreting a filter intended for the
+ * Linux kernel when the kernel rejects the filter (requiring us to
+ * run it in userland).  It contains VLAN tag information.
+ */
+struct pcap_bpf_aux_data {
+       u_short vlan_tag_present;
+       u_short vlan_tag;
+};
+
+/*
+ * Filtering routine that takes the auxiliary data as an additional
+ * argument.
+ */
+u_int  pcap_filter_with_aux_data(const struct bpf_insn *,
+    const u_char *, u_int, u_int, const struct pcap_bpf_aux_data *);
+
+/*
+ * Filtering routine that doesn't.
+ */
+u_int  pcap_filter(const struct bpf_insn *, const u_char *, u_int, u_int);
+
+/*
+ * Routine to validate a BPF program.
+ */
+int    pcap_validate_filter(const struct bpf_insn *, int);
 
 /*
  * Internal interfaces for both "pcap_create()" and routines that
@@ -459,14 +641,24 @@ void      sf_cleanup(pcap_t *p);
  */
 void   pcap_oneshot(u_char *, const struct pcap_pkthdr *, const u_char *);
 
-#ifdef _WIN32
-void   pcap_win32_err_to_str(DWORD, char *);
-#endif
-
 int    install_bpf_program(pcap_t *, struct bpf_program *);
 
 int    pcap_strcasecmp(const char *, const char *);
 
+/*
+ * Internal interfaces for pcap_createsrcstr and pcap_parsesrcstr with
+ * the additional bit of information regarding SSL support (rpcap:// vs.
+ * rpcaps://).
+ */
+int    pcap_createsrcstr_ex(char *, int, const char *, const char *,
+    const char *, unsigned char, char *);
+int    pcap_parsesrcstr_ex(const char *, int *, char *, char *,
+    char *, unsigned char *, char *);
+
+#ifdef YYDEBUG
+extern int pcap_debug;
+#endif
+
 #ifdef __cplusplus
 }
 #endif