Wireshark  4.3.0
The Wireshark network protocol analyzer
packet-ieee802154.h
1 /* packet-ieee802154.h
2  *
3  * IEEE 802.15.4 Dissectors for Wireshark
4  * By Owen Kirby <osk@exegin.com>
5  * Copyright 2007 Exegin Technologies Limited
6  *
7  * Wireshark - Network traffic analyzer
8  * By Gerald Combs <gerald@wireshark.org>
9  * Copyright 1998 Gerald Combs
10  *
11  * SPDX-License-Identifier: GPL-2.0-or-later
12  */
13 #ifndef PACKET_IEEE802154_H
14 #define PACKET_IEEE802154_H
15 
16 /* Protocol Abbreviation */
17 #define IEEE802154_PROTOABBREV_WPAN "wpan"
18 #define IEEE802154_PROTOABBREV_WPAN_BEACON "wpan.beacon"
19 /* PANID dissector list is for Decode-As and stateful dissection only. */
20 #define IEEE802154_PROTOABBREV_WPAN_PANID "wpan.panid"
21 
22 /* Dissector tables */
23 #define IEEE802154_HEADER_IE_DTABLE "wpan.header_ie"
24 #define IEEE802154_PAYLOAD_IE_DTABLE "wpan.payload_ie"
25 #define IEEE802154_MLME_IE_DTABLE "wpan.mlme_ie"
26 #define IEEE802154_CMD_VENDOR_DTABLE "wpan.cmd.vendor"
27 
28 /* Packet Overhead from MAC header + footer (excluding addressing) */
29 #define IEEE802154_MAX_FRAME_LEN 127
30 #define IEEE802154_FCS_LEN 2
31 
32 /* Command Frame Identifier Types Definitions */
33 #define IEEE802154_CMD_ASSOC_REQ 0x01
34 #define IEEE802154_CMD_ASSOC_RSP 0x02
35 #define IEEE802154_CMD_DISASSOC_NOTIFY 0x03
36 #define IEEE802154_CMD_DATA_RQ 0x04
37 #define IEEE802154_CMD_PANID_CONFLICT 0x05
38 #define IEEE802154_CMD_ORPHAN_NOTIFY 0x06
39 #define IEEE802154_CMD_BEACON_REQ 0x07
40 #define IEEE802154_CMD_COORD_REALIGN 0x08
41 #define IEEE802154_CMD_GTS_REQ 0x09
42 #define IEEE802154_CMD_TRLE_MGMT_REQ 0x0a
43 #define IEEE802154_CMD_TRLE_MGMT_RSP 0x0b
44 /* 0x0c-0x12 reserved in IEEE802.15.4-2015 */
45 #define IEEE802154_CMD_DSME_ASSOC_REQ 0x13
46 #define IEEE802154_CMD_DSME_ASSOC_RSP 0x14
47 #define IEEE802154_CMD_DSME_GTS_REQ 0x15
48 #define IEEE802154_CMD_DSME_GTS_RSP 0x16
49 #define IEEE802154_CMD_DSME_GTS_NOTIFY 0x17
50 #define IEEE802154_CMD_DSME_INFO_REQ 0x18
51 #define IEEE802154_CMD_DSME_INFO_RSP 0x19
52 #define IEEE802154_CMD_DSME_BEACON_ALLOC_NOTIFY 0x1a
53 #define IEEE802154_CMD_DSME_BEACON_COLL_NOTIFY 0x1b
54 #define IEEE802154_CMD_DSME_LINK_REPORT 0x1c
55 /* 0x1d-0x1f reserved in IEEE802.15.4-2015 */
56 #define IEEE802154_CMD_RIT_DATA_REQ 0x20
57 #define IEEE802154_CMD_DBS_REQ 0x21
58 #define IEEE802154_CMD_DBS_RSP 0x22
59 #define IEEE802154_CMD_RIT_DATA_RSP 0x23
60 #define IEEE802154_CMD_VENDOR_SPECIFIC 0x24
61 /* 0x25-0xff reserved in IEEE802.15.4-2015 */
62 
63 /* Definitions for Association Response Command */
64 #define IEEE802154_CMD_ASRSP_AS_SUCCESS 0x00
65 #define IEEE802154_CMD_ASRSP_PAN_FULL 0x01
66 #define IEEE802154_CMD_ASRSP_PAN_DENIED 0x02
67 
68 /* Bit Masks for Capability Information Field
69  Included in Association Req. command */
70 #define IEEE802154_CMD_CINFO_ALT_PAN_COORD 0x01
71 #define IEEE802154_CMD_CINFO_DEVICE_TYPE 0x02
72 #define IEEE802154_CMD_CINFO_POWER_SRC 0x04
73 #define IEEE802154_CMD_CINFO_IDLE_RX 0x08
74 #define IEEE802154_CMD_CINFO_SEC_CAPABLE 0x40
75 #define IEEE802154_CMD_CINFO_ALLOC_ADDR 0x80
76 
77 #define IEEE802154_CMD_GTS_REQ_LEN 0x0F
78 #define IEEE802154_CMD_GTS_REQ_DIR 0x10
79 #define IEEE802154_CMD_GTS_REQ_TYPE 0x20
80 
81 /* Bit masks & shifts for various beacon fields */
82 #define IEEE802154_BEACON_ORDER_MASK 0x000F
83 #define IEEE802154_SUPERFRAME_ORDER_MASK 0x00F0
84 #define IEEE802154_SUPERFRAME_CAP_MASK 0x0F00
85 #define IEEE802154_BATT_EXTENSION_MASK 0x1000
86 #define IEEE802154_SUPERFRAME_COORD_MASK 0x4000
87 #define IEEE802154_ASSOC_PERMIT_MASK 0x8000
88 #define IEEE802154_SUPERFRAME_ORDER_SHIFT 4
89 #define IEEE802154_SUPERFRAME_CAP_SHIFT 8
90 
91 #define IEEE802154_GTS_COUNT_MASK 0x07
92 #define IEEE802154_GTS_PERMIT_MASK 0x80
93 #define IEEE802154_GTS_DIRECTION_SLOT(i) (0x01<<(i))
94 #define IEEE802154_GTS_MAX_SLOTS 7
95 #define IEEE802154_GTS_DIRECTION_SLOT1 0x01
96 #define IEEE802154_GTS_DIRECTION_SLOT2 0x02
97 #define IEEE802154_GTS_DIRECTION_SLOT3 0x04
98 #define IEEE802154_GTS_DIRECTION_SLOT4 0x08
99 #define IEEE802154_GTS_DIRECTION_SLOT5 0x10
100 #define IEEE802154_GTS_DIRECTION_SLOT6 0x20
101 #define IEEE802154_GTS_DIRECTION_SLOT7 0x40
102 #define IEEE802154_GTS_SLOT_MASK 0x0F
103 #define IEEE802154_GTS_LENGTH_MASK 0xF0
104 #define IEEE802154_GTS_LENGTH_SHIFT 4
105 
106 #define IEEE802154_PENDADDR_SHORT_MASK 0x07
107 #define IEEE802154_PENDADDR_LONG_MASK 0x70
108 #define IEEE802154_PENDADDR_LONG_SHIFT 4
109 
110 #define IEEE802154_SUPERFRAME_DURATION (IEEE802154_BASE_SLOT_DURATION * IEEE802154_SUPERFRAME_SLOTS)
111 #define IEEE802154_BASE_SLOT_DURATION 60
112 #define IEEE802154_SUPERFRAME_SLOTS 16
113 
114 /* Bit-masks for the FCF */
115 #define IEEE802154_FCF_TYPE_MASK 0x0007 /* Frame Type Mask */
116 #define IEEE802154_FCF_SEC_EN 0x0008
117 #define IEEE802154_FCF_FRAME_PND 0x0010
118 #define IEEE802154_FCF_ACK_REQ 0x0020
119 #define IEEE802154_FCF_PAN_ID_COMPRESSION 0x0040 /* known as Intra PAN prior to IEEE 802.15.4-2006 */
120 #define IEEE802154_FCF_SEQNO_SUPPRESSION 0x0100
121 #define IEEE802154_FCF_IE_PRESENT 0x0200
122 #define IEEE802154_FCF_DADDR_MASK 0x0C00 /* destination addressing mask */
123 #define IEEE802154_FCF_VERSION 0x3000
124 #define IEEE802154_FCF_SADDR_MASK 0xC000 /* source addressing mask */
125 
126 /* Bit-masks for the Multipurpose FCF */
127 #define IEEE802154_MPF_FCF_TYPE_MASK 0x0007
128 #define IEEE802154_MPF_FCF_LONG_FC 0x0008
129 #define IEEE802154_MPF_FCF_DADDR_MASK 0x0030
130 #define IEEE802154_MPF_FCF_SADDR_MASK 0x00C0
131 #define IEEE802154_MPF_FCF_PAN_ID_PRESENT 0x0100
132 #define IEEE802154_MPF_FCF_SEC_EN 0x0200
133 #define IEEE802154_MPF_FCF_SEQNO_SUPPRESSION 0x0400
134 #define IEEE802154_MPF_FCF_FRAME_PND 0x0800
135 #define IEEE802154_MPF_FCF_VERSION 0x3000
136 #define IEEE802154_MPF_FCF_ACK_REQ 0x4000
137 #define IEEE802154_MPF_FCF_IE_PRESENT 0x8000
138 
139 /* Frame Type Definitions */
140 #define IEEE802154_FCF_BEACON 0x0 /* Beacon Frame */
141 #define IEEE802154_FCF_DATA 0x1 /* Data Frame */
142 #define IEEE802154_FCF_ACK 0x2 /* Acknowlegement Frame */
143 #define IEEE802154_FCF_CMD 0x3 /* MAC Command Frame */
144 #define IEEE802154_FCF_RESERVED 0x4 /* reserved */
145 #define IEEE802154_FCF_MULTIPURPOSE 0x5 /* Multipurpose */
146 #define IEEE802154_FCF_FRAGMENT 0x6 /* Fragment or Frak */
147 #define IEEE802154_FCF_EXTENDED 0x7 /* Extended */
148 
149 /* Frame version definitions. */
150 #define IEEE802154_VERSION_2003 0x0
151 #define IEEE802154_VERSION_2006 0x1
152 #define IEEE802154_VERSION_2015 0x2
153 #define IEEE802154_VERSION_RESERVED 0x3
154 
155 /* Address Mode Definitions */
156 #define IEEE802154_FCF_ADDR_NONE 0x0
157 #define IEEE802154_FCF_ADDR_RESERVED 0x1
158 #define IEEE802154_FCF_ADDR_SHORT 0x2
159 #define IEEE802154_FCF_ADDR_EXT 0x3
160 
161 /* Header IE Fields */
162 #define IEEE802154_HEADER_IE_TYPE_MASK 0x8000
163 #define IEEE802154_HEADER_IE_ID_MASK 0x7F80
164 #define IEEE802154_HEADER_IE_LENGTH_MASK 0x007F
165 
166 /* Payload IE Fields */
167 #define IEEE802154_PAYLOAD_IE_TYPE_MASK 0x8000
168 #define IEEE802154_PAYLOAD_IE_ID_MASK 0x7800
169 #define IEEE802154_PAYLOAD_IE_LENGTH_MASK 0x07FF
170 
171 /* Payload (Nested) Sub IE Fields */
172 #define IEEE802154_PSIE_TYPE_MASK 0x8000
173 #define IEEE802154_PSIE_ID_MASK_SHORT 0x7F00
174 #define IEEE802154_PSIE_LENGTH_MASK_SHORT 0x00FF
175 #define IEEE802154_PSIE_ID_MASK_LONG 0x7800
176 #define IEEE802154_PSIE_LENGTH_MASK_LONG 0x07FF
177 
178 /* Enhanced Beacon Filter IE */
179 #define IEEE802154_MLME_PSIE_EB_FLT_PJOIN 0x01
180 #define IEEE802154_MLME_PSIE_EB_FLT_LQI 0x02
181 #define IEEE802154_MLME_PSIE_EB_FLT_PERCENT 0x04
182 #define IEEE802154_MLME_PSIE_EB_FLT_ATTR_LEN 0x18
183 
184 /* Vendor OUIs */
185 
186 /* Bit-masks for TI CC24xx end-of-packet metadata */
187 #define IEEE802154_CC24xx_CRC_OK 0x8000 /* 1 if CRC OK, 0 if not */
188 #define IEEE802154_CC24xx_CORRELATION 0x7F00 /* Some LQI stuff */
189 #define IEEE802154_CC24xx_RSSI 0x00FF /* Raw RSSI */
190 
191 /* Special IEEE802.15.4 Addresses */
192 #define IEEE802154_NO_ADDR16 0xFFFE
193 #define IEEE802154_BCAST_ADDR 0xFFFF
194 #define IEEE802154_BCAST_PAN 0xFFFF
195 
196 /* Bit mask for PHY length field */
197 #define IEEE802154_PHY_LENGTH_MASK 0x7F
198 
199 /* Auxiliary Security Header */
200 #define IEEE802154_AUX_SEC_LEVEL_MASK 0x07 /* Security Level */
201 #define IEEE802154_AUX_KEY_ID_MODE_MASK 0x18 /* Key Identifier Mode */
202 #define IEEE802154_AUX_KEY_ID_MODE_SHIFT 3
203 #define IEEE802154_AUX_FRAME_COUNTER_SUPPRESSION_MASK 0x20 /* 802.15.4-2015 */
204 #define IEEE802154_AUX_ASN_IN_NONCE_MASK 0x40 /* 802.15.4-2015 */
205 /* Note: 802.15.4-2015 specifies bits 6-7 as reserved, but 6 is used for ASN */
206 #define IEEE802154_AUX_CTRL_RESERVED_MASK 0x80 /* Reserved */
207 
208 /* Thread-specific well-known key support */
209 #define IEEE802154_THR_WELL_KNOWN_KEY_INDEX 0xff
210 #define IEEE802154_THR_WELL_KNOWN_KEY_SRC 0xffffffff
211 #define IEEE802154_THR_WELL_KNOWN_EXT_ADDR 0x3506feb823d48712ULL
212 
213 /* 802.15.4e LE-multipurpose Wake-up frame length */
214 #define IEEE802154E_LE_WUF_LEN 12
215 
216 typedef enum {
217  SECURITY_LEVEL_NONE = 0x00,
218  SECURITY_LEVEL_MIC_32 = 0x01,
219  SECURITY_LEVEL_MIC_64 = 0x02,
220  SECURITY_LEVEL_MIC_128 = 0x03,
221  SECURITY_LEVEL_ENC = 0x04,
222  SECURITY_LEVEL_ENC_MIC_32 = 0x05,
223  SECURITY_LEVEL_ENC_MIC_64 = 0x06,
224  SECURITY_LEVEL_ENC_MIC_128 = 0x07
225 } ieee802154_security_level;
226 
227 typedef enum {
228  KEY_ID_MODE_IMPLICIT = 0x00,
229  KEY_ID_MODE_KEY_INDEX = 0x01,
230  KEY_ID_MODE_KEY_EXPLICIT_4 = 0x02,
231  KEY_ID_MODE_KEY_EXPLICIT_8 = 0x03
232 } ieee802154_key_id_mode;
233 
234 typedef enum {
235  KEY_HASH_NONE = 0x00,
236  KEY_HASH_ZIP = 0x01,
237  KEY_HASH_THREAD = 0x02
238 } ieee802154_key_hash;
239 
240 /* Header IE Element ID */
241 #define IEEE802154_HEADER_IE_VENDOR_SPECIFIC 0x00
242 /* Reserved 0x01-0x19 */
243 #define IEEE802154_HEADER_IE_CSL 0x1a
244 #define IEEE802154_HEADER_IE_RIT 0x1b
245 #define IEEE802154_HEADER_IE_DSME_PAN 0x1c
246 #define IEEE802154_HEADER_IE_RENDEZVOUS 0x1d
247 #define IEEE802154_HEADER_IE_TIME_CORR 0x1e
248 /* Reserved 0x1f-0x20 */
249 #define IEEE802154_HEADER_IE_EXT_DSME_PAN 0x21
250 #define IEEE802154_HEADER_IE_FSCD 0x22
251 #define IEEE802154_HEADER_IE_SMPL_SUPER_FRM 0x23
252 #define IEEE802154_HEADER_IE_SMPL_GTS 0x24
253 #define IEEE802154_HEADER_IE_LECIM 0x25
254 #define IEEE802154_HEADER_IE_TRLE 0x26
255 #define IEEE802154_HEADER_IE_RCC_CAP 0x27
256 #define IEEE802154_HEADER_IE_RCCN 0x28
257 #define IEEE802154_HEADER_IE_GLOBAL_TIME 0x29
258 #define IEEE802154_HEADER_IE_WISUN 0x2a
259 #define IEEE802154_HEADER_IE_DA_IE 0x2b
260 /* Reserved 0x2c-0x7d */
261 #define IEEE802154_HEADER_IE_HT1 0x7e
262 #define IEEE802154_HEADER_IE_HT2 0x7f
263 /* Reserved 0x80-0xff */
264 
265 /* Payload IE Group ID */
266 #define IEEE802154_PAYLOAD_IE_ESDU 0x0 /* Encapsulated Service Data Unit */
267 #define IEEE802154_PAYLOAD_IE_MLME 0x1 /* Media Access Control (MAC) subLayer Management Entity */
268 #define IEEE802154_PAYLOAD_IE_VENDOR 0x2 /* Vendor Specific */
269 #define IEEE802154_PAYLOAD_IE_MPX 0x3 /* MPX IE (802.15.9) */
270 #define IEEE802154_PAYLOAD_IE_WISUN 0x4 /* Wi-SUN IE */
271 #define IEEE802154_PAYLOAD_IE_IETF 0x5 /* IETF IE, RFC 8137 */
272 /* Reserved 0x6-0xe */
273 #define IEEE802154_PAYLOAD_IE_TERMINATION 0xf
274 
275 /* Payload IE (Nested) Sub ID */
276 /* Payload IE (Nested) Sub ID - long format */
277 /* 0x0 - 0x7 Reserved */
278 /* 0x0 - 0x8 Vendor Specific */
279 #define IEEE802154_MLME_SUBIE_CHANNEL_HOPPING 0x9
280 /* 0xa - 0xf Reserved */
281 /* 0x10 - 0x19 Short Format Reserved */
282 #define IEEE802154_MLME_SUBIE_TSCH_SYNCH 0x1A
283 #define IEEE802154_MLME_SUBIE_TSCH_SLOTFR_LINK 0x1B
284 #define IEEE802154_MLME_SUBIE_TSCH_TIMESLOT 0x1C
285 #define IEEE802154_MLME_SUBIE_HOPPING_TIMING 0x1D
286 #define IEEE802154_MLME_SUBIE_ENHANCED_BEACON_FILTER 0x1E
287 #define IEEE802154_MLME_SUBIE_MAC_METRICS 0x1F
288 #define IEEE802154_MLME_SUBIE_ALL_MAC_METRICS 0x20
289 #define IEEE802154_MLME_SUBIE_COEXISTENCE_SPEC 0x21
290 #define IEEE802154_MLME_SUBIE_SUN_DEVICE_CAPABILITIES 0x22
291 #define IEEE802154_MLME_SUBIE_SUN_FSK_GEN_PHY 0x23
292 #define IEEE802154_MLME_SUBIE_MODE_SWITCH_PARAMETER 0x24
293 #define IEEE802154_MLME_SUBIE_PHY_PARAMETER_CHANGE 0x25
294 #define IEEE802154_MLME_SUBIE_O_QPSK_PHY_MODE 0x26
295 #define IEEE802154_MLME_SUBIE_PCA_ALLOCATION 0x27
296 #define IEEE802154_MLME_SUBIE_DSSS_OPER_MODE 0x28
297 #define IEEE802154_MLME_SUBIE_FSK_OPER_MODE 0x29
298 #define IEEE802154_MLME_SUBIE_TVWS_PHY_OPE_MODE 0x2B
299 #define IEEE802154_MLME_SUBIE_TVWS_DEVICE_CAPAB 0x2C
300 #define IEEE802154_MLME_SUBIE_TVWS_DEVICE_CATEG 0x2D
301 #define IEEE802154_MLME_SUBIE_TVWS_DEVICE_IDENTIF 0x2E
302 #define IEEE802154_MLME_SUBIE_TVWS_DEVICE_LOCATION 0x2F
303 #define IEEE802154_MLME_SUBIE_TVWS_CH_INFOR_QUERY 0x30
304 #define IEEE802154_MLME_SUBIE_TVWS_CH_INFOR_SOURCE 0x31
305 #define IEEE802154_MLME_SUBIE_CTM 0x32
306 #define IEEE802154_MLME_SUBIE_TIMESTAMP 0x33
307 #define IEEE802154_MLME_SUBIE_TIMESTAMP_DIFF 0x34
308 #define IEEE802154_MLME_SUBIE_TMCP_SPECIFICATION 0x35
309 #define IEEE802154_MLME_SUBIE_RCC_PHY_OPER_MODE 0x36
310 /* 0x37-0x7f Reserved */
311 
312 /* IETF IE - Sub IE */
313 #define IEEE802154_IETF_SUBIE_6TOP_DRAFT 0xC9 /* not formally assigned yet */
314 #define IEEE802154_IETF_SUBIE_6TOP 0x01 /* not formally assigned yet */
315 
316 /* IEEE 802.15.4 cipher block size. */
317 #define IEEE802154_CIPHER_SIZE 16
318 
319 /* IEEE 802.15 CID */
320 #define IEEE80215_CID 0xBA55ECULL
321 
322 /* Macro to compute the MIC length. */
323 #define IEEE802154_MIC_LENGTH(_level_) ((0x2 << ((_level_) & 0x3)) & ~0x3)
324 /* Macro to check for payload encryption. */
325 #define IEEE802154_IS_ENCRYPTED(_level_) ((_level_) & 0x4)
326 
327 /*SIXTOP Bit-mask*/
328 #define IETF_6TOP_VERSION 0x0F
329 #define IETF_6TOP_TYPE 0x30
330 #define IETF_6TOP_FLAGS_RESERVED 0xC0
331 #define IETF_6TOP_SEQNUM 0xFF
332 
333 /* SIXTOP CMD and RC identifiers */
334 #define IETF_6TOP_CMD_ADD 0x01
335 #define IETF_6TOP_CMD_DELETE 0x02
336 #define IETF_6TOP_CMD_RELOCATE 0x03
337 #define IETF_6TOP_CMD_COUNT 0x04
338 #define IETF_6TOP_CMD_LIST 0x05
339 #define IETF_6TOP_CMD_SIGNAL 0x06
340 #define IETF_6TOP_CMD_CLEAR 0x07
341 #define IETF_6TOP_RC_SUCCESS 0x00
342 #define IETF_6TOP_RC_EOL 0x01
343 #define IETF_6TOP_RC_ERR 0x02
344 #define IETF_6TOP_RC_RESET 0x03
345 #define IETF_6TOP_RC_ERR_VERSION 0x04
346 #define IETF_6TOP_RC_ERR_SFID 0x05
347 #define IETF_6TOP_RC_ERR_SEQNUM 0x06
348 #define IETF_6TOP_RC_ERR_CELLLIST 0x07
349 #define IETF_6TOP_RC_ERR_BUSY 0x08
350 #define IETF_6TOP_RC_ERR_LOCKED 0x09
351 
352 /* SIXTOP Message Types */
353 #define IETF_6TOP_TYPE_REQUEST 0x00
354 #define IETF_6TOP_TYPE_RESPONSE 0x01
355 #define IETF_6TOP_TYPE_CONFIRMATION 0x02
356 #define IETF_6TOP_TYPE_RESERVED 0x03
357 
358 /* SIXTOP Cell Options */
359 #define IETF_6TOP_CELL_OPTION_TX 0x01
360 #define IETF_6TOP_CELL_OPTION_RX 0x02
361 #define IETF_6TOP_CELL_OPTION_SHARED 0x04
362 #define IETF_6TOP_CELL_OPTION_RESERVED 0xF8
363 
364 /* IEEE 802.15.9 MPX IE */
365 #define IEEE802159_MPX_TRANSFER_TYPE_MASK 0x07
366 #define IEEE802159_MPX_TRANSACTION_ID_MASK 0xf8
367 #define IEEE802159_MPX_TRANSACTION_ID_SHIFT 0x03
368 /* IEEE 802.15.9 Table 19 */
369 #define IEEE802159_MPX_FULL_FRAME 0
370 #define IEEE802159_MPX_FULL_FRAME_NO_MUXID 1
371 #define IEEE802159_MPX_NON_LAST_FRAGMENT 2
372 #define IEEE802159_MPX_LAST_FRAGMENT 4
373 #define IEEE802159_MPX_ABORT 6
374 /* IEEE 802.15.9 Table 20 */
375 #define IEEE802159_MPX_MULTIPLEX_ID_KMP 1
376 #define IEEE802159_MPX_MULTIPLEX_ID_WISUN 2
377 /* IEEE 802.15.9 Table 21 */
378 #define IEEE802159_MPX_KMP_ID_IEEE8021X 1
379 #define IEEE802159_MPX_KMP_ID_HIP 2
380 #define IEEE802159_MPX_KMP_ID_IKEV2 3
381 #define IEEE802159_MPX_KMP_ID_PANA 4
382 #define IEEE802159_MPX_KMP_ID_DRAGONFLY 5
383 #define IEEE802159_MPX_KMP_ID_IEEE80211_4WH 6
384 #define IEEE802159_MPX_KMP_ID_IEEE80211_GKH 7
385 #define IEEE802159_MPX_KMP_ID_ETSI_TS_102_887_2 8
386 #define IEEE802159_MPX_KMP_ID_VENDOR_SPECIFIC 255
387 /* Wi-SUN MPX Sub-ID values. */
388 #define IEEE802159_MPX_WISUN_SUBID_MHDS 0
389 #define IEEE802159_MPX_WISUN_SUBID_6LOWPAN 1
390 #define IEEE802159_MPX_WISUN_SUBID_SECURITY 2
391 
392 /* Structure containing information regarding all necessary packet fields. */
393 typedef struct {
394  /* Frame control field. */
395  gint32 version;
396  gint32 frame_type;
397  gint32 dst_addr_mode;
398  gint32 src_addr_mode;
399  gboolean security_enable;
400  gboolean frame_pending;
401  gboolean ack_request;
402  gboolean pan_id_compression;
403  gboolean seqno_suppression;
404  gboolean ie_present;
405 
406  /* Fields exclusive to the 802.15.4-2015 multipurpose frame control field */
407  gboolean long_frame_control;
408  gboolean pan_id_present;
409 
410  guint8 seqno;
411  /* Determined during processing of Header IE*/
412  gboolean payload_ie_present;
413  /* Addressing Info. */
414  gboolean dst_pan_present;
415  gboolean src_pan_present;
416  guint16 dst_pan;
417  guint16 src_pan;
418  guint16 dst16;
419  guint64 dst64;
420  guint16 src16;
421  guint64 src64;
422 
423  /* Security Info. */
424  ieee802154_security_level security_level;
425  ieee802154_key_id_mode key_id_mode;
426  gboolean frame_counter_suppression; /* 802.15.4-2015 */
427  guint32 frame_counter;
428  guint8 key_sequence_counter; /* Only for 802.15.4-2003 security suite with encryption */
429  guint64 asn;
430 
431  union {
432  guint32 addr32;
433  guint64 addr64;
434  } key_source;
435  guint8 key_index;
436 
437  /* Command ID (only if frame_type == 0x3) */
438  guint8 command_id;
439  GHashTable *short_table;
441 
442 /* Structure for two-way mapping table */
443 typedef struct {
444  GHashTable *long_table;
445  GHashTable *short_table;
447 
448 /* Key used by the short address hash table. */
449 typedef struct {
450  guint16 pan;
451  guint16 addr;
453 
454 /* Key used by the long address hash table. */
455 typedef struct {
456  guint64 addr;
458 
459 /* A mapping record for a frame, pointed to by hash table */
460 typedef struct {
461  const char *proto; /* name of protocol that created this record */
462  guint start_fnum;
463  guint end_fnum;
464  guint64 addr64;
465  /*guint32 frame_counter; TODO for frame counter sequence checks. */
467 
468 #define IEEE802154_USER_MAPPING 0
469 
470 typedef struct {
471  guint16 src_pan;
472  guint16 src16;
473  guint16 dst16;
474  ieee802154_map_rec *map_rec;
475  void *packet;
477 
478 typedef enum {
479  DECRYPT_PACKET_SUCCEEDED,
480  DECRYPT_NOT_ENCRYPTED,
481  DECRYPT_FRAME_COUNTER_SUPPRESSION_UNSUPPORTED,
482  DECRYPT_PACKET_TOO_SMALL,
483  DECRYPT_PACKET_NO_EXT_SRC_ADDR,
484  DECRYPT_PACKET_NO_KEY,
485  DECRYPT_PACKET_DECRYPT_FAILED,
486  DECRYPT_PACKET_MIC_CHECK_FAILED
487 } ieee802154_decrypt_status;
488 
489 /* UAT key structure. */
490 typedef struct {
491  gchar *pref_key;
492  guint key_index;
493  ieee802154_key_hash hash_type;
494  guint8 key[IEEE802154_CIPHER_SIZE];
495  guint8 mle_key[IEEE802154_CIPHER_SIZE];
497 
498 /* */
499 void dissect_ieee802154_superframe (tvbuff_t *, packet_info *, proto_tree *, guint *);
500 void dissect_ieee802154_gtsinfo (tvbuff_t *, packet_info *, proto_tree *, guint *);
501 void dissect_ieee802154_pendaddr (tvbuff_t *, packet_info *, proto_tree *, guint *);
502 void dissect_ieee802154_aux_sec_header_and_key(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, ieee802154_packet *packet, guint *offset);
503 void ccm_init_block(gchar *block, gboolean adata, gint M, guint64 addr, guint32 frame_counter, guint8 level, gint ctr_val, const gchar *generic_nonce);
504 gboolean ccm_ctr_encrypt(const gchar *key, const gchar *iv, gchar *mic, gchar *data, gint length);
505 gboolean ccm_cbc_mac(const gchar *key, const gchar *iv, const gchar *a, gint a_len, const gchar *m, gint m_len, gchar *mic);
506 
507 proto_tree *ieee802154_create_hie_tree(tvbuff_t *tvb, proto_tree *tree, int hf, gint ett);
508 proto_tree *ieee802154_create_pie_tree(tvbuff_t *tvb, proto_tree *tree, int hf, gint ett);
509 
510 
512 #define IEEE802154_DISSECT_HEADER_OPTION_NO_AUX_SEC_HDR (1 << 1)
523 guint ieee802154_dissect_header(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint options, proto_tree **created_header_tree, ieee802154_packet **parsed_info);
524 
536 tvbuff_t* ieee802154_decrypt_payload(tvbuff_t *tvb, guint mhr_len, packet_info *pinfo, proto_tree *ieee802154_tree, ieee802154_packet *packet);
537 
546 guint ieee802154_dissect_payload_ies(tvbuff_t *tvb, packet_info *pinfo, proto_tree *ieee802154_tree, ieee802154_packet *packet);
547 
557 guint ieee802154_dissect_frame_payload(tvbuff_t *tvb, packet_info *pinfo, proto_tree *ieee802154_tree, ieee802154_packet *packet, gboolean fcs_ok);
558 
559 
560 /* Results for the decryption */
561 typedef struct {
562  /* Set by decrypt_ieee802154_payload */
563  unsigned char *key; // not valid after return of decrypt_ieee802154_payload
564  guint key_number;
565  /* Set by the ieee802154_decrypt_func */
566  unsigned char* rx_mic;
567  guint* rx_mic_length;
568  guint aux_offset;
569  guint aux_length;
570  ieee802154_decrypt_status* status;
572 
575 typedef guint (*ieee802154_set_key_func) (ieee802154_packet *packet, unsigned char *key, unsigned char *alt_key, ieee802154_key_t *uat_key);
577 typedef tvbuff_t* (*ieee802154_decrypt_func) (tvbuff_t *, guint, packet_info *, ieee802154_packet *, ieee802154_decrypt_info_t*);
581 tvbuff_t *decrypt_ieee802154_payload(tvbuff_t *tvb, guint offset, packet_info *pinfo, proto_tree *key_tree, ieee802154_packet *packet,
582  ieee802154_decrypt_info_t *decrypt_info, ieee802154_set_key_func set_key_func, ieee802154_decrypt_func decrypt_func);
583 
584 
585 extern void register_ieee802154_mac_key_hash_handler(guint hash_identifier, ieee802154_set_key_func key_func);
586 
587 /* Short to Extended Address Prototypes */
588 extern ieee802154_map_rec *ieee802154_addr_update(ieee802154_map_tab_t *, guint16, guint16, guint64,
589  const char *, guint);
590 extern guint ieee802154_short_addr_hash(gconstpointer);
591 extern guint ieee802154_long_addr_hash(gconstpointer key);
592 extern gboolean ieee802154_short_addr_equal(gconstpointer, gconstpointer);
593 extern gboolean ieee802154_long_addr_equal(gconstpointer a, gconstpointer b);
594 
595 extern gboolean ieee802154_short_addr_invalidate(guint16, guint16, guint);
596 extern gboolean ieee802154_long_addr_invalidate(guint64, guint);
597 
598 extern ieee802154_map_tab_t ieee802154_map;
599 
600 extern const value_string ieee802154_mpx_kmp_id_vals[];
601 extern const value_string zboss_page_names[];
602 
603 extern guint ieee802154_fcs_len;
604 
605 #endif /* PACKET_IEEE802154_H */
Definition: packet_info.h:44
Definition: proto.h:897
Definition: value_string.h:26
Definition: packet-ieee802154.h:561
Definition: packet-ieee802154.h:470
Definition: packet-ieee802154.h:490
Definition: packet-ieee802154.h:455
Definition: packet-ieee802154.h:460
Definition: packet-ieee802154.h:443
Definition: packet-ieee802154.h:393
Definition: packet-ieee802154.h:449
Definition: tvbuff-int.h:35