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
72 #include <pcap/funcattrs.h>
74 #include <pcap/pcap-inttypes.h>
77 #include <winsock2.h> /* u_int, u_char etc. */
78 #include <io.h> /* _get_osfhandle() */
80 #include <sys/types.h> /* u_int, u_char etc. */
81 #include <sys/socket.h>
83 #include <sys/types.h> /* u_int, u_char etc. */
85 #endif /* _WIN32/MSDOS/UN*X */
96 * Version number of the current version of the pcap file format.
98 * NOTE: this is *NOT* the version number of the libpcap library.
99 * To fetch the version information for the version of libpcap
100 * you're using, use pcap_lib_version().
102 #define PCAP_VERSION_MAJOR 2
103 #define PCAP_VERSION_MINOR 4
105 #define PCAP_ERRBUF_SIZE 256
108 * Compatibility for systems that have a bpf.h that
109 * predates the bpf typedefs for 64-bit support.
111 #if BPF_RELEASE - 0 < 199406
112 typedef int bpf_int32;
113 typedef u_int bpf_u_int32;
116 typedef struct pcap pcap_t;
117 typedef struct pcap_dumper pcap_dumper_t;
118 typedef struct pcap_if pcap_if_t;
119 typedef struct pcap_addr pcap_addr_t;
122 * The first record in the file contains saved values for some
123 * of the flags used in the printout phases of tcpdump.
124 * Many fields here are 32 bit ints so compilers won't insert unwanted
125 * padding; these files need to be interchangeable across architectures.
127 * Do not change the layout of this structure, in any way (this includes
128 * changes that only affect the length of fields in this structure).
130 * Also, do not change the interpretation of any of the members of this
131 * structure, in any way (this includes using values other than
132 * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
137 * introduce a new structure for the new format, if the layout
138 * of the structure changed;
140 * send mail to "tcpdump-workers@lists.tcpdump.org", requesting
141 * a new magic number for your new capture file format, and, when
142 * you get the new magic number, put it in "savefile.c";
144 * use that magic number for save files with the changed file
147 * make the code in "savefile.c" capable of reading files with
148 * the old file header as well as files with the new file header
149 * (using the magic number to determine the header format).
151 * Then supply the changes by forking the branch at
153 * https://github.com/the-tcpdump-group/libpcap/issues
155 * and issuing a pull request, so that future versions of libpcap and
156 * programs that use it (such as tcpdump) will be able to read your new
157 * capture file format.
159 struct pcap_file_header {
161 u_short version_major;
162 u_short version_minor;
163 bpf_int32 thiszone; /* gmt to local correction */
164 bpf_u_int32 sigfigs; /* accuracy of timestamps */
165 bpf_u_int32 snaplen; /* max length saved portion of each pkt */
166 bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */
170 * Macros for the value returned by pcap_datalink_ext().
172 * If LT_FCS_LENGTH_PRESENT(x) is true, the LT_FCS_LENGTH(x) macro
173 * gives the FCS length of packets in the capture.
175 #define LT_FCS_LENGTH_PRESENT(x) ((x) & 0x04000000)
176 #define LT_FCS_LENGTH(x) (((x) & 0xF0000000) >> 28)
177 #define LT_FCS_DATALINK_EXT(x) ((((x) & 0xF) << 28) | 0x04000000)
186 * Generic per-packet information, as supplied by libpcap.
188 * The time stamp can and should be a "struct timeval", regardless of
189 * whether your system supports 32-bit tv_sec in "struct timeval",
190 * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit
191 * and 64-bit applications. The on-disk format of savefiles uses 32-bit
192 * tv_sec (and tv_usec); this structure is irrelevant to that. 32-bit
193 * and 64-bit versions of libpcap, even if they're on the same platform,
194 * should supply the appropriate version of "struct timeval", even if
195 * that's not what the underlying packet capture mechanism supplies.
198 struct timeval ts; /* time stamp */
199 bpf_u_int32 caplen; /* length of portion present */
200 bpf_u_int32 len; /* length this packet (off wire) */
204 * As returned by the pcap_stats()
207 u_int ps_recv; /* number of packets received */
208 u_int ps_drop; /* number of packets dropped */
209 u_int ps_ifdrop; /* drops by interface -- only supported on some platforms */
211 u_int ps_capt; /* number of packets that reach the application */
212 u_int ps_sent; /* number of packets sent by the server on the network */
213 u_int ps_netdrop; /* number of packets lost on the network */
219 * As returned by the pcap_stats_ex()
221 struct pcap_stat_ex {
222 u_long rx_packets; /* total packets received */
223 u_long tx_packets; /* total packets transmitted */
224 u_long rx_bytes; /* total bytes received */
225 u_long tx_bytes; /* total bytes transmitted */
226 u_long rx_errors; /* bad packets received */
227 u_long tx_errors; /* packet transmit problems */
228 u_long rx_dropped; /* no space in Rx buffers */
229 u_long tx_dropped; /* no space available for Tx */
230 u_long multicast; /* multicast packets received */
233 /* detailed rx_errors: */
234 u_long rx_length_errors;
235 u_long rx_over_errors; /* receiver ring buff overflow */
236 u_long rx_crc_errors; /* recv'd pkt with crc error */
237 u_long rx_frame_errors; /* recv'd frame alignment error */
238 u_long rx_fifo_errors; /* recv'r fifo overrun */
239 u_long rx_missed_errors; /* recv'r missed packet */
241 /* detailed tx_errors */
242 u_long tx_aborted_errors;
243 u_long tx_carrier_errors;
244 u_long tx_fifo_errors;
245 u_long tx_heartbeat_errors;
246 u_long tx_window_errors;
251 * Item in a list of interfaces.
254 struct pcap_if *next;
255 char *name; /* name to hand to "pcap_open_live()" */
256 char *description; /* textual description of interface, or NULL */
257 struct pcap_addr *addresses;
258 bpf_u_int32 flags; /* PCAP_IF_ interface flags */
261 #define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */
262 #define PCAP_IF_UP 0x00000002 /* interface is up */
263 #define PCAP_IF_RUNNING 0x00000004 /* interface is running */
264 #define PCAP_IF_WIRELESS 0x00000008 /* interface is wireless (*NOT* necessarily Wi-Fi!) */
265 #define PCAP_IF_CONNECTION_STATUS 0x00000030 /* connection status: */
266 #define PCAP_IF_CONNECTION_STATUS_UNKNOWN 0x00000000 /* unknown */
267 #define PCAP_IF_CONNECTION_STATUS_CONNECTED 0x00000010 /* connected */
268 #define PCAP_IF_CONNECTION_STATUS_DISCONNECTED 0x00000020 /* disconnected */
269 #define PCAP_IF_CONNECTION_STATUS_NOT_APPLICABLE 0x00000030 /* not applicable */
272 * Representation of an interface address.
275 struct pcap_addr *next;
276 struct sockaddr *addr; /* address */
277 struct sockaddr *netmask; /* netmask for that address */
278 struct sockaddr *broadaddr; /* broadcast address for that address */
279 struct sockaddr *dstaddr; /* P2P destination address for that address */
282 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
286 * Error codes for the pcap API.
287 * These will all be negative, so you can check for the success or
288 * failure of a call that returns these codes by checking for a
291 #define PCAP_ERROR -1 /* generic error code */
292 #define PCAP_ERROR_BREAK -2 /* loop terminated by pcap_breakloop */
293 #define PCAP_ERROR_NOT_ACTIVATED -3 /* the capture needs to be activated */
294 #define PCAP_ERROR_ACTIVATED -4 /* the operation can't be performed on already activated captures */
295 #define PCAP_ERROR_NO_SUCH_DEVICE -5 /* no such device exists */
296 #define PCAP_ERROR_RFMON_NOTSUP -6 /* this device doesn't support rfmon (monitor) mode */
297 #define PCAP_ERROR_NOT_RFMON -7 /* operation supported only in monitor mode */
298 #define PCAP_ERROR_PERM_DENIED -8 /* no permission to open the device */
299 #define PCAP_ERROR_IFACE_NOT_UP -9 /* interface isn't up */
300 #define PCAP_ERROR_CANTSET_TSTAMP_TYPE -10 /* this device doesn't support setting the time stamp type */
301 #define PCAP_ERROR_PROMISC_PERM_DENIED -11 /* you don't have permission to capture in promiscuous mode */
302 #define PCAP_ERROR_TSTAMP_PRECISION_NOTSUP -12 /* the requested time stamp precision is not supported */
305 * Warning codes for the pcap API.
306 * These will all be positive and non-zero, so they won't look like
309 #define PCAP_WARNING 1 /* generic warning code */
310 #define PCAP_WARNING_PROMISC_NOTSUP 2 /* this device doesn't support promiscuous mode */
311 #define PCAP_WARNING_TSTAMP_TYPE_NOTSUP 3 /* the requested time stamp type is not supported */
314 * Value to pass to pcap_compile() as the netmask if you don't know what
317 #define PCAP_NETMASK_UNKNOWN 0xffffffff
320 * We're deprecating pcap_lookupdev() for various reasons (not
321 * thread-safe, can behave weirdly with WinPcap). Callers
322 * should use pcap_findalldevs() and use the first device.
324 PCAP_API char *pcap_lookupdev(char *)
325 PCAP_DEPRECATED(pcap_lookupdev, "use 'pcap_findalldevs' and use the first device");
327 PCAP_API int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
329 PCAP_API pcap_t *pcap_create(const char *, char *);
330 PCAP_API int pcap_set_snaplen(pcap_t *, int);
331 PCAP_API int pcap_set_promisc(pcap_t *, int);
332 PCAP_API int pcap_can_set_rfmon(pcap_t *);
333 PCAP_API int pcap_set_rfmon(pcap_t *, int);
334 PCAP_API int pcap_set_timeout(pcap_t *, int);
335 PCAP_API int pcap_set_tstamp_type(pcap_t *, int);
336 PCAP_API int pcap_set_immediate_mode(pcap_t *, int);
337 PCAP_API int pcap_set_buffer_size(pcap_t *, int);
338 PCAP_API int pcap_set_tstamp_precision(pcap_t *, int);
339 PCAP_API int pcap_get_tstamp_precision(pcap_t *);
340 PCAP_API int pcap_activate(pcap_t *);
342 PCAP_API int pcap_list_tstamp_types(pcap_t *, int **);
343 PCAP_API void pcap_free_tstamp_types(int *);
344 PCAP_API int pcap_tstamp_type_name_to_val(const char *);
345 PCAP_API const char *pcap_tstamp_type_val_to_name(int);
346 PCAP_API const char *pcap_tstamp_type_val_to_description(int);
349 PCAP_API int pcap_set_protocol(pcap_t *, int);
354 * Not all systems and interfaces will necessarily support all of these.
356 * A system that supports PCAP_TSTAMP_HOST is offering time stamps
357 * provided by the host machine, rather than by the capture device,
358 * but not committing to any characteristics of the time stamp;
359 * it will not offer any of the PCAP_TSTAMP_HOST_ subtypes.
361 * PCAP_TSTAMP_HOST_LOWPREC is a time stamp, provided by the host machine,
362 * that's low-precision but relatively cheap to fetch; it's normally done
363 * using the system clock, so it's normally synchronized with times you'd
364 * fetch from system calls.
366 * PCAP_TSTAMP_HOST_HIPREC is a time stamp, provided by the host machine,
367 * that's high-precision; it might be more expensive to fetch. It might
368 * or might not be synchronized with the system clock, and might have
369 * problems with time stamps for packets received on different CPUs,
370 * depending on the platform.
372 * PCAP_TSTAMP_ADAPTER is a high-precision time stamp supplied by the
373 * capture device; it's synchronized with the system clock.
375 * PCAP_TSTAMP_ADAPTER_UNSYNCED is a high-precision time stamp supplied by
376 * the capture device; it's not synchronized with the system clock.
378 * Note that time stamps synchronized with the system clock can go
379 * backwards, as the system clock can go backwards. If a clock is
380 * not in sync with the system clock, that could be because the
381 * system clock isn't keeping accurate time, because the other
382 * clock isn't keeping accurate time, or both.
384 * Note that host-provided time stamps generally correspond to the
385 * time when the time-stamping code sees the packet; this could
386 * be some unknown amount of time after the first or last bit of
387 * the packet is received by the network adapter, due to batching
388 * of interrupts for packet arrival, queueing delays, etc..
390 #define PCAP_TSTAMP_HOST 0 /* host-provided, unknown characteristics */
391 #define PCAP_TSTAMP_HOST_LOWPREC 1 /* host-provided, low precision */
392 #define PCAP_TSTAMP_HOST_HIPREC 2 /* host-provided, high precision */
393 #define PCAP_TSTAMP_ADAPTER 3 /* device-provided, synced with the system clock */
394 #define PCAP_TSTAMP_ADAPTER_UNSYNCED 4 /* device-provided, not synced with the system clock */
397 * Time stamp resolution types.
398 * Not all systems and interfaces will necessarily support all of these
399 * resolutions when doing live captures; all of them can be requested
400 * when reading a savefile.
402 #define PCAP_TSTAMP_PRECISION_MICRO 0 /* use timestamps with microsecond precision, default */
403 #define PCAP_TSTAMP_PRECISION_NANO 1 /* use timestamps with nanosecond precision */
405 PCAP_API pcap_t *pcap_open_live(const char *, int, int, int, char *);
406 PCAP_API pcap_t *pcap_open_dead(int, int);
407 PCAP_API pcap_t *pcap_open_dead_with_tstamp_precision(int, int, u_int);
408 PCAP_API pcap_t *pcap_open_offline_with_tstamp_precision(const char *, u_int, char *);
409 PCAP_API pcap_t *pcap_open_offline(const char *, char *);
411 PCAP_API pcap_t *pcap_hopen_offline_with_tstamp_precision(intptr_t, u_int, char *);
412 PCAP_API pcap_t *pcap_hopen_offline(intptr_t, char *);
414 * If we're building libpcap, these are internal routines in savefile.c,
415 * so we must not define them as macros.
417 * If we're not building libpcap, given that the version of the C runtime
418 * with which libpcap was built might be different from the version
419 * of the C runtime with which an application using libpcap was built,
420 * and that a FILE structure may differ between the two versions of the
421 * C runtime, calls to _fileno() must use the version of _fileno() in
422 * the C runtime used to open the FILE *, not the version in the C
423 * runtime with which libpcap was built. (Maybe once the Universal CRT
424 * rules the world, this will cease to be a problem.)
426 #ifndef BUILDING_PCAP
427 #define pcap_fopen_offline_with_tstamp_precision(f,p,b) \
428 pcap_hopen_offline_with_tstamp_precision(_get_osfhandle(_fileno(f)), p, b)
429 #define pcap_fopen_offline(f,b) \
430 pcap_hopen_offline(_get_osfhandle(_fileno(f)), b)
433 PCAP_API pcap_t *pcap_fopen_offline_with_tstamp_precision(FILE *, u_int, char *);
434 PCAP_API pcap_t *pcap_fopen_offline(FILE *, char *);
437 PCAP_API void pcap_close(pcap_t *);
438 PCAP_API int pcap_loop(pcap_t *, int, pcap_handler, u_char *);
439 PCAP_API int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
440 PCAP_API const u_char *pcap_next(pcap_t *, struct pcap_pkthdr *);
441 PCAP_API int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
442 PCAP_API void pcap_breakloop(pcap_t *);
443 PCAP_API int pcap_stats(pcap_t *, struct pcap_stat *);
444 PCAP_API int pcap_setfilter(pcap_t *, struct bpf_program *);
445 PCAP_API int pcap_setdirection(pcap_t *, pcap_direction_t);
446 PCAP_API int pcap_getnonblock(pcap_t *, char *);
447 PCAP_API int pcap_setnonblock(pcap_t *, int, char *);
448 PCAP_API int pcap_inject(pcap_t *, const void *, size_t);
449 PCAP_API int pcap_sendpacket(pcap_t *, const u_char *, int);
450 PCAP_API const char *pcap_statustostr(int);
451 PCAP_API const char *pcap_strerror(int);
452 PCAP_API char *pcap_geterr(pcap_t *);
453 PCAP_API void pcap_perror(pcap_t *, const char *);
454 PCAP_API int pcap_compile(pcap_t *, struct bpf_program *, const char *, int,
456 PCAP_API int pcap_compile_nopcap(int, int, struct bpf_program *,
457 const char *, int, bpf_u_int32);
458 PCAP_API void pcap_freecode(struct bpf_program *);
459 PCAP_API int pcap_offline_filter(const struct bpf_program *,
460 const struct pcap_pkthdr *, const u_char *);
461 PCAP_API int pcap_datalink(pcap_t *);
462 PCAP_API int pcap_datalink_ext(pcap_t *);
463 PCAP_API int pcap_list_datalinks(pcap_t *, int **);
464 PCAP_API int pcap_set_datalink(pcap_t *, int);
465 PCAP_API void pcap_free_datalinks(int *);
466 PCAP_API int pcap_datalink_name_to_val(const char *);
467 PCAP_API const char *pcap_datalink_val_to_name(int);
468 PCAP_API const char *pcap_datalink_val_to_description(int);
469 PCAP_API int pcap_snapshot(pcap_t *);
470 PCAP_API int pcap_is_swapped(pcap_t *);
471 PCAP_API int pcap_major_version(pcap_t *);
472 PCAP_API int pcap_minor_version(pcap_t *);
473 PCAP_API int pcap_bufsize(pcap_t *);
476 PCAP_API FILE *pcap_file(pcap_t *);
477 PCAP_API int pcap_fileno(pcap_t *);
480 PCAP_API int pcap_wsockinit(void);
483 PCAP_API pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
484 PCAP_API pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp);
485 PCAP_API pcap_dumper_t *pcap_dump_open_append(pcap_t *, const char *);
486 PCAP_API FILE *pcap_dump_file(pcap_dumper_t *);
487 PCAP_API long pcap_dump_ftell(pcap_dumper_t *);
488 PCAP_API int64_t pcap_dump_ftell64(pcap_dumper_t *);
489 PCAP_API int pcap_dump_flush(pcap_dumper_t *);
490 PCAP_API void pcap_dump_close(pcap_dumper_t *);
491 PCAP_API void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
493 PCAP_API int pcap_findalldevs(pcap_if_t **, char *);
494 PCAP_API void pcap_freealldevs(pcap_if_t *);
497 * We return a pointer to the version string, rather than exporting the
498 * version string directly.
500 * On at least some UNIXes, if you import data from a shared library into
501 * an program, the data is bound into the program binary, so if the string
502 * in the version of the library with which the program was linked isn't
503 * the same as the string in the version of the library with which the
504 * program is being run, various undesirable things may happen (warnings,
505 * the string being the one from the version of the library with which the
506 * program was linked, or even weirder things, such as the string being the
507 * one from the library but being truncated).
509 * On Windows, the string is constructed at run time.
511 PCAP_API const char *pcap_lib_version(void);
514 * On at least some versions of NetBSD and QNX, we don't want to declare
515 * bpf_filter() here, as it's also be declared in <net/bpf.h>, with a
516 * different signature, but, on other BSD-flavored UN*Xes, it's not
517 * declared in <net/bpf.h>, so we *do* want to declare it here, so it's
518 * declared when we build pcap-bpf.c.
520 #if !defined(__NetBSD__) && !defined(__QNX__)
521 PCAP_API u_int bpf_filter(const struct bpf_insn *, const u_char *, u_int, u_int);
523 PCAP_API int bpf_validate(const struct bpf_insn *f, int len);
524 PCAP_API char *bpf_image(const struct bpf_insn *, int);
525 PCAP_API void bpf_dump(const struct bpf_program *, int);
534 \brief A queue of raw packets that will be sent to the network with pcap_sendqueue_transmit().
536 struct pcap_send_queue
538 u_int maxlen; /* Maximum size of the queue, in bytes. This
539 variable contains the size of the buffer field. */
540 u_int len; /* Current size of the queue, in bytes. */
541 char *buffer; /* Buffer containing the packets to be sent. */
544 typedef struct pcap_send_queue pcap_send_queue;
547 \brief This typedef is a support for the pcap_get_airpcap_handle() function
549 #if !defined(AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_)
550 #define AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_
551 typedef struct _AirpcapHandle *PAirpcapHandle;
554 PCAP_API int pcap_setbuff(pcap_t *p, int dim);
555 PCAP_API int pcap_setmode(pcap_t *p, int mode);
556 PCAP_API int pcap_setmintocopy(pcap_t *p, int size);
558 PCAP_API HANDLE pcap_getevent(pcap_t *p);
560 PCAP_API int pcap_oid_get_request(pcap_t *, bpf_u_int32, void *, size_t *);
561 PCAP_API int pcap_oid_set_request(pcap_t *, bpf_u_int32, const void *, size_t *);
563 PCAP_API pcap_send_queue* pcap_sendqueue_alloc(u_int memsize);
565 PCAP_API void pcap_sendqueue_destroy(pcap_send_queue* queue);
567 PCAP_API int pcap_sendqueue_queue(pcap_send_queue* queue, const struct pcap_pkthdr *pkt_header, const u_char *pkt_data);
569 PCAP_API u_int pcap_sendqueue_transmit(pcap_t *p, pcap_send_queue* queue, int sync);
571 PCAP_API struct pcap_stat *pcap_stats_ex(pcap_t *p, int *pcap_stat_size);
573 PCAP_API int pcap_setuserbuffer(pcap_t *p, int size);
575 PCAP_API int pcap_live_dump(pcap_t *p, char *filename, int maxsize, int maxpacks);
577 PCAP_API int pcap_live_dump_ended(pcap_t *p, int sync);
579 PCAP_API int pcap_start_oem(char* err_str, int flags);
581 PCAP_API PAirpcapHandle pcap_get_airpcap_handle(pcap_t *p);
593 PCAP_API int pcap_stats_ex (pcap_t *, struct pcap_stat_ex *);
594 PCAP_API void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait);
595 PCAP_API u_long pcap_mac_packets (void);
603 PCAP_API int pcap_get_selectable_fd(pcap_t *);
604 PCAP_API struct timeval *pcap_get_required_select_timeout(pcap_t *);
606 #endif /* _WIN32/MSDOS/UN*X */
608 #if 0 /* Remote capture is disabled on FreeBSD */
610 * Remote capture definitions.
612 * These routines are only present if libpcap has been configured to
613 * include remote capture support.
617 * The maximum buffer size in which address, port, interface names are kept.
619 * In case the adapter name or such is larger than this value, it is truncated.
620 * This is not used by the user; however it must be aware that an hostname / interface
621 * name longer than this value will be truncated.
623 #define PCAP_BUF_SIZE 1024
626 * The type of input source, passed to pcap_open().
628 #define PCAP_SRC_FILE 2 /* local savefile */
629 #define PCAP_SRC_IFLOCAL 3 /* local network interface */
630 #define PCAP_SRC_IFREMOTE 4 /* interface on a remote host, using RPCAP */
633 * The formats allowed by pcap_open() are the following:
634 * - file://path_and_filename [opens a local file]
635 * - rpcap://devicename [opens the selected device devices available on the local host, without using the RPCAP protocol]
636 * - rpcap://host/devicename [opens the selected device available on a remote host]
637 * - rpcap://host:port/devicename [opens the selected device available on a remote host, using a non-standard port for RPCAP]
638 * - adaptername [to open a local adapter; kept for compability, but it is strongly discouraged]
639 * - (NULL) [to open the first local adapter; kept for compability, but it is strongly discouraged]
641 * The formats allowed by the pcap_findalldevs_ex() are the following:
642 * - file://folder/ [lists all the files in the given folder]
643 * - rpcap:// [lists all local adapters]
644 * - rpcap://host:port/ [lists the devices available on a remote host]
646 * Referring to the 'host' and 'port' parameters, they can be either numeric or literal. Since
647 * IPv6 is fully supported, these are the allowed formats:
649 * - host (literal): e.g. host.foo.bar
650 * - host (numeric IPv4): e.g. 10.11.12.13
651 * - host (numeric IPv4, IPv6 style): e.g. [10.11.12.13]
652 * - host (numeric IPv6): e.g. [1:2:3::4]
653 * - port: can be either numeric (e.g. '80') or literal (e.g. 'http')
655 * Here you find some allowed examples:
656 * - rpcap://host.foo.bar/devicename [everything literal, no port number]
657 * - rpcap://host.foo.bar:1234/devicename [everything literal, with port number]
658 * - rpcap://10.11.12.13/devicename [IPv4 numeric, no port number]
659 * - rpcap://10.11.12.13:1234/devicename [IPv4 numeric, with port number]
660 * - rpcap://[10.11.12.13]:1234/devicename [IPv4 numeric with IPv6 format, with port number]
661 * - rpcap://[1:2:3::4]/devicename [IPv6 numeric, no port number]
662 * - rpcap://[1:2:3::4]:1234/devicename [IPv6 numeric, with port number]
663 * - rpcap://[1:2:3::4]:http/devicename [IPv6 numeric, with literal port number]
667 * URL schemes for capture source.
670 * This string indicates that the user wants to open a capture from a
673 #define PCAP_SRC_FILE_STRING "file://"
675 * This string indicates that the user wants to open a capture from a
676 * network interface. This string does not necessarily involve the use
677 * of the RPCAP protocol. If the interface required resides on the local
678 * host, the RPCAP protocol is not involved and the local functions are used.
680 #define PCAP_SRC_IF_STRING "rpcap://"
683 * Flags to pass to pcap_open().
687 * Specifies whether promiscuous mode is to be used.
689 #define PCAP_OPENFLAG_PROMISCUOUS 0x00000001
692 * Specifies, for an RPCAP capture, whether the data transfer (in
693 * case of a remote capture) has to be done with UDP protocol.
695 * If it is '1' if you want a UDP data connection, '0' if you want
696 * a TCP data connection; control connection is always TCP-based.
697 * A UDP connection is much lighter, but it does not guarantee that all
698 * the captured packets arrive to the client workstation. Moreover,
699 * it could be harmful in case of network congestion.
700 * This flag is meaningless if the source is not a remote interface.
701 * In that case, it is simply ignored.
703 #define PCAP_OPENFLAG_DATATX_UDP 0x00000002
706 * Specifies wheether the remote probe will capture its own generated
709 * In case the remote probe uses the same interface to capture traffic
710 * and to send data back to the caller, the captured traffic includes
711 * the RPCAP traffic as well. If this flag is turned on, the RPCAP
712 * traffic is excluded from the capture, so that the trace returned
713 * back to the collector is does not include this traffic.
715 * Has no effect on local interfaces or savefiles.
717 #define PCAP_OPENFLAG_NOCAPTURE_RPCAP 0x00000004
720 * Specifies whether the local adapter will capture its own generated traffic.
722 * This flag tells the underlying capture driver to drop the packets
723 * that were sent by itself. This is useful when building applications
724 * such as bridges that should ignore the traffic they just sent.
726 * Supported only on Windows.
728 #define PCAP_OPENFLAG_NOCAPTURE_LOCAL 0x00000008
731 * This flag configures the adapter for maximum responsiveness.
733 * In presence of a large value for nbytes, WinPcap waits for the arrival
734 * of several packets before copying the data to the user. This guarantees
735 * a low number of system calls, i.e. lower processor usage, i.e. better
736 * performance, which is good for applications like sniffers. If the user
737 * sets the PCAP_OPENFLAG_MAX_RESPONSIVENESS flag, the capture driver will
738 * copy the packets as soon as the application is ready to receive them.
739 * This is suggested for real time applications (such as, for example,
740 * a bridge) that need the best responsiveness.
742 * The equivalent with pcap_create()/pcap_activate() is "immediate mode".
744 #define PCAP_OPENFLAG_MAX_RESPONSIVENESS 0x00000010
747 * Remote authentication methods.
748 * These are used in the 'type' member of the pcap_rmtauth structure.
752 * NULL authentication.
754 * The 'NULL' authentication has to be equal to 'zero', so that old
755 * applications can just put every field of struct pcap_rmtauth to zero,
758 #define RPCAP_RMTAUTH_NULL 0
760 * Username/password authentication.
762 * With this type of authentication, the RPCAP protocol will use the username/
763 * password provided to authenticate the user on the remote machine. If the
764 * authentication is successful (and the user has the right to open network
765 * devices) the RPCAP connection will continue; otherwise it will be dropped.
767 * *******NOTE********: the username and password are sent over the network
768 * to the capture server *IN CLEAR TEXT*. Don't use this on a network
769 * that you don't completely control! (And be *really* careful in your
770 * definition of "completely"!)
772 #define RPCAP_RMTAUTH_PWD 1
775 * This structure keeps the information needed to autheticate the user
776 * on a remote machine.
778 * The remote machine can either grant or refuse the access according
779 * to the information provided.
780 * In case the NULL authentication is required, both 'username' and
781 * 'password' can be NULL pointers.
783 * This structure is meaningless if the source is not a remote interface;
784 * in that case, the functions which requires such a structure can accept
785 * a NULL pointer as well.
790 * \brief Type of the authentication required.
792 * In order to provide maximum flexibility, we can support different types
793 * of authentication based on the value of this 'type' variable. The currently
794 * supported authentication methods are defined into the
795 * \link remote_auth_methods Remote Authentication Methods Section\endlink.
799 * \brief Zero-terminated string containing the username that has to be
800 * used on the remote machine for authentication.
802 * This field is meaningless in case of the RPCAP_RMTAUTH_NULL authentication
803 * and it can be NULL.
807 * \brief Zero-terminated string containing the password that has to be
808 * used on the remote machine for authentication.
810 * This field is meaningless in case of the RPCAP_RMTAUTH_NULL authentication
811 * and it can be NULL.
817 * This routine can open a savefile, a local device, or a device on
818 * a remote machine running an RPCAP server.
820 * For opening a savefile, the pcap_open_offline routines can be used,
821 * and will work just as well; code using them will work on more
822 * platforms than code using pcap_open() to open savefiles.
824 * For opening a local device, pcap_open_live() can be used; it supports
825 * most of the capabilities that pcap_open() supports, and code using it
826 * will work on more platforms than code using pcap_open(). pcap_create()
827 * and pcap_activate() can also be used; they support all capabilities
828 * that pcap_open() supports, except for the Windows-only
829 * PCAP_OPENFLAG_NOCAPTURE_LOCAL, and support additional capabilities.
831 * For opening a remote capture, pcap_open() is currently the only
834 PCAP_API pcap_t *pcap_open(const char *source, int snaplen, int flags,
835 int read_timeout, struct pcap_rmtauth *auth, char *errbuf);
836 PCAP_API int pcap_createsrcstr(char *source, int type, const char *host,
837 const char *port, const char *name, char *errbuf);
838 PCAP_API int pcap_parsesrcstr(const char *source, int *type, char *host,
839 char *port, char *name, char *errbuf);
842 * This routine can scan a directory for savefiles, list local capture
843 * devices, or list capture devices on a remote machine running an RPCAP
846 * For scanning for savefiles, it can be used on both UN*X systems and
847 * Windows systems; for each directory entry it sees, it tries to open
848 * the file as a savefile using pcap_open_offline(), and only includes
849 * it in the list of files if the open succeeds, so it filters out
850 * files for which the user doesn't have read permission, as well as
851 * files that aren't valid savefiles readable by libpcap.
853 * For listing local capture devices, it's just a wrapper around
854 * pcap_findalldevs(); code using pcap_findalldevs() will work on more
855 * platforms than code using pcap_findalldevs_ex().
857 * For listing remote capture devices, pcap_findalldevs_ex() is currently
858 * the only API available.
860 PCAP_API int pcap_findalldevs_ex(char *source, struct pcap_rmtauth *auth,
861 pcap_if_t **alldevs, char *errbuf);
866 * These allow pcap_loop(), pcap_dispatch(), pcap_next(), and pcap_next_ex()
867 * to see only a sample of packets, rather than all packets.
869 * Currently, they work only on Windows local captures.
873 * Specifies that no sampling is to be done on the current capture.
875 * In this case, no sampling algorithms are applied to the current capture.
877 #define PCAP_SAMP_NOSAMP 0
880 * Specifies that only 1 out of N packets must be returned to the user.
882 * In this case, the 'value' field of the 'pcap_samp' structure indicates the
883 * number of packets (minus 1) that must be discarded before one packet got
885 * In other words, if 'value = 10', the first packet is returned to the
886 * caller, while the following 9 are discarded.
888 #define PCAP_SAMP_1_EVERY_N 1
891 * Specifies that we have to return 1 packet every N milliseconds.
893 * In this case, the 'value' field of the 'pcap_samp' structure indicates
894 * the 'waiting time' in milliseconds before one packet got accepted.
895 * In other words, if 'value = 10', the first packet is returned to the
896 * caller; the next returned one will be the first packet that arrives
897 * when 10ms have elapsed.
899 #define PCAP_SAMP_FIRST_AFTER_N_MS 2
902 * This structure defines the information related to sampling.
904 * In case the sampling is requested, the capturing device should read
905 * only a subset of the packets coming from the source. The returned packets
906 * depend on the sampling parameters.
908 * WARNING: The sampling process is applied *after* the filtering process.
909 * In other words, packets are filtered first, then the sampling process
910 * selects a subset of the 'filtered' packets and it returns them to the
916 * Method used for sampling; see above.
921 * This value depends on the sampling method defined.
922 * For its meaning, see above.
930 PCAP_API struct pcap_samp *pcap_setsampling(pcap_t *p);
936 /* Maximum length of an host name (needed for the RPCAP active mode) */
937 #define RPCAP_HOSTLIST_SIZE 1024
940 * Some minor differences between UN*X sockets and and Winsock sockets.
944 * \brief In Winsock, a socket handle is of type SOCKET; in UN*X, it's
945 * a file descriptor, and therefore a signed integer.
946 * We define SOCKET to be a signed integer on UN*X, so that it can
947 * be used on both platforms.
952 * \brief In Winsock, the error return if socket() fails is INVALID_SOCKET;
954 * We define INVALID_SOCKET to be -1 on UN*X, so that it can be used on
957 #define INVALID_SOCKET -1
960 PCAP_API SOCKET pcap_remoteact_accept(const char *address, const char *port,
961 const char *hostlist, char *connectinghost,
962 struct pcap_rmtauth *auth, char *errbuf);
963 PCAP_API int pcap_remoteact_list(char *hostlist, char sep, int size,
965 PCAP_API int pcap_remoteact_close(const char *host, char *errbuf);
966 PCAP_API void pcap_remoteact_cleanup(void);
967 #endif /* Remote capture is disabled on FreeBSD */
973 #endif /* lib_pcap_pcap_h */