forked from osmocom/wireshark
268841f3e0
This patch introduces new APIs to allow dissectors to have a preference for a (TCP) port, but the underlying data is actually part of Decode As functionality. For now the APIs are intentionally separate from the regular APIs that register a dissector within a dissector table. It may be possible to eventually combine the two so that all dissectors that register with a dissector table have an opportunity to "automatically" have a preference to adjust the "table value" through the preferences dialog. The tcp.port dissector table was used as the guinea pig. This will eventually be expanded to other dissector tables as well (most notably UDP ports). Some dissectors that "shared" a TCP/UDP port preference were also converted. It also removed the need for some preference callback functions (mostly when the callback function was the proto_reg_handoff function) so there is cleanup around that. Dissectors that has a port preference whose default was 0 were switched to using the dissector_add_for_decode_as_with_preference API rather than dissector_add_uint_with_preference Also added comments for TCP ports used that aren't IANA registered. Change-Id: I99604f95d426ad345f4b494598d94178b886eb67 Reviewed-on: https://code.wireshark.org/review/17724 Reviewed-by: Michael Mann <mmann78@netscape.net>
569 lines
24 KiB
C
569 lines
24 KiB
C
/* packet-gearman.c
|
|
* Routines for Gearman protocol packet disassembly
|
|
* By Flier Lu <flier.lu@gmail.com>
|
|
* Copyright 2010 Flier Lu
|
|
*
|
|
* Gearman Protocol
|
|
* ----------------
|
|
* http://gearman.org/index.php?id=protocol
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <epan/packet.h>
|
|
#include <epan/prefs.h>
|
|
#include <epan/expert.h>
|
|
#include "packet-tcp.h"
|
|
|
|
void proto_register_gearman(void);
|
|
void proto_reg_handoff_gearman(void);
|
|
|
|
static int proto_gearman = -1;
|
|
|
|
static int hf_gearman_mgr_cmd = -1;
|
|
static int hf_gearman_magic_code = -1;
|
|
static int hf_gearman_pkt_type = -1;
|
|
static int hf_gearman_data_size = -1;
|
|
static int hf_gearman_data_content = -1;
|
|
static int hf_gearman_option_name = -1;
|
|
static int hf_gearman_func_name = -1;
|
|
static int hf_gearman_func_namez = -1;
|
|
static int hf_gearman_client_id = -1;
|
|
static int hf_gearman_uniq_id = -1;
|
|
static int hf_gearman_argument = -1;
|
|
static int hf_gearman_job_handle = -1;
|
|
static int hf_gearman_job_handlez = -1;
|
|
static int hf_gearman_complete_numerator = -1;
|
|
static int hf_gearman_complete_denominator = -1;
|
|
static int hf_gearman_submit_job_sched_minute = -1;
|
|
static int hf_gearman_submit_job_sched_hour = -1;
|
|
static int hf_gearman_submit_job_sched_day_of_month = -1;
|
|
static int hf_gearman_submit_job_sched_month = -1;
|
|
static int hf_gearman_submit_job_sched_day_of_week = -1;
|
|
static int hf_gearman_submit_job_epoch_time = -1;
|
|
static int hf_gearman_result = -1;
|
|
static int hf_gearman_known_status = -1;
|
|
static int hf_gearman_running_status = -1;
|
|
static int hf_gearman_echo_text = -1;
|
|
static int hf_gearman_err_code = -1;
|
|
static int hf_gearman_err_text = -1;
|
|
|
|
static gint ett_gearman = -1;
|
|
static gint ett_gearman_command = -1;
|
|
static gint ett_gearman_content = -1;
|
|
|
|
static expert_field ei_gearman_pkt_type_unknown = EI_INIT;
|
|
|
|
static gboolean gearman_desegment = TRUE;
|
|
|
|
static const int GEARMAN_COMMAND_HEADER_SIZE = 12;
|
|
static const int GEARMAN_PORT = 4730;
|
|
static const gchar *GEARMAN_MAGIC_CODE_REQUEST = "\0REQ";
|
|
static const gchar *GEARMAN_MAGIC_CODE_RESPONSE = "\0RES";
|
|
|
|
static const gchar *GEARMAN_MGR_CMDS[] = {
|
|
"workers",
|
|
"status",
|
|
"maxqueue",
|
|
"shutdown",
|
|
"version"
|
|
};
|
|
|
|
static const int GEARMAN_MGR_CMDS_COUNT = sizeof(GEARMAN_MGR_CMDS)/sizeof(GEARMAN_MGR_CMDS[0]);
|
|
|
|
typedef enum
|
|
{
|
|
GEARMAN_COMMAND_TEXT,
|
|
GEARMAN_COMMAND_CAN_DO, /* W->J: FUNC */
|
|
GEARMAN_COMMAND_CANT_DO, /* W->J: FUNC */
|
|
GEARMAN_COMMAND_RESET_ABILITIES, /* W->J: -- */
|
|
GEARMAN_COMMAND_PRE_SLEEP, /* W->J: -- */
|
|
GEARMAN_COMMAND_UNUSED,
|
|
GEARMAN_COMMAND_NOOP, /* J->W: -- */
|
|
GEARMAN_COMMAND_SUBMIT_JOB, /* C->J: FUNC[0]UNIQ[0]ARGS */
|
|
GEARMAN_COMMAND_JOB_CREATED, /* J->C: HANDLE */
|
|
GEARMAN_COMMAND_GRAB_JOB, /* W->J: -- */
|
|
GEARMAN_COMMAND_NO_JOB, /* J->W: -- */
|
|
GEARMAN_COMMAND_JOB_ASSIGN, /* J->W: HANDLE[0]FUNC[0]ARG */
|
|
GEARMAN_COMMAND_WORK_STATUS, /* W->J/C: HANDLE[0]NUMERATOR[0]DENOMINATOR */
|
|
GEARMAN_COMMAND_WORK_COMPLETE, /* W->J/C: HANDLE[0]RES */
|
|
GEARMAN_COMMAND_WORK_FAIL, /* W->J/C: HANDLE */
|
|
GEARMAN_COMMAND_GET_STATUS, /* C->J: HANDLE */
|
|
GEARMAN_COMMAND_ECHO_REQ, /* ?->J: TEXT */
|
|
GEARMAN_COMMAND_ECHO_RES, /* J->?: TEXT */
|
|
GEARMAN_COMMAND_SUBMIT_JOB_BG, /* C->J: FUNC[0]UNIQ[0]ARGS */
|
|
GEARMAN_COMMAND_ERROR, /* J->?: ERRCODE[0]ERR_TEXT */
|
|
GEARMAN_COMMAND_STATUS_RES, /* C->J: HANDLE[0]KNOWN[0]RUNNING[0]NUM[0]DENOM */
|
|
GEARMAN_COMMAND_SUBMIT_JOB_HIGH, /* C->J: FUNC[0]UNIQ[0]ARGS */
|
|
GEARMAN_COMMAND_SET_CLIENT_ID, /* W->J: [RANDOM_STRING_NO_WHITESPACE] */
|
|
GEARMAN_COMMAND_CAN_DO_TIMEOUT, /* W->J: FUNC[0]TIMEOUT */
|
|
GEARMAN_COMMAND_ALL_YOURS,
|
|
GEARMAN_COMMAND_WORK_EXCEPTION,
|
|
GEARMAN_COMMAND_OPTION_REQ,
|
|
GEARMAN_COMMAND_OPTION_RES,
|
|
GEARMAN_COMMAND_WORK_DATA,
|
|
GEARMAN_COMMAND_WORK_WARNING,
|
|
GEARMAN_COMMAND_GRAB_JOB_UNIQ,
|
|
GEARMAN_COMMAND_JOB_ASSIGN_UNIQ,
|
|
GEARMAN_COMMAND_SUBMIT_JOB_HIGH_BG,
|
|
GEARMAN_COMMAND_SUBMIT_JOB_LOW,
|
|
GEARMAN_COMMAND_SUBMIT_JOB_LOW_BG,
|
|
GEARMAN_COMMAND_SUBMIT_JOB_SCHED,
|
|
GEARMAN_COMMAND_SUBMIT_JOB_EPOCH,
|
|
GEARMAN_COMMAND_MAX /* Always add new commands before this. */
|
|
} gearman_command_t;
|
|
|
|
static const value_string gearman_command_names[] = {
|
|
{ GEARMAN_COMMAND_TEXT, "TEXT" },
|
|
{ GEARMAN_COMMAND_CAN_DO, "CAN_DO" }, /* W->J: FUNC */
|
|
{ GEARMAN_COMMAND_CANT_DO, "CANT_DO" }, /* W->J: FUNC */
|
|
{ GEARMAN_COMMAND_RESET_ABILITIES, "RESET_ABILITIES" }, /* W->J: -- */
|
|
{ GEARMAN_COMMAND_PRE_SLEEP, "PRE_SLEEP" }, /* W->J: -- */
|
|
{ GEARMAN_COMMAND_UNUSED, "UNUSED" },
|
|
{ GEARMAN_COMMAND_NOOP, "NOOP" }, /* J->W: -- */
|
|
{ GEARMAN_COMMAND_SUBMIT_JOB, "SUBMIT_JOB" }, /* C->J: FUNC[0]UNIQ[0]ARGS */
|
|
{ GEARMAN_COMMAND_JOB_CREATED, "JOB_CREATED" }, /* J->C: HANDLE */
|
|
{ GEARMAN_COMMAND_GRAB_JOB, "GRAB_JOB" }, /* W->J: -- */
|
|
{ GEARMAN_COMMAND_NO_JOB, "NO_JOB" }, /* J->W: -- */
|
|
{ GEARMAN_COMMAND_JOB_ASSIGN, "JOB_ASSIGN" }, /* J->W: HANDLE[0]FUNC[0]ARG */
|
|
{ GEARMAN_COMMAND_WORK_STATUS, "WORK_STATUS" }, /* W->J/C: HANDLE[0]NUMERATOR[0]DENOMINATOR */
|
|
{ GEARMAN_COMMAND_WORK_COMPLETE, "WORK_COMPLETE" }, /* W->J/C: HANDLE[0]RES */
|
|
{ GEARMAN_COMMAND_WORK_FAIL, "WORK_FAIL" }, /* W->J/C: HANDLE */
|
|
{ GEARMAN_COMMAND_GET_STATUS, "GET_STATUS" }, /* C->J: HANDLE */
|
|
{ GEARMAN_COMMAND_ECHO_REQ, "ECHO_REQ" }, /* ?->J: TEXT */
|
|
{ GEARMAN_COMMAND_ECHO_RES, "ECHO_RES" }, /* J->?: TEXT */
|
|
{ GEARMAN_COMMAND_SUBMIT_JOB_BG, "SUBMIT_JOB_BG" }, /* C->J: FUNC[0]UNIQ[0]ARGS */
|
|
{ GEARMAN_COMMAND_ERROR, "ERROR" }, /* J->?: ERRCODE[0]ERR_TEXT */
|
|
{ GEARMAN_COMMAND_STATUS_RES, "STATUS_RES" }, /* C->J: HANDLE[0]KNOWN[0]RUNNING[0]NUM[0]DENOM */
|
|
{ GEARMAN_COMMAND_SUBMIT_JOB_HIGH, "SUBMIT_JOB_HIGH" }, /* C->J: FUNC[0]UNIQ[0]ARGS */
|
|
{ GEARMAN_COMMAND_SET_CLIENT_ID, "SET_CLIENT_ID" }, /* W->J: [RANDOM_STRING_NO_WHITESPACE] */
|
|
{ GEARMAN_COMMAND_CAN_DO_TIMEOUT, "CAN_DO_TIMEOUT" }, /* W->J: FUNC[0]TIMEOUT */
|
|
{ GEARMAN_COMMAND_ALL_YOURS, "ALL_YOURS" },
|
|
{ GEARMAN_COMMAND_WORK_EXCEPTION, "WORK_EXCEPTION" },
|
|
{ GEARMAN_COMMAND_OPTION_REQ, "OPTION_REQ" },
|
|
{ GEARMAN_COMMAND_OPTION_RES, "OPTION_RES" },
|
|
{ GEARMAN_COMMAND_WORK_DATA, "WORK_DATA" },
|
|
{ GEARMAN_COMMAND_WORK_WARNING, "WORK_WARNING" },
|
|
{ GEARMAN_COMMAND_GRAB_JOB_UNIQ, "GRAB_JOB_UNIQ" },
|
|
{ GEARMAN_COMMAND_JOB_ASSIGN_UNIQ, "JOB_ASSIGN_UNIQ" },
|
|
{ GEARMAN_COMMAND_SUBMIT_JOB_HIGH_BG, "SUBMIT_JOB_HIGH_BG" },
|
|
{ GEARMAN_COMMAND_SUBMIT_JOB_LOW, "SUBMIT_JOB_LOW" },
|
|
{ GEARMAN_COMMAND_SUBMIT_JOB_LOW_BG, "SUBMIT_JOB_LOW_BG" },
|
|
{ GEARMAN_COMMAND_SUBMIT_JOB_SCHED, "SUBMIT_JOB_SCHED" },
|
|
{ GEARMAN_COMMAND_SUBMIT_JOB_EPOCH, "SUBMIT_JOB_EPOCH" },
|
|
{ 0, NULL}
|
|
};
|
|
|
|
static guint
|
|
get_gearman_pdu_len(packet_info *pinfo _U_, tvbuff_t *tvb, int offset, void *data _U_)
|
|
{
|
|
return tvb_get_ntohl(tvb, offset+8)+GEARMAN_COMMAND_HEADER_SIZE;
|
|
}
|
|
|
|
static int
|
|
dissect_binary_packet(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data _U_)
|
|
{
|
|
gint offset, start_offset;
|
|
char *magic_code;
|
|
guint32 type, size;
|
|
guint len;
|
|
proto_item *content_item = NULL;
|
|
proto_tree *content_tree = NULL;
|
|
|
|
col_set_str(pinfo->cinfo, COL_PROTOCOL, "Gearman");
|
|
col_clear(pinfo->cinfo,COL_INFO);
|
|
|
|
magic_code = tvb_get_string_enc(wmem_packet_scope(), tvb, 1, 3, ENC_ASCII);
|
|
type = tvb_get_ntohl(tvb, 4);
|
|
size = tvb_get_ntohl(tvb, 8);
|
|
|
|
col_append_sep_fstr(pinfo->cinfo, COL_INFO, " , ", "[%s] ", magic_code);
|
|
|
|
col_append_fstr(pinfo->cinfo, COL_INFO, "%s(%d) LEN=%d",
|
|
val_to_str(type, gearman_command_names, "Unknown (0x%08x)"), type, size);
|
|
|
|
if (tree) {
|
|
proto_item *ti;
|
|
proto_tree *command_tree, *gearman_tree;
|
|
ti = proto_tree_add_item(tree, proto_gearman, tvb, 0, -1, ENC_NA);
|
|
gearman_tree = proto_item_add_subtree(ti, ett_gearman);
|
|
|
|
command_tree = proto_tree_add_subtree_format(gearman_tree, tvb, 0, GEARMAN_COMMAND_HEADER_SIZE+size, ett_gearman_command, NULL,
|
|
"[%s] %s(%d) LEN=%d", magic_code, val_to_str(type, gearman_command_names, "Unknown (0x%08x)"), type, size);
|
|
|
|
proto_tree_add_string(command_tree, hf_gearman_magic_code, tvb, 0, 4, magic_code);
|
|
proto_tree_add_item(command_tree, hf_gearman_pkt_type, tvb, 4, 4, ENC_BIG_ENDIAN);
|
|
proto_tree_add_item(command_tree, hf_gearman_data_size, tvb, 8, 4, ENC_BIG_ENDIAN);
|
|
|
|
content_item = proto_tree_add_item(command_tree, hf_gearman_data_content, tvb, GEARMAN_COMMAND_HEADER_SIZE, size, ENC_ASCII|ENC_NA);
|
|
content_tree = proto_item_add_subtree(content_item, ett_gearman_content);
|
|
|
|
}
|
|
offset = GEARMAN_COMMAND_HEADER_SIZE;
|
|
|
|
switch(type)
|
|
{
|
|
case GEARMAN_COMMAND_ECHO_REQ:
|
|
case GEARMAN_COMMAND_ECHO_RES:
|
|
if (!tree) break;
|
|
proto_tree_add_item(content_tree, hf_gearman_echo_text, tvb,
|
|
offset, size, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_ERROR:
|
|
if (!tree) break;
|
|
len = tvb_strsize(tvb, offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_err_code, tvb, offset, len, ENC_NA|ENC_ASCII);
|
|
proto_tree_add_item(content_tree, hf_gearman_err_text, tvb, offset+len, size-len, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_JOB_CREATED:
|
|
case GEARMAN_COMMAND_WORK_FAIL:
|
|
if (!tree) break;
|
|
proto_tree_add_item(content_tree, hf_gearman_job_handle, tvb,
|
|
offset, size, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_STATUS_RES:
|
|
if (!tree) break;
|
|
start_offset = offset;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_job_handlez, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_known_status, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_running_status, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_complete_numerator, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
proto_tree_add_item(content_tree, hf_gearman_complete_denominator, tvb, start_offset+len, size-start_offset+GEARMAN_COMMAND_HEADER_SIZE, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_OPTION_REQ:
|
|
case GEARMAN_COMMAND_OPTION_RES:
|
|
if (!tree) break;
|
|
proto_tree_add_item(content_tree, hf_gearman_option_name, tvb,
|
|
offset, size, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_SUBMIT_JOB:
|
|
case GEARMAN_COMMAND_SUBMIT_JOB_BG:
|
|
case GEARMAN_COMMAND_SUBMIT_JOB_HIGH:
|
|
case GEARMAN_COMMAND_SUBMIT_JOB_HIGH_BG:
|
|
case GEARMAN_COMMAND_SUBMIT_JOB_LOW:
|
|
case GEARMAN_COMMAND_SUBMIT_JOB_LOW_BG:
|
|
if (!tree) break;
|
|
start_offset = offset;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_func_name, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_uniq_id, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
proto_tree_add_item(content_tree, hf_gearman_argument, tvb, start_offset+len, size-start_offset+GEARMAN_COMMAND_HEADER_SIZE, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_SUBMIT_JOB_SCHED:
|
|
if (!tree) break;
|
|
start_offset = offset;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_func_name, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_uniq_id, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_submit_job_sched_minute, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_submit_job_sched_hour, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_submit_job_sched_day_of_month, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_submit_job_sched_month, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_submit_job_sched_day_of_week, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
proto_tree_add_item(content_tree, hf_gearman_argument, tvb, start_offset+len, size-start_offset+GEARMAN_COMMAND_HEADER_SIZE, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_SUBMIT_JOB_EPOCH:
|
|
if (!tree) break;
|
|
start_offset = offset;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_func_name, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_uniq_id, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_submit_job_epoch_time, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
proto_tree_add_item(content_tree, hf_gearman_argument, tvb, start_offset+len, size-start_offset+GEARMAN_COMMAND_HEADER_SIZE, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_JOB_ASSIGN:
|
|
start_offset = offset;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_job_handlez, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_func_namez, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
proto_tree_add_item(content_tree, hf_gearman_argument, tvb, start_offset+len, size-start_offset+GEARMAN_COMMAND_HEADER_SIZE, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_JOB_ASSIGN_UNIQ:
|
|
start_offset = offset;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_job_handlez, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_func_namez, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_uniq_id, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
proto_tree_add_item(content_tree, hf_gearman_argument, tvb, start_offset+len, size-start_offset+GEARMAN_COMMAND_HEADER_SIZE, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_CAN_DO:
|
|
case GEARMAN_COMMAND_CANT_DO:
|
|
if (!tree) break;
|
|
proto_tree_add_item(content_tree, hf_gearman_func_name, tvb,
|
|
offset, size, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_CAN_DO_TIMEOUT:
|
|
if (!tree) break;
|
|
proto_tree_add_item(content_tree, hf_gearman_func_name, tvb,
|
|
offset, tvb_strsize(tvb, offset), ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_WORK_DATA:
|
|
case GEARMAN_COMMAND_WORK_WARNING:
|
|
case GEARMAN_COMMAND_WORK_COMPLETE:
|
|
case GEARMAN_COMMAND_WORK_EXCEPTION:
|
|
if (!tree) break;
|
|
len = tvb_strsize(tvb, offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_job_handlez, tvb, offset, len, ENC_NA|ENC_ASCII);
|
|
proto_tree_add_item(content_tree, hf_gearman_result, tvb, offset+len, size-len, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_WORK_STATUS:
|
|
if (!tree) break;
|
|
start_offset = offset;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_job_handlez, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
start_offset += len;
|
|
len = tvb_strsize(tvb, start_offset);
|
|
proto_tree_add_item(content_tree, hf_gearman_complete_numerator, tvb, start_offset, len, ENC_NA|ENC_ASCII);
|
|
|
|
proto_tree_add_item(content_tree, hf_gearman_complete_denominator, tvb, start_offset+len, size-start_offset+GEARMAN_COMMAND_HEADER_SIZE, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
case GEARMAN_COMMAND_SET_CLIENT_ID:
|
|
if (!tree) break;
|
|
proto_tree_add_item(content_tree, hf_gearman_client_id, tvb,
|
|
offset, size, ENC_NA|ENC_ASCII);
|
|
break;
|
|
|
|
default:
|
|
if (size > 0)
|
|
expert_add_info(pinfo, content_item, &ei_gearman_pkt_type_unknown);
|
|
}
|
|
|
|
col_set_fence(pinfo->cinfo, COL_INFO);
|
|
return tvb_captured_length(tvb);
|
|
}
|
|
|
|
static void
|
|
dissect_management_packet(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
|
|
{
|
|
int i, type = 0, cmdlen, linelen, offset = 0, next_offset = 0;
|
|
proto_item *ti;
|
|
proto_tree *gearman_tree;
|
|
|
|
col_set_str(pinfo->cinfo, COL_PROTOCOL, "Gearman");
|
|
col_clear(pinfo->cinfo, COL_INFO);
|
|
|
|
ti = proto_tree_add_item(tree, proto_gearman, tvb, 0, -1, ENC_NA);
|
|
gearman_tree = proto_item_add_subtree(ti, ett_gearman);
|
|
|
|
while ((linelen = tvb_find_line_end(tvb, offset, -1, &next_offset, FALSE)) > 0)
|
|
{
|
|
for (i=0; i<GEARMAN_MGR_CMDS_COUNT; i++)
|
|
{
|
|
/* the array is a const and clearly none of the elements are longer than
|
|
* MAX_SIGNED_INT so this is a safe cast */
|
|
cmdlen = (int)strlen(GEARMAN_MGR_CMDS[i]);
|
|
|
|
if (cmdlen == linelen && 0 == tvb_strneql(tvb, offset, GEARMAN_MGR_CMDS[i], cmdlen))
|
|
{
|
|
const guint8* cmdstr;
|
|
proto_tree_add_item_ret_string(gearman_tree, hf_gearman_mgr_cmd, tvb, offset, cmdlen, ENC_ASCII|ENC_NA, wmem_packet_scope(), &cmdstr);
|
|
col_add_fstr(pinfo->cinfo, COL_INFO, "[MGR] %s", cmdstr);
|
|
type = 1;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (GEARMAN_MGR_CMDS_COUNT == i)
|
|
{
|
|
proto_tree_add_format_text(gearman_tree, tvb, offset, next_offset - offset);
|
|
|
|
if (type == 0)
|
|
{
|
|
col_add_fstr(pinfo->cinfo, COL_INFO, "[MGR] %s", tvb_get_string_enc(wmem_packet_scope(), tvb, offset, linelen, ENC_ASCII));
|
|
type = -1;
|
|
}
|
|
else
|
|
{
|
|
col_append_sep_fstr(pinfo->cinfo, COL_INFO, ",", "%s", tvb_get_string_enc(wmem_packet_scope(), tvb, offset, linelen, ENC_ASCII));
|
|
}
|
|
}
|
|
|
|
offset = next_offset;
|
|
}
|
|
}
|
|
|
|
static int
|
|
dissect_gearman(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data)
|
|
{
|
|
if ((0 == tvb_memeql(tvb, 0, GEARMAN_MAGIC_CODE_REQUEST, 4)) ||
|
|
(0 == tvb_memeql(tvb, 0, GEARMAN_MAGIC_CODE_RESPONSE, 4)))
|
|
{
|
|
tcp_dissect_pdus(tvb, pinfo, tree, gearman_desegment, GEARMAN_COMMAND_HEADER_SIZE, get_gearman_pdu_len, dissect_binary_packet, data);
|
|
}
|
|
else
|
|
{
|
|
dissect_management_packet(tvb, pinfo, tree);
|
|
}
|
|
|
|
return tvb_captured_length(tvb);
|
|
}
|
|
|
|
void
|
|
proto_register_gearman(void)
|
|
{
|
|
static hf_register_info hf[] = {
|
|
{ &hf_gearman_mgr_cmd, { "Management Command", "gearman.mgr_cmd", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_gearman_magic_code, { "Magic Code", "gearman.magic_code", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL } },
|
|
{ &hf_gearman_pkt_type, { "Packet Type", "gearman.pkt_type", FT_UINT32, BASE_DEC_HEX, VALS(gearman_command_names), 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_data_size, { "Data Length", "gearman.data_size", FT_UINT32, BASE_DEC, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_data_content, { "Data Content", "gearman.data_content", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_option_name, { "Option Name", "gearman.opt.name", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_func_name, { "Function Name", "gearman.func.name", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_func_namez, { "Function Name", "gearman.func.name", FT_STRINGZ, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_client_id, { "Client ID", "gearman.client_id", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_uniq_id, { "Unique ID", "gearman.uniq_id", FT_STRINGZ, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_argument, { "Function Argument", "gearman.func.arg", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_job_handle, { "Job Handle", "gearman.job.handle", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_job_handlez, { "Job Handle", "gearman.job.handle", FT_STRINGZ, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_complete_numerator, { "Complete Numerator", "gearman.numerator", FT_STRINGZ, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_complete_denominator, { "Complete Denominator", "gearman.denominator", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_submit_job_sched_minute, { "Minute", "gearman.submit_job_sched.minute", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_submit_job_sched_hour, { "Hour", "gearman.submit_job_sched.hour", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_submit_job_sched_day_of_month, { "Day of Month", "gearman.submit_job_sched.day_of_month", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_submit_job_sched_month, { "Month", "gearman.submit_job_sched.month", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_submit_job_sched_day_of_week, { "Day of Week", "gearman.submit_job_sched.day_of_week", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_submit_job_epoch_time, { "Epoch Time", "gearman.submit_job.epoch_time", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_result, { "Function Result", "gearman.func.result", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_known_status, { "Known job", "gearman.job.known", FT_STRINGZ, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_running_status, { "Running Job", "gearman.job.running", FT_STRINGZ, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_echo_text, { "Echo Text", "gearman.echo_text", FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_err_code, { "Error Code", "gearman.err.code", FT_STRINGZ, BASE_NONE, NULL, 0x0, NULL, HFILL} },
|
|
{ &hf_gearman_err_text, { "Error Text", "gearman.err.text", FT_STRINGZ, BASE_NONE, NULL, 0x0, NULL, HFILL} }
|
|
};
|
|
|
|
/* Setup protocol subtree array */
|
|
static gint *ett[] = {
|
|
&ett_gearman,
|
|
&ett_gearman_command,
|
|
&ett_gearman_content
|
|
};
|
|
|
|
static ei_register_info ei[] = {
|
|
{ &ei_gearman_pkt_type_unknown, { "gearman.pkt_type.unknown", PI_PROTOCOL, PI_WARN, "Unknown command", EXPFILL }},
|
|
};
|
|
|
|
module_t *gearman_module;
|
|
expert_module_t* expert_gearman;
|
|
|
|
proto_gearman = proto_register_protocol("Gearman Protocol", "Gearman", "gearman");
|
|
|
|
proto_register_field_array(proto_gearman, hf, array_length(hf));
|
|
proto_register_subtree_array(ett, array_length(ett));
|
|
expert_gearman = expert_register_protocol(proto_gearman);
|
|
expert_register_field_array(expert_gearman, ei, array_length(ei));
|
|
|
|
gearman_module = prefs_register_protocol(proto_gearman, NULL);
|
|
prefs_register_bool_preference(gearman_module, "desegment",
|
|
"Desegment all Gearman messages spanning multiple TCP segments",
|
|
"Whether the Gearman dissector should desegment all messages spanning multiple TCP segments",
|
|
&gearman_desegment);
|
|
|
|
}
|
|
|
|
void
|
|
proto_reg_handoff_gearman(void)
|
|
{
|
|
dissector_handle_t gearman_handle;
|
|
|
|
gearman_handle = create_dissector_handle(dissect_gearman, proto_gearman);
|
|
dissector_add_uint_with_preference("tcp.port", GEARMAN_PORT, gearman_handle);
|
|
}
|
|
|
|
/*
|
|
* Editor modelines - http://www.wireshark.org/tools/modelines.html
|
|
*
|
|
* Local variables:
|
|
* c-basic-offset: 2
|
|
* tab-width: 8
|
|
* indent-tabs-mode: nil
|
|
* End:
|
|
*
|
|
* vi: set shiftwidth=2 tabstop=8 expandtab:
|
|
* :indentSize=2:tabSize=8:noTabs=true:
|
|
*/
|