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