2 * Routines for WOL dissection
3 * Copyright 2007, Christopher Maynard <Chris.Maynard[AT]gtech.com>
7 * Wireshark - Network traffic analyzer
8 * By Gerald Combs <gerald@wireshark.org>
9 * Copyright 1998 Gerald Combs
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
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.
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.
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
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.
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.
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.
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.
66 #include <epan/addr_resolv.h>
67 #include <epan/packet.h>
68 #include <epan/etypes.h>
70 /* IF PROTO exposes code to other dissectors, then it must be exported
71 in a header file. If not, a header file is not needed at all. */
72 /* #include "packet-wol.h" */
74 /* Initialize the protocol and registered fields */
75 static int proto_wol = -1;
76 static int hf_wol_sync = -1;
77 static int hf_wol_mac = -1;
78 static int hf_wol_passwd = -1;
80 /* Global sample preference ("controls" display of numbers) */
81 /* static gboolean gPREF_HEX = FALSE; */
83 /* Initialize the subtree pointers */
84 static gint ett_wol = -1;
85 static gint ett_wol_macblock = -1;
87 /* Code to actually dissect the packets */
89 dissect_wol(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
93 guint8 sync[6] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
97 /* Set up structures needed to add the protocol subtree and manage it */
100 proto_tree *wol_tree;
101 proto_tree *mac_tree;
103 /* First, if at all possible, do some heuristics to check if the packet cannot
104 * possibly belong to your protocol. This is especially important for
105 * protocols directly on top of TCP or UDP where port collisions are
106 * common place (e.g., even though your protocol uses a well known port,
107 * someone else may set up, for example, a web server on that port which,
108 * if someone analyzed that web server's traffic in Wireshark, would result
109 * in Wireshark handing an HTTP packet to your dissector). For example:
111 /* Check that there's enough data */
112 len = tvb_length(tvb);
113 if ( len < 102 ) /* wol's smallest packet size is 102 */
116 /* Get some values from the packet header, probably using tvb_get_*() */
118 /* Regardless of what the AMD white paper states, don't search the entire
119 * tvb for the synchronization stream. My feeling is that this could be
120 * quite expensive and seriously hinder Wireshark performance. For now,
121 * unless we need to change it later, just compare the 1st 6 bytes. */
122 if ( tvb_memeql(tvb, 0, sync, 6) != 0 )
125 /* So far so good. Now get the next 6 bytes, which we'll assume is the
126 * target's MAC address, and do 15 memory chunk comparisons, since if this
127 * is a real MagicPacket, the target's MAC will be duplicated 16 times. */
128 mac = ep_tvb_memdup(tvb, 6, 6);
129 for ( offset = 12; offset < 102; offset += 6 )
130 if ( tvb_memeql(tvb, offset, mac, 6) != 0 )
133 /* OK, we're going to assume it's a MagicPacket. If there's a password,
134 * grab it now, and in case there's any extra bytes after the only 3 valid
135 * and expected lengths, truncate the length so the extra byte(s) aren't
136 * included as being part of the WOL payload. */
137 if ( len >= 106 && len < 108 )
140 passwd = ip_to_str(ep_tvb_memdup(tvb, 102, 4));
142 else if ( len >= 108 )
145 passwd = ether_to_str(ep_tvb_memdup(tvb, 102, 6));
153 /* Make entries in Protocol column and Info column on summary display */
154 col_set_str(pinfo->cinfo, COL_PROTOCOL, "WOL");
156 /* This field shows up as the "Info" column in the display; you should use
157 it, if possible, to summarize what's in the packet, so that a user looking
158 at the list of packets can tell what type of packet it is. See section 1.5
159 for more information.
161 Before changing the contents of a column you should make sure the column is
162 active by calling "check_col(pinfo->cinfo, COL_*)". If it is not active
163 don't bother setting it.
165 If you are setting the column to a constant string, use "col_set_str()",
166 as it's more efficient than the other "col_set_XXX()" calls.
168 If you're setting it to a string you've constructed, or will be
169 appending to the column later, use "col_add_str()".
171 "col_add_fstr()" can be used instead of "col_add_str()"; it takes
172 "printf()"-like arguments. Don't use "col_add_fstr()" with a format
173 string of "%s" - just use "col_add_str()" or "col_set_str()", as it's
174 more efficient than "col_add_fstr()".
176 If you will be fetching any data from the packet before filling in
177 the Info column, clear that column first, in case the calls to fetch
178 data from the packet throw an exception because they're fetching data
179 past the end of the packet, so that the Info column doesn't have data
180 left over from the previous dissector; do
182 col_clear(pinfo->cinfo, COL_INFO);
186 if ( check_col(pinfo->cinfo, COL_INFO) )
188 col_add_fstr(pinfo->cinfo, COL_INFO, "MagicPacket for %s (%s)",
189 get_ether_name(mac), ether_to_str(mac));
191 /* NOTE: ether-wake uses a dotted-decimal format for specifying a
192 * 4-byte password or an Ethernet mac address format for specifying
193 * a 6-byte password, so display them in that format, even if the
194 * password isn't really an IP or MAC address. */
196 col_append_fstr(pinfo->cinfo, COL_INFO, ", password %s", passwd);
199 /* A protocol dissector can be called in 2 different ways:
201 (a) Operational dissection
203 In this mode, Wireshark is only interested in the way protocols
204 interact, protocol conversations are created, packets are
205 reassembled and handed over to higher-level protocol dissectors.
206 In this mode Wireshark does not build a so-called "protocol
209 (b) Detailed dissection
211 In this mode, Wireshark is also interested in all details of
212 a given protocol, so a "protocol tree" is created.
214 Wireshark distinguishes between the 2 modes with the proto_tree pointer:
218 In the interest of speed, if "tree" is NULL, avoid building a
219 protocol tree and adding stuff to it, or even looking at any packet
220 data needed only if you're building the protocol tree, if possible.
222 Note, however, that you must fill in column information, create
223 conversations, reassemble packets, build any other persistent state
224 needed for dissection, and call subdissectors regardless of whether
225 "tree" is NULL or not. This might be inconvenient to do without
226 doing most of the dissection work; the routines for adding items to
227 the protocol tree can be passed a null protocol tree pointer, in
228 which case they'll return a null item pointer, and
229 "proto_item_add_subtree()" returns a null tree pointer if passed a
230 null item pointer, so, if you're careful not to dereference any null
231 tree or item pointers, you can accomplish this by doing all the
232 dissection work. This might not be as efficient as skipping that
233 work if you're not building a protocol tree, but if the code would
234 have a lot of tests whether "tree" is null if you skipped that work,
235 you might still be better off just doing all that work regardless of
236 whether "tree" is null or not. */
239 /* NOTE: The offset and length values in the call to
240 "proto_tree_add_item()" define what data bytes to highlight in the hex
241 display window when the line in the protocol tree display
242 corresponding to that item is selected.
244 Supplying a length of -1 is the way to highlight all data from the
245 offset to the end of the packet. */
247 /* create display subtree for the protocol */
248 ti = proto_tree_add_item(tree, proto_wol, tvb, 0, len, FALSE);
249 proto_item_append_text(ti, ", MAC: %s (%s)", get_ether_name(mac),
252 proto_item_append_text(ti, ", password: %s", passwd);
253 wol_tree = proto_item_add_subtree(ti, ett_wol);
255 /* add an item to the subtree, see section 1.6 for more information */
256 proto_tree_add_item(wol_tree, hf_wol_sync, tvb, 0, 6, FALSE);
258 /* Continue adding tree items to process the packet here */
259 mti = proto_tree_add_text(wol_tree, tvb, 6, 96, "MAC: %s (%s)",
260 get_ether_name(mac), ether_to_str(mac));
261 mac_tree = proto_item_add_subtree(mti, ett_wol_macblock);
262 for ( offset = 6; offset < 102; offset += 6 )
263 proto_tree_add_ether(mac_tree, hf_wol_mac, tvb, offset, 6, mac);
266 proto_tree_add_bytes_format(wol_tree, hf_wol_passwd, tvb, offset,
267 4, passwd, "Password: %s", passwd);
268 else if ( len == 108 )
269 proto_tree_add_bytes_format(wol_tree, hf_wol_passwd, tvb, offset,
270 6, passwd, "Password: %s", passwd);
273 /* If this protocol has a sub-dissector call it here, see section 1.8 */
275 /* Return the amount of data this dissector was able to dissect */
276 if ( pinfo->ethertype == ETHERTYPE_WOL )
279 /* Heuristic dissectors return TRUE/FALSE. */
284 /* Register the protocol with Wireshark */
286 /* this format is require because a script is used to build the C function
287 that calls all the protocol registration.
291 proto_register_wol(void)
293 /* Setup list of header fields See Section 1.6.1 for details*/
294 static hf_register_info hf[] = {
296 { "Sync stream", "wol.sync",
297 FT_BYTES, BASE_NONE, NULL, 0, NULL, HFILL }},
300 FT_ETHER, BASE_NONE, NULL, 0, NULL, HFILL }},
302 { "Password", "wol.passwd",
303 FT_BYTES, BASE_NONE, NULL, 0, NULL, HFILL }}
306 /* Setup protocol subtree array */
307 static gint *ett[] = {
312 /* Register the protocol name and description */
313 proto_wol = proto_register_protocol("Wake On LAN", "WOL", "wol");
315 /* Required function calls to register the header fields and subtrees used */
316 proto_register_field_array(proto_wol, hf, array_length(hf));
317 proto_register_subtree_array(ett, array_length(ett));
321 /* If this dissector uses sub-dissector registration add a registration routine.
322 This exact format is required because a script is used to find these
323 routines and create the code that calls these routines.
327 proto_reg_handoff_wol(void)
329 dissector_handle_t wol_handle;
331 /* Use new_create_dissector_handle() to indicate that dissect_wol()
332 * returns the number of bytes it dissected (or 0 if it thinks the packet
333 * does not belong to PROTONAME).
335 wol_handle = new_create_dissector_handle(dissect_wol, proto_wol);
337 /* We don't really want to register with EVERY possible dissector,
338 * do we? I know that the AMD white paper specifies that the
339 * MagicPacket could be present in any frame, but are we seriously
340 * going to register WOL with every other dissector!? I think not.
342 * Unless anyone has a better idea, just register with only those that
343 * are in "common usage" and grow this list as needed. Yeah, I'm sure
344 * we'll miss some, but how else to do this ... add a thousand of
345 * these dissector_add()'s and heur_dissector_add()'s??? */
346 dissector_add("ethertype", ETHERTYPE_WOL, wol_handle);
347 heur_dissector_add("udp", dissect_wol, proto_wol);