/* packet-ieee802154.h * * IEEE 802.15.4 Dissectors for Wireshark * By Owen Kirby * Copyright 2007 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. */ #ifndef PACKET_IEEE802154_H #define PACKET_IEEE802154_H /* Protocol Abbreviation */ #define IEEE802154_PROTOABBREV_WPAN "wpan" #define IEEE802154_PROTOABBREV_WPAN_BEACON "wpan.beacon" /* PANID dissector list is for Decode-As and stateful dissection only. */ #define IEEE802154_PROTOABBREV_WPAN_PANID "wpan.panid" /* Packet Overhead from MAC header + footer (excluding addressing) */ #define IEEE802154_MAX_FRAME_LEN 127 #define IEEE802154_FCS_LEN 2 /* Command Frame Identifier Types Definions */ #define IEEE802154_CMD_ASSOC_REQ 0x01 #define IEEE802154_CMD_ASSOC_RSP 0x02 #define IEEE802154_CMD_DISASSOC_NOTIFY 0x03 #define IEEE802154_CMD_DATA_RQ 0x04 #define IEEE802154_CMD_PANID_CONFLICT 0x05 #define IEEE802154_CMD_ORPHAN_NOTIFY 0x06 #define IEEE802154_CMD_BEACON_REQ 0x07 #define IEEE802154_CMD_COORD_REALIGN 0x08 #define IEEE802154_CMD_GTS_REQ 0x09 #define IEEE802154_CMD_TRLE_MGMT_REQ 0x0a #define IEEE802154_CMD_TRLE_MGMT_RSP 0x0b /* 0x0c-0x12 reserved in IEEE802.15.4-2015 */ #define IEEE802154_CMD_DSME_ASSOC_REQ 0x13 #define IEEE802154_CMD_DSME_ASSOC_RSP 0x14 #define IEEE802154_CMD_DSME_GTS_REQ 0x15 #define IEEE802154_CMD_DSME_GTS_RSP 0x16 #define IEEE802154_CMD_DSME_GTS_NOTIFY 0x17 #define IEEE802154_CMD_DSME_INFO_REQ 0x18 #define IEEE802154_CMD_DSME_INFO_RSP 0x19 #define IEEE802154_CMD_DSME_BEACON_ALLOC_NOTIFY 0x1a #define IEEE802154_CMD_DSME_BEACON_COLL_NOTIFY 0x1b #define IEEE802154_CMD_DSME_LINK_REPORT 0x1c /* 0x1d-0x1f reserved in IEEE802.15.4-2015 */ #define IEEE802154_CMD_RIT_DATA_REQ 0x20 #define IEEE802154_CMD_DBS_REQ 0x21 #define IEEE802154_CMD_DBS_RSP 0x22 /* 0x22-0x1f reserved in IEEE802.15.4-2015 */ /* Definitions for Association Response Command */ #define IEEE802154_CMD_ASRSP_AS_SUCCESS 0x00 #define IEEE802154_CMD_ASRSP_PAN_FULL 0x01 #define IEEE802154_CMD_ASRSP_PAN_DENIED 0x02 /* Bit Masks for Capability Information Field Included in Association Req. command */ #define IEEE802154_CMD_CINFO_ALT_PAN_COORD 0x01 #define IEEE802154_CMD_CINFO_DEVICE_TYPE 0x02 #define IEEE802154_CMD_CINFO_POWER_SRC 0x04 #define IEEE802154_CMD_CINFO_IDLE_RX 0x08 #define IEEE802154_CMD_CINFO_SEC_CAPABLE 0x40 #define IEEE802154_CMD_CINFO_ALLOC_ADDR 0x80 #define IEEE802154_CMD_GTS_REQ_LEN 0x0F #define IEEE802154_CMD_GTS_REQ_DIR 0x10 #define IEEE802154_CMD_GTS_REQ_TYPE 0x20 /* Bit masks & shifts for various beacon fields */ #define IEEE802154_BEACON_ORDER_MASK 0x000F #define IEEE802154_SUPERFRAME_ORDER_MASK 0x00F0 #define IEEE802154_SUPERFRAME_CAP_MASK 0x0F00 #define IEEE802154_BATT_EXTENSION_MASK 0x1000 #define IEEE802154_SUPERFRAME_COORD_MASK 0x4000 #define IEEE802154_ASSOC_PERMIT_MASK 0x8000 #define IEEE802154_SUPERFRAME_ORDER_SHIFT 4 #define IEEE802154_SUPERFRAME_CAP_SHIFT 8 #define IEEE802154_GTS_COUNT_MASK 0x07 #define IEEE802154_GTS_PERMIT_MASK 0x80 #define IEEE802154_GTS_DIRECTION_SLOT(i) (0x01<<(i)) #define IEEE802154_GTS_MAX_SLOTS 7 #define IEEE802154_GTS_DIRECTION_SLOT1 0x01 #define IEEE802154_GTS_DIRECTION_SLOT2 0x02 #define IEEE802154_GTS_DIRECTION_SLOT3 0x04 #define IEEE802154_GTS_DIRECTION_SLOT4 0x08 #define IEEE802154_GTS_DIRECTION_SLOT5 0x10 #define IEEE802154_GTS_DIRECTION_SLOT6 0x20 #define IEEE802154_GTS_DIRECTION_SLOT7 0x40 #define IEEE802154_GTS_SLOT_MASK 0x0F #define IEEE802154_GTS_LENGTH_MASK 0xF0 #define IEEE802154_GTS_LENGTH_SHIFT 4 #define IEEE802154_PENDADDR_SHORT_MASK 0x07 #define IEEE802154_PENDADDR_LONG_MASK 0x70 #define IEEE802154_PENDADDR_LONG_SHIFT 4 #define IEEE802154_SUPERFRAME_DURATION (IEEE802154_BASE_SLOT_DURATION * IEEE802154_SUPERFRAME_SLOTS) #define IEEE802154_BASE_SLOT_DURATION 60 #define IEEE802154_SUPERFRAME_SLOTS 16 /* Bit-masks for the FCF */ #define IEEE802154_FCF_TYPE_MASK 0x0007 /* Frame Type Mask */ #define IEEE802154_FCF_SEC_EN 0x0008 #define IEEE802154_FCF_FRAME_PND 0x0010 #define IEEE802154_FCF_ACK_REQ 0x0020 #define IEEE802154_FCF_PAN_ID_COMPRESSION 0x0040 /* known as Intra PAN prior to IEEE 802.15.4-2006 */ #define IEEE802154_FCF_SEQNO_SUPPRESSION 0x0100 #define IEEE802154_FCF_IE_PRESENT 0x0200 #define IEEE802154_FCF_DADDR_MASK 0x0C00 /* destination addressing mask */ #define IEEE802154_FCF_VERSION 0x3000 #define IEEE802154_FCF_SADDR_MASK 0xC000 /* source addressing mask */ /* Frame Type Definitions */ #define IEEE802154_FCF_BEACON 0x0 /* Beacon Frame */ #define IEEE802154_FCF_DATA 0x1 /* Data Frame */ #define IEEE802154_FCF_ACK 0x2 /* Acknowlegement Frame */ #define IEEE802154_FCF_CMD 0x3 /* MAC Command Frame */ #define IEEE802154_FCF_RESERVED 0x4 /* reserved */ #define IEEE802154_FCF_MULTIPURPOSE 0x5 /* Multipurpose */ #define IEEE802154_FCF_FRAGMENT 0x6 /* Fragment or Frak */ #define IEEE802154_FCF_EXTENDED 0x7 /* Extended */ /* Frame version definitions. */ #define IEEE802154_VERSION_2003 0x0 #define IEEE802154_VERSION_2006 0x1 #define IEEE802154_VERSION_2015 0x2 #define IEEE802154_VERSION_RESERVED 0x3 /* Address Mode Definitions */ #define IEEE802154_FCF_ADDR_NONE 0x0 #define IEEE802154_FCF_ADDR_RESERVED 0x1 #define IEEE802154_FCF_ADDR_SHORT 0x2 #define IEEE802154_FCF_ADDR_EXT 0x3 /* Header IE Fields */ #define IEEE802154_HEADER_IE_TYPE_MASK 0x8000 #define IEEE802154_HEADER_IE_ID_MASK 0x7F80 #define IEEE802154_HEADER_IE_LENGTH_MASK 0x007F /* Payload IE Fields */ #define IEEE802154_PAYLOAD_IE_TYPE_MASK 0x8000 #define IEEE802154_PAYLOAD_IE_ID_MASK 0x7800 #define IEEE802154_PAYLOAD_IE_LENGTH_MASK 0x07FF /* Payload (Nested) Sub IE Fields */ #define IEEE802154_PSIE_TYPE_MASK 0x8000 #define IEEE802154_PSIE_ID_MASK_SHORT 0x7F00 #define IEEE802154_PSIE_LENGTH_MASK_SHORT 0x00FF #define IEEE802154_PSIE_ID_MASK_LONG 0x7800 #define IEEE802154_PSIE_LENGTH_MASK_LONG 0x07FF /* Enhanced Beacon Filter IE */ #define IEEE802154_MLME_PSIE_EB_FLT_PJOIN 0x01 #define IEEE802154_MLME_PSIE_EB_FLT_LQI 0x02 #define IEEE802154_MLME_PSIE_EB_FLT_PERCENT 0x04 #define IEEE802154_MLME_PSIE_EB_FLT_ATTR_LEN 0x18 /* Vendor OUIs */ #define IEEE802154_VENDOR_OUI_ZIGBEE 0x4A191B /* Bit-masks for CC24xx style FCS */ #define IEEE802154_CC24xx_CORRELATION 0x7F00 #define IEEE802154_CC24xx_CRC_OK 0x8000 #define IEEE802154_CC24xx_RSSI 0x00FF /* Special IEEE802.15.4 Addresses */ #define IEEE802154_NO_ADDR16 0xFFFE #define IEEE802154_BCAST_ADDR 0xFFFF #define IEEE802154_BCAST_PAN 0xFFFF /* Bit mask for PHY length field */ #define IEEE802154_PHY_LENGTH_MASK 0x7F /* Auxiliary Security Header */ #define IEEE802154_AUX_SEC_LEVEL_MASK 0x07 /* Security Level */ #define IEEE802154_AUX_KEY_ID_MODE_MASK 0x18 /* Key Identifier Mode */ #define IEEE802154_AUX_KEY_ID_MODE_SHIFT 3 #define IEEE802154_AUX_KEY_RESERVED_MASK 0xE0 /* Reserved */ typedef enum { SECURITY_LEVEL_NONE = 0x00, SECURITY_LEVEL_MIC_32 = 0x01, SECURITY_LEVEL_MIC_64 = 0x02, SECURITY_LEVEL_MIC_128 = 0x03, SECURITY_LEVEL_ENC = 0x04, SECURITY_LEVEL_ENC_MIC_32 = 0x05, SECURITY_LEVEL_ENC_MIC_64 = 0x06, SECURITY_LEVEL_ENC_MIC_128 = 0x07 } ieee802154_security_level; typedef enum { KEY_ID_MODE_IMPLICIT = 0x00, KEY_ID_MODE_KEY_INDEX = 0x01, KEY_ID_MODE_KEY_EXPLICIT_4 = 0x02, KEY_ID_MODE_KEY_EXPLICIT_8 = 0x03 } ieee802154_key_id_mode; /* Header IE Element ID */ #define IEEE802154_HEADER_VENDOR_SPECIFIC 0x00 /* Reserved 0x01-0x19 */ #define IEEE802154_HEADER_IE_CSL 0x1a #define IEEE802154_HEADER_IE_RIT 0x1b #define IEEE802154_HEADER_IE_DSME_PAN 0x1c #define IEEE802154_HEADER_IE_RENDEZVOUS 0x1d #define IEEE802154_HEADER_IE_TIME_CORR 0x1e /* Reserved 0x1f-0x20 */ #define IEEE802154_HEADER_IE_EXT_DSME_PAN 0x21 #define IEEE802154_HEADER_IE_FSCD 0x22 #define IEEE802154_HEADER_IE_SMPL_SUPER_FRM 0x23 #define IEEE802154_HEADER_IE_SMPL_GTS 0x24 #define IEEE802154_HEADER_IE_LECIM 0x25 #define IEEE802154_HEADER_IE_TRLE 0x26 #define IEEE802154_HEADER_IE_RCC_CAP 0x27 #define IEEE802154_HEADER_IE_RCCN 0x28 #define IEEE802154_HEADER_IE_GLOBAL_TIME 0x29 /* Assigned to External Organization: 0x2a */ #define IEEE802154_HEADER_IE_DA_IE 0x2b /* Reserved 0x2c-0x7d */ #define IEEE802154_HEADER_IE_EID_TERM1 0x7e #define IEEE802154_HEADER_IE_EID_TERM2 0x7f /* Reserved 0x80-0xff */ /* Payload IE Group ID */ #define IEEE802154_PAYLOAD_IE_ESDU 0x0 /* Encapsulated Service Data Unit */ #define IEEE802154_PAYLOAD_IE_MLME 0x1 /* Media Access Control (MAC) subLayer Management Entity */ #define IEEE802154_PAYLOAD_IE_VENDOR 0x2 /* Vendor Specific */ /*For the Plugtest - Paris 2016, 6top group ID took the reserved value 0x3*/ #define IEEE802154_PAYLOAD_IE_IETF 0x3 /* Reserved 0x3-0xe */ #define IEEE802154_PAYLOAD_IE_GID_TERM 0xf /* Payload IE (Nested) Sub ID */ /* Payload IE (Nested) Sub ID - long format */ /* 0x0 - 0x7 Reserved */ /* 0x0 - 0x8 Vendor Specific */ #define IEEE802154_MLME_SUBIE_CHANNEL_HOPPING 0x9 /* 0xa - 0xf Reserved */ /* 0x10 - 0x19 Short Format Reserved */ #define IEEE802154_MLME_SUBIE_TSCH_SYNCH 0x1A #define IEEE802154_MLME_SUBIE_TSCH_SLOTFR_LINK 0x1B #define IEEE802154_MLME_SUBIE_TSCH_TIMESLOT 0x1C #define IEEE802154_MLME_SUBIE_HOPPING_TIMING 0x1D #define IEEE802154_MLME_SUBIE_ENHANCED_BEACON_FILTER 0x1E #define IEEE802154_MLME_SUBIE_MAC_METRICS 0x1F #define IEEE802154_MLME_SUBIE_ALL_MAC_METRICS 0x20 #define IEEE802154_MLME_SUBIE_COEXISTENCE_SPEC 0x21 #define IEEE802154_MLME_SUBIE_SUN_DEVICE_CAPABILITIES 0x22 #define IEEE802154_MLME_SUBIE_SUN_FSK_GEN_PHY 0x23 #define IEEE802154_MLME_SUBIE_MODE_SWITCH_PARAMETER 0x24 #define IEEE802154_MLME_SUBIE_PHY_PARAMETER_CHANGE 0x25 #define IEEE802154_MLME_SUBIE_O_QPSK_PHY_MODE 0x26 #define IEEE802154_MLME_SUBIE_PCA_ALLOCATION 0x27 #define IEEE802154_MLME_SUBIE_DSSS_OPER_MODE 0x28 #define IEEE802154_MLME_SUBIE_FSK_OPER_MODE 0x29 #define IEEE802154_MLME_SUBIE_TVWS_PHY_OPE_MODE 0x2B #define IEEE802154_MLME_SUBIE_TVWS_DEVICE_CAPAB 0x2C #define IEEE802154_MLME_SUBIE_TVWS_DEVICE_CATEG 0x2D #define IEEE802154_MLME_SUBIE_TVWS_DEVICE_IDENTIF 0x2E #define IEEE802154_MLME_SUBIE_TVWS_DEVICE_LOCATION 0x2F #define IEEE802154_MLME_SUBIE_TVWS_CH_INFOR_QUERY 0x30 #define IEEE802154_MLME_SUBIE_TVWS_CH_INFOR_SOURCE 0x31 #define IEEE802154_MLME_SUBIE_CTM 0x32 #define IEEE802154_MLME_SUBIE_TIMESTAMP 0x33 #define IEEE802154_MLME_SUBIE_TIMESTAMP_DIFF 0x34 #define IEEE802154_MLME_SUBIE_TMCP_SPECIFICATION 0x35 #define IEEE802154_MLME_SUBIE_RCC_PHY_OPER_MODE 0x36 /* 0x37-0x7f Reserved */ /* IETF IE - Sub IE */ #define IEEE802154_IETF_SUBIE_6TOP 0x00 /* not formally assigned yet */ /* IEEE 802.15.4 cipher block size. */ #define IEEE802154_CIPHER_SIZE 16 /* Macro to compute the MIC length. */ #define IEEE802154_MIC_LENGTH(_level_) ((0x2 << ((_level_) & 0x3)) & ~0x3) /* Macro to check for payload encryption. */ #define IEEE802154_IS_ENCRYPTED(_level_) ((_level_) & 0x4) /*SIXTOP Bit-mask*/ #define IETF_6TOP_VERSION 0x0F #define IETF_6TOP_TYPE 0x30 #define IETF_6TOP_FLAGS_RESERVED 0xC0 #define IETF_6TOP_SEQNUM 0x0F #define IETF_6TOP_GAB 0x30 #define IETF_6TOP_GBA 0xC0 /* SIXTOP CMD and RC identifiers */ #define IETF_6TOP_CMD_ADD 0x01 #define IETF_6TOP_CMD_DELETE 0x02 #define IETF_6TOP_CMD_STATUS 0x03 #define IETF_6TOP_CMD_LIST 0x04 #define IETF_6TOP_CMD_CLEAR 0x05 #define IETF_6TOP_RC_SUCCESS 0x06 #define IETF_6TOP_RC_ERR_VER 0x07 #define IETF_6TOP_RC_ERR_SFID 0x08 #define IETF_6TOP_RC_ERR_GEN 0x09 #define IETF_6TOP_RC_ERR_BUSY 0x0A #define IETF_6TOP_RC_ERR_NORES 0x0B #define IETF_6TOP_RC_ERR_RESET 0x0C #define IETF_6TOP_RC_ERR 0x0D /* SIXTOP Message Types */ #define IETF_6TOP_TYPE_REQUEST 0x00 #define IETF_6TOP_TYPE_RESPONSE 0x01 #define IETF_6TOP_TYPE_CONFIRMATION 0x02 #define IETF_6TOP_TYPE_RESERVED 0x03 /* SIXTOP Cell Options */ #define IETF_6TOP_CELL_OPTION_TX 0x01 #define IETF_6TOP_CELL_OPTION_RX 0x02 #define IETF_6TOP_CELL_OPTION_SHARED 0x04 #define IETF_6TOP_CELL_OPTION_RESERVED 0xF8 /* Structure containing information regarding all necessary packet fields. */ typedef struct { /* Frame control field. */ gint32 version; gint32 frame_type; gint32 dst_addr_mode; gint32 src_addr_mode; gboolean security_enable; gboolean frame_pending; gboolean ack_request; gboolean pan_id_compression; gboolean seqno_suppression; gboolean ie_present; guint8 seqno; /* determined during processing of Header IE*/ gboolean payload_ie_present; /* Addressing Info. */ guint16 dst_pan; guint16 src_pan; guint16 dst16; guint64 dst64; guint16 src16; guint64 src64; /* Security Info. */ ieee802154_security_level security_level; ieee802154_key_id_mode key_id_mode; guint32 frame_counter; guint8 key_sequence_counter; /* Only for 802.15.4-2003 security suite with encryption */ union { guint32 addr32; guint64 addr64; } key_source; guint8 key_index; /* Command ID (only if frame_type == 0x3) */ guint8 command_id; GHashTable *short_table; } ieee802154_packet; /* Structure for two-way mapping table */ typedef struct { GHashTable *long_table; GHashTable *short_table; } ieee802154_map_tab_t; /* Key used by the short address hash table. */ typedef struct { guint16 pan; guint16 addr; } ieee802154_short_addr; /* Key used by the long address hash table. */ typedef struct { guint64 addr; } ieee802154_long_addr; /* A mapping record for a frame, pointed to by hash table */ typedef struct { const char *proto; /* name of protocol that created this record */ guint start_fnum; guint end_fnum; guint64 addr64; /*guint32 frame_counter; TODO for frame counter sequence checks. */ } ieee802154_map_rec; #define IEEE802154_USER_MAPPING 0 typedef struct { guint16 src_pan; guint16 src16; guint16 dst16; ieee802154_map_rec *map_rec; } ieee802154_hints_t; /* */ void dissect_ieee802154_superframe (tvbuff_t *, packet_info *, proto_tree *, guint *); void dissect_ieee802154_gtsinfo (tvbuff_t *, packet_info *, proto_tree *, guint *); void dissect_ieee802154_pendaddr (tvbuff_t *, packet_info *, proto_tree *, guint *); /* Short to Extended Address Prototypes */ extern ieee802154_map_rec *ieee802154_addr_update(ieee802154_map_tab_t *, guint16, guint16, guint64, const char *, guint); extern guint ieee802154_short_addr_hash(gconstpointer); extern guint ieee802154_long_addr_hash(gconstpointer key); extern gboolean ieee802154_short_addr_equal(gconstpointer, gconstpointer); extern gboolean ieee802154_long_addr_equal(gconstpointer a, gconstpointer b); extern gboolean ieee802154_short_addr_invalidate(guint16, guint16, guint); extern gboolean ieee802154_long_addr_invalidate(guint64, guint); #endif /* PACKET_IEEE802154_H */