d2c6fe1c42c5f69d6156bd5f2389626c9442f2d7
[obnox/wireshark/wip.git] / wiretap / README
1 $Id: README,v 1.20 2000/02/17 21:08:14 oabad Exp $
2
3 Wiretap is a library that is being developed as a future replacement for
4 libpcap, the current standard Unix library for packet capturing. Libpcap
5 is great in that it is very platform independent and has a wonderful
6 BPF optimizing engine. But it has some shortcomings as well. These
7 shortcomings came to a head during the development of Ethereal
8 (http://ethereal.zing.org), a packet analyzer. As such, I began developing
9 wiretap so that:
10
11 1. The library can easily be amended with new packet filtering objects.
12 Libpcap is very TCP/IP-oriented. I want to filter on IPX objects, SNA objects,
13 etc. I also want any decent programmer to be able to add new filters to the
14 library.
15
16 2. The library can read file formats from many packet-capturing utilities.
17 Libpcap only reads Libpcap files.
18
19 3. The library can capture on more than one network interface at a time, and
20 save this trace in one file.
21
22 4. Network names can be resolved immediately after a trace and saved in the
23 trace file. That way, I can ship a trace of my firewall-protected network to a
24 colleague, and he'll see the proper hostnames for the IP addresses in the
25 packet capture, even though he doesn't have access to the DNS server behind my
26 LAN's firewall.
27
28 5. I want to look into the possibility of compressing packet data when saved
29 to a file, like Sniffer.
30
31 6. The packet-filter can be optimized for the host OS. Not all OSes have BPF;
32 SunOS has NIT and Solaris has DLPI, which both use the CMU/Stanford
33 packet-filter pseudomachine. RMON has another type of packet-filter syntax
34 which we could support.
35
36 Wiretap is very good at reading many file formats, as per #2
37 above. Wiretap has no filter capability at present; it currently doesn't
38 support packet capture, so it wouldn't be useful there, and filtering
39 when reading a capture file is done by Ethereal, using a more powerful
40 filtering mechanism than that provided by BPF.
41
42
43 File Formats
44 ============
45
46 Libpcap
47 -------
48 The "libpcap" file format was determined by reading the "libpcap" code;
49 wiretap reads the "libpcap" file format with its own code, rather than
50 using the "libpcap" library's code to read it.
51
52 Sniffer (uncompressed)
53 -------
54 The Sniffer format is documented in the Sniffer manual.  Unfortunately,
55 Sniffer manuals tend to document only the format for the Sniffer model
56 they document. Token-Ring and ethernet seems to work well, though.
57 If you have an ATM Sniffer file, both Guy and Gilbert would be *very*
58 interested in receiving a sample. (see 'AUTHORS' file for our e-mail
59 addresses).
60
61 LANalyzer
62 ---------
63 The LANalyzer format is available from http://www.novell.com. Search
64 their knowledge base for "Trace File Format".
65
66 Network Monitor
67 ---------------
68 Microsoft's Network Monitor file format is supported, at least under
69 Ethernet and token-ring. If you have capture files of other datalink
70 types, please send them to Guy.
71
72 "snoop"
73 -------
74 The Solaris 2.x "snoop" program's format is documented in RFC 1761.
75
76 "iptrace"
77 ---------
78 This is the capture program that comes with AIX 3.x and 4.x.  AIX 3 uses
79 the iptrace 1.0 file format, while AIX4 uses iptrace 2.0.  iptrace has
80 an undocumented, yet very simple, file format.  The interesting thing
81 about iptrace is that it will record packets coming in from all network
82 interfaces; a single iptrace file can contain multiple datalink types.
83
84 Sniffer Basic (NetXRay)/Windows Sniffer Pro
85 -------------------------------------------
86 Network Associates' Sniffer Basic (formerly NetXRay from Cinco Networks)
87 file format is now supported, at least for Ethernet and token-ring. 
88 Network Associates' Windows Sniffer Pro appears to use a variant of that
89 format; it's supported to the same extent.
90
91 RADCOM WAN/LAN Analyzers
92 ------------------------
93 Olivier Abad has added code to read Ethernet and LAPB captures from
94 RADCOM WAN/LAN Analyzers (see http://www.radcom-inc.com/).
95
96 Lucent/Ascend access products
97 -----------------------------
98 Gerald
99
100 HP-UX nettl
101 -----------
102 nettl is used on HP-UX to trace various streams based subsystems.  Wiretap
103 can read nettl files containing IP frames (NS_LS_IP subsystem) and LAPB
104 frames (SX25L2 subsystem). It has been tested with files generated on
105 HP-UX 9.04 and 10.20.
106 Use the following commands to generate a trace :
107 # IP capture. 0x30000000 means PDU in and PDU out :
108 nettl -tn 0x30000000 -e NS_LS_IP -f tracefile
109 # X25 capture. You must specify an interface :
110 nettl -tn 0x30000000 -e SX25l2 -d /dev/x25_0 -f tracefile
111 # stop capture. subsystem is NS_LS_IP or SX25L2 :
112 nettl -tf -e subsystem
113
114 Toshiba ISDN Router
115 -------------------
116 An under-documented command that the router supports in a telnet session
117 is "snoop" (not related to the Solaris "snoop" command). If you give it
118 the "dump" option, you'll get a hex dump of all packets across the router
119 (except of your own telnet session -- good thinking Toshiba!). You can
120 select a certain channel to sniff (LAN, B1, B2, D), but the default is all
121 channels.  You save this hex dump to disk with 'script' or by 'telnet |
122 tee'. Wiretap will read the ASCII hex dump and convert it to binary data.
123
124 Gilbert Ramirez <gram@xiexie.org>
125 Guy Harris <guy@alum.mit.edu>