DLT_NULL, from "libpcap", means different things on different platforms
[obnox/wireshark/wip.git] / packet-null.c
1 /* packet-null.c
2  * Routines for null packet disassembly
3  *
4  * $Id: packet-null.c,v 1.12 1999/08/22 00:47:42 guy Exp $
5  *
6  * Ethereal - Network traffic analyzer
7  * By Gerald Combs <gerald@zing.org>
8  *
9  * This file created and by Mike Hall <mlh@io.com>
10  * Copyright 1998
11  * 
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License
14  * as published by the Free Software Foundation; either version 2
15  * of the License, or (at your option) any later version.
16  * 
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  * 
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25  */
26
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #ifdef HAVE_SYS_TYPES_H
32 #include <sys/types.h>
33 #endif
34
35 #include <glib.h>
36
37 #ifdef HAVE_SYS_SOCKET_H
38 #include <sys/socket.h>
39 #endif
40
41 #include "packet.h"
42 #include "etypes.h"
43         
44 extern const value_string etype_vals[];
45
46 /* protocols and header fields */
47 static int proto_null = -1;
48 static int hf_null_etype = -1;
49 static int hf_null_family = -1;
50
51 /* Null/loopback structs and definitions */
52
53 /* Macro to byte-swap 32-bit quantities. */
54 #define BSWAP32(x) \
55         ((((x)&0xFF000000)>>24) | \
56          (((x)&0x00FF0000)>>8) | \
57          (((x)&0x0000FF00)<<8) | \
58          (((x)&0x000000FF)<<24))
59
60 /* BSD AF_ values. */
61 #define BSD_AF_INET             2
62 #define BSD_AF_APPLETALK        16
63 #define BSD_AF_IPX              23      /* at least on FreeBSD */
64 #define BSD_AF_INET6            28      /* at least on FreeBSD */
65
66 /* Family values. */
67 static const value_string family_vals[] = {
68     {BSD_AF_INET,      "IP"             },
69     {BSD_AF_APPLETALK, "Appletalk"      },
70     {BSD_AF_IPX,       "Netware IPX/SPX"},
71     {BSD_AF_INET6,     "IPv6"           },
72     {0,                NULL             }
73 };
74
75 void
76 capture_null( const u_char *pd, guint32 cap_len, packet_counts *ld )
77 {
78   guint32 null_header;
79
80   /*
81    * BSD drivers that use DLT_NULL - including the FreeBSD 3.2 ISDN-for-BSD
82    * drivers, as well as the 4.4-Lite and FreeBSD loopback drivers -
83    * appear to stuff the AF_ value for the protocol, in *host* byte
84    * order, in the first four bytes.
85    *
86    * However, according to Gerald Combs, a FreeBSD ISDN PPP dump that
87    * Andreas Klemm sent to ethereal-dev has a packet type of DLT_NULL,
88    * and the family bits look like PPP's protocol field.  (Was this an
89    * older, or different, ISDN driver?)  Looking at what appears to be
90    * that capture file, it appears that it's using PPP in HDLC framing,
91    * RFC 1549, wherein the first two octets of the frame are 0xFF
92    * (address) and 0x03 (control), so the header bytes are, in order:
93    *
94    *    0xFF
95    *    0x03
96    *    high-order byte of a PPP protocol field
97    *    low-order byte of a PPP protocol field
98    *
99    * when reading it on a little-endian machine; that means it's
100    * PPPP03FF, where PPPP is a byte-swapped PPP protocol field.
101    *
102    * "libpcap" for Linux uses DLT_NULL only for the loopback device.
103    * The loopback driver in Linux 2.0.36, at least, puts an *Ethernet*
104    * header at the beginning of loopback packets; however, "libpcap"
105    * for Linux compensates for this by skipping the source and
106    * destination MAC addresses, replacing them with 2 bytes of 0.
107    * This means that if we're reading the capture on a little-endian
108    * machine, the header, treated as a 32-bit integer, looks like
109    *
110    *    EEEEEEEEEEEEEEEE0000000000000000
111    *
112    * where "EEEEEEEEEEEEEEEE" is the Ethernet type, and if we're reading
113    * it on a big-endian machine, it looks like
114    *
115    *    0000000000000000EEEEEEEEEEEEEEEE
116    *
117    * The Ethernet type might or might not be byte-swapped; I haven't
118    * bothered thinking about that yet.
119    *
120    * AF_ values are (relatively) small integers, and shouldn't have their
121    * upper 16 bits zero; Ethernet types have to fit in 16 bits and
122    * thus must have their upper 16 bits zero.  Therefore, if the upper
123    * 16 bits of the field aren't zero, it's in the wrong byte order.
124    *
125    * Ethernet types are bigger than 1536, and AF_ values are smaller
126    * than 1536, so we needn't worry about one being mistaken for
127    * the other.  (There may be a problem if the 16-bit Ethernet
128    * type is byte-swapped as a 16-bit quantity, but if when treated
129    * as a 32-bit quantity its upper 16 bits are zero, but I'll think
130    * about that one later.)
131    *
132    * As for the PPP protocol field values:
133    *
134    * 0x0000 does not appear to be a valid PPP protocol field value,
135    * so the upper 16 bits will be non-zero, and we'll byte swap it.
136    * It'll then be
137    *
138    *    0xFF03PPPP
139    *
140    * where PPPP is a non-byte-swapped PPP protocol field; we'll
141    * check for the upper 16 bits of the byte-swapped field being
142    * non-zero and, if so, assume the lower 16 bits are a PPP
143    * protocol field (AF_ and Ethernet protocol fields should leave
144    * the upper 16 bits zero - unless somebody stuff something else
145    * there; see below).
146    *
147    * So, to compensate for this mess, we:
148    *
149    *    check if the first two octets are 0xFF and 0x03 and, if so,
150    *    treat it as a PPP frame;
151    *
152    *    otherwise, byte-swap the value if its upper 16 bits aren't zero,
153    *    and compare the lower 16 bits of the value against Ethernet
154    *    and AF_ types.
155    *
156    * If, as implied by an earlier version of the "e_nullhdr" structure,
157    * the family is only 16 bits, and there are "next" and "len" fields
158    * before it, that all goes completely to hell.  (Note that, for
159    * the BSD header, we could byte-swap it if the capture was written
160    * on a machine with the opposite byte-order to ours - the "libpcap"
161    * header lets us determine that - but it's more of a mess for Linux,
162    * given that the effect of inserting the two 0 bytes depends only
163    * on the byte order of the machine reading the file.)
164    */
165   if (pd[0] == 0xFF && pd[1] == 0x03) {
166     /*
167      * Hand it to PPP.
168      */
169     capture_ppp(pd, cap_len, ld);
170   } else {
171     /*
172      * Treat it as a normal DLT_NULL header.
173      */
174     memcpy((char *)&null_header, (char *)&pd[0], sizeof(null_header));
175
176     if ((null_header & 0xFFFF0000) != 0) {
177       /* Byte-swap it. */
178       null_header = BSWAP32(null_header);
179     }
180
181     /*
182      * The null header value must be greater than the IEEE 802.3 maximum
183      * frame length to be a valid Ethernet type; if it is, hand it
184      * to "ethertype()", otherwise treat it as a BSD AF_type (we wire
185      * in the values of the BSD AF_ types, because the values
186      * in the file will be BSD values, and the OS on which
187      * we're building this might not have the same values or
188      * might not have them defined at all; XXX - what if different
189      * BSD derivatives have different values?).
190      */
191     if (null_header > IEEE_802_3_MAX_LEN)
192       capture_ethertype(null_header, 4, pd, cap_len, ld);
193     else {
194       switch (null_header) {
195
196       case BSD_AF_INET:
197         capture_ip(pd, 4, cap_len, ld);
198         break;
199
200       default:
201         ld->other++;
202         break;
203       }
204     }
205   }
206 }
207
208 void
209 dissect_null( const u_char *pd, frame_data *fd, proto_tree *tree )
210 {
211   guint32     null_header;
212   proto_tree *fh_tree;
213   proto_item *ti;
214
215   /*
216    * See comment in "capture_null()" for an explanation of what we're
217    * doing.
218    */
219   if (pd[0] == 0xFF && pd[1] == 0x03) {
220     /*
221      * Hand it to PPP.
222      */
223     dissect_ppp(pd, fd, tree);
224   } else {
225     /*
226      * Treat it as a normal DLT_NULL header.
227      */
228     memcpy((char *)&null_header, (char *)&pd[0], sizeof(null_header));
229
230     if ((null_header & 0xFFFF0000) != 0) {
231       /* Byte-swap it. */
232       null_header = BSWAP32(null_header);
233     }
234
235     /* load the top pane info. This should be overwritten by
236        the next protocol in the stack */
237     if(check_col(fd, COL_RES_DL_SRC))
238       col_add_str(fd, COL_RES_DL_SRC, "N/A" );
239     if(check_col(fd, COL_RES_DL_DST))
240       col_add_str(fd, COL_RES_DL_DST, "N/A" );
241     if(check_col(fd, COL_PROTOCOL))
242       col_add_str(fd, COL_PROTOCOL, "N/A" );
243     if(check_col(fd, COL_INFO))
244       col_add_str(fd, COL_INFO, "Null/Loopback" );
245
246     /*
247      * The null header value must be greater than the IEEE 802.3 maximum
248      * frame length to be a valid Ethernet type; if it is, hand it
249      * to "ethertype()", otherwise treat it as a BSD AF_type (we wire
250      * in the values of the BSD AF_ types, because the values
251      * in the file will be BSD values, and the OS on which
252      * we're building this might not have the same values or
253      * might not have them defined at all; XXX - what if different
254      * BSD derivatives have different values?).
255      */
256     if (null_header > IEEE_802_3_MAX_LEN) {
257       if (tree) {
258         ti = proto_tree_add_item(tree, proto_null, 0, 4, NULL);
259         fh_tree = proto_item_add_subtree(ti, ETT_NULL);
260       } else
261         fh_tree = NULL;
262       ethertype(null_header, 4, pd, fd, tree, fh_tree, hf_null_etype);
263     } else {
264       /* populate a tree in the second pane with the status of the link
265          layer (ie none) */
266       if (tree) {
267         ti = proto_tree_add_item(tree, proto_null, 0, 4, NULL);
268         fh_tree = proto_item_add_subtree(ti, ETT_NULL);
269         proto_tree_add_item(fh_tree, hf_null_family, 0, 4, null_header);
270       }
271
272       switch (null_header) {
273
274       case BSD_AF_INET:
275         dissect_ip(pd, 4, fd, tree);
276         break;
277
278       case BSD_AF_APPLETALK:
279         dissect_ddp(pd, 4, fd, tree);
280         break;
281
282       case BSD_AF_IPX:
283         dissect_ipx(pd, 4, fd, tree);
284         break;
285
286       case BSD_AF_INET6:
287         dissect_ipv6(pd, 4, fd, tree);
288         break;
289
290       default:
291         dissect_data(pd, 4, fd, tree);
292         break;
293       }
294     }
295   }
296 }
297
298 void
299 proto_register_null(void)
300 {
301         static hf_register_info hf[] = {
302
303                 /* registered here but handled in ethertype.c */
304                 { &hf_null_etype,
305                 { "Type",               "null.type", FT_VALS_UINT16, VALS(etype_vals) }},
306
307                 { &hf_null_family,
308                 { "Family",             "null.family",  FT_VALS_UINT32, VALS(family_vals) }}
309         };
310
311         proto_null = proto_register_protocol ("Null/Loopback", "null" );
312         proto_register_field_array(proto_null, hf, array_length(hf));
313 }