wireshark/wiretap
Guy Harris 4e80643cc0 Move LINKTYPE_WIRESHARK_UPPER_PDU definitions to a separate header.
Have wsutil/exported_pdu_tlvs.h define the LINKTYPE_WIRESHARK_UPPER_PDU
TLV type and length values, as well as the port type values written to
files in EXP_PDU_TAG_PORT_TYPE TLVs.

Update the comment that describes the LINKTYPE_WIRESHARK_UPPER_PDU TLVs
to more completely and correctly reflect reality (it was moved from
epan/exported_pdu.h to wsutil/exported_pdu_tlvs.h).

Rename those port type values from OLD_PT_ to EXP_PDU_PT_; there is
nothing "old" about them - yes, they originally had the same numerical
values as the PT_ enum values in libwireshark, but that's no longer the
case, and the two are now defined independently.  Rename routines that
map between libwireshark PT_ values and EXP_PDU_PT_ values to remove
"old" from the name while we're at it.

Don't include epan/exported_pdu.h if we only need the
LINKTYPE_WIRESHARK_UPPER_PDU definitions - just include
wsutil/exported_pdu_tlvs.h.

In extcap/udpdump.c, include wsutil/exported_pdu_tlvs.h rather than
defining the TLV types ourselves.
2021-08-20 02:18:19 -07:00
..
.editorconfig Miscellaneous EditorConfig fixes 2021-03-02 19:13:54 +00:00
5views.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
5views.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
CMakeLists.txt CMake: Remove unneeded GLIB2_LIBRARIES. 2021-07-21 10:05:21 +00:00
README HTTPS In Even More Places, update some links. 2019-07-28 04:21:18 +00:00
README.airmagnet Fix many spelling errors 2020-10-11 08:35:55 +00:00
README.developer
aethra.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
aethra.h
ascend-int.h wiretap: Convert ascend.y to Lemon. 2020-11-30 08:15:43 +00:00
ascend_parser.lemon Replace some lingering references to g_log() 2021-06-19 02:34:36 +00:00
ascend_scanner.l Cast away the return value of g_strlcpy() and g_strlcat(). 2021-04-30 03:19:19 -07:00
ascendtext.c ascend: set rec->rec_type. 2021-05-31 02:44:57 -07:00
ascendtext.h
atm.c HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
atm.h
ber.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
ber.h
blf.c wiretap: Fix some BLF warnings. 2021-08-04 09:51:05 -07:00
blf.h BLF: Support for BLF file format 2021-07-16 07:37:43 +00:00
btsnoop.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
btsnoop.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
busmaster.c Move LINKTYPE_WIRESHARK_UPPER_PDU definitions to a separate header. 2021-08-20 02:18:19 -07:00
busmaster.h wiretap: Add support for Busmaster log file format 2019-08-03 15:46:08 +00:00
busmaster_parser.lemon can: more specific dissector tables for CAN IDs and extended IDs 2021-07-15 07:29:46 +00:00
busmaster_priv.h can: more specific dissector tables for CAN IDs and extended IDs 2021-07-15 07:29:46 +00:00
busmaster_scanner.l wiretap: Add support for Busmaster log file format 2019-08-03 15:46:08 +00:00
camins.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
camins.h
candump.c Move LINKTYPE_WIRESHARK_UPPER_PDU definitions to a separate header. 2021-08-20 02:18:19 -07:00
candump.h wiretap: Add support of candump logs 2019-07-11 04:44:00 +00:00
candump_parser.lemon "config.h" need not and should not be included in any header 2021-06-25 23:53:53 +01:00
candump_priv.h Add ws_debug() and use it 2021-05-24 01:13:19 +00:00
candump_scanner.l wiretap: candump: Don't generate a temporary PCAP file 2019-07-20 07:29:33 +00:00
capsa.c Replace g_assert() with ws_assert() in places 2021-06-06 20:05:26 +00:00
capsa.h
catapult_dct2000.c DT2000: Fix buffer length in wiretap code 2021-06-25 09:44:35 +01:00
catapult_dct2000.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
commview.c commview: add support for newer NCFX file format. 2021-05-11 07:40:51 +00:00
commview.h commview: add support for newer NCFX file format. 2021-05-11 07:40:51 +00:00
cosine.c Cast away the return value of g_strlcpy() and g_strlcat(). 2021-04-30 03:19:19 -07:00
cosine.h
csids.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
csids.h
daintree-sna.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
daintree-sna.h
dbs-etherwatch.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
dbs-etherwatch.h
dct3trace.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
dct3trace.h
dpa400.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
dpa400.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
erf-common.h erf: handle errors in some routines more completely. 2021-06-18 16:22:54 -07:00
erf.c erf: Fix Dead Store (found by Clang Anlyzer) 2021-07-30 20:43:55 +00:00
erf.h wiretap: eliminate the pcap/nspcap/pcapng WTAP_FILE_TYPE_SUBTYPE_ values. 2021-02-23 21:56:20 +00:00
erf_record.h ERF: split wiretap/erf.h into three files. 2020-05-02 04:24:08 +00:00
eyesdn.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
eyesdn.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
file_access.c BLF: Support for BLF file format 2021-07-16 07:37:43 +00:00
file_wrappers.c Replace g_assert() with ws_assert() in places 2021-06-06 20:05:26 +00:00
file_wrappers.h
hcidump.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
hcidump.h
i4b_trace.h Strengthen the I4B heuristics. 2019-09-02 21:40:09 +00:00
i4btrace.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
i4btrace.h
ipfix.c Refactor our logging and extend the wslog API 2021-06-11 09:40:28 +00:00
ipfix.h
iptrace.c wiretap: iptrace/Sniffer/Peek classic always have packet flags. 2021-07-14 00:31:03 +00:00
iptrace.h
iseries.c Replace g_assert() with ws_assert() in places 2021-06-06 20:05:26 +00:00
iseries.h
json.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
json.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
k12.c Wiretap: Fix a resource leak 2021-06-09 17:09:44 +00:00
k12.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
k12text.l wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
lanalyzer.c Replace g_log() calls with ws_log() 2021-06-16 12:50:27 +00:00
lanalyzer.h wiretap: eliminate the pcap/nspcap/pcapng WTAP_FILE_TYPE_SUBTYPE_ values. 2021-02-23 21:56:20 +00:00
libpcap.c erf: handle errors in some routines more completely. 2021-06-18 16:22:54 -07:00
libpcap.h wiretap: eliminate the pcap/nspcap/pcapng WTAP_FILE_TYPE_SUBTYPE_ values. 2021-02-23 21:56:20 +00:00
log3gpp.c Replace g_log() calls with ws_log() 2021-06-16 12:50:27 +00:00
log3gpp.h wiretap: Add a phone log reader. 2019-07-08 11:41:05 +00:00
logcat.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
logcat.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
logcat_text.c Cast away the return value of g_strlcpy() and g_strlcat(). 2021-04-30 03:19:19 -07:00
logcat_text.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
merge.c [#17478] free blocks in more places 2021-08-10 00:08:15 +00:00
merge.h Have wtap_read() fill in a wtap_rec and Buffer. 2019-04-05 02:49:43 +00:00
mime_file.c BLF: Support for BLF file format 2021-07-16 07:37:43 +00:00
mime_file.h
mp2t.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
mp2t.h
mp4.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
mp4.h wiretap: Add MP4 reader 2020-01-14 20:04:01 +00:00
mpeg.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
mpeg.h
mplog.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
mplog.h
netmon.c netmon: fill in all of the 802.11 pseudo-header in the dissector. 2021-04-02 07:46:32 +00:00
netmon.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
netscaler.c Replace g_assert() with ws_assert() in places 2021-06-06 20:05:26 +00:00
netscaler.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
netscreen.c Cast away the return value of g_strlcpy() and g_strlcat(). 2021-04-30 03:19:19 -07:00
netscreen.h
nettl.c Cast away the return value of g_strlcpy() and g_strlcat(). 2021-04-30 03:19:19 -07:00
nettl.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
nettrace_3gpp_32_423.c Move LINKTYPE_WIRESHARK_UPPER_PDU definitions to a separate header. 2021-08-20 02:18:19 -07:00
nettrace_3gpp_32_423.h
netxray.c Wiretap: Fix some compiler warnings. 2021-04-16 20:09:42 +00:00
netxray.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
ngsniffer.c wiretap: iptrace/Sniffer/Peek classic always have packet flags. 2021-07-14 00:31:03 +00:00
ngsniffer.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
observer.c Cast away the return value of g_strlcpy() and g_strlcat(). 2021-04-30 03:19:19 -07:00
observer.h observer: rename source and update name. 2021-03-11 16:01:27 -08:00
packetlogger.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
packetlogger.h
pcap-common.c nordic_ble: Update display name of nordic_ble dissector 2021-06-28 11:52:14 +00:00
pcap-common.h wiretap: eliminate the pcap/nspcap/pcapng WTAP_FILE_TYPE_SUBTYPE_ values. 2021-02-23 21:56:20 +00:00
pcap-encap.h libwiretap: make wtap_wtap_encap_to_pcap_encap() private to the library. 2021-03-14 14:22:16 -07:00
pcapng.c Carry drop count/packet ID/queue ID as options on packet block 2021-07-19 21:25:40 +00:00
pcapng.h wiretap: eliminate the pcap/nspcap/pcapng WTAP_FILE_TYPE_SUBTYPE_ values. 2021-02-23 21:56:20 +00:00
pcapng_module.h Make various names match the name of the systemd journal export block. 2021-06-17 13:52:45 -07:00
peekclassic.c wiretap: iptrace/Sniffer/Peek classic always have packet flags. 2021-07-14 00:31:03 +00:00
peekclassic.h
peektagged.c Carry EPB flags as an option on the packet block 2021-07-12 12:41:57 -04:00
peektagged.h
pppdump.c Replace g_assert() with ws_assert() in places 2021-06-06 20:05:26 +00:00
pppdump.h
radcom.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
radcom.h
required_file_handlers.h wiretap: eliminate the pcap/nspcap/pcapng WTAP_FILE_TYPE_SUBTYPE_ values. 2021-02-23 21:56:20 +00:00
rfc7468.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
rfc7468.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
ruby_marshal.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
ruby_marshal.h HTTPS (almost) everywhere. 2019-07-26 18:44:40 +00:00
secrets-types.h wiretap: add the ZigBee secret types. 2021-07-01 11:09:36 +00:00
snoop.c wsutil: add a header that defines some "round to power of 2" macros. 2021-06-16 02:01:23 -07:00
snoop.h wiretap: eliminate the pcap/nspcap/pcapng WTAP_FILE_TYPE_SUBTYPE_ values. 2021-02-23 21:56:20 +00:00
socketcan.h wiretap: Add support for Busmaster log file format 2019-08-03 15:46:08 +00:00
stanag4607.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
stanag4607.h
systemd_journal.c Make various names match the name of the systemd journal export block. 2021-06-17 13:52:45 -07:00
systemd_journal.h
tnef.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
tnef.h
toshiba.c wiretap: rename wtap_register_file_type_subtypes(). 2021-02-23 20:39:16 -08:00
toshiba.h
visual.c Cast away the return value of g_strlcpy() and g_strlcat(). 2021-04-30 03:19:19 -07:00
visual.h wiretap: register most built-in file types from its module. 2021-02-14 00:58:46 -08:00
vms.c Cast away the return value of g_strlcpy() and g_strlcat(). 2021-04-30 03:19:19 -07:00
vms.h
vwr.c Replace g_assert() with ws_assert() in places 2021-06-06 20:05:26 +00:00
vwr.h
wtap-int.h wiretap: un-export some routines. 2021-05-31 04:39:59 -07:00
wtap.c [#17478] free blocks in more places 2021-08-10 00:08:15 +00:00
wtap.h [#17478] free blocks in more places 2021-08-10 00:08:15 +00:00
wtap_modules.h Move even more headers outside extern "C". 2021-03-16 04:33:00 -07:00
wtap_opttypes.c Carry drop count/packet ID/queue ID as options on packet block 2021-07-19 21:25:40 +00:00
wtap_opttypes.h Fix header documentation and style 2021-08-04 06:00:28 +00:00

README

NOTE: this documents the original intent behind libwiretap.  Currently,
it is being developed solely as a library for reading capture files,
rather than packet capture.  The list of file formats is also
out-of-date.

Wiretap is a library that is being developed as a future replacement for
libpcap, the current standard Unix library for packet capturing. Libpcap
is great in that it is very platform independent and has a wonderful
BPF optimizing engine. But it has some shortcomings as well. These
shortcomings came to a head during the development of Wireshark
(https://www.wireshark.org/), a packet analyzer. As such, I began developing
wiretap so that:

1. The library can easily be amended with new packet filtering objects.
Libpcap is very TCP/IP-oriented. I want to filter on IPX objects, SNA objects,
etc. I also want any decent programmer to be able to add new filters to the
library.

2. The library can read file formats from many packet-capturing utilities.
Libpcap only reads Libpcap files.

3. The library can capture on more than one network interface at a time, and
save this trace in one file.

4. Network names can be resolved immediately after a trace and saved in the
trace file. That way, I can ship a trace of my firewall-protected network to a
colleague, and he'll see the proper hostnames for the IP addresses in the
packet capture, even though he doesn't have access to the DNS server behind my
LAN's firewall.

5. I want to look into the possibility of compressing packet data when saved
to a file, like Sniffer.

6. The packet-filter can be optimized for the host OS. Not all OSes have BPF;
SunOS has NIT and Solaris has DLPI, which both use the CMU/Stanford
packet-filter pseudomachine. RMON has another type of packet-filter syntax
which we could support.

Wiretap is very good at reading many file formats, as per #2
above. Wiretap has no filter capability at present; it currently doesn't
support packet capture, so it wouldn't be useful there, and filtering
when reading a capture file is done by Wireshark, using a more powerful
filtering mechanism than that provided by BPF.


File Formats
============

Libpcap
-------
The "libpcap" file format was determined by reading the "libpcap" code;
wiretap reads the "libpcap" file format with its own code, rather than
using the "libpcap" library's code to read it.

Sniffer (compressed and uncompressed)
-------
The uncompressed Sniffer format is documented in the Sniffer manual.
Unfortunately, Sniffer manuals tend to document only the format for
the Sniffer model they document. Token-Ring and ethernet seems to work
well, though.  If you have an ATM Sniffer file, both Guy and Gilbert
would be *very* interested in receiving a sample. (see 'AUTHORS' file
for our e-mail addresses).

LANalyzer
---------
The LANalyzer format is available from http://www.novell.com. Search
their knowledge base for "Trace File Format".

Network Monitor
---------------
Microsoft's Network Monitor file format is supported, at least under
Ethernet and token-ring. If you have capture files of other datalink
types, please send them to Guy.

"snoop"
-------
The Solaris 2.x "snoop" program's format is documented in RFC 1761.

"iptrace"
---------
This is the capture program that comes with AIX 3.x and 4.x.  AIX 3 uses
the iptrace 1.0 file format, while AIX4 uses iptrace 2.0.  iptrace has
an undocumented, yet very simple, file format.  The interesting thing
about iptrace is that it will record packets coming in from all network
interfaces; a single iptrace file can contain multiple datalink types.

Sniffer Basic (NetXRay)/Windows Sniffer Pro
-------------------------------------------
Network Associates' Sniffer Basic (formerly NetXRay from Cinco Networks)
file format is now supported, at least for Ethernet and token-ring. 
Network Associates' Windows Sniffer Pro appears to use a variant of that
format; it's supported to the same extent.

RADCOM WAN/LAN Analyzers
------------------------
Olivier Abad has added code to read Ethernet and LAPB captures from
RADCOM WAN/LAN Analyzers (see https://web.archive.org/web/20031231213434/http://www.radcom-inc.com/).

Lucent/Ascend access products
-----------------------------
Gerald

HP-UX nettl
-----------
nettl is used on HP-UX to trace various streams based subsystems.  Wiretap
can read nettl files containing IP frames (NS_LS_IP subsystem) and LAPB
frames (SX25L2 subsystem). It has been tested with files generated on
HP-UX 9.04 and 10.20.
Use the following commands to generate a trace :
# IP capture. 0x30000000 means PDU in and PDU out :
nettl -tn 0x30000000 -e NS_LS_IP -f tracefile
# X25 capture. You must specify an interface :
nettl -tn 0x30000000 -e SX25l2 -d /dev/x25_0 -f tracefile
# stop capture. subsystem is NS_LS_IP or SX25L2 :
nettl -tf -e subsystem

One may be able to specify "-tn pduin pduout" rather than
"-tn 0x30000000"; the nettl man page for HP-UX 10.30 implies that it
should work.

There is also basic support for nettl files containing NS_LS_DRIVER, 
NS_LS_TCP, NS_LS_UDP, NS_LS_LOOPBACK, unknown type 0xb9, and NS_LS_ICMP.
However, NS_LS_ICMP will not be decoded since WTAP lacks a raw ICMP 
encapsulation type.


Toshiba ISDN Router
-------------------
An under-documented command that the router supports in a telnet session
is "snoop" (not related to the Solaris "snoop" command). If you give
it the "dump" option (either by letting "snoop" query you for its next
argument, or typing "snoop dump" on the command line), you'll get a hex
dump of all packets across the router (except of your own telnet session
-- good thinking Toshiba!). You can select a certain channel to sniff
(LAN, B1, B2, D), but the default is all channels.  You save this hex
dump to disk with 'script' or by 'telnet | tee'. Wiretap will read the
ASCII hex dump and convert it to binary data.

ISDN4BSD "i4btrace" utility
---------------------------
Bert Driehuis

Cisco Secure Intrusion Detection System iplogging facility
-----------------------------------------------------------
Mike Hall

pppd logs (pppdump-format files)
--------------------------------
Gilbert

VMS TCPTRACE
------------
Compaq VMS's TCPIPTRACE format is supported.  This is the capture program
that comes with TCP/IP or UCX as supplied by Compaq or Digital Equipment
Corporation.

Under UCX 4.x, it is invoked as TCPIPTRACE.  Under TCPIP 5.x, it is invoked
as TCPTRACE.

TCPTRACE produces an ascii text based format, that has changed slightly over
time.

DBS Etherwatch (text format)
----------------------------
Text output from DBS Etherwatch is supported.  DBS Etherwatch is available
from: https://web.archive.org/web/20070612033348/http://www.users.bigpond.com/dbsneddon/software.htm.

Catapult DCT2000 (.out files)
-----------------------------
DCT2000 test systems produce ascii text-based .out files for ports
that have logging enabled. When being read, the data part of the message is
prefixed with a short header that provides some context (context+port,
direction, original timestamp, etc).

You can choose to suppress the reading of non-standard protocols
(i.e. messages between layers rather than the well-known link-level protocols
usually found on board ports).


Gilbert Ramirez <gram@alumni.rice.edu>
Guy Harris <guy@alum.mit.edu>

STANAG 4607
-----------
Initial support for the STANAG 4607 protocol.  Documentation at:
https://web.archive.org/web/20130223054955/http://www.nato.int/structur/AC/224/standard/4607/4607.htm