2 * Routines for DCD Message dissection
3 * Copyright 2004, Darryl Hymel <darryl.hymel[AT]arrisi.com>
7 * Wireshark - Network traffic analyzer
8 * By Gerald Combs <gerald@wireshark.org>
9 * Copyright 1998 Gerald Combs
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version 2
14 * of the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
30 #include <epan/packet.h>
32 #define DCD_DOWN_CLASSIFIER 23
33 #define DCD_DSG_RULE 50
34 #define DCD_DSG_CONFIG 51
36 /* Define Downstrean Classifier subtypes
37 * These are subtype of DCD_DOWN_CLASSIFIER (23)
41 #define DCD_CFR_RULE_PRI 5
42 #define DCD_CFR_IP_CLASSIFIER 9
44 /* Define IP Classifier sub-subtypes
45 * These are subtypes of DCD_CFR_IP_CLASSIFIER (23.9)
47 #define DCD_CFR_IP_SOURCE_ADDR 3
48 #define DCD_CFR_IP_SOURCE_MASK 4
49 #define DCD_CFR_IP_DEST_ADDR 5
50 #define DCD_CFR_IP_DEST_MASK 6
51 #define DCD_CFR_TCPUDP_SRCPORT_START 7
52 #define DCD_CFR_TCPUDP_SRCPORT_END 8
53 #define DCD_CFR_TCPUDP_DSTPORT_START 9
54 #define DCD_CFR_TCPUDP_DSTPORT_END 10
56 /* Define DSG Rule subtypes
57 * These are subtype of DCD_DSG_RULE (50)
61 #define DCD_RULE_PRI 2
62 #define DCD_RULE_UCID_RNG 3
63 #define DCD_RULE_CLIENT_ID 4
64 #define DCD_RULE_TUNL_ADDR 5
65 #define DCD_RULE_CFR_ID 6
66 #define DCD_RULE_VENDOR_SPEC 43
67 /* Define DSG Rule Client ID sub-subtypes
68 * These are subtypes of DCD_RULE_CLIENT_ID (50.4)
70 #define DCD_CLID_BCAST_ID 1
71 #define DCD_CLID_KNOWN_MAC_ADDR 2
72 #define DCD_CLID_CA_SYS_ID 3
73 #define DCD_CLID_APP_ID 4
75 /* Define DSG Configuration subtypes
76 * These are subtype of DCD_DSG_CONFIG (51)
79 #define DCD_CFG_CHAN_LST 1
80 #define DCD_CFG_TDSG1 2
81 #define DCD_CFG_TDSG2 3
82 #define DCD_CFG_TDSG3 4
83 #define DCD_CFG_TDSG4 5
84 #define DCD_CFG_VENDOR_SPEC 43
86 /* Initialize the protocol and registered fields */
87 static int proto_docsis_dcd = -1;
89 static int hf_docsis_dcd_config_ch_cnt = -1;
90 static int hf_docsis_dcd_num_of_frag = -1;
91 static int hf_docsis_dcd_frag_sequence_num = -1;
92 static int hf_docsis_dcd_cfr_id = -1;
93 static int hf_docsis_dcd_cfr_rule_pri = -1;
94 static int hf_docsis_dcd_cfr_ip_source_addr = -1;
95 static int hf_docsis_dcd_cfr_ip_source_mask = -1;
96 static int hf_docsis_dcd_cfr_ip_dest_addr = -1;
97 static int hf_docsis_dcd_cfr_ip_dest_mask = -1;
98 static int hf_docsis_dcd_cfr_tcpudp_srcport_start = -1;
99 static int hf_docsis_dcd_cfr_tcpudp_srcport_end = -1;
100 static int hf_docsis_dcd_cfr_tcpudp_dstport_start = -1;
101 static int hf_docsis_dcd_cfr_tcpudp_dstport_end = -1;
102 static int hf_docsis_dcd_rule_id = -1;
103 static int hf_docsis_dcd_rule_pri = -1;
104 static int hf_docsis_dcd_rule_ucid_list = -1;
105 static int hf_docsis_dcd_clid_known_mac_addr = -1;
106 static int hf_docsis_dcd_clid_ca_sys_id = -1;
107 static int hf_docsis_dcd_clid_app_id = -1;
108 static int hf_docsis_dcd_rule_tunl_addr = -1;
109 static int hf_docsis_dcd_rule_cfr_id = -1;
110 static int hf_docsis_dcd_rule_vendor_spec = -1;
111 static int hf_docsis_dcd_cfg_chan = -1;
112 static int hf_docsis_dcd_cfg_tdsg1 = -1;
113 static int hf_docsis_dcd_cfg_tdsg2 = -1;
114 static int hf_docsis_dcd_cfg_tdsg3 = -1;
115 static int hf_docsis_dcd_cfg_tdsg4 = -1;
116 static int hf_docsis_dcd_cfg_vendor_spec = -1;
118 /* Initialize the subtree pointers */
119 static gint ett_docsis_dcd = -1;
120 static gint ett_docsis_dcd_cfr = -1;
121 static gint ett_docsis_dcd_cfr_ip = -1;
122 static gint ett_docsis_dcd_rule = -1;
123 static gint ett_docsis_dcd_clid = -1;
124 static gint ett_docsis_dcd_cfg = -1;
126 /* Code to actually dissect the packets */
128 dissect_dcd_dsg_cfg (tvbuff_t * tvb, proto_tree * tree, int start, guint16 len)
131 proto_item *dcd_item;
132 proto_tree *dcd_tree;
136 dcd_item = proto_tree_add_text ( tree, tvb, start, len, "51 DCD DSG Config Encodings (Length = %u)", len);
137 dcd_tree = proto_item_add_subtree ( dcd_item , ett_docsis_dcd_cfg);
139 while ( pos < ( start + len) )
141 type = tvb_get_guint8 (tvb, pos++);
142 length = tvb_get_guint8 (tvb, pos++);
146 case DCD_CFG_CHAN_LST:
149 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfg_chan, tvb,
154 THROW (ReportedBoundsError);
160 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfg_tdsg1, tvb,
165 THROW (ReportedBoundsError);
171 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfg_tdsg2, tvb,
176 THROW (ReportedBoundsError);
182 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfg_tdsg3, tvb,
187 THROW (ReportedBoundsError);
193 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfg_tdsg4, tvb,
198 THROW (ReportedBoundsError);
201 case DCD_CFG_VENDOR_SPEC:
202 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfg_vendor_spec, tvb,
211 dissect_dcd_down_classifier_ip (tvbuff_t * tvb, proto_tree * tree, int start, guint16 len)
214 proto_item *dcd_item;
215 proto_tree *dcd_tree;
219 dcd_item = proto_tree_add_text ( tree, tvb, start, len, "23.9 DCD_CFR_IP Encodings (Length = %u)", len);
220 dcd_tree = proto_item_add_subtree ( dcd_item , ett_docsis_dcd_cfr_ip);
222 while ( pos < ( start + len) )
224 type = tvb_get_guint8 (tvb, pos++);
225 length = tvb_get_guint8 (tvb, pos++);
229 case DCD_CFR_IP_SOURCE_ADDR:
232 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfr_ip_source_addr, tvb,
237 THROW (ReportedBoundsError);
240 case DCD_CFR_IP_SOURCE_MASK:
243 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfr_ip_source_mask, tvb,
248 THROW (ReportedBoundsError);
251 case DCD_CFR_IP_DEST_ADDR:
254 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfr_ip_dest_addr, tvb,
259 THROW (ReportedBoundsError);
262 case DCD_CFR_IP_DEST_MASK:
265 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfr_ip_dest_mask, tvb,
270 THROW (ReportedBoundsError);
273 case DCD_CFR_TCPUDP_SRCPORT_START:
276 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfr_tcpudp_srcport_start, tvb,
281 THROW (ReportedBoundsError);
284 case DCD_CFR_TCPUDP_SRCPORT_END:
287 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfr_tcpudp_srcport_end, tvb,
292 THROW (ReportedBoundsError);
295 case DCD_CFR_TCPUDP_DSTPORT_START:
298 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfr_tcpudp_dstport_start, tvb,
303 THROW (ReportedBoundsError);
306 case DCD_CFR_TCPUDP_DSTPORT_END:
309 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfr_tcpudp_dstport_end, tvb,
314 THROW (ReportedBoundsError);
322 dissect_dcd_clid (tvbuff_t * tvb, proto_tree * tree, int start, guint16 len)
325 proto_item *dcd_item;
326 proto_tree *dcd_tree;
330 dcd_item = proto_tree_add_text ( tree, tvb, start, len, "50.4 DCD Rule ClientID Encodings (Length = %u)", len);
331 dcd_tree = proto_item_add_subtree ( dcd_item , ett_docsis_dcd_clid);
333 while ( pos < ( start + len) )
335 type = tvb_get_guint8 (tvb, pos++);
336 length = tvb_get_guint8 (tvb, pos++);
340 case DCD_CLID_KNOWN_MAC_ADDR:
343 proto_tree_add_item (dcd_tree, hf_docsis_dcd_clid_known_mac_addr, tvb,
348 THROW (ReportedBoundsError);
351 case DCD_CLID_CA_SYS_ID:
354 proto_tree_add_item (dcd_tree, hf_docsis_dcd_clid_ca_sys_id, tvb,
359 THROW (ReportedBoundsError);
362 case DCD_CLID_APP_ID:
365 proto_tree_add_item (dcd_tree, hf_docsis_dcd_clid_app_id, tvb,
370 THROW (ReportedBoundsError);
378 dissect_dcd_dsg_rule (tvbuff_t * tvb, proto_tree * tree, int start, guint16 len)
381 proto_item *dcd_item;
382 proto_tree *dcd_tree;
386 dcd_item = proto_tree_add_text ( tree, tvb, start, len, "50 DCD DSG Rule Encodings (Length = %u)", len);
387 dcd_tree = proto_item_add_subtree ( dcd_item , ett_docsis_dcd_rule);
389 while ( pos < ( start + len) )
391 type = tvb_get_guint8 (tvb, pos++);
392 length = tvb_get_guint8 (tvb, pos++);
399 proto_tree_add_item (dcd_tree, hf_docsis_dcd_rule_id, tvb,
404 THROW (ReportedBoundsError);
410 proto_tree_add_item (dcd_tree, hf_docsis_dcd_rule_pri, tvb,
415 THROW (ReportedBoundsError);
418 case DCD_RULE_UCID_RNG:
419 proto_tree_add_item (dcd_tree, hf_docsis_dcd_rule_ucid_list, tvb,
422 case DCD_RULE_CLIENT_ID:
423 dissect_dcd_clid (tvb , dcd_tree , pos , length );
425 case DCD_RULE_TUNL_ADDR:
428 proto_tree_add_item (dcd_tree, hf_docsis_dcd_rule_tunl_addr, tvb,
433 THROW (ReportedBoundsError);
436 case DCD_RULE_CFR_ID:
439 proto_tree_add_item (dcd_tree, hf_docsis_dcd_rule_cfr_id, tvb,
444 THROW (ReportedBoundsError);
447 case DCD_RULE_VENDOR_SPEC:
448 proto_tree_add_item (dcd_tree, hf_docsis_dcd_rule_vendor_spec, tvb,
457 dissect_dcd_down_classifier (tvbuff_t * tvb, proto_tree * tree, int start, guint16 len)
460 proto_item *dcd_item;
461 proto_tree *dcd_tree;
465 dcd_item = proto_tree_add_text ( tree, tvb, start, len, "23 DCD_CFR Encodings (Length = %u)", len);
466 dcd_tree = proto_item_add_subtree ( dcd_item , ett_docsis_dcd_cfr);
468 while ( pos < ( start + len) )
470 type = tvb_get_guint8 (tvb, pos++);
471 length = tvb_get_guint8 (tvb, pos++);
478 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfr_id, tvb,
483 THROW (ReportedBoundsError);
486 case DCD_CFR_RULE_PRI:
489 proto_tree_add_item (dcd_tree, hf_docsis_dcd_cfr_rule_pri, tvb,
494 THROW (ReportedBoundsError);
497 case DCD_CFR_IP_CLASSIFIER:
498 dissect_dcd_down_classifier_ip (tvb , dcd_tree , pos , length );
506 dissect_dcd (tvbuff_t * tvb, packet_info * pinfo, proto_tree * tree)
510 proto_tree *dcd_tree;
511 proto_item *dcd_item;
514 len = tvb_length_remaining (tvb, 0);
516 if (check_col (pinfo->cinfo, COL_INFO))
518 col_clear (pinfo->cinfo, COL_INFO);
519 col_add_fstr (pinfo->cinfo, COL_INFO,"DCD Message: ");
525 proto_tree_add_protocol_format (tree, proto_docsis_dcd, tvb, 0,
526 tvb_length_remaining (tvb, 0),
528 dcd_tree = proto_item_add_subtree (dcd_item, ett_docsis_dcd);
529 proto_tree_add_item (dcd_tree, hf_docsis_dcd_config_ch_cnt, tvb, 0, 1, FALSE);
530 proto_tree_add_item (dcd_tree, hf_docsis_dcd_num_of_frag, tvb, 1, 1, FALSE);
531 proto_tree_add_item (dcd_tree, hf_docsis_dcd_frag_sequence_num, tvb, 2, 1, FALSE);
536 type = tvb_get_guint8 (tvb, pos++);
537 length = tvb_get_guint8 (tvb, pos++);
540 case DCD_DOWN_CLASSIFIER:
541 dissect_dcd_down_classifier (tvb , dcd_tree , pos , length );
544 dissect_dcd_dsg_rule (tvb , dcd_tree , pos , length );
547 dissect_dcd_dsg_cfg (tvb , dcd_tree , pos , length );
551 } /* while (pos < len) */
555 /* Register the protocol with Wireshark */
557 /* this format is require because a script is used to build the C function
558 that calls all the protocol registration.
563 proto_register_docsis_dcd (void)
565 /* Setup list of header fields See Section 1.6.1 for details*/
566 static hf_register_info hf[] = {
567 {&hf_docsis_dcd_config_ch_cnt,
569 "Configuration Change Count",
570 "docsis_dcd.config_ch_cnt",
571 FT_UINT8, BASE_DEC, NULL, 0x0,
576 {&hf_docsis_dcd_num_of_frag,
578 "Number of Fragments",
579 "docsis_dcd.num_of_frag",
580 FT_UINT8, BASE_DEC, NULL, 0x0,
585 {&hf_docsis_dcd_frag_sequence_num,
587 "Fragment Sequence Number",
588 "docsis_dcd.frag_sequence_num",
589 FT_UINT8, BASE_DEC, NULL, 0x0,
594 {&hf_docsis_dcd_cfr_id,
596 "Downstream Classifier Id",
598 FT_UINT16, BASE_DEC, NULL, 0x0,
603 {&hf_docsis_dcd_cfr_rule_pri,
605 "Downstream Classifier Rule Priority",
606 "docsis_dcd.cfr_rule_pri",
607 FT_UINT8, BASE_DEC, NULL, 0x0,
612 {&hf_docsis_dcd_cfr_ip_source_addr,
614 "Downstream Classifier IP Source Address",
615 "docsis_dcd.cfr_ip_source_addr",
616 FT_IPv4, BASE_NONE, NULL, 0x0,
621 {&hf_docsis_dcd_cfr_ip_source_mask,
623 "Downstream Classifier IP Source Mask",
624 "docsis_dcd.cfr_ip_source_mask",
625 FT_IPv4, BASE_NONE, NULL, 0x0,
630 {&hf_docsis_dcd_cfr_ip_dest_addr,
632 "Downstream Classifier IP Destination Address",
633 "docsis_dcd.cfr_ip_dest_addr",
634 FT_IPv4, BASE_NONE, NULL, 0x0,
639 {&hf_docsis_dcd_cfr_ip_dest_mask,
641 "Downstream Classifier IP Destination Mask",
642 "docsis_dcd.cfr_ip_dest_mask",
643 FT_IPv4, BASE_NONE, NULL, 0x0,
644 "Downstream Classifier IP Destination Address",
648 {&hf_docsis_dcd_cfr_tcpudp_srcport_start,
650 "Downstream Classifier IP TCP/UDP Source Port Start",
651 "docsis_dcd.cfr_ip_tcpudp_srcport_start",
652 FT_UINT16, BASE_DEC, NULL, 0x0,
657 {&hf_docsis_dcd_cfr_tcpudp_srcport_end,
659 "Downstream Classifier IP TCP/UDP Source Port End",
660 "docsis_dcd.cfr_ip_tcpudp_srcport_end",
661 FT_UINT16, BASE_DEC, NULL, 0x0,
666 {&hf_docsis_dcd_cfr_tcpudp_dstport_start,
668 "Downstream Classifier IP TCP/UDP Destination Port Start",
669 "docsis_dcd.cfr_ip_tcpudp_dstport_start",
670 FT_UINT16, BASE_DEC, NULL, 0x0,
675 {&hf_docsis_dcd_cfr_tcpudp_dstport_end,
677 "Downstream Classifier IP TCP/UDP Destination Port End",
678 "docsis_dcd.cfr_ip_tcpudp_dstport_end",
679 FT_UINT16, BASE_DEC, NULL, 0x0,
684 {&hf_docsis_dcd_rule_id,
687 "docsis_dcd.rule_id",
688 FT_UINT8, BASE_DEC, NULL, 0x0,
693 {&hf_docsis_dcd_rule_pri,
696 "docsis_dcd.rule_pri",
697 FT_UINT8, BASE_DEC, NULL, 0x0,
702 {&hf_docsis_dcd_rule_ucid_list,
704 "DSG Rule UCID Range",
705 "docsis_dcd.rule_ucid_list",
706 FT_BYTES, BASE_NONE, NULL, 0x0,
711 {&hf_docsis_dcd_clid_known_mac_addr,
713 "DSG Rule Client ID Known MAC Address",
714 "docsis_dcd.clid_known_mac_addr",
715 FT_ETHER, BASE_NONE, NULL, 0x0,
720 {&hf_docsis_dcd_clid_ca_sys_id,
722 "DSG Rule Client ID CA System ID",
723 "docsis_dcd.clid_ca_sys_id",
724 FT_UINT16, BASE_DEC, NULL, 0x0,
729 {&hf_docsis_dcd_clid_app_id,
731 "DSG Rule Client ID Application ID",
732 "docsis_dcd.clid_app_id",
733 FT_UINT16, BASE_DEC, NULL, 0x0,
738 {&hf_docsis_dcd_rule_tunl_addr,
740 "DSG Rule Tunnel MAC Address",
741 "docsis_dcd.rule_tunl_addr",
742 FT_ETHER, BASE_NONE, NULL, 0x0,
747 {&hf_docsis_dcd_rule_cfr_id,
749 "DSG Rule Classifier ID",
750 "docsis_dcd.rule_cfr_id",
751 FT_UINT16, BASE_DEC, NULL, 0x0,
756 {&hf_docsis_dcd_rule_vendor_spec,
758 "DSG Rule Vendor Specific Parameters",
759 "docsis_dcd.rule_vendor_spec",
760 FT_BYTES, BASE_NONE, NULL, 0x0,
765 {&hf_docsis_dcd_cfg_chan,
767 "DSG Configuration Channel",
768 "docsis_dcd.cfg_chan",
769 FT_UINT32, BASE_DEC, NULL, 0x0,
774 {&hf_docsis_dcd_cfg_tdsg1,
776 "DSG Initialization Timeout (Tdsg1)",
777 "docsis_dcd.cfg_tdsg1",
778 FT_UINT16, BASE_DEC, NULL, 0x0,
783 {&hf_docsis_dcd_cfg_tdsg2,
785 "DSG Operational Timeout (Tdsg2)",
786 "docsis_dcd.cfg_tdsg2",
787 FT_UINT16, BASE_DEC, NULL, 0x0,
792 {&hf_docsis_dcd_cfg_tdsg3,
794 "DSG Two-Way Retry Timer (Tdsg3)",
795 "docsis_dcd.cfg_tdsg3",
796 FT_UINT16, BASE_DEC, NULL, 0x0,
801 {&hf_docsis_dcd_cfg_tdsg4,
803 "DSG One-Way Retry Timer (Tdsg4)",
804 "docsis_dcd.cfg_tdsg4",
805 FT_UINT16, BASE_DEC, NULL, 0x0,
810 {&hf_docsis_dcd_cfg_vendor_spec,
812 "DSG Configuration Vendor Specific Parameters",
813 "docsis_dcd.cfg_vendor_spec",
814 FT_BYTES, BASE_NONE, NULL, 0x0,
822 /* Setup protocol subtree array */
823 static gint *ett[] = {
826 &ett_docsis_dcd_cfr_ip,
827 &ett_docsis_dcd_rule,
828 &ett_docsis_dcd_clid,
832 /* Register the protocol name and description */
834 proto_register_protocol ("DOCSIS Downstream Channel Descriptor",
835 "DOCSIS DCD", "docsis_dcd");
837 /* Required function calls to register the header fields and subtrees used */
838 proto_register_field_array (proto_docsis_dcd, hf, array_length (hf));
839 proto_register_subtree_array (ett, array_length (ett));
841 register_dissector ("docsis_dcd", dissect_dcd, proto_docsis_dcd);
845 /* If this dissector uses sub-dissector registration add a registration routine.
846 This format is required because a script is used to find these routines and
847 create the code that calls these routines.
850 proto_reg_handoff_docsis_dcd (void)
852 dissector_handle_t docsis_dcd_handle;
854 docsis_dcd_handle = find_dissector ("docsis_dcd");
855 dissector_add ("docsis_mgmt", 0x20, docsis_dcd_handle);