1 /* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */
3 * Copyright (c) 1993, 1994, 1995, 1996, 1997
4 * The Regents of the University of California. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
36 * Remote packet capture mechanisms and extensions from WinPcap:
38 * Copyright (c) 2002 - 2003
39 * NetGroup, Politecnico di Torino (Italy)
40 * All rights reserved.
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
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.
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.
69 #ifndef lib_pcap_pcap_h
70 #define lib_pcap_pcap_h
73 * Some software that uses libpcap/WinPcap/Npcap defines _MSC_VER before
74 * including pcap.h if it's not defined - and it defines it to 1500.
75 * (I'm looking at *you*, lwIP!)
77 * Attempt to detect this, and undefine _MSC_VER so that we can *reliably*
78 * use it to know what compiler is being used and, if it's Visual Studio,
79 * what version is being used.
83 * We assume here that software such as that doesn't define _MSC_FULL_VER
84 * as well and that it defines _MSC_VER with a value > 1200.
86 * DO NOT BREAK THESE ASSUMPTIONS. IF YOU FEEL YOU MUST DEFINE _MSC_VER
87 * WITH A COMPILER THAT'S NOT MICROSOFT'S C COMPILER, PLEASE CONTACT
88 * US SO THAT WE CAN MAKE IT SO THAT YOU DON'T HAVE TO DO THAT. THANK
91 * OK, is _MSC_FULL_VER defined?
93 #if !defined(_MSC_FULL_VER)
97 * https://sourceforge.net/p/predef/wiki/Compilers/
99 * with "Visual C++ 6.0 Processor Pack"/Visual C++ 6.0 SP6 and
100 * later, _MSC_FULL_VER is defined, so either this is an older
101 * version of Visual C++ or it's not Visual C++ at all.
103 * For Visual C++ 6.0, _MSC_VER is defined as 1200.
107 * If this is Visual C++, _MSC_FULL_VER should be defined, so we
108 * assume this isn't Visual C++, and undo the lie that it is.
115 #include <pcap/funcattrs.h>
117 #include <pcap/pcap-inttypes.h>
120 #include <winsock2.h> /* u_int, u_char etc. */
121 #include <io.h> /* _get_osfhandle() */
123 #include <sys/types.h> /* u_int, u_char etc. */
124 #include <sys/socket.h>
126 #include <sys/types.h> /* u_int, u_char etc. */
127 #include <sys/time.h>
128 #endif /* _WIN32/MSDOS/UN*X */
130 #include <pcap/socket.h> /* for SOCKET, as the active-mode rpcap APIs use it */
132 #ifndef PCAP_DONT_INCLUDE_PCAP_BPF_H
133 #include <pcap/bpf.h>
143 * Version number of the current version of the pcap file format.
145 * NOTE: this is *NOT* the version number of the libpcap library.
146 * To fetch the version information for the version of libpcap
147 * you're using, use pcap_lib_version().
149 #define PCAP_VERSION_MAJOR 2
150 #define PCAP_VERSION_MINOR 4
152 #define PCAP_ERRBUF_SIZE 256
155 * Compatibility for systems that have a bpf.h that
156 * predates the bpf typedefs for 64-bit support.
158 #if BPF_RELEASE - 0 < 199406
159 typedef int bpf_int32;
160 typedef u_int bpf_u_int32;
163 typedef struct pcap pcap_t;
164 typedef struct pcap_dumper pcap_dumper_t;
165 typedef struct pcap_if pcap_if_t;
166 typedef struct pcap_addr pcap_addr_t;
169 * The first record in the file contains saved values for some
170 * of the flags used in the printout phases of tcpdump.
171 * Many fields here are 32 bit ints so compilers won't insert unwanted
172 * padding; these files need to be interchangeable across architectures.
173 * Documentation: https://www.tcpdump.org/manpages/pcap-savefile.5.txt.
175 * Do not change the layout of this structure, in any way (this includes
176 * changes that only affect the length of fields in this structure).
178 * Also, do not change the interpretation of any of the members of this
179 * structure, in any way (this includes using values other than
180 * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
185 * introduce a new structure for the new format, if the layout
186 * of the structure changed;
188 * send mail to "tcpdump-workers@lists.tcpdump.org", requesting
189 * a new magic number for your new capture file format, and, when
190 * you get the new magic number, put it in "savefile.c";
192 * use that magic number for save files with the changed file
195 * make the code in "savefile.c" capable of reading files with
196 * the old file header as well as files with the new file header
197 * (using the magic number to determine the header format).
199 * Then supply the changes by forking the branch at
201 * https://github.com/the-tcpdump-group/libpcap/tree/master
203 * and issuing a pull request, so that future versions of libpcap and
204 * programs that use it (such as tcpdump) will be able to read your new
205 * capture file format.
207 struct pcap_file_header {
209 u_short version_major;
210 u_short version_minor;
211 bpf_int32 thiszone; /* gmt to local correction; this is always 0 */
212 bpf_u_int32 sigfigs; /* accuracy of timestamps; this is always 0 */
213 bpf_u_int32 snaplen; /* max length saved portion of each pkt */
214 bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */
218 * Macros for the value returned by pcap_datalink_ext().
220 * If LT_FCS_LENGTH_PRESENT(x) is true, the LT_FCS_LENGTH(x) macro
221 * gives the FCS length of packets in the capture.
223 #define LT_FCS_LENGTH_PRESENT(x) ((x) & 0x04000000)
224 #define LT_FCS_LENGTH(x) (((x) & 0xF0000000) >> 28)
225 #define LT_FCS_DATALINK_EXT(x) ((((x) & 0xF) << 28) | 0x04000000)
234 * Generic per-packet information, as supplied by libpcap.
236 * The time stamp can and should be a "struct timeval", regardless of
237 * whether your system supports 32-bit tv_sec in "struct timeval",
238 * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit
239 * and 64-bit applications. The on-disk format of savefiles uses 32-bit
240 * tv_sec (and tv_usec); this structure is irrelevant to that. 32-bit
241 * and 64-bit versions of libpcap, even if they're on the same platform,
242 * should supply the appropriate version of "struct timeval", even if
243 * that's not what the underlying packet capture mechanism supplies.
246 struct timeval ts; /* time stamp */
247 bpf_u_int32 caplen; /* length of portion present */
248 bpf_u_int32 len; /* length of this packet (off wire) */
252 * As returned by the pcap_stats()
255 u_int ps_recv; /* number of packets received */
256 u_int ps_drop; /* number of packets dropped */
257 u_int ps_ifdrop; /* drops by interface -- only supported on some platforms */
259 u_int ps_capt; /* number of packets that reach the application */
260 u_int ps_sent; /* number of packets sent by the server on the network */
261 u_int ps_netdrop; /* number of packets lost on the network */
267 * As returned by the pcap_stats_ex()
269 struct pcap_stat_ex {
270 u_long rx_packets; /* total packets received */
271 u_long tx_packets; /* total packets transmitted */
272 u_long rx_bytes; /* total bytes received */
273 u_long tx_bytes; /* total bytes transmitted */
274 u_long rx_errors; /* bad packets received */
275 u_long tx_errors; /* packet transmit problems */
276 u_long rx_dropped; /* no space in Rx buffers */
277 u_long tx_dropped; /* no space available for Tx */
278 u_long multicast; /* multicast packets received */
281 /* detailed rx_errors: */
282 u_long rx_length_errors;
283 u_long rx_over_errors; /* receiver ring buff overflow */
284 u_long rx_crc_errors; /* recv'd pkt with crc error */
285 u_long rx_frame_errors; /* recv'd frame alignment error */
286 u_long rx_fifo_errors; /* recv'r fifo overrun */
287 u_long rx_missed_errors; /* recv'r missed packet */
289 /* detailed tx_errors */
290 u_long tx_aborted_errors;
291 u_long tx_carrier_errors;
292 u_long tx_fifo_errors;
293 u_long tx_heartbeat_errors;
294 u_long tx_window_errors;
299 * Item in a list of interfaces.
302 struct pcap_if *next;
303 char *name; /* name to hand to "pcap_open_live()" */
304 char *description; /* textual description of interface, or NULL */
305 struct pcap_addr *addresses;
306 bpf_u_int32 flags; /* PCAP_IF_ interface flags */
309 #define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */
310 #define PCAP_IF_UP 0x00000002 /* interface is up */
311 #define PCAP_IF_RUNNING 0x00000004 /* interface is running */
312 #define PCAP_IF_WIRELESS 0x00000008 /* interface is wireless (*NOT* necessarily Wi-Fi!) */
313 #define PCAP_IF_CONNECTION_STATUS 0x00000030 /* connection status: */
314 #define PCAP_IF_CONNECTION_STATUS_UNKNOWN 0x00000000 /* unknown */
315 #define PCAP_IF_CONNECTION_STATUS_CONNECTED 0x00000010 /* connected */
316 #define PCAP_IF_CONNECTION_STATUS_DISCONNECTED 0x00000020 /* disconnected */
317 #define PCAP_IF_CONNECTION_STATUS_NOT_APPLICABLE 0x00000030 /* not applicable */
320 * Representation of an interface address.
323 struct pcap_addr *next;
324 struct sockaddr *addr; /* address */
325 struct sockaddr *netmask; /* netmask for that address */
326 struct sockaddr *broadaddr; /* broadcast address for that address */
327 struct sockaddr *dstaddr; /* P2P destination address for that address */
330 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
334 * Error codes for the pcap API.
335 * These will all be negative, so you can check for the success or
336 * failure of a call that returns these codes by checking for a
339 #define PCAP_ERROR -1 /* generic error code */
340 #define PCAP_ERROR_BREAK -2 /* loop terminated by pcap_breakloop */
341 #define PCAP_ERROR_NOT_ACTIVATED -3 /* the capture needs to be activated */
342 #define PCAP_ERROR_ACTIVATED -4 /* the operation can't be performed on already activated captures */
343 #define PCAP_ERROR_NO_SUCH_DEVICE -5 /* no such device exists */
344 #define PCAP_ERROR_RFMON_NOTSUP -6 /* this device doesn't support rfmon (monitor) mode */
345 #define PCAP_ERROR_NOT_RFMON -7 /* operation supported only in monitor mode */
346 #define PCAP_ERROR_PERM_DENIED -8 /* no permission to open the device */
347 #define PCAP_ERROR_IFACE_NOT_UP -9 /* interface isn't up */
348 #define PCAP_ERROR_CANTSET_TSTAMP_TYPE -10 /* this device doesn't support setting the time stamp type */
349 #define PCAP_ERROR_PROMISC_PERM_DENIED -11 /* you don't have permission to capture in promiscuous mode */
350 #define PCAP_ERROR_TSTAMP_PRECISION_NOTSUP -12 /* the requested time stamp precision is not supported */
353 * Warning codes for the pcap API.
354 * These will all be positive and non-zero, so they won't look like
357 #define PCAP_WARNING 1 /* generic warning code */
358 #define PCAP_WARNING_PROMISC_NOTSUP 2 /* this device doesn't support promiscuous mode */
359 #define PCAP_WARNING_TSTAMP_TYPE_NOTSUP 3 /* the requested time stamp type is not supported */
362 * Value to pass to pcap_compile() as the netmask if you don't know what
365 #define PCAP_NETMASK_UNKNOWN 0xffffffff
368 * Initialize pcap. If this isn't called, pcap is initialized to
369 * a mode source-compatible and binary-compatible with older versions
370 * that lack this routine.
374 * Initialization options.
375 * All bits not listed here are reserved for expansion.
377 * On UNIX-like systems, the local character encoding is assumed to be
378 * UTF-8, so no character encoding transformations are done.
380 * On Windows, the local character encoding is the local ANSI code page.
382 #define PCAP_CHAR_ENC_LOCAL 0x00000000U /* strings are in the local character encoding */
383 #define PCAP_CHAR_ENC_UTF_8 0x00000001U /* strings are in UTF-8 */
386 PCAP_API int pcap_init(unsigned int, char *);
389 * We're deprecating pcap_lookupdev() for various reasons (not
390 * thread-safe, can behave weirdly with WinPcap). Callers
391 * should use pcap_findalldevs() and use the first device.
394 PCAP_DEPRECATED("use 'pcap_findalldevs' and use the first device")
395 PCAP_API char *pcap_lookupdev(char *);
398 PCAP_API int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
401 PCAP_API pcap_t *pcap_create(const char *, char *);
404 PCAP_API int pcap_set_snaplen(pcap_t *, int);
407 PCAP_API int pcap_set_promisc(pcap_t *, int);
410 PCAP_API int pcap_can_set_rfmon(pcap_t *);
413 PCAP_API int pcap_set_rfmon(pcap_t *, int);
416 PCAP_API int pcap_set_timeout(pcap_t *, int);
419 PCAP_API int pcap_set_tstamp_type(pcap_t *, int);
422 PCAP_API int pcap_set_immediate_mode(pcap_t *, int);
425 PCAP_API int pcap_set_buffer_size(pcap_t *, int);
428 PCAP_API int pcap_set_tstamp_precision(pcap_t *, int);
431 PCAP_API int pcap_get_tstamp_precision(pcap_t *);
434 PCAP_API int pcap_activate(pcap_t *);
437 PCAP_API int pcap_list_tstamp_types(pcap_t *, int **);
440 PCAP_API void pcap_free_tstamp_types(int *);
443 PCAP_API int pcap_tstamp_type_name_to_val(const char *);
446 PCAP_API const char *pcap_tstamp_type_val_to_name(int);
449 PCAP_API const char *pcap_tstamp_type_val_to_description(int);
453 PCAP_API int pcap_set_protocol_linux(pcap_t *, int);
458 * Not all systems and interfaces will necessarily support all of these.
460 * A system that supports PCAP_TSTAMP_HOST is offering time stamps
461 * provided by the host machine, rather than by the capture device,
462 * but not committing to any characteristics of the time stamp.
464 * PCAP_TSTAMP_HOST_LOWPREC is a time stamp, provided by the host machine,
465 * that's low-precision but relatively cheap to fetch; it's normally done
466 * using the system clock, so it's normally synchronized with times you'd
467 * fetch from system calls.
469 * PCAP_TSTAMP_HOST_HIPREC is a time stamp, provided by the host machine,
470 * that's high-precision; it might be more expensive to fetch. It is
471 * synchronized with the system clock.
473 * PCAP_TSTAMP_HOST_HIPREC_UNSYNCED is a time stamp, provided by the host
474 * machine, that's high-precision; it might be more expensive to fetch.
475 * It is not synchronized with the system clock, and might have
476 * problems with time stamps for packets received on different CPUs,
477 * depending on the platform. It might be more likely to be strictly
478 * monotonic than PCAP_TSTAMP_HOST_HIPREC.
480 * PCAP_TSTAMP_ADAPTER is a high-precision time stamp supplied by the
481 * capture device; it's synchronized with the system clock.
483 * PCAP_TSTAMP_ADAPTER_UNSYNCED is a high-precision time stamp supplied by
484 * the capture device; it's not synchronized with the system clock.
486 * Note that time stamps synchronized with the system clock can go
487 * backwards, as the system clock can go backwards. If a clock is
488 * not in sync with the system clock, that could be because the
489 * system clock isn't keeping accurate time, because the other
490 * clock isn't keeping accurate time, or both.
492 * Note that host-provided time stamps generally correspond to the
493 * time when the time-stamping code sees the packet; this could
494 * be some unknown amount of time after the first or last bit of
495 * the packet is received by the network adapter, due to batching
496 * of interrupts for packet arrival, queueing delays, etc..
498 #define PCAP_TSTAMP_HOST 0 /* host-provided, unknown characteristics */
499 #define PCAP_TSTAMP_HOST_LOWPREC 1 /* host-provided, low precision, synced with the system clock */
500 #define PCAP_TSTAMP_HOST_HIPREC 2 /* host-provided, high precision, synced with the system clock */
501 #define PCAP_TSTAMP_ADAPTER 3 /* device-provided, synced with the system clock */
502 #define PCAP_TSTAMP_ADAPTER_UNSYNCED 4 /* device-provided, not synced with the system clock */
503 #define PCAP_TSTAMP_HOST_HIPREC_UNSYNCED 5 /* host-provided, high precision, not synced with the system clock */
506 * Time stamp resolution types.
507 * Not all systems and interfaces will necessarily support all of these
508 * resolutions when doing live captures; all of them can be requested
509 * when reading a savefile.
511 #define PCAP_TSTAMP_PRECISION_MICRO 0 /* use timestamps with microsecond precision, default */
512 #define PCAP_TSTAMP_PRECISION_NANO 1 /* use timestamps with nanosecond precision */
515 PCAP_API pcap_t *pcap_open_live(const char *, int, int, int, char *);
518 PCAP_API pcap_t *pcap_open_dead(int, int);
521 PCAP_API pcap_t *pcap_open_dead_with_tstamp_precision(int, int, u_int);
524 PCAP_API pcap_t *pcap_open_offline_with_tstamp_precision(const char *, u_int, char *);
527 PCAP_API pcap_t *pcap_open_offline(const char *, char *);
531 PCAP_API pcap_t *pcap_hopen_offline_with_tstamp_precision(intptr_t, u_int, char *);
533 PCAP_API pcap_t *pcap_hopen_offline(intptr_t, char *);
535 * If we're building libpcap, these are internal routines in savefile.c,
536 * so we must not define them as macros.
538 * If we're not building libpcap, given that the version of the C runtime
539 * with which libpcap was built might be different from the version
540 * of the C runtime with which an application using libpcap was built,
541 * and that a FILE structure may differ between the two versions of the
542 * C runtime, calls to _fileno() must use the version of _fileno() in
543 * the C runtime used to open the FILE *, not the version in the C
544 * runtime with which libpcap was built. (Maybe once the Universal CRT
545 * rules the world, this will cease to be a problem.)
547 #ifndef BUILDING_PCAP
548 #define pcap_fopen_offline_with_tstamp_precision(f,p,b) \
549 pcap_hopen_offline_with_tstamp_precision(_get_osfhandle(_fileno(f)), p, b)
550 #define pcap_fopen_offline(f,b) \
551 pcap_hopen_offline(_get_osfhandle(_fileno(f)), b)
555 PCAP_API pcap_t *pcap_fopen_offline_with_tstamp_precision(FILE *, u_int, char *);
558 PCAP_API pcap_t *pcap_fopen_offline(FILE *, char *);
562 PCAP_API void pcap_close(pcap_t *);
565 PCAP_API int pcap_loop(pcap_t *, int, pcap_handler, u_char *);
568 PCAP_API int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
571 PCAP_API const u_char *pcap_next(pcap_t *, struct pcap_pkthdr *);
574 PCAP_API int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
577 PCAP_API void pcap_breakloop(pcap_t *);
580 PCAP_API int pcap_stats(pcap_t *, struct pcap_stat *);
583 PCAP_API int pcap_setfilter(pcap_t *, struct bpf_program *);
586 PCAP_API int pcap_setdirection(pcap_t *, pcap_direction_t);
589 PCAP_API int pcap_getnonblock(pcap_t *, char *);
592 PCAP_API int pcap_setnonblock(pcap_t *, int, char *);
595 PCAP_API int pcap_inject(pcap_t *, const void *, size_t);
598 PCAP_API int pcap_sendpacket(pcap_t *, const u_char *, int);
601 PCAP_API const char *pcap_statustostr(int);
604 PCAP_API const char *pcap_strerror(int);
607 PCAP_API char *pcap_geterr(pcap_t *);
610 PCAP_API void pcap_perror(pcap_t *, const char *);
613 PCAP_API int pcap_compile(pcap_t *, struct bpf_program *, const char *, int,
617 PCAP_DEPRECATED("use pcap_open_dead(), pcap_compile() and pcap_close()")
618 PCAP_API int pcap_compile_nopcap(int, int, struct bpf_program *,
619 const char *, int, bpf_u_int32);
621 /* XXX - this took two arguments in 0.4 and 0.5 */
623 PCAP_API void pcap_freecode(struct bpf_program *);
626 PCAP_API int pcap_offline_filter(const struct bpf_program *,
627 const struct pcap_pkthdr *, const u_char *);
630 PCAP_API int pcap_datalink(pcap_t *);
633 PCAP_API int pcap_datalink_ext(pcap_t *);
636 PCAP_API int pcap_list_datalinks(pcap_t *, int **);
639 PCAP_API int pcap_set_datalink(pcap_t *, int);
642 PCAP_API void pcap_free_datalinks(int *);
645 PCAP_API int pcap_datalink_name_to_val(const char *);
648 PCAP_API const char *pcap_datalink_val_to_name(int);
651 PCAP_API const char *pcap_datalink_val_to_description(int);
654 PCAP_API const char *pcap_datalink_val_to_description_or_dlt(int);
657 PCAP_API int pcap_snapshot(pcap_t *);
660 PCAP_API int pcap_is_swapped(pcap_t *);
663 PCAP_API int pcap_major_version(pcap_t *);
666 PCAP_API int pcap_minor_version(pcap_t *);
669 PCAP_API int pcap_bufsize(pcap_t *);
673 PCAP_API FILE *pcap_file(pcap_t *);
677 * This probably shouldn't have been kept in WinPcap; most if not all
678 * UN*X code that used it won't work on Windows. We deprecate it; if
679 * anybody really needs access to whatever HANDLE may be associated
680 * with a pcap_t (there's no guarantee that there is one), we can add
681 * a Windows-only pcap_handle() API that returns the HANDLE.
684 PCAP_DEPRECATED("request a 'pcap_handle' that returns a HANDLE if you need it")
685 PCAP_API int pcap_fileno(pcap_t *);
688 PCAP_API int pcap_fileno(pcap_t *);
692 PCAP_API int pcap_wsockinit(void);
696 PCAP_API pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
700 PCAP_API pcap_dumper_t *pcap_dump_hopen(pcap_t *, intptr_t);
703 * If we're building libpcap, this is an internal routine in sf-pcap.c, so
704 * we must not define it as a macro.
706 * If we're not building libpcap, given that the version of the C runtime
707 * with which libpcap was built might be different from the version
708 * of the C runtime with which an application using libpcap was built,
709 * and that a FILE structure may differ between the two versions of the
710 * C runtime, calls to _fileno() must use the version of _fileno() in
711 * the C runtime used to open the FILE *, not the version in the C
712 * runtime with which libpcap was built. (Maybe once the Universal CRT
713 * rules the world, this will cease to be a problem.)
715 #ifndef BUILDING_PCAP
716 #define pcap_dump_fopen(p,f) \
717 pcap_dump_hopen(p, _get_osfhandle(_fileno(f)))
721 PCAP_API pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp);
725 PCAP_API pcap_dumper_t *pcap_dump_open_append(pcap_t *, const char *);
728 PCAP_API FILE *pcap_dump_file(pcap_dumper_t *);
731 PCAP_API long pcap_dump_ftell(pcap_dumper_t *);
734 PCAP_API int64_t pcap_dump_ftell64(pcap_dumper_t *);
737 PCAP_API int pcap_dump_flush(pcap_dumper_t *);
740 PCAP_API void pcap_dump_close(pcap_dumper_t *);
743 PCAP_API void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
746 PCAP_API int pcap_findalldevs(pcap_if_t **, char *);
749 PCAP_API void pcap_freealldevs(pcap_if_t *);
752 * We return a pointer to the version string, rather than exporting the
753 * version string directly.
755 * On at least some UNIXes, if you import data from a shared library into
756 * a program, the data is bound into the program binary, so if the string
757 * in the version of the library with which the program was linked isn't
758 * the same as the string in the version of the library with which the
759 * program is being run, various undesirable things may happen (warnings,
760 * the string being the one from the version of the library with which the
761 * program was linked, or even weirder things, such as the string being the
762 * one from the library but being truncated).
764 * On Windows, the string is constructed at run time.
767 PCAP_API const char *pcap_lib_version(void);
776 \brief A queue of raw packets that will be sent to the network with pcap_sendqueue_transmit().
778 struct pcap_send_queue
780 u_int maxlen; /* Maximum size of the queue, in bytes. This
781 variable contains the size of the buffer field. */
782 u_int len; /* Current size of the queue, in bytes. */
783 char *buffer; /* Buffer containing the packets to be sent. */
786 typedef struct pcap_send_queue pcap_send_queue;
789 \brief This typedef is a support for the pcap_get_airpcap_handle() function
791 #if !defined(AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_)
792 #define AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_
793 typedef struct _AirpcapHandle *PAirpcapHandle;
796 PCAP_API int pcap_setbuff(pcap_t *p, int dim);
797 PCAP_API int pcap_setmode(pcap_t *p, int mode);
798 PCAP_API int pcap_setmintocopy(pcap_t *p, int size);
800 PCAP_API HANDLE pcap_getevent(pcap_t *p);
803 PCAP_API int pcap_oid_get_request(pcap_t *, bpf_u_int32, void *, size_t *);
806 PCAP_API int pcap_oid_set_request(pcap_t *, bpf_u_int32, const void *, size_t *);
808 PCAP_API pcap_send_queue* pcap_sendqueue_alloc(u_int memsize);
810 PCAP_API void pcap_sendqueue_destroy(pcap_send_queue* queue);
812 PCAP_API int pcap_sendqueue_queue(pcap_send_queue* queue, const struct pcap_pkthdr *pkt_header, const u_char *pkt_data);
814 PCAP_API u_int pcap_sendqueue_transmit(pcap_t *p, pcap_send_queue* queue, int sync);
816 PCAP_API struct pcap_stat *pcap_stats_ex(pcap_t *p, int *pcap_stat_size);
818 PCAP_API int pcap_setuserbuffer(pcap_t *p, int size);
820 PCAP_API int pcap_live_dump(pcap_t *p, char *filename, int maxsize, int maxpacks);
822 PCAP_API int pcap_live_dump_ended(pcap_t *p, int sync);
824 PCAP_API int pcap_start_oem(char* err_str, int flags);
826 PCAP_API PAirpcapHandle pcap_get_airpcap_handle(pcap_t *p);
838 PCAP_API int pcap_stats_ex (pcap_t *, struct pcap_stat_ex *);
839 PCAP_API void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait);
840 PCAP_API u_long pcap_mac_packets (void);
849 PCAP_API int pcap_get_selectable_fd(pcap_t *);
852 PCAP_API const struct timeval *pcap_get_required_select_timeout(pcap_t *);
854 #endif /* _WIN32/MSDOS/UN*X */
856 #if 0 /* Remote capture is disabled on FreeBSD */
858 * Remote capture definitions.
860 * These routines are only present if libpcap has been configured to
861 * include remote capture support.
865 * The maximum buffer size in which address, port, interface names are kept.
867 * In case the adapter name or such is larger than this value, it is truncated.
868 * This is not used by the user; however it must be aware that an hostname / interface
869 * name longer than this value will be truncated.
871 #define PCAP_BUF_SIZE 1024
874 * The type of input source, passed to pcap_open().
876 #define PCAP_SRC_FILE 2 /* local savefile */
877 #define PCAP_SRC_IFLOCAL 3 /* local network interface */
878 #define PCAP_SRC_IFREMOTE 4 /* interface on a remote host, using RPCAP */
881 * The formats allowed by pcap_open() are the following:
882 * - file://path_and_filename [opens a local file]
883 * - rpcap://devicename [opens the selected device available on the local host, without using the RPCAP protocol]
884 * - rpcap://host/devicename [opens the selected device available on a remote host]
885 * - rpcap://host:port/devicename [opens the selected device available on a remote host, using a non-standard port for RPCAP]
886 * - adaptername [to open a local adapter; kept for compatibility, but it is strongly discouraged]
887 * - (NULL) [to open the first local adapter; kept for compatibility, but it is strongly discouraged]
889 * The formats allowed by the pcap_findalldevs_ex() are the following:
890 * - file://folder/ [lists all the files in the given folder]
891 * - rpcap:// [lists all local adapters]
892 * - rpcap://host:port/ [lists the devices available on a remote host]
894 * In all the above, "rpcaps://" can be substituted for "rpcap://" to enable
895 * SSL (if it has been compiled in).
897 * Referring to the 'host' and 'port' parameters, they can be either numeric or literal. Since
898 * IPv6 is fully supported, these are the allowed formats:
900 * - host (literal): e.g. host.foo.bar
901 * - host (numeric IPv4): e.g. 10.11.12.13
902 * - host (numeric IPv4, IPv6 style): e.g. [10.11.12.13]
903 * - host (numeric IPv6): e.g. [1:2:3::4]
904 * - port: can be either numeric (e.g. '80') or literal (e.g. 'http')
906 * Here you find some allowed examples:
907 * - rpcap://host.foo.bar/devicename [everything literal, no port number]
908 * - rpcap://host.foo.bar:1234/devicename [everything literal, with port number]
909 * - rpcap://10.11.12.13/devicename [IPv4 numeric, no port number]
910 * - rpcap://10.11.12.13:1234/devicename [IPv4 numeric, with port number]
911 * - rpcap://[10.11.12.13]:1234/devicename [IPv4 numeric with IPv6 format, with port number]
912 * - rpcap://[1:2:3::4]/devicename [IPv6 numeric, no port number]
913 * - rpcap://[1:2:3::4]:1234/devicename [IPv6 numeric, with port number]
914 * - rpcap://[1:2:3::4]:http/devicename [IPv6 numeric, with literal port number]
918 * URL schemes for capture source.
921 * This string indicates that the user wants to open a capture from a
924 #define PCAP_SRC_FILE_STRING "file://"
926 * This string indicates that the user wants to open a capture from a
927 * network interface. This string does not necessarily involve the use
928 * of the RPCAP protocol. If the interface required resides on the local
929 * host, the RPCAP protocol is not involved and the local functions are used.
931 #define PCAP_SRC_IF_STRING "rpcap://"
934 * Flags to pass to pcap_open().
938 * Specifies whether promiscuous mode is to be used.
940 #define PCAP_OPENFLAG_PROMISCUOUS 0x00000001
943 * Specifies, for an RPCAP capture, whether the data transfer (in
944 * case of a remote capture) has to be done with UDP protocol.
946 * If it is '1' if you want a UDP data connection, '0' if you want
947 * a TCP data connection; control connection is always TCP-based.
948 * A UDP connection is much lighter, but it does not guarantee that all
949 * the captured packets arrive to the client workstation. Moreover,
950 * it could be harmful in case of network congestion.
951 * This flag is meaningless if the source is not a remote interface.
952 * In that case, it is simply ignored.
954 #define PCAP_OPENFLAG_DATATX_UDP 0x00000002
957 * Specifies whether the remote probe will capture its own generated
960 * In case the remote probe uses the same interface to capture traffic
961 * and to send data back to the caller, the captured traffic includes
962 * the RPCAP traffic as well. If this flag is turned on, the RPCAP
963 * traffic is excluded from the capture, so that the trace returned
964 * back to the collector is does not include this traffic.
966 * Has no effect on local interfaces or savefiles.
968 #define PCAP_OPENFLAG_NOCAPTURE_RPCAP 0x00000004
971 * Specifies whether the local adapter will capture its own generated traffic.
973 * This flag tells the underlying capture driver to drop the packets
974 * that were sent by itself. This is useful when building applications
975 * such as bridges that should ignore the traffic they just sent.
977 * Supported only on Windows.
979 #define PCAP_OPENFLAG_NOCAPTURE_LOCAL 0x00000008
982 * This flag configures the adapter for maximum responsiveness.
984 * In presence of a large value for nbytes, WinPcap waits for the arrival
985 * of several packets before copying the data to the user. This guarantees
986 * a low number of system calls, i.e. lower processor usage, i.e. better
987 * performance, which is good for applications like sniffers. If the user
988 * sets the PCAP_OPENFLAG_MAX_RESPONSIVENESS flag, the capture driver will
989 * copy the packets as soon as the application is ready to receive them.
990 * This is suggested for real time applications (such as, for example,
991 * a bridge) that need the best responsiveness.
993 * The equivalent with pcap_create()/pcap_activate() is "immediate mode".
995 #define PCAP_OPENFLAG_MAX_RESPONSIVENESS 0x00000010
998 * Remote authentication methods.
999 * These are used in the 'type' member of the pcap_rmtauth structure.
1003 * NULL authentication.
1005 * The 'NULL' authentication has to be equal to 'zero', so that old
1006 * applications can just put every field of struct pcap_rmtauth to zero,
1009 #define RPCAP_RMTAUTH_NULL 0
1011 * Username/password authentication.
1013 * With this type of authentication, the RPCAP protocol will use the username/
1014 * password provided to authenticate the user on the remote machine. If the
1015 * authentication is successful (and the user has the right to open network
1016 * devices) the RPCAP connection will continue; otherwise it will be dropped.
1018 * *******NOTE********: unless TLS is being used, the username and password
1019 * are sent over the network to the capture server *IN CLEAR TEXT*. Don't
1020 * use this, without TLS (i.e., with rpcap:// rather than rpcaps://) on
1021 * a network that you don't completely control! (And be *really* careful
1022 * in your definition of "completely"!)
1024 #define RPCAP_RMTAUTH_PWD 1
1027 * This structure keeps the information needed to authenticate the user
1028 * on a remote machine.
1030 * The remote machine can either grant or refuse the access according
1031 * to the information provided.
1032 * In case the NULL authentication is required, both 'username' and
1033 * 'password' can be NULL pointers.
1035 * This structure is meaningless if the source is not a remote interface;
1036 * in that case, the functions which requires such a structure can accept
1037 * a NULL pointer as well.
1042 * \brief Type of the authentication required.
1044 * In order to provide maximum flexibility, we can support different types
1045 * of authentication based on the value of this 'type' variable. The currently
1046 * supported authentication methods are defined into the
1047 * \link remote_auth_methods Remote Authentication Methods Section\endlink.
1051 * \brief Zero-terminated string containing the username that has to be
1052 * used on the remote machine for authentication.
1054 * This field is meaningless in case of the RPCAP_RMTAUTH_NULL authentication
1055 * and it can be NULL.
1059 * \brief Zero-terminated string containing the password that has to be
1060 * used on the remote machine for authentication.
1062 * This field is meaningless in case of the RPCAP_RMTAUTH_NULL authentication
1063 * and it can be NULL.
1069 * This routine can open a savefile, a local device, or a device on
1070 * a remote machine running an RPCAP server.
1072 * For opening a savefile, the pcap_open_offline routines can be used,
1073 * and will work just as well; code using them will work on more
1074 * platforms than code using pcap_open() to open savefiles.
1076 * For opening a local device, pcap_open_live() can be used; it supports
1077 * most of the capabilities that pcap_open() supports, and code using it
1078 * will work on more platforms than code using pcap_open(). pcap_create()
1079 * and pcap_activate() can also be used; they support all capabilities
1080 * that pcap_open() supports, except for the Windows-only
1081 * PCAP_OPENFLAG_NOCAPTURE_LOCAL, and support additional capabilities.
1083 * For opening a remote capture, pcap_open() is currently the only
1087 PCAP_API pcap_t *pcap_open(const char *source, int snaplen, int flags,
1088 int read_timeout, struct pcap_rmtauth *auth, char *errbuf);
1091 PCAP_API int pcap_createsrcstr(char *source, int type, const char *host,
1092 const char *port, const char *name, char *errbuf);
1095 PCAP_API int pcap_parsesrcstr(const char *source, int *type, char *host,
1096 char *port, char *name, char *errbuf);
1099 * This routine can scan a directory for savefiles, list local capture
1100 * devices, or list capture devices on a remote machine running an RPCAP
1103 * For scanning for savefiles, it can be used on both UN*X systems and
1104 * Windows systems; for each directory entry it sees, it tries to open
1105 * the file as a savefile using pcap_open_offline(), and only includes
1106 * it in the list of files if the open succeeds, so it filters out
1107 * files for which the user doesn't have read permission, as well as
1108 * files that aren't valid savefiles readable by libpcap.
1110 * For listing local capture devices, it's just a wrapper around
1111 * pcap_findalldevs(); code using pcap_findalldevs() will work on more
1112 * platforms than code using pcap_findalldevs_ex().
1114 * For listing remote capture devices, pcap_findalldevs_ex() is currently
1115 * the only API available.
1118 PCAP_API int pcap_findalldevs_ex(const char *source,
1119 struct pcap_rmtauth *auth, pcap_if_t **alldevs, char *errbuf);
1124 * These allow pcap_loop(), pcap_dispatch(), pcap_next(), and pcap_next_ex()
1125 * to see only a sample of packets, rather than all packets.
1127 * Currently, they work only on Windows local captures.
1131 * Specifies that no sampling is to be done on the current capture.
1133 * In this case, no sampling algorithms are applied to the current capture.
1135 #define PCAP_SAMP_NOSAMP 0
1138 * Specifies that only 1 out of N packets must be returned to the user.
1140 * In this case, the 'value' field of the 'pcap_samp' structure indicates the
1141 * number of packets (minus 1) that must be discarded before one packet got
1143 * In other words, if 'value = 10', the first packet is returned to the
1144 * caller, while the following 9 are discarded.
1146 #define PCAP_SAMP_1_EVERY_N 1
1149 * Specifies that we have to return 1 packet every N milliseconds.
1151 * In this case, the 'value' field of the 'pcap_samp' structure indicates
1152 * the 'waiting time' in milliseconds before one packet got accepted.
1153 * In other words, if 'value = 10', the first packet is returned to the
1154 * caller; the next returned one will be the first packet that arrives
1155 * when 10ms have elapsed.
1157 #define PCAP_SAMP_FIRST_AFTER_N_MS 2
1160 * This structure defines the information related to sampling.
1162 * In case the sampling is requested, the capturing device should read
1163 * only a subset of the packets coming from the source. The returned packets
1164 * depend on the sampling parameters.
1166 * WARNING: The sampling process is applied *after* the filtering process.
1167 * In other words, packets are filtered first, then the sampling process
1168 * selects a subset of the 'filtered' packets and it returns them to the
1174 * Method used for sampling; see above.
1179 * This value depends on the sampling method defined.
1180 * For its meaning, see above.
1189 PCAP_API struct pcap_samp *pcap_setsampling(pcap_t *p);
1192 * RPCAP active mode.
1195 /* Maximum length of an host name (needed for the RPCAP active mode) */
1196 #define RPCAP_HOSTLIST_SIZE 1024
1199 PCAP_API SOCKET pcap_remoteact_accept(const char *address, const char *port,
1200 const char *hostlist, char *connectinghost,
1201 struct pcap_rmtauth *auth, char *errbuf);
1204 PCAP_API SOCKET pcap_remoteact_accept_ex(const char *address, const char *port,
1205 const char *hostlist, char *connectinghost,
1206 struct pcap_rmtauth *auth, int uses_ssl, char *errbuf);
1209 PCAP_API int pcap_remoteact_list(char *hostlist, char sep, int size,
1213 PCAP_API int pcap_remoteact_close(const char *host, char *errbuf);
1216 PCAP_API void pcap_remoteact_cleanup(void);
1217 #endif /* Remote capture is disabled on FreeBSD */
1223 #endif /* lib_pcap_pcap_h */