*
* Wiretap Library
* Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef __WTAP_H__
#define __WTAP_H__
#include <wireshark.h>
#include <time.h>
#include <wsutil/buffer.h>
#include <wsutil/nstime.h>
#include <wsutil/inet_addr.h>
#include "wtap_opttypes.h"
#ifdef __cplusplus
extern "C" {
#endif
* what is contained in the packet trace file.
*
* WTAP_ENCAP_PER_PACKET is a value passed to "wtap_dump_open()" or
* "wtap_dump_fdopen()" to indicate that there is no single encapsulation
* type for all packets in the file; this may cause those routines to
* fail if the capture file format being written can't support that.
* It's also returned by "wtap_file_encap()" for capture files that
* don't have a single encapsulation type for all packets in the file.
*
* WTAP_ENCAP_UNKNOWN is returned by "wtap_pcap_encap_to_wtap_encap()"
* if it's handed an unknown encapsulation. It is also used by file
* types for encapsulations which are unsupported by libwiretap.
*
* WTAP_ENCAP_NONE is an initial value used by file types like pcapng
* that do not have a single file level encapsulation type. If and when
* something that indicate encapsulation is read, the encapsulation will
* change (possibly to WTAP_ENCAP_PER_PACKET) and appropriate IDBs will
* be generated. If a file type uses this value, it MUST provide IDBs
* (possibly fake) when the encapsulation changes; otherwise, it should
* return WTAP_ENCAP_UNKNOWN so that attempts to write an output file
* without reading the entire input file first fail gracefully.
*
* WTAP_ENCAP_FDDI_BITSWAPPED is for FDDI captures on systems where the
* MAC addresses you get from the hardware are bit-swapped. Ideally,
* the driver would tell us that, but I know of none that do, so, for
* now, we base it on the machine on which we're *reading* the
* capture, rather than on the machine on which the capture was taken
* (they're probably likely to be the same). We assume that they're
* bit-swapped on everything except for systems running Ultrix, Alpha
* systems, and BSD/OS systems (that's what "tcpdump" does; I guess
* Digital decided to bit-swap addresses in the hardware or in the
* driver, and I guess BSDI bit-swapped them in the driver, given that
* BSD/OS generally runs on Boring Old PC's). If we create a wiretap
* save file format, we'd use the WTAP_ENCAP values to flag the
* encapsulation of a packet, so there we'd at least be able to base
* it on the machine on which the capture was taken.
*
* WTAP_ENCAP_LINUX_ATM_CLIP is the encapsulation you get with the
* ATM on Linux code from <http://linux-atm.sourceforge.net/>;
* that code adds a DLT_ATM_CLIP DLT_ code of 19, and that
* encapsulation isn't the same as the DLT_ATM_RFC1483 encapsulation
* presumably used on some BSD systems, which we turn into
* WTAP_ENCAP_ATM_RFC1483.
*
* WTAP_ENCAP_NULL corresponds to DLT_NULL from "libpcap". This
* corresponds to
*
* 1) PPP-over-HDLC encapsulation, at least with some versions
* of ISDN4BSD (but not the current ones, it appears, unless
* I've missed something);
*
* 2) a 4-byte header containing the AF_ address family, in
* the byte order of the machine that saved the capture,
* for the packet, as used on many BSD systems for the
* loopback device and some other devices, or a 4-byte header
* containing the AF_ address family in network byte order,
* as used on recent OpenBSD systems for the loopback device;
*
* 3) a 4-byte header containing 2 octets of 0 and an Ethernet
* type in the byte order from an Ethernet header, that being
* what older versions of "libpcap" on Linux turn the Ethernet
* header for loopback interfaces into (0.6.0 and later versions
* leave the Ethernet header alone and make it DLT_EN10MB). */
#define WTAP_ENCAP_NONE -2
#define WTAP_ENCAP_PER_PACKET -1
#define WTAP_ENCAP_UNKNOWN 0
#define WTAP_ENCAP_ETHERNET 1
#define WTAP_ENCAP_TOKEN_RING 2
#define WTAP_ENCAP_SLIP 3
#define WTAP_ENCAP_PPP 4
#define WTAP_ENCAP_FDDI 5
#define WTAP_ENCAP_FDDI_BITSWAPPED 6
#define WTAP_ENCAP_RAW_IP 7
#define WTAP_ENCAP_ARCNET 8
#define WTAP_ENCAP_ARCNET_LINUX 9
#define WTAP_ENCAP_ATM_RFC1483 10
#define WTAP_ENCAP_LINUX_ATM_CLIP 11
#define WTAP_ENCAP_LAPB 12
#define WTAP_ENCAP_ATM_PDUS 13
#define WTAP_ENCAP_ATM_PDUS_UNTRUNCATED 14
#define WTAP_ENCAP_NULL 15
#define WTAP_ENCAP_ASCEND 16
#define WTAP_ENCAP_ISDN 17
#define WTAP_ENCAP_IP_OVER_FC 18
#define WTAP_ENCAP_PPP_WITH_PHDR 19
#define WTAP_ENCAP_IEEE_802_11 20
#define WTAP_ENCAP_IEEE_802_11_PRISM 21
#define WTAP_ENCAP_IEEE_802_11_WITH_RADIO 22
#define WTAP_ENCAP_IEEE_802_11_RADIOTAP 23
#define WTAP_ENCAP_IEEE_802_11_AVS 24
#define WTAP_ENCAP_SLL 25
#define WTAP_ENCAP_FRELAY 26
#define WTAP_ENCAP_FRELAY_WITH_PHDR 27
#define WTAP_ENCAP_CHDLC 28
#define WTAP_ENCAP_CISCO_IOS 29
#define WTAP_ENCAP_LOCALTALK 30
#define WTAP_ENCAP_OLD_PFLOG 31
#define WTAP_ENCAP_HHDLC 32
#define WTAP_ENCAP_DOCSIS 33
#define WTAP_ENCAP_COSINE 34
#define WTAP_ENCAP_WFLEET_HDLC 35
#define WTAP_ENCAP_SDLC 36
#define WTAP_ENCAP_TZSP 37
#define WTAP_ENCAP_ENC 38
#define WTAP_ENCAP_PFLOG 39
#define WTAP_ENCAP_CHDLC_WITH_PHDR 40
#define WTAP_ENCAP_BLUETOOTH_H4 41
#define WTAP_ENCAP_MTP2 42
#define WTAP_ENCAP_MTP3 43
#define WTAP_ENCAP_IRDA 44
#define WTAP_ENCAP_USER0 45
#define WTAP_ENCAP_USER1 46
#define WTAP_ENCAP_USER2 47
#define WTAP_ENCAP_USER3 48
#define WTAP_ENCAP_USER4 49
#define WTAP_ENCAP_USER5 50
#define WTAP_ENCAP_USER6 51
#define WTAP_ENCAP_USER7 52
#define WTAP_ENCAP_USER8 53
#define WTAP_ENCAP_USER9 54
#define WTAP_ENCAP_USER10 55
#define WTAP_ENCAP_USER11 56
#define WTAP_ENCAP_USER12 57
#define WTAP_ENCAP_USER13 58
#define WTAP_ENCAP_USER14 59
#define WTAP_ENCAP_USER15 60
#define WTAP_ENCAP_SYMANTEC 61
#define WTAP_ENCAP_APPLE_IP_OVER_IEEE1394 62
#define WTAP_ENCAP_BACNET_MS_TP 63
#define WTAP_ENCAP_NETTL_RAW_ICMP 64
#define WTAP_ENCAP_NETTL_RAW_ICMPV6 65
#define WTAP_ENCAP_GPRS_LLC 66
#define WTAP_ENCAP_JUNIPER_ATM1 67
#define WTAP_ENCAP_JUNIPER_ATM2 68
#define WTAP_ENCAP_REDBACK 69
#define WTAP_ENCAP_NETTL_RAW_IP 70
#define WTAP_ENCAP_NETTL_ETHERNET 71
#define WTAP_ENCAP_NETTL_TOKEN_RING 72
#define WTAP_ENCAP_NETTL_FDDI 73
#define WTAP_ENCAP_NETTL_UNKNOWN 74
#define WTAP_ENCAP_MTP2_WITH_PHDR 75
#define WTAP_ENCAP_JUNIPER_PPPOE 76
#define WTAP_ENCAP_GCOM_TIE1 77
#define WTAP_ENCAP_GCOM_SERIAL 78
#define WTAP_ENCAP_NETTL_X25 79
#define WTAP_ENCAP_K12 80
#define WTAP_ENCAP_JUNIPER_MLPPP 81
#define WTAP_ENCAP_JUNIPER_MLFR 82
#define WTAP_ENCAP_JUNIPER_ETHER 83
#define WTAP_ENCAP_JUNIPER_PPP 84
#define WTAP_ENCAP_JUNIPER_FRELAY 85
#define WTAP_ENCAP_JUNIPER_CHDLC 86
#define WTAP_ENCAP_JUNIPER_GGSN 87
#define WTAP_ENCAP_LINUX_LAPD 88
#define WTAP_ENCAP_CATAPULT_DCT2000 89
#define WTAP_ENCAP_BER 90
#define WTAP_ENCAP_JUNIPER_VP 91
#define WTAP_ENCAP_USB_FREEBSD 92
#define WTAP_ENCAP_IEEE802_16_MAC_CPS 93
#define WTAP_ENCAP_NETTL_RAW_TELNET 94
#define WTAP_ENCAP_USB_LINUX 95
#define WTAP_ENCAP_MPEG 96
#define WTAP_ENCAP_PPI 97
#define WTAP_ENCAP_ERF 98
#define WTAP_ENCAP_BLUETOOTH_H4_WITH_PHDR 99
#define WTAP_ENCAP_SITA 100
#define WTAP_ENCAP_SCCP 101
#define WTAP_ENCAP_BLUETOOTH_HCI 102
#define WTAP_ENCAP_IPMB_KONTRON 103
#define WTAP_ENCAP_IEEE802_15_4 104
#define WTAP_ENCAP_X2E_XORAYA 105
#define WTAP_ENCAP_FLEXRAY 106
#define WTAP_ENCAP_LIN 107
#define WTAP_ENCAP_MOST 108
#define WTAP_ENCAP_CAN20B 109
#define WTAP_ENCAP_LAYER1_EVENT 110
#define WTAP_ENCAP_X2E_SERIAL 111
#define WTAP_ENCAP_I2C_LINUX 112
#define WTAP_ENCAP_IEEE802_15_4_NONASK_PHY 113
#define WTAP_ENCAP_TNEF 114
#define WTAP_ENCAP_USB_LINUX_MMAPPED 115
#define WTAP_ENCAP_GSM_UM 116
#define WTAP_ENCAP_DPNSS 117
#define WTAP_ENCAP_PACKETLOGGER 118
#define WTAP_ENCAP_NSTRACE_1_0 119
#define WTAP_ENCAP_NSTRACE_2_0 120
#define WTAP_ENCAP_FIBRE_CHANNEL_FC2 121
#define WTAP_ENCAP_FIBRE_CHANNEL_FC2_WITH_FRAME_DELIMS 122
#define WTAP_ENCAP_JPEG_JFIF 123
#define WTAP_ENCAP_IPNET 124
#define WTAP_ENCAP_SOCKETCAN 125
#define WTAP_ENCAP_IEEE_802_11_NETMON 126
#define WTAP_ENCAP_IEEE802_15_4_NOFCS 127
#define WTAP_ENCAP_RAW_IPFIX 128
#define WTAP_ENCAP_RAW_IP4 129
#define WTAP_ENCAP_RAW_IP6 130
#define WTAP_ENCAP_LAPD 131
#define WTAP_ENCAP_DVBCI 132
#define WTAP_ENCAP_MUX27010 133
#define WTAP_ENCAP_MIME 134
#define WTAP_ENCAP_NETANALYZER 135
#define WTAP_ENCAP_NETANALYZER_TRANSPARENT 136
#define WTAP_ENCAP_IP_OVER_IB_SNOOP 137
#define WTAP_ENCAP_MPEG_2_TS 138
#define WTAP_ENCAP_PPP_ETHER 139
#define WTAP_ENCAP_NFC_LLCP 140
#define WTAP_ENCAP_NFLOG 141
#define WTAP_ENCAP_V5_EF 142
#define WTAP_ENCAP_BACNET_MS_TP_WITH_PHDR 143
#define WTAP_ENCAP_IXVERIWAVE 144
#define WTAP_ENCAP_SDH 145
#define WTAP_ENCAP_DBUS 146
#define WTAP_ENCAP_AX25_KISS 147
#define WTAP_ENCAP_AX25 148
#define WTAP_ENCAP_SCTP 149
#define WTAP_ENCAP_INFINIBAND 150
#define WTAP_ENCAP_JUNIPER_SVCS 151
#define WTAP_ENCAP_USBPCAP 152
#define WTAP_ENCAP_RTAC_SERIAL 153
#define WTAP_ENCAP_BLUETOOTH_LE_LL 154
#define WTAP_ENCAP_WIRESHARK_UPPER_PDU 155
#define WTAP_ENCAP_STANAG_4607 156
#define WTAP_ENCAP_STANAG_5066_D_PDU 157
#define WTAP_ENCAP_NETLINK 158
#define WTAP_ENCAP_BLUETOOTH_LINUX_MONITOR 159
#define WTAP_ENCAP_BLUETOOTH_BREDR_BB 160
#define WTAP_ENCAP_BLUETOOTH_LE_LL_WITH_PHDR 161
#define WTAP_ENCAP_NSTRACE_3_0 162
#define WTAP_ENCAP_LOGCAT 163
#define WTAP_ENCAP_LOGCAT_BRIEF 164
#define WTAP_ENCAP_LOGCAT_PROCESS 165
#define WTAP_ENCAP_LOGCAT_TAG 166
#define WTAP_ENCAP_LOGCAT_THREAD 167
#define WTAP_ENCAP_LOGCAT_TIME 168
#define WTAP_ENCAP_LOGCAT_THREADTIME 169
#define WTAP_ENCAP_LOGCAT_LONG 170
#define WTAP_ENCAP_PKTAP 171
#define WTAP_ENCAP_EPON 172
#define WTAP_ENCAP_IPMI_TRACE 173
#define WTAP_ENCAP_LOOP 174
#define WTAP_ENCAP_JSON 175
#define WTAP_ENCAP_NSTRACE_3_5 176
#define WTAP_ENCAP_ISO14443 177
#define WTAP_ENCAP_GFP_T 178
#define WTAP_ENCAP_GFP_F 179
#define WTAP_ENCAP_IP_OVER_IB_PCAP 180
#define WTAP_ENCAP_JUNIPER_VN 181
#define WTAP_ENCAP_USB_DARWIN 182
#define WTAP_ENCAP_LORATAP 183
#define WTAP_ENCAP_3MB_ETHERNET 184
#define WTAP_ENCAP_VSOCK 185
#define WTAP_ENCAP_NORDIC_BLE 186
#define WTAP_ENCAP_NETMON_NET_NETEVENT 187
#define WTAP_ENCAP_NETMON_HEADER 188
#define WTAP_ENCAP_NETMON_NET_FILTER 189
#define WTAP_ENCAP_NETMON_NETWORK_INFO_EX 190
#define WTAP_ENCAP_MA_WFP_CAPTURE_V4 191
#define WTAP_ENCAP_MA_WFP_CAPTURE_V6 192
#define WTAP_ENCAP_MA_WFP_CAPTURE_2V4 193
#define WTAP_ENCAP_MA_WFP_CAPTURE_2V6 194
#define WTAP_ENCAP_MA_WFP_CAPTURE_AUTH_V4 195
#define WTAP_ENCAP_MA_WFP_CAPTURE_AUTH_V6 196
#define WTAP_ENCAP_JUNIPER_ST 197
#define WTAP_ENCAP_ETHERNET_MPACKET 198
#define WTAP_ENCAP_DOCSIS31_XRA31 199
#define WTAP_ENCAP_DPAUXMON 200
#define WTAP_ENCAP_RUBY_MARSHAL 201
#define WTAP_ENCAP_RFC7468 202
#define WTAP_ENCAP_SYSTEMD_JOURNAL 203
#define WTAP_ENCAP_EBHSCR 204
#define WTAP_ENCAP_VPP 205
#define WTAP_ENCAP_IEEE802_15_4_TAP 206
#define WTAP_ENCAP_LOG_3GPP 207
#define WTAP_ENCAP_USB_2_0 208
#define WTAP_ENCAP_MP4 209
#define WTAP_ENCAP_SLL2 210
#define WTAP_ENCAP_ZWAVE_SERIAL 211
#define WTAP_ENCAP_ETW 212
#define WTAP_ENCAP_ERI_ENB_LOG 213
#define WTAP_ENCAP_ZBNCP 214
#define WTAP_ENCAP_USB_2_0_LOW_SPEED 215
#define WTAP_ENCAP_USB_2_0_FULL_SPEED 216
#define WTAP_ENCAP_USB_2_0_HIGH_SPEED 217
#define WTAP_ENCAP_AUTOSAR_DLT 218
#define WTAP_ENCAP_AUERSWALD_LOG 219
#define WTAP_ENCAP_ATSC_ALP 220
#define WTAP_ENCAP_FIRA_UCI 221
#define WTAP_ENCAP_SILABS_DEBUG_CHANNEL 222
#define WTAP_ENCAP_MDB 223
#define WTAP_ENCAP_EMS 224
#define WTAP_ENCAP_DECT_NR 225
#define WTAP_NUM_ENCAP_TYPES wtap_get_num_encap_types()
#define WTAP_FILE_TYPE_SUBTYPE_UNKNOWN -1
#define WTAP_TSPREC_UNKNOWN -2
#define WTAP_TSPREC_PER_PACKET -1
* These values are the number of digits of precision after the integral part.
* Thry're the same as WS_TSPREC values; we define them here so that
* tools/make-enums.py sees them.
*/
#define WTAP_TSPREC_SEC 0
#define WTAP_TSPREC_100_MSEC 1
#define WTAP_TSPREC_DSEC 1
#define WTAP_TSPREC_10_MSEC 2
#define WTAP_TSPREC_CSEC 2
#define WTAP_TSPREC_MSEC 3
#define WTAP_TSPREC_100_USEC 4
#define WTAP_TSPREC_10_USEC 5
#define WTAP_TSPREC_USEC 6
#define WTAP_TSPREC_100_NSEC 7
#define WTAP_TSPREC_10_NSEC 8
#define WTAP_TSPREC_NSEC 9
* Maximum packet sizes.
*
* For most link-layer types, we use 262144, which is currently
* libpcap's MAXIMUM_SNAPLEN.
*
* For WTAP_ENCAP_DBUS, the maximum is 128MiB, as per
*
* https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-messages
*
* For WTAP_ENCAP_EBHSCR, the maximum is 8MiB, as per
*
* https://www.elektrobit.com/ebhscr
*
* For WTAP_ENCAP_USBPCAP, the maximum is 128MiB, as per
*
* https://gitlab.com/wireshark/wireshark/-/issues/15985
*
* We don't want to write out files that specify a maximum packet size
* greater than 262144 if we don't have to, as software reading those
* files might allocate a buffer much larger than necessary, wasting memory.
*/
#define WTAP_MAX_PACKET_SIZE_STANDARD 262144U
#define WTAP_MAX_PACKET_SIZE_USBPCAP (128U*1024U*1024U)
#define WTAP_MAX_PACKET_SIZE_EBHSCR (32U*1024U*1024U)
#define WTAP_MAX_PACKET_SIZE_DBUS (128U*1024U*1024U)
* "Pseudo-headers" are used to supply to the clients of wiretap
* per-packet information that's not part of the packet payload
* proper.
*
* NOTE: do not use pseudo-header structures to hold information
* used by the code to read a particular capture file type; to
* keep that sort of state information, add a new structure for
* that private information to "wtap-int.h", add a pointer to that
* type of structure to the "capture" member of the "struct wtap"
* structure, and allocate one of those structures and set that member
* in the "open" routine for that capture file type if the open
* succeeds. See various other capture file type handlers for examples
* of that.
*/
struct eth_phdr {
int fcs_len;
};
between DTE and DCE. */
#define FROM_DCE 0x80
struct dte_dce_phdr {
uint8_t flags;
};
struct isdn_phdr {
bool uton;
uint8_t channel;
};
Not all of this information is supplied by all capture types.
These originally came from the Network General (DOS-based)
ATM Sniffer file format, but we've added some additional
items. */
* Status bits.
*/
#define ATM_RAW_CELL 0x01
#define ATM_NO_HEC 0x02
#define ATM_AAL2_NOPHDR 0x04
#define ATM_REASSEMBLY_ERROR 0x08
* AAL types.
*/
#define AAL_UNKNOWN 0
#define AAL_1 1
#define AAL_2 2
#define AAL_3_4 3
#define AAL_5 4
#define AAL_USER 5
#define AAL_SIGNALLING 6
#define AAL_OAMCELL 7
* Traffic types.
*/
#define TRAF_UNKNOWN 0
#define TRAF_LLCMX 1
#define TRAF_VCMX 2
#define TRAF_LANE 3
#define TRAF_ILMI 4
#define TRAF_FR 5
#define TRAF_SPANS 6
#define TRAF_IPSILON 7
#define TRAF_UMTS_FP 8
#define TRAF_GPRS_NS 9
#define TRAF_SSCOP 10
* Traffic subtypes.
*/
#define TRAF_ST_UNKNOWN 0
* For TRAF_VCMX:
*/
#define TRAF_ST_VCMX_802_3_FCS 1
#define TRAF_ST_VCMX_802_4_FCS 2
#define TRAF_ST_VCMX_802_5_FCS 3
#define TRAF_ST_VCMX_FDDI_FCS 4
#define TRAF_ST_VCMX_802_6_FCS 5
#define TRAF_ST_VCMX_802_3 7
#define TRAF_ST_VCMX_802_4 8
#define TRAF_ST_VCMX_802_5 9
#define TRAF_ST_VCMX_FDDI 10
#define TRAF_ST_VCMX_802_6 11
#define TRAF_ST_VCMX_FRAGMENTS 12
#define TRAF_ST_VCMX_BPDU 13
* For TRAF_LANE:
*/
#define TRAF_ST_LANE_LE_CTRL 1
#define TRAF_ST_LANE_802_3 2
#define TRAF_ST_LANE_802_5 3
#define TRAF_ST_LANE_802_3_MC 4
#define TRAF_ST_LANE_802_5_MC 5
* For TRAF_IPSILON:
*/
#define TRAF_ST_IPSILON_FT0 1
#define TRAF_ST_IPSILON_FT1 2
#define TRAF_ST_IPSILON_FT2 3
struct atm_phdr {
uint32_t flags;
uint8_t aal;
uint8_t type;
uint8_t subtype;
uint16_t vpi;
uint16_t vci;
uint8_t aal2_cid;
uint16_t channel;
uint16_t cells;
uint16_t aal5t_u2u;
uint16_t aal5t_len;
uint32_t aal5t_chksum;
};
"wandisplay", and similar commands on Lucent/Ascend access equipment. */
#define ASCEND_MAX_STR_LEN 64
#define ASCEND_PFX_WDS_X 1
#define ASCEND_PFX_WDS_R 2
#define ASCEND_PFX_WDD 3
#define ASCEND_PFX_ISDN_X 4
#define ASCEND_PFX_ISDN_R 5
#define ASCEND_PFX_ETHER 6
struct ascend_phdr {
uint16_t type;
char user[ASCEND_MAX_STR_LEN];
uint32_t sess;
char call_num[ASCEND_MAX_STR_LEN];
uint32_t chunk;
uint32_t task;
};
struct p2p_phdr {
bool sent;
};
* Packet "pseudo-header" information for 802.11.
* Radio information is only present in this form for
* WTAP_ENCAP_IEEE_802_11_WITH_RADIO. This is used for file formats in
* which the radio information isn't provided as a pseudo-header in the
* packet data. It is also used by the dissectors for the pseudo-headers
* in the packet data to supply radio information, in a form independent
* of the file format and pseudo-header format, to the "802.11 radio"
* dissector.
*
* Signal strength, etc. information:
*
* Raw signal strength can be measured in milliwatts.
* It can also be represented as dBm, which is 10 times the log base 10
* of the signal strength in mW.
*
* The Receive Signal Strength Indicator is an integer in the range 0 to 255.
* The actual RSSI value for a given signal strength is dependent on the
* vendor (and perhaps on the adapter). The maximum possible RSSI value
* is also dependent on the vendor and perhaps the adapter.
*
* The signal strength can be represented as a percentage, which is 100
* times the ratio of the RSSI and the maximum RSSI.
*/
* PHY types.
*/
#define PHDR_802_11_PHY_UNKNOWN 0
#define PHDR_802_11_PHY_11_FHSS 1
#define PHDR_802_11_PHY_11_IR 2
#define PHDR_802_11_PHY_11_DSSS 3
#define PHDR_802_11_PHY_11B 4
#define PHDR_802_11_PHY_11A 5
#define PHDR_802_11_PHY_11G 6
#define PHDR_802_11_PHY_11N 7
#define PHDR_802_11_PHY_11AC 8
#define PHDR_802_11_PHY_11AD 9
#define PHDR_802_11_PHY_11AH 10
#define PHDR_802_11_PHY_11AX 11
#define PHDR_802_11_PHY_11BE 12
* PHY-specific information.
*/
* 802.11 legacy FHSS.
*/
struct ieee_802_11_fhss {
unsigned has_hop_set:1;
unsigned has_hop_pattern:1;
unsigned has_hop_index:1;
uint8_t hop_set;
uint8_t hop_pattern;
uint8_t hop_index;
};
* 802.11b.
*/
struct ieee_802_11b {
unsigned has_short_preamble:1;
bool short_preamble;
};
* 802.11a.
*/
struct ieee_802_11a {
unsigned has_channel_type:1;
unsigned has_turbo_type:1;
unsigned channel_type:2;
unsigned turbo_type:2;
};
* Channel type values.
*/
#define PHDR_802_11A_CHANNEL_TYPE_NORMAL 0
#define PHDR_802_11A_CHANNEL_TYPE_HALF_CLOCKED 1
#define PHDR_802_11A_CHANNEL_TYPE_QUARTER_CLOCKED 2
* "Turbo" is an Atheros proprietary extension with 40 MHz-wide channels.
* It can be dynamic or static.
*
* See
*
* http://wifi-insider.com/atheros/turbo.htm
*/
#define PHDR_802_11A_TURBO_TYPE_NORMAL 0
#define PHDR_802_11A_TURBO_TYPE_TURBO 1
#define PHDR_802_11A_TURBO_TYPE_DYNAMIC_TURBO 2
#define PHDR_802_11A_TURBO_TYPE_STATIC_TURBO 3
* 802.11g.
*
* This should only be used for packets sent using OFDM; packets
* sent on an 11g network using DSSS should have the PHY set to
* 11b.
*/
struct ieee_802_11g {
unsigned has_mode:1;
uint32_t mode;
};
* Mode values.
*/
#define PHDR_802_11G_MODE_NORMAL 0
#define PHDR_802_11G_MODE_SUPER_G 1
* 802.11n.
*/
struct ieee_802_11n {
unsigned has_mcs_index:1;
unsigned has_bandwidth:1;
unsigned has_short_gi:1;
unsigned has_greenfield:1;
unsigned has_fec:1;
unsigned has_stbc_streams:1;
unsigned has_ness:1;
uint16_t mcs_index;
unsigned bandwidth;
unsigned short_gi:1;
unsigned greenfield:1;
unsigned fec:1;
unsigned stbc_streams:2;
unsigned ness;
};
* Bandwidth values; used for both 11n and 11ac.
*/
#define PHDR_802_11_BANDWIDTH_20_MHZ 0
#define PHDR_802_11_BANDWIDTH_40_MHZ 1
#define PHDR_802_11_BANDWIDTH_20_20L 2
#define PHDR_802_11_BANDWIDTH_20_20U 3
#define PHDR_802_11_BANDWIDTH_80_MHZ 4
#define PHDR_802_11_BANDWIDTH_40_40L 5
#define PHDR_802_11_BANDWIDTH_40_40U 6
#define PHDR_802_11_BANDWIDTH_20LL 7
#define PHDR_802_11_BANDWIDTH_20LU 8
#define PHDR_802_11_BANDWIDTH_20UL 9
#define PHDR_802_11_BANDWIDTH_20UU 10
#define PHDR_802_11_BANDWIDTH_160_MHZ 11
#define PHDR_802_11_BANDWIDTH_80_80L 12
#define PHDR_802_11_BANDWIDTH_80_80U 13
#define PHDR_802_11_BANDWIDTH_40LL 14
#define PHDR_802_11_BANDWIDTH_40LU 15
#define PHDR_802_11_BANDWIDTH_40UL 16
#define PHDR_802_11_BANDWIDTH_40UU 17
#define PHDR_802_11_BANDWIDTH_20LLL 18
#define PHDR_802_11_BANDWIDTH_20LLU 19
#define PHDR_802_11_BANDWIDTH_20LUL 20
#define PHDR_802_11_BANDWIDTH_20LUU 21
#define PHDR_802_11_BANDWIDTH_20ULL 22
#define PHDR_802_11_BANDWIDTH_20ULU 23
#define PHDR_802_11_BANDWIDTH_20UUL 24
#define PHDR_802_11_BANDWIDTH_20UUU 25
* 802.11ac.
*/
struct ieee_802_11ac {
unsigned has_stbc:1;
unsigned has_txop_ps_not_allowed:1;
unsigned has_short_gi:1;
unsigned has_short_gi_nsym_disambig:1;
unsigned has_ldpc_extra_ofdm_symbol:1;
unsigned has_beamformed:1;
unsigned has_bandwidth:1;
unsigned has_fec:1;
unsigned has_group_id:1;
unsigned has_partial_aid:1;
unsigned stbc:1;
unsigned txop_ps_not_allowed:1;
unsigned short_gi:1;
unsigned short_gi_nsym_disambig:1;
unsigned ldpc_extra_ofdm_symbol:1;
unsigned beamformed:1;
uint8_t bandwidth;
uint8_t mcs[4];
uint8_t nss[4];
uint8_t fec;
uint8_t group_id;
uint16_t partial_aid;
};
* 802.11ad.
*/
* Min and Max frequencies for 802.11ad and a macro for checking for 802.11ad.
*/
#define PHDR_802_11AD_MIN_FREQUENCY 57000
#define PHDR_802_11AD_MAX_FREQUENCY 71000
#define IS_80211AD(frequency) (((frequency) >= PHDR_802_11AD_MIN_FREQUENCY) &&\
((frequency) <= PHDR_802_11AD_MAX_FREQUENCY))
struct ieee_802_11ad {
unsigned has_mcs_index:1;
uint8_t mcs;
};
* 802.11ax (HE).
*/
struct ieee_802_11ax {
unsigned has_mcs_index:1;
unsigned has_bwru:1;
unsigned has_gi:1;
uint8_t nsts:4;
uint8_t mcs:4;
uint8_t bwru:4;
uint8_t gi:2;
};
* 802.11be (EHT).
*/
struct ieee_802_11be_user_info {
unsigned sta_id_known:1;
unsigned mcs_known:1;
unsigned coding_known:1;
unsigned rsv_known:1;
unsigned nsts_known:1;
unsigned bf_known:1;
unsigned spatial_config_known:1;
unsigned data_for_this_user:1;
unsigned sta_id:11;
unsigned ldpc_coding:1;
unsigned mcs:4;
unsigned nsts:4;
unsigned rsv:1;
unsigned beamform:1;
unsigned rsv2:2;
};
#define PHDR_802_11BE_MAX_USERS 4
struct ieee_802_11be {
unsigned has_ru_mru_size:1;
unsigned has_gi:1;
unsigned has_bandwidth:1;
uint8_t bandwidth;
uint8_t ru_mru_size:4;
uint8_t gi:2;
uint8_t num_users;
struct ieee_802_11be_user_info user[PHDR_802_11BE_MAX_USERS];
};
union ieee_802_11_phy_info {
struct ieee_802_11_fhss info_11_fhss;
struct ieee_802_11b info_11b;
struct ieee_802_11a info_11a;
struct ieee_802_11g info_11g;
struct ieee_802_11n info_11n;
struct ieee_802_11ac info_11ac;
struct ieee_802_11ad info_11ad;
struct ieee_802_11ax info_11ax;
struct ieee_802_11be info_11be;
};
struct ieee_802_11_phdr {
int fcs_len;
unsigned decrypted:1;
unsigned datapad:1;
unsigned no_a_msdus:1;
unsigned phy;
union ieee_802_11_phy_info phy_info;
unsigned has_channel:1;
unsigned has_frequency:1;
unsigned has_data_rate:1;
unsigned has_signal_percent:1;
unsigned has_noise_percent:1;
unsigned has_signal_dbm:1;
unsigned has_noise_dbm:1;
unsigned has_signal_db:1;
unsigned has_noise_db:1;
unsigned has_tsf_timestamp:1;
unsigned has_aggregate_info:1;
unsigned has_zero_length_psdu_type:1;
uint16_t channel;
uint32_t frequency;
uint16_t data_rate;
uint8_t signal_percent;
uint8_t noise_percent;
int8_t signal_dbm;
int8_t noise_dbm;
uint8_t signal_db;
uint8_t noise_db;
uint64_t tsf_timestamp;
uint32_t aggregate_flags;
uint32_t aggregate_id;
uint8_t zero_length_psdu_type;
};
* A-MPDU flags.
*/
#define PHDR_802_11_LAST_PART_OF_A_MPDU 0x00000001
#define PHDR_802_11_A_MPDU_DELIM_CRC_ERROR 0x00000002
* Zero-length PSDU types.
*/
#define PHDR_802_11_SOUNDING_PSDU 0
#define PHDR_802_11_DATA_NOT_CAPTURED 1
#define PHDR_802_11_0_LENGTH_PSDU_VENDOR_SPECIFIC 0xff
#define COSINE_MAX_IF_NAME_LEN 128
#define COSINE_ENCAP_TEST 1
#define COSINE_ENCAP_PPoATM 2
#define COSINE_ENCAP_PPoFR 3
#define COSINE_ENCAP_ATM 4
#define COSINE_ENCAP_FR 5
#define COSINE_ENCAP_HDLC 6
#define COSINE_ENCAP_PPP 7
#define COSINE_ENCAP_ETH 8
#define COSINE_ENCAP_UNKNOWN 99
#define COSINE_DIR_TX 1
#define COSINE_DIR_RX 2
struct cosine_phdr {
uint8_t encap;
uint8_t direction;
char if_name[COSINE_MAX_IF_NAME_LEN];
uint16_t pro;
uint16_t off;
uint16_t pri;
uint16_t rm;
uint16_t err;
};
* Direction of the packet
*/
#define IRDA_INCOMING 0x0000
#define IRDA_OUTGOING 0x0004
* "Inline" log messages produced by IrCOMM2k on Windows
*/
#define IRDA_LOG_MESSAGE 0x0100
#define IRDA_MISSED_MSG 0x0101
* Differentiate between frames and log messages
*/
#define IRDA_CLASS_FRAME 0x0000
#define IRDA_CLASS_LOG 0x0100
#define IRDA_CLASS_MASK 0xFF00
struct irda_phdr {
uint16_t pkttype;
};
struct nettl_phdr {
uint16_t subsys;
uint32_t devid;
uint32_t kind;
int32_t pid;
uint32_t uid;
};
#define MTP2_ANNEX_A_NOT_USED 0
#define MTP2_ANNEX_A_USED 1
#define MTP2_ANNEX_A_USED_UNKNOWN 2
struct mtp2_phdr {
uint8_t sent;
uint8_t annex_a_used;
uint16_t link_number;
};
typedef union {
struct {
uint16_t vp;
uint16_t vc;
uint16_t cid;
} atm;
uint32_t ds0mask;
} k12_input_info_t;
struct k12_phdr {
uint32_t input;
const char *input_name;
const char *stack_file;
uint32_t input_type;
k12_input_info_t input_info;
uint8_t *extra_info;
uint32_t extra_length;
void* stuff;
};
#define K12_PORT_DS0S 0x00010008
#define K12_PORT_DS1 0x00100008
#define K12_PORT_ATMPVC 0x01020000
struct lapd_phdr {
uint16_t pkttype;
uint8_t we_network;
};
struct wtap;
struct catapult_dct2000_phdr
{
union
{
struct isdn_phdr isdn;
struct atm_phdr atm;
struct p2p_phdr p2p;
} inner_pseudo_header;
int64_t seek_off;
struct wtap *wth;
};
* Endace Record Format pseudo header
*/
struct erf_phdr {
uint64_t ts;
uint8_t type;
uint8_t flags;
uint16_t rlen;
uint16_t lctr;
uint16_t wlen;
};
struct erf_ehdr {
uint64_t ehdr;
};
* ERF pseudo header with optional subheader
* (Multichannel or Ethernet)
*/
#define MAX_ERF_EHDR 16
struct wtap_erf_eth_hdr {
uint8_t offset;
uint8_t pad;
};
struct erf_mc_phdr {
struct erf_phdr phdr;
struct erf_ehdr ehdr_list[MAX_ERF_EHDR];
union
{
struct wtap_erf_eth_hdr eth_hdr;
uint32_t mc_hdr;
uint32_t aal2_hdr;
} subhdr;
};
#define SITA_FRAME_DIR_TXED (0x00)
#define SITA_FRAME_DIR_RXED (0x01)
#define SITA_FRAME_DIR (0x01)
#define SITA_ERROR_NO_BUFFER (0x80)
#define SITA_SIG_DSR (0x01)
#define SITA_SIG_DTR (0x02)
#define SITA_SIG_CTS (0x04)
#define SITA_SIG_RTS (0x08)
#define SITA_SIG_DCD (0x10)
#define SITA_SIG_UNDEF1 (0x20)
#define SITA_SIG_UNDEF2 (0x40)
#define SITA_SIG_UNDEF3 (0x80)
#define SITA_ERROR_TX_UNDERRUN (0x01)
#define SITA_ERROR_TX_CTS_LOST (0x02)
#define SITA_ERROR_TX_UART_ERROR (0x04)
#define SITA_ERROR_TX_RETX_LIMIT (0x08)
#define SITA_ERROR_TX_UNDEF1 (0x10)
#define SITA_ERROR_TX_UNDEF2 (0x20)
#define SITA_ERROR_TX_UNDEF3 (0x40)
#define SITA_ERROR_TX_UNDEF4 (0x80)
#define SITA_ERROR_RX_FRAMING (0x01)
#define SITA_ERROR_RX_PARITY (0x02)
#define SITA_ERROR_RX_COLLISION (0x04)
#define SITA_ERROR_RX_FRAME_LONG (0x08)
#define SITA_ERROR_RX_FRAME_SHORT (0x10)
#define SITA_ERROR_RX_UNDEF1 (0x20)
#define SITA_ERROR_RX_UNDEF2 (0x40)
#define SITA_ERROR_RX_UNDEF3 (0x80)
#define SITA_ERROR_RX_NONOCTET_ALIGNED (0x01)
#define SITA_ERROR_RX_ABORT (0x02)
#define SITA_ERROR_RX_CD_LOST (0x04)
#define SITA_ERROR_RX_DPLL (0x08)
#define SITA_ERROR_RX_OVERRUN (0x10)
#define SITA_ERROR_RX_FRAME_LEN_VIOL (0x20)
#define SITA_ERROR_RX_CRC (0x40)
#define SITA_ERROR_RX_BREAK (0x80)
#define SITA_PROTO_UNUSED (0x00)
#define SITA_PROTO_BOP_LAPB (0x01)
#define SITA_PROTO_ETHERNET (0x02)
#define SITA_PROTO_ASYNC_INTIO (0x03)
#define SITA_PROTO_ASYNC_BLKIO (0x04)
#define SITA_PROTO_ALC (0x05)
#define SITA_PROTO_UTS (0x06)
#define SITA_PROTO_PPP_HDLC (0x07)
#define SITA_PROTO_SDLC (0x08)
#define SITA_PROTO_TOKENRING (0x09)
#define SITA_PROTO_I2C (0x10)
#define SITA_PROTO_DPM_LINK (0x11)
#define SITA_PROTO_BOP_FRL (0x12)
struct sita_phdr {
uint8_t sita_flags;
uint8_t sita_signals;
uint8_t sita_errors1;
uint8_t sita_errors2;
uint8_t sita_proto;
};
struct bthci_phdr {
bool sent;
uint32_t channel;
};
#define BTHCI_CHANNEL_COMMAND 1
#define BTHCI_CHANNEL_ACL 2
#define BTHCI_CHANNEL_SCO 3
#define BTHCI_CHANNEL_EVENT 4
#define BTHCI_CHANNEL_ISO 5
struct btmon_phdr {
uint16_t adapter_id;
uint16_t opcode;
};
struct l1event_phdr {
bool uton;
};
struct i2c_phdr {
uint8_t is_event;
uint8_t bus;
uint32_t flags;
};
struct gsm_um_phdr {
bool uplink;
uint8_t channel;
uint8_t bsic;
uint16_t arfcn;
uint32_t tdma_frame;
uint8_t error;
uint16_t timeshift;
};
#define GSM_UM_CHANNEL_UNKNOWN 0
#define GSM_UM_CHANNEL_BCCH 1
#define GSM_UM_CHANNEL_SDCCH 2
#define GSM_UM_CHANNEL_SACCH 3
#define GSM_UM_CHANNEL_FACCH 4
#define GSM_UM_CHANNEL_CCCH 5
#define GSM_UM_CHANNEL_RACH 6
#define GSM_UM_CHANNEL_AGCH 7
#define GSM_UM_CHANNEL_PCH 8
struct nstr_phdr {
int64_t rec_offset;
int32_t rec_len;
uint8_t nicno_offset;
uint8_t nicno_len;
uint8_t dir_offset;
uint8_t dir_len;
uint16_t eth_offset;
uint8_t pcb_offset;
uint8_t l_pcb_offset;
uint8_t rec_type;
uint8_t vlantag_offset;
uint8_t coreid_offset;
uint8_t srcnodeid_offset;
uint8_t destnodeid_offset;
uint8_t clflags_offset;
uint8_t src_vmname_len_offset;
uint8_t dst_vmname_len_offset;
uint8_t ns_activity_offset;
uint8_t data_offset;
};
struct nokia_phdr {
struct eth_phdr eth;
uint8_t stuff[4];
};
#define LLCP_PHDR_FLAG_SENT 0
struct llcp_phdr {
uint8_t adapter;
uint8_t flags;
};
struct logcat_phdr {
int version;
};
struct netmon_phdr {
uint8_t* title;
uint32_t descLength;
uint8_t* description;
unsigned sub_encap;
union sub_wtap_pseudo_header {
struct eth_phdr eth;
struct atm_phdr atm;
struct ieee_802_11_phdr ieee_802_11;
} subheader;
};
struct ber_phdr {
const char *pathname;
};
union wtap_pseudo_header {
struct eth_phdr eth;
struct dte_dce_phdr dte_dce;
struct isdn_phdr isdn;
struct atm_phdr atm;
struct ascend_phdr ascend;
struct p2p_phdr p2p;
struct ieee_802_11_phdr ieee_802_11;
struct cosine_phdr cosine;
struct irda_phdr irda;
struct nettl_phdr nettl;
struct mtp2_phdr mtp2;
struct k12_phdr k12;
struct lapd_phdr lapd;
struct catapult_dct2000_phdr dct2000;
struct erf_mc_phdr erf;
struct sita_phdr sita;
struct bthci_phdr bthci;
struct btmon_phdr btmon;
struct l1event_phdr l1event;
struct i2c_phdr i2c;
struct gsm_um_phdr gsm_um;
struct nstr_phdr nstr;
struct nokia_phdr nokia;
struct llcp_phdr llcp;
struct logcat_phdr logcat;
struct netmon_phdr netmon;
struct ber_phdr ber;
};
* Record type values.
*
* This list will expand over time, so don't assume everything will
* forever be one of the types listed below.
*
* For file-type-specific records, the "ftsrec" field of the pseudo-header
* contains a file-type-specific subtype value, such as a block type for
* a pcapng file.
*
* An "event" is an indication that something happened during the capture
* process, such as a status transition of some sort on the network.
* These should, ideally, have a time stamp and, if they're relevant to
* a particular interface on a multi-interface capture, should also have
* an interface ID. The data for the event is file-type-specific and
* subtype-specific. These should be dissected and displayed just as
* packets are.
*
* A "report" supplies information not corresponding to an event;
* for example, a pcapng Interface Statistics Block would be a report,
* as it doesn't correspond to something happening on the network.
* They may have a time stamp, and should be dissected and displayed
* just as packets are.
*
* We distinguish between "events" and "reports" so that, for example,
* the packet display can show the delta between a packet and an event
* but not show the delta between a packet and a report, as the time
* stamp of a report may not correspond to anything interesting on
* the network but the time stamp of an event would.
*
* XXX - are there any file-type-specific records that *shouldn't* be
* dissected and displayed? If so, they should be parsed and the
* information in them stored somewhere, and used somewhere, whether
* it's just used when saving the file in its native format or also
* used to parse *other* file-type-specific records.
*
* These would be similar to, for example, pcapng Interface Description
* Blocks, for which the position within the file is significant only
* in that an IDB for an interface must appear before any packets from
* the interface; the fact that an IDB appears at some point doesn't
* necessarily mean something happened in the capture at that point.
* Name Resolution Blocks are another example of such a record.
*
* (XXX - if you want to have a record that says "this interface first
* showed up at this time", that needs to be a separate record type
* from the IDB. We *could* add a "New Interface Description Block",
* with a time stamp, for that purpose, but we'd *still* have to
* provide IDBs for those interfaces, for compatibility with programs
* that don't know about the NIDB. An ISB with only an isb_starttime
* option would suffice for this purpose, so nothing needs to be
* added to pcapng for this.)
*/
#define REC_TYPE_PACKET 0
#define REC_TYPE_FT_SPECIFIC_EVENT 1
#define REC_TYPE_FT_SPECIFIC_REPORT 2
#define REC_TYPE_SYSCALL 3
#define REC_TYPE_SYSTEMD_JOURNAL_EXPORT 4
#define REC_TYPE_CUSTOM_BLOCK 5
typedef struct {
uint32_t caplen;
uint32_t len;
int pkt_encap;
uint32_t interface_id;
union wtap_pseudo_header pseudo_header;
} wtap_packet_header;
* The pcapng specification says "The word is encoded as an unsigned
* 32-bit integer, using the endianness of the Section Header Block
* scope it is in. In the following table, the bits are numbered with
* 0 being the most-significant bit and 31 being the least-significant
* bit of the 32-bit unsigned integer."
*
* From that, the direction, in bits 0 and 1, is at the *top* of the word.
*
* However, several implementations, such as:
*
* the Wireshark pcapng file reading code;
*
* macOS libpcap and tcpdump;
*
* text2pcap;
*
* and probably the software that generated the capture in bug 11665;
*
* treat 0 as the *least*-significant bit and bit 31 being the *most*-
* significant bit of the flags word, and put the direction at the
* *bottom* of the word.
*
* For now, we go with the known implementations.
*/
#define PACK_FLAGS_DIRECTION_MASK 0x00000003
#define PACK_FLAGS_DIRECTION_SHIFT 0
#define PACK_FLAGS_DIRECTION(pack_flags) (((pack_flags) & PACK_FLAGS_DIRECTION_MASK) >> PACK_FLAGS_DIRECTION_SHIFT)
#define PACK_FLAGS_DIRECTION_UNKNOWN 0
#define PACK_FLAGS_DIRECTION_INBOUND 1
#define PACK_FLAGS_DIRECTION_OUTBOUND 2
#define PACK_FLAGS_RECEPTION_TYPE_MASK 0x0000001C
#define PACK_FLAGS_RECEPTION_TYPE_SHIFT 2
#define PACK_FLAGS_RECEPTION_TYPE(pack_flags) (((pack_flags) & PACK_FLAGS_RECEPTION_TYPE_MASK) >> PACK_FLAGS_RECEPTION_TYPE_SHIFT)
#define PACK_FLAGS_RECEPTION_TYPE_UNSPECIFIED 0
#define PACK_FLAGS_RECEPTION_TYPE_UNICAST 1
#define PACK_FLAGS_RECEPTION_TYPE_MULTICAST 2
#define PACK_FLAGS_RECEPTION_TYPE_BROADCAST 3
#define PACK_FLAGS_RECEPTION_TYPE_PROMISCUOUS 4
#define PACK_FLAGS_FCS_LENGTH_MASK 0x000001E0
#define PACK_FLAGS_FCS_LENGTH_SHIFT 5
#define PACK_FLAGS_FCS_LENGTH(pack_flags) (((pack_flags) & PACK_FLAGS_FCS_LENGTH_MASK) >> PACK_FLAGS_FCS_LENGTH_SHIFT)
#define PACK_FLAGS_RESERVED_MASK 0x0000FE00
#define PACK_FLAGS_CRC_ERROR 0x01000000
#define PACK_FLAGS_PACKET_TOO_LONG 0x02000000
#define PACK_FLAGS_PACKET_TOO_SHORT 0x04000000
#define PACK_FLAGS_WRONG_INTER_FRAME_GAP 0x08000000
#define PACK_FLAGS_UNALIGNED_FRAME 0x10000000
#define PACK_FLAGS_START_FRAME_DELIMITER_ERROR 0x20000000
#define PACK_FLAGS_PREAMBLE_ERROR 0x40000000
#define PACK_FLAGS_SYMBOL_ERROR 0x80000000
#define PACK_FLAGS_VALUE(direction, reception_type, fcs_length, ll_dependent_errors) \
(((direction) << 30) | \
((reception_type) << 27) | \
((fcs_length) << 23) | \
(ll_dependent_errors))
typedef struct {
unsigned record_type;
uint32_t record_len;
} wtap_ft_specific_header;
typedef struct {
const char *pathname;
unsigned record_type;
int byte_order;
uint64_t timestamp;
uint64_t thread_id;
uint32_t event_len;
uint32_t event_filelen;
uint16_t event_type;
uint32_t nparams;
uint16_t cpu_id;
} wtap_syscall_header;
typedef struct {
uint32_t record_len;
} wtap_systemd_journal_export_header;
typedef struct {
uint32_t length;
uint32_t pen;
bool copy_allowed;
union {
struct nflx {
uint32_t type;
uint32_t skipped;
} nflx_custom_data_header;
} custom_data_header;
} wtap_custom_block_header;
#define BBLOG_TYPE_EVENT_BLOCK 1
#define BBLOG_TYPE_SKIPPED_BLOCK 2
* The largest nstime.secs value that can be put into an unsigned
* 32-bit quantity.
*
* We assume that time_t is signed; it is signed on Windows/MSVC and
* on many UN*Xes.
*
* So, if time_t is 32-bit, we define this as INT32_MAX, as that's
* the largest value a time_t can have, and it fits in an unsigned
* 32-bit quantity. If it's 64-bit or larger, we define this as
* UINT32_MAX, as, even if it's signed, it can be as large as
* UINT32_MAX, and that's the largest value that can fit in
* a 32-bit unsigned quantity.
*
* Comparing against this, rather than against G_MAXINT2, when checking
* whether a time stamp will fit in a 32-bit unsigned integer seconds
* field in a capture file being written avoids signed vs. unsigned
* warnings if time_t is a signed 32-bit type.
*
* XXX - what if time_t is unsigned? Are there any platforms where
* it is?
*/
#define WTAP_NSTIME_32BIT_SECS_MAX ((time_t)(sizeof(time_t) > sizeof(int32_t) ? UINT32_MAX : INT32_MAX))
typedef struct wtap_rec {
unsigned rec_type;
uint32_t presence_flags;
unsigned section_number;
nstime_t ts;
int tsprec;
nstime_t ts_rel_cap;
bool ts_rel_cap_valid;
union {
wtap_packet_header packet_header;
wtap_ft_specific_header ft_specific_header;
wtap_syscall_header syscall_header;
wtap_systemd_journal_export_header systemd_journal_export_header;
wtap_custom_block_header custom_block_header;
} rec_header;
wtap_block_t block ;
bool block_was_modified;
* We use a Buffer so that we don't have to allocate and free
* a buffer for the options for each record.
*/
Buffer options_buf;
} wtap_rec;
* Bits in presence_flags, indicating which of the fields we have.
*
* For the time stamp, we may need some more flags to indicate
* whether the time stamp is an absolute date-and-time stamp, an
* absolute time-only stamp (which can make relative time
* calculations tricky, as you could in theory have two time
* stamps separated by an unknown number of days), or a time stamp
* relative to some unspecified time in the past (see mpeg.c).
*
* There is no presence flag for len - there has to be *some* length
* value for the packet. (The "captured length" can be missing if
* the file format doesn't report a captured length distinct from
* the on-the-network length because the application(s) producing those
* files don't support slicing packets.)
*
* There could be a presence flag for the packet encapsulation - if it's
* absent, use the file encapsulation - but it's not clear that's useful;
* we currently do that in the module for the file format.
*
* Only WTAP_HAS_TS and WTAP_HAS_SECTION_NUMBER apply to all record types.
*/
#define WTAP_HAS_TS 0x00000001
#define WTAP_HAS_CAP_LEN 0x00000002
#define WTAP_HAS_INTERFACE_ID 0x00000004
#define WTAP_HAS_SECTION_NUMBER 0x00000008
#ifndef MAXNAMELEN
#define MAXNAMELEN 64
#endif
typedef struct hashipv4 {
unsigned addr;
uint8_t flags;
char ip[WS_INET_ADDRSTRLEN];
char name[MAXNAMELEN];
char cidr_addr[WS_INET_CIDRADDRSTRLEN];
} hashipv4_t;
typedef struct hashipv6 {
uint8_t addr[16];
uint8_t flags;
char ip6[WS_INET6_ADDRSTRLEN];
char name[MAXNAMELEN];
} hashipv6_t;
* Used when writing name resolutions blocks (NRB)
*/
typedef struct addrinfo_lists {
GList *ipv4_addr_list;
GList *ipv6_addr_list;
} addrinfo_lists_t;
* Parameters for various wtap_dump_* functions, specifying per-file
* information. The structure itself is no longer used after returning
* from wtap_dump_*, but its pointer fields must remain valid until
* wtap_dump_close is called.
*
* @note The shb_hdr and idb_inf arguments will be used until
* wtap_dump_close() is called, but will not be free'd by the dumper. If
* you created them, you must free them yourself after wtap_dump_close().
* dsbs_initial will be unreferenced by wtap_dump_close(), so to reuse
* them for another dump file, call wtap_block_array_ref() before closing.
* dsbs_growing typically refers to another wth->dsbs.
* nrbs_growing typically refers to another wth->nrbs.
*
* @see wtap_dump_params_init, wtap_dump_params_cleanup.
*/
typedef struct wtap_dump_params {
int encap;
int snaplen;
int tsprec;
GArray *shb_hdrs;
const GArray *shb_iface_to_global;
This array may grow after the dumper is opened if a new
section header is read. */
wtapng_iface_descriptions_t *idb_inf;
const GArray *nrbs_growing;
This array may grow since the dumper was opened and will subsequently
be written before newer packets are written in wtap_dump. */
GArray *dsbs_initial;
const GArray *dsbs_growing;
This array may grow since the dumper was opened and will subsequently
be written before newer packets are written in wtap_dump. */
const GArray *mevs_growing;
This array may grow since the dumper was opened and will subsequently
be written before newer packets are written in wtap_dump. */
bool dont_copy_idbs;
} wtap_dump_params;
#define WTAP_DUMP_PARAMS_INIT {.snaplen=0}
struct wtap_dumper;
typedef struct wtap wtap;
typedef struct wtap_dumper wtap_dumper;
typedef struct wtap_reader *FILE_T;
* wtap_wslua_file_info struct is used by wslua code for Lua-based file writers.
*
* This concept is necessary because when wslua goes to invoke the
* registered dump/write_open routine callback in Lua, it needs the ref number representing
* the hooked function inside Lua. This will be stored in the thing pointed to
* by the void* data here. This 'data' pointer will be copied into the
* wtap_dumper struct's 'void* data' member when calling the dump_open function,
* which is how wslua finally retrieves it. Unlike wtap_dumper's 'priv' member, its
* 'data' member is not free'd in wtap_dump_close().
*/
typedef struct wtap_wslua_file_info {
int (*wslua_can_write_encap)(int, void*);
void* wslua_data;
} wtap_wslua_file_info_t;
* For registering extensions used for file formats.
*
* These items are used in dialogs for opening files, so that
* the user can ask to see all capture files (as identified
* by file extension) or particular types of capture files.
*
* Each item has a human-readable description of the file types
* (possibly more than one!) that use all of this set of extensions,
* a flag indicating whether it's a capture file or just some file
* whose contents we can dissect, and a list of extensions files of
* that type might have.
*
* Note that entries in this table do *not* necessarily correspoond
* to single file types; for example, the entry that lists just "cap"
* is for several file formats, all of which use the extension ".cap".
*
* Also note that a given extension may appear in multiple entries;
* for example, "cap" (again!) is in an entry for some file types
* that use only ".cap" and in entries for file types that use
* ".cap" and some other extensions, and ".trc" is used both for
* DOS Sniffer Token Ring captures ("trc") and EyeSDN USB ISDN
* trace files ("tr{a}c{e}").
*
* Some entries aren't for capture file types, they're just generic types,
* such as "text file" or "XML file", that can be used for, among other
* things, captures we can read, or for file formats we can read in
* order to dissect the contents of the file (think of this as "Fileshark",
* which is a program that we really should have). Those are marked
* specially, because, in file section dialogs, the user should be able
* to select "All Capture Files" and get a set of extensions that are
* associated with capture file formats, but not with files in other
* formats that might or might not contain captured packets (such as
* .txt or .xml") or formats that aren't capture files but that we
* support as "we're being Fileshark now" (such as .jpeg). The routine
* that constructs a list of extensions for "All Capture Files" omits
* extensions for those entries.
*/
struct file_extension_info {
const char *name;
bool is_capture_file;
const char *extensions;
};
* For registering file types that we can open.
*
* Each file type has an open routine.
*
* The open routine should return:
*
* WTAP_OPEN_ERROR on an I/O error;
*
* WTAP_OPEN_MINE if the file it's reading is one of the types
* it handles;
*
* WTAP_OPEN_NOT_MINE if the file it's reading isn't one of the
* types it handles.
*
* If the routine handles this type of file, it should set the
* "file_type_subtype" field in the "struct wtap" to the type of the file.
*
* Note that the routine does not have to free the private data pointer on
* error. The caller takes care of that by calling wtap_close on error.
* (See https://gitlab.com/wireshark/wireshark/-/issues/8518)
*
* However, the caller does have to free the private data pointer when
* returning WTAP_OPEN_NOT_MINE, since the next file type will be called
* and will likely just overwrite the pointer.
*/
typedef enum {
WTAP_OPEN_NOT_MINE = 0,
WTAP_OPEN_MINE = 1,
WTAP_OPEN_ERROR = -1
} wtap_open_return_val;
typedef wtap_open_return_val (*wtap_open_routine_t)(struct wtap*, int *,
char **);
* Some file formats have defined magic numbers at fixed offsets from
* the beginning of the file; those routines should return 1 if and
* only if the file has the magic number at that offset. (pcapng
* is a bit of a special case, as it has both the Section Header Block
* type field and its byte-order magic field; it checks for both.)
* Those file formats do not require a file name extension in order
* to recognize them or to avoid recognizing other file types as that
* type, and have no extensions specified for them.
*
* Other file formats don't have defined magic numbers at fixed offsets,
* so a heuristic is required. If that file format has any file name
* extensions used for it, a list of those extensions should be
* specified, so that, if the name of the file being opened has an
* extension, the file formats that use that extension are tried before
* the ones that don't, to handle the case where a file of one type
* might be recognized by the heuristics for a different file type.
*/
typedef enum {
OPEN_INFO_MAGIC = 0,
OPEN_INFO_HEURISTIC = 1
} wtap_open_type;
WS_DLL_PUBLIC void init_open_routines(void);
void cleanup_open_routines(void);
* Information about a given file type that applies to all subtypes of
* the file type.
*
* Each file type has:
*
* a human-readable description of the file type, for use in the
* user interface;
* a wtap_open_type indication of how the open routine
* determines whether a file is of that type;
* an open routine;
* an optional list of extensions used for this file type;
* data to be passed to Lua file readers - this should be NULL for
* non-Lua (C) file readers.
*
* The list of file extensions is used as a hint when calling open routines
* to open a file; heuristic open routines whose list of extensions includes
* the file's extension are called before heuristic open routines whose
* (possibly-empty) list of extensions doesn't contain the file's extension,
* to reduce the chances that a file will be misidentified due to an heuristic
* test with a weak heuristic being done before a heuristic test for the
* file's type.
*
* The list of extensions should be NULL for magic-number open routines,
* as it will not be used for any purpose (no such hinting is done).
*/
struct open_info {
const char *name;
wtap_open_type type;
wtap_open_routine_t open_routine;
const char *extensions;
char **extensions_set;
void* wslua_data;
};
WS_DLL_PUBLIC struct open_info *open_routines;
* Types of comments.
*/
#define WTAP_COMMENT_PER_SECTION 0x00000001
#define WTAP_COMMENT_PER_INTERFACE 0x00000002
#define WTAP_COMMENT_PER_PACKET 0x00000004
* For a given option type in a certain block type, does a file format
* not support it, support only one such option, or support multiple
* such options?
*/
typedef enum {
OPTION_NOT_SUPPORTED,
ONE_OPTION_SUPPORTED,
MULTIPLE_OPTIONS_SUPPORTED
} option_support_t;
* Entry in a table of supported option types.
*/
struct supported_option_type {
unsigned opt;
option_support_t support;
};
#define OPTION_TYPES_SUPPORTED(option_type_array) \
array_length(option_type_array), option_type_array
#define NO_OPTIONS_SUPPORTED \
0, NULL
* For a given block type, does a file format not support it, support
* only one such block, or support multiple such blocks?
*/
typedef enum {
BLOCK_NOT_SUPPORTED,
ONE_BLOCK_SUPPORTED,
MULTIPLE_BLOCKS_SUPPORTED
} block_support_t;
* Entry in a table of supported block types.
*/
struct supported_block_type {
wtap_block_type_t type;
block_support_t support;
size_t num_supported_options;
const struct supported_option_type *supported_options;
};
#define BLOCKS_SUPPORTED(block_type_array) \
array_length(block_type_array), block_type_array
struct file_type_subtype_info {
* The file type description.
*/
const char *description;
* The file type name, used to look up file types by name, e.g.
* looking up a file type specified as a command-line argument.
*/
const char *name;
* The default file extension, used to save this type.
* Should be NULL if no default extension is known.
*/
const char *default_file_extension;
* A semicolon-separated list of additional file extensions
* used for this type.
* Should be NULL if no extensions, or no extensions other
* than the default extension, are known.
*/
const char *additional_file_extensions;
* When writing this file format, is seeking required?
*/
bool writing_must_seek;
* Number of block types supported.
*/
size_t num_supported_blocks;
* Table of block types supported.
*/
const struct supported_block_type *supported_blocks;
* Can this type write this encapsulation format?
* Should be NULL is this file type doesn't have write support.
*
* XXX - This returns an int because it can return err codes,
* specifically WTAP_ERR_CHECK_WSLUA (instead of having an
* int *err parameter like the other functions.)
*/
int (*can_write_encap)(int);
* The function to open the capture file for writing.
* Should be NULL if this file type doesn't have write support.
*/
bool (*dump_open)(wtap_dumper *, int *, char **);
* If can_write_encap returned WTAP_ERR_CHECK_WSLUA, then this is used instead.
* This should be NULL for everyone except Lua-based file writers.
*/
wtap_wslua_file_info_t *wslua_info;
};
#define WTAP_TYPE_AUTO 0
* @brief Initialize the Wiretap library.
*
* @param load_wiretap_plugins Load Wiretap plugins when initializing library.
*/
WS_DLL_PUBLIC
void wtap_init(bool load_wiretap_plugins);
* "int" pointed to by its second argument:
*
* @param filename Name of the file to open
* @param type WTAP_TYPE_AUTO for automatic recognize file format or explicit choose format type
* @param[out] err a positive "errno" value if the capture file can't be opened;
* a negative number, indicating the type of error, on other failures.
* @param[out] err_info for some errors, a string giving more details of
* the error
* @param do_random true if random access to the file will be done,
* false if not
*/
WS_DLL_PUBLIC
struct wtap* wtap_open_offline(const char *filename, unsigned int type, int *err,
char **err_info, bool do_random);
* If we were compiled with zlib and we're at EOF, unset EOF so that
* wtap_read/gzread has a chance to succeed. This is necessary if
* we're tailing a file.
*/
WS_DLL_PUBLIC
void wtap_cleareof(wtap *wth);
* Set callback functions to add new hostnames. Currently pcapng-only.
* MUST match add_ipv4_name and add_ipv6_name in addr_resolv.c.
*/
typedef void (*wtap_new_ipv4_callback_t) (const unsigned addr, const char *name, const bool static_entry);
WS_DLL_PUBLIC
void wtap_set_cb_new_ipv4(wtap *wth, wtap_new_ipv4_callback_t add_new_ipv4);
typedef void (*wtap_new_ipv6_callback_t) (const void *addrp, const char *name, const bool static_entry);
WS_DLL_PUBLIC
void wtap_set_cb_new_ipv6(wtap *wth, wtap_new_ipv6_callback_t add_new_ipv6);
* Set callback function to receive new decryption secrets for a particular
* secrets type (as defined in secrets-types.h). Currently pcapng-only.
*/
typedef void (*wtap_new_secrets_callback_t)(uint32_t secrets_type, const void *secrets, unsigned size);
WS_DLL_PUBLIC
void wtap_set_cb_new_secrets(wtap *wth, wtap_new_secrets_callback_t add_new_secrets);
*
* @wth a wtap * returned by a call that opened a file for reading.
* @rec a pointer to a wtap_rec, filled in with information about the
* record.
* @buf a pointer to a Buffer, filled in with data from the record.
* @param err a positive "errno" value, or a negative number indicating
* the type of error, if the read failed.
* @param err_info for some errors, a string giving more details of
* the error
* @param offset a pointer to a int64_t, set to the offset in the file
* that should be used on calls to wtap_seek_read() to reread that record,
* if the read succeeded.
* @return true on success, false on failure.
*/
WS_DLL_PUBLIC
bool wtap_read(wtap *wth, wtap_rec *rec, Buffer *buf, int *err,
char **err_info, int64_t *offset);
* *phdr and *buf.
*
* @wth a wtap * returned by a call that opened a file for random-access
* reading.
* @seek_off a int64_t giving an offset value returned by a previous
* wtap_read() call.
* @rec a pointer to a struct wtap_rec, filled in with information
* about the record.
* @buf a pointer to a Buffer, filled in with data from the record.
* @param err a positive "errno" value, or a negative number indicating
* the type of error, if the read failed.
* @param err_info for some errors, a string giving more details of
* the error
* @return true on success, false on failure.
*/
WS_DLL_PUBLIC
bool wtap_seek_read(wtap *wth, int64_t seek_off, wtap_rec *rec,
Buffer *buf, int *err, char **err_info);
WS_DLL_PUBLIC
void wtap_rec_init(wtap_rec *rec);
WS_DLL_PUBLIC
void wtap_rec_reset(wtap_rec *rec);
WS_DLL_PUBLIC
void wtap_rec_cleanup(wtap_rec *rec);
* Types of compression for a file, including "none".
*/
typedef enum {
WTAP_UNCOMPRESSED,
WTAP_GZIP_COMPRESSED,
WTAP_ZSTD_COMPRESSED,
WTAP_LZ4_COMPRESSED,
WTAP_UNKNOWN_COMPRESSION,
} wtap_compression_type;
WS_DLL_PUBLIC
wtap_compression_type wtap_get_compression_type(wtap *wth);
WS_DLL_PUBLIC
wtap_compression_type wtap_name_to_compression_type(const char *name);
WS_DLL_PUBLIC
wtap_compression_type wtap_extension_to_compression_type(const char *ext);
WS_DLL_PUBLIC
const char *wtap_compression_type_description(wtap_compression_type compression_type);
WS_DLL_PUBLIC
const char *wtap_compression_type_extension(wtap_compression_type compression_type);
WS_DLL_PUBLIC
GSList *wtap_get_all_compression_type_extensions_list(void);
WS_DLL_PUBLIC
GSList *wtap_get_all_output_compression_type_names_list(void);
WS_DLL_PUBLIC
bool wtap_can_write_compression_type(wtap_compression_type compression_type);
* from the file so far. */
WS_DLL_PUBLIC
int64_t wtap_read_so_far(wtap *wth);
WS_DLL_PUBLIC
int64_t wtap_file_size(wtap *wth, int *err);
WS_DLL_PUBLIC
unsigned wtap_snapshot_length(wtap *wth);
WS_DLL_PUBLIC
int wtap_file_type_subtype(wtap *wth);
WS_DLL_PUBLIC
int wtap_file_encap(wtap *wth);
WS_DLL_PUBLIC
int wtap_file_tsprec(wtap *wth);
* @brief Gets number of section header blocks.
* @details Returns the number of existing SHBs.
*
* @param wth The wiretap session.
* @return The number of existing section headers.
*/
WS_DLL_PUBLIC
unsigned wtap_file_get_num_shbs(wtap *wth);
* @brief Gets existing section header block, not for new file.
* @details Returns the pointer to an existing SHB, without creating a
* new one. This should only be used for accessing info, not
* for creating a new file based on existing SHB info. Use
* wtap_file_get_shb_for_new_file() for that.
*
* @param wth The wiretap session.
* @param shb_num The ordinal number (0-based) of the section header
* in the file
* @return The specified existing section header, which must NOT be g_free'd.
*/
WS_DLL_PUBLIC
wtap_block_t wtap_file_get_shb(wtap *wth, unsigned shb_num);
* @brief Sets or replaces the section header comment.
* @details The passed-in comment string is set to be the comment
* for the section header block. The passed-in string's
* ownership will be owned by the block, so it should be
* duplicated before passing into this function.
*
* @param wth The wiretap session.
* @param comment The comment string.
*/
WS_DLL_PUBLIC
void wtap_write_shb_comment(wtap *wth, char *comment);
* @brief Gets the unique interface id for a SHB's interface
* @details Given an existing SHB number and an interface ID within
* that section, returns the unique ordinal number (0-based)
* of that interface over the entire wiretap session.
*
* @param wth The wiretap session.
* @param shb_num The ordinal number (0-based) of a section header
* @param interface_id An interface id within the section
* @return The unique wtap session-wide interface id for that interface
*/
WS_DLL_PUBLIC
unsigned wtap_file_get_shb_global_interface_id(wtap *wth, unsigned shb_num, uint32_t interface_id);
* @brief Gets existing interface descriptions.
* @details Returns a new struct containing a pointer to the existing
* description, without creating new descriptions internally.
* @note The returned pointer must be g_free'd, but its internal
* interface_data must not.
*
* @param wth The wiretap session.
* @return A new struct of the existing section descriptions, which must be g_free'd.
*/
WS_DLL_PUBLIC
wtapng_iface_descriptions_t *wtap_file_get_idb_info(wtap *wth);
* @brief Gets next interface description.
*
* @details This returns the first unfetched wtap_block_t from the set
* of interface descriptions. Returns NULL if there are no more
* unfetched interface descriptions; a subsequent call after
* wtap_read() returns, either with a new record or an EOF, may return
* another interface description.
*/
WS_DLL_PUBLIC
wtap_block_t wtap_get_next_interface_description(wtap *wth);
* @brief Free's a interface description block and all of its members.
*
* @details This free's all of the interface descriptions inside the passed-in
* struct, including their members (e.g., comments); and then free's the
* passed-in struct as well.
*
* @warning Do not use this for the struct returned by
* wtap_file_get_idb_info(), as that one did not create the internal
* interface descriptions; for that case you can simply g_free() the new
* struct.
*/
WS_DLL_PUBLIC
void wtap_free_idb_info(wtapng_iface_descriptions_t *idb_info);
* @brief Gets a debug string of an interface description.
* @details Returns a newly allocated string of debug information about
* the given interface descrption, useful for debugging.
* @note The returned pointer must be g_free'd.
*
* @param if_descr The interface description.
* @param indent Number of spaces to indent each line by.
* @param line_end A string to append to each line (e.g., "\n" or ", ").
* @return A newly allocated gcahr array string, which must be g_free'd.
*/
WS_DLL_PUBLIC
char *wtap_get_debug_if_descr(const wtap_block_t if_descr,
const int indent,
const char* line_end);
* @brief Gets existing name resolution block, not for new file.
* @details Returns the pointer to the existing NRB, without creating a
* new one. This should only be used for accessing info, not
* for creating a new file based on existing NRB info. Use
* wtap_file_get_nrb_for_new_file() for that.
*
* @param wth The wiretap session.
* @return The existing section header, which must NOT be g_free'd.
*
* XXX - need to be updated to handle multiple NRBs.
*/
WS_DLL_PUBLIC
wtap_block_t wtap_file_get_nrb(wtap *wth);
* @brief Gets number of decryption secrets blocks.
* @details Returns the number of existing DSBs.
*
* @param wth The wiretap session.
* @return The number of existing decryption secrets blocks.
*/
WS_DLL_PUBLIC
unsigned wtap_file_get_num_dsbs(wtap *wth);
* @brief Gets existing decryption secrets block, not for new file.
* @details Returns the pointer to an existing DSB, without creating a
* new one. This should only be used for accessing info.
*
* @param wth The wiretap session.
* @param dsb_num The ordinal number (0-based) of the decryption secrets block
* in the file
* @return The specified existing decryption secrets block, which must NOT be g_free'd.
*/
WS_DLL_PUBLIC
wtap_block_t wtap_file_get_dsb(wtap *wth, unsigned dsb_num);
* @brief Adds a Decryption Secrets Block to the open wiretap session.
* @details The passed-in DSB is added to the DSBs for the current
* session.
*
* @param wth The wiretap session.
* @param dsb The Decryption Secrets Block to add
*/
WS_DLL_PUBLIC
void wtap_file_add_decryption_secrets(wtap *wth, const wtap_block_t dsb);
* Remove any decryption secret information from the per-file information;
* used if we're stripping decryption secrets while the file is open
*
* @param wth The wiretap session from which to remove the
* decryption secrets.
* @return true if any DSBs were removed
*/
WS_DLL_PUBLIC
bool wtap_file_discard_decryption_secrets(wtap *wth);
WS_DLL_PUBLIC
void wtap_fdclose(wtap *wth);
WS_DLL_PUBLIC
bool wtap_fdreopen(wtap *wth, const char *filename, int *err);
WS_DLL_PUBLIC
void wtap_sequential_close(wtap *wth);
WS_DLL_PUBLIC
void wtap_close(wtap *wth);
WS_DLL_PUBLIC
bool wtap_dump_can_open(int filetype);
* Given a GArray of WTAP_ENCAP_ types, return the per-file encapsulation
* type that would be needed to write out a file with those types.
*/
WS_DLL_PUBLIC
int wtap_dump_required_file_encap_type(const GArray *file_encaps);
* Return true if we can write this encapsulation type in this
* capture file type/subtype, false if not.
*/
WS_DLL_PUBLIC
bool wtap_dump_can_write_encap(int file_type_subtype, int encap);
* Return true if we can write this capture file type/subtype out in
* compressed form, false if not.
*/
WS_DLL_PUBLIC
bool wtap_dump_can_compress(int file_type_subtype);
* Initialize the per-file information based on an existing file. Its
* contents must be freed according to the requirements of wtap_dump_params.
* If wth does not remain valid for the duration of the session, dsbs_growing
* MUST be cleared after this function.
*
* @param params The parameters for wtap_dump_* to initialize.
* @param wth The wiretap session.
*/
WS_DLL_PUBLIC
void wtap_dump_params_init(wtap_dump_params *params, wtap *wth);
* Initialize the per-file information based on an existing file, but
* don't copy over the interface information. Its contents must be freed
* according to the requirements of wtap_dump_params.
* If wth does not remain valid for the duration of the session, dsbs_growing
* MUST be cleared after this function.
*
* XXX - this should eventually become wtap_dump_params_init(), with all
* programs writing capture files copying IDBs over by hand, so that they
* handle IDBs in the middle of the file.
*
* @param params The parameters for wtap_dump_* to initialize.
* @param wth The wiretap session.
*/
WS_DLL_PUBLIC
void wtap_dump_params_init_no_idbs(wtap_dump_params *params, wtap *wth);
* Remove any name resolution information from the per-file information;
* used if we're stripping name resolution as we write the file.
*
* @param params The parameters for wtap_dump_* from which to remove the
* name resolution..
*/
WS_DLL_PUBLIC
void wtap_dump_params_discard_name_resolution(wtap_dump_params *params);
* Remove any decryption secret information from the per-file information;
* used if we're stripping decryption secrets as we write the file.
*
* @param params The parameters for wtap_dump_* from which to remove the
* decryption secrets..
*/
WS_DLL_PUBLIC
void wtap_dump_params_discard_decryption_secrets(wtap_dump_params *params);
* Free memory associated with the wtap_dump_params when it is no longer in
* use by wtap_dumper.
*
* @param params The parameters as initialized by wtap_dump_params_init.
*/
WS_DLL_PUBLIC
void wtap_dump_params_cleanup(wtap_dump_params *params);
* @brief Opens a new capture file for writing.
*
* @param filename The new file's name.
* @param file_type_subtype The WTAP_FILE_TYPE_SUBTYPE_XXX file type.
* @param compression_type Type of compression to use when writing, if any
* @param params The per-file information for this file.
* @param[out] err Will be set to an error code on failure.
* @param[out] err_info for some errors, a string giving more details of
* the error
* @return The newly created dumper object, or NULL on failure.
*/
WS_DLL_PUBLIC
wtap_dumper* wtap_dump_open(const char *filename, int file_type_subtype,
wtap_compression_type compression_type, const wtap_dump_params *params,
int *err, char **err_info);
* @brief Creates a dumper for a temporary file.
*
* @param tmpdir Directory in which to create the temporary file.
* @param filenamep Points to a pointer that's set to point to the
* pathname of the temporary file; it's allocated with g_malloc()
* @param pfx A string to be used as the prefix for the temporary file name
* @param file_type_subtype The WTAP_FILE_TYPE_SUBTYPE_XXX file type.
* @param compression_type Type of compression to use when writing, if any
* @param params The per-file information for this file.
* @param[out] err Will be set to an error code on failure.
* @param[out] err_info for some errors, a string giving more details of
* the error
* @return The newly created dumper object, or NULL on failure.
*/
WS_DLL_PUBLIC
wtap_dumper* wtap_dump_open_tempfile(const char *tmpdir, char **filenamep,
const char *pfx,
int file_type_subtype, wtap_compression_type compression_type,
const wtap_dump_params *params, int *err, char **err_info);
* @brief Creates a dumper for an existing file descriptor.
*
* @param fd The file descriptor for which the dumper should be created.
* @param file_type_subtype The WTAP_FILE_TYPE_SUBTYPE_XXX file type.
* @param compression_type Type of compression to use when writing, if any
* @param params The per-file information for this file.
* @param[out] err Will be set to an error code on failure.
* @param[out] err_info for some errors, a string giving more details of
* the error
* @return The newly created dumper object, or NULL on failure.
*/
WS_DLL_PUBLIC
wtap_dumper* wtap_dump_fdopen(int fd, int file_type_subtype,
wtap_compression_type compression_type, const wtap_dump_params *params,
int *err, char **err_info);
* @brief Creates a dumper for the standard output.
*
* @param file_type_subtype The WTAP_FILE_TYPE_SUBTYPE_XXX file type.
* @param compression_type Type of compression to use when writing, if any
* @param params The per-file information for this file.
* @param[out] err Will be set to an error code on failure.
* @param[out] err_info for some errors, a string giving more details of
* the error
* @return The newly created dumper object, or NULL on failure.
*/
WS_DLL_PUBLIC
wtap_dumper* wtap_dump_open_stdout(int file_type_subtype,
wtap_compression_type compression_type, const wtap_dump_params *params,
int *err, char **err_info);
* Add an IDB to the list of IDBs for a file we're writing.
* Makes a copy of the IDB, so it can be freed after this call is made.
*
* @param wdh handle for the file we're writing.
* @param idb the IDB to add
* @param[out] err Will be set to an error code on failure.
* @param[out] err_info for some errors, a string giving more details of
* the error.
* @return true on success, false on failure.
*/
WS_DLL_PUBLIC
bool wtap_dump_add_idb(wtap_dumper *wdh, wtap_block_t idb, int *err,
char **err_info);
WS_DLL_PUBLIC
bool wtap_dump(wtap_dumper *, const wtap_rec *, const uint8_t *,
int *err, char **err_info);
WS_DLL_PUBLIC
bool wtap_dump_flush(wtap_dumper *, int *);
WS_DLL_PUBLIC
int wtap_dump_file_type_subtype(wtap_dumper *wdh);
WS_DLL_PUBLIC
int64_t wtap_get_bytes_dumped(wtap_dumper *);
WS_DLL_PUBLIC
void wtap_set_bytes_dumped(wtap_dumper *wdh, int64_t bytes_dumped);
struct addrinfo;
WS_DLL_PUBLIC
bool wtap_addrinfo_list_empty(addrinfo_lists_t *addrinfo_lists);
WS_DLL_PUBLIC
bool wtap_dump_set_addrinfo_list(wtap_dumper *wdh, addrinfo_lists_t *addrinfo_lists);
WS_DLL_PUBLIC
void wtap_dump_discard_name_resolution(wtap_dumper *wdh);
WS_DLL_PUBLIC
void wtap_dump_discard_decryption_secrets(wtap_dumper *wdh);
* Closes open file handles and frees memory associated with wdh. Note that
* shb_hdr and idb_inf are not freed by this routine.
*
* @param wdh handle for the file we're closing.
* @param[out] needs_reload if not null, points to a bool that will
* be set to true if a full reload of the file would be required if
* this was done as part of a "Save" or "Save As" operation, false
* if no full reload would be required.
* @param[out] err points to an int that will be set to an error code
* on failure.
* @param[out] err_info for some errors, points to a char * that will
* be set to a string giving more details of the error.
*
* @return true on success, false on failure.
*/
WS_DLL_PUBLIC
bool wtap_dump_close(wtap_dumper *wdh, bool *needs_reload,
int *err, char **err_info);
* Return true if we can write a file out with the given GArray of file
* encapsulations and the given bitmask of comment types.
*/
WS_DLL_PUBLIC
bool wtap_dump_can_write(const GArray *file_encaps, uint32_t required_comment_types);
* Generates arbitrary packet data in "exported PDU" format
* and appends it to buf.
* For filetype readers to transform non-packetized data.
* Calls ws_buffer_asssure_space() for you and handles padding
* to 4-byte boundary.
*
* @param[in,out] buf Buffer into which to write field
* @param epdu_tag tag ID of field to create
* @param data data to be written
* @param data_len length of data
*/
WS_DLL_PUBLIC
void wtap_buffer_append_epdu_tag(Buffer *buf, uint16_t epdu_tag, const uint8_t *data, uint16_t data_len);
* Generates packet data for an unsigned integer in "exported PDU" format.
* For filetype readers to transform non-packetized data.
*
* @param[in,out] buf Buffer into which to write field
* @param epdu_tag tag ID of field to create
* @param val integer value to write to buf
*/
WS_DLL_PUBLIC
void wtap_buffer_append_epdu_uint(Buffer *buf, uint16_t epdu_tag, uint32_t val);
* Generates packet data for a string in "exported PDU" format.
* For filetype readers to transform non-packetized data.
*
* @param[in,out] buf Buffer into which to write field
* @param epdu_tag tag ID of field to create
* @param val string value to write to buf
*/
WS_DLL_PUBLIC
void wtap_buffer_append_epdu_string(Buffer *buf, uint16_t epdu_tag, const char *val);
* Close off a set of "exported PDUs" added to the buffer.
* For filetype readers to transform non-packetized data.
*
* @param[in,out] buf Buffer into which to write field
*
* @return Total length of buf populated to date
*/
WS_DLL_PUBLIC
int wtap_buffer_append_epdu_end(Buffer *buf);
* Sort the file types by name or by description?
*/
typedef enum {
FT_SORT_BY_NAME,
FT_SORT_BY_DESCRIPTION
} ft_sort_order;
* Get a GArray of file type/subtype values for file types/subtypes
* that can be used to save a file of a given type with a given GArray of
* WTAP_ENCAP_ types and the given bitmask of comment types.
*/
WS_DLL_PUBLIC
GArray *wtap_get_savable_file_types_subtypes_for_file(int file_type_subtype,
const GArray *file_encaps, uint32_t required_comment_types,
ft_sort_order sort_order);
* Get a GArray of all writable file type/subtype values.
*/
WS_DLL_PUBLIC
GArray *wtap_get_writable_file_types_subtypes(ft_sort_order sort_order);
WS_DLL_PUBLIC
const char *wtap_file_type_subtype_description(int file_type_subtype);
WS_DLL_PUBLIC
const char *wtap_file_type_subtype_name(int file_type_subtype);
WS_DLL_PUBLIC
int wtap_name_to_file_type_subtype(const char *name);
WS_DLL_PUBLIC
int wtap_pcap_file_type_subtype(void);
WS_DLL_PUBLIC
int wtap_pcap_nsec_file_type_subtype(void);
WS_DLL_PUBLIC
int wtap_pcapng_file_type_subtype(void);
* Return an indication of whether this capture file format supports
* the block in question.
*/
WS_DLL_PUBLIC
block_support_t wtap_file_type_subtype_supports_block(int file_type_subtype,
wtap_block_type_t type);
* Return an indication of whether this capture file format supports
* the option in queston for the block in question.
*/
WS_DLL_PUBLIC
option_support_t wtap_file_type_subtype_supports_option(int file_type_subtype,
wtap_block_type_t type, unsigned opttype);
* types, including compressed extensions, e.g. not just "pcap" but
* also "pcap.gz" if we can read gzipped files.
*
* "Capture files" means "include file types that correspond to
* collections of network packets, but not file types that
* store data that just happens to be transported over protocols
* such as HTTP but that aren't collections of network packets",
* so that it could be used for "All Capture Files" without picking
* up JPEG files or files such as that - those aren't capture files,
* and we *do* have them listed in the long list of individual file
* types, so omitting them from "All Capture Files" is the right
* thing to do.
*
* All strings in the list are allocated with g_malloc() and must be freed
* with g_free().
*
* This is used to generate a list of extensions to look for if the user
* chooses "All Capture Files" in a file open dialog.
*/
WS_DLL_PUBLIC
GSList *wtap_get_all_capture_file_extensions_list(void);
* we can read, including compressed extensions, e.g. not just "pcap" but
* also "pcap.gz" if we can read gzipped files.
*
* "File type" means "include file types that correspond to collections
* of network packets, as well as file types that store data that just
* happens to be transported over protocols such as HTTP but that aren't
* collections of network packets, and plain text files".
*
* All strings in the list are allocated with g_malloc() and must be freed
* with g_free().
*/
WS_DLL_PUBLIC
GSList *wtap_get_all_file_extensions_list(void);
* Free a list returned by wtap_get_file_extension_type_extensions(),
* wtap_get_all_capture_file_extensions_list, wtap_get_file_extensions_list(),
* or wtap_get_all_file_extensions_list().
*/
WS_DLL_PUBLIC
void wtap_free_extensions_list(GSList *extensions);
* Return the default file extension to use with the specified file type
* and subtype; that's just the extension, without any ".".
*/
WS_DLL_PUBLIC
const char *wtap_default_file_extension(int file_type_subtype);
* and subtype.
*
* If include_compressed is true, the list will include compressed
* extensions, e.g. not just "pcap" but also "pcap.gz" if we can read
* gzipped files.
*
* All strings in the list are allocated with g_malloc() and must be freed
* with g_free().
*/
WS_DLL_PUBLIC
GSList *wtap_get_file_extensions_list(int file_type_subtype, bool include_compressed);
WS_DLL_PUBLIC
const char *wtap_encap_name(int encap);
WS_DLL_PUBLIC
const char *wtap_encap_description(int encap);
WS_DLL_PUBLIC
int wtap_name_to_encap(const char *short_name);
WS_DLL_PUBLIC
const char* wtap_tsprec_string(int tsprec);
WS_DLL_PUBLIC
const char *wtap_strerror(int err);
WS_DLL_PUBLIC
int wtap_get_num_file_type_extensions(void);
WS_DLL_PUBLIC
int wtap_get_num_encap_types(void);
WS_DLL_PUBLIC
const char *wtap_get_file_extension_type_name(int extension_type);
WS_DLL_PUBLIC
GSList *wtap_get_file_extension_type_extensions(unsigned extension_type);
WS_DLL_PUBLIC
void wtap_register_file_type_extension(const struct file_extension_info *ei);
typedef struct {
void (*register_wtap_module)(void);
} wtap_plugin;
WS_DLL_PUBLIC
void wtap_register_plugin(const wtap_plugin *plug);
* 0 if plugins can be loaded for libwiretap (file type).
* 1 if plugins are not supported by the platform.
* -1 if plugins were disabled in the build configuration.
*/
WS_DLL_PUBLIC
int wtap_plugins_supported(void);
WS_DLL_PUBLIC
void wtap_register_open_info(struct open_info *oi, const bool first_routine);
WS_DLL_PUBLIC
bool wtap_has_open_info(const char *name);
WS_DLL_PUBLIC
bool wtap_uses_lua_filehandler(const wtap* wth);
WS_DLL_PUBLIC
void wtap_deregister_open_info(const char *name);
WS_DLL_PUBLIC
unsigned int open_info_name_to_type(const char *name);
WS_DLL_PUBLIC
int wtap_register_file_type_subtype(const struct file_type_subtype_info* fi);
WS_DLL_PUBLIC
void wtap_deregister_file_type_subtype(const int file_type_subtype);
WS_DLL_PUBLIC
int wtap_register_encap_type(const char *description, const char *name);
WS_DLL_PUBLIC
void wtap_cleanup(void);
* Wiretap error codes.
*/
#define WTAP_ERR_NOT_REGULAR_FILE -1
#define WTAP_ERR_RANDOM_OPEN_PIPE -2
#define WTAP_ERR_FILE_UNKNOWN_FORMAT -3
#define WTAP_ERR_UNSUPPORTED -4
reading that we can't support */
#define WTAP_ERR_CANT_WRITE_TO_PIPE -5
#define WTAP_ERR_CANT_OPEN -6
#define WTAP_ERR_UNWRITABLE_FILE_TYPE -7
#define WTAP_ERR_UNWRITABLE_ENCAP -8
specified encapsulation */
#define WTAP_ERR_ENCAP_PER_PACKET_UNSUPPORTED -9
#define WTAP_ERR_CANT_WRITE -10
#define WTAP_ERR_CANT_CLOSE -11
#define WTAP_ERR_SHORT_READ -12
#define WTAP_ERR_BAD_FILE -13
#define WTAP_ERR_SHORT_WRITE -14
#define WTAP_ERR_UNC_OVERFLOW -15
#define WTAP_ERR_RANDOM_OPEN_STDIN -16
#define WTAP_ERR_COMPRESSION_NOT_SUPPORTED -17
#define WTAP_ERR_CANT_SEEK -18
#define WTAP_ERR_CANT_SEEK_COMPRESSED -19
#define WTAP_ERR_DECOMPRESS -20
#define WTAP_ERR_INTERNAL -21
#define WTAP_ERR_PACKET_TOO_LARGE -22
reading, use WTAP_ERR_BAD_FILE instead */
#define WTAP_ERR_CHECK_WSLUA -23
plugin, so that the code will call wslua_can_write_encap() instead if it gets this */
#define WTAP_ERR_UNWRITABLE_REC_TYPE -24
#define WTAP_ERR_UNWRITABLE_REC_DATA -25
#define WTAP_ERR_DECOMPRESSION_NOT_SUPPORTED -26
#define WTAP_ERR_TIME_STAMP_NOT_SUPPORTED -27
file type */
#ifdef __cplusplus
}
#endif
#endif
* Editor modelines - https://www.wireshark.org/tools/modelines.html
*
* Local variables:
* c-basic-offset: 4
* tab-width: 8
* indent-tabs-mode: nil
* End:
*
* vi: set shiftwidth=4 tabstop=8 expandtab:
* :indentSize=4:tabSize=8:noTabs=true:
*/