]> 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 ec643eba3359d9e16427b1a334627330470e260a..894e74afa85305b1db1524ff251670aba9a71b50 100644 (file)
 #ifndef pcap_int_h
 #define        pcap_int_h
 
+#include <stddef.h>
+
 #include <signal.h>
 
 #include <pcap/pcap.h>
 
+#ifdef MSDOS
+  #include <fcntl.h>
+  #include <io.h>
+#endif
+
 #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)
+  /*
+   * Compiler is MSVC.  Make sure we have VS 2015 or later.
+   */
+  #if _MSC_VER < 1900
+    #error "Building libpcap requires VS 2015 or later"
+  #endif
+#endif
+
 /*
  * Version string.
  * Uses PACKAGE_VERSION from config.h.
 extern "C" {
 #endif
 
-#ifdef MSDOS
-  #include <fcntl.h>
-  #include <io.h>
-#endif
+/*
+ * 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().
+ */
+extern int pcap_new_api;
+
+/*
+ * 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
@@ -77,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)
  *
@@ -86,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 */
@@ -196,7 +264,7 @@ struct pcap {
 
        int snapshot;
        int linktype;           /* Network linktype */
-       int linktype_ext;       /* Extended information stored in the linktype field of a file */
+       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() */
@@ -234,7 +302,7 @@ struct pcap {
         * pcap_t's with a required timeout, and the code must be
         * prepared not to see any packets from the attempt.
         */
-       struct timeval *required_select_timeout;
+       const struct timeval *required_select_timeout;
 #endif
 
        /*
@@ -243,6 +311,9 @@ struct pcap {
        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;
@@ -336,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
@@ -346,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) */
 };
 
 /*
@@ -362,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;
@@ -384,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"?
@@ -414,7 +481,19 @@ int        pcap_setnonblock_fd(pcap_t *p, int);
  * 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 *);
@@ -469,17 +548,58 @@ int       add_addr_to_if(pcap_if_list_t *, const char *, bpf_u_int32,
 #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.
+ */
+
+/*
+ * 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.
  */
-pcap_t *pcap_open_offline_common(char *ebuf, size_t size);
+#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
@@ -490,7 +610,7 @@ void        sf_cleanup(pcap_t *p);
  * Linux kernel when the kernel rejects the filter (requiring us to
  * run it in userland).  It contains VLAN tag information.
  */
-struct bpf_aux_data {
+struct pcap_bpf_aux_data {
        u_short vlan_tag_present;
        u_short vlan_tag;
 };
@@ -500,7 +620,7 @@ struct bpf_aux_data {
  * argument.
  */
 u_int  pcap_filter_with_aux_data(const struct bpf_insn *,
-    const u_char *, u_int, u_int, const struct bpf_aux_data *);
+    const u_char *, u_int, u_int, const struct pcap_bpf_aux_data *);
 
 /*
  * Filtering routine that doesn't.
@@ -521,20 +641,19 @@ int       pcap_validate_filter(const struct bpf_insn *, int);
  */
 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 interface for pcap_parsesrcstr with the additional bit of
- * information regarding SSL support (rpcap:// vs rpcaps://)
+ * Internal interfaces for pcap_createsrcstr and pcap_parsesrcstr with
+ * the additional bit of information regarding SSL support (rpcap:// vs.
+ * rpcaps://).
  */
-int pcap_parsesrcstr_ex(const char *source, int *type, char *host, char *port,
-                        char *name, unsigned char *uses_ssl, char *errbuf);
+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;