osmocom
/
wireshark
11
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity
wireshark/epan/dissectors/packet-wisun.c

1106 lines
39 KiB
C
Raw Blame History

/* packet-ieee802154.c
*
* Wi-SUN IE Dissectors for Wireshark
* By Owen Kirby <osk@exegin.com>
* Copyright 2007 Exegin Technologies Limited
*
* 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/decode_as.h>
#include <epan/exceptions.h>
#include <epan/expert.h>
#include <epan/addr_resolv.h>
#include <epan/address_types.h>
#include <epan/prefs.h>
#include <epan/strutil.h>
#include <epan/to_str.h>
#include <epan/show_exception.h>
#include <epan/proto_data.h>
#include <epan/etypes.h>
#include <epan/oui.h>
#include <wsutil/pint.h>
#include "packet-ieee802154.h"
void proto_register_wisun(void);
void proto_reg_handoff_wisun(void);
/* Wi-SUN Header IE Sub-ID Values. */
#define WISUN_SUBID_UTT 1
#define WISUN_SUBID_BT 2
#define WISUN_SUBID_FC 3
#define WISUN_SUBID_RSL 4
#define WISUN_SUBID_MHDS 5
#define WISUN_SUBID_VH 6
/* Wi-SUN Payload/Nested ID values. */
#define WISUN_PIE_SUBID_US 1
#define WISUN_PIE_SUBID_BS 2
#define WISUN_PIE_SUBID_VP 3
#define WISUN_PIE_SUBID_PAN 4
#define WISUN_PIE_SUBID_NETNAME 5
#define WISUN_PIE_SUBID_PENVER 6
#define WISUN_PIE_SUBID_GTKHASH 7
#define WISUN_CHANNEL_PLAN 0x07
#define WISUN_CHANNEL_FUNCTION 0x38
#define WISUN_CHANNEL_EXCLUDE 0xc0
#define WISUN_CHANNEL_PLAN_REGULATORY 0
#define WISUN_CHANNEL_PLAN_SPACING 1
#define WISUN_CHANNEL_FUNCTION_FIXED 0
#define WISUN_CHANNEL_FUNCTION_TR51CF 1
#define WISUN_CHANNEL_FUNCTION_DH1CF 2
#define WISUN_CHANNEL_FUNCTION_VENDOR 3
#define WISUN_CHANNEL_EXCLUDE_NONE 0
#define WISUN_CHANNEL_EXCLUDE_RANGE 1
#define WISUN_CHANNEL_EXCLUDE_MASK 2
static int proto_wisun = -1;
static int hf_wisun_subid = -1;
static int hf_wisun_unknown_ie = -1;
static int hf_wisun_uttie = -1;
static int hf_wisun_uttie_type = -1;
static int hf_wisun_uttie_ufsi = -1;
static int hf_wisun_btie = -1;
static int hf_wisun_btie_slot = -1;
static int hf_wisun_btie_bfio = -1;
static int hf_wisun_fcie = -1;
static int hf_wisun_fcie_tx = -1;
static int hf_wisun_fcie_rx = -1;
static int hf_wisun_rslie = -1;
static int hf_wisun_rslie_rsl = -1;
static int hf_wisun_vhie = -1;
static int hf_wisun_vhie_vid = -1;
static int hf_wisun_pie = -1;
static int hf_wisun_wsie = -1;
static int hf_wisun_wsie_type = -1;
static int hf_wisun_wsie_id = -1;
static int hf_wisun_wsie_length = -1;
static int hf_wisun_usie = -1;
static int hf_wisun_usie_dwell_interval = -1;
static int hf_wisun_usie_clock_drift = -1;
static int hf_wisun_usie_timing_accuracy = -1;
static int hf_wisun_usie_channel_control = -1;
static int hf_wisun_usie_channel_plan = -1;
static int hf_wisun_usie_channel_function = -1;
static int hf_wisun_usie_channel_exclude = -1;
static int hf_wisun_usie_regulatory_domain = -1;
static int hf_wisun_usie_operating_class = -1;
static int hf_wisun_usie_channel_frequency = -1;
static int hf_wisun_usie_channel_spacing = -1;
static int hf_wisun_usie_number_channels = -1;
static int hf_wisun_usie_fixed_channel = -1;
static int hf_wisun_usie_hop_count = -1;
static int hf_wisun_usie_hop_list = -1;
static int hf_wisun_usie_number_ranges = -1;
static int hf_wisun_usie_exclude_range = -1;
static int hf_wisun_usie_exclude_mask = -1;
static int hf_wisun_bsie = -1;
static int hf_wisun_bsie_bcast_interval = -1;
static int hf_wisun_bsie_bcast_schedule_id = -1;
static int hf_wisun_vpie = -1;
static int hf_wisun_vpie_vid = -1;
static int hf_wisun_panie = -1;
static int hf_wisun_panie_size = -1;
static int hf_wisun_panie_cost = -1;
static int hf_wisun_panie_flags = -1;
static int hf_wisun_panie_flag_parent_bsie = -1;
static int hf_wisun_panie_flag_routing_method = -1;
static int hf_wisun_panie_flag_eapol_ready = -1;
static int hf_wisun_panie_flag_version = -1;
static int hf_wisun_netnameie = -1;
static int hf_wisun_netnameie_name = -1;
static int hf_wisun_panverie = -1;
static int hf_wisun_panverie_version = -1;
static int hf_wisun_gtkhashie = -1;
static int hf_wisun_gtkhashie_gtk0 = -1;
static int hf_wisun_gtkhashie_gtk1 = -1;
static int hf_wisun_gtkhashie_gtk2 = -1;
static int hf_wisun_gtkhashie_gtk3 = -1;
static int proto_wisun_sec = -1;
static int hf_wisun_sec_function = -1;
static int hf_wisun_sec_error_type = -1;
static int hf_wisun_sec_error_nonce = -1;
static gint ett_wisun_unknown_ie = -1;
static gint ett_wisun_uttie = -1;
static gint ett_wisun_btie = -1;
static gint ett_wisun_fcie = -1;
static gint ett_wisun_rslie = -1;
static gint ett_wisun_vhie = -1;
static gint ett_wisun_pie = -1;
static gint ett_wisun_wsie_bitmap = -1;
static gint ett_wisun_usie = -1;
static gint ett_wisun_bsie = -1;
static gint ett_wisun_vpie = -1;
static gint ett_wisun_usie_channel_control;
static gint ett_wisun_panie = -1;
static gint ett_wisun_panie_flags = -1;
static gint ett_wisun_netnameie = -1;
static gint ett_wisun_panverie = -1;
static gint ett_wisun_gtkhashie = -1;
static gint ett_wisun_sec = -1;
static const value_string wisun_wsie_types[] = {
{ 0, "Short" },
{ 1, "Long" },
{ 0, NULL }
};
static const value_string wisun_subid_vals[] = {
{ WISUN_SUBID_UTT, "Unicast Timing IE" },
{ WISUN_SUBID_BT, "Broadcast Timing IE" },
{ WISUN_SUBID_FC, "Flow Control IE" },
{ WISUN_SUBID_RSL, "Received Signal Level IE" },
{ WISUN_SUBID_MHDS, "Multi-Hop Delivery Service IE" },
{ WISUN_SUBID_VH, "Vendor Header IE" },
{ 0, NULL }
};
static const value_string wisun_wsie_names[] = {
{ WISUN_PIE_SUBID_US, "Unicast Schedule IE" },
{ WISUN_PIE_SUBID_BS, "Broadcast Schedule IE" },
{ WISUN_PIE_SUBID_VP, "Vendor Payload IE" },
{ WISUN_PIE_SUBID_PAN, "PAN Information IE" },
{ WISUN_PIE_SUBID_NETNAME, "Network Name IE" },
{ WISUN_PIE_SUBID_PENVER, "PAN Version IE" },
{ WISUN_PIE_SUBID_GTKHASH, "GTK Hash IE" },
{ 0, NULL }
};
static const value_string wisun_frame_type_vals[] = {
{ 0, "PAN Advertisement" },
{ 1, "PAN Advertisement Solicit" },
{ 2, "PAN Configuration" },
{ 3, "PAN Configuration Solicit" },
{ 4, "Data" },
{ 5, "Acknowledgment" },
{ 6, "EAPOL" },
{ 0, NULL }
};
static const value_string wisun_channel_plan_names[] = {
{ WISUN_CHANNEL_PLAN_REGULATORY, "Regulatory Domain and Operating Class" },
{ WISUN_CHANNEL_PLAN_SPACING, "Channel Spacing and Number" },
{ 0, NULL }
};
static const value_string wisun_channel_function_names[] = {
{ WISUN_CHANNEL_FUNCTION_FIXED, "Fixed Channel" },
{ WISUN_CHANNEL_FUNCTION_TR51CF, "TR51 Channel Function" },
{ WISUN_CHANNEL_FUNCTION_DH1CF, "Direct Hash Channel Function" },
{ WISUN_CHANNEL_FUNCTION_VENDOR, "Vendor Defined Channel Function" },
{ 0, NULL }
};
static const value_string wisun_channel_exclude_names[] = {
{ WISUN_CHANNEL_EXCLUDE_NONE, "None" },
{ WISUN_CHANNEL_EXCLUDE_RANGE, "Ranges" },
{ WISUN_CHANNEL_EXCLUDE_MASK, "Bitmask" },
{ 0, NULL }
};
static const value_string wisun_channel_spacing_names[] = {
{ 0, "200 kHz" },
{ 1, "400 kHz" },
{ 2, "600 kHz" },
{ 0, NULL }
};
static const value_string wisun_routing_methods[] = {
{ 0, "RPL" },
{ 1, "MHDS" },
{ 0, NULL }
};
static const value_string wisun_sec_functions[] = {
{ 0x01, "SM Error" },
{ 0, NULL }
};
static const value_string wisun_sec_sm_errors[] = {
{ 0x01, "No Session" },
{ 0x02, "Unavailable Key" },
{ 0x03, "Unsupported Security" },
{ 0x04, "Invalid Parameter" },
{ 0x06, "Unsupported Security" },
{ 0, NULL }
};
static const int * wisun_format_nested_ie[] = {
&hf_wisun_wsie_type,
&hf_wisun_wsie_id,
&hf_wisun_wsie_length,
NULL
};
static expert_field ei_wisun_subid_unsupported = EI_INIT;
static expert_field ei_wisun_wsie_short_format = EI_INIT;
static expert_field ei_wisun_wsie_unsupported = EI_INIT;
static expert_field ei_wisun_usie_channel_plan_invalid = EI_INIT;
static int
wisun_add_wbxml_uint(tvbuff_t *tvb, proto_tree *tree, int hf, guint offset)
{
guint val = 0;
guint len = 0;
guint8 b;
do {
b = tvb_get_guint8(tvb, offset + len++);
val = (val << 7) | (b & 0x7f);
} while (b & 0x80);
proto_tree_add_uint(tree, hf, tvb, offset, len, val);
return len;
}
/*-----------------------------------------------
* Wi-SUN Header IE Dissection
*---------------------------------------------*/
static proto_tree *
wisun_create_hie_tree(tvbuff_t *tvb, proto_tree *tree, int hf, gint ett)
{
proto_tree *subtree = ieee802154_create_hie_tree(tvb, tree, hf, ett);
proto_tree_add_item(subtree, hf_wisun_subid, tvb, 2, 1, ENC_LITTLE_ENDIAN);
return subtree;
}
static int
dissect_wisun_uttie(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset)
{
guint8 frame_type = tvb_get_guint8(tvb, offset);
col_set_str(pinfo->cinfo, COL_PROTOCOL, "Wi-SUN");
col_set_str(pinfo->cinfo, COL_INFO, val_to_str_const(frame_type, wisun_frame_type_vals, "Unknown Wi-SUN Frame"));
proto_tree_add_item(tree, hf_wisun_uttie_type, tvb, offset, 1, ENC_LITTLE_ENDIAN);
proto_tree_add_item(tree, hf_wisun_uttie_ufsi, tvb, offset+1, 3, ENC_LITTLE_ENDIAN);
return 4;
}
static int
dissect_wisun_btie(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset)
{
proto_tree_add_item(tree, hf_wisun_btie_slot, tvb, offset, 2, ENC_LITTLE_ENDIAN);
proto_tree_add_item(tree, hf_wisun_btie_bfio, tvb, offset+2, 4, ENC_LITTLE_ENDIAN);
return 6;
}
static int
dissect_wisun_fcie(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset)
{
nstime_t ts;
ts.secs = 0;
ts.nsecs = tvb_get_guint8(tvb, offset) * 1000000UL;
proto_tree_add_time(tree, hf_wisun_fcie_tx, tvb, offset, 1, &ts);
ts.nsecs = tvb_get_guint8(tvb, offset+1) * 1000000UL;
proto_tree_add_time(tree, hf_wisun_fcie_rx, tvb, offset + 1, 1, &ts);
return 2;
}
static int
dissect_wisun_rslie(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset)
{
proto_tree_add_item(tree, hf_wisun_rslie_rsl, tvb, offset, 1, ENC_LITTLE_ENDIAN);
return 1;
}
static int
dissect_wisun_vhie(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset)
{
guint vidlen = wisun_add_wbxml_uint(tvb, tree, hf_wisun_vhie_vid, offset);
call_data_dissector(tvb_new_subset_remaining(tvb, offset + vidlen), pinfo, tree);
return tvb_reported_length(tvb);
}
static int
dissect_wisun_hie(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
guint offset;
proto_tree *subtree;
guint8 subid = tvb_get_guint8(tvb, 2);
offset = 3;
switch (subid) {
case WISUN_SUBID_UTT:
subtree = wisun_create_hie_tree(tvb, tree, hf_wisun_uttie, ett_wisun_uttie);
offset += dissect_wisun_uttie(tvb, pinfo, subtree, offset);
break;
case WISUN_SUBID_BT:
subtree = wisun_create_hie_tree(tvb, tree, hf_wisun_btie, ett_wisun_btie);
offset += dissect_wisun_btie(tvb, pinfo, subtree, offset);
break;
case WISUN_SUBID_FC:
subtree = wisun_create_hie_tree(tvb, tree, hf_wisun_fcie, ett_wisun_fcie);
offset += dissect_wisun_fcie(tvb, pinfo, subtree, offset);
break;
case WISUN_SUBID_RSL:
subtree = wisun_create_hie_tree(tvb, tree, hf_wisun_rslie, ett_wisun_rslie);
offset += dissect_wisun_rslie(tvb, pinfo, subtree, offset);
break;
case WISUN_SUBID_VH:
subtree = wisun_create_hie_tree(tvb, tree, hf_wisun_vhie, ett_wisun_vhie);
offset += dissect_wisun_vhie(tvb, pinfo, subtree, offset);
break;
default:
subtree = wisun_create_hie_tree(tvb, tree, hf_wisun_unknown_ie, ett_wisun_unknown_ie);
expert_add_info(pinfo, subtree, &ei_wisun_subid_unsupported);
call_data_dissector(tvb_new_subset_remaining(tvb, offset), pinfo, subtree);
offset = tvb_reported_length(tvb);
break;
}
return offset;
}
/*-----------------------------------------------
* Wi-SUN Payload IE Dissection
*---------------------------------------------*/
static int
dissect_wisun_channel_info(tvbuff_t *tvb, packet_info *pinfo, guint offset, proto_tree *tree, guint8 control)
{
guint count;
switch ((control & WISUN_CHANNEL_PLAN) >> 0) {
case WISUN_CHANNEL_PLAN_REGULATORY:
proto_tree_add_item(tree, hf_wisun_usie_regulatory_domain, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
proto_tree_add_item(tree, hf_wisun_usie_operating_class, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
break;
case WISUN_CHANNEL_PLAN_SPACING:
proto_tree_add_item(tree, hf_wisun_usie_channel_frequency, tvb, offset, 3, ENC_LITTLE_ENDIAN);
offset += 3;
proto_tree_add_item(tree, hf_wisun_usie_channel_spacing, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
proto_tree_add_item(tree, hf_wisun_usie_number_channels, tvb, offset, 2, ENC_LITTLE_ENDIAN);
offset += 2;
break;
default:
expert_add_info(pinfo, tree, &ei_wisun_usie_channel_plan_invalid);
return tvb_reported_length(tvb);
}
switch ((control & WISUN_CHANNEL_FUNCTION) >> 3) {
case WISUN_CHANNEL_FUNCTION_FIXED:
proto_tree_add_item(tree, hf_wisun_usie_fixed_channel, tvb, offset, 2, ENC_LITTLE_ENDIAN);
offset += 2;
break;
case WISUN_CHANNEL_FUNCTION_VENDOR:
count = tvb_get_guint8(tvb, offset);
proto_tree_add_item(tree, hf_wisun_usie_hop_count, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
while (count--) {
proto_tree_add_item(tree, hf_wisun_usie_hop_list, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
}
break;
default:
/* Hopping list is implied by the hashing function. */
break;
}
switch ((control & WISUN_CHANNEL_EXCLUDE) >> 6) {
case WISUN_CHANNEL_EXCLUDE_RANGE:
count = tvb_get_guint8(tvb, offset);
proto_tree_add_item(tree, hf_wisun_usie_number_ranges, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
while (count) {
guint16 ex_start = tvb_get_letohs(tvb, offset);
guint16 ex_end = tvb_get_letohs(tvb, offset+2);
proto_tree_add_uint_format_value(tree, hf_wisun_usie_exclude_range, tvb, offset, 4, ex_start, "[%u, %u]", ex_start, ex_end);
offset += 4;
count--;
}
break;
case WISUN_CHANNEL_EXCLUDE_MASK:
count = tvb_reported_length_remaining(tvb, offset);
proto_tree_add_item(tree, hf_wisun_usie_exclude_mask, tvb, offset, count, ENC_NA);
offset += count;
break;
default:
/* Assume there is nothing to exclude. */
break;
}
return offset;
}
static int
dissect_wisun_usie(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
proto_item *item;
proto_tree *subtree;
guint offset = 0;
guint8 channel_control;
static const int * fields_usie_channel[] = {
&hf_wisun_usie_channel_plan,
&hf_wisun_usie_channel_function,
&hf_wisun_usie_channel_exclude,
NULL
};
item = proto_tree_add_item(tree, hf_wisun_usie, tvb, 0, tvb_reported_length_remaining(tvb, 0), ENC_NA);
subtree = proto_item_add_subtree(item, ett_wisun_usie);
/* Fixed stuff */
proto_tree_add_bitmask(subtree, tvb, offset, hf_wisun_wsie, ett_wisun_wsie_bitmap, wisun_format_nested_ie, ENC_LITTLE_ENDIAN);
offset += 2;
proto_tree_add_item(subtree, hf_wisun_usie_dwell_interval, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
proto_tree_add_item(subtree, hf_wisun_usie_clock_drift, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
proto_tree_add_item(subtree, hf_wisun_usie_timing_accuracy, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
channel_control = tvb_get_guint8(tvb, offset);
proto_tree_add_bitmask_with_flags(subtree, tvb, offset, hf_wisun_usie_channel_control, ett_wisun_usie_channel_control,
fields_usie_channel, ENC_LITTLE_ENDIAN, BMT_NO_FLAGS);
offset++;
/* Variable stuff */
return offset + dissect_wisun_channel_info(tvb, pinfo, offset, subtree, channel_control);
}
static int
dissect_wisun_bsie(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
proto_item *item;
proto_tree *subtree;
guint offset = 0;
guint8 channel_control;
static const int * fields_usie_channel[] = {
&hf_wisun_usie_channel_plan,
&hf_wisun_usie_channel_function,
&hf_wisun_usie_channel_exclude,
NULL
};
item = proto_tree_add_item(tree, hf_wisun_bsie, tvb, 0, tvb_reported_length(tvb), ENC_NA);
subtree = proto_item_add_subtree(item, ett_wisun_bsie);
/* Fixed stuff */
proto_tree_add_bitmask(subtree, tvb, offset, hf_wisun_wsie, ett_wisun_wsie_bitmap, wisun_format_nested_ie, ENC_LITTLE_ENDIAN);
offset += 2;
proto_tree_add_item(subtree, hf_wisun_bsie_bcast_interval, tvb, offset, 4, ENC_LITTLE_ENDIAN);
offset += 4;
proto_tree_add_item(subtree, hf_wisun_bsie_bcast_schedule_id, tvb, offset, 2, ENC_LITTLE_ENDIAN);
offset += 2;
proto_tree_add_item(subtree, hf_wisun_usie_dwell_interval, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
proto_tree_add_item(subtree, hf_wisun_usie_clock_drift, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
proto_tree_add_item(subtree, hf_wisun_usie_timing_accuracy, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
channel_control = tvb_get_guint8(tvb, offset);
proto_tree_add_bitmask_with_flags(subtree, tvb, offset, hf_wisun_usie_channel_control, ett_wisun_usie_channel_control,
fields_usie_channel, ENC_LITTLE_ENDIAN, BMT_NO_FLAGS);
offset++;
/* Variable stuff */
return offset + dissect_wisun_channel_info(tvb, pinfo, offset, subtree, channel_control);
}
static int
dissect_wisun_vpie(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, void *data _U_)
{
proto_item *item;
proto_tree *subtree;
guint vidlen;
item = proto_tree_add_item(tree, hf_wisun_vpie, tvb, 0, tvb_reported_length(tvb), ENC_NA);
subtree = proto_item_add_subtree(item, ett_wisun_vpie);
vidlen = wisun_add_wbxml_uint(tvb, subtree, hf_wisun_vpie_vid, 2);
call_data_dissector(tvb_new_subset_remaining(tvb, 2 + vidlen), pinfo, subtree);
return tvb_reported_length(tvb);
}
static int
dissect_wisun_panie(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, void *data _U_)
{
proto_item *item;
proto_tree *subtree;
guint offset = 0;
static const int * fields_panie_flags[] = {
&hf_wisun_panie_flag_parent_bsie,
&hf_wisun_panie_flag_routing_method,
&hf_wisun_panie_flag_eapol_ready,
&hf_wisun_panie_flag_version,
NULL
};
item = proto_tree_add_item(tree, hf_wisun_panie, tvb, 0, tvb_reported_length(tvb), ENC_NA);
subtree = proto_item_add_subtree(item, ett_wisun_panie);
proto_tree_add_bitmask(subtree, tvb, offset, hf_wisun_wsie, ett_wisun_wsie_bitmap, wisun_format_nested_ie, ENC_LITTLE_ENDIAN);
offset += 2;
proto_tree_add_item(subtree, hf_wisun_panie_size, tvb, offset, 2, ENC_LITTLE_ENDIAN);
offset += 2;
proto_tree_add_item(subtree, hf_wisun_panie_cost, tvb, offset, 1, ENC_LITTLE_ENDIAN);
offset++;
proto_tree_add_bitmask_with_flags(subtree, tvb, offset, hf_wisun_panie_flags, ett_wisun_panie_flags,
fields_panie_flags, ENC_LITTLE_ENDIAN, BMT_NO_FLAGS);
offset++;
return offset;
}
static int
dissect_wisun_netnameie(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, void *data _U_)
{
proto_item *item;
proto_tree *subtree;
item = proto_tree_add_item(tree, hf_wisun_netnameie, tvb, 0, tvb_reported_length(tvb), ENC_NA);
subtree = proto_item_add_subtree(item, ett_wisun_netnameie);
proto_tree_add_bitmask(subtree, tvb, 0, hf_wisun_wsie, ett_wisun_wsie_bitmap, wisun_format_nested_ie, ENC_LITTLE_ENDIAN);
proto_tree_add_item(subtree, hf_wisun_netnameie_name, tvb, 2, tvb_reported_length_remaining(tvb, 2), ENC_ASCII|ENC_NA);
return tvb_reported_length(tvb);
}
static int
dissect_wisun_panverie(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, void *data _U_)
{
proto_item *item;
proto_tree *subtree;
item = proto_tree_add_item(tree, hf_wisun_panverie, tvb, 0, tvb_reported_length(tvb), ENC_NA);
subtree = proto_item_add_subtree(item, ett_wisun_panverie);
proto_tree_add_bitmask(subtree, tvb, 0, hf_wisun_wsie, ett_wisun_wsie_bitmap, wisun_format_nested_ie, ENC_LITTLE_ENDIAN);
proto_tree_add_item(subtree, hf_wisun_panverie_version, tvb, 2, 2, ENC_LITTLE_ENDIAN);
return tvb_reported_length(tvb);
}
static int
dissect_wisun_gtkhashie(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, void *data _U_)
{
proto_item *item;
proto_tree *subtree;
item = proto_tree_add_item(tree, hf_wisun_gtkhashie, tvb, 0, tvb_reported_length(tvb), ENC_NA);
subtree = proto_item_add_subtree(item, ett_wisun_gtkhashie);
proto_tree_add_bitmask(subtree, tvb, 0, hf_wisun_wsie, ett_wisun_wsie_bitmap, wisun_format_nested_ie, ENC_LITTLE_ENDIAN);
proto_tree_add_item(subtree, hf_wisun_gtkhashie_gtk0, tvb, 2, 8, ENC_LITTLE_ENDIAN);
proto_tree_add_item(subtree, hf_wisun_gtkhashie_gtk1, tvb, 10, 8, ENC_LITTLE_ENDIAN);
proto_tree_add_item(subtree, hf_wisun_gtkhashie_gtk2, tvb, 18, 8, ENC_LITTLE_ENDIAN);
proto_tree_add_item(subtree, hf_wisun_gtkhashie_gtk3, tvb, 26, 8, ENC_LITTLE_ENDIAN);
return 34;
}
static int
dissect_wisun_pie(tvbuff_t *tvb, packet_info *pinfo, proto_tree *ies_tree, void *data)
{
proto_tree *tree = ieee802154_create_pie_tree(tvb, ies_tree, hf_wisun_pie, ett_wisun_pie);
guint offset = 2;
while (tvb_reported_length_remaining(tvb, offset) > 1) {
/* Wi-SUN Payload IE contains nested IE's using the same format as IEEE802.15.4 */
guint16 wsie_ie = tvb_get_letohs(tvb, offset);
guint16 wsie_len;
tvbuff_t * wsie_tvb;
/* No Wi-SUN Sub-IEs are currently defined for the short format. */
if (!(wsie_ie & IEEE802154_PSIE_TYPE_MASK)) {
wsie_len = (wsie_ie & IEEE802154_PSIE_LENGTH_MASK_SHORT) + 2;
call_data_dissector(tvb_new_subset_remaining(tvb, offset), pinfo, tree);
expert_add_info(pinfo, tree, &ei_wisun_wsie_short_format);
offset += wsie_len + 2;
continue;
}
wsie_len = (wsie_ie & IEEE802154_PSIE_LENGTH_MASK_LONG);
wsie_tvb = tvb_new_subset_length(tvb, offset, wsie_len + 2);
switch ((wsie_ie & IEEE802154_PSIE_ID_MASK_LONG) >> 11) {
case WISUN_PIE_SUBID_US:
dissect_wisun_usie(wsie_tvb, pinfo, tree, data);
break;
case WISUN_PIE_SUBID_BS:
dissect_wisun_bsie(wsie_tvb, pinfo, tree, data);
break;
case WISUN_PIE_SUBID_VP:
dissect_wisun_vpie(wsie_tvb, pinfo, tree, data);
break;
case WISUN_PIE_SUBID_PAN:
dissect_wisun_panie(wsie_tvb, pinfo, tree, data);
break;
case WISUN_PIE_SUBID_NETNAME:
dissect_wisun_netnameie(wsie_tvb, pinfo, tree, data);
break;
case WISUN_PIE_SUBID_PENVER:
dissect_wisun_panverie(wsie_tvb, pinfo, tree, data);
break;
case WISUN_PIE_SUBID_GTKHASH:
dissect_wisun_gtkhashie(wsie_tvb, pinfo, tree, data);
break;
default:{
proto_item *item = proto_tree_add_item(tree, hf_wisun_unknown_ie, wsie_tvb, 0, tvb_reported_length(wsie_tvb), ENC_NA);
proto_tree *subtree = proto_item_add_subtree(item, ett_wisun_unknown_ie);
proto_tree_add_bitmask(subtree, wsie_tvb, 0, hf_wisun_wsie, ett_wisun_wsie_bitmap, wisun_format_nested_ie, ENC_LITTLE_ENDIAN);
expert_add_info(pinfo, subtree, &ei_wisun_wsie_unsupported);
call_data_dissector(tvb_new_subset_remaining(wsie_tvb, 2), pinfo, subtree);
break;
}
}
offset += (wsie_ie & IEEE802154_PSIE_LENGTH_MASK_LONG) + 2;
}
return offset;
}
/*-----------------------------------------------
* Wi-SUN FAN Security Extensions Dissection
*---------------------------------------------*/
static int
dissect_wisun_sec(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
proto_item *ws_root;
proto_tree *ws_tree;
guint8 function = tvb_get_guint8(tvb, 0);
const char *function_name = val_to_str_const(function, wisun_sec_functions, "Unknown Function");
/* Create the protocol tree. */
ws_root = proto_tree_add_protocol_format(tree, proto_wisun_sec, tvb, 0, -1, "Wi-SUN %s", function_name);
ws_tree = proto_item_add_subtree(ws_root, ett_wisun_sec);
/* Add the protocol name. */
col_set_str(pinfo->cinfo, COL_PROTOCOL, "Wi-SUN");
col_set_str(pinfo->cinfo, COL_INFO, function_name);
/* Decode based on the function code. */
proto_tree_add_item(ws_tree, hf_wisun_sec_function, tvb, 0, 1, ENC_LITTLE_ENDIAN);
switch (function) {
case 0x01:{
const char *err_name = val_to_str_const(tvb_get_guint8(tvb, 1), wisun_sec_sm_errors, "Unknown Error");
col_append_fstr(pinfo->cinfo, COL_INFO, ": %s", err_name);
proto_item_append_text(ws_root, ": %s", err_name);
proto_tree_add_item(ws_tree, hf_wisun_sec_error_type, tvb, 1, 1, ENC_LITTLE_ENDIAN);
proto_tree_add_item(ws_tree, hf_wisun_sec_error_nonce, tvb, 2, tvb_reported_length_remaining(tvb, 2), ENC_NA);
return tvb_reported_length(tvb);
}
default:
call_data_dissector(tvb_new_subset_remaining(tvb, 2), pinfo, ws_tree);
return tvb_reported_length(tvb);
}
}
/*-----------------------------------------------
* Wi-SUN Protocol Registration
*---------------------------------------------*/
void proto_register_wisun(void)
{
static hf_register_info hf[] = {
/* Wi-SUN Header IEs */
{ &hf_wisun_subid,
{ "Header Sub ID", "wisun.subid", FT_UINT8, BASE_DEC, VALS(wisun_subid_vals), 0x0,
NULL, HFILL }
},
{ &hf_wisun_unknown_ie,
{ "Unknown IE", "wisun.unknown", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_uttie,
{ "Unicast Timing IE", "wisun.uttie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_uttie_type,
{ "Frame Type", "wisun.uttie.type", FT_UINT8, BASE_DEC, VALS(wisun_frame_type_vals), 0x0,
NULL, HFILL }
},
{ &hf_wisun_uttie_ufsi,
{ "Unicast Fractional Sequence Interval", "wisun.uttie.ufsi", FT_UINT24, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_btie,
{ "Broadcast Timing IE", "wisun.btie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_btie_slot,
{ "Broadcast Slot Number", "wisun.btie.slot", FT_UINT24, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_btie_bfio,
{ "Broadcast Fractional Interval Offset", "wisun.btie.bfio", FT_UINT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_fcie,
{ "Flow Control IE", "wisun.fcie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_fcie_tx,
{ "Transmit Flow Control", "wisun.fcie.tx", FT_RELATIVE_TIME, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_fcie_rx,
{ "Receive Flow Control", "wisun.fcie.rx", FT_RELATIVE_TIME, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_rslie,
{ "Received Signal Level IE", "wisun.rslie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_rslie_rsl,
{ "Received Signal Level", "wisun.rslie.rsl", FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_vhie,
{ "Vendor Header IE", "wisun.vhie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_vhie_vid,
{ "Vendor ID", "wisun.vhie.vid", FT_UINT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
/* Wi-SUN Payload IE */
{ &hf_wisun_pie,
{ "Wi-SUN Payload IE", "wisun.pie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_wsie,
{ "Wi-SUN Sub IE", "wisun.wsie", FT_UINT16, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_wsie_type,
{ "Type", "wisun.wsie.type", FT_UINT16, BASE_DEC, VALS(wisun_wsie_types), IEEE802154_PSIE_TYPE_MASK,
NULL, HFILL }
},
{ &hf_wisun_wsie_id,
{ "Sub ID", "wisun.wsie.id", FT_UINT16, BASE_DEC, VALS(wisun_wsie_names), IEEE802154_PSIE_ID_MASK_LONG,
NULL, HFILL }
},
{ &hf_wisun_wsie_length,
{ "Length", "wisun.wsie.length", FT_UINT16, BASE_DEC, NULL, IEEE802154_PSIE_LENGTH_MASK_LONG,
NULL, HFILL }
},
{ &hf_wisun_usie,
{ "Unicast Schedule IE", "wisun.usie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_dwell_interval,
{ "Dwell Interval", "wisun.usie.dwell", FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_clock_drift,
{ "Clock Drift", "wisun.usie.drift", FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_timing_accuracy,
{ "Timing Accuracy", "wisun.usie.accuracy", FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_channel_control,
{ "Channel Control", "wisun.usie.channel", FT_UINT8, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_channel_plan,
{ "Channel Plan", "wisun.usie.channel.plan", FT_UINT8, BASE_DEC, VALS(wisun_channel_plan_names), WISUN_CHANNEL_PLAN,
NULL, HFILL }
},
{ &hf_wisun_usie_channel_function,
{ "Channel Function", "wisun.usie.channel.function", FT_UINT8, BASE_DEC, VALS(wisun_channel_function_names), WISUN_CHANNEL_FUNCTION,
NULL, HFILL }
},
{ &hf_wisun_usie_channel_exclude,
{ "Excluded Channels", "wisun.usie.channel.exclude", FT_UINT8, BASE_DEC, VALS(wisun_channel_exclude_names), WISUN_CHANNEL_EXCLUDE,
NULL, HFILL }
},
{ &hf_wisun_usie_regulatory_domain,
{ "Regulatory Domain", "wisun.usie.domain", FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_operating_class,
{ "Operating Class", "wisun.usie.class", FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_channel_frequency,
{ "CH0 Frequency", "wisun.usie.channel_frequency", FT_UINT24, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_channel_spacing,
{ "Channel Spacing", "wisun.usie.channel_spacing", FT_UINT8, BASE_DEC, VALS(wisun_channel_spacing_names), 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_number_channels,
{ "Number of Channels", "wisun.usie.num_channels", FT_UINT16, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_fixed_channel,
{ "Fixed Channel", "wisun.usie.fixed_channel", FT_UINT16, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_hop_count,
{ "Chanel Hop Count", "wisun.usie.hop_count", FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_hop_list,
{ "Channel Hop List", "wisun.usie.hop_list", FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_number_ranges,
{ "Number of Excluded Ranges", "wisun.usie.num_ranges", FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_exclude_range,
{ "Excluded Channel Range", "wisun.usie.exclude.range", FT_UINT16, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_usie_exclude_mask,
{ "Excluded Channel Mask", "wisun.usie.exclude.mask", FT_BYTES, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_bsie,
{ "Broadcast Schedule IE", "wisun.bsie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_bsie_bcast_interval,
{ "Broadcast Interval", "wisun.bsie.interval", FT_UINT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_bsie_bcast_schedule_id,
{ "Broadcast Schedule ID", "wisun.bsie.schedule", FT_UINT16, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_vpie,
{ "Vendor Payload IE", "wisun.vpie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_vpie_vid,
{ "Vendor ID", "wisun.vpie.vid", FT_UINT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_panie,
{ "PAN Information IE", "wisun.panie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_panie_size,
{ "PAN Size", "wisun.panie.size", FT_UINT16, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_panie_cost,
{ "Routing Cost", "wisun.panie.cost", FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_panie_flags,
{ "PAN Flags", "wisun.panie.flags", FT_UINT8, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_panie_flag_parent_bsie,
{ "Use Parent BS-IE", "wisun.panie.flags.parent_bsie", FT_BOOLEAN, 8, NULL, 0x01,
NULL, HFILL }
},
{ &hf_wisun_panie_flag_routing_method,
{ "Routing Method", "wisun.panie.flags.routing_method", FT_UINT8, BASE_HEX, VALS(wisun_routing_methods), 0x02,
NULL, HFILL }
},
{ &hf_wisun_panie_flag_eapol_ready,
{ "EAPOL Ready", "wisun.panie.flags.eapol", FT_BOOLEAN, 8, NULL, 0x04,
NULL, HFILL }
},
{ &hf_wisun_panie_flag_version,
{ "FAN TPS Version", "wisun.panie.flags.version", FT_UINT8, BASE_DEC, NULL, 0xe0,
NULL, HFILL }
},
{ &hf_wisun_netnameie,
{ "Network Name IE", "wisun.netnameie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_netnameie_name,
{ "Network Name", "wisun.netnameie.name", FT_STRING, STR_ASCII, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_panverie,
{ "PAN Version IE", "wisun.panverie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_panverie_version,
{ "PAN Version", "wisun.panverie.version", FT_UINT16, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_gtkhashie,
{ "GTK Hash IE", "wisun.gtkhashie", FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_gtkhashie_gtk0,
{ "GTK0 Hash", "wisun.gtkhashie.gtk0", FT_UINT64, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_gtkhashie_gtk1,
{ "GTK1 Hash", "wisun.gtkhashie.gtk1", FT_UINT64, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_gtkhashie_gtk2,
{ "GTK2 Hash", "wisun.gtkhashie.gtk2", FT_UINT64, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_wisun_gtkhashie_gtk3,
{ "GTK3 Hash", "wisun.gtkhashie.gtk3", FT_UINT64, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
/* Wi-SUN FAN Security Extension */
{ &hf_wisun_sec_function,
{ "Function Code", "wisun.sec.function", FT_UINT8, BASE_HEX, VALS(wisun_sec_functions), 0x0,
NULL, HFILL }
},
{ &hf_wisun_sec_error_type,
{ "Error Type", "wisun.sec.error", FT_UINT8, BASE_HEX, VALS(wisun_sec_sm_errors), 0x0,
NULL, HFILL }
},
{ &hf_wisun_sec_error_nonce,
{ "Initiator Nonce", "wisun.sec.nonce", FT_BYTES, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
};
/* Subtrees */
static gint *ett[] = {
&ett_wisun_unknown_ie,
&ett_wisun_uttie,
&ett_wisun_btie,
&ett_wisun_fcie,
&ett_wisun_rslie,
&ett_wisun_vhie,
&ett_wisun_pie,
&ett_wisun_wsie_bitmap,
&ett_wisun_usie,
&ett_wisun_bsie,
&ett_wisun_vpie,
&ett_wisun_panie,
&ett_wisun_panie_flags,
&ett_wisun_netnameie,
&ett_wisun_panverie,
&ett_wisun_gtkhashie,
&ett_wisun_sec
};
static ei_register_info ei[] = {
{ &ei_wisun_subid_unsupported, { "wisun.subid.unsupported", PI_PROTOCOL, PI_WARN,
"Unsuppoted Header Sub ID", EXPFILL }},
{ &ei_wisun_wsie_short_format, { "wisun.wsie.short_format", PI_PROTOCOL, PI_WARN,
"Wi-SUN Sub-IE are not valid for the short format", EXPFILL }},
{ &ei_wisun_usie_channel_plan_invalid, { "wisun.usie.channel.plan.invalid", PI_PROTOCOL, PI_WARN,
"Invalid Channel Plan", EXPFILL }},
{ &ei_wisun_wsie_unsupported, { "wisun.wsie.unsupported", PI_PROTOCOL, PI_WARN,
"Unsupported Sub-IE ID", EXPFILL }},
};
expert_module_t* expert_wisun;
proto_wisun = proto_register_protocol("Wi-SUN Field Area Network", "Wi-SUN", "wisun");
proto_wisun_sec = proto_register_protocol("Wi-SUN FAN Security Extension", "Wi-SUN WM-SEC", "wisun.sec");
proto_register_field_array(proto_wisun, hf, array_length(hf));
proto_register_subtree_array(ett, array_length(ett));
expert_wisun = expert_register_protocol(proto_wisun);
expert_register_field_array(expert_wisun, ei, array_length(ei));
register_dissector("wisun.sec", dissect_wisun_sec, proto_wisun_sec);
}
void proto_reg_handoff_wisun(void)
{
dissector_add_uint(IEEE802154_HEADER_IE_DTABLE, IEEE802154_HEADER_IE_WISUN, create_dissector_handle(dissect_wisun_hie, proto_wisun));
dissector_add_uint(IEEE802154_PAYLOAD_IE_DTABLE, IEEE802154_PAYLOAD_IE_WISUN, create_dissector_handle(dissect_wisun_pie, proto_wisun));
}
/*
* 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:
*/
Reference in New Issue View Git Blame Copy Permalink