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       *mac;
  89     const guint8 *passwd;
  90         guint64       qword;
  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         qword = tvb_get_ntoh48(tvb,0);
 118         if(qword != 0xffffffffffff)
 119         return (0);
 120
 121     /* So far so good.  Now get the next 6 bytes, which we'll assume is the
 122      * target's MAC address, and do 15 memory chunk comparisons, since if this
 123      * is a real MagicPacket, the target's MAC will be duplicated 16 times. */
 124     mac = (guint8 *)tvb_memdup(wmem_packet_scope(), tvb, 6, 6);
 125     for ( offset = 12; offset < 102; offset += 6 )
 126         if ( tvb_memeql(tvb, offset, mac, 6) != 0 )
 127             return (0);
 128
 129     /* OK, we're going to assume it's a MagicPacket.  If there's a password,
 130      * grab it now, and in case there's any extra bytes after the only 3 valid
 131      * and expected lengths, truncate the length so the extra byte(s) aren't
 132      * included as being part of the WOL payload. */
 133     if ( len >= 106 && len < 108 )
 134     {
 135         len = 106;
 136         passwd = tvb_ip_to_str(tvb, 102);
 137     }
 138     else if ( len >= 108 )
 139     {
 140         len = 108;
 141         passwd = tvb_ether_to_str(tvb, 102);
 142     }
 143     else
 144     {
 145         len = 102;
 146         passwd = NULL;
 147     }
 148
 149 /* Make entries in Protocol column and Info column on summary display */
 150     col_set_str(pinfo->cinfo, COL_PROTOCOL, "WOL");
 151
 152 /* This field shows up as the "Info" column in the display; you should use
 153    it, if possible, to summarize what's in the packet, so that a user looking
 154    at the list of packets can tell what type of packet it is. See section 1.5
 155    for more information.
 156
 157    If you are setting the column to a constant string, use "col_set_str()",
 158    as it's more efficient than the other "col_set_XXX()" calls.
 159
 160    If you're setting it to a string you've constructed, or will be
 161    appending to the column later, use "col_add_str()".
 162
 163    "col_add_fstr()" can be used instead of "col_add_str()"; it takes
 164    "printf()"-like arguments.  Don't use "col_add_fstr()" with a format
 165    string of "%s" - just use "col_add_str()" or "col_set_str()", as it's
 166    more efficient than "col_add_fstr()".
 167
 168    If you will be fetching any data from the packet before filling in
 169    the Info column, clear that column first, in case the calls to fetch
 170    data from the packet throw an exception because they're fetching data
 171    past the end of the packet, so that the Info column doesn't have data
 172    left over from the previous dissector; do
 173
 174     col_clear(pinfo->cinfo, COL_INFO);
 175
 176    */
 177
 178     col_add_fstr(pinfo->cinfo, COL_INFO, "MagicPacket for %s (%s)",
 179         get_ether_name(mac), ether_to_str(mac));
 180
 181     /* NOTE: ether-wake uses a dotted-decimal format for specifying a
 182         * 4-byte password or an Ethernet mac address format for specifying
 183         * a 6-byte password, so display them in that format, even if the
 184         * password isn't really an IP or MAC address. */
 185     if ( passwd )
 186         col_append_fstr(pinfo->cinfo, COL_INFO, ", password %s", passwd);
 187
 188 /* A protocol dissector can be called in 2 different ways:
 189
 190     (a) Operational dissection
 191
 192         In this mode, Wireshark is only interested in the way protocols
 193         interact, protocol conversations are created, packets are
 194         reassembled and handed over to higher-level protocol dissectors.
 195         In this mode Wireshark does not build a so-called "protocol
 196         tree".
 197
 198     (b) Detailed dissection
 199
 200         In this mode, Wireshark is also interested in all details of
 201         a given protocol, so a "protocol tree" is created.
 202
 203    Wireshark distinguishes between the 2 modes with the proto_tree pointer:
 204     (a) <=> tree == NULL
 205     (b) <=> tree != NULL
 206
 207    In the interest of speed, if "tree" is NULL, avoid building a
 208    protocol tree and adding stuff to it, or even looking at any packet
 209    data needed only if you're building the protocol tree, if possible.
 210
 211    Note, however, that you must fill in column information, create
 212    conversations, reassemble packets, build any other persistent state
 213    needed for dissection, and call subdissectors regardless of whether
 214    "tree" is NULL or not.  This might be inconvenient to do without
 215    doing most of the dissection work; the routines for adding items to
 216    the protocol tree can be passed a null protocol tree pointer, in
 217    which case they'll return a null item pointer, and
 218    "proto_item_add_subtree()" returns a null tree pointer if passed a
 219    null item pointer, so, if you're careful not to dereference any null
 220    tree or item pointers, you can accomplish this by doing all the
 221    dissection work.  This might not be as efficient as skipping that
 222    work if you're not building a protocol tree, but if the code would
 223    have a lot of tests whether "tree" is null if you skipped that work,
 224    you might still be better off just doing all that work regardless of
 225    whether "tree" is null or not. */
 226     if (tree) {
 227
 228 /* NOTE: The offset and length values in the call to
 229    "proto_tree_add_item()" define what data bytes to highlight in the hex
 230    display window when the line in the protocol tree display
 231    corresponding to that item is selected.
 232
 233    Supplying a length of -1 is the way to highlight all data from the
 234    offset to the end of the packet. */
 235
 236 /* create display subtree for the protocol */
 237         ti = proto_tree_add_item(tree, proto_wol, tvb, 0, len, ENC_NA);
 238         proto_item_append_text(ti, ", MAC: %s (%s)", get_ether_name(mac),
 239             ether_to_str(mac));
 240         if ( passwd )
 241             proto_item_append_text(ti, ", password: %s", passwd);
 242         wol_tree = proto_item_add_subtree(ti, ett_wol);
 243
 244 /* add an item to the subtree, see section 1.6 for more information */
 245         proto_tree_add_item(wol_tree, hf_wol_sync, tvb, 0, 6, ENC_NA);
 246
 247 /* Continue adding tree items to process the packet here */
 248         mti = proto_tree_add_text(wol_tree, tvb, 6, 96, "MAC: %s (%s)",
 249             get_ether_name(mac), ether_to_str(mac));
 250         mac_tree = proto_item_add_subtree(mti, ett_wol_macblock);
 251         for ( offset = 6; offset < 102; offset += 6 )
 252             proto_tree_add_ether(mac_tree, hf_wol_mac, tvb, offset, 6, mac);
 253
 254         if ( len == 106 )
 255             proto_tree_add_bytes_format_value(wol_tree, hf_wol_passwd, tvb, offset,
 256                 4, passwd, "%s", passwd);
 257         else if ( len == 108 )
 258             proto_tree_add_bytes_format_value(wol_tree, hf_wol_passwd, tvb, offset,
 259                 6, passwd, "%s", passwd);
 260     }
 261
 262 /* If this protocol has a sub-dissector call it here, see section 1.8 */
 263
 264 /* Return the amount of data this dissector was able to dissect */
 265     if ( pinfo->ethertype == ETHERTYPE_WOL )
 266         return (len);
 267
 268     /* Heuristic dissectors return TRUE/FALSE. */
 269     return (TRUE);
 270 }
 271
 272
 273 /* Register the protocol with Wireshark */
 274
 275 /* this format is require because a script is used to build the C function
 276    that calls all the protocol registration.
 277 */
 278
 279 void
 280 proto_register_wol(void)
 281 {
 282 /* Setup list of header fields  See Section 1.6.1 for details*/
 283     static hf_register_info hf[] = {
 284         { &hf_wol_sync,
 285             { "Sync stream", "wol.sync",
 286             FT_BYTES, BASE_NONE, NULL, 0, NULL, HFILL }},
 287         { &hf_wol_mac,
 288             { "MAC", "wol.mac",
 289             FT_ETHER, BASE_NONE, NULL, 0, NULL, HFILL }},
 290         { &hf_wol_passwd,
 291             { "Password", "wol.passwd",
 292             FT_BYTES, BASE_NONE, NULL, 0, NULL, HFILL }}
 293     };
 294
 295 /* Setup protocol subtree array */
 296     static gint *ett[] = {
 297         &ett_wol,
 298         &ett_wol_macblock
 299     };
 300
 301 /* Register the protocol name and description */
 302     proto_wol = proto_register_protocol("Wake On LAN", "WOL", "wol");
 303
 304 /* Required function calls to register the header fields and subtrees used */
 305     proto_register_field_array(proto_wol, hf, array_length(hf));
 306     proto_register_subtree_array(ett, array_length(ett));
 307 }
 308
 309
 310 /* If this dissector uses sub-dissector registration add a registration routine.
 311    This exact format is required because a script is used to find these
 312    routines and create the code that calls these routines.
 313
 314 */
 315 void
 316 proto_reg_handoff_wol(void)
 317 {
 318     dissector_handle_t wol_handle;
 319
 320 /*  Use new_create_dissector_handle() to indicate that dissect_wol()
 321  *  returns the number of bytes it dissected (or 0 if it thinks the packet
 322  *  does not belong to PROTONAME).
 323  */
 324     wol_handle = new_create_dissector_handle(dissect_wol, proto_wol);
 325
 326     /* We don't really want to register with EVERY possible dissector,
 327      * do we?  I know that the AMD white paper specifies that the
 328      * MagicPacket could be present in any frame, but are we seriously
 329      * going to register WOL with every other dissector!?  I think not.
 330      *
 331      * Unless anyone has a better idea, just register with only those that
 332      * are in "common usage" and grow this list as needed.  Yeah, I'm sure
 333      * we'll miss some, but how else to do this ... add a thousand of
 334      * these dissector_add_uint()'s and heur_dissector_add()'s??? */
 335     dissector_add_uint("ethertype", ETHERTYPE_WOL, wol_handle);
 336     heur_dissector_add("udp", dissect_wol, proto_wol);
 337 }
 338
 339 /*
 340  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
 341  *
 342  * Local variables:
 343  * c-basic-offset: 4
 344  * tab-width: 8
 345  * indent-tabs-mode: nil
 346  * End:
 347  *
 348  * vi: set shiftwidth=4 tabstop=8 expandtab:
 349  * :indentSize=4:tabSize=8:noTabs=true:
 350  */