]> The Tcpdump Group git mirrors - libpcap/blob - pcap/pcap.h
Don't wrap chunks of headers with extern "C" { ... }.
[libpcap] / 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 /*
73 * Some software that uses libpcap/WinPcap/Npcap defines _MSC_VER before
74 * includeing pcap.h if it's not defined - and it defines it to 1500.
75 * (I'm looking at *you*, lwIP!)
76 *
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.
80 */
81 #if defined(_MSC_VER)
82 /*
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.
85 *
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
89 * YOU.
90 *
91 * OK, is _MSC_FULL_VER defined?
92 */
93 #if !defined(_MSC_FULL_VER)
94 /*
95 * According to
96 *
97 * https://sourceforge.net/p/predef/wiki/Compilers/
98 *
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.
102 *
103 * For Visual C++ 6.0, _MSC_VER is defined as 1200.
104 */
105 #if _MSC_VER > 1200
106 /*
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.
109 */
110 #undef _MSC_VER
111 #endif
112 #endif
113 #endif
114
115 #include <pcap/funcattrs.h>
116
117 #include <pcap/pcap-inttypes.h>
118
119 #if defined(_WIN32)
120 #include <winsock2.h> /* u_int, u_char etc. */
121 #include <io.h> /* _get_osfhandle() */
122 #elif defined(MSDOS)
123 #include <sys/types.h> /* u_int, u_char etc. */
124 #include <sys/socket.h>
125 #else /* UN*X */
126 #include <sys/types.h> /* u_int, u_char etc. */
127 #include <sys/time.h>
128 #endif /* _WIN32/MSDOS/UN*X */
129
130 #include <pcap/socket.h> /* for SOCKET, as the active-mode rpcap APIs use it */
131
132 #ifndef PCAP_DONT_INCLUDE_PCAP_BPF_H
133 #include <pcap/bpf.h>
134 #endif
135
136 #include <stdio.h>
137
138 /*
139 * Version number of the current version of the pcap file format.
140 *
141 * NOTE: this is *NOT* the version number of the libpcap library.
142 * To fetch the version information for the version of libpcap
143 * you're using, use pcap_lib_version().
144 */
145 #define PCAP_VERSION_MAJOR 2
146 #define PCAP_VERSION_MINOR 4
147
148 #define PCAP_ERRBUF_SIZE 256
149
150 /*
151 * Compatibility for systems that have a bpf.h that
152 * predates the bpf typedefs for 64-bit support.
153 */
154 #if BPF_RELEASE - 0 < 199406
155 typedef int bpf_int32;
156 typedef u_int bpf_u_int32;
157 #endif
158
159 typedef struct pcap pcap_t;
160 typedef struct pcap_dumper pcap_dumper_t;
161 typedef struct pcap_if pcap_if_t;
162 typedef struct pcap_addr pcap_addr_t;
163
164 /*
165 * The first record in the file contains saved values for some
166 * of the flags used in the printout phases of tcpdump.
167 * Many fields here are 32 bit ints so compilers won't insert unwanted
168 * padding; these files need to be interchangeable across architectures.
169 * Documentation: https://www.tcpdump.org/manpages/pcap-savefile.5.txt.
170 *
171 * Do not change the layout of this structure, in any way (this includes
172 * changes that only affect the length of fields in this structure).
173 *
174 * Also, do not change the interpretation of any of the members of this
175 * structure, in any way (this includes using values other than
176 * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
177 * field).
178 *
179 * Instead:
180 *
181 * introduce a new structure for the new format, if the layout
182 * of the structure changed;
183 *
184 * send mail to "tcpdump-workers@lists.tcpdump.org", requesting
185 * a new magic number for your new capture file format, and, when
186 * you get the new magic number, put it in "savefile.c";
187 *
188 * use that magic number for save files with the changed file
189 * header;
190 *
191 * make the code in "savefile.c" capable of reading files with
192 * the old file header as well as files with the new file header
193 * (using the magic number to determine the header format).
194 *
195 * Then supply the changes by forking the branch at
196 *
197 * https://github.com/the-tcpdump-group/libpcap/tree/master
198 *
199 * and issuing a pull request, so that future versions of libpcap and
200 * programs that use it (such as tcpdump) will be able to read your new
201 * capture file format.
202 */
203 struct pcap_file_header {
204 bpf_u_int32 magic;
205 u_short version_major;
206 u_short version_minor;
207 bpf_int32 thiszone; /* gmt to local correction; this is always 0 */
208 bpf_u_int32 sigfigs; /* accuracy of timestamps; this is always 0 */
209 bpf_u_int32 snaplen; /* max length saved portion of each pkt */
210 bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */
211 };
212
213 /*
214 * Macros for the value returned by pcap_datalink_ext().
215 *
216 * If LT_FCS_LENGTH_PRESENT(x) is true, the LT_FCS_LENGTH(x) macro
217 * gives the FCS length of packets in the capture.
218 */
219 #define LT_FCS_LENGTH_PRESENT(x) ((x) & 0x04000000)
220 #define LT_FCS_LENGTH(x) (((x) & 0xF0000000) >> 28)
221 #define LT_FCS_DATALINK_EXT(x) ((((x) & 0xF) << 28) | 0x04000000)
222
223 typedef enum {
224 PCAP_D_INOUT = 0,
225 PCAP_D_IN,
226 PCAP_D_OUT
227 } pcap_direction_t;
228
229 /*
230 * Generic per-packet information, as supplied by libpcap.
231 *
232 * The time stamp can and should be a "struct timeval", regardless of
233 * whether your system supports 32-bit tv_sec in "struct timeval",
234 * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit
235 * and 64-bit applications. The on-disk format of savefiles uses 32-bit
236 * tv_sec (and tv_usec); this structure is irrelevant to that. 32-bit
237 * and 64-bit versions of libpcap, even if they're on the same platform,
238 * should supply the appropriate version of "struct timeval", even if
239 * that's not what the underlying packet capture mechanism supplies.
240 */
241 struct pcap_pkthdr {
242 struct timeval ts; /* time stamp */
243 bpf_u_int32 caplen; /* length of portion present */
244 bpf_u_int32 len; /* length of this packet (off wire) */
245 };
246
247 /*
248 * As returned by the pcap_stats()
249 */
250 struct pcap_stat {
251 u_int ps_recv; /* number of packets received */
252 u_int ps_drop; /* number of packets dropped */
253 u_int ps_ifdrop; /* drops by interface -- only supported on some platforms */
254 #ifdef _WIN32
255 u_int ps_capt; /* number of packets that reach the application */
256 u_int ps_sent; /* number of packets sent by the server on the network */
257 u_int ps_netdrop; /* number of packets lost on the network */
258 #endif /* _WIN32 */
259 };
260
261 #ifdef MSDOS
262 /*
263 * As returned by the pcap_stats_ex()
264 */
265 struct pcap_stat_ex {
266 u_long rx_packets; /* total packets received */
267 u_long tx_packets; /* total packets transmitted */
268 u_long rx_bytes; /* total bytes received */
269 u_long tx_bytes; /* total bytes transmitted */
270 u_long rx_errors; /* bad packets received */
271 u_long tx_errors; /* packet transmit problems */
272 u_long rx_dropped; /* no space in Rx buffers */
273 u_long tx_dropped; /* no space available for Tx */
274 u_long multicast; /* multicast packets received */
275 u_long collisions;
276
277 /* detailed rx_errors: */
278 u_long rx_length_errors;
279 u_long rx_over_errors; /* receiver ring buff overflow */
280 u_long rx_crc_errors; /* recv'd pkt with crc error */
281 u_long rx_frame_errors; /* recv'd frame alignment error */
282 u_long rx_fifo_errors; /* recv'r fifo overrun */
283 u_long rx_missed_errors; /* recv'r missed packet */
284
285 /* detailed tx_errors */
286 u_long tx_aborted_errors;
287 u_long tx_carrier_errors;
288 u_long tx_fifo_errors;
289 u_long tx_heartbeat_errors;
290 u_long tx_window_errors;
291 };
292 #endif
293
294 /*
295 * Item in a list of interfaces.
296 */
297 struct pcap_if {
298 struct pcap_if *next;
299 char *name; /* name to hand to "pcap_open_live()" */
300 char *description; /* textual description of interface, or NULL */
301 struct pcap_addr *addresses;
302 bpf_u_int32 flags; /* PCAP_IF_ interface flags */
303 };
304
305 #define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */
306 #define PCAP_IF_UP 0x00000002 /* interface is up */
307 #define PCAP_IF_RUNNING 0x00000004 /* interface is running */
308 #define PCAP_IF_WIRELESS 0x00000008 /* interface is wireless (*NOT* necessarily Wi-Fi!) */
309 #define PCAP_IF_CONNECTION_STATUS 0x00000030 /* connection status: */
310 #define PCAP_IF_CONNECTION_STATUS_UNKNOWN 0x00000000 /* unknown */
311 #define PCAP_IF_CONNECTION_STATUS_CONNECTED 0x00000010 /* connected */
312 #define PCAP_IF_CONNECTION_STATUS_DISCONNECTED 0x00000020 /* disconnected */
313 #define PCAP_IF_CONNECTION_STATUS_NOT_APPLICABLE 0x00000030 /* not applicable */
314
315 /*
316 * Representation of an interface address.
317 */
318 struct pcap_addr {
319 struct pcap_addr *next;
320 struct sockaddr *addr; /* address */
321 struct sockaddr *netmask; /* netmask for that address */
322 struct sockaddr *broadaddr; /* broadcast address for that address */
323 struct sockaddr *dstaddr; /* P2P destination address for that address */
324 };
325
326 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
327 const u_char *);
328
329 /*
330 * Error codes for the pcap API.
331 * These will all be negative, so you can check for the success or
332 * failure of a call that returns these codes by checking for a
333 * negative value.
334 */
335 #define PCAP_ERROR -1 /* generic error code */
336 #define PCAP_ERROR_BREAK -2 /* loop terminated by pcap_breakloop */
337 #define PCAP_ERROR_NOT_ACTIVATED -3 /* the capture needs to be activated */
338 #define PCAP_ERROR_ACTIVATED -4 /* the operation can't be performed on already activated captures */
339 #define PCAP_ERROR_NO_SUCH_DEVICE -5 /* no such device exists */
340 #define PCAP_ERROR_RFMON_NOTSUP -6 /* this device doesn't support rfmon (monitor) mode */
341 #define PCAP_ERROR_NOT_RFMON -7 /* operation supported only in monitor mode */
342 #define PCAP_ERROR_PERM_DENIED -8 /* no permission to open the device */
343 #define PCAP_ERROR_IFACE_NOT_UP -9 /* interface isn't up */
344 #define PCAP_ERROR_CANTSET_TSTAMP_TYPE -10 /* this device doesn't support setting the time stamp type */
345 #define PCAP_ERROR_PROMISC_PERM_DENIED -11 /* you don't have permission to capture in promiscuous mode */
346 #define PCAP_ERROR_TSTAMP_PRECISION_NOTSUP -12 /* the requested time stamp precision is not supported */
347
348 /*
349 * Warning codes for the pcap API.
350 * These will all be positive and non-zero, so they won't look like
351 * errors.
352 */
353 #define PCAP_WARNING 1 /* generic warning code */
354 #define PCAP_WARNING_PROMISC_NOTSUP 2 /* this device doesn't support promiscuous mode */
355 #define PCAP_WARNING_TSTAMP_TYPE_NOTSUP 3 /* the requested time stamp type is not supported */
356
357 /*
358 * Value to pass to pcap_compile() as the netmask if you don't know what
359 * the netmask is.
360 */
361 #define PCAP_NETMASK_UNKNOWN 0xffffffff
362
363 /*
364 * Initialize pcap. If this isn't called, pcap is initialized to
365 * a mode source-compatible and binary-compatible with older versions
366 * that lack this routine.
367 */
368
369 /*
370 * Initialization options.
371 * All bits not listed here are reserved for expansion.
372 *
373 * On UNIX-like systems, the local character encoding is assumed to be
374 * UTF-8, so no character encoding transformations are done.
375 *
376 * On Windows, the local character encoding is the local ANSI code page.
377 */
378 #define PCAP_CHAR_ENC_LOCAL 0x00000000U /* strings are in the local character encoding */
379 #define PCAP_CHAR_ENC_UTF_8 0x00000001U /* strings are in UTF-8 */
380
381 PCAP_AVAILABLE_1_10
382 PCAP_EXPORTED_C_FUNC int pcap_init(unsigned int, char *);
383
384 /*
385 * We're deprecating pcap_lookupdev() for various reasons (not
386 * thread-safe, can behave weirdly with WinPcap). Callers
387 * should use pcap_findalldevs() and use the first device.
388 */
389 PCAP_AVAILABLE_0_4
390 PCAP_EXPORTED_C_FUNC char *pcap_lookupdev(char *)
391 PCAP_DEPRECATED(pcap_lookupdev, "use 'pcap_findalldevs' and use the first device");
392
393 PCAP_AVAILABLE_0_4
394 PCAP_EXPORTED_C_FUNC int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
395
396 PCAP_AVAILABLE_1_0
397 PCAP_EXPORTED_C_FUNC pcap_t *pcap_create(const char *, char *);
398
399 PCAP_AVAILABLE_1_0
400 PCAP_EXPORTED_C_FUNC int pcap_set_snaplen(pcap_t *, int);
401
402 PCAP_AVAILABLE_1_0
403 PCAP_EXPORTED_C_FUNC int pcap_set_promisc(pcap_t *, int);
404
405 PCAP_AVAILABLE_1_0
406 PCAP_EXPORTED_C_FUNC int pcap_can_set_rfmon(pcap_t *);
407
408 PCAP_AVAILABLE_1_0
409 PCAP_EXPORTED_C_FUNC int pcap_set_rfmon(pcap_t *, int);
410
411 PCAP_AVAILABLE_1_0
412 PCAP_EXPORTED_C_FUNC int pcap_set_timeout(pcap_t *, int);
413
414 PCAP_AVAILABLE_1_2
415 PCAP_EXPORTED_C_FUNC int pcap_set_tstamp_type(pcap_t *, int);
416
417 PCAP_AVAILABLE_1_5
418 PCAP_EXPORTED_C_FUNC int pcap_set_immediate_mode(pcap_t *, int);
419
420 PCAP_AVAILABLE_1_0
421 PCAP_EXPORTED_C_FUNC int pcap_set_buffer_size(pcap_t *, int);
422
423 PCAP_AVAILABLE_1_5
424 PCAP_EXPORTED_C_FUNC int pcap_set_tstamp_precision(pcap_t *, int);
425
426 PCAP_AVAILABLE_1_5
427 PCAP_EXPORTED_C_FUNC int pcap_get_tstamp_precision(pcap_t *);
428
429 PCAP_AVAILABLE_1_0
430 PCAP_EXPORTED_C_FUNC int pcap_activate(pcap_t *);
431
432 PCAP_AVAILABLE_1_2
433 PCAP_EXPORTED_C_FUNC int pcap_list_tstamp_types(pcap_t *, int **);
434
435 PCAP_AVAILABLE_1_2
436 PCAP_EXPORTED_C_FUNC void pcap_free_tstamp_types(int *);
437
438 PCAP_AVAILABLE_1_2
439 PCAP_EXPORTED_C_FUNC int pcap_tstamp_type_name_to_val(const char *);
440
441 PCAP_AVAILABLE_1_2
442 PCAP_EXPORTED_C_FUNC const char *pcap_tstamp_type_val_to_name(int);
443
444 PCAP_AVAILABLE_1_2
445 PCAP_EXPORTED_C_FUNC const char *pcap_tstamp_type_val_to_description(int);
446
447 #ifdef __linux__
448 PCAP_AVAILABLE_1_9
449 PCAP_EXPORTED_C_FUNC int pcap_set_protocol_linux(pcap_t *, int);
450 #endif
451
452 /*
453 * Time stamp types.
454 * Not all systems and interfaces will necessarily support all of these.
455 *
456 * A system that supports PCAP_TSTAMP_HOST is offering time stamps
457 * provided by the host machine, rather than by the capture device,
458 * but not committing to any characteristics of the time stamp.
459 *
460 * PCAP_TSTAMP_HOST_LOWPREC is a time stamp, provided by the host machine,
461 * that's low-precision but relatively cheap to fetch; it's normally done
462 * using the system clock, so it's normally synchronized with times you'd
463 * fetch from system calls.
464 *
465 * PCAP_TSTAMP_HOST_HIPREC is a time stamp, provided by the host machine,
466 * that's high-precision; it might be more expensive to fetch. It is
467 * synchronized with the system clock.
468 *
469 * PCAP_TSTAMP_HOST_HIPREC_UNSYNCED is a time stamp, provided by the host
470 * machine, that's high-precision; it might be more expensive to fetch.
471 * It is not synchronized with the system clock, and might have
472 * problems with time stamps for packets received on different CPUs,
473 * depending on the platform. It might be more likely to be strictly
474 * monotonic than PCAP_TSTAMP_HOST_HIPREC.
475 *
476 * PCAP_TSTAMP_ADAPTER is a high-precision time stamp supplied by the
477 * capture device; it's synchronized with the system clock.
478 *
479 * PCAP_TSTAMP_ADAPTER_UNSYNCED is a high-precision time stamp supplied by
480 * the capture device; it's not synchronized with the system clock.
481 *
482 * Note that time stamps synchronized with the system clock can go
483 * backwards, as the system clock can go backwards. If a clock is
484 * not in sync with the system clock, that could be because the
485 * system clock isn't keeping accurate time, because the other
486 * clock isn't keeping accurate time, or both.
487 *
488 * Note that host-provided time stamps generally correspond to the
489 * time when the time-stamping code sees the packet; this could
490 * be some unknown amount of time after the first or last bit of
491 * the packet is received by the network adapter, due to batching
492 * of interrupts for packet arrival, queueing delays, etc..
493 */
494 #define PCAP_TSTAMP_HOST 0 /* host-provided, unknown characteristics */
495 #define PCAP_TSTAMP_HOST_LOWPREC 1 /* host-provided, low precision, synced with the system clock */
496 #define PCAP_TSTAMP_HOST_HIPREC 2 /* host-provided, high precision, synced with the system clock */
497 #define PCAP_TSTAMP_ADAPTER 3 /* device-provided, synced with the system clock */
498 #define PCAP_TSTAMP_ADAPTER_UNSYNCED 4 /* device-provided, not synced with the system clock */
499 #define PCAP_TSTAMP_HOST_HIPREC_UNSYNCED 5 /* host-provided, high precision, not synced with the system clock */
500
501 /*
502 * Time stamp resolution types.
503 * Not all systems and interfaces will necessarily support all of these
504 * resolutions when doing live captures; all of them can be requested
505 * when reading a savefile.
506 */
507 #define PCAP_TSTAMP_PRECISION_MICRO 0 /* use timestamps with microsecond precision, default */
508 #define PCAP_TSTAMP_PRECISION_NANO 1 /* use timestamps with nanosecond precision */
509
510 PCAP_AVAILABLE_0_4
511 PCAP_EXPORTED_C_FUNC pcap_t *pcap_open_live(const char *, int, int, int, char *);
512
513 PCAP_AVAILABLE_0_6
514 PCAP_EXPORTED_C_FUNC pcap_t *pcap_open_dead(int, int);
515
516 PCAP_AVAILABLE_1_5
517 PCAP_EXPORTED_C_FUNC pcap_t *pcap_open_dead_with_tstamp_precision(int, int, u_int);
518
519 PCAP_AVAILABLE_1_5
520 PCAP_EXPORTED_C_FUNC pcap_t *pcap_open_offline_with_tstamp_precision(const char *, u_int, char *);
521
522 PCAP_AVAILABLE_0_4
523 PCAP_EXPORTED_C_FUNC pcap_t *pcap_open_offline(const char *, char *);
524
525 #ifdef _WIN32
526 PCAP_AVAILABLE_1_5
527 PCAP_EXPORTED_C_FUNC pcap_t *pcap_hopen_offline_with_tstamp_precision(intptr_t, u_int, char *);
528
529 PCAP_EXPORTED_C_FUNC pcap_t *pcap_hopen_offline(intptr_t, char *);
530 /*
531 * If we're building libpcap, these are internal routines in savefile.c,
532 * so we must not define them as macros.
533 *
534 * If we're not building libpcap, given that the version of the C runtime
535 * with which libpcap was built might be different from the version
536 * of the C runtime with which an application using libpcap was built,
537 * and that a FILE structure may differ between the two versions of the
538 * C runtime, calls to _fileno() must use the version of _fileno() in
539 * the C runtime used to open the FILE *, not the version in the C
540 * runtime with which libpcap was built. (Maybe once the Universal CRT
541 * rules the world, this will cease to be a problem.)
542 */
543 #ifndef BUILDING_PCAP
544 #define pcap_fopen_offline_with_tstamp_precision(f,p,b) \
545 pcap_hopen_offline_with_tstamp_precision(_get_osfhandle(_fileno(f)), p, b)
546 #define pcap_fopen_offline(f,b) \
547 pcap_hopen_offline(_get_osfhandle(_fileno(f)), b)
548 #endif
549 #else /*_WIN32*/
550 PCAP_AVAILABLE_1_5
551 PCAP_EXPORTED_C_FUNC pcap_t *pcap_fopen_offline_with_tstamp_precision(FILE *, u_int, char *);
552
553 PCAP_AVAILABLE_0_9
554 PCAP_EXPORTED_C_FUNC pcap_t *pcap_fopen_offline(FILE *, char *);
555 #endif /*_WIN32*/
556
557 PCAP_AVAILABLE_0_4
558 PCAP_EXPORTED_C_FUNC void pcap_close(pcap_t *);
559
560 PCAP_AVAILABLE_0_4
561 PCAP_EXPORTED_C_FUNC int pcap_loop(pcap_t *, int, pcap_handler, u_char *);
562
563 PCAP_AVAILABLE_0_4
564 PCAP_EXPORTED_C_FUNC int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
565
566 PCAP_AVAILABLE_0_4
567 PCAP_EXPORTED_C_FUNC const u_char *pcap_next(pcap_t *, struct pcap_pkthdr *);
568
569 PCAP_AVAILABLE_0_8
570 PCAP_EXPORTED_C_FUNC int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
571
572 PCAP_AVAILABLE_0_8
573 PCAP_EXPORTED_C_FUNC void pcap_breakloop(pcap_t *);
574
575 PCAP_AVAILABLE_0_4
576 PCAP_EXPORTED_C_FUNC int pcap_stats(pcap_t *, struct pcap_stat *);
577
578 PCAP_AVAILABLE_0_4
579 PCAP_EXPORTED_C_FUNC int pcap_setfilter(pcap_t *, struct bpf_program *);
580
581 PCAP_AVAILABLE_0_9
582 PCAP_EXPORTED_C_FUNC int pcap_setdirection(pcap_t *, pcap_direction_t);
583
584 PCAP_AVAILABLE_0_7
585 PCAP_EXPORTED_C_FUNC int pcap_getnonblock(pcap_t *, char *);
586
587 PCAP_AVAILABLE_0_7
588 PCAP_EXPORTED_C_FUNC int pcap_setnonblock(pcap_t *, int, char *);
589
590 PCAP_AVAILABLE_0_9
591 PCAP_EXPORTED_C_FUNC int pcap_inject(pcap_t *, const void *, size_t);
592
593 PCAP_AVAILABLE_0_8
594 PCAP_EXPORTED_C_FUNC int pcap_sendpacket(pcap_t *, const u_char *, int);
595
596 PCAP_AVAILABLE_1_0
597 PCAP_EXPORTED_C_FUNC const char *pcap_statustostr(int);
598
599 PCAP_AVAILABLE_0_4
600 PCAP_EXPORTED_C_FUNC const char *pcap_strerror(int);
601
602 PCAP_AVAILABLE_0_4
603 PCAP_EXPORTED_C_FUNC char *pcap_geterr(pcap_t *);
604
605 PCAP_AVAILABLE_0_4
606 PCAP_EXPORTED_C_FUNC void pcap_perror(pcap_t *, const char *);
607
608 PCAP_AVAILABLE_0_4
609 PCAP_EXPORTED_C_FUNC int pcap_compile(pcap_t *, struct bpf_program *, const char *, int,
610 bpf_u_int32);
611
612 PCAP_AVAILABLE_0_5
613 PCAP_EXPORTED_C_FUNC int pcap_compile_nopcap(int, int, struct bpf_program *,
614 const char *, int, bpf_u_int32);
615
616 /* XXX - this took two arguments in 0.4 and 0.5 */
617 PCAP_AVAILABLE_0_6
618 PCAP_EXPORTED_C_FUNC void pcap_freecode(struct bpf_program *);
619
620 PCAP_AVAILABLE_1_0
621 PCAP_EXPORTED_C_FUNC int pcap_offline_filter(const struct bpf_program *,
622 const struct pcap_pkthdr *, const u_char *);
623
624 PCAP_AVAILABLE_0_4
625 PCAP_EXPORTED_C_FUNC int pcap_datalink(pcap_t *);
626
627 PCAP_AVAILABLE_1_0
628 PCAP_EXPORTED_C_FUNC int pcap_datalink_ext(pcap_t *);
629
630 PCAP_AVAILABLE_0_8
631 PCAP_EXPORTED_C_FUNC int pcap_list_datalinks(pcap_t *, int **);
632
633 PCAP_AVAILABLE_0_8
634 PCAP_EXPORTED_C_FUNC int pcap_set_datalink(pcap_t *, int);
635
636 PCAP_AVAILABLE_0_8
637 PCAP_EXPORTED_C_FUNC void pcap_free_datalinks(int *);
638
639 PCAP_AVAILABLE_0_8
640 PCAP_EXPORTED_C_FUNC int pcap_datalink_name_to_val(const char *);
641
642 PCAP_AVAILABLE_0_8
643 PCAP_EXPORTED_C_FUNC const char *pcap_datalink_val_to_name(int);
644
645 PCAP_AVAILABLE_0_8
646 PCAP_EXPORTED_C_FUNC const char *pcap_datalink_val_to_description(int);
647
648 PCAP_AVAILABLE_1_10
649 PCAP_EXPORTED_C_FUNC const char *pcap_datalink_val_to_description_or_dlt(int);
650
651 PCAP_AVAILABLE_0_4
652 PCAP_EXPORTED_C_FUNC int pcap_snapshot(pcap_t *);
653
654 PCAP_AVAILABLE_0_4
655 PCAP_EXPORTED_C_FUNC int pcap_is_swapped(pcap_t *);
656
657 PCAP_AVAILABLE_0_4
658 PCAP_EXPORTED_C_FUNC int pcap_major_version(pcap_t *);
659
660 PCAP_AVAILABLE_0_4
661 PCAP_EXPORTED_C_FUNC int pcap_minor_version(pcap_t *);
662
663 PCAP_AVAILABLE_1_9
664 PCAP_EXPORTED_C_FUNC int pcap_bufsize(pcap_t *);
665
666 /* XXX */
667 PCAP_AVAILABLE_0_4
668 PCAP_EXPORTED_C_FUNC FILE *pcap_file(pcap_t *);
669
670 #ifdef _WIN32
671 /*
672 * This probably shouldn't have been kept in WinPcap; most if not all
673 * UN*X code that used it won't work on Windows. We deprecate it; if
674 * anybody really needs access to whatever HANDLE may be associated
675 * with a pcap_t (there's no guarantee that there is one), we can add
676 * a Windows-only pcap_handle() API that returns the HANDLE.
677 */
678 PCAP_AVAILABLE_0_4
679 PCAP_EXPORTED_C_FUNC int pcap_fileno(pcap_t *)
680 PCAP_DEPRECATED(pcap_fileno, "use 'pcap_handle'");
681 #else /* _WIN32 */
682 PCAP_AVAILABLE_0_4
683 PCAP_EXPORTED_C_FUNC int pcap_fileno(pcap_t *);
684 #endif /* _WIN32 */
685
686 #ifdef _WIN32
687 PCAP_EXPORTED_C_FUNC int pcap_wsockinit(void);
688 #endif
689
690 PCAP_AVAILABLE_0_4
691 PCAP_EXPORTED_C_FUNC pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
692
693 #ifdef _WIN32
694 PCAP_AVAILABLE_0_9
695 PCAP_EXPORTED_C_FUNC pcap_dumper_t *pcap_dump_hopen(pcap_t *, intptr_t);
696
697 /*
698 * If we're building libpcap, this is an internal routine in sf-pcap.c, so
699 * we must not define it as a macro.
700 *
701 * If we're not building libpcap, given that the version of the C runtime
702 * with which libpcap was built might be different from the version
703 * of the C runtime with which an application using libpcap was built,
704 * and that a FILE structure may differ between the two versions of the
705 * C runtime, calls to _fileno() must use the version of _fileno() in
706 * the C runtime used to open the FILE *, not the version in the C
707 * runtime with which libpcap was built. (Maybe once the Universal CRT
708 * rules the world, this will cease to be a problem.)
709 */
710 #ifndef BUILDING_PCAP
711 #define pcap_dump_fopen(p,f) \
712 pcap_dump_hopen(p, _get_osfhandle(_fileno(f)))
713 #endif
714 #else /*_WIN32*/
715 PCAP_AVAILABLE_0_9
716 PCAP_EXPORTED_C_FUNC pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp);
717 #endif /*_WIN32*/
718
719 PCAP_AVAILABLE_1_7
720 PCAP_EXPORTED_C_FUNC pcap_dumper_t *pcap_dump_open_append(pcap_t *, const char *);
721
722 PCAP_AVAILABLE_0_8
723 PCAP_EXPORTED_C_FUNC FILE *pcap_dump_file(pcap_dumper_t *);
724
725 PCAP_AVAILABLE_0_9
726 PCAP_EXPORTED_C_FUNC long pcap_dump_ftell(pcap_dumper_t *);
727
728 PCAP_AVAILABLE_1_9
729 PCAP_EXPORTED_C_FUNC int64_t pcap_dump_ftell64(pcap_dumper_t *);
730
731 PCAP_AVAILABLE_0_8
732 PCAP_EXPORTED_C_FUNC int pcap_dump_flush(pcap_dumper_t *);
733
734 PCAP_AVAILABLE_0_4
735 PCAP_EXPORTED_C_FUNC void pcap_dump_close(pcap_dumper_t *);
736
737 PCAP_AVAILABLE_0_4
738 PCAP_EXPORTED_C_FUNC void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
739
740 PCAP_AVAILABLE_0_7
741 PCAP_EXPORTED_C_FUNC int pcap_findalldevs(pcap_if_t **, char *);
742
743 PCAP_AVAILABLE_0_7
744 PCAP_EXPORTED_C_FUNC void pcap_freealldevs(pcap_if_t *);
745
746 /*
747 * We return a pointer to the version string, rather than exporting the
748 * version string directly.
749 *
750 * On at least some UNIXes, if you import data from a shared library into
751 * a program, the data is bound into the program binary, so if the string
752 * in the version of the library with which the program was linked isn't
753 * the same as the string in the version of the library with which the
754 * program is being run, various undesirable things may happen (warnings,
755 * the string being the one from the version of the library with which the
756 * program was linked, or even weirder things, such as the string being the
757 * one from the library but being truncated).
758 *
759 * On Windows, the string is constructed at run time.
760 */
761 PCAP_AVAILABLE_0_8
762 PCAP_EXPORTED_C_FUNC const char *pcap_lib_version(void);
763
764 #if defined(_WIN32)
765
766 /*
767 * Win32 definitions
768 */
769
770 /*!
771 \brief A queue of raw packets that will be sent to the network with pcap_sendqueue_transmit().
772 */
773 struct pcap_send_queue
774 {
775 u_int maxlen; /* Maximum size of the queue, in bytes. This
776 variable contains the size of the buffer field. */
777 u_int len; /* Current size of the queue, in bytes. */
778 char *buffer; /* Buffer containing the packets to be sent. */
779 };
780
781 typedef struct pcap_send_queue pcap_send_queue;
782
783 /*!
784 \brief This typedef is a support for the pcap_get_airpcap_handle() function
785 */
786 #if !defined(AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_)
787 #define AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_
788 typedef struct _AirpcapHandle *PAirpcapHandle;
789 #endif
790
791 PCAP_EXPORTED_C_FUNC int pcap_setbuff(pcap_t *p, int dim);
792 PCAP_EXPORTED_C_FUNC int pcap_setmode(pcap_t *p, int mode);
793 PCAP_EXPORTED_C_FUNC int pcap_setmintocopy(pcap_t *p, int size);
794
795 PCAP_EXPORTED_C_FUNC HANDLE pcap_getevent(pcap_t *p);
796
797 PCAP_AVAILABLE_1_8
798 PCAP_EXPORTED_C_FUNC int pcap_oid_get_request(pcap_t *, bpf_u_int32, void *, size_t *);
799
800 PCAP_AVAILABLE_1_8
801 PCAP_EXPORTED_C_FUNC int pcap_oid_set_request(pcap_t *, bpf_u_int32, const void *, size_t *);
802
803 PCAP_EXPORTED_C_FUNC pcap_send_queue* pcap_sendqueue_alloc(u_int memsize);
804
805 PCAP_EXPORTED_C_FUNC void pcap_sendqueue_destroy(pcap_send_queue* queue);
806
807 PCAP_EXPORTED_C_FUNC int pcap_sendqueue_queue(pcap_send_queue* queue, const struct pcap_pkthdr *pkt_header, const u_char *pkt_data);
808
809 PCAP_EXPORTED_C_FUNC u_int pcap_sendqueue_transmit(pcap_t *p, pcap_send_queue* queue, int sync);
810
811 PCAP_EXPORTED_C_FUNC struct pcap_stat *pcap_stats_ex(pcap_t *p, int *pcap_stat_size);
812
813 PCAP_EXPORTED_C_FUNC int pcap_setuserbuffer(pcap_t *p, int size);
814
815 PCAP_EXPORTED_C_FUNC int pcap_live_dump(pcap_t *p, char *filename, int maxsize, int maxpacks);
816
817 PCAP_EXPORTED_C_FUNC int pcap_live_dump_ended(pcap_t *p, int sync);
818
819 PCAP_EXPORTED_C_FUNC int pcap_start_oem(char* err_str, int flags);
820
821 PCAP_EXPORTED_C_FUNC PAirpcapHandle pcap_get_airpcap_handle(pcap_t *p);
822
823 #define MODE_CAPT 0
824 #define MODE_STAT 1
825 #define MODE_MON 2
826
827 #elif defined(MSDOS)
828
829 /*
830 * MS-DOS definitions
831 */
832
833 PCAP_EXPORTED_C_FUNC int pcap_stats_ex (pcap_t *, struct pcap_stat_ex *);
834 PCAP_EXPORTED_C_FUNC void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait);
835 PCAP_EXPORTED_C_FUNC u_long pcap_mac_packets (void);
836
837 #else /* UN*X */
838
839 /*
840 * UN*X definitions
841 */
842
843 PCAP_AVAILABLE_0_8
844 PCAP_EXPORTED_C_FUNC int pcap_get_selectable_fd(pcap_t *);
845
846 PCAP_AVAILABLE_1_9
847 PCAP_EXPORTED_C_FUNC const struct timeval *pcap_get_required_select_timeout(pcap_t *);
848
849 #endif /* _WIN32/MSDOS/UN*X */
850
851 /*
852 * Remote capture definitions.
853 *
854 * These routines are only present if libpcap has been configured to
855 * include remote capture support.
856 */
857
858 /*
859 * The maximum buffer size in which address, port, interface names are kept.
860 *
861 * In case the adapter name or such is larger than this value, it is truncated.
862 * This is not used by the user; however it must be aware that an hostname / interface
863 * name longer than this value will be truncated.
864 */
865 #define PCAP_BUF_SIZE 1024
866
867 /*
868 * The type of input source, passed to pcap_open().
869 */
870 #define PCAP_SRC_FILE 2 /* local savefile */
871 #define PCAP_SRC_IFLOCAL 3 /* local network interface */
872 #define PCAP_SRC_IFREMOTE 4 /* interface on a remote host, using RPCAP */
873
874 /*
875 * The formats allowed by pcap_open() are the following:
876 * - file://path_and_filename [opens a local file]
877 * - rpcap://devicename [opens the selected device devices available on the local host, without using the RPCAP protocol]
878 * - rpcap://host/devicename [opens the selected device available on a remote host]
879 * - rpcap://host:port/devicename [opens the selected device available on a remote host, using a non-standard port for RPCAP]
880 * - adaptername [to open a local adapter; kept for compatibility, but it is strongly discouraged]
881 * - (NULL) [to open the first local adapter; kept for compatibility, but it is strongly discouraged]
882 *
883 * The formats allowed by the pcap_findalldevs_ex() are the following:
884 * - file://folder/ [lists all the files in the given folder]
885 * - rpcap:// [lists all local adapters]
886 * - rpcap://host:port/ [lists the devices available on a remote host]
887 *
888 * In all the above, "rpcaps://" can be substituted for "rpcap://" to enable
889 * SSL (if it has been compiled in).
890 *
891 * Referring to the 'host' and 'port' parameters, they can be either numeric or literal. Since
892 * IPv6 is fully supported, these are the allowed formats:
893 *
894 * - host (literal): e.g. host.foo.bar
895 * - host (numeric IPv4): e.g. 10.11.12.13
896 * - host (numeric IPv4, IPv6 style): e.g. [10.11.12.13]
897 * - host (numeric IPv6): e.g. [1:2:3::4]
898 * - port: can be either numeric (e.g. '80') or literal (e.g. 'http')
899 *
900 * Here you find some allowed examples:
901 * - rpcap://host.foo.bar/devicename [everything literal, no port number]
902 * - rpcap://host.foo.bar:1234/devicename [everything literal, with port number]
903 * - rpcap://10.11.12.13/devicename [IPv4 numeric, no port number]
904 * - rpcap://10.11.12.13:1234/devicename [IPv4 numeric, with port number]
905 * - rpcap://[10.11.12.13]:1234/devicename [IPv4 numeric with IPv6 format, with port number]
906 * - rpcap://[1:2:3::4]/devicename [IPv6 numeric, no port number]
907 * - rpcap://[1:2:3::4]:1234/devicename [IPv6 numeric, with port number]
908 * - rpcap://[1:2:3::4]:http/devicename [IPv6 numeric, with literal port number]
909 */
910
911 /*
912 * URL schemes for capture source.
913 */
914 /*
915 * This string indicates that the user wants to open a capture from a
916 * local file.
917 */
918 #define PCAP_SRC_FILE_STRING "file://"
919 /*
920 * This string indicates that the user wants to open a capture from a
921 * network interface. This string does not necessarily involve the use
922 * of the RPCAP protocol. If the interface required resides on the local
923 * host, the RPCAP protocol is not involved and the local functions are used.
924 */
925 #define PCAP_SRC_IF_STRING "rpcap://"
926
927 /*
928 * Flags to pass to pcap_open().
929 */
930
931 /*
932 * Specifies whether promiscuous mode is to be used.
933 */
934 #define PCAP_OPENFLAG_PROMISCUOUS 0x00000001
935
936 /*
937 * Specifies, for an RPCAP capture, whether the data transfer (in
938 * case of a remote capture) has to be done with UDP protocol.
939 *
940 * If it is '1' if you want a UDP data connection, '0' if you want
941 * a TCP data connection; control connection is always TCP-based.
942 * A UDP connection is much lighter, but it does not guarantee that all
943 * the captured packets arrive to the client workstation. Moreover,
944 * it could be harmful in case of network congestion.
945 * This flag is meaningless if the source is not a remote interface.
946 * In that case, it is simply ignored.
947 */
948 #define PCAP_OPENFLAG_DATATX_UDP 0x00000002
949
950 /*
951 * Specifies whether the remote probe will capture its own generated
952 * traffic.
953 *
954 * In case the remote probe uses the same interface to capture traffic
955 * and to send data back to the caller, the captured traffic includes
956 * the RPCAP traffic as well. If this flag is turned on, the RPCAP
957 * traffic is excluded from the capture, so that the trace returned
958 * back to the collector is does not include this traffic.
959 *
960 * Has no effect on local interfaces or savefiles.
961 */
962 #define PCAP_OPENFLAG_NOCAPTURE_RPCAP 0x00000004
963
964 /*
965 * Specifies whether the local adapter will capture its own generated traffic.
966 *
967 * This flag tells the underlying capture driver to drop the packets
968 * that were sent by itself. This is useful when building applications
969 * such as bridges that should ignore the traffic they just sent.
970 *
971 * Supported only on Windows.
972 */
973 #define PCAP_OPENFLAG_NOCAPTURE_LOCAL 0x00000008
974
975 /*
976 * This flag configures the adapter for maximum responsiveness.
977 *
978 * In presence of a large value for nbytes, WinPcap waits for the arrival
979 * of several packets before copying the data to the user. This guarantees
980 * a low number of system calls, i.e. lower processor usage, i.e. better
981 * performance, which is good for applications like sniffers. If the user
982 * sets the PCAP_OPENFLAG_MAX_RESPONSIVENESS flag, the capture driver will
983 * copy the packets as soon as the application is ready to receive them.
984 * This is suggested for real time applications (such as, for example,
985 * a bridge) that need the best responsiveness.
986 *
987 * The equivalent with pcap_create()/pcap_activate() is "immediate mode".
988 */
989 #define PCAP_OPENFLAG_MAX_RESPONSIVENESS 0x00000010
990
991 /*
992 * Remote authentication methods.
993 * These are used in the 'type' member of the pcap_rmtauth structure.
994 */
995
996 /*
997 * NULL authentication.
998 *
999 * The 'NULL' authentication has to be equal to 'zero', so that old
1000 * applications can just put every field of struct pcap_rmtauth to zero,
1001 * and it does work.
1002 */
1003 #define RPCAP_RMTAUTH_NULL 0
1004 /*
1005 * Username/password authentication.
1006 *
1007 * With this type of authentication, the RPCAP protocol will use the username/
1008 * password provided to authenticate the user on the remote machine. If the
1009 * authentication is successful (and the user has the right to open network
1010 * devices) the RPCAP connection will continue; otherwise it will be dropped.
1011 *
1012 * *******NOTE********: the username and password are sent over the network
1013 * to the capture server *IN CLEAR TEXT*. Don't use this on a network
1014 * that you don't completely control! (And be *really* careful in your
1015 * definition of "completely"!)
1016 */
1017 #define RPCAP_RMTAUTH_PWD 1
1018
1019 /*
1020 * This structure keeps the information needed to authenticate the user
1021 * on a remote machine.
1022 *
1023 * The remote machine can either grant or refuse the access according
1024 * to the information provided.
1025 * In case the NULL authentication is required, both 'username' and
1026 * 'password' can be NULL pointers.
1027 *
1028 * This structure is meaningless if the source is not a remote interface;
1029 * in that case, the functions which requires such a structure can accept
1030 * a NULL pointer as well.
1031 */
1032 struct pcap_rmtauth
1033 {
1034 /*
1035 * \brief Type of the authentication required.
1036 *
1037 * In order to provide maximum flexibility, we can support different types
1038 * of authentication based on the value of this 'type' variable. The currently
1039 * supported authentication methods are defined into the
1040 * \link remote_auth_methods Remote Authentication Methods Section\endlink.
1041 */
1042 int type;
1043 /*
1044 * \brief Zero-terminated string containing the username that has to be
1045 * used on the remote machine for authentication.
1046 *
1047 * This field is meaningless in case of the RPCAP_RMTAUTH_NULL authentication
1048 * and it can be NULL.
1049 */
1050 char *username;
1051 /*
1052 * \brief Zero-terminated string containing the password that has to be
1053 * used on the remote machine for authentication.
1054 *
1055 * This field is meaningless in case of the RPCAP_RMTAUTH_NULL authentication
1056 * and it can be NULL.
1057 */
1058 char *password;
1059 };
1060
1061 /*
1062 * This routine can open a savefile, a local device, or a device on
1063 * a remote machine running an RPCAP server.
1064 *
1065 * For opening a savefile, the pcap_open_offline routines can be used,
1066 * and will work just as well; code using them will work on more
1067 * platforms than code using pcap_open() to open savefiles.
1068 *
1069 * For opening a local device, pcap_open_live() can be used; it supports
1070 * most of the capabilities that pcap_open() supports, and code using it
1071 * will work on more platforms than code using pcap_open(). pcap_create()
1072 * and pcap_activate() can also be used; they support all capabilities
1073 * that pcap_open() supports, except for the Windows-only
1074 * PCAP_OPENFLAG_NOCAPTURE_LOCAL, and support additional capabilities.
1075 *
1076 * For opening a remote capture, pcap_open() is currently the only
1077 * API available.
1078 */
1079 PCAP_AVAILABLE_1_9
1080 PCAP_EXPORTED_C_FUNC pcap_t *pcap_open(const char *source, int snaplen, int flags,
1081 int read_timeout, struct pcap_rmtauth *auth, char *errbuf);
1082
1083 PCAP_AVAILABLE_1_9
1084 PCAP_EXPORTED_C_FUNC int pcap_createsrcstr(char *source, int type, const char *host,
1085 const char *port, const char *name, char *errbuf);
1086
1087 PCAP_AVAILABLE_1_9
1088 PCAP_EXPORTED_C_FUNC int pcap_parsesrcstr(const char *source, int *type, char *host,
1089 char *port, char *name, char *errbuf);
1090
1091 /*
1092 * This routine can scan a directory for savefiles, list local capture
1093 * devices, or list capture devices on a remote machine running an RPCAP
1094 * server.
1095 *
1096 * For scanning for savefiles, it can be used on both UN*X systems and
1097 * Windows systems; for each directory entry it sees, it tries to open
1098 * the file as a savefile using pcap_open_offline(), and only includes
1099 * it in the list of files if the open succeeds, so it filters out
1100 * files for which the user doesn't have read permission, as well as
1101 * files that aren't valid savefiles readable by libpcap.
1102 *
1103 * For listing local capture devices, it's just a wrapper around
1104 * pcap_findalldevs(); code using pcap_findalldevs() will work on more
1105 * platforms than code using pcap_findalldevs_ex().
1106 *
1107 * For listing remote capture devices, pcap_findalldevs_ex() is currently
1108 * the only API available.
1109 */
1110 PCAP_AVAILABLE_1_9
1111 PCAP_EXPORTED_C_FUNC int pcap_findalldevs_ex(const char *source,
1112 struct pcap_rmtauth *auth, pcap_if_t **alldevs, char *errbuf);
1113
1114 /*
1115 * Sampling methods.
1116 *
1117 * These allow pcap_loop(), pcap_dispatch(), pcap_next(), and pcap_next_ex()
1118 * to see only a sample of packets, rather than all packets.
1119 *
1120 * Currently, they work only on Windows local captures.
1121 */
1122
1123 /*
1124 * Specifies that no sampling is to be done on the current capture.
1125 *
1126 * In this case, no sampling algorithms are applied to the current capture.
1127 */
1128 #define PCAP_SAMP_NOSAMP 0
1129
1130 /*
1131 * Specifies that only 1 out of N packets must be returned to the user.
1132 *
1133 * In this case, the 'value' field of the 'pcap_samp' structure indicates the
1134 * number of packets (minus 1) that must be discarded before one packet got
1135 * accepted.
1136 * In other words, if 'value = 10', the first packet is returned to the
1137 * caller, while the following 9 are discarded.
1138 */
1139 #define PCAP_SAMP_1_EVERY_N 1
1140
1141 /*
1142 * Specifies that we have to return 1 packet every N milliseconds.
1143 *
1144 * In this case, the 'value' field of the 'pcap_samp' structure indicates
1145 * the 'waiting time' in milliseconds before one packet got accepted.
1146 * In other words, if 'value = 10', the first packet is returned to the
1147 * caller; the next returned one will be the first packet that arrives
1148 * when 10ms have elapsed.
1149 */
1150 #define PCAP_SAMP_FIRST_AFTER_N_MS 2
1151
1152 /*
1153 * This structure defines the information related to sampling.
1154 *
1155 * In case the sampling is requested, the capturing device should read
1156 * only a subset of the packets coming from the source. The returned packets
1157 * depend on the sampling parameters.
1158 *
1159 * WARNING: The sampling process is applied *after* the filtering process.
1160 * In other words, packets are filtered first, then the sampling process
1161 * selects a subset of the 'filtered' packets and it returns them to the
1162 * caller.
1163 */
1164 struct pcap_samp
1165 {
1166 /*
1167 * Method used for sampling; see above.
1168 */
1169 int method;
1170
1171 /*
1172 * This value depends on the sampling method defined.
1173 * For its meaning, see above.
1174 */
1175 int value;
1176 };
1177
1178 /*
1179 * New functions.
1180 */
1181 PCAP_AVAILABLE_1_9
1182 PCAP_EXPORTED_C_FUNC struct pcap_samp *pcap_setsampling(pcap_t *p);
1183
1184 /*
1185 * RPCAP active mode.
1186 */
1187
1188 /* Maximum length of an host name (needed for the RPCAP active mode) */
1189 #define RPCAP_HOSTLIST_SIZE 1024
1190
1191 PCAP_AVAILABLE_1_9
1192 PCAP_EXPORTED_C_FUNC SOCKET pcap_remoteact_accept(const char *address, const char *port,
1193 const char *hostlist, char *connectinghost,
1194 struct pcap_rmtauth *auth, char *errbuf);
1195
1196 PCAP_AVAILABLE_1_10
1197 PCAP_EXPORTED_C_FUNC SOCKET pcap_remoteact_accept_ex(const char *address, const char *port,
1198 const char *hostlist, char *connectinghost,
1199 struct pcap_rmtauth *auth, int uses_ssl, char *errbuf);
1200
1201 PCAP_AVAILABLE_1_9
1202 PCAP_EXPORTED_C_FUNC int pcap_remoteact_list(char *hostlist, char sep, int size,
1203 char *errbuf);
1204
1205 PCAP_AVAILABLE_1_9
1206 PCAP_EXPORTED_C_FUNC int pcap_remoteact_close(const char *host, char *errbuf);
1207
1208 PCAP_AVAILABLE_1_9
1209 PCAP_EXPORTED_C_FUNC void pcap_remoteact_cleanup(void);
1210
1211 #endif /* lib_pcap_pcap_h */