pcap/pcap.h

   1 /* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */
   2 /*
   3  * Copyright (c) 1993, 1994, 1995, 1996, 1997
   4  *      The Regents of the University of California.  All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. All advertising materials mentioning features or use of this software
  15  *    must display the following acknowledgement:
  16  *      This product includes software developed by the Computer Systems
  17  *      Engineering Group at Lawrence Berkeley Laboratory.
  18  * 4. Neither the name of the University nor of the Laboratory may be used
  19  *    to endorse or promote products derived from this software without
  20  *    specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34
  35 /*
  36  * Remote packet capture mechanisms and extensions from WinPcap:
  37  *
  38  * Copyright (c) 2002 - 2003
  39  * NetGroup, Politecnico di Torino (Italy)
  40  * All rights reserved.
  41  *
  42  * Redistribution and use in source and binary forms, with or without
  43  * modification, are permitted provided that the following conditions
  44  * are met:
  45  *
  46  * 1. Redistributions of source code must retain the above copyright
  47  * notice, this list of conditions and the following disclaimer.
  48  * 2. Redistributions in binary form must reproduce the above copyright
  49  * notice, this list of conditions and the following disclaimer in the
  50  * documentation and/or other materials provided with the distribution.
  51  * 3. Neither the name of the Politecnico di Torino nor the names of its
  52  * contributors may be used to endorse or promote products derived from
  53  * this software without specific prior written permission.
  54  *
  55  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  56  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  57  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  58  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  59  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  60  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  61  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  62  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  63  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  64  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  65  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  66  *
  67  */
  68
  69 #ifndef lib_pcap_pcap_h
  70 #define lib_pcap_pcap_h
  71
  72 #include <pcap/funcattrs.h>
  73
  74 #include <pcap/pcap-inttypes.h>
  75
  76 #if defined(_WIN32)
  77   #include <winsock2.h>         /* u_int, u_char etc. */
  78   #include <io.h>               /* _get_osfhandle() */
  79 #elif defined(MSDOS)
  80   #include <sys/types.h>        /* u_int, u_char etc. */
  81   #include <sys/socket.h>
  82 #else /* UN*X */
  83   #include <sys/types.h>        /* u_int, u_char etc. */
  84   #include <sys/time.h>
  85 #endif /* _WIN32/MSDOS/UN*X */
  86
  87 #ifndef PCAP_DONT_INCLUDE_PCAP_BPF_H
  88 #include <pcap/bpf.h>
  89 #endif
  90
  91 #include <stdio.h>
  92
  93 #ifdef __cplusplus
  94 extern "C" {
  95 #endif
  96
  97 /*
  98  * Version number of the current version of the pcap file format.
  99  *
 100  * NOTE: this is *NOT* the version number of the libpcap library.
 101  * To fetch the version information for the version of libpcap
 102  * you're using, use pcap_lib_version().
 103  */
 104 #define PCAP_VERSION_MAJOR 2
 105 #define PCAP_VERSION_MINOR 4
 106
 107 #define PCAP_ERRBUF_SIZE 256
 108
 109 /*
 110  * Compatibility for systems that have a bpf.h that
 111  * predates the bpf typedefs for 64-bit support.
 112  */
 113 #if BPF_RELEASE - 0 < 199406
 114 typedef int bpf_int32;
 115 typedef u_int bpf_u_int32;
 116 #endif
 117
 118 typedef struct pcap pcap_t;
 119 typedef struct pcap_dumper pcap_dumper_t;
 120 typedef struct pcap_if pcap_if_t;
 121 typedef struct pcap_addr pcap_addr_t;
 122
 123 /*
 124  * The first record in the file contains saved values for some
 125  * of the flags used in the printout phases of tcpdump.
 126  * Many fields here are 32 bit ints so compilers won't insert unwanted
 127  * padding; these files need to be interchangeable across architectures.
 128  *
 129  * Do not change the layout of this structure, in any way (this includes
 130  * changes that only affect the length of fields in this structure).
 131  *
 132  * Also, do not change the interpretation of any of the members of this
 133  * structure, in any way (this includes using values other than
 134  * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
 135  * field).
 136  *
 137  * Instead:
 138  *
 139  *      introduce a new structure for the new format, if the layout
 140  *      of the structure changed;
 141  *
 142  *      send mail to "tcpdump-workers@lists.tcpdump.org", requesting
 143  *      a new magic number for your new capture file format, and, when
 144  *      you get the new magic number, put it in "savefile.c";
 145  *
 146  *      use that magic number for save files with the changed file
 147  *      header;
 148  *
 149  *      make the code in "savefile.c" capable of reading files with
 150  *      the old file header as well as files with the new file header
 151  *      (using the magic number to determine the header format).
 152  *
 153  * Then supply the changes by forking the branch at
 154  *
 155  *      https://github.com/the-tcpdump-group/libpcap/issues
 156  *
 157  * and issuing a pull request, so that future versions of libpcap and
 158  * programs that use it (such as tcpdump) will be able to read your new
 159  * capture file format.
 160  */
 161 struct pcap_file_header {
 162         bpf_u_int32 magic;
 163         u_short version_major;
 164         u_short version_minor;
 165         bpf_int32 thiszone;     /* gmt to local correction */
 166         bpf_u_int32 sigfigs;    /* accuracy of timestamps */
 167         bpf_u_int32 snaplen;    /* max length saved portion of each pkt */
 168         bpf_u_int32 linktype;   /* data link type (LINKTYPE_*) */
 169 };
 170
 171 /*
 172  * Macros for the value returned by pcap_datalink_ext().
 173  *
 174  * If LT_FCS_LENGTH_PRESENT(x) is true, the LT_FCS_LENGTH(x) macro
 175  * gives the FCS length of packets in the capture.
 176  */
 177 #define LT_FCS_LENGTH_PRESENT(x)        ((x) & 0x04000000)
 178 #define LT_FCS_LENGTH(x)                (((x) & 0xF0000000) >> 28)
 179 #define LT_FCS_DATALINK_EXT(x)          ((((x) & 0xF) << 28) | 0x04000000)
 180
 181 typedef enum {
 182        PCAP_D_INOUT = 0,
 183        PCAP_D_IN,
 184        PCAP_D_OUT
 185 } pcap_direction_t;
 186
 187 /*
 188  * Generic per-packet information, as supplied by libpcap.
 189  *
 190  * The time stamp can and should be a "struct timeval", regardless of
 191  * whether your system supports 32-bit tv_sec in "struct timeval",
 192  * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit
 193  * and 64-bit applications.  The on-disk format of savefiles uses 32-bit
 194  * tv_sec (and tv_usec); this structure is irrelevant to that.  32-bit
 195  * and 64-bit versions of libpcap, even if they're on the same platform,
 196  * should supply the appropriate version of "struct timeval", even if
 197  * that's not what the underlying packet capture mechanism supplies.
 198  */
 199 struct pcap_pkthdr {
 200         struct timeval ts;      /* time stamp */
 201         bpf_u_int32 caplen;     /* length of portion present */
 202         bpf_u_int32 len;        /* length this packet (off wire) */
 203 };
 204
 205 /*
 206  * As returned by the pcap_stats()
 207  */
 208 struct pcap_stat {
 209         u_int ps_recv;          /* number of packets received */
 210         u_int ps_drop;          /* number of packets dropped */
 211         u_int ps_ifdrop;        /* drops by interface -- only supported on some platforms */
 212 #ifdef _WIN32
 213         u_int ps_capt;          /* number of packets that reach the application */
 214         u_int ps_sent;          /* number of packets sent by the server on the network */
 215         u_int ps_netdrop;       /* number of packets lost on the network */
 216 #endif /* _WIN32 */
 217 };
 218
 219 #ifdef MSDOS
 220 /*
 221  * As returned by the pcap_stats_ex()
 222  */
 223 struct pcap_stat_ex {
 224        u_long  rx_packets;        /* total packets received       */
 225        u_long  tx_packets;        /* total packets transmitted    */
 226        u_long  rx_bytes;          /* total bytes received         */
 227        u_long  tx_bytes;          /* total bytes transmitted      */
 228        u_long  rx_errors;         /* bad packets received         */
 229        u_long  tx_errors;         /* packet transmit problems     */
 230        u_long  rx_dropped;        /* no space in Rx buffers       */
 231        u_long  tx_dropped;        /* no space available for Tx    */
 232        u_long  multicast;         /* multicast packets received   */
 233        u_long  collisions;
 234
 235        /* detailed rx_errors: */
 236        u_long  rx_length_errors;
 237        u_long  rx_over_errors;    /* receiver ring buff overflow  */
 238        u_long  rx_crc_errors;     /* recv'd pkt with crc error    */
 239        u_long  rx_frame_errors;   /* recv'd frame alignment error */
 240        u_long  rx_fifo_errors;    /* recv'r fifo overrun          */
 241        u_long  rx_missed_errors;  /* recv'r missed packet         */
 242
 243        /* detailed tx_errors */
 244        u_long  tx_aborted_errors;
 245        u_long  tx_carrier_errors;
 246        u_long  tx_fifo_errors;
 247        u_long  tx_heartbeat_errors;
 248        u_long  tx_window_errors;
 249      };
 250 #endif
 251
 252 /*
 253  * Item in a list of interfaces.
 254  */
 255 struct pcap_if {
 256         struct pcap_if *next;
 257         char *name;             /* name to hand to "pcap_open_live()" */
 258         char *description;      /* textual description of interface, or NULL */
 259         struct pcap_addr *addresses;
 260         bpf_u_int32 flags;      /* PCAP_IF_ interface flags */
 261 };
 262
 263 #define PCAP_IF_LOOPBACK                                0x00000001      /* interface is loopback */
 264 #define PCAP_IF_UP                                      0x00000002      /* interface is up */
 265 #define PCAP_IF_RUNNING                                 0x00000004      /* interface is running */
 266 #define PCAP_IF_WIRELESS                                0x00000008      /* interface is wireless (*NOT* necessarily Wi-Fi!) */
 267 #define PCAP_IF_CONNECTION_STATUS                       0x00000030      /* connection status: */
 268 #define PCAP_IF_CONNECTION_STATUS_UNKNOWN               0x00000000      /* unknown */
 269 #define PCAP_IF_CONNECTION_STATUS_CONNECTED             0x00000010      /* connected */
 270 #define PCAP_IF_CONNECTION_STATUS_DISCONNECTED          0x00000020      /* disconnected */
 271 #define PCAP_IF_CONNECTION_STATUS_NOT_APPLICABLE        0x00000030      /* not applicable */
 272
 273 /*
 274  * Representation of an interface address.
 275  */
 276 struct pcap_addr {
 277         struct pcap_addr *next;
 278         struct sockaddr *addr;          /* address */
 279         struct sockaddr *netmask;       /* netmask for that address */
 280         struct sockaddr *broadaddr;     /* broadcast address for that address */
 281         struct sockaddr *dstaddr;       /* P2P destination address for that address */
 282 };
 283
 284 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
 285                              const u_char *);
 286
 287 /*
 288  * Error codes for the pcap API.
 289  * These will all be negative, so you can check for the success or
 290  * failure of a call that returns these codes by checking for a
 291  * negative value.
 292  */
 293 #define PCAP_ERROR                      -1      /* generic error code */
 294 #define PCAP_ERROR_BREAK                -2      /* loop terminated by pcap_breakloop */
 295 #define PCAP_ERROR_NOT_ACTIVATED        -3      /* the capture needs to be activated */
 296 #define PCAP_ERROR_ACTIVATED            -4      /* the operation can't be performed on already activated captures */
 297 #define PCAP_ERROR_NO_SUCH_DEVICE       -5      /* no such device exists */
 298 #define PCAP_ERROR_RFMON_NOTSUP         -6      /* this device doesn't support rfmon (monitor) mode */
 299 #define PCAP_ERROR_NOT_RFMON            -7      /* operation supported only in monitor mode */
 300 #define PCAP_ERROR_PERM_DENIED          -8      /* no permission to open the device */
 301 #define PCAP_ERROR_IFACE_NOT_UP         -9      /* interface isn't up */
 302 #define PCAP_ERROR_CANTSET_TSTAMP_TYPE  -10     /* this device doesn't support setting the time stamp type */
 303 #define PCAP_ERROR_PROMISC_PERM_DENIED  -11     /* you don't have permission to capture in promiscuous mode */
 304 #define PCAP_ERROR_TSTAMP_PRECISION_NOTSUP -12  /* the requested time stamp precision is not supported */
 305
 306 /*
 307  * Warning codes for the pcap API.
 308  * These will all be positive and non-zero, so they won't look like
 309  * errors.
 310  */
 311 #define PCAP_WARNING                    1       /* generic warning code */
 312 #define PCAP_WARNING_PROMISC_NOTSUP     2       /* this device doesn't support promiscuous mode */
 313 #define PCAP_WARNING_TSTAMP_TYPE_NOTSUP 3       /* the requested time stamp type is not supported */
 314
 315 /*
 316  * Value to pass to pcap_compile() as the netmask if you don't know what
 317  * the netmask is.
 318  */
 319 #define PCAP_NETMASK_UNKNOWN    0xffffffff
 320
 321 /*
 322  * We're deprecating pcap_lookupdev() for various reasons (not
 323  * thread-safe, can behave weirdly with WinPcap).  Callers
 324  * should use pcap_findalldevs() and use the first device.
 325  */
 326 PCAP_API char   *pcap_lookupdev(char *)
 327 PCAP_DEPRECATED(pcap_lookupdev, "use 'pcap_findalldevs' and use the first device");
 328
 329 PCAP_API int    pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
 330
 331 PCAP_API pcap_t *pcap_create(const char *, char *);
 332 PCAP_API int    pcap_set_snaplen(pcap_t *, int);
 333 PCAP_API int    pcap_set_promisc(pcap_t *, int);
 334 PCAP_API int    pcap_can_set_rfmon(pcap_t *);
 335 PCAP_API int    pcap_set_rfmon(pcap_t *, int);
 336 PCAP_API int    pcap_set_timeout(pcap_t *, int);
 337 PCAP_API int    pcap_set_tstamp_type(pcap_t *, int);
 338 PCAP_API int    pcap_set_immediate_mode(pcap_t *, int);
 339 PCAP_API int    pcap_set_buffer_size(pcap_t *, int);
 340 PCAP_API int    pcap_set_tstamp_precision(pcap_t *, int);
 341 PCAP_API int    pcap_get_tstamp_precision(pcap_t *);
 342 PCAP_API int    pcap_activate(pcap_t *);
 343
 344 PCAP_API int    pcap_list_tstamp_types(pcap_t *, int **);
 345 PCAP_API void   pcap_free_tstamp_types(int *);
 346 PCAP_API int    pcap_tstamp_type_name_to_val(const char *);
 347 PCAP_API const char *pcap_tstamp_type_val_to_name(int);
 348 PCAP_API const char *pcap_tstamp_type_val_to_description(int);
 349
 350 #ifdef __linux__
 351 PCAP_API int    pcap_set_protocol(pcap_t *, int);
 352 #endif
 353
 354 /*
 355  * Time stamp types.
 356  * Not all systems and interfaces will necessarily support all of these.
 357  *
 358  * A system that supports PCAP_TSTAMP_HOST is offering time stamps
 359  * provided by the host machine, rather than by the capture device,
 360  * but not committing to any characteristics of the time stamp;
 361  * it will not offer any of the PCAP_TSTAMP_HOST_ subtypes.
 362  *
 363  * PCAP_TSTAMP_HOST_LOWPREC is a time stamp, provided by the host machine,
 364  * that's low-precision but relatively cheap to fetch; it's normally done
 365  * using the system clock, so it's normally synchronized with times you'd
 366  * fetch from system calls.
 367  *
 368  * PCAP_TSTAMP_HOST_HIPREC is a time stamp, provided by the host machine,
 369  * that's high-precision; it might be more expensive to fetch.  It might
 370  * or might not be synchronized with the system clock, and might have
 371  * problems with time stamps for packets received on different CPUs,
 372  * depending on the platform.
 373  *
 374  * PCAP_TSTAMP_ADAPTER is a high-precision time stamp supplied by the
 375  * capture device; it's synchronized with the system clock.
 376  *
 377  * PCAP_TSTAMP_ADAPTER_UNSYNCED is a high-precision time stamp supplied by
 378  * the capture device; it's not synchronized with the system clock.
 379  *
 380  * Note that time stamps synchronized with the system clock can go
 381  * backwards, as the system clock can go backwards.  If a clock is
 382  * not in sync with the system clock, that could be because the
 383  * system clock isn't keeping accurate time, because the other
 384  * clock isn't keeping accurate time, or both.
 385  *
 386  * Note that host-provided time stamps generally correspond to the
 387  * time when the time-stamping code sees the packet; this could
 388  * be some unknown amount of time after the first or last bit of
 389  * the packet is received by the network adapter, due to batching
 390  * of interrupts for packet arrival, queueing delays, etc..
 391  */
 392 #define PCAP_TSTAMP_HOST                0       /* host-provided, unknown characteristics */
 393 #define PCAP_TSTAMP_HOST_LOWPREC        1       /* host-provided, low precision */
 394 #define PCAP_TSTAMP_HOST_HIPREC         2       /* host-provided, high precision */
 395 #define PCAP_TSTAMP_ADAPTER             3       /* device-provided, synced with the system clock */
 396 #define PCAP_TSTAMP_ADAPTER_UNSYNCED    4       /* device-provided, not synced with the system clock */
 397
 398 /*
 399  * Time stamp resolution types.
 400  * Not all systems and interfaces will necessarily support all of these
 401  * resolutions when doing live captures; all of them can be requested
 402  * when reading a savefile.
 403  */
 404 #define PCAP_TSTAMP_PRECISION_MICRO     0       /* use timestamps with microsecond precision, default */
 405 #define PCAP_TSTAMP_PRECISION_NANO      1       /* use timestamps with nanosecond precision */
 406
 407 PCAP_API pcap_t *pcap_open_live(const char *, int, int, int, char *);
 408 PCAP_API pcap_t *pcap_open_dead(int, int);
 409 PCAP_API pcap_t *pcap_open_dead_with_tstamp_precision(int, int, u_int);
 410 PCAP_API pcap_t *pcap_open_offline_with_tstamp_precision(const char *, u_int, char *);
 411 PCAP_API pcap_t *pcap_open_offline(const char *, char *);
 412 #ifdef _WIN32
 413   PCAP_API pcap_t  *pcap_hopen_offline_with_tstamp_precision(intptr_t, u_int, char *);
 414   PCAP_API pcap_t  *pcap_hopen_offline(intptr_t, char *);
 415   /*
 416    * If we're building libpcap, these are internal routines in savefile.c,
 417    * so we must not define them as macros.
 418    *
 419    * If we're not building libpcap, given that the version of the C runtime
 420    * with which libpcap was built might be different from the version
 421    * of the C runtime with which an application using libpcap was built,
 422    * and that a FILE structure may differ between the two versions of the
 423    * C runtime, calls to _fileno() must use the version of _fileno() in
 424    * the C runtime used to open the FILE *, not the version in the C
 425    * runtime with which libpcap was built.  (Maybe once the Universal CRT
 426    * rules the world, this will cease to be a problem.)
 427    */
 428   #ifndef BUILDING_PCAP
 429     #define pcap_fopen_offline_with_tstamp_precision(f,p,b) \
 430         pcap_hopen_offline_with_tstamp_precision(_get_osfhandle(_fileno(f)), p, b)
 431     #define pcap_fopen_offline(f,b) \
 432         pcap_hopen_offline(_get_osfhandle(_fileno(f)), b)
 433   #endif
 434 #else /*_WIN32*/
 435   PCAP_API pcap_t       *pcap_fopen_offline_with_tstamp_precision(FILE *, u_int, char *);
 436   PCAP_API pcap_t       *pcap_fopen_offline(FILE *, char *);
 437 #endif /*_WIN32*/
 438
 439 PCAP_API void   pcap_close(pcap_t *);
 440 PCAP_API int    pcap_loop(pcap_t *, int, pcap_handler, u_char *);
 441 PCAP_API int    pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
 442 PCAP_API const u_char *pcap_next(pcap_t *, struct pcap_pkthdr *);
 443 PCAP_API int    pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
 444 PCAP_API void   pcap_breakloop(pcap_t *);
 445 PCAP_API int    pcap_stats(pcap_t *, struct pcap_stat *);
 446 PCAP_API int    pcap_setfilter(pcap_t *, struct bpf_program *);
 447 PCAP_API int    pcap_setdirection(pcap_t *, pcap_direction_t);
 448 PCAP_API int    pcap_getnonblock(pcap_t *, char *);
 449 PCAP_API int    pcap_setnonblock(pcap_t *, int, char *);
 450 PCAP_API int    pcap_inject(pcap_t *, const void *, size_t);
 451 PCAP_API int    pcap_sendpacket(pcap_t *, const u_char *, int);
 452 PCAP_API const char *pcap_statustostr(int);
 453 PCAP_API const char *pcap_strerror(int);
 454 PCAP_API char   *pcap_geterr(pcap_t *);
 455 PCAP_API void   pcap_perror(pcap_t *, const char *);
 456 PCAP_API int    pcap_compile(pcap_t *, struct bpf_program *, const char *, int,
 457             bpf_u_int32);
 458 PCAP_API int    pcap_compile_nopcap(int, int, struct bpf_program *,
 459             const char *, int, bpf_u_int32);
 460 PCAP_API void   pcap_freecode(struct bpf_program *);
 461 PCAP_API int    pcap_offline_filter(const struct bpf_program *,
 462             const struct pcap_pkthdr *, const u_char *);
 463 PCAP_API int    pcap_datalink(pcap_t *);
 464 PCAP_API int    pcap_datalink_ext(pcap_t *);
 465 PCAP_API int    pcap_list_datalinks(pcap_t *, int **);
 466 PCAP_API int    pcap_set_datalink(pcap_t *, int);
 467 PCAP_API void   pcap_free_datalinks(int *);
 468 PCAP_API int    pcap_datalink_name_to_val(const char *);
 469 PCAP_API const char *pcap_datalink_val_to_name(int);
 470 PCAP_API const char *pcap_datalink_val_to_description(int);
 471 PCAP_API int    pcap_snapshot(pcap_t *);
 472 PCAP_API int    pcap_is_swapped(pcap_t *);
 473 PCAP_API int    pcap_major_version(pcap_t *);
 474 PCAP_API int    pcap_minor_version(pcap_t *);
 475 PCAP_API int    pcap_bufsize(pcap_t *);
 476
 477 /* XXX */
 478 PCAP_API FILE   *pcap_file(pcap_t *);
 479 PCAP_API int    pcap_fileno(pcap_t *);
 480
 481 #ifdef _WIN32
 482   PCAP_API int  pcap_wsockinit(void);
 483 #endif
 484
 485 PCAP_API pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
 486 PCAP_API pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp);
 487 PCAP_API pcap_dumper_t *pcap_dump_open_append(pcap_t *, const char *);
 488 PCAP_API FILE   *pcap_dump_file(pcap_dumper_t *);
 489 PCAP_API long   pcap_dump_ftell(pcap_dumper_t *);
 490 PCAP_API int64_t        pcap_dump_ftell64(pcap_dumper_t *);
 491 PCAP_API int    pcap_dump_flush(pcap_dumper_t *);
 492 PCAP_API void   pcap_dump_close(pcap_dumper_t *);
 493 PCAP_API void   pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
 494
 495 PCAP_API int    pcap_findalldevs(pcap_if_t **, char *);
 496 PCAP_API void   pcap_freealldevs(pcap_if_t *);
 497
 498 /*
 499  * We return a pointer to the version string, rather than exporting the
 500  * version string directly.
 501  *
 502  * On at least some UNIXes, if you import data from a shared library into
 503  * an program, the data is bound into the program binary, so if the string
 504  * in the version of the library with which the program was linked isn't
 505  * the same as the string in the version of the library with which the
 506  * program is being run, various undesirable things may happen (warnings,
 507  * the string being the one from the version of the library with which the
 508  * program was linked, or even weirder things, such as the string being the
 509  * one from the library but being truncated).
 510  *
 511  * On Windows, the string is constructed at run time.
 512  */
 513 PCAP_API const char *pcap_lib_version(void);
 514
 515 /*
 516  * On at least some versions of NetBSD and QNX, we don't want to declare
 517  * bpf_filter() here, as it's also be declared in <net/bpf.h>, with a
 518  * different signature, but, on other BSD-flavored UN*Xes, it's not
 519  * declared in <net/bpf.h>, so we *do* want to declare it here, so it's
 520  * declared when we build pcap-bpf.c.
 521  */
 522 #if !defined(__NetBSD__) && !defined(__QNX__)
 523   PCAP_API u_int        bpf_filter(const struct bpf_insn *, const u_char *, u_int, u_int);
 524 #endif
 525 PCAP_API int    bpf_validate(const struct bpf_insn *f, int len);
 526 PCAP_API char   *bpf_image(const struct bpf_insn *, int);
 527 PCAP_API void   bpf_dump(const struct bpf_program *, int);
 528
 529 #if defined(_WIN32)
 530
 531   /*
 532    * Win32 definitions
 533    */
 534
 535   /*!
 536     \brief A queue of raw packets that will be sent to the network with pcap_sendqueue_transmit().
 537   */
 538   struct pcap_send_queue
 539   {
 540         u_int maxlen;   /* Maximum size of the queue, in bytes. This
 541                            variable contains the size of the buffer field. */
 542         u_int len;      /* Current size of the queue, in bytes. */
 543         char *buffer;   /* Buffer containing the packets to be sent. */
 544   };
 545
 546   typedef struct pcap_send_queue pcap_send_queue;
 547
 548   /*!
 549     \brief This typedef is a support for the pcap_get_airpcap_handle() function
 550   */
 551   #if !defined(AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_)
 552     #define AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_
 553     typedef struct _AirpcapHandle *PAirpcapHandle;
 554   #endif
 555
 556   PCAP_API int pcap_setbuff(pcap_t *p, int dim);
 557   PCAP_API int pcap_setmode(pcap_t *p, int mode);
 558   PCAP_API int pcap_setmintocopy(pcap_t *p, int size);
 559
 560   PCAP_API HANDLE pcap_getevent(pcap_t *p);
 561
 562   PCAP_API int pcap_oid_get_request(pcap_t *, bpf_u_int32, void *, size_t *);
 563   PCAP_API int pcap_oid_set_request(pcap_t *, bpf_u_int32, const void *, size_t *);
 564
 565   PCAP_API pcap_send_queue* pcap_sendqueue_alloc(u_int memsize);
 566
 567   PCAP_API void pcap_sendqueue_destroy(pcap_send_queue* queue);
 568
 569   PCAP_API int pcap_sendqueue_queue(pcap_send_queue* queue, const struct pcap_pkthdr *pkt_header, const u_char *pkt_data);
 570
 571   PCAP_API u_int pcap_sendqueue_transmit(pcap_t *p, pcap_send_queue* queue, int sync);
 572
 573   PCAP_API struct pcap_stat *pcap_stats_ex(pcap_t *p, int *pcap_stat_size);
 574
 575   PCAP_API int pcap_setuserbuffer(pcap_t *p, int size);
 576
 577   PCAP_API int pcap_live_dump(pcap_t *p, char *filename, int maxsize, int maxpacks);
 578
 579   PCAP_API int pcap_live_dump_ended(pcap_t *p, int sync);
 580
 581   PCAP_API int pcap_start_oem(char* err_str, int flags);
 582
 583   PCAP_API PAirpcapHandle pcap_get_airpcap_handle(pcap_t *p);
 584
 585   #define MODE_CAPT 0
 586   #define MODE_STAT 1
 587   #define MODE_MON 2
 588
 589 #elif defined(MSDOS)
 590
 591   /*
 592    * MS-DOS definitions
 593    */
 594
 595   PCAP_API int  pcap_stats_ex (pcap_t *, struct pcap_stat_ex *);
 596   PCAP_API void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait);
 597   PCAP_API u_long pcap_mac_packets (void);
 598
 599 #else /* UN*X */
 600
 601   /*
 602    * UN*X definitions
 603    */
 604
 605   PCAP_API int  pcap_get_selectable_fd(pcap_t *);
 606   PCAP_API struct timeval *pcap_get_required_select_timeout(pcap_t *);
 607
 608 #endif /* _WIN32/MSDOS/UN*X */
 609
 610 /*
 611  * Remote capture definitions.
 612  *
 613  * These routines are only present if libpcap has been configured to
 614  * include remote capture support.
 615  */
 616
 617 /*
 618  * The maximum buffer size in which address, port, interface names are kept.
 619  *
 620  * In case the adapter name or such is larger than this value, it is truncated.
 621  * This is not used by the user; however it must be aware that an hostname / interface
 622  * name longer than this value will be truncated.
 623  */
 624 #define PCAP_BUF_SIZE 1024
 625
 626 /*
 627  * The type of input source, passed to pcap_open().
 628  */
 629 #define PCAP_SRC_FILE           2       /* local savefile */
 630 #define PCAP_SRC_IFLOCAL        3       /* local network interface */
 631 #define PCAP_SRC_IFREMOTE       4       /* interface on a remote host, using RPCAP */
 632
 633 /*
 634  * The formats allowed by pcap_open() are the following:
 635  * - file://path_and_filename [opens a local file]
 636  * - rpcap://devicename [opens the selected device devices available on the local host, without using the RPCAP protocol]
 637  * - rpcap://host/devicename [opens the selected device available on a remote host]
 638  * - rpcap://host:port/devicename [opens the selected device available on a remote host, using a non-standard port for RPCAP]
 639  * - adaptername [to open a local adapter; kept for compability, but it is strongly discouraged]
 640  * - (NULL) [to open the first local adapter; kept for compability, but it is strongly discouraged]
 641  *
 642  * The formats allowed by the pcap_findalldevs_ex() are the following:
 643  * - file://folder/ [lists all the files in the given folder]
 644  * - rpcap:// [lists all local adapters]
 645  * - rpcap://host:port/ [lists the devices available on a remote host]
 646  *
 647  * Referring to the 'host' and 'port' parameters, they can be either numeric or literal. Since
 648  * IPv6 is fully supported, these are the allowed formats:
 649  *
 650  * - host (literal): e.g. host.foo.bar
 651  * - host (numeric IPv4): e.g. 10.11.12.13
 652  * - host (numeric IPv4, IPv6 style): e.g. [10.11.12.13]
 653  * - host (numeric IPv6): e.g. [1:2:3::4]
 654  * - port: can be either numeric (e.g. '80') or literal (e.g. 'http')
 655  *
 656  * Here you find some allowed examples:
 657  * - rpcap://host.foo.bar/devicename [everything literal, no port number]
 658  * - rpcap://host.foo.bar:1234/devicename [everything literal, with port number]
 659  * - rpcap://10.11.12.13/devicename [IPv4 numeric, no port number]
 660  * - rpcap://10.11.12.13:1234/devicename [IPv4 numeric, with port number]
 661  * - rpcap://[10.11.12.13]:1234/devicename [IPv4 numeric with IPv6 format, with port number]
 662  * - rpcap://[1:2:3::4]/devicename [IPv6 numeric, no port number]
 663  * - rpcap://[1:2:3::4]:1234/devicename [IPv6 numeric, with port number]
 664  * - rpcap://[1:2:3::4]:http/devicename [IPv6 numeric, with literal port number]
 665  */
 666
 667 /*
 668  * URL schemes for capture source.
 669  */
 670 /*
 671  * This string indicates that the user wants to open a capture from a
 672  * local file.
 673  */
 674 #define PCAP_SRC_FILE_STRING "file://"
 675 /*
 676  * This string indicates that the user wants to open a capture from a
 677  * network interface.  This string does not necessarily involve the use
 678  * of the RPCAP protocol. If the interface required resides on the local
 679  * host, the RPCAP protocol is not involved and the local functions are used.
 680  */
 681 #define PCAP_SRC_IF_STRING "rpcap://"
 682
 683 /*
 684  * Flags to pass to pcap_open().
 685  */
 686
 687 /*
 688  * Specifies whether promiscuous mode is to be used.
 689  */
 690 #define PCAP_OPENFLAG_PROMISCUOUS               0x00000001
 691
 692 /*
 693  * Specifies, for an RPCAP capture, whether the data transfer (in
 694  * case of a remote capture) has to be done with UDP protocol.
 695  *
 696  * If it is '1' if you want a UDP data connection, '0' if you want
 697  * a TCP data connection; control connection is always TCP-based.
 698  * A UDP connection is much lighter, but it does not guarantee that all
 699  * the captured packets arrive to the client workstation. Moreover,
 700  * it could be harmful in case of network congestion.
 701  * This flag is meaningless if the source is not a remote interface.
 702  * In that case, it is simply ignored.
 703  */
 704 #define PCAP_OPENFLAG_DATATX_UDP                0x00000002
 705
 706 /*
 707  * Specifies wheether the remote probe will capture its own generated
 708  * traffic.
 709  *
 710  * In case the remote probe uses the same interface to capture traffic
 711  * and to send data back to the caller, the captured traffic includes
 712  * the RPCAP traffic as well.  If this flag is turned on, the RPCAP
 713  * traffic is excluded from the capture, so that the trace returned
 714  * back to the collector is does not include this traffic.
 715  *
 716  * Has no effect on local interfaces or savefiles.
 717  */
 718 #define PCAP_OPENFLAG_NOCAPTURE_RPCAP           0x00000004
 719
 720 /*
 721  * Specifies whether the local adapter will capture its own generated traffic.
 722  *
 723  * This flag tells the underlying capture driver to drop the packets
 724  * that were sent by itself.  This is useful when building applications
 725  * such as bridges that should ignore the traffic they just sent.
 726  *
 727  * Supported only on Windows.
 728  */
 729 #define PCAP_OPENFLAG_NOCAPTURE_LOCAL           0x00000008
 730
 731 /*
 732  * This flag configures the adapter for maximum responsiveness.
 733  *
 734  * In presence of a large value for nbytes, WinPcap waits for the arrival
 735  * of several packets before copying the data to the user. This guarantees
 736  * a low number of system calls, i.e. lower processor usage, i.e. better
 737  * performance, which is good for applications like sniffers. If the user
 738  * sets the PCAP_OPENFLAG_MAX_RESPONSIVENESS flag, the capture driver will
 739  * copy the packets as soon as the application is ready to receive them.
 740  * This is suggested for real time applications (such as, for example,
 741  * a bridge) that need the best responsiveness.
 742  *
 743  * The equivalent with pcap_create()/pcap_activate() is "immediate mode".
 744  */
 745 #define PCAP_OPENFLAG_MAX_RESPONSIVENESS        0x00000010
 746
 747 /*
 748  * Remote authentication methods.
 749  * These are used in the 'type' member of the pcap_rmtauth structure.
 750  */
 751
 752 /*
 753  * NULL authentication.
 754  *
 755  * The 'NULL' authentication has to be equal to 'zero', so that old
 756  * applications can just put every field of struct pcap_rmtauth to zero,
 757  * and it does work.
 758  */
 759 #define RPCAP_RMTAUTH_NULL 0
 760 /*
 761  * Username/password authentication.
 762  *
 763  * With this type of authentication, the RPCAP protocol will use the username/
 764  * password provided to authenticate the user on the remote machine. If the
 765  * authentication is successful (and the user has the right to open network
 766  * devices) the RPCAP connection will continue; otherwise it will be dropped.
 767  *
 768  * *******NOTE********: the username and password are sent over the network
 769  * to the capture server *IN CLEAR TEXT*.  Don't use this on a network
 770  * that you don't completely control!  (And be *really* careful in your
 771  * definition of "completely"!)
 772  */
 773 #define RPCAP_RMTAUTH_PWD 1
 774
 775 /*
 776  * This structure keeps the information needed to autheticate the user
 777  * on a remote machine.
 778  *
 779  * The remote machine can either grant or refuse the access according
 780  * to the information provided.
 781  * In case the NULL authentication is required, both 'username' and
 782  * 'password' can be NULL pointers.
 783  *
 784  * This structure is meaningless if the source is not a remote interface;
 785  * in that case, the functions which requires such a structure can accept
 786  * a NULL pointer as well.
 787  */
 788 struct pcap_rmtauth
 789 {
 790         /*
 791          * \brief Type of the authentication required.
 792          *
 793          * In order to provide maximum flexibility, we can support different types
 794          * of authentication based on the value of this 'type' variable. The currently
 795          * supported authentication methods are defined into the
 796          * \link remote_auth_methods Remote Authentication Methods Section\endlink.
 797          */
 798         int type;
 799         /*
 800          * \brief Zero-terminated string containing the username that has to be
 801          * used on the remote machine for authentication.
 802          *
 803          * This field is meaningless in case of the RPCAP_RMTAUTH_NULL authentication
 804          * and it can be NULL.
 805          */
 806         char *username;
 807         /*
 808          * \brief Zero-terminated string containing the password that has to be
 809          * used on the remote machine for authentication.
 810          *
 811          * This field is meaningless in case of the RPCAP_RMTAUTH_NULL authentication
 812          * and it can be NULL.
 813          */
 814         char *password;
 815 };
 816
 817 /*
 818  * This routine can open a savefile, a local device, or a device on
 819  * a remote machine running an RPCAP server.
 820  *
 821  * For opening a savefile, the pcap_open_offline routines can be used,
 822  * and will work just as well; code using them will work on more
 823  * platforms than code using pcap_open() to open savefiles.
 824  *
 825  * For opening a local device, pcap_open_live() can be used; it supports
 826  * most of the capabilities that pcap_open() supports, and code using it
 827  * will work on more platforms than code using pcap_open().  pcap_create()
 828  * and pcap_activate() can also be used; they support all capabilities
 829  * that pcap_open() supports, except for the Windows-only
 830  * PCAP_OPENFLAG_NOCAPTURE_LOCAL, and support additional capabilities.
 831  *
 832  * For opening a remote capture, pcap_open() is currently the only
 833  * API available.
 834  */
 835 PCAP_API pcap_t *pcap_open(const char *source, int snaplen, int flags,
 836             int read_timeout, struct pcap_rmtauth *auth, char *errbuf);
 837 PCAP_API int    pcap_createsrcstr(char *source, int type, const char *host,
 838             const char *port, const char *name, char *errbuf);
 839 PCAP_API int    pcap_parsesrcstr(const char *source, int *type, char *host,
 840             char *port, char *name, char *errbuf);
 841
 842 /*
 843  * This routine can scan a directory for savefiles, list local capture
 844  * devices, or list capture devices on a remote machine running an RPCAP
 845  * server.
 846  *
 847  * For scanning for savefiles, it can be used on both UN*X systems and
 848  * Windows systems; for each directory entry it sees, it tries to open
 849  * the file as a savefile using pcap_open_offline(), and only includes
 850  * it in the list of files if the open succeeds, so it filters out
 851  * files for which the user doesn't have read permission, as well as
 852  * files that aren't valid savefiles readable by libpcap.
 853  *
 854  * For listing local capture devices, it's just a wrapper around
 855  * pcap_findalldevs(); code using pcap_findalldevs() will work on more
 856  * platforms than code using pcap_findalldevs_ex().
 857  *
 858  * For listing remote capture devices, pcap_findalldevs_ex() is currently
 859  * the only API available.
 860  */
 861 PCAP_API int    pcap_findalldevs_ex(char *source, struct pcap_rmtauth *auth,
 862             pcap_if_t **alldevs, char *errbuf);
 863
 864 /*
 865  * Sampling methods.
 866  *
 867  * These allow pcap_loop(), pcap_dispatch(), pcap_next(), and pcap_next_ex()
 868  * to see only a sample of packets, rather than all packets.
 869  *
 870  * Currently, they work only on Windows local captures.
 871  */
 872
 873 /*
 874  * Specifies that no sampling is to be done on the current capture.
 875  *
 876  * In this case, no sampling algorithms are applied to the current capture.
 877  */
 878 #define PCAP_SAMP_NOSAMP        0
 879
 880 /*
 881  * Specifies that only 1 out of N packets must be returned to the user.
 882  *
 883  * In this case, the 'value' field of the 'pcap_samp' structure indicates the
 884  * number of packets (minus 1) that must be discarded before one packet got
 885  * accepted.
 886  * In other words, if 'value = 10', the first packet is returned to the
 887  * caller, while the following 9 are discarded.
 888  */
 889 #define PCAP_SAMP_1_EVERY_N     1
 890
 891 /*
 892  * Specifies that we have to return 1 packet every N milliseconds.
 893  *
 894  * In this case, the 'value' field of the 'pcap_samp' structure indicates
 895  * the 'waiting time' in milliseconds before one packet got accepted.
 896  * In other words, if 'value = 10', the first packet is returned to the
 897  * caller; the next returned one will be the first packet that arrives
 898  * when 10ms have elapsed.
 899  */
 900 #define PCAP_SAMP_FIRST_AFTER_N_MS 2
 901
 902 /*
 903  * This structure defines the information related to sampling.
 904  *
 905  * In case the sampling is requested, the capturing device should read
 906  * only a subset of the packets coming from the source. The returned packets
 907  * depend on the sampling parameters.
 908  *
 909  * WARNING: The sampling process is applied *after* the filtering process.
 910  * In other words, packets are filtered first, then the sampling process
 911  * selects a subset of the 'filtered' packets and it returns them to the
 912  * caller.
 913  */
 914 struct pcap_samp
 915 {
 916         /*
 917          * Method used for sampling; see above.
 918          */
 919         int method;
 920
 921         /*
 922          * This value depends on the sampling method defined.
 923          * For its meaning, see above.
 924          */
 925         int value;
 926 };
 927
 928 /*
 929  * New functions.
 930  */
 931 PCAP_API struct pcap_samp *pcap_setsampling(pcap_t *p);
 932
 933 /*
 934  * RPCAP active mode.
 935  */
 936
 937 /* Maximum length of an host name (needed for the RPCAP active mode) */
 938 #define RPCAP_HOSTLIST_SIZE 1024
 939
 940 /*
 941  * Some minor differences between UN*X sockets and and Winsock sockets.
 942  */
 943 #ifndef _WIN32
 944   /*!
 945    * \brief In Winsock, a socket handle is of type SOCKET; in UN*X, it's
 946    * a file descriptor, and therefore a signed integer.
 947    * We define SOCKET to be a signed integer on UN*X, so that it can
 948    * be used on both platforms.
 949    */
 950   #define SOCKET int
 951
 952   /*!
 953    * \brief In Winsock, the error return if socket() fails is INVALID_SOCKET;
 954    * in UN*X, it's -1.
 955    * We define INVALID_SOCKET to be -1 on UN*X, so that it can be used on
 956    * both platforms.
 957    */
 958   #define INVALID_SOCKET -1
 959 #endif
 960
 961 PCAP_API SOCKET pcap_remoteact_accept(const char *address, const char *port,
 962             const char *hostlist, char *connectinghost,
 963             struct pcap_rmtauth *auth, char *errbuf);
 964 PCAP_API int    pcap_remoteact_list(char *hostlist, char sep, int size,
 965             char *errbuf);
 966 PCAP_API int    pcap_remoteact_close(const char *host, char *errbuf);
 967 PCAP_API void   pcap_remoteact_cleanup(void);
 968
 969 #ifdef __cplusplus
 970 }
 971 #endif
 972
 973 #endif /* lib_pcap_pcap_h */