epan/dissectors/packet-wol.c

   1 /* packet-wol.c
   2  * Routines for WOL dissection
   3  * Copyright 2007, Christopher Maynard <Chris.Maynard[AT]gtech.com>
   4  *
   5  * $Id$
   6  *
   7  * Wireshark - Network traffic analyzer
   8  * By Gerald Combs <gerald@wireshark.org>
   9  * Copyright 1998 Gerald Combs
  10  *
  11  * This dissector for "Wake On LAN" was not copied from any other existing
  12  * dissector.  It uses the template from SVN23520 docs/README.devloper, which
  13  * was the latest one available at the time of this writing.  This dissector is
  14  * a heuristic one though, so appropriate changes have made to the template
  15  * as needed.
  16  *
  17  * The "Wake On LAN" dissector was written based primarily on the AMD white
  18  * paper, available from: http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/20213.pdf.
  19  *
  20  * In addition, testing of the dissector was conducted using 2 utilities
  21  * downloaded from http://www.moldaner.de/wakeonlan/wakeonlan.html and
  22  * http://www.depicus.com/wake-on-lan/, as well as with the ether-wake utility
  23  * on a Linux Fedora Core 4 system.
  24  *
  25  * From what I can tell from the tools available, even though the white paper
  26  * indicates that the so-called, "MagicPacket" can be located anywhere within
  27  * the Ethernet frame, in practice, there seem to be only 2 variations of the
  28  * implementation of the MagicPacket.  Ether-wake implements it as an Ethernet
  29  * frame with ether type 0x0842 (ETHERTYPE_WOL), and the other tools all seem
  30  * to implement it as a UDP packet, both with the payload as nothing but the
  31  * MagicPacket.
  32  *
  33  * To keep things simple, this dissector will only indicate a frame as
  34  * Wake-On-Lan if the MagicPacket is found for a frame marked as etherytpe
  35  * 0x0842 or if it's a UDP packet.  To fully support Wake-On-Lan dissection
  36  * though, we would need a way to have this dissector called only if the frame
  37  * hasn't already been classified as some other type of dissector ... but I
  38  * don't know how to do that?  The only alternative I am aware of would be to
  39  * register as a heuristic dissector for pretty much every possible protocol
  40  * there is, which seems unreasonable to do to me.
  41  *
  42  * This program is free software; you can redistribute it and/or
  43  * modify it under the terms of the GNU General Public License
  44  * as published by the Free Software Foundation; either version 2
  45  * of the License, or (at your option) any later version.
  46  *
  47  * This program is distributed in the hope that it will be useful,
  48  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  49  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  50  * GNU General Public License for more details.
  51  *
  52  * You should have received a copy of the GNU General Public License
  53  * along with this program; if not, write to the Free Software
  54  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  55  */
  56
  57 #include "config.h"
  58
  59 #include <glib.h>
  60
  61 #include <epan/packet.h>
  62 #include <epan/addr_resolv.h>
  63 #include <epan/etypes.h>
  64
  65 /* IF PROTO exposes code to other dissectors, then it must be exported
  66    in a header file. If not, a header file is not needed at all. */
  67 /* #include "packet-wol.h" */
  68
  69 /* Initialize the protocol and registered fields */
  70 static int proto_wol = -1;
  71 static int hf_wol_sync = -1;
  72 static int hf_wol_mac = -1;
  73 static int hf_wol_passwd = -1;
  74
  75 /* Global sample preference ("controls" display of numbers) */
  76 /* static gboolean gPREF_HEX = FALSE; */
  77
  78 /* Initialize the subtree pointers */
  79 static gint ett_wol = -1;
  80 static gint ett_wol_macblock = -1;
  81
  82 /* Code to actually dissect the packets */
  83 static int
  84 dissect_wol(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
  85 {
  86     guint         len;
  87     gint          offset;
  88     guint8        sync[6] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
  89     guint8       *mac;
  90     const guint8 *passwd;
  91
  92 /* Set up structures needed to add the protocol subtree and manage it */
  93     proto_item *ti;
  94     proto_item *mti;
  95     proto_tree *wol_tree;
  96     proto_tree *mac_tree;
  97
  98 /*  First, if at all possible, do some heuristics to check if the packet cannot
  99  *  possibly belong to your protocol.  This is especially important for
 100  *  protocols directly on top of TCP or UDP where port collisions are
 101  *  common place (e.g., even though your protocol uses a well known port,
 102  *  someone else may set up, for example, a web server on that port which,
 103  *  if someone analyzed that web server's traffic in Wireshark, would result
 104  *  in Wireshark handing an HTTP packet to your dissector).  For example:
 105  */
 106     /* Check that there's enough data */
 107     len = tvb_length(tvb);
 108     if ( len < 102 )    /* wol's smallest packet size is 102 */
 109         return (0);
 110
 111     /* Get some values from the packet header, probably using tvb_get_*() */
 112
 113     /* Regardless of what the AMD white paper states, don't search the entire
 114      * tvb for the synchronization stream.  My feeling is that this could be
 115      * quite expensive and seriously hinder Wireshark performance.  For now,
 116      * unless we need to change it later, just compare the 1st 6 bytes. */
 117     if ( tvb_memeql(tvb, 0, sync, 6) != 0 )
 118         return (0);
 119
 120     /* So far so good.  Now get the next 6 bytes, which we'll assume is the
 121      * target's MAC address, and do 15 memory chunk comparisons, since if this
 122      * is a real MagicPacket, the target's MAC will be duplicated 16 times. */
 123     mac = (guint8 *)tvb_memdup(wmem_packet_scope(), tvb, 6, 6);
 124     for ( offset = 12; offset < 102; offset += 6 )
 125         if ( tvb_memeql(tvb, offset, mac, 6) != 0 )
 126             return (0);
 127
 128     /* OK, we're going to assume it's a MagicPacket.  If there's a password,
 129      * grab it now, and in case there's any extra bytes after the only 3 valid
 130      * and expected lengths, truncate the length so the extra byte(s) aren't
 131      * included as being part of the WOL payload. */
 132     if ( len >= 106 && len < 108 )
 133     {
 134         len = 106;
 135         passwd = tvb_ip_to_str(tvb, 102);
 136     }
 137     else if ( len >= 108 )
 138     {
 139         len = 108;
 140         passwd = tvb_ether_to_str(tvb, 102);
 141     }
 142     else
 143     {
 144         len = 102;
 145         passwd = NULL;
 146     }
 147
 148 /* Make entries in Protocol column and Info column on summary display */
 149     col_set_str(pinfo->cinfo, COL_PROTOCOL, "WOL");
 150
 151 /* This field shows up as the "Info" column in the display; you should use
 152    it, if possible, to summarize what's in the packet, so that a user looking
 153    at the list of packets can tell what type of packet it is. See section 1.5
 154    for more information.
 155
 156    If you are setting the column to a constant string, use "col_set_str()",
 157    as it's more efficient than the other "col_set_XXX()" calls.
 158
 159    If you're setting it to a string you've constructed, or will be
 160    appending to the column later, use "col_add_str()".
 161
 162    "col_add_fstr()" can be used instead of "col_add_str()"; it takes
 163    "printf()"-like arguments.  Don't use "col_add_fstr()" with a format
 164    string of "%s" - just use "col_add_str()" or "col_set_str()", as it's
 165    more efficient than "col_add_fstr()".
 166
 167    If you will be fetching any data from the packet before filling in
 168    the Info column, clear that column first, in case the calls to fetch
 169    data from the packet throw an exception because they're fetching data
 170    past the end of the packet, so that the Info column doesn't have data
 171    left over from the previous dissector; do
 172
 173     col_clear(pinfo->cinfo, COL_INFO);
 174
 175    */
 176
 177     col_add_fstr(pinfo->cinfo, COL_INFO, "MagicPacket for %s (%s)",
 178         get_ether_name(mac), ether_to_str(mac));
 179
 180     /* NOTE: ether-wake uses a dotted-decimal format for specifying a
 181         * 4-byte password or an Ethernet mac address format for specifying
 182         * a 6-byte password, so display them in that format, even if the
 183         * password isn't really an IP or MAC address. */
 184     if ( passwd )
 185         col_append_fstr(pinfo->cinfo, COL_INFO, ", password %s", passwd);
 186
 187 /* A protocol dissector can be called in 2 different ways:
 188
 189     (a) Operational dissection
 190
 191         In this mode, Wireshark is only interested in the way protocols
 192         interact, protocol conversations are created, packets are
 193         reassembled and handed over to higher-level protocol dissectors.
 194         In this mode Wireshark does not build a so-called "protocol
 195         tree".
 196
 197     (b) Detailed dissection
 198
 199         In this mode, Wireshark is also interested in all details of
 200         a given protocol, so a "protocol tree" is created.
 201
 202    Wireshark distinguishes between the 2 modes with the proto_tree pointer:
 203     (a) <=> tree == NULL
 204     (b) <=> tree != NULL
 205
 206    In the interest of speed, if "tree" is NULL, avoid building a
 207    protocol tree and adding stuff to it, or even looking at any packet
 208    data needed only if you're building the protocol tree, if possible.
 209
 210    Note, however, that you must fill in column information, create
 211    conversations, reassemble packets, build any other persistent state
 212    needed for dissection, and call subdissectors regardless of whether
 213    "tree" is NULL or not.  This might be inconvenient to do without
 214    doing most of the dissection work; the routines for adding items to
 215    the protocol tree can be passed a null protocol tree pointer, in
 216    which case they'll return a null item pointer, and
 217    "proto_item_add_subtree()" returns a null tree pointer if passed a
 218    null item pointer, so, if you're careful not to dereference any null
 219    tree or item pointers, you can accomplish this by doing all the
 220    dissection work.  This might not be as efficient as skipping that
 221    work if you're not building a protocol tree, but if the code would
 222    have a lot of tests whether "tree" is null if you skipped that work,
 223    you might still be better off just doing all that work regardless of
 224    whether "tree" is null or not. */
 225     if (tree) {
 226
 227 /* NOTE: The offset and length values in the call to
 228    "proto_tree_add_item()" define what data bytes to highlight in the hex
 229    display window when the line in the protocol tree display
 230    corresponding to that item is selected.
 231
 232    Supplying a length of -1 is the way to highlight all data from the
 233    offset to the end of the packet. */
 234
 235 /* create display subtree for the protocol */
 236         ti = proto_tree_add_item(tree, proto_wol, tvb, 0, len, ENC_NA);
 237         proto_item_append_text(ti, ", MAC: %s (%s)", get_ether_name(mac),
 238             ether_to_str(mac));
 239         if ( passwd )
 240             proto_item_append_text(ti, ", password: %s", passwd);
 241         wol_tree = proto_item_add_subtree(ti, ett_wol);
 242
 243 /* add an item to the subtree, see section 1.6 for more information */
 244         proto_tree_add_item(wol_tree, hf_wol_sync, tvb, 0, 6, ENC_NA);
 245
 246 /* Continue adding tree items to process the packet here */
 247         mti = proto_tree_add_text(wol_tree, tvb, 6, 96, "MAC: %s (%s)",
 248             get_ether_name(mac), ether_to_str(mac));
 249         mac_tree = proto_item_add_subtree(mti, ett_wol_macblock);
 250         for ( offset = 6; offset < 102; offset += 6 )
 251             proto_tree_add_ether(mac_tree, hf_wol_mac, tvb, offset, 6, mac);
 252
 253         if ( len == 106 )
 254             proto_tree_add_bytes_format(wol_tree, hf_wol_passwd, tvb, offset,
 255                 4, passwd, "Password: %s", passwd);
 256         else if ( len == 108 )
 257             proto_tree_add_bytes_format(wol_tree, hf_wol_passwd, tvb, offset,
 258                 6, passwd, "Password: %s", passwd);
 259     }
 260
 261 /* If this protocol has a sub-dissector call it here, see section 1.8 */
 262
 263 /* Return the amount of data this dissector was able to dissect */
 264     if ( pinfo->ethertype == ETHERTYPE_WOL )
 265         return (len);
 266
 267     /* Heuristic dissectors return TRUE/FALSE. */
 268     return (TRUE);
 269 }
 270
 271
 272 /* Register the protocol with Wireshark */
 273
 274 /* this format is require because a script is used to build the C function
 275    that calls all the protocol registration.
 276 */
 277
 278 void
 279 proto_register_wol(void)
 280 {
 281 /* Setup list of header fields  See Section 1.6.1 for details*/
 282     static hf_register_info hf[] = {
 283         { &hf_wol_sync,
 284             { "Sync stream", "wol.sync",
 285             FT_BYTES, BASE_NONE, NULL, 0, NULL, HFILL }},
 286         { &hf_wol_mac,
 287             { "MAC", "wol.mac",
 288             FT_ETHER, BASE_NONE, NULL, 0, NULL, HFILL }},
 289         { &hf_wol_passwd,
 290             { "Password", "wol.passwd",
 291             FT_BYTES, BASE_NONE, NULL, 0, NULL, HFILL }}
 292     };
 293
 294 /* Setup protocol subtree array */
 295     static gint *ett[] = {
 296         &ett_wol,
 297         &ett_wol_macblock
 298     };
 299
 300 /* Register the protocol name and description */
 301     proto_wol = proto_register_protocol("Wake On LAN", "WOL", "wol");
 302
 303 /* Required function calls to register the header fields and subtrees used */
 304     proto_register_field_array(proto_wol, hf, array_length(hf));
 305     proto_register_subtree_array(ett, array_length(ett));
 306 }
 307
 308
 309 /* If this dissector uses sub-dissector registration add a registration routine.
 310    This exact format is required because a script is used to find these
 311    routines and create the code that calls these routines.
 312
 313 */
 314 void
 315 proto_reg_handoff_wol(void)
 316 {
 317     dissector_handle_t wol_handle;
 318
 319 /*  Use new_create_dissector_handle() to indicate that dissect_wol()
 320  *  returns the number of bytes it dissected (or 0 if it thinks the packet
 321  *  does not belong to PROTONAME).
 322  */
 323     wol_handle = new_create_dissector_handle(dissect_wol, proto_wol);
 324
 325     /* We don't really want to register with EVERY possible dissector,
 326      * do we?  I know that the AMD white paper specifies that the
 327      * MagicPacket could be present in any frame, but are we seriously
 328      * going to register WOL with every other dissector!?  I think not.
 329      *
 330      * Unless anyone has a better idea, just register with only those that
 331      * are in "common usage" and grow this list as needed.  Yeah, I'm sure
 332      * we'll miss some, but how else to do this ... add a thousand of
 333      * these dissector_add_uint()'s and heur_dissector_add()'s??? */
 334     dissector_add_uint("ethertype", ETHERTYPE_WOL, wol_handle);
 335     heur_dissector_add("udp", dissect_wol, proto_wol);
 336 }
 337
 338 /*
 339  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
 340  *
 341  * Local variables:
 342  * c-basic-offset: 4
 343  * tab-width: 8
 344  * indent-tabs-mode: nil
 345  * End:
 346  *
 347  * vi: set shiftwidth=4 tabstop=8 expandtab:
 348  * :indentSize=4:tabSize=8:noTabs=true:
 349  */