forked from openwsn-berkeley/dissectors
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathpacket-ieee802154.h
392 lines (340 loc) · 15.8 KB
/
packet-ieee802154.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
/* packet-ieee802154.h
*
* IEEE 802.15.4 Dissectors for Wireshark
* By Owen Kirby <osk@exegin.com>
* Copyright 2007 Exegin Technologies Limited
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* IEEE 802.15.4 - TSCH options implemented
* By Jonathan Munoz <jmmunoz86@gmail.com>
*
* 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
#define IEEE802154_FCF_LEN 2
/* Command Frame Identifier Types Definions */
#define IEEE802154_CMD_ASRQ 0x01
#define IEEE802154_CMD_ASRSP 0x02
#define IEEE802154_CMD_DISAS 0x03
#define IEEE802154_CMD_DATA_RQ 0x04
#define IEEE802154_CMD_PANID_ERR 0x05
#define IEEE802154_CMD_ORPH_NOTIF 0x06
#define IEEE802154_CMD_BCN_RQ 0x07
#define IEEE802154_CMD_COORD_REAL 0x08
#define IEEE802154_CMD_GTS_REQ 0x09
#define IEEE802145_CMD_TRLE_MNGMT_REQ 0x0A
#define IEEE802145_CMD_TRLE_MNGMT_RESP 0x0B
#define IEEE802145_CMD_DSME_ASSOC_REQ 0x13
#define IEEE802145_CMD_DSME_ASSOC_RESP 0x14
#define IEEE802145_CMD_DSME_GTS_ASSOC_REQ 0x15
#define IEEE802145_CMD_DSME_GTS_ASSOC_RESP 0x16
#define IEEE802145_CMD_DSME_GTS_NOTIFY 0x17
#define IEEE802145_CMD_DSME_INF_REQ 0x18
#define IEEE802145_CMD_DSME_INF_RESP 0x19
#define IEEE802145_CMD_DSME_BEACON_ALL_NOT 0x1A
#define IEEE802145_CMD_DSME_BEACON_COLL_NOT 0x1B
#define IEEE802145_CMD_DSME_LINK_REPORT 0x1C
#define IEEE802145_CMD_RIT_DATA_REQ 0x20
#define IEEE802145_CMD_DBS_REQ 0x21
#define IEEE802145_CMD_DBS_RESP 0x22
/* MODIFIED JMMS */
#define IEEE802145_CMD_MAX_ID 0x09
/* 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_INTRA_PAN 0x0040 /* known as PAN ID Compression in IEEE 802.15.4-2006 */
#define IEEE802154_FCF_SEQNR_SUPPR 0x0100 /* Sequence number suppression */ /* according to 2015 spec. */
#define IEEE802154_FCF_IELIST_PRESENT 0x0200 /* if Information Elements inside the frame*/ /* according to 2015 spec. */
#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 0x0000 /* Beacon Frame */
#define IEEE802154_FCF_DATA 0x0001 /* Data Frame */
#define IEEE802154_FCF_ACK 0x0002 /* Acknowlegement Frame */
#define IEEE802154_FCF_CMD 0x0003 /* Command Frame */
#define IEEE802154_FCF_RESERVED 0x0004 /* Reserved */
#define IEEE802154_FCF_MULTIPURPOSE 0x0005 /* Multipurpose frame */ /* according to 2015 spec. */
#define IEEE802154_FCF_FRAGMENT_FRAG 0x0006 /* Fragment or Frak frame */ /* according to 2015 spec. */
#define IEEE802154_FCF_EXTENDED 0x0007 /* Extended frame */ /* according to 2015 spec. */
/* Frame version definitions. */
#define IEEE802154_VERSION_2003 0x0
#define IEEE802154_VERSION_2006 0x1
#define IEEE802154_VERSION_2015 0x2
/* Address Mode Definitions */
#define IEEE802154_FCF_ADDR_NONE 0x0000
#define IEEE802154_FCF_ADDR_SHORT 0x0002
#define IEEE802154_FCF_ADDR_EXT 0x0003
/* 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 */
/* Header Information Elements' list */ /* according to 2015 spec. */
#define IEEE802154_H_IE_DA_IE_VENDOR_SPECIFIC_HEADER 0x00
#define IEEE802154_H_IE_DA 0x19
#define IEEE802154_H_IE_CSL 0x1A
#define IEEE802154_H_IE_RIT 0x1B
#define IEEE802154_H_IE_DSME_PAN_DESC 0x1C
#define IEEE802154_H_IE_RDV_TIME 0x1D
#define IEEE802154_H_IE_TIME_CORRECTION 0x1E
#define IEEE802154_H_IE_EXT_DSME_PAN_DESC 0x21
#define IEEE802154_H_IE_FSCD 0x22
#define IEEE802154_H_IE_SIMPL_SF_SPEC 0x23
#define IEEE802154_H_IE_SIMPL_GTS 0x24
#define IEEE802154_H_IE_LECIM_CAPAB 0x25
#define IEEE802154_H_IE_TRLE_DESC 0x26
#define IEEE802154_H_IE_RCC_CAPAB 0x27
#define IEEE802154_H_IE_RCCN_DESC 0x28
#define IEEE802154_H_IE_GLOBAL_TIME 0x29
#define IEEE802154_H_IE_HDR_TERM_1 0x7E
#define IEEE802154_H_IE_HDR_TERM_2 0x7F
/* Payload Information Elements' list */ /* according to 2015 spec. */
#define IEEE802154_P_IE_ESDU 0x00
#define IEEE802154_P_IE_MLME 0x01
#define IEEE802154_P_IE_VENDOR_SPECIFIC 0x02
#define IEEE802154_P_IE_PAYLOAD_TERM 0x0F
/* MLME IE Short Sub-list */
#define IEEE802154_P_IE_TSCH_SYNC_SH 0x1A
#define IEEE802154_P_IE_TSCH_SLOTFR_LINK_SH 0x1B
#define IEEE802154_P_IE_TSCH_TIMESLOT_SH 0x1C
#define IEEE802154_P_IE_HOPPING_TIMING_SH 0x1D
#define IEEE802154_P_IE_ENHACED_BEACON_FILTER_SH 0x1E
#define IEEE802154_P_IE_MAC_METRICS_SH 0x1F
#define IEEE802154_P_IE_ALL_MAC_METRICS_SH 0x20
#define IEEE802154_P_IE_COEXISTENCE_SPEC_SH 0x21
#define IEEE802154_P_IE_SUN_DEVICE_CAPABILITIES_SH 0x22
#define IEEE802154_P_IE_SUN_FSK_GEN_PHY_SH 0x23
#define IEEE802154_P_IE_MODE_SWITCH_PARAMETER_SH 0x24
#define IEEE802154_P_IE_PHY_PARAMETER_CHANGE_SH 0x25
#define IEEE802154_P_IE_O_QPSK_PHY_MODE_SH 0x26
#define IEEE802154_P_IE_PCA_ALLOCATION_SH 0x27
#define IEEE802154_P_IE_DSSS_OPER_MODE_SH 0x28
#define IEEE802154_P_IE_FSK_OPER_MODE_SH 0x29
#define IEEE802154_P_IE_TVWS_PHY_OPE_MODE_SH 0x2B
#define IEEE802154_P_IE_TVWS_DEVICE_CAPAB_SH 0x2C
#define IEEE802154_P_IE_TVWS_DEVICE_CATEG_SH 0x2D
#define IEEE802154_P_IE_TVWS_DEVICE_IDENTIF_SH 0x2E
#define IEEE802154_P_IE_TVWS_DEVICE_LOCATION_SH 0x2F
#define IEEE802154_P_IE_TVWS_CH_INFOR_QUERY_SH 0x30
#define IEEE802154_P_IE_TVWS_CH_INFOR_SOURCE_SH 0x31
#define IEEE802154_P_IE_CTM_SH 0x32
#define IEEE802154_P_IE_TIMESTAMP_SH 0x33
#define IEEE802154_P_IE_TIMESTAMP_DIFF_SH 0x34
#define IEEE802154_P_IE_TMCP_SPECIFICATION_SH 0x35
#define IEEE802154_P_IE_RCC_PHY_OPER_MODE_SH 0x36
/* MLME IE Long Sub-list */
#define IEEE802154_P_IE_VENDOR_SPECIFIC_LG 0x8
#define IEEE802154_P_IE_CHANNEL_HOPPING_LG 0x9
/* --------------------------------------------------------------------- */
/* Bit-mask for the Header Information's Elements header */
#define IEEE802154_H_IE_LENGTH 0x007F
#define IEEE802154_H_IE_ID 0x7F80
#define IEEE802154_H_IE_TYPE 0x8000
/* Bit-mask for the Payload Information's Elements header */
#define IEEE802154_P_IE_LENGTH 0x07FF
#define IEEE802154_P_IE_ID 0x7800
#define IEEE802154_P_IE_TYPE 0x8000
/* Bit-mask for the MLME Short Format of Nested IE */
#define IEEE802154_P_MLME_SHORT_LENGTH 0x00FF
#define IEEE802154_P_MLME_SHORT_ID 0x7F00
#define IEEE802154_P_MLME_TYPE 0x8000
/* Bit-mask for the MLME Long Format of Nested IE */
#define IEEE802154_P_MLME_LONG_LENGTH 0x07FF
#define IEEE802154_P_MLME_LONG_ID 0x7800
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;
/* 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)
/* 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 seqnr_suppresion;
gboolean ielist_present;
gboolean frame_pending;
gboolean ack_request;
gboolean intra_pan;
guint8 seqno;
/* 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 */
/* Header Information Elements' header */
guint8 h_ie_content_lenght;
guint8 h_ie_id;
gboolean h_ie_type;
gboolean p_ie_present;
/* Payload Information Elements' payload */
guint16 p_ie_content_lenght;
guint8 p_ie_id;
gboolean p_ie_type;
/* Payload MLME Information Elements*/
gboolean p_ie_mlme_present;
gboolean p_ie_mlme_type;
guint16 p_ie_mlme_sh_lenght;
guint8 p_ie_mlme_sh_id;
guint16 p_ie_mlme_lg_lenght;
guint8 p_ie_mlme_lg_id;
/* utilities */
guint16 keep_dissecting;
guint16 keep_dissecting_p_ie;
guint16 h_ie_size;
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;
/* 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 */