2 * Routines for dsi packet dissection
3 * Copyright 2001, Randy McEoin <rmceoin@pe.com>
5 * Wireshark - Network traffic analyzer
6 * By Gerald Combs <gerald@wireshark.org>
7 * Copyright 1998 Gerald Combs
9 * Copied from packet-pop.c
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version 2
14 * of the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 #include <epan/packet.h>
29 #include <epan/prefs.h>
31 #include "packet-tcp.h"
32 #include "packet-afp.h"
34 /* The information in this module (DSI) comes from:
36 AFP 2.1 & 2.2 documentation, in PDF form, at
38 http://developer.apple.com/DOCUMENTATION/macos8/pdf/ASAppleTalkFiling2.1_2.2.pdf
40 The netatalk source code by Wesley Craig & Adrian Sun
42 The Data Stream Interface description from
43 http://developer.apple.com/documentation/Networking/Conceptual/AFPClient/AFPClient-6.html
45 (no longer available, apparently)
47 Also, AFP 3.3 documents parts of DSI at:
48 http://developer.apple.com/mac/library/documentation/Networking/Conceptual/AFP/Introduction/Introduction.html
50 * What a Data Stream Interface packet looks like:
52 * |-------------------------------|
53 * |flags |command| requestID |
54 * |-------------------------------|
55 * |error code/enclosed data offset|
56 * |-------------------------------|
57 * |total data length |
58 * |-------------------------------|
60 * |-------------------------------|
63 void proto_register_dsi(void);
64 void proto_reg_handoff_dsi(void);
66 static int proto_dsi = -1;
67 static int hf_dsi_flags = -1;
68 static int hf_dsi_command = -1;
69 static int hf_dsi_requestid = -1;
70 static int hf_dsi_offset = -1;
71 static int hf_dsi_error = -1;
72 static int hf_dsi_length = -1;
73 static int hf_dsi_reserved = -1;
75 static gint ett_dsi = -1;
77 static int hf_dsi_open_type = -1;
78 static int hf_dsi_open_len = -1;
79 static int hf_dsi_open_quantum = -1;
80 static int hf_dsi_replay_cache_size = -1;
81 static int hf_dsi_open_option = -1;
83 static int hf_dsi_attn_flag = -1;
84 static int hf_dsi_attn_flag_shutdown = -1;
85 static int hf_dsi_attn_flag_crash = -1;
86 static int hf_dsi_attn_flag_msg = -1;
87 static int hf_dsi_attn_flag_reconnect = -1;
88 static int hf_dsi_attn_flag_time = -1;
89 static int hf_dsi_attn_flag_bitmap = -1;
91 static gint ett_dsi_open = -1;
92 static gint ett_dsi_attn = -1;
93 static gint ett_dsi_attn_flag = -1;
95 static const value_string dsi_attn_flag_vals[] = {
96 {0x0, "Reserved" }, /* 0000 */
97 {0x1, "Reserved" }, /* 0001 */
98 {0x2, "Server message" }, /* 0010 */
99 {0x3, "Server notification, cf. extended bitmap" }, /* 0011 */
100 {0x4, "Server is shutting down, internal error" }, /* 0100 */
101 {0x8, "Server is shutting down" }, /* 1000 */
102 {0x9, "Server disconnects user" }, /* 1001 */
103 {0x10,"Server is shutting down, message" }, /* 1010 */
104 {0x11,"Server is shutting down, message,no reconnect"}, /* 1011 */
106 static value_string_ext dsi_attn_flag_vals_ext = VALUE_STRING_EXT_INIT(dsi_attn_flag_vals);
108 static const value_string dsi_open_type_vals[] = {
109 {0, "Server quantum" },
110 {1, "Attention quantum" },
111 {2, "Replay cache size" },
114 /* desegmentation of DSI */
115 static gboolean dsi_desegment = TRUE;
117 static dissector_handle_t data_handle;
118 static dissector_handle_t afp_handle;
119 static dissector_handle_t afp_server_status_handle;
121 #define TCP_PORT_DSI 548
123 #define DSI_BLOCKSIZ 16
126 #define DSIFL_REQUEST 0x00
127 #define DSIFL_REPLY 0x01
128 #define DSIFL_MAX 0x01
131 #define DSIFUNC_CLOSE 1 /* DSICloseSession */
132 #define DSIFUNC_CMD 2 /* DSICommand */
133 #define DSIFUNC_STAT 3 /* DSIGetStatus */
134 #define DSIFUNC_OPEN 4 /* DSIOpenSession */
135 #define DSIFUNC_TICKLE 5 /* DSITickle */
136 #define DSIFUNC_WRITE 6 /* DSIWrite */
137 #define DSIFUNC_ATTN 8 /* DSIAttention */
138 #define DSIFUNC_MAX 8 /* largest command */
140 static const value_string flag_vals[] = {
141 {DSIFL_REQUEST, "Request" },
142 {DSIFL_REPLY, "Reply" },
145 static const value_string func_vals[] = {
146 {DSIFUNC_CLOSE, "CloseSession" },
147 {DSIFUNC_CMD, "Command" },
148 {DSIFUNC_STAT, "GetStatus" },
149 {DSIFUNC_OPEN, "OpenSession" },
150 {DSIFUNC_TICKLE, "Tickle" },
151 {DSIFUNC_WRITE, "Write" },
153 {DSIFUNC_ATTN, "Attention" },
155 static value_string_ext func_vals_ext = VALUE_STRING_EXT_INIT(func_vals);
158 dissect_dsi_open_session(tvbuff_t *tvb, proto_tree *dsi_tree, gint offset, gint dsi_length)
164 tree = proto_tree_add_subtree(dsi_tree, tvb, offset, -1, ett_dsi_open, NULL, "Open Session");
166 while( dsi_length >2 ) {
168 type = tvb_get_guint8(tvb, offset);
169 proto_tree_add_item(tree, hf_dsi_open_type, tvb, offset, 1, ENC_BIG_ENDIAN);
171 len = tvb_get_guint8(tvb, offset);
172 proto_tree_add_item(tree, hf_dsi_open_len, tvb, offset, 1, ENC_BIG_ENDIAN);
176 proto_tree_add_item(tree, hf_dsi_open_quantum, tvb, offset, 4, ENC_BIG_ENDIAN);
179 proto_tree_add_item(tree, hf_dsi_open_quantum, tvb, offset, 4, ENC_BIG_ENDIAN);
182 proto_tree_add_item(tree, hf_dsi_replay_cache_size, tvb, offset, 4, ENC_BIG_ENDIAN);
185 proto_tree_add_item(tree, hf_dsi_open_option, tvb, offset, len, ENC_NA);
188 dsi_length -= len + 2;
196 dissect_dsi_attention(tvbuff_t *tvb, proto_tree *dsi_tree, gint offset)
202 if (!tvb_reported_length_remaining(tvb,offset))
205 flag = tvb_get_ntohs(tvb, offset);
206 tree = proto_tree_add_subtree(dsi_tree, tvb, offset, -1, ett_dsi_attn, NULL, "Attention");
208 ti = proto_tree_add_item(tree, hf_dsi_attn_flag, tvb, offset, 2, ENC_BIG_ENDIAN);
209 tree = proto_item_add_subtree(ti, ett_dsi_attn_flag);
210 proto_tree_add_item(tree, hf_dsi_attn_flag_shutdown, tvb, offset, 2, ENC_BIG_ENDIAN);
211 proto_tree_add_item(tree, hf_dsi_attn_flag_crash, tvb, offset, 2, ENC_BIG_ENDIAN);
212 proto_tree_add_item(tree, hf_dsi_attn_flag_msg, tvb, offset, 2, ENC_BIG_ENDIAN);
213 proto_tree_add_item(tree, hf_dsi_attn_flag_reconnect, tvb, offset, 2, ENC_BIG_ENDIAN);
215 if ((flag & 0xf000) != 0x3000)
216 proto_tree_add_item(tree, hf_dsi_attn_flag_time, tvb, offset, 2, ENC_BIG_ENDIAN);
218 proto_tree_add_item(tree, hf_dsi_attn_flag_bitmap, tvb, offset, 2, ENC_BIG_ENDIAN);
224 dissect_dsi_packet(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data _U_)
226 proto_tree *dsi_tree;
228 guint8 dsi_flags,dsi_command;
229 guint16 dsi_requestid;
232 guint32 dsi_reserved;
233 struct aspinfo aspinfo;
236 col_set_str(pinfo->cinfo, COL_PROTOCOL, "DSI");
237 col_clear(pinfo->cinfo, COL_INFO);
239 dsi_flags = tvb_get_guint8(tvb, 0);
240 dsi_command = tvb_get_guint8(tvb, 1);
241 dsi_requestid = tvb_get_ntohs(tvb, 2);
242 dsi_code = tvb_get_ntohl(tvb, 4);
243 dsi_length = tvb_get_ntohl(tvb, 8);
244 dsi_reserved = tvb_get_ntohl(tvb, 12);
246 col_add_fstr(pinfo->cinfo, COL_INFO, "%s %s (%u)",
247 val_to_str(dsi_flags, flag_vals,
248 "Unknown flag (0x%02x)"),
249 val_to_str_ext(dsi_command, &func_vals_ext,
250 "Unknown function (0x%02x)"),
253 dsi_ti = proto_tree_add_item(tree, proto_dsi, tvb, 0, -1, ENC_NA);
254 dsi_tree = proto_item_add_subtree(dsi_ti, ett_dsi);
257 proto_tree_add_uint(dsi_tree, hf_dsi_flags, tvb,
259 proto_tree_add_uint(dsi_tree, hf_dsi_command, tvb,
261 proto_tree_add_uint(dsi_tree, hf_dsi_requestid, tvb,
262 2, 2, dsi_requestid);
266 proto_tree_add_int(dsi_tree, hf_dsi_offset, tvb,
271 proto_tree_add_int(dsi_tree, hf_dsi_error, tvb,
275 proto_tree_add_uint_format_value(dsi_tree, hf_dsi_length, tvb,
277 "%u bytes", dsi_length);
278 proto_tree_add_uint(dsi_tree, hf_dsi_reserved, tvb,
279 12, 4, dsi_reserved);
282 switch (dsi_command) {
285 dissect_dsi_open_session(tvb, dsi_tree, DSI_BLOCKSIZ, dsi_length);
290 dissect_dsi_attention(tvb, dsi_tree, DSI_BLOCKSIZ);
294 if (tree && (dsi_flags == DSIFL_REPLY)) {
297 /* XXX - assumes only AFP runs atop DSI */
298 new_tvb = tvb_new_subset_remaining(tvb, DSI_BLOCKSIZ);
299 call_dissector(afp_server_status_handle, new_tvb, pinfo, dsi_tree);
307 aspinfo.reply = (dsi_flags == DSIFL_REPLY);
308 aspinfo.command = dsi_command;
309 aspinfo.seq = dsi_requestid;
310 aspinfo.code = dsi_code;
311 proto_item_set_len(dsi_ti, DSI_BLOCKSIZ);
313 new_tvb = tvb_new_subset_remaining(tvb, DSI_BLOCKSIZ);
314 call_dissector_with_data(afp_handle, new_tvb, pinfo, tree, &aspinfo);
318 call_dissector(data_handle,
319 tvb_new_subset_remaining(tvb, DSI_BLOCKSIZ),
324 return tvb_length(tvb);
328 get_dsi_pdu_len(packet_info *pinfo _U_, tvbuff_t *tvb, int offset, void *data _U_)
331 guint8 dsi_flags,dsi_command;
333 dsi_flags = tvb_get_guint8(tvb, offset);
334 dsi_command = tvb_get_guint8(tvb, offset+ 1);
335 if ( dsi_flags > DSIFL_MAX || !dsi_command || dsi_command > DSIFUNC_MAX)
337 /* it's not a known dsi pdu start sequence */
338 return tvb_length_remaining(tvb, offset);
342 * Get the length of the DSI packet.
344 plen = tvb_get_ntohl(tvb, offset+8);
347 * That length doesn't include the length of the header itself;
354 dissect_dsi(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data)
356 tcp_dissect_pdus(tvb, pinfo, tree, dsi_desegment, 12,
357 get_dsi_pdu_len, dissect_dsi_packet, data);
359 return tvb_length(tvb);
363 proto_register_dsi(void)
366 static hf_register_info hf[] = {
368 { "Flags", "dsi.flags",
369 FT_UINT8, BASE_HEX, VALS(flag_vals), 0x0,
370 "Indicates request or reply.", HFILL }},
373 { "Command", "dsi.command",
374 FT_UINT8, BASE_DEC|BASE_EXT_STRING, &func_vals_ext, 0x0,
375 "Represents a DSI command.", HFILL }},
378 { "Request ID", "dsi.requestid",
379 FT_UINT16, BASE_DEC, NULL, 0x0,
380 "Keeps track of which request this is. Replies must match a Request. IDs must be generated in sequential order.", HFILL }},
383 { "Data offset", "dsi.data_offset",
384 FT_INT32, BASE_DEC, NULL, 0x0,
388 { "Error code", "dsi.error_code",
389 FT_INT32, BASE_DEC|BASE_EXT_STRING, &asp_error_vals_ext, 0x0,
393 { "Length", "dsi.length",
394 FT_UINT32, BASE_DEC, NULL, 0x0,
395 "Total length of the data that follows the DSI header.", HFILL }},
398 { "Reserved", "dsi.reserved",
399 FT_UINT32, BASE_HEX, NULL, 0x0,
400 "Reserved for future use. Should be set to zero.", HFILL }},
403 { "Option", "dsi.open_type",
404 FT_UINT8, BASE_DEC, VALS(dsi_open_type_vals), 0x0,
405 "Open session option type.", HFILL }},
408 { "Length", "dsi.open_len",
409 FT_UINT8, BASE_DEC, NULL, 0x0,
410 "Open session option len", HFILL }},
412 { &hf_dsi_open_quantum,
413 { "Quantum", "dsi.open_quantum",
414 FT_UINT32, BASE_DEC, NULL, 0x0,
415 "Server/Attention quantum", HFILL }},
417 { &hf_dsi_replay_cache_size,
418 { "Replay", "dsi.replay_cache",
419 FT_UINT32, BASE_DEC, NULL, 0x0,
420 "Replay cache size", HFILL }},
422 { &hf_dsi_open_option,
423 { "Option", "dsi.open_option",
424 FT_BYTES, BASE_NONE, NULL, 0x0,
425 "Open session options (undecoded)", HFILL }},
428 { "Flags", "dsi.attn_flag",
429 FT_UINT16, BASE_HEX|BASE_EXT_STRING, &dsi_attn_flag_vals_ext, 0xf000,
430 "Server attention flag", HFILL }},
431 { &hf_dsi_attn_flag_shutdown,
432 { "Shutdown", "dsi.attn_flag.shutdown",
433 FT_BOOLEAN, 16, NULL, 1<<15,
434 "Attention flag, server is shutting down", HFILL }},
435 { &hf_dsi_attn_flag_crash,
436 { "Crash", "dsi.attn_flag.crash",
437 FT_BOOLEAN, 16, NULL, 1<<14,
438 "Attention flag, server crash bit", HFILL }},
439 { &hf_dsi_attn_flag_msg,
440 { "Message", "dsi.attn_flag.msg",
441 FT_BOOLEAN, 16, NULL, 1<<13,
442 "Attention flag, server message bit", HFILL }},
443 { &hf_dsi_attn_flag_reconnect,
444 { "Don't reconnect", "dsi.attn_flag.reconnect",
445 FT_BOOLEAN, 16, NULL, 1<<12,
446 "Attention flag, don't reconnect bit", HFILL }},
447 { &hf_dsi_attn_flag_time,
448 { "Minutes", "dsi.attn_flag.time",
449 FT_UINT16, BASE_DEC, NULL, 0xfff,
450 "Number of minutes", HFILL }},
451 { &hf_dsi_attn_flag_bitmap,
452 { "Bitmap", "dsi.attn_flag.bitmap",
453 FT_UINT16, BASE_HEX, NULL, 0xfff,
454 "Attention extended bitmap", HFILL }},
457 static gint *ett[] = {
463 module_t *dsi_module;
465 proto_dsi = proto_register_protocol("Data Stream Interface", "DSI", "dsi");
466 proto_register_field_array(proto_dsi, hf, array_length(hf));
467 proto_register_subtree_array(ett, array_length(ett));
469 dsi_module = prefs_register_protocol(proto_dsi, NULL);
470 prefs_register_bool_preference(dsi_module, "desegment",
471 "Reassemble DSI messages spanning multiple TCP segments",
472 "Whether the DSI dissector should reassemble messages spanning multiple TCP segments."
473 " To use this option, you must also enable \"Allow subdissectors to reassemble TCP streams\" in the TCP protocol settings.",
478 proto_reg_handoff_dsi(void)
480 dissector_handle_t dsi_handle;
482 dsi_handle = new_create_dissector_handle(dissect_dsi, proto_dsi);
483 dissector_add_uint("tcp.port", TCP_PORT_DSI, dsi_handle);
485 data_handle = find_dissector("data");
486 afp_handle = find_dissector("afp");
487 afp_server_status_handle = find_dissector("afp_server_status");
491 * Editor modelines - http://www.wireshark.org/tools/modelines.html
496 * indent-tabs-mode: t
499 * vi: set shiftwidth=8 tabstop=8 noexpandtab:
500 * :indentSize=8:tabSize=8:noTabs=false: