/* packet-zbee-aps.c * Dissector routines for the ZigBee Application Support Sub-layer (APS) * By Owen Kirby * Copyright 2009 Exegin Technologies Limited * * Wireshark - Network traffic analyzer * By Gerald Combs * Copyright 1998 Gerald Combs * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ /* Include Files */ #include "config.h" #include #include #include /* req'd for packet-zbee-security.h */ #include #include #include #include "packet-zbee.h" #include "packet-zbee-nwk.h" #include "packet-zbee-security.h" #include "packet-zbee-aps.h" #include "packet-zbee-zdp.h" /************************* * Function Declarations * ************************* */ /* Dissector Routines */ static void dissect_zbee_aps_cmd (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint8 version, void *data); /* Command Dissector Helpers */ static guint dissect_zbee_aps_skke_challenge (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset); static guint dissect_zbee_aps_skke_data (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset); static guint dissect_zbee_aps_transport_key (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset); static guint dissect_zbee_aps_update_device (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset, guint8 version); static guint dissect_zbee_aps_remove_device (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset); static guint dissect_zbee_aps_request_key (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset); static guint dissect_zbee_aps_switch_key (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset); static guint dissect_zbee_aps_auth_challenge (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset); static guint dissect_zbee_aps_auth_data (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset); static guint dissect_zbee_aps_tunnel (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset, void *data); static guint dissect_zbee_aps_verify_key (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset); static guint dissect_zbee_aps_confirm_key (tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset); static guint dissect_zbee_t2 (tvbuff_t *tvb, proto_tree *tree, guint16 cluster_id); /* Helper routine. */ static guint zbee_apf_transaction_len (tvbuff_t *tvb, guint offset, guint8 type); static void proto_init_zbee_aps(void); static void proto_cleanup_zbee_aps(void); void proto_register_zbee_aps(void); /******************** * Global Variables * ******************** */ /* Field indices. */ static int proto_zbee_aps = -1; static int hf_zbee_aps_fcf_frame_type = -1; static int hf_zbee_aps_fcf_delivery = -1; static int hf_zbee_aps_fcf_indirect_mode = -1; /* ZigBee 2004 and earlier. */ static int hf_zbee_aps_fcf_ack_format = -1; /* ZigBee 2007 and later. */ static int hf_zbee_aps_fcf_security = -1; static int hf_zbee_aps_fcf_ack_req = -1; static int hf_zbee_aps_fcf_ext_header = -1; static int hf_zbee_aps_dst = -1; static int hf_zbee_aps_group = -1; static int hf_zbee_aps_cluster = -1; static int hf_zbee_aps_profile = -1; static int hf_zbee_aps_src = -1; static int hf_zbee_aps_counter = -1; static int hf_zbee_aps_fragmentation = -1; static int hf_zbee_aps_block_number = -1; static int hf_zbee_aps_block_ack = -1; static int hf_zbee_aps_block_ack1 = -1; static int hf_zbee_aps_block_ack2 = -1; static int hf_zbee_aps_block_ack3 = -1; static int hf_zbee_aps_block_ack4 = -1; static int hf_zbee_aps_block_ack5 = -1; static int hf_zbee_aps_block_ack6 = -1; static int hf_zbee_aps_block_ack7 = -1; static int hf_zbee_aps_block_ack8 = -1; static int hf_zbee_aps_cmd_id = -1; static int hf_zbee_aps_cmd_initiator = -1; static int hf_zbee_aps_cmd_responder = -1; static int hf_zbee_aps_cmd_partner = -1; static int hf_zbee_aps_cmd_initiator_flag = -1; static int hf_zbee_aps_cmd_device = -1; static int hf_zbee_aps_cmd_challenge = -1; static int hf_zbee_aps_cmd_mac = -1; static int hf_zbee_aps_cmd_key = -1; static int hf_zbee_aps_cmd_key_hash = -1; static int hf_zbee_aps_cmd_key_type = -1; static int hf_zbee_aps_cmd_dst = -1; static int hf_zbee_aps_cmd_src = -1; static int hf_zbee_aps_cmd_seqno = -1; static int hf_zbee_aps_cmd_short_addr = -1; static int hf_zbee_aps_cmd_device_status = -1; static int hf_zbee_aps_cmd_status = -1; static int hf_zbee_aps_cmd_ea_key_type = -1; static int hf_zbee_aps_cmd_ea_data = -1; /* Field indices for ZigBee 2003 & earlier Application Framework. */ static int proto_zbee_apf = -1; static int hf_zbee_apf_count = -1; static int hf_zbee_apf_type = -1; /* Subtree indices. */ static gint ett_zbee_aps = -1; static gint ett_zbee_aps_fcf = -1; static gint ett_zbee_aps_ext = -1; static gint ett_zbee_aps_cmd = -1; /* Fragmentation indices. */ static int hf_zbee_aps_fragments = -1; static int hf_zbee_aps_fragment = -1; static int hf_zbee_aps_fragment_overlap = -1; static int hf_zbee_aps_fragment_overlap_conflicts = -1; static int hf_zbee_aps_fragment_multiple_tails = -1; static int hf_zbee_aps_fragment_too_long_fragment = -1; static int hf_zbee_aps_fragment_error = -1; static int hf_zbee_aps_fragment_count = -1; static int hf_zbee_aps_reassembled_in = -1; static int hf_zbee_aps_reassembled_length = -1; static gint ett_zbee_aps_fragment = -1; static gint ett_zbee_aps_fragments = -1; /* Test Profile #2 indices. */ static int hf_zbee_aps_t2_cluster = -1; static int hf_zbee_aps_t2_btres_octet_sequence = -1; static int hf_zbee_aps_t2_btres_octet_sequence_length_requested = -1; static int hf_zbee_aps_t2_btres_status = -1; static int hf_zbee_aps_t2_btreq_octet_sequence = -1; static int hf_zbee_aps_t2_btreq_octet_sequence_length = -1; /* ZDP indices. */ static int hf_zbee_aps_zdp_cluster = -1; /* Subtree indices for the ZigBee 2004 & earlier Application Framework. */ static gint ett_zbee_apf = -1; static gint ett_zbee_aps_frag_ack = -1; /* Subtree indices for the ZigBee Test Profile #2. */ static gint ett_zbee_aps_t2 = -1; static expert_field ei_zbee_aps_invalid_delivery_mode = EI_INIT; static expert_field ei_zbee_aps_missing_payload = EI_INIT; /* Dissector Handles. */ static dissector_handle_t zbee_aps_handle; static dissector_handle_t zbee_apf_handle; /* Dissector List. */ static dissector_table_t zbee_aps_dissector_table; /* Reassembly table. */ static reassembly_table zbee_aps_reassembly_table; static const fragment_items zbee_aps_frag_items = { /* Fragment subtrees */ &ett_zbee_aps_fragment, &ett_zbee_aps_fragments, /* Fragment fields */ &hf_zbee_aps_fragments, &hf_zbee_aps_fragment, &hf_zbee_aps_fragment_overlap, &hf_zbee_aps_fragment_overlap_conflicts, &hf_zbee_aps_fragment_multiple_tails, &hf_zbee_aps_fragment_too_long_fragment, &hf_zbee_aps_fragment_error, &hf_zbee_aps_fragment_count, /* Reassembled in field */ &hf_zbee_aps_reassembled_in, /* Reassembled length field */ &hf_zbee_aps_reassembled_length, /* Reassembled data field */ NULL, /* Tag */ "APS Message fragments" }; /********************/ /* Field Names */ /********************/ /* Frame Type Names */ static const value_string zbee_aps_frame_types[] = { { ZBEE_APS_FCF_DATA, "Data" }, { ZBEE_APS_FCF_CMD, "Command" }, { ZBEE_APS_FCF_ACK, "Ack" }, { ZBEE_APS_FCF_INTERPAN, "Interpan" }, { 0, NULL } }; /* Delivery Mode Names */ static const value_string zbee_aps_delivery_modes[] = { { ZBEE_APS_FCF_UNICAST, "Unicast" }, { ZBEE_APS_FCF_INDIRECT, "Indirect" }, { ZBEE_APS_FCF_BCAST, "Broadcast" }, { ZBEE_APS_FCF_GROUP, "Group" }, { 0, NULL } }; /* Fragmentation Mode Names */ static const value_string zbee_aps_fragmentation_modes[] = { { ZBEE_APS_EXT_FCF_FRAGMENT_NONE, "None" }, { ZBEE_APS_EXT_FCF_FRAGMENT_FIRST, "First Block" }, { ZBEE_APS_EXT_FCF_FRAGMENT_MIDDLE, "Middle Block" }, { 0, NULL } }; /* APS Command Names */ static const value_string zbee_aps_cmd_names[] = { { ZBEE_APS_CMD_SKKE1, "SKKE-1" }, { ZBEE_APS_CMD_SKKE2, "SKKE-2" }, { ZBEE_APS_CMD_SKKE3, "SKKE-3" }, { ZBEE_APS_CMD_SKKE4, "SKKE-4" }, { ZBEE_APS_CMD_TRANSPORT_KEY, "Transport Key" }, { ZBEE_APS_CMD_UPDATE_DEVICE, "Update Device" }, { ZBEE_APS_CMD_REMOVE_DEVICE, "Remove Device" }, { ZBEE_APS_CMD_REQUEST_KEY, "Request Key" }, { ZBEE_APS_CMD_SWITCH_KEY, "Switch Key" }, { ZBEE_APS_CMD_EA_INIT_CHLNG, "EA Initiator Challenge" }, { ZBEE_APS_CMD_EA_RESP_CHLNG, "EA Responder Challenge" }, { ZBEE_APS_CMD_EA_INIT_MAC_DATA,"EA Initiator MAC" }, { ZBEE_APS_CMD_EA_RESP_MAC_DATA,"EA Responder MAC" }, { ZBEE_APS_CMD_TUNNEL, "Tunnel" }, { ZBEE_APS_CMD_VERIFY_KEY, "Verify Key" }, { ZBEE_APS_CMD_CONFIRM_KEY, "Confirm Key" }, { 0, NULL } }; /* APS Key Names */ static const value_string zbee_aps_key_names[] = { { ZBEE_APS_CMD_KEY_TC_MASTER, "Trust Center Master Key" }, { ZBEE_APS_CMD_KEY_STANDARD_NWK, "Standard Network Key" }, { ZBEE_APS_CMD_KEY_APP_MASTER, "Application Master Key" }, { ZBEE_APS_CMD_KEY_APP_LINK, "Application Link Key" }, { ZBEE_APS_CMD_KEY_TC_LINK, "Trust Center Link Key" }, { ZBEE_APS_CMD_KEY_HIGH_SEC_NWK, "High-Security Network Key" }, { 0, NULL } }; /* APS Key Names (Entity-Authentication). */ static const value_string zbee_aps_ea_key_names[] = { { ZBEE_APS_CMD_EA_KEY_NWK, "Network Key" }, { ZBEE_APS_CMD_EA_KEY_LINK, "Link Key" }, { 0, NULL } }; /* Update Device Status Names */ static const value_string zbee_aps_update_status_names[] = { { ZBEE_APS_CMD_UPDATE_STANDARD_SEC_REJOIN, "Standard security, secured rejoin" }, { ZBEE_APS_CMD_UPDATE_STANDARD_UNSEC_JOIN, "Standard security, unsecured join" }, { ZBEE_APS_CMD_UPDATE_LEAVE, "Device left" }, { ZBEE_APS_CMD_UPDATE_STANDARD_UNSEC_REJOIN,"Standard security, unsecured rejoin" }, { ZBEE_APS_CMD_UPDATE_HIGH_SEC_REJOIN, "High security, secured rejoin" }, { ZBEE_APS_CMD_UPDATE_HIGH_UNSEC_JOIN, "High security, unsecured join" }, { ZBEE_APS_CMD_UPDATE_HIGH_UNSEC_REJOIN, "High security, unsecured rejoin" }, { 0, NULL } }; /* Update Device Status Names */ static const value_string zbee_aps_status_names[] = { { ZBEE_APP_STATUS_SUCCESS, "SUCCESS" }, { ZBEE_APP_STATUS_ASDU_TOO_LONG, "ASDU_TOO_LONG" }, { ZBEE_APP_STATUS_DEFRAG_DEFERRED, "DEFRAG_DEFERRED" }, { ZBEE_APP_STATUS_DEFRAG_UNSUPPORTED, "DEFRAG_UNSUPPORTED" }, { ZBEE_APP_STATUS_ILLEGAL_REQUEST, "ILLEGAL_REQUEST" }, { ZBEE_APP_STATUS_INVALID_BINDING, "INVALID_BINDING" }, { ZBEE_APP_STATUS_INVALID_GROUP, "INVALID_GROUP" }, { ZBEE_APP_STATUS_INVALID_PARAMETER, "INVALID_PARAMETER" }, { ZBEE_APP_STATUS_NO_ACK, "NO_ACK" }, { ZBEE_APP_STATUS_NO_BOUND_DEVICE, "NO_BOUND_DEVICE" }, { ZBEE_APP_STATUS_NO_SHORT_ADDRESS, "NO_SHORT_ADDRESS" }, { ZBEE_APP_STATUS_NOT_SUPPORTED, "NOT_SUPPORTED" }, { ZBEE_APP_STATUS_SECURED_LINK_KEY, "SECURED_LINK_KEY" }, { ZBEE_APP_STATUS_SECURED_NWK_KEY, "SECURED_NWK_KEY" }, { ZBEE_APP_STATUS_SECURITY_FAIL, "SECURITY_FAIL" }, { ZBEE_APP_STATUS_TABLE_FULL, "TABLE_FULL" }, { ZBEE_APP_STATUS_UNSECURED, "UNSECURED" }, { ZBEE_APP_STATUS_UNSUPPORTED_ATTRIBUTE, "UNSUPPORTED_ATTRIBUTE" }, { 0, NULL } }; /* Outdated ZigBee 2004 Value Strings. */ static const value_string zbee_apf_type_names[] = { { ZBEE_APP_TYPE_KVP, "Key-Value Pair" }, { ZBEE_APP_TYPE_MSG, "Message" }, { 0, NULL } }; #if 0 static const value_string zbee_apf_kvp_command_names[] = { { ZBEE_APP_KVP_SET, "Set" }, { ZBEE_APP_KVP_EVENT, "Event" }, { ZBEE_APP_KVP_GET_ACK, "Get Acknowledgement" }, { ZBEE_APP_KVP_SET_ACK, "Set Acknowledgement" }, { ZBEE_APP_KVP_EVENT_ACK, "Event Acknowledgement" }, { ZBEE_APP_KVP_GET_RESP, "Get Response" }, { ZBEE_APP_KVP_SET_RESP, "Set Response" }, { ZBEE_APP_KVP_EVENT_RESP, "Event Response" }, { 0, NULL } }; #endif #if 0 static const value_string zbee_apf_kvp_type_names[] = { { ZBEE_APP_KVP_NO_DATA, "No Data" }, { ZBEE_APP_KVP_UINT8, "8-bit Unsigned Integer" }, { ZBEE_APP_KVP_INT8, "8-bit Signed Integer" }, { ZBEE_APP_KVP_UINT16, "16-bit Unsigned Integer" }, { ZBEE_APP_KVP_INT16, "16-bit Signed Integer" }, { ZBEE_APP_KVP_FLOAT16, "16-bit Floating Point" }, { ZBEE_APP_KVP_ABS_TIME, "Absolute Time" }, { ZBEE_APP_KVP_REL_TIME, "Relative Time" }, { ZBEE_APP_KVP_CHAR_STRING, "Character String" }, { ZBEE_APP_KVP_OCT_STRING, "Octet String" }, { 0, NULL } }; #endif /* ZigBee Application Profile ID Names */ const range_string zbee_aps_apid_names[] = { { ZBEE_DEVICE_PROFILE, ZBEE_DEVICE_PROFILE, "ZigBee Device Profile" }, { ZBEE_PROFILE_IPM, ZBEE_PROFILE_IPM, "Industrial Plant Monitoring" }, { ZBEE_PROFILE_T1, ZBEE_PROFILE_T1, "Test Profile #1" }, { ZBEE_PROFILE_HA, ZBEE_PROFILE_HA, "Home Automation" }, { ZBEE_PROFILE_CBA, ZBEE_PROFILE_CBA, "Commercial Building Automation" }, { ZBEE_PROFILE_WSN, ZBEE_PROFILE_WSN, "Wireless Sensor Network" }, { ZBEE_PROFILE_TA, ZBEE_PROFILE_TA, "Telecom Automation" }, { ZBEE_PROFILE_HC, ZBEE_PROFILE_HC, "Health Care" }, { ZBEE_PROFILE_SE, ZBEE_PROFILE_SE, "Smart Energy" }, { ZBEE_PROFILE_RS, ZBEE_PROFILE_RS, "Retail Services" }, { ZBEE_PROFILE_STD_MIN, ZBEE_PROFILE_STD_MAX, "Unknown ZigBee Standard" }, { ZBEE_PROFILE_T2, ZBEE_PROFILE_T2, "Test Profile #2" }, { ZBEE_PROFILE_GP, ZBEE_PROFILE_GP, "Green Power" }, { ZBEE_PROFILE_RSVD0_MIN, ZBEE_PROFILE_RSVD0_MAX, "Unknown ZigBee Reserved" }, { ZBEE_PROFILE_RSVD1_MIN, ZBEE_PROFILE_RSVD1_MAX, "Unknown ZigBee Reserved" }, { ZBEE_PROFILE_IEEE_1451_5, ZBEE_PROFILE_IEEE_1451_5, "IEEE_1451_5" }, { ZBEE_PROFILE_MFR_SPEC_ORG_MIN, ZBEE_PROFILE_MFR_SPEC_ORG_MAX, "Unallocated Manufacturer-Specific" }, { ZBEE_PROFILE_IEEE_1451_5, ZBEE_PROFILE_IEEE_1451_5, "IEEE_1451_5" }, /* Manufacturer Allocations */ { ZBEE_PROFILE_CIRRONET_0_MIN, ZBEE_PROFILE_CIRRONET_0_MAX, ZBEE_MFG_CIRRONET }, { ZBEE_PROFILE_CHIPCON_MIN, ZBEE_PROFILE_CHIPCON_MAX, ZBEE_MFG_CHIPCON }, { ZBEE_PROFILE_EMBER_MIN, ZBEE_PROFILE_EMBER_MAX, ZBEE_MFG_EMBER }, { ZBEE_PROFILE_NTS_MIN, ZBEE_PROFILE_NTS_MAX, ZBEE_MFG_CHIPCON }, { ZBEE_PROFILE_FREESCALE_MIN, ZBEE_PROFILE_FREESCALE_MAX, ZBEE_MFG_FREESCALE }, { ZBEE_PROFILE_IPCOM_MIN, ZBEE_PROFILE_IPCOM_MAX, ZBEE_MFG_IPCOM }, { ZBEE_PROFILE_SAN_JUAN_MIN, ZBEE_PROFILE_SAN_JUAN_MAX, ZBEE_MFG_SAN_JUAN }, { ZBEE_PROFILE_TUV_MIN, ZBEE_PROFILE_TUV_MAX, ZBEE_MFG_TUV }, { ZBEE_PROFILE_COMPXS_MIN, ZBEE_PROFILE_COMPXS_MAX, ZBEE_MFG_COMPXS }, { ZBEE_PROFILE_BM_MIN, ZBEE_PROFILE_BM_MAX, ZBEE_MFG_BM }, { ZBEE_PROFILE_AWAREPOINT_MIN, ZBEE_PROFILE_AWAREPOINT_MAX, ZBEE_MFG_AWAREPOINT }, { ZBEE_PROFILE_SAN_JUAN_1_MIN, ZBEE_PROFILE_SAN_JUAN_1_MAX, ZBEE_MFG_SAN_JUAN }, { ZBEE_PROFILE_ZLL, ZBEE_PROFILE_ZLL, "ZLL" }, { ZBEE_PROFILE_PHILIPS_MIN, ZBEE_PROFILE_PHILIPS_MAX, ZBEE_MFG_PHILIPS }, { ZBEE_PROFILE_LUXOFT_MIN, ZBEE_PROFILE_LUXOFT_MAX, ZBEE_MFG_LUXOFT }, { ZBEE_PROFILE_KORWIN_MIN, ZBEE_PROFILE_KORWIN_MAX, ZBEE_MFG_KORWIN }, { ZBEE_PROFILE_1_RF_MIN, ZBEE_PROFILE_1_RF_MAX, ZBEE_MFG_1_RF }, { ZBEE_PROFILE_STG_MIN, ZBEE_PROFILE_STG_MAX, ZBEE_MFG_STG }, { ZBEE_PROFILE_TELEGESIS_MIN, ZBEE_PROFILE_TELEGESIS_MAX, ZBEE_MFG_TELEGESIS }, { ZBEE_PROFILE_CIRRONET_1_MIN, ZBEE_PROFILE_CIRRONET_1_MAX, ZBEE_MFG_CIRRONET }, { ZBEE_PROFILE_VISIONIC_MIN, ZBEE_PROFILE_VISIONIC_MAX, ZBEE_MFG_VISIONIC }, { ZBEE_PROFILE_INSTA_MIN, ZBEE_PROFILE_INSTA_MAX, ZBEE_MFG_INSTA }, { ZBEE_PROFILE_ATALUM_MIN, ZBEE_PROFILE_ATALUM_MAX, ZBEE_MFG_ATALUM }, { ZBEE_PROFILE_ATMEL_MIN, ZBEE_PROFILE_ATMEL_MAX, ZBEE_MFG_ATMEL }, { ZBEE_PROFILE_DEVELCO_MIN, ZBEE_PROFILE_DEVELCO_MAX, ZBEE_MFG_DEVELCO }, { ZBEE_PROFILE_HONEYWELL_MIN, ZBEE_PROFILE_HONEYWELL_MAX, ZBEE_MFG_HONEYWELL }, { ZBEE_PROFILE_NEC_MIN, ZBEE_PROFILE_NEC_MAX, ZBEE_MFG_NEC }, { ZBEE_PROFILE_YAMATAKE_MIN, ZBEE_PROFILE_YAMATAKE_MAX, ZBEE_MFG_YAMATAKE }, { ZBEE_PROFILE_TENDRIL_MIN, ZBEE_PROFILE_TENDRIL_MAX, ZBEE_MFG_TENDRIL }, { ZBEE_PROFILE_ASSA_MIN, ZBEE_PROFILE_ASSA_MAX, ZBEE_MFG_ASSA }, { ZBEE_PROFILE_MAXSTREAM_MIN, ZBEE_PROFILE_MAXSTREAM_MAX, ZBEE_MFG_MAXSTREAM }, { ZBEE_PROFILE_XANADU_MIN, ZBEE_PROFILE_XANADU_MAX, ZBEE_MFG_XANADU }, { ZBEE_PROFILE_NEUROCOM_MIN, ZBEE_PROFILE_NEUROCOM_MAX, ZBEE_MFG_NEUROCOM }, { ZBEE_PROFILE_III_MIN, ZBEE_PROFILE_III_MAX, ZBEE_MFG_III }, { ZBEE_PROFILE_VANTAGE_MIN, ZBEE_PROFILE_VANTAGE_MAX, ZBEE_MFG_VANTAGE }, { ZBEE_PROFILE_ICONTROL_MIN, ZBEE_PROFILE_ICONTROL_MAX, ZBEE_MFG_ICONTROL }, { ZBEE_PROFILE_RAYMARINE_MIN, ZBEE_PROFILE_RAYMARINE_MAX, ZBEE_MFG_RAYMARINE }, { ZBEE_PROFILE_RENESAS_MIN, ZBEE_PROFILE_RENESAS_MAX, ZBEE_MFG_RENESAS }, { ZBEE_PROFILE_LSR_MIN, ZBEE_PROFILE_LSR_MAX, ZBEE_MFG_LSR }, { ZBEE_PROFILE_ONITY_MIN, ZBEE_PROFILE_ONITY_MAX, ZBEE_MFG_ONITY }, { ZBEE_PROFILE_MONO_MIN, ZBEE_PROFILE_MONO_MAX, ZBEE_MFG_MONO }, { ZBEE_PROFILE_RFT_MIN, ZBEE_PROFILE_RFT_MAX, ZBEE_MFG_RFT }, { ZBEE_PROFILE_ITRON_MIN, ZBEE_PROFILE_ITRON_MAX, ZBEE_MFG_ITRON }, { ZBEE_PROFILE_TRITECH_MIN, ZBEE_PROFILE_TRITECH_MAX, ZBEE_MFG_TRITECH }, { ZBEE_PROFILE_EMBEDIT_MIN, ZBEE_PROFILE_EMBEDIT_MAX, ZBEE_MFG_EMBEDIT }, { ZBEE_PROFILE_S3C_MIN, ZBEE_PROFILE_S3C_MAX, ZBEE_MFG_S3C }, { ZBEE_PROFILE_SIEMENS_MIN, ZBEE_PROFILE_SIEMENS_MAX, ZBEE_MFG_SIEMENS }, { ZBEE_PROFILE_MINDTECH_MIN, ZBEE_PROFILE_MINDTECH_MAX, ZBEE_MFG_MINDTECH }, { ZBEE_PROFILE_LGE_MIN, ZBEE_PROFILE_LGE_MAX, ZBEE_MFG_LGE }, { ZBEE_PROFILE_MITSUBISHI_MIN, ZBEE_PROFILE_MITSUBISHI_MAX, ZBEE_MFG_MITSUBISHI }, { ZBEE_PROFILE_JOHNSON_MIN, ZBEE_PROFILE_JOHNSON_MAX, ZBEE_MFG_JOHNSON }, { ZBEE_PROFILE_PRI_MIN, ZBEE_PROFILE_PRI_MAX, ZBEE_MFG_PRI }, { ZBEE_PROFILE_KNICK_MIN, ZBEE_PROFILE_KNICK_MAX, ZBEE_MFG_KNICK }, { ZBEE_PROFILE_VICONICS_MIN, ZBEE_PROFILE_VICONICS_MAX, ZBEE_MFG_VICONICS }, { ZBEE_PROFILE_FLEXIPANEL_MIN, ZBEE_PROFILE_FLEXIPANEL_MAX, ZBEE_MFG_FLEXIPANEL }, { ZBEE_PROFILE_TRANE_MIN, ZBEE_PROFILE_TRANE_MAX, ZBEE_MFG_TRANE }, { ZBEE_PROFILE_JENNIC_MIN, ZBEE_PROFILE_JENNIC_MAX, ZBEE_MFG_JENNIC }, { ZBEE_PROFILE_LIG_MIN, ZBEE_PROFILE_LIG_MAX, ZBEE_MFG_LIG }, { ZBEE_PROFILE_ALERTME_MIN, ZBEE_PROFILE_ALERTME_MAX, ZBEE_MFG_ALERTME }, { ZBEE_PROFILE_DAINTREE_MIN, ZBEE_PROFILE_DAINTREE_MAX, ZBEE_MFG_DAINTREE }, { ZBEE_PROFILE_AIJI_MIN, ZBEE_PROFILE_AIJI_MAX, ZBEE_MFG_AIJI }, { ZBEE_PROFILE_TEL_ITALIA_MIN, ZBEE_PROFILE_TEL_ITALIA_MAX, ZBEE_MFG_TEL_ITALIA }, { ZBEE_PROFILE_MIKROKRETS_MIN, ZBEE_PROFILE_MIKROKRETS_MAX, ZBEE_MFG_MIKROKRETS }, { ZBEE_PROFILE_OKI_MIN, ZBEE_PROFILE_OKI_MAX, ZBEE_MFG_OKI }, { ZBEE_PROFILE_NEWPORT_MIN, ZBEE_PROFILE_NEWPORT_MAX, ZBEE_MFG_NEWPORT }, { ZBEE_PROFILE_C4_CL, ZBEE_PROFILE_C4_CL, ZBEE_MFG_C4 " Cluster Library"}, { ZBEE_PROFILE_C4_MIN, ZBEE_PROFILE_C4_MAX, ZBEE_MFG_C4 }, { ZBEE_PROFILE_STM_MIN, ZBEE_PROFILE_STM_MAX, ZBEE_MFG_STM }, { ZBEE_PROFILE_ASN_0_MIN, ZBEE_PROFILE_ASN_0_MAX, ZBEE_MFG_ASN }, { ZBEE_PROFILE_DCSI_MIN, ZBEE_PROFILE_DCSI_MAX, ZBEE_MFG_DCSI }, { ZBEE_PROFILE_FRANCE_TEL_MIN, ZBEE_PROFILE_FRANCE_TEL_MAX, ZBEE_MFG_FRANCE_TEL }, { ZBEE_PROFILE_MUNET_MIN, ZBEE_PROFILE_MUNET_MAX, ZBEE_MFG_MUNET }, { ZBEE_PROFILE_AUTANI_MIN, ZBEE_PROFILE_AUTANI_MAX, ZBEE_MFG_AUTANI }, { ZBEE_PROFILE_COL_VNET_MIN, ZBEE_PROFILE_COL_VNET_MAX, ZBEE_MFG_COL_VNET }, { ZBEE_PROFILE_AEROCOMM_MIN, ZBEE_PROFILE_AEROCOMM_MAX, ZBEE_MFG_AEROCOMM }, { ZBEE_PROFILE_SI_LABS_MIN, ZBEE_PROFILE_SI_LABS_MAX, ZBEE_MFG_SI_LABS }, { ZBEE_PROFILE_INNCOM_MIN, ZBEE_PROFILE_INNCOM_MAX, ZBEE_MFG_INNCOM }, { ZBEE_PROFILE_CANNON_MIN, ZBEE_PROFILE_CANNON_MAX, ZBEE_MFG_CANNON }, { ZBEE_PROFILE_SYNAPSE_MIN, ZBEE_PROFILE_SYNAPSE_MAX, ZBEE_MFG_SYNAPSE }, { ZBEE_PROFILE_FPS_MIN, ZBEE_PROFILE_FPS_MAX, ZBEE_MFG_FPS }, { ZBEE_PROFILE_CLS_MIN, ZBEE_PROFILE_CLS_MAX, ZBEE_MFG_CLS }, { ZBEE_PROFILE_CRANE_MIN, ZBEE_PROFILE_CRANE_MAX, ZBEE_MFG_CRANE }, { ZBEE_PROFILE_ASN_1_MIN, ZBEE_PROFILE_ASN_1_MAX, ZBEE_MFG_ASN }, { ZBEE_PROFILE_MOBILARM_MIN, ZBEE_PROFILE_MOBILARM_MAX, ZBEE_MFG_MOBILARM }, { ZBEE_PROFILE_IMONITOR_MIN, ZBEE_PROFILE_IMONITOR_MAX, ZBEE_MFG_IMONITOR }, { ZBEE_PROFILE_BARTECH_MIN, ZBEE_PROFILE_BARTECH_MAX, ZBEE_MFG_BARTECH }, { ZBEE_PROFILE_MESHNETICS_MIN, ZBEE_PROFILE_MESHNETICS_MAX, ZBEE_MFG_MESHNETICS }, { ZBEE_PROFILE_LS_IND_MIN, ZBEE_PROFILE_LS_IND_MAX, ZBEE_MFG_LS_IND }, { ZBEE_PROFILE_CASON_MIN, ZBEE_PROFILE_CASON_MAX, ZBEE_MFG_CASON }, { ZBEE_PROFILE_WLESS_GLUE_MIN, ZBEE_PROFILE_WLESS_GLUE_MAX, ZBEE_MFG_WLESS_GLUE }, { ZBEE_PROFILE_ELSTER_MIN, ZBEE_PROFILE_ELSTER_MAX, ZBEE_MFG_ELSTER }, { ZBEE_PROFILE_ONSET_MIN, ZBEE_PROFILE_ONSET_MAX, ZBEE_MFG_ONSET }, { ZBEE_PROFILE_RIGA_MIN, ZBEE_PROFILE_RIGA_MAX, ZBEE_MFG_RIGA }, { ZBEE_PROFILE_ENERGATE_MIN, ZBEE_PROFILE_ENERGATE_MAX, ZBEE_MFG_ENERGATE }, { ZBEE_PROFILE_VANTAGE_1_MIN, ZBEE_PROFILE_VANTAGE_1_MAX, ZBEE_MFG_VANTAGE }, { ZBEE_PROFILE_CONMED_MIN, ZBEE_PROFILE_CONMED_MAX, ZBEE_MFG_CONMED }, { ZBEE_PROFILE_SMS_TEC_MIN, ZBEE_PROFILE_SMS_TEC_MAX, ZBEE_MFG_SMS_TEC }, { ZBEE_PROFILE_POWERMAND_MIN, ZBEE_PROFILE_POWERMAND_MAX, ZBEE_MFG_POWERMAND }, { ZBEE_PROFILE_SCHNEIDER_MIN, ZBEE_PROFILE_SCHNEIDER_MAX, ZBEE_MFG_SCHNEIDER }, { ZBEE_PROFILE_EATON_MIN, ZBEE_PROFILE_EATON_MAX, ZBEE_MFG_EATON }, { ZBEE_PROFILE_TELULAR_MIN, ZBEE_PROFILE_TELULAR_MAX, ZBEE_MFG_TELULAR }, { ZBEE_PROFILE_DELPHI_MIN, ZBEE_PROFILE_DELPHI_MAX, ZBEE_MFG_DELPHI }, { ZBEE_PROFILE_EPISENSOR_MIN, ZBEE_PROFILE_EPISENSOR_MAX, ZBEE_MFG_EPISENSOR }, { ZBEE_PROFILE_LANDIS_GYR_MIN, ZBEE_PROFILE_LANDIS_GYR_MAX, ZBEE_MFG_LANDIS_GYR }, { ZBEE_PROFILE_SHURE_MIN, ZBEE_PROFILE_SHURE_MAX, ZBEE_MFG_SHURE }, { ZBEE_PROFILE_COMVERGE_MIN, ZBEE_PROFILE_COMVERGE_MAX, ZBEE_MFG_COMVERGE }, { ZBEE_PROFILE_KABA_MIN, ZBEE_PROFILE_KABA_MAX, ZBEE_MFG_KABA }, { ZBEE_PROFILE_HIDALGO_MIN, ZBEE_PROFILE_HIDALGO_MAX, ZBEE_MFG_HIDALGO }, { ZBEE_PROFILE_AIR2APP_MIN, ZBEE_PROFILE_AIR2APP_MAX, ZBEE_MFG_AIR2APP }, { ZBEE_PROFILE_AMX_MIN, ZBEE_PROFILE_AMX_MAX, ZBEE_MFG_AMX }, { ZBEE_PROFILE_EDMI_MIN, ZBEE_PROFILE_EDMI_MAX, ZBEE_MFG_EDMI }, { ZBEE_PROFILE_CYAN_MIN, ZBEE_PROFILE_CYAN_MAX, ZBEE_MFG_CYAN }, { ZBEE_PROFILE_SYS_SPA_MIN, ZBEE_PROFILE_SYS_SPA_MAX, ZBEE_MFG_SYS_SPA }, { ZBEE_PROFILE_TELIT_MIN, ZBEE_PROFILE_TELIT_MAX, ZBEE_MFG_TELIT }, { ZBEE_PROFILE_KAGA_MIN, ZBEE_PROFILE_KAGA_MAX, ZBEE_MFG_KAGA }, { ZBEE_PROFILE_4_NOKS_MIN, ZBEE_PROFILE_4_NOKS_MAX, ZBEE_MFG_4_NOKS }, { ZBEE_PROFILE_PROFILE_SYS_MIN, ZBEE_PROFILE_PROFILE_SYS_MAX, ZBEE_MFG_PROFILE_SYS }, { ZBEE_PROFILE_FREESTYLE_MIN, ZBEE_PROFILE_FREESTYLE_MAX, ZBEE_MFG_FREESTYLE }, { ZBEE_PROFILE_REMOTE_MIN, ZBEE_PROFILE_REMOTE_MAX, ZBEE_MFG_REMOTE_TECH }, { ZBEE_PROFILE_WAVECOM_MIN, ZBEE_PROFILE_WAVECOM_MAX, ZBEE_MFG_WAVECOM }, { ZBEE_PROFILE_ENERGY_OPT_MIN, ZBEE_PROFILE_ENERGY_OPT_MAX, ZBEE_MFG_GREEN_ENERGY }, { ZBEE_PROFILE_GE_MIN, ZBEE_PROFILE_GE_MAX, ZBEE_MFG_GE }, { ZBEE_PROFILE_MESHWORKS_MIN, ZBEE_PROFILE_MESHWORKS_MAX, ZBEE_MFG_MESHWORKS }, { ZBEE_PROFILE_ELLIPS_MIN, ZBEE_PROFILE_ELLIPS_MAX, ZBEE_MFG_ELLIPS }, { ZBEE_PROFILE_CEDO_MIN, ZBEE_PROFILE_CEDO_MAX, ZBEE_MFG_CEDO }, { ZBEE_PROFILE_A_D_MIN, ZBEE_PROFILE_A_D_MAX, ZBEE_MFG_A_AND_D }, { ZBEE_PROFILE_CARRIER_MIN, ZBEE_PROFILE_CARRIER_MAX, ZBEE_MFG_CARRIER }, { ZBEE_PROFILE_PASSIVESYS_MIN, ZBEE_PROFILE_PASSIVESYS_MAX, ZBEE_MFG_PASSIVE }, { ZBEE_PROFILE_SUNRISE_MIN, ZBEE_PROFILE_SUNRISE_MAX, ZBEE_MFG_SUNRISE }, { ZBEE_PROFILE_MEMTEC_MIN, ZBEE_PROFILE_MEMTEC_MAX, ZBEE_MFG_MEMTECH }, { ZBEE_PROFILE_BRITISH_GAS_MIN, ZBEE_PROFILE_BRITISH_GAS_MAX, ZBEE_MFG_BRITISH_GAS }, { ZBEE_PROFILE_SENTEC_MIN, ZBEE_PROFILE_SENTEC_MAX, ZBEE_MFG_SENTEC }, { ZBEE_PROFILE_NAVETAS_MIN, ZBEE_PROFILE_NAVETAS_MAX, ZBEE_MFG_NAVETAS }, { ZBEE_PROFILE_ENERNOC_MIN, ZBEE_PROFILE_ENERNOC_MAX, ZBEE_MFG_ENERNOC }, { ZBEE_PROFILE_ELTAV_MIN, ZBEE_PROFILE_ELTAV_MAX, ZBEE_MFG_ELTAV }, { ZBEE_PROFILE_XSTREAMHD_MIN, ZBEE_PROFILE_XSTREAMHD_MAX, ZBEE_MFG_XSTREAMHD }, { ZBEE_PROFILE_OMRON_MIN, ZBEE_PROFILE_OMRON_MAX, ZBEE_MFG_OMRON }, { ZBEE_PROFILE_NEC_TOKIN_MIN, ZBEE_PROFILE_NEC_TOKIN_MAX, ZBEE_MFG_NEC_TOKIN }, { ZBEE_PROFILE_PEEL_MIN, ZBEE_PROFILE_PEEL_MAX, ZBEE_MFG_PEEL }, { ZBEE_PROFILE_ELECTROLUX_MIN, ZBEE_PROFILE_ELECTROLUX_MAX, ZBEE_MFG_ELECTROLUX }, { ZBEE_PROFILE_SAMSUNG_MIN, ZBEE_PROFILE_SAMSUNG_MAX, ZBEE_MFG_SAMSUNG }, { ZBEE_PROFILE_MAINSTREAM_MIN, ZBEE_PROFILE_MAINSTREAM_MAX, ZBEE_MFG_MAINSTREAM }, { ZBEE_PROFILE_DIGI_MIN, ZBEE_PROFILE_DIGI_MAX, ZBEE_MFG_DIGI }, { ZBEE_PROFILE_RADIOCRAFTS_MIN, ZBEE_PROFILE_RADIOCRAFTS_MAX, ZBEE_MFG_RADIOCRAFTS }, { ZBEE_PROFILE_SCHNEIDER2_MIN, ZBEE_PROFILE_SCHNEIDER2_MAX, ZBEE_MFG_SCHNEIDER }, { ZBEE_PROFILE_HUAWEI_MIN, ZBEE_PROFILE_HUAWEI_MAX, ZBEE_MFG_HUAWEI }, { ZBEE_PROFILE_BGLOBAL_MIN, ZBEE_PROFILE_BGLOBAL_MAX, ZBEE_MFG_BGLOBAL }, { ZBEE_PROFILE_ABB_MIN, ZBEE_PROFILE_ABB_MAX, ZBEE_MFG_ABB }, { ZBEE_PROFILE_GENUS_MIN, ZBEE_PROFILE_GENUS_MAX, ZBEE_MFG_GENUS }, { ZBEE_PROFILE_UBISYS_MIN, ZBEE_PROFILE_UBISYS_MAX, ZBEE_MFG_UBISYS }, { ZBEE_PROFILE_CRESTRON_MIN, ZBEE_PROFILE_CRESTRON_MAX, ZBEE_MFG_CRESTRON }, { ZBEE_PROFILE_AAC_TECH_MIN, ZBEE_PROFILE_AAC_TECH_MAX, ZBEE_MFG_AAC_TECH }, { ZBEE_PROFILE_STEELCASE_MIN, ZBEE_PROFILE_STEELCASE_MAX, ZBEE_MFG_STEELCASE }, { 0, 0, NULL } }; /* ZigBee Application Profile ID Abbreviations */ const range_string zbee_aps_apid_abbrs[] = { { ZBEE_DEVICE_PROFILE, ZBEE_DEVICE_PROFILE, "ZDP" }, { ZBEE_PROFILE_IPM, ZBEE_PROFILE_IPM, "IPM" }, { ZBEE_PROFILE_T1, ZBEE_PROFILE_T1, "T1" }, { ZBEE_PROFILE_HA, ZBEE_PROFILE_HA, "HA" }, { ZBEE_PROFILE_CBA, ZBEE_PROFILE_CBA, "CBA" }, { ZBEE_PROFILE_WSN, ZBEE_PROFILE_WSN, "WSN" }, { ZBEE_PROFILE_TA, ZBEE_PROFILE_TA, "TA" }, { ZBEE_PROFILE_HC, ZBEE_PROFILE_HC, "HC" }, { ZBEE_PROFILE_SE, ZBEE_PROFILE_SE, "SE" }, { ZBEE_PROFILE_RS, ZBEE_PROFILE_RS, "RS" }, { ZBEE_PROFILE_T2, ZBEE_PROFILE_T2, "T2" }, { ZBEE_PROFILE_GP, ZBEE_PROFILE_GP, "GP" }, /* Manufacturer Allocations */ { ZBEE_PROFILE_C4_MIN, ZBEE_PROFILE_C4_MAX, "C4" }, { 0, 0, NULL } }; /* ZCL Cluster Names */ /* BUGBUG: big enough to hash? */ const value_string zbee_aps_cid_names[] = { /* General */ { ZBEE_ZCL_CID_BASIC, "Basic"}, { ZBEE_ZCL_CID_POWER_CONFIG, "Power Configuration"}, { ZBEE_ZCL_CID_DEVICE_TEMP_CONFIG, "Device Temperature Configuration"}, { ZBEE_ZCL_CID_IDENTIFY, "Identify"}, { ZBEE_ZCL_CID_GROUPS, "Groups"}, { ZBEE_ZCL_CID_SCENES, "Scenes"}, { ZBEE_ZCL_CID_ON_OFF, "On/Off"}, { ZBEE_ZCL_CID_ON_OFF_SWITCH_CONFIG, "On/Off Switch Configuration"}, { ZBEE_ZCL_CID_LEVEL_CONTROL, "Level Control"}, { ZBEE_ZCL_CID_ALARMS, "Alarms"}, { ZBEE_ZCL_CID_TIME, "Time"}, { ZBEE_ZCL_CID_RSSI_LOCATION, "RSSI Location"}, { ZBEE_ZCL_CID_ANALOG_INPUT_BASIC, "Analog Input (Basic)"}, { ZBEE_ZCL_CID_ANALOG_OUTPUT_BASIC, "Analog Output (Basic)"}, { ZBEE_ZCL_CID_ANALOG_VALUE_BASIC, "Analog Value (Basic)"}, { ZBEE_ZCL_CID_BINARY_INPUT_BASIC, "Binary Input (Basic)"}, { ZBEE_ZCL_CID_BINARY_OUTPUT_BASIC, "Binary Output (Basic)"}, { ZBEE_ZCL_CID_BINARY_VALUE_BASIC, "Binary Value (Basic)"}, { ZBEE_ZCL_CID_MULTISTATE_INPUT_BASIC, "Multistate Input (Basic)"}, { ZBEE_ZCL_CID_MULTISTATE_OUTPUT_BASIC, "Multistate Output (Basic)"}, { ZBEE_ZCL_CID_MULTISTATE_VALUE_BASIC, "Multistate Value (Basic)"}, { ZBEE_ZCL_CID_COMMISSIONING, "Commissioning"}, { ZBEE_ZCL_CID_PARTITION, "Partition"}, { ZBEE_ZCL_CID_OTA_UPGRADE, "OTA Upgrade"}, { ZBEE_ZCL_CID_POLL_CONTROL, "Poll Control"}, { ZBEE_ZCL_CID_GP, "Green Power"}, /* */ { ZBEE_ZCL_CID_POWER_PROFILE, "Power Profile"}, { ZBEE_ZCL_CID_APPLIANCE_CONTROL, "Appliance Control"}, /* Closures */ { ZBEE_ZCL_CID_SHADE_CONFIG, "Shade Configuration"}, { ZBEE_ZCL_CID_DOOR_LOCK, "Door Lock"}, /* HVAC */ { ZBEE_ZCL_CID_PUMP_CONFIG_CONTROL, "Pump Configuration Control"}, { ZBEE_ZCL_CID_THERMOSTAT, "Thermostat"}, { ZBEE_ZCL_CID_FAN_CONTROL, "Fan Control"}, { ZBEE_ZCL_CID_DEHUMIDIFICATION_CONTROL, "Dehumidification Control"}, { ZBEE_ZCL_CID_THERMOSTAT_UI_CONFIG, "Thermostat User Interface Configuration"}, /* Lighting */ { ZBEE_ZCL_CID_COLOR_CONTROL, "Color Control"}, { ZBEE_ZCL_CID_BALLAST_CONFIG, "Ballast Configuration"}, /* Measurement and Sensing */ { ZBEE_ZCL_CID_ILLUMINANCE_MEASUREMENT, "Illuminance Measurement"}, { ZBEE_ZCL_CID_ILLUMINANCE_LEVEL_SENSING, "Illuminance Level Sensing"}, { ZBEE_ZCL_CID_TEMPERATURE_MEASUREMENT, "Temperature Measurement"}, { ZBEE_ZCL_CID_PRESSURE_MEASUREMENT, "Pressure Measurement"}, { ZBEE_ZCL_CID_FLOW_MEASUREMENT, "Flow Measurement"}, { ZBEE_ZCL_CID_REL_HUMIDITY_MEASUREMENT, "Relative Humidity Measurement"}, { ZBEE_ZCL_CID_OCCUPANCY_SENSING, "Occupancy Sensing"}, /* Security and Safety */ { ZBEE_ZCL_CID_IAS_ZONE, "Intruder Alarm System Zone"}, { ZBEE_ZCL_CID_IAS_ACE, "Intruder Alarm System ACE"}, { ZBEE_ZCL_CID_IAS_WD, "Intruder Alarm System WD"}, /* Protocol Interfaces */ { ZBEE_ZCL_CID_GENERIC_TUNNEL, "BACnet Generic Tunnel"}, { ZBEE_ZCL_CID_BACNET_PROTOCOL_TUNNEL, "BACnet Protocol Tunnel"}, { ZBEE_ZCL_CID_BACNET_ANALOG_INPUT_REG, "BACnet Analog Input (Regular)"}, { ZBEE_ZCL_CID_BACNET_ANALOG_INPUT_EXT, "BACnet Analog Input (Extended)"}, { ZBEE_ZCL_CID_BACNET_ANALOG_OUTPUT_REG, "BACnet Analog Output (Regular)"}, { ZBEE_ZCL_CID_BACNET_ANALOG_OUTPUT_EXT, "BACnet Analog Output (Extended)"}, { ZBEE_ZCL_CID_BACNET_ANALOG_VALUE_REG, "BACnet Analog Value (Regular)"}, { ZBEE_ZCL_CID_BACNET_ANALOG_VALUE_EXT, "BACnet Analog Value (Extended)"}, { ZBEE_ZCL_CID_BACNET_BINARY_INPUT_REG, "BACnet Binary Input (Regular)"}, { ZBEE_ZCL_CID_BACNET_BINARY_INPUT_EXT, "BACnet Binary Input (Extended)"}, { ZBEE_ZCL_CID_BACNET_BINARY_OUTPUT_REG, "BACnet Binary Output (Regular)"}, { ZBEE_ZCL_CID_BACNET_BINARY_OUTPUT_EXT, "BACnet Binary Output (Extended)"}, { ZBEE_ZCL_CID_BACNET_BINARY_VALUE_REG, "BACnet Binary Value (Regular)"}, { ZBEE_ZCL_CID_BACNET_BINARY_VALUE_EXT, "BACnet Binary Value (Extended)"}, { ZBEE_ZCL_CID_BACNET_MULTISTATE_INPUT_REG, "BACnet Multistage Input (Regular)"}, { ZBEE_ZCL_CID_BACNET_MULTISTATE_INPUT_EXT, "BACnet Multistage Input (Extended)"}, { ZBEE_ZCL_CID_BACNET_MULTISTATE_OUTPUT_REG, "BACnet Multistage Output (Regular)"}, { ZBEE_ZCL_CID_BACNET_MULTISTATE_OUTPUT_EXT, "BACnet Multistage Output (Extended)"}, { ZBEE_ZCL_CID_BACNET_MULTISTATE_VALUE_REG, "BACnet Multistage Value (Regular)"}, { ZBEE_ZCL_CID_BACNET_MULTISTATE_VALUE_EXT, "BACnet Multistage Value (Extended)"}, /* ZCL Cluster IDs - Smart Energy */ { ZBEE_ZCL_CID_PRICE, "Price"}, { ZBEE_ZCL_CID_DEMAND_RESPONSE_LOAD_CONTROL, "Demand Response and Load Control"}, { ZBEE_ZCL_CID_SIMPLE_METERING, "Simple Metering"}, { ZBEE_ZCL_CID_MESSAGE, "Message"}, { ZBEE_ZCL_CID_TUNNELING, "Tunneling"}, { ZBEE_ZCL_CID_PRE_PAYMENT, "Pre-Payment"}, { ZBEE_ZCL_CID_ENERGY_MANAGEMENT, "Energy Management"}, { ZBEE_ZCL_CID_CALENDAR, "Calendar"}, { ZBEE_ZCL_CID_DEVICE_MANAGEMENT, "Device Management"}, { ZBEE_ZCL_CID_EVENTS, "Events"}, { ZBEE_ZCL_CID_MDU_PAIRING, "MDU Pairing"}, /* ZCL Cluster IDs - Key Establishment */ { ZBEE_ZCL_CID_KE, "Key Establishment"}, /* ZCL Cluster IDs - Home Automation */ {ZBEE_ZCL_CID_APPLIANCE_IDENTIFICATION, "Appliance Identification"}, {ZBEE_ZCL_CID_METER_IDENTIFICATION, "Meter Identification"}, {ZBEE_ZCL_CID_APPLIANCE_EVENTS_AND_ALERT, "Appliance Events And Alerts"}, {ZBEE_ZCL_CID_APPLIANCE_STATISTICS, "Appliance Statistics"}, {ZBEE_ZCL_CID_ZLL, "ZLL Commissioning"}, { 0, NULL } }; /* APS Test Profile #2 Cluster Names */ const value_string zbee_aps_t2_cid_names[] = { { ZBEE_APS_T2_CID_BR, "Broadcast Request"}, { ZBEE_APS_T2_CID_BTADR, "Broadcast to All Devices Response"}, { ZBEE_APS_T2_CID_BTARACR, "Broadcast to All Routers and Coordinator Response"}, { ZBEE_APS_T2_CID_BTARXOWIDR, "Broadcast to All RXOnWhenIdle Devices Response"}, { ZBEE_APS_T2_CID_BTGREQ, "Buffer Test Group Request"}, { ZBEE_APS_T2_CID_BTGRES, "Buffer Test Group Response"}, { ZBEE_APS_T2_CID_BTREQ, "Buffer Test Request"}, { ZBEE_APS_T2_CID_BTRES, "Buffer Test Response"}, { ZBEE_APS_T2_CID_FNDR, "Freeform No Data Response"}, { ZBEE_APS_T2_CID_FREQ, "Freeform Request"}, { ZBEE_APS_T2_CID_FRES, "Freeform Response"}, { ZBEE_APS_T2_CID_PCR, "Packet Count Response"}, { ZBEE_APS_T2_CID_RDREQ, "Route Discovery Request"}, { ZBEE_APS_T2_CID_RDRES, "Route Discovery Response"}, { ZBEE_APS_T2_CID_RESPC, "Reset Packet Count"}, { ZBEE_APS_T2_CID_RETPC, "Retrieve Packet Count"}, { ZBEE_APS_T2_CID_TCP, "Transmit Counted Packets"}, { 0, NULL } }; /* APS Test Profile #2 Buffer Test Response Status Names */ const value_string zbee_aps_t2_btres_status_names[] = { { ZBEE_APS_T2_CID_BTRES_S_SBT, "Successful Buffer Test"}, { ZBEE_APS_T2_CID_BTRES_S_TFOFA, "Transmission Failure on First Attempt"}, { 0, NULL } }; /* APS Fragmented Block Acknowledgements */ #define ZBEE_APS_FRAG_BLOCK1_ACK 0x01 #define ZBEE_APS_FRAG_BLOCK2_ACK 0x02 #define ZBEE_APS_FRAG_BLOCK3_ACK 0x04 #define ZBEE_APS_FRAG_BLOCK4_ACK 0x08 #define ZBEE_APS_FRAG_BLOCK5_ACK 0x10 #define ZBEE_APS_FRAG_BLOCK6_ACK 0x20 #define ZBEE_APS_FRAG_BLOCK7_ACK 0x40 #define ZBEE_APS_FRAG_BLOCK8_ACK 0x80 /** *ZigBee Application Support Sublayer dissector for wireshark. * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to data tree Wireshark uses to display packet. */ static int dissect_zbee_aps(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) { tvbuff_t *payload_tvb = NULL; dissector_handle_t profile_handle = NULL; dissector_handle_t zcl_handle = NULL; proto_tree *aps_tree; proto_tree *field_tree; proto_item *proto_root; zbee_aps_packet packet; zbee_nwk_packet *nwk; guint8 fcf; guint8 offset = 0; static const int * frag_ack_flags[] = { &hf_zbee_aps_block_ack1, &hf_zbee_aps_block_ack2, &hf_zbee_aps_block_ack3, &hf_zbee_aps_block_ack4, &hf_zbee_aps_block_ack5, &hf_zbee_aps_block_ack6, &hf_zbee_aps_block_ack7, &hf_zbee_aps_block_ack8, NULL }; /* Reject the packet if data is NULL */ if (data == NULL) return 0; nwk = (zbee_nwk_packet *)data; /* Init. */ memset(&packet, 0, sizeof(zbee_aps_packet)); /* Create the protocol tree */ proto_root = proto_tree_add_protocol_format(tree, proto_zbee_aps, tvb, offset, tvb_captured_length(tvb), "ZigBee Application Support Layer"); aps_tree = proto_item_add_subtree(proto_root, ett_zbee_aps); /* Set the protocol column, if the NWK layer hasn't already done so. */ col_set_str(pinfo->cinfo, COL_PROTOCOL, "ZigBee"); /* Get the FCF */ fcf = tvb_get_guint8(tvb, offset); packet.type = zbee_get_bit_field(fcf, ZBEE_APS_FCF_FRAME_TYPE); packet.delivery = zbee_get_bit_field(fcf, ZBEE_APS_FCF_DELIVERY_MODE); packet.indirect_mode = zbee_get_bit_field(fcf, ZBEE_APS_FCF_INDIRECT_MODE); packet.ack_format = zbee_get_bit_field(fcf, ZBEE_APS_FCF_ACK_FORMAT); packet.security = zbee_get_bit_field(fcf, ZBEE_APS_FCF_SECURITY); packet.ack_req = zbee_get_bit_field(fcf, ZBEE_APS_FCF_ACK_REQ); packet.ext_header = zbee_get_bit_field(fcf, ZBEE_APS_FCF_EXT_HEADER); /* Display the frame type to the proto root and info column. */ proto_item_append_text(proto_root, " %s", val_to_str_const(packet.type, zbee_aps_frame_types, "Unknown Type")); col_set_str(pinfo->cinfo, COL_INFO, "APS: "); col_append_str(pinfo->cinfo, COL_INFO, val_to_str_const(packet.type, zbee_aps_frame_types, "Unknown Frame Type")); /* Display the FCF */ /* Create the subtree */ field_tree = proto_tree_add_subtree_format(aps_tree, tvb, offset, 1, ett_zbee_aps_fcf, NULL, "Frame Control Field: %s (0x%02x)", val_to_str_const(packet.type, zbee_aps_frame_types, "Unknown"), fcf); /* Add the frame type and delivery mode. */ proto_tree_add_uint(field_tree, hf_zbee_aps_fcf_frame_type, tvb, offset, 1, fcf & ZBEE_APS_FCF_FRAME_TYPE); proto_tree_add_uint(field_tree, hf_zbee_aps_fcf_delivery, tvb, offset, 1, fcf & ZBEE_APS_FCF_DELIVERY_MODE); if (nwk->version >= ZBEE_VERSION_2007) { /* ZigBee 2007 and later uses an ack mode flag. */ if (packet.type == ZBEE_APS_FCF_ACK) { proto_tree_add_boolean(field_tree, hf_zbee_aps_fcf_ack_format, tvb, offset, 1, fcf & ZBEE_APS_FCF_ACK_FORMAT); } } else { /* ZigBee 2004, uses indirect mode. */ if (packet.delivery == ZBEE_APS_FCF_INDIRECT) { proto_tree_add_boolean(field_tree, hf_zbee_aps_fcf_indirect_mode, tvb, offset, 1, fcf & ZBEE_APS_FCF_INDIRECT_MODE); } } /* Add the rest of the flags */ proto_tree_add_boolean(field_tree, hf_zbee_aps_fcf_security, tvb, offset, 1, fcf & ZBEE_APS_FCF_SECURITY); proto_tree_add_boolean(field_tree, hf_zbee_aps_fcf_ack_req, tvb, offset, 1, fcf & ZBEE_APS_FCF_ACK_REQ); proto_tree_add_boolean(field_tree, hf_zbee_aps_fcf_ext_header, tvb, offset, 1, fcf & ZBEE_APS_FCF_EXT_HEADER); offset += 1; /* Check if the endpoint addressing fields are present. */ switch (packet.type) { case ZBEE_APS_FCF_DATA: /* Endpoint addressing must exist to some extent on data frames. */ break; case ZBEE_APS_FCF_ACK: if ((nwk->version >= ZBEE_VERSION_2007) && (packet.ack_format)) { /* Command Ack: endpoint addressing does not exist. */ goto dissect_zbee_aps_no_endpt; } break; case ZBEE_APS_FCF_INTERPAN: packet.dst_present = FALSE; packet.src_present = FALSE; break; default: case ZBEE_APS_FCF_CMD: /* Endpoint addressing does not exist for these frames. */ goto dissect_zbee_aps_no_endpt; } /* switch */ if (packet.type != ZBEE_APS_FCF_INTERPAN) { /* Determine whether the source and/or destination endpoints are present. * We should only get here for endpoint-addressed data or ack frames. */ if ((packet.delivery == ZBEE_APS_FCF_UNICAST) || (packet.delivery == ZBEE_APS_FCF_BCAST)) { /* Source and destination endpoints exist. (Although, I strongly * disagree with the presence of the endpoint in broadcast delivery * mode). */ packet.dst_present = TRUE; packet.src_present = TRUE; } else if ((packet.delivery == ZBEE_APS_FCF_INDIRECT) && (nwk->version <= ZBEE_VERSION_2004)) { /* Indirect addressing was removed in ZigBee 2006, basically because it * was a useless, broken feature which only complicated things. Treat * this mode as invalid for ZigBee 2006 and later. When using indirect * addressing, only one of the source and destination endpoints exist, * and is controlled by the setting of indirect_mode. */ packet.dst_present = (!packet.indirect_mode); packet.src_present = (packet.indirect_mode); } else if ((packet.delivery == ZBEE_APS_FCF_GROUP) && (nwk->version >= ZBEE_VERSION_2007)) { /* Group addressing was added in ZigBee 2006, and contains only the * source endpoint. (IMO, Broacast deliveries should do the same). */ packet.dst_present = FALSE; packet.src_present = TRUE; } else { /* Illegal Delivery Mode. */ expert_add_info(pinfo, proto_root, &ei_zbee_aps_invalid_delivery_mode); return tvb_captured_length(tvb); } /* If the destination endpoint is present, get and display it. */ if (packet.dst_present) { packet.dst = tvb_get_guint8(tvb, offset); proto_tree_add_uint(aps_tree, hf_zbee_aps_dst, tvb, offset, 1, packet.dst); proto_item_append_text(proto_root, ", Dst Endpt: %d", packet.dst); offset += 1; /* Update the info column. */ col_append_fstr(pinfo->cinfo, COL_INFO, ", Dst Endpt: %d", packet.dst); } } /* if !interpan */ /* If the group address is present, display it. */ if (packet.delivery == ZBEE_APS_FCF_GROUP) { packet.group = tvb_get_letohs(tvb, offset); proto_tree_add_uint(aps_tree, hf_zbee_aps_group, tvb, offset,2, packet.group); proto_item_append_text(proto_root, ", Group: 0x%04x", packet.group); offset +=2; /* Update the info column. */ col_append_fstr(pinfo->cinfo, COL_INFO, ", Group: 0x%04x", packet.group); } /* Get and display the cluster ID. */ if (nwk->version >= ZBEE_VERSION_2007) { /* Cluster ID is 16-bits long in ZigBee 2007 and later. */ nwk->cluster_id = tvb_get_letohs(tvb, offset); switch (tvb_get_letohs(tvb, offset + 2)) { case ZBEE_DEVICE_PROFILE: proto_tree_add_uint_format(aps_tree, hf_zbee_aps_zdp_cluster, tvb, offset, 2, nwk->cluster_id, "%s (Cluster ID: 0x%04x)", val_to_str(nwk->cluster_id, zbee_zdp_cluster_names, "Unknown Device Profile Cluster"), nwk->cluster_id); break; case ZBEE_PROFILE_T2: proto_tree_add_item(aps_tree, hf_zbee_aps_t2_cluster, tvb, offset, 2, ENC_LITTLE_ENDIAN); if (packet.type == ZBEE_APS_FCF_DATA) { col_set_str(pinfo->cinfo, COL_INFO, val_to_str_const(nwk->cluster_id, zbee_aps_t2_cid_names, "Unknown T2 cluster")); } break; default: proto_tree_add_item(aps_tree, hf_zbee_aps_cluster, tvb, offset, 2, ENC_LITTLE_ENDIAN); break; } offset += 2; } else { /* Cluster ID is 8-bits long in ZigBee 2004 and earlier. */ nwk->cluster_id = tvb_get_guint8(tvb, offset); proto_tree_add_uint_format_value(aps_tree, hf_zbee_aps_cluster, tvb, offset, 1, nwk->cluster_id, "0x%02x", nwk->cluster_id); offset += 1; } /* Get and display the profile ID. */ packet.profile = tvb_get_letohs(tvb, offset); profile_handle = dissector_get_uint_handle(zbee_aps_dissector_table, packet.profile); proto_tree_add_uint(aps_tree, hf_zbee_aps_profile, tvb, offset,2, packet.profile); /* Update the protocol root and info column later, after the source endpoint * so that the source and destination will be back-to-back in the text. */ offset +=2; /* The source endpoint is present for all cases except indirect /w indirect_mode == FALSE */ if (packet.type != ZBEE_APS_FCF_INTERPAN && ((packet.delivery != ZBEE_APS_FCF_INDIRECT) || (!packet.indirect_mode))) { packet.src = tvb_get_guint8(tvb, offset); proto_tree_add_uint(aps_tree, hf_zbee_aps_src, tvb, offset, 1, packet.src); proto_item_append_text(proto_root, ", Src Endpt: %d", packet.src); offset += 1; /* Update the info column. */ col_append_fstr(pinfo->cinfo, COL_INFO, ", Src Endpt: %d", packet.src); } /* Display the profile ID now that the source endpoint was listed. */ if (packet.type == ZBEE_APS_FCF_DATA) { col_append_fstr(pinfo->cinfo, COL_PROTOCOL, " %s", rval_to_str_const(packet.profile, zbee_aps_apid_abbrs, "")); } /* Jump here if there is no endpoint addressing in this frame. */ dissect_zbee_aps_no_endpt: /* Get and display the APS counter. Only present on ZigBee 2007 and later. */ if (nwk->version >= ZBEE_VERSION_2007 && packet.type != ZBEE_APS_FCF_INTERPAN) { packet.counter = tvb_get_guint8(tvb, offset); proto_tree_add_uint(aps_tree, hf_zbee_aps_counter, tvb, offset, 1, packet.counter); offset += 1; } /* Get and display the extended header, if present. */ if (packet.ext_header) { fcf = tvb_get_guint8(tvb, offset); packet.fragmentation = fcf & ZBEE_APS_EXT_FCF_FRAGMENT; /* Create a subtree */ field_tree = proto_tree_add_subtree_format(aps_tree, tvb, offset, 1, ett_zbee_aps_fcf, NULL, "Extended Frame Control Field (0x%02x)", fcf); /* Display the fragmentation sub-field. */ proto_tree_add_uint(field_tree, hf_zbee_aps_fragmentation, tvb, offset, 1, packet.fragmentation); offset += 1; /* If fragmentation is enabled, get and display the block number. */ if (packet.fragmentation != ZBEE_APS_EXT_FCF_FRAGMENT_NONE) { packet.block_number = tvb_get_guint8(tvb, offset); proto_tree_add_uint(field_tree, hf_zbee_aps_block_number, tvb, offset, 1, packet.block_number); offset += 1; } /* If fragmentation is enabled, and this is an acknowledgement, get and display the ack bitfield. */ if ((packet.fragmentation != ZBEE_APS_EXT_FCF_FRAGMENT_NONE) && (packet.type == ZBEE_APS_FCF_ACK)) { proto_tree_add_bitmask(field_tree, tvb, offset, hf_zbee_aps_block_ack, ett_zbee_aps_frag_ack, frag_ack_flags, ENC_NA); offset += 1; } } else { /* Ensure the fragmentation mode is set off, so that the reassembly handler * doesn't get called. */ packet.fragmentation = ZBEE_APS_EXT_FCF_FRAGMENT_NONE; } /* If a payload is present, and security is enabled, decrypt the payload. */ if ((offset < tvb_captured_length(tvb)) && packet.security) { payload_tvb = dissect_zbee_secure(tvb, pinfo, aps_tree, offset); if (payload_tvb == NULL) { /* If Payload_tvb is NULL, then the security dissector cleaned up. */ return tvb_captured_length(tvb); } } /* If the payload exists, create a tvb subset. */ else if (offset < tvb_captured_length(tvb)) { payload_tvb = tvb_new_subset_remaining(tvb, offset); } /* If the payload exists, and the packet is fragmented, attempt reassembly. */ if ((payload_tvb) && (packet.fragmentation != ZBEE_APS_EXT_FCF_FRAGMENT_NONE)) { guint32 msg_id; guint32 block_num; guint32 num_blocks; fragment_head *frag_msg = NULL; tvbuff_t *new_tvb; /* Set the fragmented flag. */ pinfo->fragmented = TRUE; /* The source address and APS Counter pair form a unique identifier * for each message (fragmented or not). Hash these two together to * create the message id for the fragmentation handler. */ msg_id = ((nwk->src)<<8) + packet.counter; /* If this is the first block of a fragmented message, than the block * number field is the maximum number of blocks in the message. Otherwise * the block number is the block being sent. */ if (packet.fragmentation == ZBEE_APS_EXT_FCF_FRAGMENT_FIRST) { num_blocks = packet.block_number - 1; block_num = 0; /* first packet. */ } else { block_num = packet.block_number; num_blocks = 0; } /* Add this fragment to the reassembly handler. */ frag_msg = fragment_add_seq_check(&zbee_aps_reassembly_table, payload_tvb, 0, pinfo, msg_id, NULL, block_num, tvb_captured_length(payload_tvb), TRUE); if (num_blocks > 0) { fragment_set_tot_len(&zbee_aps_reassembly_table, pinfo, msg_id, NULL, num_blocks); } new_tvb = process_reassembled_data(payload_tvb, 0, pinfo, "Reassembled ZigBee APS" , frag_msg, &zbee_aps_frag_items, NULL, aps_tree); if (new_tvb) { /* The reassembly handler defragmented the message, and created a new tvbuff. */ payload_tvb = new_tvb; } else { /* The reassembly handler could not defragment the message. */ col_append_fstr(pinfo->cinfo, COL_INFO, " (fragment %d)", block_num); call_data_dissector(payload_tvb, pinfo, tree); return tvb_captured_length(tvb); } } /* Handle the packet type. */ switch (packet.type) { case ZBEE_APS_FCF_DATA: case ZBEE_APS_FCF_INTERPAN: if (!payload_tvb) { break; } if (nwk->version <= ZBEE_VERSION_2004) { /* * In ZigBee 2004, an "application framework" sits between the * APS and application. Call a subdissector to handle it. */ nwk->private_data = profile_handle; profile_handle = zbee_apf_handle; } else if (profile_handle == NULL) { if (payload_tvb && (packet.profile == ZBEE_PROFILE_T2)) { /* Move T2 dissect here: don't want to show T2 contents as * ZCL mess, broken packets etc */ payload_tvb = tvb_new_subset_remaining(payload_tvb, dissect_zbee_t2(payload_tvb, aps_tree, nwk->cluster_id)); } else { /* Could not locate a profile dissector, but there may be profile-wide commands so try to dissect them */ zcl_handle = find_dissector(ZBEE_PROTOABBREV_ZCL); } if (zcl_handle) { call_dissector_with_data(zcl_handle, payload_tvb, pinfo, tree, nwk); } break; } call_dissector_with_data(profile_handle, payload_tvb, pinfo, tree, nwk); return tvb_captured_length(tvb); case ZBEE_APS_FCF_CMD: if (!payload_tvb) { /* Command packets MUST contain a payload. */ expert_add_info(pinfo, proto_root, &ei_zbee_aps_missing_payload); return tvb_captured_length(tvb); } dissect_zbee_aps_cmd(payload_tvb, pinfo, aps_tree, nwk->version, data); return tvb_captured_length(tvb); case ZBEE_APS_FCF_ACK: /* Acks should never contain a payload. */ break; default: /* Illegal frame type. */ break; } /* switch */ /* * If we get this far, then no subdissectors have been called, use the data * dissector to display the leftover bytes, if any. */ if (payload_tvb) { call_data_dissector(payload_tvb, pinfo, tree); } return tvb_captured_length(tvb); } /* dissect_zbee_aps */ /** *ZigBee APS sub-dissector for APS Command frames * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to data tree Wireshark uses to display packet. *@param proto_root pointer to the root of the APS tree *@param data raw packet private data. */ static void dissect_zbee_aps_cmd(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint8 version, void *data) { proto_item *cmd_root; proto_tree *cmd_tree; guint offset = 0; guint8 cmd_id = tvb_get_guint8(tvb, offset); /* Create a subtree for the APS Command frame, and add the command ID to it. */ cmd_tree = proto_tree_add_subtree_format(tree, tvb, offset, -1, ett_zbee_aps_cmd, &cmd_root, "Command Frame: %s", val_to_str_const(cmd_id, zbee_aps_cmd_names, "Unknown")); /* Add the command ID. */ proto_tree_add_uint(cmd_tree, hf_zbee_aps_cmd_id, tvb, offset, 1, cmd_id); offset += 1; /* Add the command name to the info column. */ col_set_str(pinfo->cinfo, COL_INFO, val_to_str_const(cmd_id, zbee_aps_cmd_names, "Unknown Command")); /* Handle the contents of the command frame. */ switch(cmd_id){ case ZBEE_APS_CMD_SKKE1: case ZBEE_APS_CMD_SKKE2: offset = dissect_zbee_aps_skke_challenge(tvb, pinfo, cmd_tree, offset); break; case ZBEE_APS_CMD_SKKE3: case ZBEE_APS_CMD_SKKE4: offset = dissect_zbee_aps_skke_data(tvb, pinfo, cmd_tree, offset); break; case ZBEE_APS_CMD_TRANSPORT_KEY: /* Transport Key Command. */ offset = dissect_zbee_aps_transport_key(tvb, pinfo, cmd_tree, offset); break; case ZBEE_APS_CMD_UPDATE_DEVICE: /* Update Device Command. */ offset = dissect_zbee_aps_update_device(tvb, pinfo, cmd_tree, offset, version); break; case ZBEE_APS_CMD_REMOVE_DEVICE: /* Remove Device. */ offset = dissect_zbee_aps_remove_device(tvb, pinfo, cmd_tree, offset); break; case ZBEE_APS_CMD_REQUEST_KEY: /* Request Key Command. */ offset = dissect_zbee_aps_request_key(tvb, pinfo, cmd_tree, offset); break; case ZBEE_APS_CMD_SWITCH_KEY: /* Switch Key Command. */ offset = dissect_zbee_aps_switch_key(tvb, pinfo, cmd_tree, offset); break; case ZBEE_APS_CMD_EA_INIT_CHLNG: case ZBEE_APS_CMD_EA_RESP_CHLNG: /* Entity Authentication Challenge Command. */ offset = dissect_zbee_aps_auth_challenge(tvb, pinfo, cmd_tree, offset); break; case ZBEE_APS_CMD_EA_INIT_MAC_DATA: case ZBEE_APS_CMD_EA_RESP_MAC_DATA: /* Entity Authentication Data Command. */ offset = dissect_zbee_aps_auth_data(tvb, pinfo, cmd_tree, offset); break; case ZBEE_APS_CMD_TUNNEL: /* Tunnel Command. */ offset = dissect_zbee_aps_tunnel(tvb, pinfo, cmd_tree, offset, data); break; case ZBEE_APS_CMD_VERIFY_KEY: /* Verify Key Command. */ offset = dissect_zbee_aps_verify_key(tvb, pinfo, cmd_tree, offset); break; case ZBEE_APS_CMD_CONFIRM_KEY: /* Confirm Key Command. */ offset = dissect_zbee_aps_confirm_key(tvb, pinfo, cmd_tree, offset); break; default: break; } /* switch */ /* Check for any excess bytes. */ if (offset < tvb_captured_length(tvb)) { /* There are leftover bytes! */ proto_tree *root; tvbuff_t *leftover_tvb = tvb_new_subset_remaining(tvb, offset); /* Get the APS Root. */ root = proto_tree_get_root(tree); /* Correct the length of the command tree. */ proto_item_set_len(cmd_root, offset); /* Dump the leftover to the data dissector. */ call_data_dissector(leftover_tvb, pinfo, root); } } /* dissect_zbee_aps_cmd */ /** *Helper dissector for the SKKE Challenge commands (SKKE1 and * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to the command subtree. *@param offset into the tvb to begin dissection. *@return offset after command dissection. */ static guint dissect_zbee_aps_skke_challenge(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset) { /* Get and display the initiator address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_initiator, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* Get and display the responder address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_responder, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* Get and display the SKKE data. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_challenge, tvb, offset, ZBEE_APS_CMD_SKKE_DATA_LENGTH, ENC_NA); offset += ZBEE_APS_CMD_SKKE_DATA_LENGTH; /* Done */ return offset; } /* dissect_zbee_aps_skke_challenge */ /** *Helper dissector for the SKKE Data commands (SKKE3 and * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to the command subtree. *@param offset into the tvb to begin dissection. *@return offset after command dissection. */ static guint dissect_zbee_aps_skke_data(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset) { /* Get and display the initiator address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_initiator, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* Get and display the responder address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_responder, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* Get and display the SKKE data. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_mac, tvb, offset, ZBEE_APS_CMD_SKKE_DATA_LENGTH, ENC_NA); offset += ZBEE_APS_CMD_SKKE_DATA_LENGTH; /* Done */ return offset; } /* dissect_zbee_aps_skke_data */ /** *Helper dissector for the Transport Key command. * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to the command subtree. *@param offset into the tvb to begin dissection. *@return offset after command dissection. */ static guint dissect_zbee_aps_transport_key(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset) { guint8 key_type; guint8 key[ZBEE_APS_CMD_KEY_LENGTH]; GSList **nwk_keyring; key_record_t key_record; zbee_nwk_hints_t *nwk_hints; guint i; /* Get and display the key type. */ key_type = tvb_get_guint8(tvb, offset); proto_tree_add_uint(tree, hf_zbee_aps_cmd_key_type, tvb, offset, 1, key_type); offset += 1; /* Coincidentally, all the key descriptors start with the key. So * get and display it. */ for (i=0; ifd->flags.visited && (nwk_hints = (zbee_nwk_hints_t *)p_get_proto_data(wmem_file_scope(), pinfo, proto_get_id_by_filter_name(ZBEE_PROTOABBREV_NWK), 0))) { nwk_keyring = (GSList **)g_hash_table_lookup(zbee_table_nwk_keyring, &nwk_hints->src_pan); if ( !nwk_keyring ) { nwk_keyring = (GSList **)g_malloc0(sizeof(GSList*)); g_hash_table_insert(zbee_table_nwk_keyring, g_memdup(&nwk_hints->src_pan, sizeof(nwk_hints->src_pan)), nwk_keyring); } if ( nwk_keyring ) { if ( !*nwk_keyring || memcmp( ((key_record_t *)((GSList *)(*nwk_keyring))->data)->key, &key, ZBEE_APS_CMD_KEY_LENGTH) ) { /* Store a new or different key in the key ring */ key_record.frame_num = pinfo->num; key_record.label = NULL; memcpy(&key_record.key, &key, ZBEE_APS_CMD_KEY_LENGTH); *nwk_keyring = g_slist_prepend(*nwk_keyring, g_memdup(&key_record, sizeof(key_record_t))); } } } /* Parse the rest of the key descriptor. */ switch (key_type) { case ZBEE_APS_CMD_KEY_STANDARD_NWK: case ZBEE_APS_CMD_KEY_HIGH_SEC_NWK: { /* Network Key */ guint8 seqno; /* Get and display the sequence number. */ seqno = tvb_get_guint8(tvb, offset); proto_tree_add_uint(tree, hf_zbee_aps_cmd_seqno, tvb, offset, 1, seqno); offset += 1; /* Get and display the destination address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_dst, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* Get and display the source address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_src, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; break; } case ZBEE_APS_CMD_KEY_TC_MASTER: case ZBEE_APS_CMD_KEY_TC_LINK: { /* Trust Center master key. */ /* Get and display the destination address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_dst, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* Get and display the source address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_src, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; break; } case ZBEE_APS_CMD_KEY_APP_MASTER: case ZBEE_APS_CMD_KEY_APP_LINK: { /* Application master or link key, both have the same format. */ guint8 initiator; /* get and display the partner address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_partner, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* get and display the initiator flag. */ initiator = tvb_get_guint8(tvb, offset); proto_tree_add_boolean(tree, hf_zbee_aps_cmd_initiator_flag, tvb, offset, 1, initiator); offset += 1; break; } default: break; } /* switch */ /* Done */ return offset; } /* dissect_zbee_aps_transport_key */ /** *Helper dissector for the Verify Key Command. * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to the command subtree. *@param offset into the tvb to begin dissection. *@return offset after command dissection. */ static guint dissect_zbee_aps_verify_key(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset) { /* display the key type. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_key_type, tvb, offset, 1, ENC_NA); offset += 1; /* Get and display the source address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_src, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* This value is the outcome of executing the specialized keyed hash * function specified in section B.1.4 using a key with the 1-octet string * 03 as the input string. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_key_hash, tvb, offset, ZBEE_APS_CMD_KEY_LENGTH, ENC_NA); offset += ZBEE_APS_CMD_KEY_LENGTH; /* Done */ return offset; } /* dissect_zbee_aps_verify_key */ /** *Helper dissector for the Confirm Key command. * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to the command subtree. *@param offset into the tvb to begin dissection. *@return offset after command dissection. */ static guint dissect_zbee_aps_confirm_key(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset) { /* display status. */ guint status = tvb_get_guint8(tvb, offset); proto_tree_add_item(tree, hf_zbee_aps_cmd_status, tvb, offset, 1, ENC_LITTLE_ENDIAN); offset += 1; /* display the key type. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_key_type, tvb, offset, 1, ENC_NA); offset += 1; proto_tree_add_item(tree, hf_zbee_aps_cmd_dst, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; proto_item_append_text(tree, ", %s", val_to_str_const(status, zbee_aps_status_names, "Unknown Status")); col_append_fstr(pinfo->cinfo, COL_INFO, ", %s", val_to_str_const(status, zbee_aps_status_names, "Unknown Status")); /* Done */ return offset; } /* dissect_zbee_aps_confirm_key */ /** *Helper dissector for the Update Device command. * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to the command subtree. *@param offset into the tvb to begin dissection. *@return offset after command dissection. */ static guint dissect_zbee_aps_update_device(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset, guint8 version) { /* Get and display the device address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_device, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* Get and display the short address. Only on ZigBee 2006 and later. */ if (version >= ZBEE_VERSION_2007) { proto_tree_add_item(tree, hf_zbee_aps_cmd_short_addr, tvb, offset, 2, ENC_LITTLE_ENDIAN); offset +=2; } /* Get and display the status. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_device_status, tvb, offset, 1, ENC_LITTLE_ENDIAN); offset += 1; /* Done */ return offset; } /* dissect_zbee_aps_update_device */ /** *Helper dissector for the Remove Device command. * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to the command subtree. *@param offset into the tvb to begin dissection. *@return offset after command dissection. */ static guint dissect_zbee_aps_remove_device(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset) { /* Get and display the device address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_device, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* Done */ return offset; } /* dissect_zbee_aps_remove_device */ /** *Helper dissector for the Request Key command. * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to the command subtree. *@param offset into the tvb to begin dissection. *@return offset after command dissection. */ static guint dissect_zbee_aps_request_key(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset) { guint8 key_type; /* Get and display the key type. */ key_type = tvb_get_guint8(tvb, offset); proto_tree_add_uint(tree, hf_zbee_aps_cmd_key_type, tvb, offset, 1, key_type); offset += 1; /* Get and display the partner address. Only present on application master key. */ if (key_type == ZBEE_APS_CMD_KEY_APP_MASTER) { proto_tree_add_item(tree, hf_zbee_aps_cmd_partner, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; } /* Done */ return offset; } /* dissect_zbee_aps_request_key */ /** *Helper dissector for the Switch Key command. * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to the command subtree. *@param offset into the tvb to begin dissection. *@return offset after command dissection. */ static guint dissect_zbee_aps_switch_key(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset) { guint8 seqno; /* Get and display the sequence number. */ seqno = tvb_get_guint8(tvb, offset); proto_tree_add_uint(tree, hf_zbee_aps_cmd_seqno, tvb, offset, 1, seqno); offset += 1; /* Done */ return offset; } /* dissect_zbee_aps_switch_key */ /** *Helper dissector for the Entity-Authentication Initiator * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to the command subtree. *@param offset into the tvb to begin dissection. *@return offset after command dissection. */ static guint dissect_zbee_aps_auth_challenge(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset) { guint8 key_type; guint8 key_seqno; /* Get and display the key type. */ key_type = tvb_get_guint8(tvb, offset); proto_tree_add_uint(tree, hf_zbee_aps_cmd_ea_key_type, tvb, offset, 1, key_type); offset += 1; /* If using the network key, display the key sequence number. */ if (key_type == ZBEE_APS_CMD_EA_KEY_NWK) { key_seqno = tvb_get_guint8(tvb, offset); proto_tree_add_uint(tree, hf_zbee_aps_cmd_seqno, tvb, offset, 1, key_seqno); offset += 1; } /* Get and display the initiator address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_initiator, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* Get and display the responder address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_responder, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* Get and display the challenge. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_challenge, tvb, offset, ZBEE_APS_CMD_EA_CHALLENGE_LENGTH, ENC_NA); offset += ZBEE_APS_CMD_EA_CHALLENGE_LENGTH; /* Done*/ return offset; } /* dissect_zbee_aps_auth_challenge */ /** *Helper dissector for the Entity-Authentication Initiator * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to the command subtree. *@param offset into the tvb to begin dissection. *@return offset after command dissection. */ static guint dissect_zbee_aps_auth_data(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree, guint offset) { guint8 data_type; /* Display the MAC. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_mac, tvb, offset, ZBEE_APS_CMD_EA_MAC_LENGTH, ENC_NA); offset += ZBEE_APS_CMD_EA_MAC_LENGTH; /* Get and display the data type. */ data_type = tvb_get_guint8(tvb, offset); /* Note! We're interpreting the DataType field to be the same as * KeyType field in the challenge frames. So far, this seems * consistent, although ZigBee appears to have left some holes * in the definition of the DataType and Data fields (ie: what * happens when KeyType == Link Key?) */ proto_tree_add_uint(tree, hf_zbee_aps_cmd_ea_key_type, tvb, offset, 1, data_type); offset += 1; /* Display the data field. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_ea_data, tvb, offset, ZBEE_APS_CMD_EA_DATA_LENGTH, ENC_NA); offset += ZBEE_APS_CMD_EA_DATA_LENGTH; /* Done */ return offset; } /* dissect_zbee_aps_auth_data */ /** *Helper dissector for the Tunnel command. * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to the command subtree. *@param offset into the tvb to begin dissection. *@param data raw packet private data. *@return offset after command dissection. */ static guint dissect_zbee_aps_tunnel(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset, void *data) { proto_tree *root; tvbuff_t *tunnel_tvb; /* Get and display the destination address. */ proto_tree_add_item(tree, hf_zbee_aps_cmd_dst, tvb, offset, 8, ENC_LITTLE_ENDIAN); offset += 8; /* The remainder is a tunneled APS frame. */ tunnel_tvb = tvb_new_subset_remaining(tvb, offset); root = proto_tree_get_root(tree); call_dissector_with_data(zbee_aps_handle, tunnel_tvb, pinfo, root, data); offset = tvb_captured_length(tvb); /* Done */ return offset; } /* dissect_zbee_aps_tunnel */ /** *ZigBee Application Framework dissector for Wireshark. Note * *@param tvb pointer to buffer containing raw packet. *@param pinfo pointer to packet information fields *@param tree pointer to data tree. */ static int dissect_zbee_apf(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data) { proto_tree *apf_tree; proto_item *proto_root; guint8 count; guint8 type; guint offset = 0; guint i; tvbuff_t *app_tvb; dissector_handle_t app_dissector = NULL; zbee_nwk_packet *nwk = (zbee_nwk_packet *)data; if (nwk != NULL) app_dissector = (dissector_handle_t)(nwk->private_data); /* Create the tree for the application framework. */ proto_root = proto_tree_add_protocol_format(tree, proto_zbee_apf, tvb, 0, tvb_captured_length(tvb), "ZigBee Application Framework"); apf_tree = proto_item_add_subtree(proto_root, ett_zbee_apf); /* Get the count and type. */ count = zbee_get_bit_field(tvb_get_guint8(tvb, offset), ZBEE_APP_COUNT); type = zbee_get_bit_field(tvb_get_guint8(tvb, offset), ZBEE_APP_TYPE); proto_tree_add_uint(apf_tree, hf_zbee_apf_count, tvb, offset, 1, count); proto_tree_add_uint(apf_tree, hf_zbee_apf_type, tvb, offset, 1, type); offset += 1; /* Ensure the application dissector exists. */ if (app_dissector == NULL) { /* No dissector for this profile. */ goto dissect_app_end; } /* Handle the transactions. */ for (i=0; i