packet-null.c

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