packet-null.c

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