packet-null.c

   1 /* packet-null.c
   2  * Routines for null packet disassembly
   3  *
   4  * $Id: packet-null.c,v 1.13 1999/08/22 01:48:24 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_ISO              7
  63 #define BSD_AF_APPLETALK        16
  64 #define BSD_AF_IPX              23
  65 #define BSD_AF_INET6_OPENBSD    24
  66 #define BSD_AF_INET6_FREEBSD    28
  67
  68 /* Family values. */
  69 static const value_string family_vals[] = {
  70     {BSD_AF_INET,          "IP"             },
  71     {BSD_AF_ISO,           "OSI"            },
  72     {BSD_AF_APPLETALK,     "Appletalk"      },
  73     {BSD_AF_IPX,           "Netware IPX/SPX"},
  74     {BSD_AF_INET6_OPENBSD, "IPv6"           },
  75     {BSD_AF_INET6_FREEBSD, "IPv6"           },
  76     {0,                    NULL             }
  77 };
  78
  79 void
  80 capture_null( const u_char *pd, guint32 cap_len, packet_counts *ld )
  81 {
  82   guint32 null_header;
  83
  84   /*
  85    * BSD drivers that use DLT_NULL - including the FreeBSD 3.2 ISDN-for-BSD
  86    * drivers, as well as the 4.4-Lite and FreeBSD loopback drivers -
  87    * appear to stuff the AF_ value for the protocol, in *host* byte
  88    * order, in the first four bytes.
  89    *
  90    * However, according to Gerald Combs, a FreeBSD ISDN PPP dump that
  91    * Andreas Klemm sent to ethereal-dev has a packet type of DLT_NULL,
  92    * and the family bits look like PPP's protocol field.  (Was this an
  93    * older, or different, ISDN driver?)  Looking at what appears to be
  94    * that capture file, it appears that it's using PPP in HDLC framing,
  95    * RFC 1549, wherein the first two octets of the frame are 0xFF
  96    * (address) and 0x03 (control), so the header bytes are, in order:
  97    *
  98    *    0xFF
  99    *    0x03
 100    *    high-order byte of a PPP protocol field
 101    *    low-order byte of a PPP protocol field
 102    *
 103    * when reading it on a little-endian machine; that means it's
 104    * PPPP03FF, where PPPP is a byte-swapped PPP protocol field.
 105    *
 106    * "libpcap" for Linux uses DLT_NULL only for the loopback device.
 107    * The loopback driver in Linux 2.0.36, at least, puts an *Ethernet*
 108    * header at the beginning of loopback packets; however, "libpcap"
 109    * for Linux compensates for this by skipping the source and
 110    * destination MAC addresses, replacing them with 2 bytes of 0.
 111    * This means that if we're reading the capture on a little-endian
 112    * machine, the header, treated as a 32-bit integer, looks like
 113    *
 114    *    EEEEEEEEEEEEEEEE0000000000000000
 115    *
 116    * where "EEEEEEEEEEEEEEEE" is the Ethernet type, and if we're reading
 117    * it on a big-endian machine, it looks like
 118    *
 119    *    0000000000000000EEEEEEEEEEEEEEEE
 120    *
 121    * The Ethernet type might or might not be byte-swapped; I haven't
 122    * bothered thinking about that yet.
 123    *
 124    * AF_ values are (relatively) small integers, and shouldn't have their
 125    * upper 16 bits zero; Ethernet types have to fit in 16 bits and
 126    * thus must have their upper 16 bits zero.  Therefore, if the upper
 127    * 16 bits of the field aren't zero, it's in the wrong byte order.
 128    *
 129    * Ethernet types are bigger than 1536, and AF_ values are smaller
 130    * than 1536, so we needn't worry about one being mistaken for
 131    * the other.  (There may be a problem if the 16-bit Ethernet
 132    * type is byte-swapped as a 16-bit quantity, but if when treated
 133    * as a 32-bit quantity its upper 16 bits are zero, but I'll think
 134    * about that one later.)
 135    *
 136    * As for the PPP protocol field values:
 137    *
 138    * 0x0000 does not appear to be a valid PPP protocol field value,
 139    * so the upper 16 bits will be non-zero, and we'll byte swap it.
 140    * It'll then be
 141    *
 142    *    0xFF03PPPP
 143    *
 144    * where PPPP is a non-byte-swapped PPP protocol field; we'll
 145    * check for the upper 16 bits of the byte-swapped field being
 146    * non-zero and, if so, assume the lower 16 bits are a PPP
 147    * protocol field (AF_ and Ethernet protocol fields should leave
 148    * the upper 16 bits zero - unless somebody stuff something else
 149    * there; see below).
 150    *
 151    * So, to compensate for this mess, we:
 152    *
 153    *    check if the first two octets are 0xFF and 0x03 and, if so,
 154    *    treat it as a PPP frame;
 155    *
 156    *    otherwise, byte-swap the value if its upper 16 bits aren't zero,
 157    *    and compare the lower 16 bits of the value against Ethernet
 158    *    and AF_ types.
 159    *
 160    * If, as implied by an earlier version of the "e_nullhdr" structure,
 161    * the family is only 16 bits, and there are "next" and "len" fields
 162    * before it, that all goes completely to hell.  (Note that, for
 163    * the BSD header, we could byte-swap it if the capture was written
 164    * on a machine with the opposite byte-order to ours - the "libpcap"
 165    * header lets us determine that - but it's more of a mess for Linux,
 166    * given that the effect of inserting the two 0 bytes depends only
 167    * on the byte order of the machine reading the file.)
 168    */
 169   if (pd[0] == 0xFF && pd[1] == 0x03) {
 170     /*
 171      * Hand it to PPP.
 172      */
 173     capture_ppp(pd, cap_len, ld);
 174   } else {
 175     /*
 176      * Treat it as a normal DLT_NULL header.
 177      */
 178     memcpy((char *)&null_header, (char *)&pd[0], sizeof(null_header));
 179
 180     if ((null_header & 0xFFFF0000) != 0) {
 181       /* Byte-swap it. */
 182       null_header = BSWAP32(null_header);
 183     }
 184
 185     /*
 186      * The null header value must be greater than the IEEE 802.3 maximum
 187      * frame length to be a valid Ethernet type; if it is, hand it
 188      * to "ethertype()", otherwise treat it as a BSD AF_type (we wire
 189      * in the values of the BSD AF_ types, because the values
 190      * in the file will be BSD values, and the OS on which
 191      * we're building this might not have the same values or
 192      * might not have them defined at all; XXX - what if different
 193      * BSD derivatives have different values?).
 194      */
 195     if (null_header > IEEE_802_3_MAX_LEN)
 196       capture_ethertype(null_header, 4, pd, cap_len, ld);
 197     else {
 198       switch (null_header) {
 199
 200       case BSD_AF_INET:
 201         capture_ip(pd, 4, cap_len, ld);
 202         break;
 203
 204       default:
 205         ld->other++;
 206         break;
 207       }
 208     }
 209   }
 210 }
 211
 212 void
 213 dissect_null( const u_char *pd, frame_data *fd, proto_tree *tree )
 214 {
 215   guint32     null_header;
 216   proto_tree *fh_tree;
 217   proto_item *ti;
 218
 219   /*
 220    * See comment in "capture_null()" for an explanation of what we're
 221    * doing.
 222    */
 223   if (pd[0] == 0xFF && pd[1] == 0x03) {
 224     /*
 225      * Hand it to PPP.
 226      */
 227     dissect_ppp(pd, fd, tree);
 228   } else {
 229     /*
 230      * Treat it as a normal DLT_NULL header.
 231      */
 232     memcpy((char *)&null_header, (char *)&pd[0], sizeof(null_header));
 233
 234     if ((null_header & 0xFFFF0000) != 0) {
 235       /* Byte-swap it. */
 236       null_header = BSWAP32(null_header);
 237     }
 238
 239     /* load the top pane info. This should be overwritten by
 240        the next protocol in the stack */
 241     if(check_col(fd, COL_RES_DL_SRC))
 242       col_add_str(fd, COL_RES_DL_SRC, "N/A" );
 243     if(check_col(fd, COL_RES_DL_DST))
 244       col_add_str(fd, COL_RES_DL_DST, "N/A" );
 245     if(check_col(fd, COL_PROTOCOL))
 246       col_add_str(fd, COL_PROTOCOL, "N/A" );
 247     if(check_col(fd, COL_INFO))
 248       col_add_str(fd, COL_INFO, "Null/Loopback" );
 249
 250     /*
 251      * The null header value must be greater than the IEEE 802.3 maximum
 252      * frame length to be a valid Ethernet type; if it is, hand it
 253      * to "ethertype()", otherwise treat it as a BSD AF_type (we wire
 254      * in the values of the BSD AF_ types, because the values
 255      * in the file will be BSD values, and the OS on which
 256      * we're building this might not have the same values or
 257      * might not have them defined at all; XXX - what if different
 258      * BSD derivatives have different values?).
 259      */
 260     if (null_header > IEEE_802_3_MAX_LEN) {
 261       if (tree) {
 262         ti = proto_tree_add_item(tree, proto_null, 0, 4, NULL);
 263         fh_tree = proto_item_add_subtree(ti, ETT_NULL);
 264       } else
 265         fh_tree = NULL;
 266       ethertype(null_header, 4, pd, fd, tree, fh_tree, hf_null_etype);
 267     } else {
 268       /* populate a tree in the second pane with the status of the link
 269          layer (ie none) */
 270       if (tree) {
 271         ti = proto_tree_add_item(tree, proto_null, 0, 4, NULL);
 272         fh_tree = proto_item_add_subtree(ti, ETT_NULL);
 273         proto_tree_add_item(fh_tree, hf_null_family, 0, 4, null_header);
 274       }
 275
 276       switch (null_header) {
 277
 278       case BSD_AF_INET:
 279         dissect_ip(pd, 4, fd, tree);
 280         break;
 281
 282       case BSD_AF_APPLETALK:
 283         dissect_ddp(pd, 4, fd, tree);
 284         break;
 285
 286       case BSD_AF_IPX:
 287         dissect_ipx(pd, 4, fd, tree);
 288         break;
 289
 290       case BSD_AF_ISO:
 291         dissect_osi(pd, 4, fd, tree);
 292         break;
 293
 294       case BSD_AF_INET6_OPENBSD:
 295       case BSD_AF_INET6_FREEBSD:
 296         dissect_ipv6(pd, 4, fd, tree);
 297         break;
 298
 299       default:
 300         dissect_data(pd, 4, fd, tree);
 301         break;
 302       }
 303     }
 304   }
 305 }
 306
 307 void
 308 proto_register_null(void)
 309 {
 310         static hf_register_info hf[] = {
 311
 312                 /* registered here but handled in ethertype.c */
 313                 { &hf_null_etype,
 314                 { "Type",               "null.type", FT_VALS_UINT16, VALS(etype_vals) }},
 315
 316                 { &hf_null_family,
 317                 { "Family",             "null.family",  FT_VALS_UINT32, VALS(family_vals) }}
 318         };
 319
 320         proto_null = proto_register_protocol ("Null/Loopback", "null" );
 321         proto_register_field_array(proto_null, hf, array_length(hf));
 322 }