--- /dev/null
+/* packet-quake3.c
+ * Routines for Quake III Arena packet dissection
+ *
+ * Uwe Girlich <uwe@planetquake.com>
+ *
+ * $Id: packet-quake3.c,v 1.1 2001/07/22 18:54:16 girlich Exp $
+ *
+ * Ethereal - Network traffic analyzer
+ * By Gerald Combs <gerald@zing.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * Copied from packet-quake2.c
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+
+/*
+ All informations used in this decoding were gathered from
+ * some own captures of a private server,
+ * the "Server commands howto" document written by id Software
+ (http://www.quake3arena.com/tech/ServerCommandsHowto.html)
+ * source code of the game server browser tool qstat
+ (http://www.qstat.org).
+*/
+
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#ifdef HAVE_SYS_TYPES_H
+# include <sys/types.h>
+#endif
+
+#include <string.h>
+#include <glib.h>
+#include "packet.h"
+#include "prefs.h"
+#include "resolv.h"
+
+static int proto_quake3 = -1;
+
+static int hf_quake3_direction = -1;
+static int hf_quake3_connectionless = -1;
+static int hf_quake3_game = -1;
+static int hf_quake3_connectionless_marker = -1;
+static int hf_quake3_connectionless_text = -1;
+static int hf_quake3_connectionless_command = -1;
+static int hf_quake3_server_addr = -1;
+static int hf_quake3_server_port = -1;
+static int hf_quake3_game_seq1 = -1;
+static int hf_quake3_game_rel1 = -1;
+static int hf_quake3_game_seq2 = -1;
+static int hf_quake3_game_rel2 = -1;
+static int hf_quake3_game_qport = -1;
+
+static gint ett_quake3 = -1;
+static gint ett_quake3_connectionless = -1;
+static gint ett_quake3_connectionless_text = -1;
+static gint ett_quake3_server = -1;
+static gint ett_quake3_game = -1;
+static gint ett_quake3_game_seq1 = -1;
+static gint ett_quake3_game_seq2 = -1;
+static gint ett_quake3_game_clc = -1;
+static gint ett_quake3_game_svc = -1;
+
+
+#define QUAKE3_SERVER_PORT 27960
+#define QUAKE3_MASTER_PORT 27950
+static unsigned int gbl_quake3_server_port=QUAKE3_SERVER_PORT;
+static unsigned int gbl_quake3_master_port=QUAKE3_MASTER_PORT;
+
+
+static const value_string names_direction[] = {
+#define DIR_UNKNOWN 0
+ { DIR_UNKNOWN, "Unknown" },
+#define DIR_C2S 1
+ { DIR_C2S, "Client to Server" },
+#define DIR_S2C 2
+ { DIR_S2C, "Server to Client" },
+#define DIR_C2M 3
+ { DIR_C2M, "Client to Master" },
+#define DIR_M2C 4
+ { DIR_M2C, "Master to Client" },
+ { 0, NULL }
+};
+
+
+#define string_starts_with(s1, s2) (strncmp((s1), (s2), strlen(s2)) == 0)
+
+
+static const value_string names_command[] = {
+#define COMMAND_UNKNOWN 0
+ { COMMAND_UNKNOWN, "Unknown" },
+#define COMMAND_statusResponse 1
+ { COMMAND_statusResponse, "Reply Status" },
+#define COMMAND_getstatus 2
+ { COMMAND_getstatus, "Request Status" },
+#define COMMAND_infoResponse 3
+ { COMMAND_infoResponse, "Reply Info" },
+#define COMMAND_getinfo 4
+ { COMMAND_getinfo, "Request Info" },
+#define COMMAND_challengeResponse 5
+ { COMMAND_challengeResponse, "Reply Challenge" },
+#define COMMAND_getchallenge 6
+ { COMMAND_getchallenge, "Request Challenge" },
+#define COMMAND_connectResponse 7
+ { COMMAND_connectResponse, "Reply Connect" },
+#define COMMAND_connect 8
+ { COMMAND_connect, "Request Connect" },
+#define COMMAND_rconResponse 9
+ { COMMAND_rconResponse, "Reply Remote Command" },
+#define COMMAND_rcon 10
+ { COMMAND_rcon, "Request Remote Command" },
+#define COMMAND_getmotdResponse 11
+ { COMMAND_getmotdResponse, "Reply Motto of the Day" },
+#define COMMAND_getmotd 12
+ { COMMAND_getmotd, "Request Motto of the Day" },
+#define COMMAND_getserversResponse 13
+ { COMMAND_getserversResponse, "Reply Servers" },
+#define COMMAND_getservers 14
+ { COMMAND_getservers, "Request Servers" },
+ { 0, NULL }
+};
+
+
+static void
+dissect_quake3_ConnectionlessPacket(tvbuff_t *tvb, packet_info *pinfo,
+ proto_tree *tree, int* direction)
+{
+ proto_tree *cl_tree = NULL;
+ proto_item *cl_item = NULL;
+ proto_item *text_item = NULL;
+ proto_tree *text_tree = NULL;
+ guint8 text[2048];
+ int maxbufsize = 0;
+ int len;
+ int offset;
+ guint32 marker;
+ int command;
+ int command_len;
+ int command_finished = FALSE;
+
+ marker = tvb_get_ntohl(tvb, 0);
+ if (tree) {
+ cl_item = proto_tree_add_text(tree, tvb,
+ 0, tvb_length(tvb), "Connectionless");
+ if (cl_item)
+ cl_tree = proto_item_add_subtree(
+ cl_item, ett_quake3_connectionless);
+ }
+
+ if (cl_tree) {
+ proto_tree_add_uint(cl_tree, hf_quake3_connectionless_marker,
+ tvb, 0, 4, marker);
+ }
+
+ /* all the rest of the packet is just text */
+ offset = 4;
+
+ maxbufsize = MIN((gint)sizeof(text), tvb_length_remaining(tvb, offset));
+ len = tvb_get_nstringz0(tvb, offset, maxbufsize, text);
+ if (cl_tree) {
+ text_item = proto_tree_add_string(cl_tree,
+ hf_quake3_connectionless_text,
+ tvb, offset, len + 1, text);
+ if (text_item) {
+ text_tree = proto_item_add_subtree(
+ text_item,
+ ett_quake3_connectionless_text);
+ }
+ }
+
+ command = COMMAND_UNKNOWN;
+ command_len = 0;
+
+ if (strncmp(text, "statusResponse", 14) == 0) {
+ command = COMMAND_statusResponse;
+ *direction = DIR_S2C;
+ command_len = 14;
+ }
+ else if (strncmp(text, "getstatus", 9) == 0) {
+ command = COMMAND_getstatus;
+ *direction = DIR_C2S;
+ command_len = 9;
+ }
+ else if (strncmp(text, "infoResponse", 12) == 0) {
+ command = COMMAND_infoResponse;
+ *direction = DIR_S2C;
+ command_len = 12;
+
+ }
+ else if (strncmp(text, "getinfo", 7) == 0) {
+ command = COMMAND_getinfo;
+ *direction = DIR_C2S;
+ command_len = 7;
+ }
+ else if (strncmp(text, "challengeResponse", 17) == 0) {
+ command = COMMAND_challengeResponse;
+ *direction = DIR_S2C;
+ command_len = 17;
+ }
+ else if (strncmp(text, "getchallenge", 12) == 0) {
+ command = COMMAND_getchallenge;
+ *direction = DIR_C2S;
+ command_len = 12;
+ }
+ else if (strncmp(text, "connectResponse", 15) == 0) {
+ command = COMMAND_connectResponse;
+ *direction = DIR_S2C;
+ command_len = 15;
+
+ }
+ else if (strncmp(text, "connect", 7) == 0) {
+ command = COMMAND_connect;
+ *direction = DIR_C2S;
+ command_len = 7;
+ }
+ else if (strncmp(text, "rconResponse", 12) == 0) {
+ command = COMMAND_rconResponse;
+ *direction = DIR_S2C;
+ command_len = 12;
+ }
+ else if (strncmp(text, "rcon", 4) == 0) {
+ command = COMMAND_rcon;
+ *direction = DIR_C2S;
+ command_len = 4;
+ }
+ else if (strncmp(text, "getmotdResponse", 15) == 0) {
+ command = COMMAND_getmotdResponse;
+ *direction = DIR_M2C;
+ command_len = 15;
+ }
+ else if (strncmp(text, "getmotd", 7) == 0) {
+ command = COMMAND_getmotd;
+ *direction = DIR_C2M;
+ command_len = 7;
+ }
+ else if (strncmp(text, "getserversResponse", 18) == 0) {
+ int base;
+ command = COMMAND_getserversResponse;
+ *direction = DIR_M2C;
+ command_len = 18;
+ /* The data can contain 0's, and the text string is binary
+ anyway, so better replace the text string after the first
+ \ with "<DATA>". */
+ if (text_item) {
+ /* first correct the length until the end of the packet */
+ proto_item_set_len(text_item, tvb_length_remaining(tvb, offset));
+ /* then replace the text */
+ proto_item_set_text(text_item, "Text: getserversResponse<DATA>");
+ }
+ proto_tree_add_string(text_tree, hf_quake3_connectionless_command,
+ tvb, offset, command_len,
+ val_to_str(command, names_command, "Unknown"));
+ command_finished = TRUE;
+
+ /* now we decode all the rest */
+ base = offset + 18;
+ /* '/' IP.IP.IP.IP PORTLO PORTHI */
+ while (tvb_length_remaining(tvb, base) >= 7) {
+ guint32 ip_addr;
+ guint16 udp_port;
+ proto_item *server_item = NULL;
+ proto_tree *server_tree = NULL;
+
+ ip_addr = tvb_get_ntohl(tvb, base + 1);
+ udp_port = tvb_get_ntohs(tvb, base + 5);
+
+ /* It may be a good idea to create a conversation for
+ every server in this list, as we'll see at
+ least a getinfo request to each of them and they
+ may run on totally unusual ports. */
+
+ if (text_tree) {
+ server_item = proto_tree_add_text(text_tree,
+ tvb, base, 7,
+ "Server: %s:%u",
+ get_hostname(htonl(ip_addr)),
+ udp_port);
+ if (server_item)
+ server_tree = proto_item_add_subtree(
+ server_item,
+ ett_quake3_server);
+ }
+ if (server_tree) {
+ /* I'm not sure about all this ordering stuff
+ but so it works on my (le) machine */
+ proto_tree_add_ipv4(server_tree, hf_quake3_server_addr,
+ tvb, base + 1, 4, htonl(ip_addr));
+ proto_tree_add_uint(server_tree, hf_quake3_server_port,
+ tvb, base + 5, 2, udp_port);
+ }
+
+ base += 7;
+ }
+ }
+ else if (strncmp(text, "getservers", 10) == 0) {
+ command = COMMAND_getservers;
+ *direction = DIR_C2M;
+ command_len = 10;
+ }
+ else {
+ *direction = DIR_UNKNOWN;
+ }
+
+ if (text_tree && command_finished == FALSE) {
+ proto_tree_add_string(text_tree, hf_quake3_connectionless_command,
+ tvb, offset, command_len,
+ val_to_str(command, names_command, "Unknown"));
+ }
+
+ offset += len + 1;
+
+}
+
+
+static void
+dissect_quake3_client_commands(tvbuff_t *tvb, packet_info *pinfo,
+ proto_tree *tree)
+{
+ /* this shouldn't be too difficult */
+ dissect_data(tvb, 0, pinfo, tree);
+}
+
+
+static void
+dissect_quake3_server_commands(tvbuff_t *tvb, packet_info *pinfo,
+ proto_tree *tree)
+{
+ /* It is totally forbidden to decode this any further,
+ I wont do it. */
+ dissect_data(tvb, 0, pinfo, tree);
+}
+
+
+static const value_string names_reliable[] = {
+ { 0, "Non Reliable" },
+ { 1, "Reliable" },
+ { 0, NULL }
+};
+
+
+static void
+dissect_quake3_GamePacket(tvbuff_t *tvb, packet_info *pinfo,
+ proto_tree *tree, int *direction)
+{
+ proto_tree *game_tree = NULL;
+ proto_item *game_item = NULL;
+ guint32 seq1;
+ guint32 seq2;
+ int rel1;
+ int rel2;
+ int offset;
+ guint rest_length;
+
+ *direction = (pinfo->destport == gbl_quake3_server_port) ?
+ DIR_C2S : DIR_S2C;
+
+ if (tree) {
+ game_item = proto_tree_add_text(tree, tvb,
+ 0, tvb_length(tvb), "Game");
+ if (game_item)
+ game_tree = proto_item_add_subtree(
+ game_item, ett_quake3_game);
+ }
+
+ offset = 0;
+
+ seq1 = tvb_get_letohs(tvb, offset);
+ rel1 = seq1 & 0x8000 ? 1 : 0;
+ seq1 &= ~0x8000;
+ if (game_tree) {
+ proto_item *seq1_item = proto_tree_add_text(game_tree,
+ tvb, offset, 2, "Current Sequence: %u (%s)",
+ seq1, val_to_str(rel1,names_reliable,"%u"));
+ if (seq1_item) {
+ proto_tree *seq1_tree = proto_item_add_subtree(
+ seq1_item, ett_quake3_game_seq1);
+ proto_tree_add_uint(seq1_tree, hf_quake3_game_seq1,
+ tvb, offset, 2, seq1);
+ proto_tree_add_boolean(seq1_tree, hf_quake3_game_rel1,
+ tvb, offset+1, 1, rel1);
+ }
+ }
+ offset += 2;
+
+ seq2 = tvb_get_letohs(tvb, offset);
+ rel2 = seq2 & 0x8000 ? 1 : 0;
+ seq2 &= ~0x8000;
+ if (game_tree) {
+ proto_item *seq2_item = proto_tree_add_text(game_tree,
+ tvb, offset, 2, "Acknowledge Sequence: %u (%s)",
+ seq2, val_to_str(rel2,names_reliable,"%u"));;
+ if (seq2_item) {
+ proto_tree *seq2_tree = proto_item_add_subtree(
+ seq2_item, ett_quake3_game_seq2);
+ proto_tree_add_uint(seq2_tree, hf_quake3_game_seq2,
+ tvb, offset, 2, seq2);
+ proto_tree_add_boolean(seq2_tree, hf_quake3_game_rel2,
+ tvb, offset+1, 1, rel2);
+ }
+ }
+ offset += 2;
+
+ if (*direction == DIR_C2S) {
+ /* client to server */
+ guint16 qport = tvb_get_letohs(tvb, offset);
+ if (game_tree) {
+ proto_tree_add_uint(game_tree, hf_quake3_game_qport,
+ tvb, offset, 2, qport);
+ }
+ offset +=2;
+ }
+
+ /* all the rest is pure game data */
+ rest_length = tvb_reported_length(tvb) - offset;
+ if (rest_length) {
+ tvbuff_t *next_tvb =
+ tvb_new_subset(tvb, offset, rest_length , rest_length);
+
+ if (*direction == DIR_C2S) {
+ proto_item *c_item = NULL;
+ proto_tree *c_tree = NULL;
+ if (tree) {
+ c_item = proto_tree_add_text(game_tree, next_tvb,
+ 0, tvb_length(next_tvb),
+ "Client Commands");
+ if (c_item) {
+ c_tree = proto_item_add_subtree(
+ c_item, ett_quake3_game_clc);
+ }
+ }
+ dissect_quake3_client_commands(next_tvb, pinfo, c_tree);
+ }
+ else {
+ proto_item *c_item = NULL;
+ proto_tree *c_tree = NULL;
+ if (tree) {
+ c_item = proto_tree_add_text(game_tree, next_tvb,
+ 0, tvb_length(next_tvb),
+ "Server Commands");
+ if (c_item) {
+ c_tree = proto_item_add_subtree(
+ c_item, ett_quake3_game_svc);
+ }
+ }
+ dissect_quake3_server_commands(next_tvb, pinfo, c_tree);
+ }
+ }
+}
+
+
+static void
+dissect_quake3(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
+{
+ proto_tree *quake3_tree = NULL;
+ proto_item *quake3_item = NULL;
+ proto_item *dir_item = NULL;
+ int direction;
+
+ direction = DIR_UNKNOWN;
+
+ pinfo->current_proto = "QUAKE3";
+
+ if (check_col(pinfo->fd, COL_PROTOCOL))
+ col_set_str(pinfo->fd, COL_PROTOCOL, "QUAKE3");
+
+ if (tree) {
+ quake3_item = proto_tree_add_item(tree, proto_quake3,
+ tvb, 0, tvb_length(tvb), FALSE);
+ if (quake3_item)
+ quake3_tree = proto_item_add_subtree(
+ quake3_item, ett_quake3);
+
+ if (quake3_tree) {
+ dir_item = proto_tree_add_none_format(
+ quake3_tree,
+ hf_quake3_direction, tvb, 0, 0,
+ "Direction: %s",
+ val_to_str(direction,
+ names_direction, "%u"));
+ }
+ }
+
+ if (tvb_get_ntohl(tvb, 0) == 0xffffffff) {
+ if (check_col(pinfo->fd, COL_INFO)) {
+ col_set_str(pinfo->fd, COL_INFO, "Connectionless ");
+ }
+ if (quake3_tree)
+ proto_tree_add_uint_format(quake3_tree,
+ hf_quake3_connectionless,
+ tvb, 0, 0, 1,
+ "Type: Connectionless");
+ dissect_quake3_ConnectionlessPacket(
+ tvb, pinfo, quake3_tree, &direction);
+ }
+ else {
+ if (check_col(pinfo->fd, COL_INFO)) {
+ col_set_str(pinfo->fd, COL_INFO, "Game ");
+ }
+ if (quake3_tree)
+ proto_tree_add_uint_format(quake3_tree,
+ hf_quake3_game,
+ tvb, 0, 0, 1,
+ "Type: Game");
+ dissect_quake3_GamePacket(
+ tvb, pinfo, quake3_tree, &direction);
+ }
+ if (direction != DIR_UNKNOWN && dir_item)
+ proto_item_set_text(dir_item,
+ "Direction: %s",
+ val_to_str(direction,
+ names_direction, "%u"));
+
+ if (check_col(pinfo->fd, COL_INFO))
+ col_append_str(pinfo->fd, COL_INFO, val_to_str(direction,
+ names_direction, "%u"));
+}
+
+
+void
+proto_reg_handoff_quake3(void)
+{
+ static int initialized=FALSE;
+ static int server_port;
+ static int master_port;
+ int i;
+
+ if (initialized) {
+ for (i=0;i<4;i++)
+ dissector_delete("udp.port", server_port+i, dissect_quake3);
+ for (i=0;i<4;i++)
+ dissector_delete("udp.port", master_port+i, dissect_quake3);
+ } else {
+ initialized=TRUE;
+ }
+
+ /* set port for future deletes */
+ server_port = gbl_quake3_server_port;
+ master_port = gbl_quake3_master_port;
+
+ /* add dissectors */
+ for (i=0;i<4;i++)
+ dissector_add("udp.port", gbl_quake3_server_port + i,
+ dissect_quake3, proto_quake3);
+ for (i=0;i<4;i++)
+ dissector_add("udp.port", gbl_quake3_master_port + i,
+ dissect_quake3, proto_quake3);
+}
+
+
+void
+proto_register_quake3(void)
+{
+ static hf_register_info hf[] = {
+ { &hf_quake3_direction,
+ { "Direction", "quake3.direction",
+ FT_NONE, BASE_DEC, NULL, 0x0,
+ "Packet Direction", HFILL }},
+ { &hf_quake3_connectionless,
+ { "Connectionless", "quake3.connectionless",
+ FT_UINT32, BASE_DEC, NULL, 0x0,
+ "Connectionless", HFILL }},
+ { &hf_quake3_game,
+ { "Game", "quake3.game",
+ FT_UINT32, BASE_DEC, NULL, 0x0,
+ "Game", HFILL }},
+ { &hf_quake3_connectionless_marker,
+ { "Marker", "quake3.connectionless.marker",
+ FT_UINT32, BASE_HEX, NULL, 0x0,
+ "Marker", HFILL }},
+ { &hf_quake3_connectionless_text,
+ { "Text", "quake3.connectionless.text",
+ FT_STRING, BASE_DEC, NULL, 0x0,
+ "Text", HFILL }},
+ { &hf_quake3_connectionless_command,
+ { "Command", "quake3.connectionless.command",
+ FT_STRING, BASE_DEC, NULL, 0x0,
+ "Command", HFILL }},
+ { &hf_quake3_server_addr,
+ { "Server Address", "quake3.server.addr",
+ FT_IPv4, BASE_DEC, NULL, 0x0,
+ "Server IP Address", HFILL }},
+ { &hf_quake3_server_port,
+ { "Server Port", "quake3.server.port",
+ FT_UINT16, BASE_DEC, NULL, 0x0,
+ "Server UDP Port", HFILL }},
+ { &hf_quake3_game_seq1,
+ { "Sequence Number", "quake3.game.seq1",
+ FT_UINT32, BASE_DEC, NULL, 0x0,
+ "Sequence number of the current packet", HFILL }},
+ { &hf_quake3_game_rel1,
+ { "Reliable", "quake3.game.rel1",
+ FT_BOOLEAN, BASE_DEC, NULL, 0x0,
+ "Packet is reliable and may be retransmitted", HFILL }},
+ { &hf_quake3_game_seq2,
+ { "Sequence Number", "quake3.game.seq2",
+ FT_UINT32, BASE_DEC, NULL, 0x0,
+ "Sequence number of the last received packet", HFILL }},
+ { &hf_quake3_game_rel2,
+ { "Reliable", "quake3.game.rel2",
+ FT_BOOLEAN, BASE_DEC, NULL, 0x0,
+ "Packet was reliable and may be retransmitted", HFILL }},
+ { &hf_quake3_game_qport,
+ { "QPort", "quake3.game.qport",
+ FT_UINT32, BASE_DEC, NULL, 0x0,
+ "Quake III Arena Client Port", HFILL }}
+ };
+ static gint *ett[] = {
+ &ett_quake3,
+ &ett_quake3_connectionless,
+ &ett_quake3_connectionless_text,
+ &ett_quake3_server,
+ &ett_quake3_game,
+ &ett_quake3_game_seq1,
+ &ett_quake3_game_seq2,
+ &ett_quake3_game_clc,
+ &ett_quake3_game_svc
+ };
+ module_t *quake3_module;
+
+ proto_quake3 = proto_register_protocol("Quake III Arena Network Protocol",
+ "QUAKE3", "quake3");
+ proto_register_field_array(proto_quake3, hf, array_length(hf));
+ proto_register_subtree_array(ett, array_length(ett));
+
+ /* Register a configuration option for port */
+ quake3_module = prefs_register_protocol(proto_quake3,
+ proto_reg_handoff_quake3);
+ prefs_register_uint_preference(quake3_module, "udp.port",
+ "Quake III Arena Server UDP Base Port",
+ "Set the UDP base port for the Quake III Arena Server",
+ 10, &gbl_quake3_server_port);
+ prefs_register_uint_preference(quake3_module, "udp.port",
+ "Quake III Arena Master Server UDP Base Port",
+ "Set the UDP base port for the Quake III Arena Master Server",
+ 10, &gbl_quake3_master_port);
+}
+
git.samba.org / obnox / wireshark / wip.git / commitdiff