wireshark/epan/dissectors/packet-whois.c
Michael Mann 268841f3e0 Combine Decode As and port preferences for tcp.port dissector table.
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>
2016-10-08 02:44:53 +00:00

222 lines
7.5 KiB
C

/* packet-whois.c
* Routines for whois dissection (see http://tools.ietf.org/html/rfc3912)
* Copyright 2013, Christopher Maynard <Christopher.Maynard@gtech.com>
*
* 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/conversation.h>
#include <epan/expert.h>
#define WHOIS_PORT 43 /* This is the registered IANA port (nicname) */
void proto_register_whois(void);
void proto_reg_handoff_whois(void);
static int proto_whois = -1;
static int hf_whois_query = -1;
static int hf_whois_answer = -1;
static int hf_whois_answer_in = -1;
static int hf_whois_answer_to = -1;
static int hf_whois_response_time = -1;
static expert_field ei_whois_nocrlf = EI_INIT;
static gint ett_whois = -1;
typedef struct _whois_transaction_t {
guint32 req_frame;
guint32 rep_frame;
nstime_t req_time;
} whois_transaction_t;
static int
dissect_whois(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree,
void *data _U_)
{
proto_item *ti, *expert_ti;
proto_tree *whois_tree;
conversation_t *conversation;
whois_transaction_t *whois_trans;
gboolean is_query;
guint len;
col_set_str(pinfo->cinfo, COL_PROTOCOL, "WHOIS");
if (pinfo->destport == WHOIS_PORT) {
is_query = TRUE;
col_set_str(pinfo->cinfo, COL_INFO, "Query");
} else {
is_query = FALSE;
col_set_str(pinfo->cinfo, COL_INFO, "Answer");
}
conversation = find_or_create_conversation(pinfo);
whois_trans = (whois_transaction_t *)conversation_get_proto_data(conversation, proto_whois);
if (whois_trans == NULL) {
whois_trans = wmem_new0(wmem_file_scope(), whois_transaction_t);
conversation_add_proto_data(conversation, proto_whois, whois_trans);
}
len = tvb_reported_length(tvb);
if (!PINFO_FD_VISITED(pinfo)) {
if (pinfo->can_desegment) {
if (is_query) {
if ((len < 2) || (tvb_memeql(tvb, len - 2, "\r\n", 2))) {
pinfo->desegment_len = DESEGMENT_ONE_MORE_SEGMENT;
pinfo->desegment_offset = 0;
return -1;
} else {
whois_trans->req_frame = pinfo->num;
whois_trans->req_time = pinfo->abs_ts;
}
} else {
pinfo->desegment_len = DESEGMENT_UNTIL_FIN;
pinfo->desegment_offset = 0;
return -1;
}
}
} else if (is_query && (whois_trans->req_frame == 0)) {
whois_trans->req_frame = pinfo->num;
whois_trans->req_time = pinfo->abs_ts;
}
if (!is_query && (whois_trans->rep_frame == 0)) {
/* By comparing whois_trans->rep_frame to 0, if reassembly is turned
* on, whois_trans->rep_frame will be assigned to the reassembled frame
* number, and if reassembly is turned off, whois_trans->rep_frame will
* be assigned to the first frame number of the response. This seems
* to match other protocols' behavior. The alternative is:
* if (pinfo->num > whois_trans->rep_frame)
* which will give us the same frame number either way.
*/
whois_trans->rep_frame = pinfo->num;
}
ti = proto_tree_add_protocol_format(tree, proto_whois, tvb, 0, -1,
"WHOIS: %s", is_query ? "Query" : "Answer");
whois_tree = proto_item_add_subtree(ti, ett_whois);
if (is_query) {
expert_ti = proto_tree_add_item(whois_tree, hf_whois_query, tvb, 0, -1, ENC_ASCII|ENC_NA);
if ((len < 2) || (tvb_memeql(tvb, len - 2, "\r\n", 2))) {
/*
* From RFC3912, section 2:
* All requests are terminated with ASCII CR and then ASCII LF.
*/
expert_add_info(pinfo, expert_ti, &ei_whois_nocrlf);
}
if (tree && whois_trans->rep_frame) {
ti = proto_tree_add_uint(whois_tree, hf_whois_answer_in,
tvb, 0, 0, whois_trans->rep_frame);
PROTO_ITEM_SET_GENERATED(ti);
}
} else if (tree && whois_trans->rep_frame) {
proto_tree_add_item(whois_tree, hf_whois_answer, tvb, 0, -1, ENC_ASCII|ENC_NA);
if (whois_trans->req_frame) {
nstime_t ns;
ti = proto_tree_add_uint(whois_tree, hf_whois_answer_to,
tvb, 0, 0, whois_trans->req_frame);
PROTO_ITEM_SET_GENERATED(ti);
if (pinfo->num == whois_trans->rep_frame) {
nstime_delta(&ns, &pinfo->abs_ts, &whois_trans->req_time);
ti = proto_tree_add_time(whois_tree, hf_whois_response_time, tvb, 0, 0, &ns);
PROTO_ITEM_SET_GENERATED(ti);
}
}
}
return tvb_captured_length(tvb);
}
void
proto_register_whois(void)
{
expert_module_t *expert_whois;
static hf_register_info hf[] = {
{ &hf_whois_query,
{ "Query", "whois.query", FT_STRING, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_whois_answer,
{ "Answer", "whois.answer", FT_STRING, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_whois_answer_in,
{ "Answer In", "whois.answer_in", FT_FRAMENUM, BASE_NONE, NULL,
0x0, "The answer to this WHOIS query is in this frame",
HFILL }
},
{ &hf_whois_answer_to,
{ "Query In", "whois.answer_to", FT_FRAMENUM, BASE_NONE, NULL,
0x0, "This is the answer to the WHOIS query in this frame",
HFILL }
},
{ &hf_whois_response_time,
{ "Response Time", "whois.response_time", FT_RELATIVE_TIME,
BASE_NONE, NULL, 0x0,
"The time between the Query and the Answer", HFILL }
}
};
static gint *ett[] = {
&ett_whois
};
static ei_register_info ei[] = {
{ &ei_whois_nocrlf,
{ "whois.nocrlf", PI_MALFORMED, PI_WARN, "Missing <CR><LF>", EXPFILL}
}
};
proto_whois = proto_register_protocol("whois", "WHOIS", "whois");
proto_register_field_array(proto_whois, hf, array_length(hf));
proto_register_subtree_array(ett, array_length(ett));
expert_whois = expert_register_protocol(proto_whois);
expert_register_field_array(expert_whois, ei, array_length(ei));
}
void
proto_reg_handoff_whois(void)
{
static dissector_handle_t whois_handle;
whois_handle = create_dissector_handle(dissect_whois, proto_whois);
dissector_add_uint_with_preference("tcp.port", WHOIS_PORT, whois_handle);
}
/*
* Editor modelines - http://www.wireshark.org/tools/modelines.html
*
* Local variables:
* c-basic-offset: 4
* tab-width: 8
* indent-tabs-mode: nil
* End:
*
* vi: set shiftwidth=4 tabstop=8 expandtab:
* :indentSize=4:tabSize=8:noTabs=true:
*/