contrib/libpcap/pcap-int.h

   1 /*
   2  * Copyright (c) 1994, 1995, 1996
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the Computer Systems
  16  *      Engineering Group at Lawrence Berkeley Laboratory.
  17  * 4. Neither the name of the University nor of the Laboratory may be used
  18  *    to endorse or promote products derived from this software without
  19  *    specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 #ifndef pcap_int_h
  35 #define pcap_int_h
  36
  37 #include <signal.h>
  38
  39 #include <pcap/pcap.h>
  40
  41 #include "varattrs.h"
  42 #include "fmtutils.h"
  43
  44 /*
  45  * Version string.
  46  * Uses PACKAGE_VERSION from config.h.
  47  */
  48 #define PCAP_VERSION_STRING "libpcap version " PACKAGE_VERSION
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54 #ifdef MSDOS
  55   #include <fcntl.h>
  56   #include <io.h>
  57 #endif
  58
  59 /*
  60  * Swap byte ordering of unsigned long long timestamp on a big endian
  61  * machine.
  62  */
  63 #define SWAPLL(ull)  ((ull & 0xff00000000000000ULL) >> 56) | \
  64                       ((ull & 0x00ff000000000000ULL) >> 40) | \
  65                       ((ull & 0x0000ff0000000000ULL) >> 24) | \
  66                       ((ull & 0x000000ff00000000ULL) >> 8)  | \
  67                       ((ull & 0x00000000ff000000ULL) << 8)  | \
  68                       ((ull & 0x0000000000ff0000ULL) << 24) | \
  69                       ((ull & 0x000000000000ff00ULL) << 40) | \
  70                       ((ull & 0x00000000000000ffULL) << 56)
  71
  72 /*
  73  * Maximum snapshot length.
  74  *
  75  * Somewhat arbitrary, but chosen to be:
  76  *
  77  *    1) big enough for maximum-size Linux loopback packets (65549)
  78  *       and some USB packets captured with USBPcap:
  79  *
  80  *           http://desowin.org/usbpcap/
  81  *
  82  *       (> 131072, < 262144)
  83  *
  84  * and
  85  *
  86  *    2) small enough not to cause attempts to allocate huge amounts of
  87  *       memory; some applications might use the snapshot length in a
  88  *       savefile header to control the size of the buffer they allocate,
  89  *       so a size of, say, 2^31-1 might not work well.  (libpcap uses it
  90  *       as a hint, but doesn't start out allocating a buffer bigger than
  91  *       2 KiB, and grows the buffer as necessary, but not beyond the
  92  *       per-linktype maximum snapshot length.  Other code might naively
  93  *       use it; we want to avoid writing a too-large snapshot length,
  94  *       in order not to cause that code problems.)
  95  *
  96  * We don't enforce this in pcap_set_snaplen(), but we use it internally.
  97  */
  98 #define MAXIMUM_SNAPLEN         262144
  99
 100 struct pcap_opt {
 101         char    *device;
 102         int     timeout;        /* timeout for buffering */
 103         u_int   buffer_size;
 104         int     promisc;
 105         int     rfmon;          /* monitor mode */
 106         int     immediate;      /* immediate mode - deliver packets as soon as they arrive */
 107         int     nonblock;       /* non-blocking mode - don't wait for packets to be delivered, return "no packets available" */
 108         int     tstamp_type;
 109         int     tstamp_precision;
 110
 111         /*
 112          * Platform-dependent options.
 113          */
 114 #ifdef __linux__
 115         int     protocol;       /* protocol to use when creating PF_PACKET socket */
 116 #endif
 117 #ifdef _WIN32
 118         int     nocapture_local;/* disable NPF loopback */
 119 #endif
 120 };
 121
 122 typedef int     (*activate_op_t)(pcap_t *);
 123 typedef int     (*can_set_rfmon_op_t)(pcap_t *);
 124 typedef int     (*read_op_t)(pcap_t *, int cnt, pcap_handler, u_char *);
 125 typedef int     (*next_packet_op_t)(pcap_t *, struct pcap_pkthdr *, u_char **);
 126 typedef int     (*inject_op_t)(pcap_t *, const void *, size_t);
 127 typedef void    (*save_current_filter_op_t)(pcap_t *, const char *);
 128 typedef int     (*setfilter_op_t)(pcap_t *, struct bpf_program *);
 129 typedef int     (*setdirection_op_t)(pcap_t *, pcap_direction_t);
 130 typedef int     (*set_datalink_op_t)(pcap_t *, int);
 131 typedef int     (*getnonblock_op_t)(pcap_t *);
 132 typedef int     (*setnonblock_op_t)(pcap_t *, int);
 133 typedef int     (*stats_op_t)(pcap_t *, struct pcap_stat *);
 134 #ifdef _WIN32
 135 typedef struct pcap_stat *(*stats_ex_op_t)(pcap_t *, int *);
 136 typedef int     (*setbuff_op_t)(pcap_t *, int);
 137 typedef int     (*setmode_op_t)(pcap_t *, int);
 138 typedef int     (*setmintocopy_op_t)(pcap_t *, int);
 139 typedef HANDLE  (*getevent_op_t)(pcap_t *);
 140 typedef int     (*oid_get_request_op_t)(pcap_t *, bpf_u_int32, void *, size_t *);
 141 typedef int     (*oid_set_request_op_t)(pcap_t *, bpf_u_int32, const void *, size_t *);
 142 typedef u_int   (*sendqueue_transmit_op_t)(pcap_t *, pcap_send_queue *, int);
 143 typedef int     (*setuserbuffer_op_t)(pcap_t *, int);
 144 typedef int     (*live_dump_op_t)(pcap_t *, char *, int, int);
 145 typedef int     (*live_dump_ended_op_t)(pcap_t *, int);
 146 typedef PAirpcapHandle  (*get_airpcap_handle_op_t)(pcap_t *);
 147 #endif
 148 typedef void    (*cleanup_op_t)(pcap_t *);
 149
 150 /*
 151  * We put all the stuff used in the read code path at the beginning,
 152  * to try to keep it together in the same cache line or lines.
 153  */
 154 struct pcap {
 155         /*
 156          * Method to call to read packets on a live capture.
 157          */
 158         read_op_t read_op;
 159
 160         /*
 161          * Method to call to read the next packet from a savefile.
 162          */
 163         next_packet_op_t next_packet_op;
 164
 165 #ifdef _WIN32
 166         HANDLE handle;
 167 #else
 168         int fd;
 169 #endif /* _WIN32 */
 170
 171         /*
 172          * Read buffer.
 173          */
 174         u_int bufsize;
 175         void *buffer;
 176         u_char *bp;
 177         int cc;
 178
 179         sig_atomic_t break_loop; /* flag set to force break from packet-reading loop */
 180
 181         void *priv;             /* private data for methods */
 182
 183 #ifdef ENABLE_REMOTE
 184         struct pcap_samp rmt_samp;      /* parameters related to the sampling process. */
 185 #endif
 186
 187         int swapped;
 188         FILE *rfile;            /* null if live capture, non-null if savefile */
 189         u_int fddipad;
 190         struct pcap *next;      /* list of open pcaps that need stuff cleared on close */
 191
 192         /*
 193          * File version number; meaningful only for a savefile, but we
 194          * keep it here so that apps that (mistakenly) ask for the
 195          * version numbers will get the same zero values that they
 196          * always did.
 197          */
 198         int version_major;
 199         int version_minor;
 200
 201         int snapshot;
 202         int linktype;           /* Network linktype */
 203         int linktype_ext;       /* Extended information stored in the linktype field of a file */
 204         int tzoff;              /* timezone offset */
 205         int offset;             /* offset for proper alignment */
 206         int activated;          /* true if the capture is really started */
 207         int oldstyle;           /* if we're opening with pcap_open_live() */
 208
 209         struct pcap_opt opt;
 210
 211         /*
 212          * Place holder for pcap_next().
 213          */
 214         u_char *pkt;
 215
 216 #ifdef _WIN32
 217         struct pcap_stat stat;  /* used for pcap_stats_ex() */
 218 #endif
 219
 220         /* We're accepting only packets in this direction/these directions. */
 221         pcap_direction_t direction;
 222
 223         /*
 224          * Flags to affect BPF code generation.
 225          */
 226         int bpf_codegen_flags;
 227
 228 #if !defined(_WIN32) && !defined(MSDOS)
 229         int selectable_fd;      /* FD on which select()/poll()/epoll_wait()/kevent()/etc. can be done */
 230
 231         /*
 232          * In case there either is no selectable FD, or there is but
 233          * it doesn't necessarily work (e.g., if it doesn't get notified
 234          * if the packet capture timeout expires before the buffer
 235          * fills up), this points to a timeout that should be used
 236          * in select()/poll()/epoll_wait()/kevent() call.  The pcap_t should
 237          * be put into non-blocking mode, and, if the timeout expires on
 238          * the call, an attempt should be made to read packets from all
 239          * pcap_t's with a required timeout, and the code must be
 240          * prepared not to see any packets from the attempt.
 241          */
 242         struct timeval *required_select_timeout;
 243 #endif
 244
 245         /*
 246          * Placeholder for filter code if bpf not in kernel.
 247          */
 248         struct bpf_program fcode;
 249
 250         char errbuf[PCAP_ERRBUF_SIZE + 1];
 251         int dlt_count;
 252         u_int *dlt_list;
 253         int tstamp_type_count;
 254         u_int *tstamp_type_list;
 255         int tstamp_precision_count;
 256         u_int *tstamp_precision_list;
 257
 258         struct pcap_pkthdr pcap_header; /* This is needed for the pcap_next_ex() to work */
 259
 260         /*
 261          * More methods.
 262          */
 263         activate_op_t activate_op;
 264         can_set_rfmon_op_t can_set_rfmon_op;
 265         inject_op_t inject_op;
 266         save_current_filter_op_t save_current_filter_op;
 267         setfilter_op_t setfilter_op;
 268         setdirection_op_t setdirection_op;
 269         set_datalink_op_t set_datalink_op;
 270         getnonblock_op_t getnonblock_op;
 271         setnonblock_op_t setnonblock_op;
 272         stats_op_t stats_op;
 273
 274         /*
 275          * Routine to use as callback for pcap_next()/pcap_next_ex().
 276          */
 277         pcap_handler oneshot_callback;
 278
 279 #ifdef _WIN32
 280         /*
 281          * These are, at least currently, specific to the Win32 NPF
 282          * driver.
 283          */
 284         stats_ex_op_t stats_ex_op;
 285         setbuff_op_t setbuff_op;
 286         setmode_op_t setmode_op;
 287         setmintocopy_op_t setmintocopy_op;
 288         getevent_op_t getevent_op;
 289         oid_get_request_op_t oid_get_request_op;
 290         oid_set_request_op_t oid_set_request_op;
 291         sendqueue_transmit_op_t sendqueue_transmit_op;
 292         setuserbuffer_op_t setuserbuffer_op;
 293         live_dump_op_t live_dump_op;
 294         live_dump_ended_op_t live_dump_ended_op;
 295         get_airpcap_handle_op_t get_airpcap_handle_op;
 296 #endif
 297         cleanup_op_t cleanup_op;
 298 };
 299
 300 /*
 301  * BPF code generation flags.
 302  */
 303 #define BPF_SPECIAL_VLAN_HANDLING       0x00000001      /* special VLAN handling for Linux */
 304
 305 /*
 306  * This is a timeval as stored in a savefile.
 307  * It has to use the same types everywhere, independent of the actual
 308  * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some
 309  * platforms and 64-bit tv_sec values on other platforms, and writing
 310  * out native `struct timeval' values would mean files could only be
 311  * read on systems with the same tv_sec size as the system on which
 312  * the file was written.
 313  */
 314
 315 struct pcap_timeval {
 316     bpf_int32 tv_sec;           /* seconds */
 317     bpf_int32 tv_usec;          /* microseconds */
 318 };
 319
 320 /*
 321  * This is a `pcap_pkthdr' as actually stored in a savefile.
 322  *
 323  * Do not change the format of this structure, in any way (this includes
 324  * changes that only affect the length of fields in this structure),
 325  * and do not make the time stamp anything other than seconds and
 326  * microseconds (e.g., seconds and nanoseconds).  Instead:
 327  *
 328  *      introduce a new structure for the new format;
 329  *
 330  *      send mail to "tcpdump-workers@lists.tcpdump.org", requesting
 331  *      a new magic number for your new capture file format, and, when
 332  *      you get the new magic number, put it in "savefile.c";
 333  *
 334  *      use that magic number for save files with the changed record
 335  *      header;
 336  *
 337  *      make the code in "savefile.c" capable of reading files with
 338  *      the old record header as well as files with the new record header
 339  *      (using the magic number to determine the header format).
 340  *
 341  * Then supply the changes by forking the branch at
 342  *
 343  *      https://github.com/the-tcpdump-group/libpcap/issues
 344  *
 345  * and issuing a pull request, so that future versions of libpcap and
 346  * programs that use it (such as tcpdump) will be able to read your new
 347  * capture file format.
 348  */
 349
 350 struct pcap_sf_pkthdr {
 351     struct pcap_timeval ts;     /* time stamp */
 352     bpf_u_int32 caplen;         /* length of portion present */
 353     bpf_u_int32 len;            /* length this packet (off wire) */
 354 };
 355
 356 /*
 357  * How a `pcap_pkthdr' is actually stored in savefiles written
 358  * by some patched versions of libpcap (e.g. the ones in Red
 359  * Hat Linux 6.1 and 6.2).
 360  *
 361  * Do not change the format of this structure, in any way (this includes
 362  * changes that only affect the length of fields in this structure).
 363  * Instead, introduce a new structure, as per the above.
 364  */
 365
 366 struct pcap_sf_patched_pkthdr {
 367     struct pcap_timeval ts;     /* time stamp */
 368     bpf_u_int32 caplen;         /* length of portion present */
 369     bpf_u_int32 len;            /* length this packet (off wire) */
 370     int         index;
 371     unsigned short protocol;
 372     unsigned char pkt_type;
 373 };
 374
 375 /*
 376  * User data structure for the one-shot callback used for pcap_next()
 377  * and pcap_next_ex().
 378  */
 379 struct oneshot_userdata {
 380         struct pcap_pkthdr *hdr;
 381         const u_char **pkt;
 382         pcap_t *pd;
 383 };
 384
 385 #ifndef min
 386 #define min(a, b) ((a) > (b) ? (b) : (a))
 387 #endif
 388
 389 int     pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
 390
 391 #include <stdarg.h>
 392
 393 #include "portability.h"
 394
 395 /*
 396  * Does the packet count argument to a module's read routine say
 397  * "supply packets until you run out of packets"?
 398  */
 399 #define PACKET_COUNT_IS_UNLIMITED(count)        ((count) <= 0)
 400
 401 /*
 402  * Routines that most pcap implementations can use for non-blocking mode.
 403  */
 404 #if !defined(_WIN32) && !defined(MSDOS)
 405 int     pcap_getnonblock_fd(pcap_t *);
 406 int     pcap_setnonblock_fd(pcap_t *p, int);
 407 #endif
 408
 409 /*
 410  * Internal interfaces for "pcap_create()".
 411  *
 412  * "pcap_create_interface()" is the routine to do a pcap_create on
 413  * a regular network interface.  There are multiple implementations
 414  * of this, one for each platform type (Linux, BPF, DLPI, etc.),
 415  * with the one used chosen by the configure script.
 416  *
 417  * "pcap_create_common()" allocates and fills in a pcap_t, for use
 418  * by pcap_create routines.
 419  */
 420 pcap_t  *pcap_create_interface(const char *, char *);
 421 pcap_t  *pcap_create_common(char *, size_t);
 422 int     pcap_do_addexit(pcap_t *);
 423 void    pcap_add_to_pcaps_to_close(pcap_t *);
 424 void    pcap_remove_from_pcaps_to_close(pcap_t *);
 425 void    pcap_cleanup_live_common(pcap_t *);
 426 int     pcap_check_activated(pcap_t *);
 427
 428 /*
 429  * Internal interfaces for "pcap_findalldevs()".
 430  *
 431  * A pcap_if_list_t * is a reference to a list of devices.
 432  *
 433  * A get_if_flags_func is a platform-dependent function called to get
 434  * additional interface flags.
 435  *
 436  * "pcap_platform_finddevs()" is the platform-dependent routine to
 437  * find local network interfaces.
 438  *
 439  * "pcap_findalldevs_interfaces()" is a helper to find those interfaces
 440  * using the "standard" mechanisms (SIOCGIFCONF, "getifaddrs()", etc.).
 441  *
 442  * "add_dev()" adds an entry to a pcap_if_list_t.
 443  *
 444  * "find_dev()" tries to find a device, by name, in a pcap_if_list_t.
 445  *
 446  * "find_or_add_dev()" checks whether a device is already in a pcap_if_list_t
 447  * and, if not, adds an entry for it.
 448  */
 449 struct pcap_if_list;
 450 typedef struct pcap_if_list pcap_if_list_t;
 451 typedef int (*get_if_flags_func)(const char *, bpf_u_int32 *, char *);
 452 int     pcap_platform_finddevs(pcap_if_list_t *, char *);
 453 #if !defined(_WIN32) && !defined(MSDOS)
 454 int     pcap_findalldevs_interfaces(pcap_if_list_t *, char *,
 455             int (*)(const char *), get_if_flags_func);
 456 #endif
 457 pcap_if_t *find_or_add_dev(pcap_if_list_t *, const char *, bpf_u_int32,
 458             get_if_flags_func, const char *, char *);
 459 pcap_if_t *find_dev(pcap_if_list_t *, const char *);
 460 pcap_if_t *add_dev(pcap_if_list_t *, const char *, bpf_u_int32, const char *,
 461             char *);
 462 int     add_addr_to_dev(pcap_if_t *, struct sockaddr *, size_t,
 463             struct sockaddr *, size_t, struct sockaddr *, size_t,
 464             struct sockaddr *dstaddr, size_t, char *errbuf);
 465 #ifndef _WIN32
 466 pcap_if_t *find_or_add_if(pcap_if_list_t *, const char *, bpf_u_int32,
 467             get_if_flags_func, char *);
 468 int     add_addr_to_if(pcap_if_list_t *, const char *, bpf_u_int32,
 469             get_if_flags_func,
 470             struct sockaddr *, size_t, struct sockaddr *, size_t,
 471             struct sockaddr *, size_t, struct sockaddr *, size_t, char *);
 472 #endif
 473
 474 /*
 475  * Internal interfaces for "pcap_open_offline()".
 476  *
 477  * "pcap_open_offline_common()" allocates and fills in a pcap_t, for use
 478  * by pcap_open_offline routines.
 479  *
 480  * "pcap_adjust_snapshot()" adjusts the snapshot to be non-zero and
 481  * fit within an int.
 482  *
 483  * "sf_cleanup()" closes the file handle associated with a pcap_t, if
 484  * appropriate, and frees all data common to all modules for handling
 485  * savefile types.
 486  */
 487 pcap_t  *pcap_open_offline_common(char *ebuf, size_t size);
 488 bpf_u_int32 pcap_adjust_snapshot(bpf_u_int32 linktype, bpf_u_int32 snaplen);
 489 void    sf_cleanup(pcap_t *p);
 490
 491 /*
 492  * Internal interfaces for doing user-mode filtering of packets and
 493  * validating filter programs.
 494  */
 495 /*
 496  * Auxiliary data, for use when interpreting a filter intended for the
 497  * Linux kernel when the kernel rejects the filter (requiring us to
 498  * run it in userland).  It contains VLAN tag information.
 499  */
 500 struct bpf_aux_data {
 501         u_short vlan_tag_present;
 502         u_short vlan_tag;
 503 };
 504
 505 /*
 506  * Filtering routine that takes the auxiliary data as an additional
 507  * argument.
 508  */
 509 u_int   bpf_filter_with_aux_data(const struct bpf_insn *,
 510     const u_char *, u_int, u_int, const struct bpf_aux_data *);
 511
 512 /*
 513  * Internal interfaces for both "pcap_create()" and routines that
 514  * open savefiles.
 515  *
 516  * "pcap_oneshot()" is the standard one-shot callback for "pcap_next()"
 517  * and "pcap_next_ex()".
 518  */
 519 void    pcap_oneshot(u_char *, const struct pcap_pkthdr *, const u_char *);
 520
 521 int     install_bpf_program(pcap_t *, struct bpf_program *);
 522
 523 int     pcap_strcasecmp(const char *, const char *);
 524
 525 #ifdef YYDEBUG
 526 extern int pcap_debug;
 527 #endif
 528
 529 #ifdef __cplusplus
 530 }
 531 #endif
 532
 533 #endif