packet-null.c

   1 /* packet-null.c
   2  * Routines for null packet disassembly
   3  *
   4  * $Id: packet-null.c,v 1.37 2001/01/03 06:55:30 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 <string.h>
  42 #include "packet.h"
  43 #include "packet-null.h"
  44 #include "packet-atalk.h"
  45 #include "packet-ip.h"
  46 #include "packet-ipv6.h"
  47 #include "packet-ipx.h"
  48 #include "packet-osi.h"
  49 #include "packet-ppp.h"
  50 #include "etypes.h"
  51 #include "aftypes.h"
  52
  53 static dissector_table_t null_dissector_table;
  54
  55 extern const value_string etype_vals[];
  56
  57 /* protocols and header fields */
  58 static int proto_null = -1;
  59 static int hf_null_etype = -1;
  60 static int hf_null_family = -1;
  61
  62 static gint ett_null = -1;
  63
  64 /* Null/loopback structs and definitions */
  65
  66 /* Family values. */
  67 static const value_string family_vals[] = {
  68     {BSD_AF_INET,          "IP"             },
  69     {BSD_AF_ISO,           "OSI"            },
  70     {BSD_AF_APPLETALK,     "Appletalk"      },
  71     {BSD_AF_IPX,           "Netware IPX/SPX"},
  72     {BSD_AF_INET6_BSD,     "IPv6"           },
  73     {BSD_AF_INET6_FREEBSD, "IPv6"           },
  74     {0,                    NULL             }
  75 };
  76
  77 static dissector_handle_t ppp_handle;
  78
  79 void
  80 capture_null( const u_char *pd, 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, 0, 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, ld);
 197     else {
 198       switch (null_header) {
 199
 200       case BSD_AF_INET:
 201         capture_ip(pd, 4, ld);
 202         break;
 203
 204       default:
 205         ld->other++;
 206         break;
 207       }
 208     }
 209   }
 210 }
 211
 212 static void
 213 dissect_null(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 214 {
 215   guint32       null_header;
 216   proto_tree    *fh_tree;
 217   proto_item    *ti;
 218   tvbuff_t      *next_tvb;
 219
 220   CHECK_DISPLAY_AS_DATA(proto_null, tvb, pinfo, tree);
 221
 222   pinfo->current_proto = "Null";
 223
 224   /*
 225    * See comment in "capture_null()" for an explanation of what we're
 226    * doing.
 227    */
 228   if (tvb_get_ntohs(tvb, 0) == 0xFF03) {
 229     /*
 230      * Hand it to PPP.
 231      */
 232     call_dissector(ppp_handle, tvb, pinfo, tree);
 233   } else {
 234
 235     /* load the top pane info. This should be overwritten by
 236        the next protocol in the stack */
 237     if(check_col(pinfo->fd, COL_RES_DL_SRC))
 238       col_set_str(pinfo->fd, COL_RES_DL_SRC, "N/A" );
 239     if(check_col(pinfo->fd, COL_RES_DL_DST))
 240       col_set_str(pinfo->fd, COL_RES_DL_DST, "N/A" );
 241     if(check_col(pinfo->fd, COL_PROTOCOL))
 242       col_set_str(pinfo->fd, COL_PROTOCOL, "N/A" );
 243     if(check_col(pinfo->fd, COL_INFO))
 244       col_set_str(pinfo->fd, COL_INFO, "Null/Loopback" );
 245
 246     /*
 247      * Treat it as a normal DLT_NULL header.
 248      */
 249     tvb_memcpy(tvb, (guint8 *)&null_header, 0, sizeof(null_header));
 250
 251     if ((null_header & 0xFFFF0000) != 0) {
 252       /* Byte-swap it. */
 253       null_header = BSWAP32(null_header);
 254     }
 255
 256     /*
 257      * The null header value must be greater than the IEEE 802.3 maximum
 258      * frame length to be a valid Ethernet type; if it is, hand it
 259      * to "ethertype()", otherwise treat it as a BSD AF_type (we wire
 260      * in the values of the BSD AF_ types, because the values
 261      * in the file will be BSD values, and the OS on which
 262      * we're building this might not have the same values or
 263      * might not have them defined at all; XXX - what if different
 264      * BSD derivatives have different values?).
 265      */
 266     if (null_header > IEEE_802_3_MAX_LEN) {
 267       if (tree) {
 268         ti = proto_tree_add_item(tree, proto_null, tvb, 0, 4, FALSE);
 269         fh_tree = proto_item_add_subtree(ti, ett_null);
 270       } else
 271         fh_tree = NULL;
 272       ethertype(null_header, tvb, 4, pinfo, tree, fh_tree, hf_null_etype);
 273     } else {
 274       /* populate a tree in the second pane with the status of the link
 275          layer (ie none) */
 276       if (tree) {
 277         ti = proto_tree_add_item(tree, proto_null, tvb, 0, 4, FALSE);
 278         fh_tree = proto_item_add_subtree(ti, ett_null);
 279         proto_tree_add_uint(fh_tree, hf_null_family, tvb, 0, 4, null_header);
 280       }
 281
 282       next_tvb = tvb_new_subset(tvb, 4, -1, -1);
 283       if (!dissector_try_port(null_dissector_table, null_header,
 284             next_tvb, pinfo, tree)) {
 285         /* No sub-dissector found.  Label rest of packet as "Data" */
 286         dissect_data(next_tvb, 0, pinfo, tree);
 287       }
 288     }
 289   }
 290 }
 291
 292 void
 293 proto_register_null(void)
 294 {
 295         static hf_register_info hf[] = {
 296
 297                 /* registered here but handled in ethertype.c */
 298                 { &hf_null_etype,
 299                 { "Type",               "null.type", FT_UINT16, BASE_HEX, VALS(etype_vals), 0x0,
 300                         "" }},
 301
 302                 { &hf_null_family,
 303                 { "Family",             "null.family",  FT_UINT32, BASE_HEX, VALS(family_vals), 0x0,
 304                         "" }}
 305         };
 306         static gint *ett[] = {
 307                 &ett_null,
 308         };
 309
 310         proto_null = proto_register_protocol("Null/Loopback", "Null", "null");
 311         proto_register_field_array(proto_null, hf, array_length(hf));
 312         proto_register_subtree_array(ett, array_length(ett));
 313
 314         /* subdissector code */
 315         null_dissector_table = register_dissector_table("null.type");
 316 }
 317
 318 void
 319 proto_reg_handoff_null(void)
 320 {
 321         /*
 322          * Get a handle for the PPP dissector.
 323          */
 324         ppp_handle = find_dissector("ppp");
 325         dissector_add("wtap_encap", WTAP_ENCAP_NULL, dissect_null);
 326 }