aboutsummaryrefslogtreecommitdiffstats
path: root/plugins
diff options
context:
space:
mode:
authorSeth Alexander <seth.alexander@cosmicaes.com>2016-11-01 09:42:46 -0700
committerMichael Mann <mmann78@netscape.net>2016-11-22 14:18:22 +0000
commit3e1828e35188e1987554b50ed2451de90398b5af (patch)
tree65d2c708f4df40a70d9ba0985c02541c0a320c47 /plugins
parentfe38577409e1cf5c1eb9c45f27bfa51e607fa270 (diff)
Added Path Value and CRC to DOCSIS Plugin
DOCSIS update with basic defragmentation Bug: 13106 Change-Id: Idbb42c80b87c0c3189da087b523733cf0b19967c Reviewed-on: https://code.wireshark.org/review/18676 Petri-Dish: Michael Mann <mmann78@netscape.net> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Michael Mann <mmann78@netscape.net>
Diffstat (limited to 'plugins')
-rw-r--r--plugins/docsis/packet-docsis.c1168
1 files changed, 747 insertions, 421 deletions
diff --git a/plugins/docsis/packet-docsis.c b/plugins/docsis/packet-docsis.c
index a498d83379..74532bc806 100644
--- a/plugins/docsis/packet-docsis.c
+++ b/plugins/docsis/packet-docsis.c
@@ -44,41 +44,67 @@
#include "config.h"
+#include <epan/etypes.h>
+#include <epan/expert.h>
#include <epan/packet.h>
+#include <epan/prefs.h>
+#include <epan/reassemble.h>
#include <wiretap/wtap.h>
#include <epan/exceptions.h>
+#include <epan/crc16-tvb.h>
+#include <epan/crc32-tvb.h>
void proto_register_docsis(void);
void proto_reg_handoff_docsis(void);
-#define FCTYPE_PACKET 0x00
-#define FCTYPE_ATMPDU 0x01
-#define FCTYPE_RESRVD 0x02
-#define FCTYPE_MACSPC 0x03
-
-#define EH_NULL_CONFIG 0
-#define EH_REQUEST 1
-#define EH_ACK_REQ 2
-#define EH_BP_UP 3
-#define EH_BP_DOWN 4
-#define EH_SFLOW_HDR_DOWN 5
-#define EH_SFLOW_HDR_UP 6
-#define EH_BP_UP2 7
-#define EH_DS_SERVICE 8
-#define EH_RESERVED_9 9
-#define EH_RESERVED_10 10
-#define EH_RESERVED_11 11
-#define EH_RESERVED_12 12
-#define EH_RESERVED_13 13
-#define EH_RESERVED_14 14
-#define EH_EXTENDED 15
+/* Assume all packets have an FCS */
+static gboolean docsis_check_fcs = TRUE;
+
+#define DOCSIS_MIN_HEADER_LEN 6
+
+#define FCTYPE_PACKET 0x00
+#define FCTYPE_RESERVED 0x01
+#define FCTYPE_ISOLAT 0x02
+#define FCTYPE_MACSPC 0x03
+
+#define FCPARM_TIMING_HDR 0x00
+#define FCPARM_MAC_MGMT_HDR 0x01
+#define FCPARM_RQST_FRM 0x02
+#define FCPARM_FRAG_HDR 0x03
+#define FCPARM_QUEUE_DEPTH_REQ_FRM 0x04
+#define FCPARM_CONCAT_HDR 0x1C
+
+#define EXT_HDR_OFF 0x00
+#define EXT_HDR_ON 0x01
+
+#define FRAG_FCS_LEN 4
+#define FRAG_FIRST 0x20
+#define FRAG_MIDDLE 0x00
+#define FRAG_LAST 0x10
+
+#define EH_NULL_CONFIG 0
+#define EH_REQUEST 1
+#define EH_ACK_REQ 2
+#define EH_BP_UP 3
+#define EH_BP_DOWN 4
+#define EH_SFLOW_HDR_DOWN 5
+#define EH_SFLOW_HDR_UP 6
+#define EH_BP_UP2 7
+#define EH_DS_SERVICE 8
+#define EH_PATH_VERIFY 9
+#define EH_RESERVED_10 10
+#define EH_RESERVED_11 11
+#define EH_RESERVED_12 12
+#define EH_RESERVED_13 13
+#define EH_RESERVED_14 14
+#define EH_EXTENDED 15
/* Initialize the protocol and registered fields */
static int proto_docsis = -1;
static int hf_docsis_fctype = -1;
static int hf_docsis_machdr_fcparm = -1;
static int hf_docsis_fcparm = -1;
-static int hf_docsis_ehdron = -1;
+static int hf_docsis_exthdr = -1;
static int hf_docsis_concat_cnt = -1;
static int hf_docsis_macparm = -1;
static int hf_docsis_ehdrlen = -1;
@@ -94,6 +120,7 @@ static int hf_docsis_sid = -1;
static int hf_docsis_mini_slots = -1;
static int hf_docsis_requested_size = -1;
static int hf_docsis_hcs = -1;
+static int hf_docsis_hcs_status = -1;
static int hf_docsis_bpi_en = -1;
static int hf_docsis_toggle_bit = -1;
static int hf_docsis_key_seq = -1;
@@ -112,6 +139,23 @@ static int hf_docsis_ehdr_bpup2_toggle_bit = -1;
static int hf_docsis_ehdr_bpup2_key_seq = -1;
static int hf_docsis_ehdr_bpup2_ver = -1;
static int hf_docsis_ehdr_bpup2_sid = -1;
+static int hf_docsis_ehdr_pv_st_refpt = -1;
+static int hf_docsis_ehdr_pv_timestamp = -1;
+
+static int hf_docsis_fragments = -1;
+static int hf_docsis_fragment = -1;
+static int hf_docsis_fragment_overlap = -1;
+static int hf_docsis_fragment_overlap_conflict = -1;
+static int hf_docsis_fragment_multiple_tails = -1;
+static int hf_docsis_fragment_too_long_fragment = -1;
+static int hf_docsis_fragment_error = -1;
+static int hf_docsis_fragment_count = -1;
+static int hf_docsis_reassembled_in = -1;
+static int hf_docsis_reassembled_length = -1;
+static int hf_docsis_reassembled_data = -1;
+static int hf_docsis_frag_fcs = -1;
+static int hf_docsis_frag_fcs_status = -1;
+
static dissector_handle_t docsis_handle;
static dissector_handle_t eth_withoutfcs_handle;
static dissector_handle_t docsis_mgmt_handle;
@@ -119,15 +163,22 @@ static dissector_handle_t docsis_mgmt_handle;
static dissector_table_t docsis_dissector_table;
#endif
+static expert_field ei_docsis_hcs_bad = EI_INIT;
+static expert_field ei_docsis_len = EI_INIT;
+static expert_field ei_docsis_frag_fcs_bad = EI_INIT;
+static expert_field ei_docsis_eh_len = EI_INIT;
+
/* Initialize the subtree pointers */
static gint ett_docsis = -1;
static gint ett_ehdr = -1;
+static gint ett_docsis_fragments = -1;
+static gint ett_docsis_fragment = -1;
static const value_string fctype_vals[] = {
- {FCTYPE_PACKET, "Packet PDU"},
- {FCTYPE_ATMPDU, "ATM PDU"},
- {FCTYPE_RESRVD, "Reserved"},
- {FCTYPE_MACSPC, "MAC Specific"},
+ {FCTYPE_PACKET, "Packet PDU"},
+ {FCTYPE_RESERVED, "Reserved"},
+ {FCTYPE_ISOLAT, "Isolation PDU"},
+ {FCTYPE_MACSPC, "MAC Specific"},
{0, NULL}
};
@@ -141,8 +192,7 @@ static const value_string eh_type_vals[] = {
{EH_SFLOW_HDR_DOWN, "Service Flow EH; PHS Header Downstream"},
{EH_BP_UP2, "Upstream Privacy with Multi Channel"},
{EH_DS_SERVICE, "Downstream Service"},
- {EH_RESERVED_9, "Reserved"},
- {EH_RESERVED_10, "Reserved"},
+ {EH_PATH_VERIFY, "Path Verify"},
{EH_RESERVED_10, "Reserved"},
{EH_RESERVED_11, "Reserved"},
{EH_RESERVED_12, "Reserved"},
@@ -152,26 +202,43 @@ static const value_string eh_type_vals[] = {
{0, NULL}
};
-static const value_string fcparm_vals[] = {
- {0x0, "Timing Header"},
- {0x1, "Mac Management Message"},
- {0x2, "Request Frame"},
- {0x3, "Fragmentation Header"},
- {0x4, "Queue Depth-based Request Frame"},
- {0x1C, "Concatenation Header"},
+static const value_string ms_fcparm_vals[] = {
+ {FCPARM_TIMING_HDR, "Timing Header"},
+ {FCPARM_MAC_MGMT_HDR, "MAC Management Message"},
+ {FCPARM_RQST_FRM, "Request Frame"},
+ {FCPARM_FRAG_HDR, "Fragmentation Header"},
+ {FCPARM_QUEUE_DEPTH_REQ_FRM, "Queue Depth-based Request Frame"},
+ {FCPARM_CONCAT_HDR, "Concatenation Header"},
{0, NULL}
};
-static const true_false_string ehdron_tfs = {
+static const value_string pkt_fcparm_vals[] = {
+ {0x00, "PDU MAC"},
+ {0x01, "DELAY/DUPLICATE/MULTICAST/BROADCAST"},
+ {0, NULL}
+};
+
+static const true_false_string exthdr_tfs = {
"Extended Header Present",
"Extended Header Absent"
};
+/* Plugins can't use true_false_string and value_string const from /epan on Windows
+ Duplicated here because of that */
static const true_false_string ena_dis_tfs = {
"Enabled",
"Disabled"
};
+static const value_string local_proto_checksum_vals[] = {
+ { PROTO_CHECKSUM_E_BAD, "Bad" },
+ { PROTO_CHECKSUM_E_GOOD, "Good" },
+ { PROTO_CHECKSUM_E_UNVERIFIED, "Unverified" },
+ { PROTO_CHECKSUM_E_NOT_PRESENT, "Not present" },
+
+ { 0, NULL }
+};
+
static const true_false_string qind_tfs = {
"Rate overrun",
"Rate non-overrun"
@@ -182,442 +249,598 @@ static const true_false_string odd_even_tfs = {
"Even Key",
};
+/* Fragmentation Flags / Sequence */
+static guint8 frag_flags;
+static guint8 frag_seq;
+static guint16 frag_sid;
+
+/*
+ * Defragmentation of DOCSIS
+ */
+static reassembly_table docsis_reassembly_table;
+
+static void
+docsis_defragment_init(void)
+{
+ reassembly_table_init(&docsis_reassembly_table,
+ &addresses_reassembly_table_functions);
+}
+
+static void
+docsis_defragment_cleanup(void)
+{
+ reassembly_table_destroy(&docsis_reassembly_table);
+}
+
+static const fragment_items docsis_frag_items = {
+ &ett_docsis_fragment,
+ &ett_docsis_fragments,
+ &hf_docsis_fragments,
+ &hf_docsis_fragment,
+ &hf_docsis_fragment_overlap,
+ &hf_docsis_fragment_overlap_conflict,
+ &hf_docsis_fragment_multiple_tails,
+ &hf_docsis_fragment_too_long_fragment,
+ &hf_docsis_fragment_error,
+ &hf_docsis_fragment_count,
+ &hf_docsis_reassembled_in,
+ &hf_docsis_reassembled_length,
+ &hf_docsis_reassembled_data,
+ "DOCSIS fragments"
+};
+
/* Dissection */
-/* Code to Dissect the extended header */
+/* Code to Dissect the extended header; TLV Formatted headers */
static void
-dissect_ehdr (tvbuff_t * tvb, proto_tree * tree, gboolean isfrag)
+dissect_ehdr (tvbuff_t * tvb, proto_tree * tree, packet_info * pinfo)
{
proto_tree *ehdr_tree;
- proto_item *item;
+ proto_item *item_pshi;
+ proto_item *eh_length_item;
gint ehdrlen;
int pos;
guint8 type;
guint8 len;
guint8 val;
- guint8 mini_slots;
- guint16 sid;
ehdrlen = tvb_get_guint8 (tvb, 1);
pos = 4;
ehdr_tree = proto_tree_add_subtree(tree, tvb, pos, ehdrlen, ett_ehdr, NULL, "Extended Header");
+
while (pos < ehdrlen + 4)
+ {
+ type = (tvb_get_guint8 (tvb, pos) & 0xF0);
+ len = (tvb_get_guint8 (tvb, pos) & 0x0F);
+ if ((((type >> 4) & 0x0F)== 6) && (len == 2))
+ {
+ proto_tree_add_uint_format_value(ehdr_tree, hf_docsis_eh_type, tvb, pos, 1, 0x60, "Unsolicited Grant Sync EHDR Sub-Element");
+ }
+ else
{
- type = (tvb_get_guint8 (tvb, pos) & 0xF0);
- len = (tvb_get_guint8 (tvb, pos) & 0x0F);
- if ((((type >> 4) & 0x0F)== 6) && (len == 2))
+ proto_tree_add_item (ehdr_tree, hf_docsis_eh_type, tvb, pos, 1, ENC_BIG_ENDIAN);
+ }
+
+ eh_length_item = proto_tree_add_item (ehdr_tree, hf_docsis_eh_len, tvb, pos, 1, ENC_BIG_ENDIAN);
+
+
+ switch ((type >> 4) & 0x0F)
+ {
+ case EH_REQUEST:
+ /* Request: Minislots Requested */
+ if (len == 3)
{
- proto_tree_add_uint_format_value(ehdr_tree, hf_docsis_eh_type, tvb, pos, 1, 0x60, "Unsolicited Grant Sync EHDR Sub-Element");
+ proto_tree_add_item(ehdr_tree, hf_docsis_mini_slots, tvb, pos + 1, 1, ENC_NA);
+ proto_tree_add_item(ehdr_tree, hf_docsis_sid, tvb, pos + 2, 2, ENC_BIG_ENDIAN);
}
- else
- proto_tree_add_item (ehdr_tree, hf_docsis_eh_type, tvb, pos, 1, ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_eh_len, tvb, pos, 1, ENC_BIG_ENDIAN);
- switch ((type >> 4) & 0x0F)
+ else
{
- case EH_REQUEST:
- if (len == 3)
- {
- mini_slots = tvb_get_guint8 (tvb, pos + 1);
- sid = tvb_get_ntohs (tvb, pos + 2);
- proto_tree_add_uint (ehdr_tree, hf_docsis_mini_slots, tvb,
- pos + 1, 1, mini_slots);
- proto_tree_add_uint (ehdr_tree, hf_docsis_sid, tvb, pos + 2, 2,
- sid);
- }
- else
- {
- THROW (ReportedBoundsError);
- }
- break;
- case EH_ACK_REQ:
- if (len == 2)
- {
- sid = tvb_get_ntohs (tvb, pos + 1);
- proto_tree_add_uint (ehdr_tree, hf_docsis_sid, tvb, pos + 2, 2,
- sid);
- }
- else
- {
- THROW (ReportedBoundsError);
- }
- break;
- case EH_BP_UP:
- proto_tree_add_item (ehdr_tree, hf_docsis_key_seq, tvb, pos + 1, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_ver, tvb, pos + 1, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_bpi_en, tvb, pos + 2, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_toggle_bit, tvb, pos + 2,
+ expert_add_info(pinfo, eh_length_item, &ei_docsis_eh_len);
+ return;
+ }
+ break;
+ case EH_ACK_REQ:
+ /* Deprecated in DOCSIS 3.1 */
+ if (len == 2)
+ {
+ proto_tree_add_item(ehdr_tree, hf_docsis_sid, tvb, pos + 1, 2, ENC_BIG_ENDIAN);
+ }
+ else
+ {
+ expert_add_info(pinfo, eh_length_item, &ei_docsis_eh_len);
+ return;
+ }
+ break;
+ case EH_BP_UP:
+ /* Upstream Privacy EH Element or Upstream Privacy with fragmentation */
+ proto_tree_add_item (ehdr_tree, hf_docsis_key_seq, tvb, pos + 1, 1,
+ ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_ver, tvb, pos + 1, 1,
+ ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_bpi_en, tvb, pos + 2, 1,
+ ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_toggle_bit, tvb, pos + 2,
+ 1, ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_sid, tvb, pos + 2, 2,
+ ENC_BIG_ENDIAN);
+ frag_sid = tvb_get_guint8 (tvb, pos+2) & 0xCFFF;
+ proto_tree_add_item (ehdr_tree, hf_docsis_mini_slots, tvb, pos + 4,
+ 1, ENC_BIG_ENDIAN);
+ if (pinfo->fragmented)
+ {
+ proto_tree_add_item (ehdr_tree, hf_docsis_frag_rsvd, tvb, pos+5,
1, ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_sid, tvb, pos + 2, 2,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_mini_slots, tvb, pos + 4,
+ frag_flags = tvb_get_guint8 (tvb, pos+5) & 0x30;
+ proto_tree_add_item (ehdr_tree, hf_docsis_frag_first, tvb, pos+5,
1, ENC_BIG_ENDIAN);
- if (isfrag)
- {
- proto_tree_add_item (ehdr_tree, hf_docsis_frag_rsvd, tvb, pos+5,
- 1, ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_frag_first, tvb, pos+5,
- 1, ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_frag_last, tvb, pos+5,
- 1, ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_frag_seq, tvb, pos+5,
- 1, ENC_BIG_ENDIAN);
- }
- break;
- case EH_BP_DOWN:
- proto_tree_add_item (ehdr_tree, hf_docsis_key_seq, tvb, pos + 1, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_ver, tvb, pos + 1, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_bpi_en, tvb, pos + 2, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_toggle_bit, tvb, pos + 2,
+ proto_tree_add_item (ehdr_tree, hf_docsis_frag_last, tvb, pos+5,
1, ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_said, tvb, pos + 2, 2,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_reserved, tvb, pos + 4, 1,
- ENC_BIG_ENDIAN);
- break;
- case EH_SFLOW_HDR_DOWN:
- case EH_SFLOW_HDR_UP:
- val = tvb_get_guint8 (tvb, pos+1);
- item = proto_tree_add_item(ehdr_tree, hf_docsis_ehdr_phsi, tvb, pos+1, 1, ENC_BIG_ENDIAN);
- if (val == 0)
- {
- proto_item_append_text(item, " (No PHS on current packet)" );
- }
-
- if (len == 2)
- {
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_qind, tvb, pos+2, 1, ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_grants, tvb, pos+2, 1, ENC_BIG_ENDIAN);
- }
- break;
- case EH_BP_UP2:
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_bpup2_key_seq, tvb, pos + 1, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_bpup2_ver, tvb, pos + 1, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_bpup2_bpi_en, tvb, pos + 2, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_bpup2_toggle_bit, tvb, pos + 2,
+ frag_seq = tvb_get_guint8 (tvb, pos+5) & 0x0F;
+ proto_tree_add_item (ehdr_tree, hf_docsis_frag_seq, tvb, pos+5,
1, ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_bpup2_sid, tvb, pos + 2, 2,
- ENC_BIG_ENDIAN);
- break;
- case EH_DS_SERVICE:
- proto_tree_add_item(ehdr_tree, hf_docsis_ehdr_ds_traffic_pri, tvb, pos+1, 1, ENC_BIG_ENDIAN);
+ }
+ break;
+ case EH_BP_DOWN:
+ /* Downstream Privacy EH Element */
+ proto_tree_add_item (ehdr_tree, hf_docsis_key_seq, tvb, pos + 1, 1,
+ ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_ver, tvb, pos + 1, 1,
+ ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_bpi_en, tvb, pos + 2, 1,
+ ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_toggle_bit, tvb, pos + 2,
+ 1, ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_said, tvb, pos + 2, 2,
+ ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_reserved, tvb, pos + 4, 1,
+ ENC_BIG_ENDIAN);
+ break;
+ case EH_SFLOW_HDR_DOWN:
+ /* Deprecated in DOCSIS 3.1, was Downstream Service Flow EH Element in earlier revisions */
+ case EH_SFLOW_HDR_UP:
+ /* Deprecated in DOCSIS 3.1, was Upstream Service Flow EH Element in earlier revisions */
+ val = tvb_get_guint8 (tvb, pos+1);
+ item_pshi = proto_tree_add_item(ehdr_tree, hf_docsis_ehdr_phsi, tvb, pos+1, 1, ENC_BIG_ENDIAN);
+ if (val == 0)
+ {
+ proto_item_append_text(item_pshi, " (No PHS on current packet)" );
+ }
- if (len == 3)
- {
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_ds_dsid, tvb, pos+1, 3, ENC_BIG_ENDIAN);
- }
+ if (len == 2)
+ {
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_qind, tvb, pos+2, 1, ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_grants, tvb, pos+2, 1, ENC_BIG_ENDIAN);
+ }
+ break;
+ case EH_BP_UP2:
+ /* Upstream Privacy EH Element, version 2, with no piggyback request */
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_bpup2_key_seq, tvb, pos + 1, 1,
+ ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_bpup2_ver, tvb, pos + 1, 1,
+ ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_bpup2_bpi_en, tvb, pos + 2, 1,
+ ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_bpup2_toggle_bit, tvb, pos + 2,
+ 1, ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_bpup2_sid, tvb, pos + 2, 2,
+ ENC_BIG_ENDIAN);
+ break;
+ case EH_DS_SERVICE:
+ /* Downstream Service EH Element */
+ proto_tree_add_item(ehdr_tree, hf_docsis_ehdr_ds_traffic_pri, tvb, pos+1, 1, ENC_BIG_ENDIAN);
- if (len == 5)
- {
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_ds_seq_chg_cnt, tvb, pos+1, 1, ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_ds_dsid, tvb, pos+1, 3, ENC_BIG_ENDIAN);
- proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_ds_pkt_seq_num, tvb, pos+4, 2, ENC_BIG_ENDIAN);
- }
+ if (len == 3)
+ {
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_ds_dsid, tvb, pos+1, 3, ENC_BIG_ENDIAN);
+ }
- break;
- default:
- if (len > 0)
- proto_tree_add_item (ehdr_tree, hf_docsis_eh_val, tvb, pos + 1,
- len, ENC_NA);
+ if (len == 5)
+ {
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_ds_seq_chg_cnt, tvb, pos+1, 1, ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_ds_dsid, tvb, pos+1, 3, ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_ds_pkt_seq_num, tvb, pos+4, 2, ENC_BIG_ENDIAN);
}
- pos += len + 1;
+ break;
+ case EH_PATH_VERIFY:
+ /* Path Verify EH Element */
+ if (len == 5)
+ {
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_pv_st_refpt, tvb, pos+1, 1, ENC_BIG_ENDIAN);
+ proto_tree_add_item (ehdr_tree, hf_docsis_ehdr_pv_timestamp, tvb, pos+2, 4, ENC_BIG_ENDIAN);
+ }
+ break;
+ case EH_EXTENDED:
+ /* Extended EH Element, one or more Sub EH fields may follow; simply recurse */
+ dissect_ehdr (tvb, ehdr_tree, pinfo);
+ break;
+ default:
+ if (len > 0)
+ proto_tree_add_item (ehdr_tree, hf_docsis_eh_val, tvb, pos + 1,
+ len, ENC_NA);
}
+ pos += len + 1;
+ }
return;
}
+/* Code to Dissect the Header Check Sequence field */
+static void
+dissect_hcs_field (tvbuff_t * tvb, packet_info * pinfo, proto_tree * docsis_tree, gint hdrlen)
+{
+ /* dissect the header check sequence */
+ if(docsis_check_fcs){
+ /* CRC-CCITT(16+12+5+1) */
+ guint16 fcs = g_ntohs(crc16_ccitt_tvb(tvb, (hdrlen - 2)));
+ proto_tree_add_checksum(docsis_tree, tvb, (hdrlen - 2), hf_docsis_hcs, hf_docsis_hcs_status, &ei_docsis_hcs_bad, pinfo, fcs, ENC_BIG_ENDIAN, PROTO_CHECKSUM_VERIFY);
+ }
+ else
+ {
+ proto_tree_add_checksum(docsis_tree, tvb, (hdrlen - 2), hf_docsis_hcs, hf_docsis_hcs_status, &ei_docsis_hcs_bad, pinfo, 0, ENC_BIG_ENDIAN, PROTO_CHECKSUM_NO_FLAGS);
+ }
+ return;
+}
+
+/* Code to Dissect the extended header length / MAC Param field and Length field */
+/* The length field may condain a SID, but this logic is not handled here */
+static void
+dissect_exthdr_length_field (tvbuff_t * tvb, packet_info * pinfo, proto_tree * docsis_tree, guint8 exthdr, guint16 mac_parm, guint16 len_sid, guint16 *payload_length)
+{
+ proto_item *length_item;
+ if (exthdr == EXT_HDR_ON)
+ {
+ /* Add in Extended Header Length */
+ proto_tree_add_item (docsis_tree, hf_docsis_ehdrlen, tvb, 1, 1, ENC_BIG_ENDIAN);
+ length_item = proto_tree_add_item (docsis_tree, hf_docsis_len, tvb, 2, 2, ENC_BIG_ENDIAN);
+ /* Validate PDU length */
+ if ((len_sid - mac_parm) > *payload_length)
+ {
+ *payload_length = len_sid;
+ expert_add_info(pinfo, length_item, &ei_docsis_len);
+ }
+ /* Pass off to the Extended Header dissection */
+ dissect_ehdr (tvb, docsis_tree, pinfo);
+ }
+ else
+ {
+ /* Add in MAC Parm field only */
+ proto_tree_add_item (docsis_tree, hf_docsis_macparm, tvb, 1, 1, ENC_BIG_ENDIAN);
+ length_item = proto_tree_add_item (docsis_tree, hf_docsis_len, tvb, 2, 2, ENC_BIG_ENDIAN);
+ /* Validate PDU length */
+ if (len_sid > *payload_length)
+ {
+ *payload_length = len_sid;
+ expert_add_info(pinfo, length_item, &ei_docsis_len);
+ }
+ }
+ return;
+}
+/* Main DOCSIS Dissection Entry Point */
+/* Code to Dissect the DOCSIS Frames */
static int
dissect_docsis (tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree, void* data _U_)
{
- guint8 fc;
- guint8 fctype;
- guint8 fcparm;
- guint8 ehdron;
- gint mac_parm;
- gint hdrlen;
- guint16 len_sid;
- tvbuff_t *next_tvb, *mgt_tvb;
- gint pdulen, captured_length;
- gint framelen;
- gboolean isfrag = FALSE;
- gint oldconcatlen;
+ guint8 fc = 0;
+ guint8 fctype = 0;
+ guint8 fcparm = 0;
+ guint8 exthdr = 0;
+ guint16 mac_parm = 0;
+ guint8 hdrlen = DOCSIS_MIN_HEADER_LEN;
+ guint16 len_sid = 0;
+ tvbuff_t *next_tvb = NULL;
+ tvbuff_t *mgt_tvb = NULL;
+ gint pdulen = 0;
+ guint16 payload_length = 0;
+ guint16 framelen = 0;
+ gboolean save_fragmented;
proto_item *ti;
proto_tree *docsis_tree;
+
/* concatlen and concatpos are declared static to allow for recursive calls to
* the dissect_docsis routine when dissecting Concatenated frames
*/
- static gint concatlen;
- static gint concatpos;
+ static guint16 concatlen;
+ static guint16 concatpos;
- /* Extract important fields */
+ /* Extract Frame Control parts */
fc = tvb_get_guint8 (tvb, 0); /* Frame Control Byte */
fctype = (fc >> 6) & 0x03; /* Frame Control Type: 2 MSB Bits */
fcparm = (fc >> 1) & 0x1F; /* Frame Control Parameter: Next 5 Bits */
- ehdron = (fc & 0x01); /* Extended Header Bit: LSB */
+ exthdr = (fc & 0x01); /* Extended Header Bit: LSB */
- if (fcparm == 0x04) {
+ /* Extract the MAC Parm; MAC Parm and SID offsets; change for a Queue Depth Request */
+ if (fcparm == FCPARM_QUEUE_DEPTH_REQ_FRM) {
mac_parm = tvb_get_ntohs (tvb, 1);
len_sid = tvb_get_ntohs (tvb, 3);
+ hdrlen = DOCSIS_MIN_HEADER_LEN + 1; // 7-byte header for this message type
} else {
mac_parm = tvb_get_guint8 (tvb, 1);
len_sid = tvb_get_ntohs (tvb, 2);
}
- /* set Header length based on presence of Extended header */
- if (ehdron == 0x00) {
- if (fcparm == 0x04)
- hdrlen = 7;
+ /* Set Header Length based on presence of Extended header */
+ if (exthdr == EXT_HDR_ON) {
+ hdrlen += mac_parm;
+ }
+
+ /* Captured Payload Length is based on the length of the header */
+ payload_length = tvb_captured_length_remaining (tvb, hdrlen);
+
+ /* If this is a Request Frame, then pdulen is 0 and framelen is 6 */
+ if ((fctype == FCTYPE_MACSPC) && (fcparm == FCPARM_RQST_FRM || fcparm == FCPARM_QUEUE_DEPTH_REQ_FRM))
+ {
+ pdulen = 0;
+ if (fcparm == FCPARM_QUEUE_DEPTH_REQ_FRM)
+ framelen = DOCSIS_MIN_HEADER_LEN + 1;
else
- hdrlen = 6;
+ framelen = DOCSIS_MIN_HEADER_LEN;
} else {
- hdrlen = 6 + mac_parm;
+ framelen = DOCSIS_MIN_HEADER_LEN + len_sid;
+ pdulen = len_sid - (mac_parm + 2);
}
- /* Captured PDU Length is based on the length of the header */
- captured_length = tvb_captured_length_remaining (tvb, hdrlen);
+ /* Make entries in Protocol column and Info column on summary display */
+ col_set_str (pinfo->cinfo, COL_PROTOCOL, "DOCSIS");
- /* If this is a Request Frame, then pdulen is 0 and framelen is 6 */
- if ((fctype == FCTYPE_MACSPC) && (fcparm == 0x02 || fcparm == 0x04))
+ switch (fctype)
+ {
+ case FCTYPE_PACKET:
+ col_set_str (pinfo->cinfo, COL_INFO, "Packet PDU");
+ break;
+ case FCTYPE_RESERVED:
+ col_set_str (pinfo->cinfo, COL_INFO, "Reserved PDU");
+ break;
+ case FCTYPE_ISOLAT:
+ col_set_str (pinfo->cinfo, COL_INFO, "Isolation PDU");
+ break;
+ case FCTYPE_MACSPC:
+ if (fcparm == FCPARM_RQST_FRM)
+ col_add_fstr (pinfo->cinfo, COL_INFO,
+ "Request Frame SID = %u Mini Slots = %u", len_sid,
+ mac_parm);
+ else if (fcparm == FCPARM_QUEUE_DEPTH_REQ_FRM)
+ col_add_fstr (pinfo->cinfo, COL_INFO,
+ "Request Frame SID = %u Bytes Requested = %u", len_sid,
+ mac_parm);
+ else if (fcparm == FCPARM_FRAG_HDR)
+ col_set_str (pinfo->cinfo, COL_INFO, "Fragmented Frame");
+ else
+ col_set_str (pinfo->cinfo, COL_INFO, "Mac Specific");
+ break;
+ } /* switch fctype */
+
+ ti = proto_tree_add_item(tree, proto_docsis, tvb, 0, hdrlen, ENC_NA);
+ docsis_tree = proto_item_add_subtree (ti, ett_docsis);
+
+ /* add an item to the subtree, see section 1.6 for more information */
+
+ /* Add in FC Byte fields */
+ proto_tree_add_item (docsis_tree, hf_docsis_fctype, tvb, 0, 1, ENC_BIG_ENDIAN);
+
+ switch (fctype)
+ {
+ case FCTYPE_PACKET:
{
- pdulen = 0;
- framelen = 6;
+ proto_item_append_text (ti, " Packet PDU");
+ proto_tree_add_item (docsis_tree, hf_docsis_fcparm, tvb, 0, 1, ENC_BIG_ENDIAN);
+ proto_tree_add_item (docsis_tree, hf_docsis_exthdr, tvb, 0, 1, ENC_BIG_ENDIAN);
+ /* Dissect Length field for a PDU */
+ dissect_exthdr_length_field (tvb, pinfo, docsis_tree, exthdr, mac_parm, len_sid, &payload_length);
+ /* Dissect Header Check Sequence field for a PDU */
+ dissect_hcs_field (tvb, pinfo, docsis_tree, hdrlen);
+ if (pdulen > 0)
+ {
+ next_tvb = tvb_new_subset_remaining(tvb, hdrlen);
+ call_dissector (eth_withoutfcs_handle, next_tvb, pinfo, docsis_tree);
+ }
+ if (concatlen > 0)
+ {
+ concatlen = concatlen - framelen;
+ concatpos += framelen;
+ }
+ break;
}
- else
+ case FCTYPE_RESERVED:
{
- framelen = 6 + len_sid;
- pdulen = len_sid - (mac_parm + 2);
- }
+ proto_item_append_text (ti, " Reserved PDU");
+ proto_tree_add_item (docsis_tree, hf_docsis_fcparm, tvb, 0, 1, ENC_BIG_ENDIAN);
+ proto_tree_add_item (docsis_tree, hf_docsis_exthdr, tvb, 0, 1, ENC_BIG_ENDIAN);
+ /* Dissect Length field for a PDU */
+ dissect_exthdr_length_field (tvb, pinfo, docsis_tree, exthdr, mac_parm, len_sid, &payload_length);
+ /* Dissect Header Check Sequence field for a PDU */
+ dissect_hcs_field (tvb, pinfo, docsis_tree, hdrlen);
+
+ if (concatlen > 0)
+ {
+ concatlen = concatlen - framelen;
+ concatpos += framelen;
+ }
- /* if this is a concatenated frame setup the length of the concatenated
- * frame and set the position to the first byte of the first frame */
- if ((fctype == FCTYPE_MACSPC) && (fcparm == 0x1c))
+ /* Don't do anything for a Reserved Frame */
+ next_tvb = tvb_new_subset_remaining(tvb, hdrlen);
+ call_data_dissector(next_tvb, pinfo, tree);
+ break;
+ }
+ case FCTYPE_ISOLAT:
{
- concatlen = len_sid;
- concatpos = 6;
+ proto_item_append_text (ti, " Isolation PDU");
+ proto_tree_add_item (docsis_tree, hf_docsis_fcparm, tvb, 0, 1, ENC_BIG_ENDIAN);
+ proto_tree_add_item (docsis_tree, hf_docsis_exthdr, tvb, 0, 1, ENC_BIG_ENDIAN);
+ /* Dissect Length field for a PDU */
+ dissect_exthdr_length_field (tvb, pinfo, docsis_tree, exthdr, mac_parm, len_sid, &payload_length);
+ /* Dissect Header Check Sequence field for a PDU */
+ dissect_hcs_field (tvb, pinfo, docsis_tree, hdrlen);
+ if (pdulen > 0)
+ {
+ next_tvb = tvb_new_subset_remaining(tvb, hdrlen);
+ call_dissector (eth_withoutfcs_handle, next_tvb, pinfo, docsis_tree);
+ }
+ if (concatlen > 0)
+ {
+ concatlen = concatlen - framelen;
+ concatpos += framelen;
+ }
+ break;
}
-
- /* Make entries in Protocol column and Info column on summary display */
- col_set_str (pinfo->cinfo, COL_PROTOCOL, "DOCSIS");
-
- switch (fctype)
+ case FCTYPE_MACSPC:
{
- case FCTYPE_PACKET:
- col_set_str (pinfo->cinfo, COL_INFO, "Packet PDU");
- break;
- case FCTYPE_ATMPDU:
- col_set_str (pinfo->cinfo, COL_INFO, "ATM PDU");
- break;
- case FCTYPE_RESRVD:
- col_set_str (pinfo->cinfo, COL_INFO, "Reserved PDU");
- break;
- case FCTYPE_MACSPC:
- if (fcparm == 0x02)
- col_add_fstr (pinfo->cinfo, COL_INFO,
- "Request Frame SID = %u Mini Slots = %u", len_sid,
- mac_parm);
- else if (fcparm == 0x04)
- col_add_fstr (pinfo->cinfo, COL_INFO,
- "Request Frame SID = %u Bytes Requested = %u", len_sid,
- mac_parm);
- else if (fcparm == 0x03)
- col_set_str (pinfo->cinfo, COL_INFO, "Fragmented Frame");
- else
- col_set_str (pinfo->cinfo, COL_INFO, "Mac Specific");
- break;
- } /* switch */
+ proto_item_append_text (ti, " MAC-Specific PDU");
+ proto_tree_add_item (docsis_tree, hf_docsis_machdr_fcparm, tvb, 0, 1, ENC_BIG_ENDIAN);
+ proto_tree_add_item (docsis_tree, hf_docsis_exthdr, tvb, 0, 1, ENC_BIG_ENDIAN);
+ switch(fcparm)
+ {
+ case FCPARM_TIMING_HDR:
+ // no break
+ case FCPARM_MAC_MGMT_HDR:
+ {
+ /* Dissect Length field for a PDU */
+ dissect_exthdr_length_field (tvb, pinfo, docsis_tree, exthdr, mac_parm, len_sid, &payload_length);
+ /* Dissect Header Check Sequence field for a PDU */
+ dissect_hcs_field (tvb, pinfo, docsis_tree, hdrlen);
- /* In the interest of speed, if "tree" is NULL, don't do any work not
- necessary to generate protocol tree items. */
- if (tree)
- {
- ti = proto_tree_add_protocol_format (tree, proto_docsis, tvb, 0,
- hdrlen, "DOCSIS");
- docsis_tree = proto_item_add_subtree (ti, ett_docsis);
+ /* Pass off to the DOCSIS Management dissector/s */
+ mgt_tvb = tvb_new_subset_remaining(tvb, hdrlen);
+ call_dissector (docsis_mgmt_handle, mgt_tvb, pinfo, docsis_tree);
+ break;
+ }
+ case FCPARM_RQST_FRM:
+ {
+ /* Decode for a Request Frame. No extended header */
+ proto_tree_add_uint (docsis_tree, hf_docsis_mini_slots, tvb, 1, 1, mac_parm);
+ proto_tree_add_uint (docsis_tree, hf_docsis_sid, tvb, 2, 2, len_sid);
+ /* Dissect Header Check Sequence field for a PDU */
+ dissect_hcs_field (tvb, pinfo, docsis_tree, hdrlen);
- /* add an item to the subtree, see section 1.6 for more information */
- proto_tree_add_item (docsis_tree, hf_docsis_fctype, tvb, 0, 1, ENC_BIG_ENDIAN);
- switch (fctype)
+ if (concatlen > 0)
+ {
+ concatlen = concatlen - framelen;
+ concatpos += framelen;
+ }
+
+ /* Don't do anything for a Request Frame, there is no data following it*/
+ break;
+ }
+ case FCPARM_FRAG_HDR:
{
- case FCTYPE_PACKET:
- case FCTYPE_ATMPDU:
- case FCTYPE_RESRVD:
- proto_tree_add_item (docsis_tree, hf_docsis_fcparm, tvb, 0, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (docsis_tree, hf_docsis_ehdron, tvb, 0, 1,
- ENC_BIG_ENDIAN);
- if (ehdron == 0x01)
- {
- proto_tree_add_item (docsis_tree, hf_docsis_ehdrlen, tvb, 1, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (docsis_tree, hf_docsis_len, tvb, 2, 2,
- ENC_BIG_ENDIAN);
- dissect_ehdr (tvb, docsis_tree, isfrag);
- proto_tree_add_item (docsis_tree, hf_docsis_hcs, tvb,
- 4 + mac_parm, 2, ENC_BIG_ENDIAN);
- }
+ /* Check if this is a fragmentation header */
+ save_fragmented = pinfo->fragmented;
+ pinfo->fragmented = TRUE;
+
+ /* Dissect Length field for a PDU */
+ dissect_exthdr_length_field (tvb, pinfo, docsis_tree, exthdr, mac_parm, len_sid, &payload_length);
+ /* Dissect Header Check Sequence field for a PDU */
+ dissect_hcs_field (tvb, pinfo, docsis_tree, hdrlen);
+
+ /* Grab the Fragment FCS */
+ guint32 sent_fcs = tvb_get_ntohl(tvb, (hdrlen + len_sid - 4));
+ guint32 fcs = crc32_802_tvb(tvb, tvb_captured_length(tvb) - 4);
+
+ /* Only defragment valid frames with a good FCS */
+ if (sent_fcs == fcs)
+ {
+ /* Force the packet info field to treat all subsequent fragments as new */
+ pinfo->fd->flags.visited = 0;
+
+ fragment_item *frag_msg = NULL;
+ frag_msg = fragment_add_seq_check(&docsis_reassembly_table,
+ tvb, hdrlen, pinfo,
+ frag_sid, NULL, /* ID for fragments belonging together */
+ frag_seq, /* Fragment Sequence Number */
+ (len_sid - 4), /* fragment length - to the end */
+ !(frag_flags & FRAG_LAST)); /* More fragments? */
+
+ next_tvb = process_reassembled_data(tvb, hdrlen, pinfo,
+ "Reassembled Message", frag_msg, &docsis_frag_items,
+ NULL, docsis_tree);
+
+ if (frag_flags == FRAG_LAST)
+ pinfo->fragmented = FALSE;
else
- {
- proto_tree_add_item (docsis_tree, hf_docsis_macparm, tvb, 1, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (docsis_tree, hf_docsis_len, tvb, 2, 2,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (docsis_tree, hf_docsis_hcs, tvb, 4, 2,
- ENC_BIG_ENDIAN);
- }
- break;
- case FCTYPE_MACSPC:
- proto_tree_add_item (docsis_tree, hf_docsis_machdr_fcparm, tvb, 0,
- 1, ENC_BIG_ENDIAN);
- proto_tree_add_item (docsis_tree, hf_docsis_ehdron, tvb, 0, 1,
- ENC_BIG_ENDIAN);
- /* Decode for a Request Frame. No extended header */
- if (fcparm == 0x02)
- {
- proto_tree_add_uint (docsis_tree, hf_docsis_mini_slots, tvb, 1,
- 1, mac_parm);
- proto_tree_add_uint (docsis_tree, hf_docsis_sid, tvb, 2, 2,
- len_sid);
- proto_tree_add_item (docsis_tree, hf_docsis_hcs, tvb, 4, 2,
- ENC_BIG_ENDIAN);
- break;
- }
- /* Decode for a Queue-depth Based Request */
- if (fcparm == 0x04)
- {
- proto_tree_add_uint (docsis_tree, hf_docsis_requested_size, tvb, 1,
- 2, mac_parm);
- proto_tree_add_uint (docsis_tree, hf_docsis_sid, tvb, 3, 2,
- len_sid);
- proto_tree_add_item (docsis_tree, hf_docsis_hcs, tvb, 5, 2,
- ENC_BIG_ENDIAN);
- break;
- }
- /* Check if this is a fragmentation header */
- if (fcparm == 0x03)
- {
- isfrag = TRUE;
- }
- /* Decode for a Concatenated Header. No Extended Header */
- if (fcparm == 0x1c)
- {
- proto_item_append_text (ti, " (Concatenated Header)");
- proto_tree_add_item (docsis_tree, hf_docsis_concat_cnt, tvb, 1,
- 1, ENC_BIG_ENDIAN);
- proto_tree_add_item (docsis_tree, hf_docsis_len, tvb, 2, 2,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (docsis_tree, hf_docsis_hcs, tvb, 4, 2,
- ENC_BIG_ENDIAN);
- break;
- }
- /* If Extended header is present then decode it */
- if (ehdron == 0x01)
- {
- proto_tree_add_item (docsis_tree, hf_docsis_ehdrlen, tvb, 1, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (docsis_tree, hf_docsis_len, tvb, 2, 2,
- ENC_BIG_ENDIAN);
- dissect_ehdr (tvb, docsis_tree, isfrag);
- proto_tree_add_item (docsis_tree, hf_docsis_hcs, tvb,
- 4 + mac_parm, 2, ENC_BIG_ENDIAN);
- break;
- }
- /* default case for all other Mac Frame Types */
- proto_tree_add_item (docsis_tree, hf_docsis_macparm, tvb, 1, 1,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (docsis_tree, hf_docsis_len, tvb, 2, 2,
- ENC_BIG_ENDIAN);
- proto_tree_add_item (docsis_tree, hf_docsis_hcs, tvb, 4, 2, ENC_BIG_ENDIAN);
- break;
+ pinfo->fragmented = TRUE;
+
+ if (frag_msg) { /* Reassembled */
+ proto_item_append_text (ti, " (Message Reassembled)");
+ } else { /* Not last packet of reassembled Short Message */
+ proto_item_append_text (ti, " (Message fragment %u)", frag_seq);
+
+ }
+
+ if(next_tvb)
+ {
+ /* By default assume an Ethernet payload */
+ call_dissector (eth_withoutfcs_handle, next_tvb, pinfo, docsis_tree);
+ } else {
+ /* Otherwise treat as Data */
+ tvbuff_t *payload_tvb = tvb_new_subset(tvb, hdrlen, (len_sid - 4), -1);
+ call_data_dissector(payload_tvb, pinfo, docsis_tree);
+ }
+ } else {
+ /* Report frames with a bad FCS */
+ expert_add_info(pinfo, ti, &ei_docsis_frag_fcs_bad);
+ }
+
+ /* Add the Fragment FCS to the end of the parent tree */
+ proto_tree_add_checksum(docsis_tree, tvb, (hdrlen + len_sid - 4), hf_docsis_frag_fcs, hf_docsis_frag_fcs_status, &ei_docsis_frag_fcs_bad, pinfo, fcs, ENC_BIG_ENDIAN, PROTO_CHECKSUM_VERIFY);
+
+ pinfo->fragmented = save_fragmented;
+ break;
}
- }
+ case FCPARM_QUEUE_DEPTH_REQ_FRM:
+ {
+ /* Decode for a Queue-depth Based Request */
+ proto_tree_add_uint (docsis_tree, hf_docsis_requested_size, tvb, 1, 2, mac_parm);
+ proto_tree_add_uint (docsis_tree, hf_docsis_sid, tvb, 3, 2, len_sid);
+ /* Dissect Header Check Sequence field for a PDU */
+ dissect_hcs_field (tvb, pinfo, docsis_tree, hdrlen);
- switch (fctype)
- {
- case FCTYPE_PACKET:
- case FCTYPE_RESRVD:
- if (pdulen >= 0)
+ if (concatlen > 0)
{
- if (pdulen > 0)
- {
- next_tvb = tvb_new_subset (tvb, hdrlen, captured_length, pdulen);
- call_dissector (eth_withoutfcs_handle, next_tvb, pinfo, tree);
- }
- if (concatlen > 0)
- {
- concatlen = concatlen - framelen;
- concatpos += framelen;
- }
+ concatlen = concatlen - framelen;
+ concatpos += framelen;
}
- break;
- case FCTYPE_MACSPC:
- switch (fcparm)
+
+ /* No PDU Payload for this frame */
+ break;
+ }
+ case FCPARM_CONCAT_HDR:
+ {
+ /* Decode for a Concatenated Header; ONLY for DOCSIS versions < 3.1. No Extended Header */
+ proto_item_append_text (ti, " (Concatenated Header)");
+ proto_tree_add_item (docsis_tree, hf_docsis_concat_cnt, tvb, 1, 1, ENC_BIG_ENDIAN);
+ proto_tree_add_item (docsis_tree, hf_docsis_len, tvb, 2, 2, ENC_BIG_ENDIAN);
+ /* Dissect Header Check Sequence field for a PDU */
+ dissect_hcs_field (tvb, pinfo, docsis_tree, hdrlen);
+
+ /* If this is a concatenated frame setup the length of the concatenated
+ * frame and set the position to the first byte of the first frame
+ */
+ concatlen = len_sid;
+ concatpos = DOCSIS_MIN_HEADER_LEN;
+
+ /* Call the docsis dissector on the same frame
+ * to dissect DOCSIS frames within the concatenated
+ * frame. concatpos and concatlen are declared
+ * static and are decremented and incremented
+ * respectively when the inner
+ * docsis frames are dissected. */
+ while (concatlen > 0)
{
- case 0x00:
- case 0x01:
- if (pdulen > 0)
- {
- mgt_tvb = tvb_new_subset (tvb, hdrlen, captured_length, pdulen);
- call_dissector (docsis_mgmt_handle, mgt_tvb, pinfo, tree);
- }
- if (concatlen > 0)
- {
- concatlen = concatlen - framelen;
- concatpos += framelen;
- }
- break;
- case 0x02:
- /* Don't do anything for a Request Frame */
- break;
- case 0x03:
- /* For Fragmentation Frames simply dissect using the data
- * dissector as we don't handle them yet
- */
- if (pdulen > 0)
- {
- mgt_tvb = tvb_new_subset (tvb, hdrlen, captured_length, pdulen);
- call_data_dissector(mgt_tvb, pinfo, tree);
- }
- if (concatlen > 0)
- {
- concatlen = concatlen - framelen;
- concatpos += framelen;
- }
- break;
- case 0x1c:
- /* call the docsis dissector on the same frame
- * to dissect DOCSIS frames within the concatenated
- * frame. concatpos and concatlen are declared
- * static and are decremented and incremented
- * respectively when the inner
- * docsis frames are dissected. */
- while (concatlen > 0)
- {
- oldconcatlen = concatlen;
- next_tvb = tvb_new_subset (tvb, concatpos, -1, concatlen);
- call_dissector (docsis_handle, next_tvb, pinfo, tree);
- if (oldconcatlen <= concatlen)
- THROW(ReportedBoundsError);
- }
- concatlen = 0;
- concatpos = 0;
- col_set_str(pinfo->cinfo, COL_INFO, "Concatenated Frame");
- break;
+ next_tvb = tvb_new_subset (tvb, concatpos, -1, concatlen);
+ call_dissector (docsis_handle, next_tvb, pinfo, docsis_tree);
}
- break;
+ concatlen = 0;
+ concatpos = 0;
+ break;
+ }
+ } /* switch fcparm */
+ break;
}
- return tvb_captured_length(tvb);
-}
+ } /* switch fctype*/
+ return tvb_captured_length(tvb);
+}
/* Register the protocol with Wireshark */
void
@@ -631,17 +854,17 @@ proto_register_docsis (void)
},
{&hf_docsis_fcparm,
{"FCParm", "docsis.fcparm",
- FT_UINT8, BASE_DEC, NULL, 0x3E,
+ FT_UINT8, BASE_DEC, VALS (pkt_fcparm_vals), 0x3E,
"Parameter Field", HFILL}
},
{&hf_docsis_machdr_fcparm,
{"FCParm", "docsis.fcparm",
- FT_UINT8, BASE_HEX, VALS (fcparm_vals), 0x3E,
+ FT_UINT8, BASE_DEC, VALS (ms_fcparm_vals), 0x3E,
"Parameter Field", HFILL}
},
- {&hf_docsis_ehdron,
- {"EHDRON", "docsis.ehdron",
- FT_BOOLEAN, 8, TFS (&ehdron_tfs), 0x01,
+ {&hf_docsis_exthdr,
+ {"EXTHDR", "docsis.exthdr",
+ FT_BOOLEAN, 8, TFS (&exthdr_tfs), 0x01,
"Extended Header Presence", HFILL}
},
{&hf_docsis_macparm,
@@ -701,7 +924,7 @@ proto_register_docsis (void)
},
{&hf_docsis_sid,
{"SID", "docsis.ehdr.sid",
- FT_UINT16, BASE_DEC, NULL, 0x3FFF,
+ FT_UINT16, BASE_DEC_HEX, NULL, 0x3FFF,
"Service Identifier", HFILL}
},
{&hf_docsis_said,
@@ -721,7 +944,7 @@ proto_register_docsis (void)
},
{&hf_docsis_requested_size,
{"Bytes Requested", "docsis.ehdr.reqsize",
- FT_UINT16, BASE_DEC, NULL, 0x0,
+ FT_UINT16, BASE_DEC, NULL, 0xFFFF,
NULL, HFILL}
},
{&hf_docsis_key_seq,
@@ -752,76 +975,177 @@ proto_register_docsis (void)
{&hf_docsis_ehdr_bpup2_key_seq,
{"Key Sequence", "docsis.ehdr.bpup2_keyseq",
FT_UINT8, BASE_DEC, NULL, 0xF0,
- "NULL", HFILL}
+ NULL, HFILL}
},
{&hf_docsis_ehdr_bpup2_ver,
{"Version", "docsis.ehdr.bpup2_ver",
FT_UINT8, BASE_DEC, NULL, 0x0F,
- "NULL", HFILL}
+ NULL, HFILL}
},
{&hf_docsis_ehdr_bpup2_bpi_en,
{"Encryption", "docsis.ehdr.bpup2_bpi_en",
FT_BOOLEAN, 8, TFS (&ena_dis_tfs), 0x80,
- "BPI Enable", HFILL},
+ "BPI Enable", HFILL}
},
{&hf_docsis_ehdr_bpup2_toggle_bit,
{"Toggle", "docsis.ehdr.bpup2_toggle_bit",
FT_BOOLEAN, 8, TFS (&odd_even_tfs), 0x40,
- "NULL", HFILL},
+ NULL, HFILL}
},
{&hf_docsis_ehdr_bpup2_sid,
{"SID", "docsis.ehdr.bpup2_sid",
FT_UINT16, BASE_DEC, NULL, 0x3FFF,
"Service Identifier", HFILL}
},
+ { &hf_docsis_ehdr_pv_st_refpt,
+ { "Start Reference Point", "docsis.ehdr.pv_start_ref",
+ FT_UINT8, BASE_DEC, NULL, 0x0,
+ NULL, HFILL}
+ },
+ { &hf_docsis_ehdr_pv_timestamp,
+ { "Timestamp", "docsis.ehdr.pv_timestamp",
+ FT_UINT32, BASE_DEC, NULL, 0x0,
+ NULL, HFILL}
+ },
{&hf_docsis_ehdr_ds_traffic_pri,
{"DS Traffic Priority", "docsis.ehdr.ds_traffic_pri",
FT_UINT8, BASE_DEC, NULL, 0xE0,
- "NULL", HFILL}
+ NULL, HFILL}
},
{&hf_docsis_ehdr_ds_seq_chg_cnt,
{"DS Sequence Change Count", "docsis.ehdr.ds_seq_chg_cnt",
FT_UINT8, BASE_DEC, NULL, 0x10,
- "NULL", HFILL}
+ NULL, HFILL}
},
{&hf_docsis_ehdr_ds_dsid,
{"DS DSID", "docsis.ehdr.ds_dsid",
FT_UINT32, BASE_DEC, NULL, 0x0FFFFF,
- "NULL", HFILL}
+ NULL, HFILL}
},
{&hf_docsis_ehdr_ds_pkt_seq_num,
{"DS Packet Sequence Number", "docsis.ehdr.ds_pkt_seq_num",
FT_UINT16, BASE_DEC, NULL, 0x0,
- "NULL", HFILL}
+ NULL, HFILL}
},
{&hf_docsis_hcs,
{"Header check sequence", "docsis.hcs",
FT_UINT16, BASE_HEX, NULL, 0x0,
- NULL, HFILL},
+ NULL, HFILL}
},
- {&hf_docsis_bpi_en,
- {"Encryption", "docsis.bpi_en",
- FT_BOOLEAN, 8, TFS (&ena_dis_tfs), 0x80,
- "BPI Enable", HFILL},
+ { &hf_docsis_hcs_status,
+ { "HCS Status", "docsis.hcs.status",
+ FT_UINT8, BASE_NONE, VALS(local_proto_checksum_vals), 0x0,
+ NULL, HFILL}
},
- {&hf_docsis_toggle_bit,
- {"Toggle", "docsis.toggle_bit",
- FT_BOOLEAN, 8, TFS (&odd_even_tfs), 0x40,
- NULL, HFILL},
+ { &hf_docsis_bpi_en,
+ { "Encryption", "docsis.bpi_en",
+ FT_BOOLEAN, 8, TFS (&ena_dis_tfs), 0x80,
+ "BPI Enable", HFILL}
+ },
+ { &hf_docsis_toggle_bit,
+ { "Toggle", "docsis.toggle_bit",
+ FT_BOOLEAN, 8, TFS (&odd_even_tfs), 0x40,
+ NULL, HFILL}
+ },
+ { &hf_docsis_fragment_overlap,
+ { "Fragment overlap", "docsis.fragment.overlap",
+ FT_BOOLEAN, BASE_NONE, NULL, 0x0,
+ "Fragment overlaps with other fragments", HFILL}
+ },
+ { &hf_docsis_fragment_overlap_conflict,
+ { "Conflicting data in fragment overlap", "docsis.fragment.overlap.conflict",
+ FT_BOOLEAN, BASE_NONE, NULL, 0x0,
+ "Overlapping fragments contained conflicting data", HFILL}
+ },
+ { &hf_docsis_fragment_multiple_tails,
+ { "Multiple tail fragments found", "docsis.fragment.multipletails",
+ FT_BOOLEAN, BASE_NONE, NULL, 0x0,
+ "Several tails were found when defragmenting the packet", HFILL}
},
+ { &hf_docsis_fragment_too_long_fragment,
+ { "Fragment too long", "docsis.fragment.toolongfragment",
+ FT_BOOLEAN, BASE_NONE, NULL, 0x0,
+ "Fragment contained data past end of packet", HFILL}
+ },
+ { &hf_docsis_fragment_error,
+ { "Defragmentation error", "docsis.fragment.error",
+ FT_FRAMENUM, BASE_NONE, NULL, 0x0,
+ "Defragmentation error due to illegal fragments", HFILL}
+ },
+ { &hf_docsis_fragment_count,
+ { "Fragment count", "docsis.fragment.count",
+ FT_UINT32, BASE_DEC, NULL, 0x0,
+ NULL, HFILL}
+ },
+ { &hf_docsis_fragment,
+ { "DOCSIS Fragment", "docsis.fragment",
+ FT_FRAMENUM, BASE_NONE, NULL, 0x0,
+ NULL, HFILL}
+ },
+ { &hf_docsis_fragments,
+ { "DOCSIS Fragments", "docsis.fragments",
+ FT_BYTES, BASE_NONE, NULL, 0x0,
+ NULL, HFILL}
+ },
+ { &hf_docsis_reassembled_in,
+ { "Reassembled DOCSIS in frame", "docsis.reassembled_in",
+ FT_FRAMENUM, BASE_NONE, NULL, 0x0,
+ "This DOCSIS packet is reassembled in this frame", HFILL}
+ },
+ { &hf_docsis_reassembled_length,
+ { "Reassembled DOCSIS length", "docsis.reassembled.length",
+ FT_UINT32, BASE_DEC, NULL, 0x0,
+ "The total length of the reassembled payload", HFILL}
+ },
+ { &hf_docsis_reassembled_data,
+ { "Reassembled DOCSIS data", "docsis.reassembled.data",
+ FT_BYTES, BASE_NONE, NULL, 0x0,
+ "The reassembled payload", HFILL}
+ },
+ { &hf_docsis_frag_fcs,
+ { "Fragment FCS", "docsis.frag.fcs",
+ FT_UINT32, BASE_HEX, NULL, 0x0,
+ NULL, HFILL}
+ },
+ { &hf_docsis_frag_fcs_status,
+ { "Fragment FCS Status", "docsis.frag.fcs.status",
+ FT_UINT8, BASE_NONE, VALS(local_proto_checksum_vals), 0x0,
+ NULL, HFILL}
+ }
+ };
+ static ei_register_info ei[] = {
+ { &ei_docsis_hcs_bad, { "docsis.hcs_bad", PI_CHECKSUM, PI_ERROR, "Bad checksum", EXPFILL }},
+ { &ei_docsis_len, { "docsis.len.past_end", PI_MALFORMED, PI_ERROR, "Length field value goes past the end of the payload", EXPFILL }},
+ { &ei_docsis_frag_fcs_bad, { "docsis.frag.fcs_bad", PI_CHECKSUM, PI_ERROR, "Bad checksum", EXPFILL }},
+ { &ei_docsis_eh_len, { "docsis.ehdr.len.past_end", PI_MALFORMED, PI_ERROR, "Extended Header Length Invalid!", EXPFILL }}
};
static gint *ett[] = {
- &ett_docsis,
- &ett_ehdr,
+ &ett_docsis,
+ &ett_ehdr,
+ &ett_docsis_fragment,
+ &ett_docsis_fragments
};
- proto_docsis = proto_register_protocol ("DOCSIS 1.1", "DOCSIS", "docsis");
+ module_t *docsis_module;
+ expert_module_t* expert_docsis;
+ proto_docsis = proto_register_protocol ("DOCSIS", "DOCSIS", "docsis");
proto_register_field_array (proto_docsis, hf, array_length (hf));
proto_register_subtree_array (ett, array_length (ett));
+ /* register expert notifications */
+ expert_docsis = expert_register_protocol(proto_docsis);
+ expert_register_field_array(expert_docsis, ei, array_length(ei));
+
+ /* Register configuration preferences */
+ docsis_module = prefs_register_protocol(proto_docsis, NULL);
+ prefs_register_bool_preference(docsis_module, "check_fcs",
+ "Validate the DOCSIS checksum if possible",
+ "Whether or not to validate the Header Check Sequence",
+ &docsis_check_fcs);
+
#if 0
docsis_dissector_table = register_dissector_table ("docsis",
"DOCSIS Encapsulation Type", proto_docsis,
@@ -829,6 +1153,8 @@ proto_register_docsis (void)
#endif
register_dissector ("docsis", dissect_docsis, proto_docsis);
+ register_init_routine(docsis_defragment_init);
+ register_cleanup_routine(docsis_defragment_cleanup);
}
void