• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 #ifdef __cplusplus
139 extern "C" {
140 #endif
141 
142 /*
143  * Version number of the current version of the pcap file format.
144  *
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().
148  */
149 #define PCAP_VERSION_MAJOR 2
150 #define PCAP_VERSION_MINOR 4
151 
152 #define PCAP_ERRBUF_SIZE 256
153 
154 /*
155  * Compatibility for systems that have a bpf.h that
156  * predates the bpf typedefs for 64-bit support.
157  */
158 #if BPF_RELEASE - 0 < 199406
159 typedef	int bpf_int32;
160 typedef	u_int bpf_u_int32;
161 #endif
162 
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;
167 
168 /*
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.
174  *
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).
177  *
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"
181  * field).
182  *
183  * Instead:
184  *
185  *	introduce a new structure for the new format, if the layout
186  *	of the structure changed;
187  *
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";
191  *
192  *	use that magic number for save files with the changed file
193  *	header;
194  *
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).
198  *
199  * Then supply the changes by forking the branch at
200  *
201  *	https://github.com/the-tcpdump-group/libpcap/tree/master
202  *
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.
206  */
207 struct pcap_file_header {
208 	bpf_u_int32 magic;
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_*) */
215 };
216 
217 /*
218  * Macros for the value returned by pcap_datalink_ext().
219  *
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.
222  */
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)
226 
227 typedef enum {
228        PCAP_D_INOUT = 0,
229        PCAP_D_IN,
230        PCAP_D_OUT
231 } pcap_direction_t;
232 
233 /*
234  * Generic per-packet information, as supplied by libpcap.
235  *
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.
244  */
245 struct pcap_pkthdr {
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) */
249 };
250 
251 /*
252  * As returned by the pcap_stats()
253  */
254 struct pcap_stat {
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 */
258 #ifdef _WIN32
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 */
262 #endif /* _WIN32 */
263 };
264 
265 #ifdef MSDOS
266 /*
267  * As returned by the pcap_stats_ex()
268  */
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   */
279        u_long  collisions;
280 
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         */
288 
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;
295      };
296 #endif
297 
298 /*
299  * Item in a list of interfaces.
300  */
301 struct pcap_if {
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 */
307 };
308 
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 */
318 
319 /*
320  * Representation of an interface address.
321  */
322 struct pcap_addr {
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 */
328 };
329 
330 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
331 			     const u_char *);
332 
333 /*
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
337  * negative value.
338  */
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 */
351 
352 /*
353  * Warning codes for the pcap API.
354  * These will all be positive and non-zero, so they won't look like
355  * errors.
356  */
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 */
360 
361 /*
362  * Value to pass to pcap_compile() as the netmask if you don't know what
363  * the netmask is.
364  */
365 #define PCAP_NETMASK_UNKNOWN	0xffffffff
366 
367 /*
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.
371  */
372 
373 /*
374  * Initialization options.
375  * All bits not listed here are reserved for expansion.
376  *
377  * On UNIX-like systems, the local character encoding is assumed to be
378  * UTF-8, so no character encoding transformations are done.
379  *
380  * On Windows, the local character encoding is the local ANSI code page.
381  */
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 */
384 
385 PCAP_AVAILABLE_1_10
386 PCAP_API int	pcap_init(unsigned int, char *);
387 
388 /*
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.
392  */
393 PCAP_AVAILABLE_0_4
394 PCAP_API char	*pcap_lookupdev(char *)
395 PCAP_DEPRECATED(pcap_lookupdev, "use 'pcap_findalldevs' and use the first device");
396 
397 PCAP_AVAILABLE_0_4
398 PCAP_API int	pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
399 
400 PCAP_AVAILABLE_1_0
401 PCAP_API pcap_t	*pcap_create(const char *, char *);
402 
403 PCAP_AVAILABLE_1_0
404 PCAP_API int	pcap_set_snaplen(pcap_t *, int);
405 
406 PCAP_AVAILABLE_1_0
407 PCAP_API int	pcap_set_promisc(pcap_t *, int);
408 
409 PCAP_AVAILABLE_1_0
410 PCAP_API int	pcap_can_set_rfmon(pcap_t *);
411 
412 PCAP_AVAILABLE_1_0
413 PCAP_API int	pcap_set_rfmon(pcap_t *, int);
414 
415 PCAP_AVAILABLE_1_0
416 PCAP_API int	pcap_set_timeout(pcap_t *, int);
417 
418 PCAP_AVAILABLE_1_2
419 PCAP_API int	pcap_set_tstamp_type(pcap_t *, int);
420 
421 PCAP_AVAILABLE_1_5
422 PCAP_API int	pcap_set_immediate_mode(pcap_t *, int);
423 
424 PCAP_AVAILABLE_1_0
425 PCAP_API int	pcap_set_buffer_size(pcap_t *, int);
426 
427 PCAP_AVAILABLE_1_5
428 PCAP_API int	pcap_set_tstamp_precision(pcap_t *, int);
429 
430 PCAP_AVAILABLE_1_5
431 PCAP_API int	pcap_get_tstamp_precision(pcap_t *);
432 
433 PCAP_AVAILABLE_1_0
434 PCAP_API int	pcap_activate(pcap_t *);
435 
436 PCAP_AVAILABLE_1_2
437 PCAP_API int	pcap_list_tstamp_types(pcap_t *, int **);
438 
439 PCAP_AVAILABLE_1_2
440 PCAP_API void	pcap_free_tstamp_types(int *);
441 
442 PCAP_AVAILABLE_1_2
443 PCAP_API int	pcap_tstamp_type_name_to_val(const char *);
444 
445 PCAP_AVAILABLE_1_2
446 PCAP_API const char *pcap_tstamp_type_val_to_name(int);
447 
448 PCAP_AVAILABLE_1_2
449 PCAP_API const char *pcap_tstamp_type_val_to_description(int);
450 
451 #ifdef __linux__
452 PCAP_AVAILABLE_1_9
453 PCAP_API int	pcap_set_protocol_linux(pcap_t *, int);
454 #endif
455 
456 /*
457  * Time stamp types.
458  * Not all systems and interfaces will necessarily support all of these.
459  *
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.
463  *
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.
468  *
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.
472  *
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.
479  *
480  * PCAP_TSTAMP_ADAPTER is a high-precision time stamp supplied by the
481  * capture device; it's synchronized with the system clock.
482  *
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.
485  *
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.
491  *
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..
497  */
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 */
504 
505 /*
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.
510  */
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 */
513 
514 PCAP_AVAILABLE_0_4
515 PCAP_API pcap_t	*pcap_open_live(const char *, int, int, int, char *);
516 
517 PCAP_AVAILABLE_0_6
518 PCAP_API pcap_t	*pcap_open_dead(int, int);
519 
520 PCAP_AVAILABLE_1_5
521 PCAP_API pcap_t	*pcap_open_dead_with_tstamp_precision(int, int, u_int);
522 
523 PCAP_AVAILABLE_1_5
524 PCAP_API pcap_t	*pcap_open_offline_with_tstamp_precision(const char *, u_int, char *);
525 
526 PCAP_AVAILABLE_0_4
527 PCAP_API pcap_t	*pcap_open_offline(const char *, char *);
528 
529 #ifdef _WIN32
530   PCAP_AVAILABLE_1_5
531   PCAP_API pcap_t  *pcap_hopen_offline_with_tstamp_precision(intptr_t, u_int, char *);
532 
533   PCAP_API pcap_t  *pcap_hopen_offline(intptr_t, char *);
534   /*
535    * If we're building libpcap, these are internal routines in savefile.c,
536    * so we must not define them as macros.
537    *
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.)
546    */
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)
552   #endif
553 #else /*_WIN32*/
554   PCAP_AVAILABLE_1_5
555   PCAP_API pcap_t	*pcap_fopen_offline_with_tstamp_precision(FILE *, u_int, char *);
556 
557   PCAP_AVAILABLE_0_9
558   PCAP_API pcap_t	*pcap_fopen_offline(FILE *, char *);
559 #endif /*_WIN32*/
560 
561 PCAP_AVAILABLE_0_4
562 PCAP_API void	pcap_close(pcap_t *);
563 
564 PCAP_AVAILABLE_0_4
565 PCAP_API int	pcap_loop(pcap_t *, int, pcap_handler, u_char *);
566 
567 PCAP_AVAILABLE_0_4
568 PCAP_API int	pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
569 
570 PCAP_AVAILABLE_0_4
571 PCAP_API const u_char *pcap_next(pcap_t *, struct pcap_pkthdr *);
572 
573 PCAP_AVAILABLE_0_8
574 PCAP_API int 	pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
575 
576 PCAP_AVAILABLE_0_8
577 PCAP_API void	pcap_breakloop(pcap_t *);
578 
579 PCAP_AVAILABLE_0_4
580 PCAP_API int	pcap_stats(pcap_t *, struct pcap_stat *);
581 
582 PCAP_AVAILABLE_0_4
583 PCAP_API int	pcap_setfilter(pcap_t *, struct bpf_program *);
584 
585 PCAP_AVAILABLE_0_9
586 PCAP_API int 	pcap_setdirection(pcap_t *, pcap_direction_t);
587 
588 PCAP_AVAILABLE_0_7
589 PCAP_API int	pcap_getnonblock(pcap_t *, char *);
590 
591 PCAP_AVAILABLE_0_7
592 PCAP_API int	pcap_setnonblock(pcap_t *, int, char *);
593 
594 PCAP_AVAILABLE_0_9
595 PCAP_API int	pcap_inject(pcap_t *, const void *, size_t);
596 
597 PCAP_AVAILABLE_0_8
598 PCAP_API int	pcap_sendpacket(pcap_t *, const u_char *, int);
599 
600 PCAP_AVAILABLE_1_0
601 PCAP_API const char *pcap_statustostr(int);
602 
603 PCAP_AVAILABLE_0_4
604 PCAP_API const char *pcap_strerror(int);
605 
606 PCAP_AVAILABLE_0_4
607 PCAP_API char	*pcap_geterr(pcap_t *);
608 
609 PCAP_AVAILABLE_0_4
610 PCAP_API void	pcap_perror(pcap_t *, const char *);
611 
612 PCAP_AVAILABLE_0_4
613 PCAP_API int	pcap_compile(pcap_t *, struct bpf_program *, const char *, int,
614 	    bpf_u_int32);
615 
616 PCAP_AVAILABLE_0_5
617 PCAP_API int	pcap_compile_nopcap(int, int, struct bpf_program *,
618 	    const char *, int, bpf_u_int32);
619 
620 /* XXX - this took two arguments in 0.4 and 0.5 */
621 PCAP_AVAILABLE_0_6
622 PCAP_API void	pcap_freecode(struct bpf_program *);
623 
624 PCAP_AVAILABLE_1_0
625 PCAP_API int	pcap_offline_filter(const struct bpf_program *,
626 	    const struct pcap_pkthdr *, const u_char *);
627 
628 PCAP_AVAILABLE_0_4
629 PCAP_API int	pcap_datalink(pcap_t *);
630 
631 PCAP_AVAILABLE_1_0
632 PCAP_API int	pcap_datalink_ext(pcap_t *);
633 
634 PCAP_AVAILABLE_0_8
635 PCAP_API int	pcap_list_datalinks(pcap_t *, int **);
636 
637 PCAP_AVAILABLE_0_8
638 PCAP_API int	pcap_set_datalink(pcap_t *, int);
639 
640 PCAP_AVAILABLE_0_8
641 PCAP_API void	pcap_free_datalinks(int *);
642 
643 PCAP_AVAILABLE_0_8
644 PCAP_API int	pcap_datalink_name_to_val(const char *);
645 
646 PCAP_AVAILABLE_0_8
647 PCAP_API const char *pcap_datalink_val_to_name(int);
648 
649 PCAP_AVAILABLE_0_8
650 PCAP_API const char *pcap_datalink_val_to_description(int);
651 
652 PCAP_AVAILABLE_1_10
653 PCAP_API const char *pcap_datalink_val_to_description_or_dlt(int);
654 
655 PCAP_AVAILABLE_0_4
656 PCAP_API int	pcap_snapshot(pcap_t *);
657 
658 PCAP_AVAILABLE_0_4
659 PCAP_API int	pcap_is_swapped(pcap_t *);
660 
661 PCAP_AVAILABLE_0_4
662 PCAP_API int	pcap_major_version(pcap_t *);
663 
664 PCAP_AVAILABLE_0_4
665 PCAP_API int	pcap_minor_version(pcap_t *);
666 
667 PCAP_AVAILABLE_1_9
668 PCAP_API int	pcap_bufsize(pcap_t *);
669 
670 /* XXX */
671 PCAP_AVAILABLE_0_4
672 PCAP_API FILE	*pcap_file(pcap_t *);
673 
674 #ifdef _WIN32
675 /*
676  * This probably shouldn't have been kept in WinPcap; most if not all
677  * UN*X code that used it won't work on Windows.  We deprecate it; if
678  * anybody really needs access to whatever HANDLE may be associated
679  * with a pcap_t (there's no guarantee that there is one), we can add
680  * a Windows-only pcap_handle() API that returns the HANDLE.
681  */
682 PCAP_AVAILABLE_0_4
683 PCAP_API int	pcap_fileno(pcap_t *)
684 PCAP_DEPRECATED(pcap_fileno, "use 'pcap_handle'");
685 #else /* _WIN32 */
686 PCAP_AVAILABLE_0_4
687 PCAP_API int	pcap_fileno(pcap_t *);
688 #endif /* _WIN32 */
689 
690 #ifdef _WIN32
691   PCAP_API int	pcap_wsockinit(void);
692 #endif
693 
694 PCAP_AVAILABLE_0_4
695 PCAP_API pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
696 
697 #ifdef _WIN32
698   PCAP_AVAILABLE_0_9
699   PCAP_API pcap_dumper_t *pcap_dump_hopen(pcap_t *, intptr_t);
700 
701   /*
702    * If we're building libpcap, this is an internal routine in sf-pcap.c, so
703    * we must not define it as a macro.
704    *
705    * If we're not building libpcap, given that the version of the C runtime
706    * with which libpcap was built might be different from the version
707    * of the C runtime with which an application using libpcap was built,
708    * and that a FILE structure may differ between the two versions of the
709    * C runtime, calls to _fileno() must use the version of _fileno() in
710    * the C runtime used to open the FILE *, not the version in the C
711    * runtime with which libpcap was built.  (Maybe once the Universal CRT
712    * rules the world, this will cease to be a problem.)
713    */
714   #ifndef BUILDING_PCAP
715     #define pcap_dump_fopen(p,f) \
716 	pcap_dump_hopen(p, _get_osfhandle(_fileno(f)))
717   #endif
718 #else /*_WIN32*/
719   PCAP_AVAILABLE_0_9
720   PCAP_API pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp);
721 #endif /*_WIN32*/
722 
723 PCAP_AVAILABLE_1_7
724 PCAP_API pcap_dumper_t *pcap_dump_open_append(pcap_t *, const char *);
725 
726 PCAP_AVAILABLE_0_8
727 PCAP_API FILE	*pcap_dump_file(pcap_dumper_t *);
728 
729 PCAP_AVAILABLE_0_9
730 PCAP_API long	pcap_dump_ftell(pcap_dumper_t *);
731 
732 PCAP_AVAILABLE_1_9
733 PCAP_API int64_t	pcap_dump_ftell64(pcap_dumper_t *);
734 
735 PCAP_AVAILABLE_0_8
736 PCAP_API int	pcap_dump_flush(pcap_dumper_t *);
737 
738 PCAP_AVAILABLE_0_4
739 PCAP_API void	pcap_dump_close(pcap_dumper_t *);
740 
741 PCAP_AVAILABLE_0_4
742 PCAP_API void	pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
743 
744 PCAP_AVAILABLE_0_7
745 PCAP_API int	pcap_findalldevs(pcap_if_t **, char *);
746 
747 PCAP_AVAILABLE_0_7
748 PCAP_API void	pcap_freealldevs(pcap_if_t *);
749 
750 /*
751  * We return a pointer to the version string, rather than exporting the
752  * version string directly.
753  *
754  * On at least some UNIXes, if you import data from a shared library into
755  * a program, the data is bound into the program binary, so if the string
756  * in the version of the library with which the program was linked isn't
757  * the same as the string in the version of the library with which the
758  * program is being run, various undesirable things may happen (warnings,
759  * the string being the one from the version of the library with which the
760  * program was linked, or even weirder things, such as the string being the
761  * one from the library but being truncated).
762  *
763  * On Windows, the string is constructed at run time.
764  */
765 PCAP_AVAILABLE_0_8
766 PCAP_API const char *pcap_lib_version(void);
767 
768 #if defined(_WIN32)
769 
770   /*
771    * Win32 definitions
772    */
773 
774   /*!
775     \brief A queue of raw packets that will be sent to the network with pcap_sendqueue_transmit().
776   */
777   struct pcap_send_queue
778   {
779 	u_int maxlen;	/* Maximum size of the queue, in bytes. This
780 			   variable contains the size of the buffer field. */
781 	u_int len;	/* Current size of the queue, in bytes. */
782 	char *buffer;	/* Buffer containing the packets to be sent. */
783   };
784 
785   typedef struct pcap_send_queue pcap_send_queue;
786 
787   /*!
788     \brief This typedef is a support for the pcap_get_airpcap_handle() function
789   */
790   #if !defined(AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_)
791     #define AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_
792     typedef struct _AirpcapHandle *PAirpcapHandle;
793   #endif
794 
795   PCAP_API int pcap_setbuff(pcap_t *p, int dim);
796   PCAP_API int pcap_setmode(pcap_t *p, int mode);
797   PCAP_API int pcap_setmintocopy(pcap_t *p, int size);
798 
799   PCAP_API HANDLE pcap_getevent(pcap_t *p);
800 
801   PCAP_AVAILABLE_1_8
802   PCAP_API int pcap_oid_get_request(pcap_t *, bpf_u_int32, void *, size_t *);
803 
804   PCAP_AVAILABLE_1_8
805   PCAP_API int pcap_oid_set_request(pcap_t *, bpf_u_int32, const void *, size_t *);
806 
807   PCAP_API pcap_send_queue* pcap_sendqueue_alloc(u_int memsize);
808 
809   PCAP_API void pcap_sendqueue_destroy(pcap_send_queue* queue);
810 
811   PCAP_API int pcap_sendqueue_queue(pcap_send_queue* queue, const struct pcap_pkthdr *pkt_header, const u_char *pkt_data);
812 
813   PCAP_API u_int pcap_sendqueue_transmit(pcap_t *p, pcap_send_queue* queue, int sync);
814 
815   PCAP_API struct pcap_stat *pcap_stats_ex(pcap_t *p, int *pcap_stat_size);
816 
817   PCAP_API int pcap_setuserbuffer(pcap_t *p, int size);
818 
819   PCAP_API int pcap_live_dump(pcap_t *p, char *filename, int maxsize, int maxpacks);
820 
821   PCAP_API int pcap_live_dump_ended(pcap_t *p, int sync);
822 
823   PCAP_API int pcap_start_oem(char* err_str, int flags);
824 
825   PCAP_API PAirpcapHandle pcap_get_airpcap_handle(pcap_t *p);
826 
827   #define MODE_CAPT 0
828   #define MODE_STAT 1
829   #define MODE_MON 2
830 
831 #elif defined(MSDOS)
832 
833   /*
834    * MS-DOS definitions
835    */
836 
837   PCAP_API int  pcap_stats_ex (pcap_t *, struct pcap_stat_ex *);
838   PCAP_API void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait);
839   PCAP_API u_long pcap_mac_packets (void);
840 
841 #else /* UN*X */
842 
843   /*
844    * UN*X definitions
845    */
846 
847   PCAP_AVAILABLE_0_8
848   PCAP_API int	pcap_get_selectable_fd(pcap_t *);
849 
850   PCAP_AVAILABLE_1_9
851   PCAP_API const struct timeval *pcap_get_required_select_timeout(pcap_t *);
852 
853 #endif /* _WIN32/MSDOS/UN*X */
854 
855 /*
856  * Remote capture definitions.
857  *
858  * These routines are only present if libpcap has been configured to
859  * include remote capture support.
860  */
861 
862 /*
863  * The maximum buffer size in which address, port, interface names are kept.
864  *
865  * In case the adapter name or such is larger than this value, it is truncated.
866  * This is not used by the user; however it must be aware that an hostname / interface
867  * name longer than this value will be truncated.
868  */
869 #define PCAP_BUF_SIZE 1024
870 
871 /*
872  * The type of input source, passed to pcap_open().
873  */
874 #define PCAP_SRC_FILE		2	/* local savefile */
875 #define PCAP_SRC_IFLOCAL	3	/* local network interface */
876 #define PCAP_SRC_IFREMOTE	4	/* interface on a remote host, using RPCAP */
877 
878 /*
879  * The formats allowed by pcap_open() are the following:
880  * - file://path_and_filename [opens a local file]
881  * - rpcap://devicename [opens the selected device devices available on the local host, without using the RPCAP protocol]
882  * - rpcap://host/devicename [opens the selected device available on a remote host]
883  * - rpcap://host:port/devicename [opens the selected device available on a remote host, using a non-standard port for RPCAP]
884  * - adaptername [to open a local adapter; kept for compatibility, but it is strongly discouraged]
885  * - (NULL) [to open the first local adapter; kept for compatibility, but it is strongly discouraged]
886  *
887  * The formats allowed by the pcap_findalldevs_ex() are the following:
888  * - file://folder/ [lists all the files in the given folder]
889  * - rpcap:// [lists all local adapters]
890  * - rpcap://host:port/ [lists the devices available on a remote host]
891  *
892  * In all the above, "rpcaps://" can be substituted for "rpcap://" to enable
893  * SSL (if it has been compiled in).
894  *
895  * Referring to the 'host' and 'port' parameters, they can be either numeric or literal. Since
896  * IPv6 is fully supported, these are the allowed formats:
897  *
898  * - host (literal): e.g. host.foo.bar
899  * - host (numeric IPv4): e.g. 10.11.12.13
900  * - host (numeric IPv4, IPv6 style): e.g. [10.11.12.13]
901  * - host (numeric IPv6): e.g. [1:2:3::4]
902  * - port: can be either numeric (e.g. '80') or literal (e.g. 'http')
903  *
904  * Here you find some allowed examples:
905  * - rpcap://host.foo.bar/devicename [everything literal, no port number]
906  * - rpcap://host.foo.bar:1234/devicename [everything literal, with port number]
907  * - rpcap://10.11.12.13/devicename [IPv4 numeric, no port number]
908  * - rpcap://10.11.12.13:1234/devicename [IPv4 numeric, with port number]
909  * - rpcap://[10.11.12.13]:1234/devicename [IPv4 numeric with IPv6 format, with port number]
910  * - rpcap://[1:2:3::4]/devicename [IPv6 numeric, no port number]
911  * - rpcap://[1:2:3::4]:1234/devicename [IPv6 numeric, with port number]
912  * - rpcap://[1:2:3::4]:http/devicename [IPv6 numeric, with literal port number]
913  */
914 
915 /*
916  * URL schemes for capture source.
917  */
918 /*
919  * This string indicates that the user wants to open a capture from a
920  * local file.
921  */
922 #define PCAP_SRC_FILE_STRING "file://"
923 /*
924  * This string indicates that the user wants to open a capture from a
925  * network interface.  This string does not necessarily involve the use
926  * of the RPCAP protocol. If the interface required resides on the local
927  * host, the RPCAP protocol is not involved and the local functions are used.
928  */
929 #define PCAP_SRC_IF_STRING "rpcap://"
930 
931 /*
932  * Flags to pass to pcap_open().
933  */
934 
935 /*
936  * Specifies whether promiscuous mode is to be used.
937  */
938 #define PCAP_OPENFLAG_PROMISCUOUS		0x00000001
939 
940 /*
941  * Specifies, for an RPCAP capture, whether the data transfer (in
942  * case of a remote capture) has to be done with UDP protocol.
943  *
944  * If it is '1' if you want a UDP data connection, '0' if you want
945  * a TCP data connection; control connection is always TCP-based.
946  * A UDP connection is much lighter, but it does not guarantee that all
947  * the captured packets arrive to the client workstation. Moreover,
948  * it could be harmful in case of network congestion.
949  * This flag is meaningless if the source is not a remote interface.
950  * In that case, it is simply ignored.
951  */
952 #define PCAP_OPENFLAG_DATATX_UDP		0x00000002
953 
954 /*
955  * Specifies whether the remote probe will capture its own generated
956  * traffic.
957  *
958  * In case the remote probe uses the same interface to capture traffic
959  * and to send data back to the caller, the captured traffic includes
960  * the RPCAP traffic as well.  If this flag is turned on, the RPCAP
961  * traffic is excluded from the capture, so that the trace returned
962  * back to the collector is does not include this traffic.
963  *
964  * Has no effect on local interfaces or savefiles.
965  */
966 #define PCAP_OPENFLAG_NOCAPTURE_RPCAP		0x00000004
967 
968 /*
969  * Specifies whether the local adapter will capture its own generated traffic.
970  *
971  * This flag tells the underlying capture driver to drop the packets
972  * that were sent by itself.  This is useful when building applications
973  * such as bridges that should ignore the traffic they just sent.
974  *
975  * Supported only on Windows.
976  */
977 #define PCAP_OPENFLAG_NOCAPTURE_LOCAL		0x00000008
978 
979 /*
980  * This flag configures the adapter for maximum responsiveness.
981  *
982  * In presence of a large value for nbytes, WinPcap waits for the arrival
983  * of several packets before copying the data to the user. This guarantees
984  * a low number of system calls, i.e. lower processor usage, i.e. better
985  * performance, which is good for applications like sniffers. If the user
986  * sets the PCAP_OPENFLAG_MAX_RESPONSIVENESS flag, the capture driver will
987  * copy the packets as soon as the application is ready to receive them.
988  * This is suggested for real time applications (such as, for example,
989  * a bridge) that need the best responsiveness.
990  *
991  * The equivalent with pcap_create()/pcap_activate() is "immediate mode".
992  */
993 #define PCAP_OPENFLAG_MAX_RESPONSIVENESS	0x00000010
994 
995 /*
996  * Remote authentication methods.
997  * These are used in the 'type' member of the pcap_rmtauth structure.
998  */
999 
1000 /*
1001  * NULL authentication.
1002  *
1003  * The 'NULL' authentication has to be equal to 'zero', so that old
1004  * applications can just put every field of struct pcap_rmtauth to zero,
1005  * and it does work.
1006  */
1007 #define RPCAP_RMTAUTH_NULL 0
1008 /*
1009  * Username/password authentication.
1010  *
1011  * With this type of authentication, the RPCAP protocol will use the username/
1012  * password provided to authenticate the user on the remote machine. If the
1013  * authentication is successful (and the user has the right to open network
1014  * devices) the RPCAP connection will continue; otherwise it will be dropped.
1015  *
1016  * *******NOTE********: the username and password are sent over the network
1017  * to the capture server *IN CLEAR TEXT*.  Don't use this on a network
1018  * that you don't completely control!  (And be *really* careful in your
1019  * definition of "completely"!)
1020  */
1021 #define RPCAP_RMTAUTH_PWD 1
1022 
1023 /*
1024  * This structure keeps the information needed to authenticate the user
1025  * on a remote machine.
1026  *
1027  * The remote machine can either grant or refuse the access according
1028  * to the information provided.
1029  * In case the NULL authentication is required, both 'username' and
1030  * 'password' can be NULL pointers.
1031  *
1032  * This structure is meaningless if the source is not a remote interface;
1033  * in that case, the functions which requires such a structure can accept
1034  * a NULL pointer as well.
1035  */
1036 struct pcap_rmtauth
1037 {
1038 	/*
1039 	 * \brief Type of the authentication required.
1040 	 *
1041 	 * In order to provide maximum flexibility, we can support different types
1042 	 * of authentication based on the value of this 'type' variable. The currently
1043 	 * supported authentication methods are defined into the
1044 	 * \link remote_auth_methods Remote Authentication Methods Section\endlink.
1045 	 */
1046 	int type;
1047 	/*
1048 	 * \brief Zero-terminated string containing the username that has to be
1049 	 * used on the remote machine for authentication.
1050 	 *
1051 	 * This field is meaningless in case of the RPCAP_RMTAUTH_NULL authentication
1052 	 * and it can be NULL.
1053 	 */
1054 	char *username;
1055 	/*
1056 	 * \brief Zero-terminated string containing the password that has to be
1057 	 * used on the remote machine for authentication.
1058 	 *
1059 	 * This field is meaningless in case of the RPCAP_RMTAUTH_NULL authentication
1060 	 * and it can be NULL.
1061 	 */
1062 	char *password;
1063 };
1064 
1065 /*
1066  * This routine can open a savefile, a local device, or a device on
1067  * a remote machine running an RPCAP server.
1068  *
1069  * For opening a savefile, the pcap_open_offline routines can be used,
1070  * and will work just as well; code using them will work on more
1071  * platforms than code using pcap_open() to open savefiles.
1072  *
1073  * For opening a local device, pcap_open_live() can be used; it supports
1074  * most of the capabilities that pcap_open() supports, and code using it
1075  * will work on more platforms than code using pcap_open().  pcap_create()
1076  * and pcap_activate() can also be used; they support all capabilities
1077  * that pcap_open() supports, except for the Windows-only
1078  * PCAP_OPENFLAG_NOCAPTURE_LOCAL, and support additional capabilities.
1079  *
1080  * For opening a remote capture, pcap_open() is currently the only
1081  * API available.
1082  */
1083 PCAP_AVAILABLE_1_9
1084 PCAP_API pcap_t	*pcap_open(const char *source, int snaplen, int flags,
1085 	    int read_timeout, struct pcap_rmtauth *auth, char *errbuf);
1086 
1087 PCAP_AVAILABLE_1_9
1088 PCAP_API int	pcap_createsrcstr(char *source, int type, const char *host,
1089 	    const char *port, const char *name, char *errbuf);
1090 
1091 PCAP_AVAILABLE_1_9
1092 PCAP_API int	pcap_parsesrcstr(const char *source, int *type, char *host,
1093 	    char *port, char *name, char *errbuf);
1094 
1095 /*
1096  * This routine can scan a directory for savefiles, list local capture
1097  * devices, or list capture devices on a remote machine running an RPCAP
1098  * server.
1099  *
1100  * For scanning for savefiles, it can be used on both UN*X systems and
1101  * Windows systems; for each directory entry it sees, it tries to open
1102  * the file as a savefile using pcap_open_offline(), and only includes
1103  * it in the list of files if the open succeeds, so it filters out
1104  * files for which the user doesn't have read permission, as well as
1105  * files that aren't valid savefiles readable by libpcap.
1106  *
1107  * For listing local capture devices, it's just a wrapper around
1108  * pcap_findalldevs(); code using pcap_findalldevs() will work on more
1109  * platforms than code using pcap_findalldevs_ex().
1110  *
1111  * For listing remote capture devices, pcap_findalldevs_ex() is currently
1112  * the only API available.
1113  */
1114 PCAP_AVAILABLE_1_9
1115 PCAP_API int	pcap_findalldevs_ex(const char *source,
1116 	    struct pcap_rmtauth *auth, pcap_if_t **alldevs, char *errbuf);
1117 
1118 /*
1119  * Sampling methods.
1120  *
1121  * These allow pcap_loop(), pcap_dispatch(), pcap_next(), and pcap_next_ex()
1122  * to see only a sample of packets, rather than all packets.
1123  *
1124  * Currently, they work only on Windows local captures.
1125  */
1126 
1127 /*
1128  * Specifies that no sampling is to be done on the current capture.
1129  *
1130  * In this case, no sampling algorithms are applied to the current capture.
1131  */
1132 #define PCAP_SAMP_NOSAMP	0
1133 
1134 /*
1135  * Specifies that only 1 out of N packets must be returned to the user.
1136  *
1137  * In this case, the 'value' field of the 'pcap_samp' structure indicates the
1138  * number of packets (minus 1) that must be discarded before one packet got
1139  * accepted.
1140  * In other words, if 'value = 10', the first packet is returned to the
1141  * caller, while the following 9 are discarded.
1142  */
1143 #define PCAP_SAMP_1_EVERY_N	1
1144 
1145 /*
1146  * Specifies that we have to return 1 packet every N milliseconds.
1147  *
1148  * In this case, the 'value' field of the 'pcap_samp' structure indicates
1149  * the 'waiting time' in milliseconds before one packet got accepted.
1150  * In other words, if 'value = 10', the first packet is returned to the
1151  * caller; the next returned one will be the first packet that arrives
1152  * when 10ms have elapsed.
1153  */
1154 #define PCAP_SAMP_FIRST_AFTER_N_MS 2
1155 
1156 /*
1157  * This structure defines the information related to sampling.
1158  *
1159  * In case the sampling is requested, the capturing device should read
1160  * only a subset of the packets coming from the source. The returned packets
1161  * depend on the sampling parameters.
1162  *
1163  * WARNING: The sampling process is applied *after* the filtering process.
1164  * In other words, packets are filtered first, then the sampling process
1165  * selects a subset of the 'filtered' packets and it returns them to the
1166  * caller.
1167  */
1168 struct pcap_samp
1169 {
1170 	/*
1171 	 * Method used for sampling; see above.
1172 	 */
1173 	int method;
1174 
1175 	/*
1176 	 * This value depends on the sampling method defined.
1177 	 * For its meaning, see above.
1178 	 */
1179 	int value;
1180 };
1181 
1182 /*
1183  * New functions.
1184  */
1185 PCAP_AVAILABLE_1_9
1186 PCAP_API struct pcap_samp *pcap_setsampling(pcap_t *p);
1187 
1188 /*
1189  * RPCAP active mode.
1190  */
1191 
1192 /* Maximum length of an host name (needed for the RPCAP active mode) */
1193 #define RPCAP_HOSTLIST_SIZE 1024
1194 
1195 PCAP_AVAILABLE_1_9
1196 PCAP_API SOCKET	pcap_remoteact_accept(const char *address, const char *port,
1197 	    const char *hostlist, char *connectinghost,
1198 	    struct pcap_rmtauth *auth, char *errbuf);
1199 
1200 PCAP_AVAILABLE_1_10
1201 PCAP_API SOCKET	pcap_remoteact_accept_ex(const char *address, const char *port,
1202 	    const char *hostlist, char *connectinghost,
1203 	    struct pcap_rmtauth *auth, int uses_ssl, char *errbuf);
1204 
1205 PCAP_AVAILABLE_1_9
1206 PCAP_API int	pcap_remoteact_list(char *hostlist, char sep, int size,
1207 	    char *errbuf);
1208 
1209 PCAP_AVAILABLE_1_9
1210 PCAP_API int	pcap_remoteact_close(const char *host, char *errbuf);
1211 
1212 PCAP_AVAILABLE_1_9
1213 PCAP_API void	pcap_remoteact_cleanup(void);
1214 
1215 #ifdef __cplusplus
1216 }
1217 #endif
1218 
1219 #endif /* lib_pcap_pcap_h */
1220