-
-
Notifications
You must be signed in to change notification settings - Fork 2k
/
zigbee.py
1183 lines (1080 loc) · 46.3 KB
/
zigbee.py
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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This program is published under a GPLv2 license
# This file is part of Scapy
# See http://www.secdev.org/projects/scapy for more information
# Copyright (C) Ryan Speers <ryan@rmspeers.com> 2011-2012
# Copyright (C) Roger Meyer <roger.meyer@csus.edu>: 2012-03-10 Added frames
# Copyright (C) Gabriel Potter <gabriel@potter.fr>: 2018
# Copyright (C) 2020 Dimitrios-Georgios Akestoridis <akestoridis@cmu.edu>
# This program is published under a GPLv2 license
"""
ZigBee bindings for IEEE 802.15.4.
"""
import struct
from scapy.compat import orb
from scapy.packet import bind_layers, bind_bottom_up, Packet
from scapy.fields import BitField, ByteField, XLEIntField, ConditionalField, \
ByteEnumField, EnumField, BitEnumField, FieldListField, FlagsField, \
IntField, PacketListField, ShortField, StrField, StrFixedLenField, \
StrLenField, XLEShortField, XStrField
from scapy.layers.dot15d4 import dot15d4AddressField, Dot15d4Beacon, Dot15d4, \
Dot15d4FCS
from scapy.layers.inet import UDP
from scapy.layers.ntp import TimeStampField
# ZigBee Cluster Library Identifiers, Table 2.2 ZCL
_zcl_cluster_identifier = {
# Functional Domain: General
0x0000: "basic",
0x0001: "power_configuration",
0x0002: "device_temperature_configuration",
0x0003: "identify",
0x0004: "groups",
0x0005: "scenes",
0x0006: "on_off",
0x0007: "on_off_switch_configuration",
0x0008: "level_control",
0x0009: "alarms",
0x000a: "time",
0x000b: "rssi_location",
0x000c: "analog_input",
0x000d: "analog_output",
0x000e: "analog_value",
0x000f: "binary_input",
0x0010: "binary_output",
0x0011: "binary_value",
0x0012: "multistate_input",
0x0013: "multistate_output",
0x0014: "multistate_value",
0x0015: "commissioning",
# 0x0016 - 0x00ff reserved
# Functional Domain: Closures
0x0100: "shade_configuration",
# 0x0101 - 0x01ff reserved
# Functional Domain: HVAC
0x0200: "pump_configuration_and_control",
0x0201: "thermostat",
0x0202: "fan_control",
0x0203: "dehumidification_control",
0x0204: "thermostat_user_interface_configuration",
# 0x0205 - 0x02ff reserved
# Functional Domain: Lighting
0x0300: "color_control",
0x0301: "ballast_configuration",
# Functional Domain: Measurement and sensing
0x0400: "illuminance_measurement",
0x0401: "illuminance_level_sensing",
0x0402: "temperature_measurement",
0x0403: "pressure_measurement",
0x0404: "flow_measurement",
0x0405: "relative_humidity_measurement",
0x0406: "occupancy_sensing",
# Functional Domain: Security and safethy
0x0500: "ias_zone",
0x0501: "ias_ace",
0x0502: "ias_wd",
# Functional Domain: Protocol Interfaces
0x0600: "generic_tunnel",
0x0601: "bacnet_protocol_tunnel",
0x0602: "analog_input_regular",
0x0603: "analog_input_extended",
0x0604: "analog_output_regular",
0x0605: "analog_output_extended",
0x0606: "analog_value_regular",
0x0607: "analog_value_extended",
0x0608: "binary_input_regular",
0x0609: "binary_input_extended",
0x060a: "binary_output_regular",
0x060b: "binary_output_extended",
0x060c: "binary_value_regular",
0x060d: "binary_value_extended",
0x060e: "multistate_input_regular",
0x060f: "multistate_input_extended",
0x0610: "multistate_output_regular",
0x0611: "multistate_output_extended",
0x0612: "multistate_value_regular",
0x0613: "multistate_value",
# Smart Energy Profile Clusters
0x0700: "price",
0x0701: "demand_response_and_load_control",
0x0702: "metering",
0x0703: "messaging",
0x0704: "smart_energy_tunneling",
0x0705: "prepayment",
# Functional Domain: General
# Key Establishment
0x0800: "key_establishment",
}
# ZigBee stack profiles
_zcl_profile_identifier = {
0x0000: "ZigBee_Stack_Profile_1",
0x0101: "IPM_Industrial_Plant_Monitoring",
0x0104: "HA_Home_Automation",
0x0105: "CBA_Commercial_Building_Automation",
0x0107: "TA_Telecom_Applications",
0x0108: "HC_Health_Care",
0x0109: "SE_Smart_Energy_Profile",
}
# ZigBee Cluster Library, Table 2.8 ZCL Command Frames
_zcl_command_frames = {
0x00: "read_attributes",
0x01: "read_attributes_response",
0x02: "write_attributes_response",
0x03: "write_attributes_undivided",
0x04: "write_attributes_response",
0x05: "write_attributes_no_response",
0x06: "configure_reporting",
0x07: "configure_reporting_response",
0x08: "read_reporting_configuration",
0x09: "read_reporting_configuration_response",
0x0a: "report_attributes",
0x0b: "default_response",
0x0c: "discover_attributes",
0x0d: "discover_attributes_response",
# 0x0e - 0xff Reserved
}
# ZigBee Cluster Library, Table 2.16 Enumerated Status Values
_zcl_enumerated_status_values = {
0x00: "SUCCESS",
0x02: "FAILURE",
# 0x02 - 0x7f Reserved
0x80: "MALFORMED_COMMAND",
0x81: "UNSUP_CLUSTER_COMMAND",
0x82: "UNSUP_GENERAL_COMMAND",
0x83: "UNSUP_MANUF_CLUSTER_COMMAND",
0x84: "UNSUP_MANUF_GENERAL_COMMAND",
0x85: "INVALID_FIELD",
0x86: "UNSUPPORTED_ATTRIBUTE",
0x87: "INVALID_VALUE",
0x88: "READ_ONLY",
0x89: "INSUFFICIENT_SPACE",
0x8a: "DUPLICATE_EXISTS",
0x8b: "NOT_FOUND",
0x8c: "UNREPORTABLE_ATTRIBUTE",
0x8d: "INVALID_DATA_TYPE",
# 0x8e - 0xbf Reserved
0xc0: "HARDWARE_FAILURE",
0xc1: "SOFTWARE_FAILURE",
0xc2: "CALIBRATION_ERROR",
# 0xc3 - 0xff Reserved
}
# ZigBee Cluster Library, Table 2.15 Data Types
_zcl_attribute_data_types = {
0x00: "no_data",
# General data
0x08: "8-bit_data",
0x09: "16-bit_data",
0x0a: "24-bit_data",
0x0b: "32-bit_data",
0x0c: "40-bit_data",
0x0d: "48-bit_data",
0x0e: "56-bit_data",
0x0f: "64-bit_data",
# Logical
0x10: "boolean",
# Bitmap
0x18: "8-bit_bitmap",
0x19: "16-bit_bitmap",
0x1a: "24-bit_bitmap",
0x1b: "32-bit_bitmap",
0x1c: "40-bit_bitmap",
0x1d: "48-bit_bitmap",
0x1e: "56-bit_bitmap",
0x1f: "64-bit_bitmap",
# Unsigned integer
0x20: "Unsigned_8-bit_integer",
0x21: "Unsigned_16-bit_integer",
0x22: "Unsigned_24-bit_integer",
0x23: "Unsigned_32-bit_integer",
0x24: "Unsigned_40-bit_integer",
0x25: "Unsigned_48-bit_integer",
0x26: "Unsigned_56-bit_integer",
0x27: "Unsigned_64-bit_integer",
# Signed integer
0x28: "Signed_8-bit_integer",
0x29: "Signed_16-bit_integer",
0x2a: "Signed_24-bit_integer",
0x2b: "Signed_32-bit_integer",
0x2c: "Signed_40-bit_integer",
0x2d: "Signed_48-bit_integer",
0x2e: "Signed_56-bit_integer",
0x2f: "Signed_64-bit_integer",
# Enumeration
0x30: "8-bit_enumeration",
0x31: "16-bit_enumeration",
# Floating point
0x38: "semi_precision",
0x39: "single_precision",
0x3a: "double_precision",
# String
0x41: "octet-string",
0x42: "character_string",
0x43: "long_octet_string",
0x44: "long_character_string",
# Ordered sequence
0x48: "array",
0x4c: "structure",
# Collection
0x50: "set",
0x51: "bag",
# Time
0xe0: "time_of_day",
0xe1: "date",
0xe2: "utc_time",
# Identifier
0xe8: "cluster_id",
0xe9: "attribute_id",
0xea: "bacnet_oid",
# Miscellaneous
0xf0: "ieee_address",
0xf1: "128-bit_security_key",
# Unknown
0xff: "unknown",
}
# ZigBee #
class ZigbeeNWK(Packet):
name = "Zigbee Network Layer"
fields_desc = [
BitField("discover_route", 0, 2),
BitField("proto_version", 2, 4),
BitEnumField("frametype", 0, 2,
{0: 'data', 1: 'command', 3: 'Inter-PAN'}),
FlagsField("flags", 0, 8, ['multicast', 'security', 'source_route', 'extended_dst', 'extended_src', 'reserved1', 'reserved2', 'reserved3']), # noqa: E501
XLEShortField("destination", 0),
XLEShortField("source", 0),
ByteField("radius", 0),
ByteField("seqnum", 1),
# ConditionalField(XLongField("ext_dst", 0), lambda pkt:pkt.flags & 8),
ConditionalField(dot15d4AddressField("ext_dst", 0, adjust=lambda pkt, x: 8), lambda pkt:pkt.flags & 8), # noqa: E501
ConditionalField(dot15d4AddressField("ext_src", 0, adjust=lambda pkt, x: 8), lambda pkt:pkt.flags & 16), # noqa: E501
ConditionalField(ByteField("relay_count", 1), lambda pkt:pkt.flags & 0x04), # noqa: E501
ConditionalField(ByteField("relay_index", 0), lambda pkt:pkt.flags & 0x04), # noqa: E501
ConditionalField(FieldListField("relays", [], XLEShortField("", 0x0000), count_from=lambda pkt:pkt.relay_count), lambda pkt:pkt.flags & 0x04), # noqa: E501
]
@classmethod
def dispatch_hook(cls, _pkt=None, *args, **kargs):
if _pkt and len(_pkt) >= 2:
frametype = ord(_pkt[:1]) & 3
if frametype == 3:
return ZigbeeNWKStub
return cls
def guess_payload_class(self, payload):
if self.flags.security:
return ZigbeeSecurityHeader
elif self.frametype == 0:
return ZigbeeAppDataPayload
elif self.frametype == 1:
return ZigbeeNWKCommandPayload
else:
return Packet.guess_payload_class(self, payload)
class LinkStatusEntry(Packet):
name = "ZigBee Link Status Entry"
fields_desc = [
# Neighbor network address (2 octets)
XLEShortField("neighbor_network_address", 0x0000),
# Link status (1 octet)
BitField("reserved1", 0, 1),
BitField("outgoing_cost", 0, 3),
BitField("reserved2", 0, 1),
BitField("incoming_cost", 0, 3),
]
def extract_padding(self, p):
return b"", p
class ZigbeeNWKCommandPayload(Packet):
name = "Zigbee Network Layer Command Payload"
fields_desc = [
ByteEnumField("cmd_identifier", 1, {
1: "route request",
2: "route reply",
3: "network status",
4: "leave",
5: "route record",
6: "rejoin request",
7: "rejoin response",
8: "link status",
9: "network report",
10: "network update",
11: "end device timeout request",
12: "end device timeout response"
# 0x0d - 0xff reserved
}),
# - Route Request Command - #
# Command options (1 octet)
ConditionalField(BitField("res1", 0, 1),
lambda pkt: pkt.cmd_identifier in [1, 2]),
ConditionalField(BitField("multicast", 0, 1),
lambda pkt: pkt.cmd_identifier in [1, 2]),
ConditionalField(BitField("dest_addr_bit", 0, 1), lambda pkt: pkt.cmd_identifier == 1), # noqa: E501
ConditionalField(
BitEnumField("many_to_one", 0, 2, {
0: "not_m2one", 1: "m2one_support_rrt", 2: "m2one_no_support_rrt", 3: "reserved"} # noqa: E501
), lambda pkt: pkt.cmd_identifier == 1),
ConditionalField(BitField("res2", 0, 3), lambda pkt: pkt.cmd_identifier == 1), # noqa: E501
# - Route Reply Command - #
# Command options (1 octet)
ConditionalField(BitField("responder_addr_bit", 0, 1), lambda pkt: pkt.cmd_identifier == 2), # noqa: E501
ConditionalField(BitField("originator_addr_bit", 0, 1), lambda pkt: pkt.cmd_identifier == 2), # noqa: E501
ConditionalField(BitField("res3", 0, 4), lambda pkt: pkt.cmd_identifier == 2), # noqa: E501
# Route request identifier (1 octet)
ConditionalField(ByteField("route_request_identifier", 0),
lambda pkt: pkt.cmd_identifier in [1, 2]), # noqa: E501
# Originator address (2 octets)
ConditionalField(XLEShortField("originator_address", 0x0000), lambda pkt: pkt.cmd_identifier == 2), # noqa: E501
# Responder address (2 octets)
ConditionalField(XLEShortField("responder_address", 0x0000), lambda pkt: pkt.cmd_identifier == 2), # noqa: E501
# - Network Status Command - #
# Status code (1 octet)
ConditionalField(ByteEnumField("status_code", 0, {
0x00: "No route available",
0x01: "Tree link failure",
0x02: "Non-tree link failure",
0x03: "Low battery level",
0x04: "No routing capacity",
0x05: "No indirect capacity",
0x06: "Indirect transaction expiry",
0x07: "Target device unavailable",
0x08: "Target address unallocated",
0x09: "Parent link failure",
0x0a: "Validate route",
0x0b: "Source route failure",
0x0c: "Many-to-one route failure",
0x0d: "Address conflict",
0x0e: "Verify addresses",
0x0f: "PAN identifier update",
0x10: "Network address update",
0x11: "Bad frame counter",
0x12: "Bad key sequence number",
# 0x13 - 0xff Reserved
}), lambda pkt: pkt.cmd_identifier == 3),
# Destination address (2 octets)
ConditionalField(XLEShortField("destination_address", 0x0000),
lambda pkt: pkt.cmd_identifier in [1, 3]),
# Path cost (1 octet)
ConditionalField(ByteField("path_cost", 0),
lambda pkt: pkt.cmd_identifier in [1, 2]), # noqa: E501
# Destination IEEE Address (0/8 octets), only present when dest_addr_bit has a value of 1 # noqa: E501
ConditionalField(dot15d4AddressField("ext_dst", 0, adjust=lambda pkt, x: 8), # noqa: E501
lambda pkt: (pkt.cmd_identifier == 1 and pkt.dest_addr_bit == 1)), # noqa: E501
# Originator IEEE address (0/8 octets)
ConditionalField(dot15d4AddressField("originator_addr", 0, adjust=lambda pkt, x: 8), # noqa: E501
lambda pkt: (pkt.cmd_identifier == 2 and pkt.originator_addr_bit == 1)), # noqa: E501
# Responder IEEE address (0/8 octets)
ConditionalField(dot15d4AddressField("responder_addr", 0, adjust=lambda pkt, x: 8), # noqa: E501
lambda pkt: (pkt.cmd_identifier == 2 and pkt.responder_addr_bit == 1)), # noqa: E501
# - Leave Command - #
# Command options (1 octet)
# Bit 7: Remove children
ConditionalField(BitField("remove_children", 0, 1), lambda pkt: pkt.cmd_identifier == 4), # noqa: E501
# Bit 6: Request
ConditionalField(BitField("request", 0, 1), lambda pkt: pkt.cmd_identifier == 4), # noqa: E501
# Bit 5: Rejoin
ConditionalField(BitField("rejoin", 0, 1), lambda pkt: pkt.cmd_identifier == 4), # noqa: E501
# Bit 0 - 4: Reserved
ConditionalField(BitField("res4", 0, 5), lambda pkt: pkt.cmd_identifier == 4), # noqa: E501
# - Route Record Command - #
# Relay count (1 octet)
ConditionalField(ByteField("rr_relay_count", 0), lambda pkt: pkt.cmd_identifier == 5), # noqa: E501
# Relay list (variable in length)
ConditionalField(
FieldListField("rr_relay_list", [], XLEShortField("", 0x0000), count_from=lambda pkt:pkt.rr_relay_count), # noqa: E501
lambda pkt:pkt.cmd_identifier == 5),
# - Rejoin Request Command - #
# Capability Information (1 octet)
ConditionalField(BitField("allocate_address", 0, 1), lambda pkt:pkt.cmd_identifier == 6), # Allocate Address # noqa: E501
ConditionalField(BitField("security_capability", 0, 1), lambda pkt:pkt.cmd_identifier == 6), # Security Capability # noqa: E501
ConditionalField(BitField("reserved2", 0, 1), lambda pkt:pkt.cmd_identifier == 6), # bit 5 is reserved # noqa: E501
ConditionalField(BitField("reserved1", 0, 1), lambda pkt:pkt.cmd_identifier == 6), # bit 4 is reserved # noqa: E501
ConditionalField(BitField("receiver_on_when_idle", 0, 1), lambda pkt:pkt.cmd_identifier == 6), # Receiver On When Idle # noqa: E501
ConditionalField(BitField("power_source", 0, 1), lambda pkt:pkt.cmd_identifier == 6), # Power Source # noqa: E501
ConditionalField(BitField("device_type", 0, 1), lambda pkt:pkt.cmd_identifier == 6), # Device Type # noqa: E501
ConditionalField(BitField("alternate_pan_coordinator", 0, 1), lambda pkt:pkt.cmd_identifier == 6), # Alternate PAN Coordinator # noqa: E501
# - Rejoin Response Command - #
# Network address (2 octets)
ConditionalField(XLEShortField("network_address", 0xFFFF), lambda pkt:pkt.cmd_identifier == 7), # noqa: E501
# Rejoin status (1 octet)
ConditionalField(ByteField("rejoin_status", 0), lambda pkt:pkt.cmd_identifier == 7), # noqa: E501
# - Link Status Command - #
# Command options (1 octet)
ConditionalField(BitField("res5", 0, 1), lambda pkt:pkt.cmd_identifier == 8), # Reserved # noqa: E501
ConditionalField(BitField("last_frame", 0, 1), lambda pkt:pkt.cmd_identifier == 8), # Last frame # noqa: E501
ConditionalField(BitField("first_frame", 0, 1), lambda pkt:pkt.cmd_identifier == 8), # First frame # noqa: E501
ConditionalField(BitField("entry_count", 0, 5), lambda pkt:pkt.cmd_identifier == 8), # Entry count # noqa: E501
# Link status list (variable size)
ConditionalField(
PacketListField("link_status_list", [], LinkStatusEntry, count_from=lambda pkt:pkt.entry_count), # noqa: E501
lambda pkt:pkt.cmd_identifier == 8),
# - Network Report Command - #
# Command options (1 octet)
ConditionalField(
BitEnumField("report_command_identifier", 0, 3, {0: "PAN identifier conflict"}), # 0x01 - 0x07 Reserved # noqa: E501
lambda pkt: pkt.cmd_identifier == 9),
ConditionalField(BitField("report_information_count", 0, 5), lambda pkt: pkt.cmd_identifier == 9), # noqa: E501
# Report information (variable length)
# Only present if we have a PAN Identifier Conflict Report
ConditionalField(
FieldListField("PAN_ID_conflict_report", [], XLEShortField("", 0x0000), # noqa: E501
count_from=lambda pkt:pkt.report_information_count),
lambda pkt:(pkt.cmd_identifier == 9 and pkt.report_command_identifier == 0) # noqa: E501
),
# - Network Update Command - #
# Command options (1 octet)
ConditionalField(
BitEnumField("update_command_identifier", 0, 3, {0: "PAN Identifier Update"}), # 0x01 - 0x07 Reserved # noqa: E501
lambda pkt: pkt.cmd_identifier == 10),
ConditionalField(BitField("update_information_count", 0, 5), lambda pkt: pkt.cmd_identifier == 10), # noqa: E501
# EPID: Extended PAN ID (8 octets)
ConditionalField(
dot15d4AddressField("epid", 0, adjust=lambda pkt, x: 8),
lambda pkt: pkt.cmd_identifier in [9, 10]
),
# Update Id (1 octet)
ConditionalField(ByteField("update_id", 0), lambda pkt: pkt.cmd_identifier == 10), # noqa: E501
# Update Information (Variable)
# Only present if we have a PAN Identifier Update
# New PAN ID (2 octets)
ConditionalField(XLEShortField("new_PAN_ID", 0x0000),
lambda pkt: (pkt.cmd_identifier == 10 and pkt.update_command_identifier == 0)), # noqa: E501
# - End Device Timeout Request Command - #
# Requested Timeout (1 octet)
ConditionalField(
ByteEnumField("req_timeout", 3, {
0: "10 seconds",
1: "2 minutes",
2: "4 minutes",
3: "8 minutes",
4: "16 minutes",
5: "32 minutes",
6: "64 minutes",
7: "128 minutes",
8: "256 minutes",
9: "512 minutes",
10: "1024 minutes",
11: "2048 minutes",
12: "4096 minutes",
13: "8192 minutes",
14: "16384 minutes"
}),
lambda pkt: pkt.cmd_identifier == 11),
# End Device Configuration (1 octet)
ConditionalField(
ByteField("ed_conf", 0),
lambda pkt: pkt.cmd_identifier == 11),
# - End Device Timeout Response Command - #
# Status (1 octet)
ConditionalField(
ByteEnumField("status", 0, {
0: "Success",
1: "Incorrect Value"
}),
lambda pkt: pkt.cmd_identifier == 12),
# Parent Information (1 octet)
ConditionalField(
BitField("res6", 0, 6),
lambda pkt: pkt.cmd_identifier == 12),
ConditionalField(
BitField("ed_timeout_req_keepalive", 0, 1),
lambda pkt: pkt.cmd_identifier == 12),
ConditionalField(
BitField("mac_data_poll_keepalive", 0, 1),
lambda pkt: pkt.cmd_identifier == 12)
# StrField("data", ""),
]
def util_mic_len(pkt):
''' Calculate the length of the attribute value field '''
if (pkt.nwk_seclevel == 0): # no encryption, no mic
return 0
elif (pkt.nwk_seclevel == 1): # MIC-32
return 4
elif (pkt.nwk_seclevel == 2): # MIC-64
return 8
elif (pkt.nwk_seclevel == 3): # MIC-128
return 16
elif (pkt.nwk_seclevel == 4): # ENC
return 0
elif (pkt.nwk_seclevel == 5): # ENC-MIC-32
return 4
elif (pkt.nwk_seclevel == 6): # ENC-MIC-64
return 8
elif (pkt.nwk_seclevel == 7): # ENC-MIC-128
return 16
else:
return 0
class ZigbeeSecurityHeader(Packet):
name = "Zigbee Security Header"
fields_desc = [
# Security control (1 octet)
FlagsField("reserved1", 0, 2, ['reserved1', 'reserved2']),
BitField("extended_nonce", 1, 1), # set to 1 if the sender address field is present (source) # noqa: E501
# Key identifier
BitEnumField("key_type", 1, 2, {
0: 'data_key',
1: 'network_key',
2: 'key_transport_key',
3: 'key_load_key'
}),
# Security level (3 bits)
BitEnumField("nwk_seclevel", 0, 3, {
0: "None",
1: "MIC-32",
2: "MIC-64",
3: "MIC-128",
4: "ENC",
5: "ENC-MIC-32",
6: "ENC-MIC-64",
7: "ENC-MIC-128"
}),
# Frame counter (4 octets)
XLEIntField("fc", 0), # provide frame freshness and prevent duplicate frames # noqa: E501
# Source address (0/8 octets)
ConditionalField(dot15d4AddressField("source", 0, adjust=lambda pkt, x: 8), lambda pkt: pkt.extended_nonce), # noqa: E501
# Key sequence number (0/1 octet): only present when key identifier is 1 (network key) # noqa: E501
ConditionalField(ByteField("key_seqnum", 0), lambda pkt: pkt.getfieldval("key_type") == 1), # noqa: E501
# Payload
# the length of the encrypted data is the payload length minus the MIC
StrField("data", ""), # noqa: E501
# Message Integrity Code (0/variable in size), length depends on nwk_seclevel # noqa: E501
XStrField("mic", ""),
]
def post_dissect(self, s):
# Get the mic dissected correctly
mic_length = util_mic_len(self)
if mic_length > 0: # Slice "data" into "data + mic"
_data, _mic = self.data[:-mic_length], self.data[-mic_length:]
self.data, self.mic = _data, _mic
return s
class ZigbeeAppDataPayload(Packet):
name = "Zigbee Application Layer Data Payload (General APS Frame Format)"
fields_desc = [
# Frame control (1 octet)
FlagsField("frame_control", 2, 4,
['ack_format', 'security', 'ack_req', 'extended_hdr']),
BitEnumField("delivery_mode", 0, 2,
{0: 'unicast', 1: 'indirect',
2: 'broadcast', 3: 'group_addressing'}),
BitEnumField("aps_frametype", 0, 2,
{0: 'data', 1: 'command', 2: 'ack'}),
# Destination endpoint (0/1 octet)
ConditionalField(
ByteField("dst_endpoint", 10),
lambda pkt: ((pkt.aps_frametype == 0 and
pkt.delivery_mode in [0, 2]) or
(pkt.aps_frametype == 2 and not
pkt.frame_control.ack_format))
),
# Group address (0/2 octets)
ConditionalField(
XLEShortField("group_addr", 0x0000),
lambda pkt: (pkt.aps_frametype == 0 and pkt.delivery_mode == 3)
),
# Cluster identifier (0/2 octets)
ConditionalField(
# unsigned short (little-endian)
EnumField("cluster", 0, _zcl_cluster_identifier, fmt="<H"),
lambda pkt: ((pkt.aps_frametype == 0) or
(pkt.aps_frametype == 2 and not
pkt.frame_control.ack_format))
),
# Profile identifier (0/2 octets)
ConditionalField(
EnumField("profile", 0, _zcl_profile_identifier, fmt="<H"),
lambda pkt: ((pkt.aps_frametype == 0) or
(pkt.aps_frametype == 2 and not
pkt.frame_control.ack_format))
),
# Source endpoint (0/1 octets)
ConditionalField(
ByteField("src_endpoint", 10),
lambda pkt: ((pkt.aps_frametype == 0) or
(pkt.aps_frametype == 2 and not
pkt.frame_control.ack_format))
),
# APS counter (1 octet)
ByteField("counter", 0),
# Extended header (0/1/2 octets)
# cribbed from https://github.com/wireshark/wireshark/blob/master/epan/dissectors/packet-zbee-aps.c # noqa: E501
ConditionalField(
ByteEnumField(
"fragmentation", 0,
{0: "none", 1: "first_block", 2: "middle_block"}),
lambda pkt: (pkt.aps_frametype in [0, 2] and
pkt.frame_control.extended_hdr)
),
ConditionalField(
ByteField("block_number", 0),
lambda pkt: (pkt.aps_frametype in [0, 2] and
pkt.fragmentation in [1, 2])
),
ConditionalField(
ByteField("ack_bitfield", 0),
lambda pkt: (pkt.aps_frametype == 2 and
pkt.fragmentation in [1, 2])
),
# variable length frame payload:
# 3 frame types: data, APS command, and acknowledgement
# ConditionalField(StrField("data", ""), lambda pkt:pkt.aps_frametype == 0), # noqa: E501
]
def guess_payload_class(self, payload):
if self.frame_control & 0x02: # we have a security header
return ZigbeeSecurityHeader
elif self.aps_frametype == 0: # data
if self.profile == 0x0000:
return ZigbeeDeviceProfile
else:
return ZigbeeClusterLibrary
elif self.aps_frametype == 1: # command
return ZigbeeAppCommandPayload
else:
return Packet.guess_payload_class(self, payload)
_TransportKeyKeyTypes = {
0x00: "Trust Center Master Key",
0x01: "Standard Network Key",
0x02: "Application Master Key",
0x03: "Application Link Key",
0x04: "Trust Center Link Key",
0x05: "High-Security Network Key",
}
_RequestKeyKeyTypes = {
0x02: "Application Link Key",
0x04: "Trust Center Link Key",
}
_ApsStatusValues = {
0x00: "SUCCESS",
0xa0: "ASDU_TOO_LONG",
0xa1: "DEFRAG_DEFERRED",
0xa2: "DEFRAG_UNSUPPORTED",
0xa3: "ILLEGAL_REQUEST",
0xa4: "INVALID_BINDING",
0xa5: "INVALID_GROUP",
0xa6: "INVALID_PARAMETER",
0xa7: "NO_ACK",
0xa8: "NO_BOUND_DEVICE",
0xa9: "NO_SHORT_ADDRESS",
0xaa: "NOT_SUPPORTED",
0xab: "SECURED_LINK_KEY",
0xac: "SECURED_NWK_KEY",
0xad: "SECURITY_FAIL",
0xae: "TABLE_FULL",
0xaf: "UNSECURED",
0xb0: "UNSUPPORTED_ATTRIBUTE"
}
class ZigbeeAppCommandPayload(Packet):
name = "Zigbee Application Layer Command Payload"
fields_desc = [
ByteEnumField("cmd_identifier", 1, {
1: "APS_CMD_SKKE_1",
2: "APS_CMD_SKKE_2",
3: "APS_CMD_SKKE_3",
4: "APS_CMD_SKKE_4",
5: "APS_CMD_TRANSPORT_KEY",
6: "APS_CMD_UPDATE_DEVICE",
7: "APS_CMD_REMOVE_DEVICE",
8: "APS_CMD_REQUEST_KEY",
9: "APS_CMD_SWITCH_KEY",
# TODO: implement 10 to 13
10: "APS_CMD_EA_INIT_CHLNG",
11: "APS_CMD_EA_RSP_CHLNG",
12: "APS_CMD_EA_INIT_MAC_DATA",
13: "APS_CMD_EA_RSP_MAC_DATA",
14: "APS_CMD_TUNNEL",
15: "APS_CMD_VERIFY_KEY",
16: "APS_CMD_CONFIRM_KEY"
}),
# SKKE Commands
ConditionalField(dot15d4AddressField("initiator", 0,
adjust=lambda pkt, x: 8),
lambda pkt: pkt.cmd_identifier in [1, 2, 3, 4]),
ConditionalField(dot15d4AddressField("responder", 0,
adjust=lambda pkt, x: 8),
lambda pkt: pkt.cmd_identifier in [1, 2, 3, 4]),
ConditionalField(StrFixedLenField("data", 0, length=16),
lambda pkt: pkt.cmd_identifier in [1, 2, 3, 4]),
# Confirm-key command
ConditionalField(
ByteEnumField("status", 0, _ApsStatusValues),
lambda pkt: pkt.cmd_identifier == 16),
# Common fields
ConditionalField(
ByteEnumField("key_type", 0, _TransportKeyKeyTypes),
lambda pkt: pkt.cmd_identifier in [5, 8, 15, 16]),
ConditionalField(dot15d4AddressField("address", 0,
adjust=lambda pkt, x: 8),
lambda pkt: pkt.cmd_identifier in [6, 7, 15, 16]),
# Transport-key Command
ConditionalField(
StrFixedLenField("key", None, 16),
lambda pkt: pkt.cmd_identifier == 5),
ConditionalField(
ByteField("key_seqnum", 0),
lambda pkt: (pkt.cmd_identifier == 5 and
pkt.key_type in [0x01, 0x05])),
ConditionalField(
dot15d4AddressField("dest_addr", 0, adjust=lambda pkt, x: 8),
lambda pkt: ((pkt.cmd_identifier == 5 and
pkt.key_type not in [0x02, 0x03]) or
pkt.cmd_identifier == 14)),
ConditionalField(
dot15d4AddressField("src_addr", 0, adjust=lambda pkt, x: 8),
lambda pkt: (pkt.cmd_identifier == 5 and
pkt.key_type not in [0x02, 0x03])),
ConditionalField(
dot15d4AddressField("partner_addr", 0, adjust=lambda pkt, x: 8),
lambda pkt: ((pkt.cmd_identifier == 5 and
pkt.key_type in [0x02, 0x03]) or
(pkt.cmd_identifier == 8 and pkt.key_type == 0x02))),
ConditionalField(
ByteField("initiator_flag", 0),
lambda pkt: (pkt.cmd_identifier == 5 and
pkt.key_type in [0x02, 0x03])),
# Update-Device Command
ConditionalField(XLEShortField("short_address", 0),
lambda pkt: pkt.cmd_identifier == 6),
ConditionalField(ByteField("update_status", 0),
lambda pkt: pkt.cmd_identifier == 6),
# Switch-Key Command
ConditionalField(StrFixedLenField("seqnum", None, 8),
lambda pkt: pkt.cmd_identifier == 9),
# Un-implemented: 10-13 (+?)
ConditionalField(StrField("unimplemented", ""),
lambda pkt: (pkt.cmd_identifier >= 10 and
pkt.cmd_identifier <= 13)),
# Tunnel Command
ConditionalField(
FlagsField("frame_control", 2, 4, [
"ack_format",
"security",
"ack_req",
"extended_hdr"
]),
lambda pkt: pkt.cmd_identifier == 14),
ConditionalField(
BitEnumField("delivery_mode", 0, 2, {
0: "unicast",
1: "indirect",
2: "broadcast",
3: "group_addressing"
}),
lambda pkt: pkt.cmd_identifier == 14),
ConditionalField(
BitEnumField("aps_frametype", 1, 2, {
0: "data",
1: "command",
2: "ack"
}),
lambda pkt: pkt.cmd_identifier == 14),
ConditionalField(
ByteField("counter", 0),
lambda pkt: pkt.cmd_identifier == 14),
# Verify-Key Command
ConditionalField(
StrFixedLenField("key_hash", None, 16),
lambda pkt: pkt.cmd_identifier == 15),
]
def guess_payload_class(self, payload):
if self.cmd_identifier == 14:
# Tunneled APS Auxiliary Header
return ZigbeeSecurityHeader
else:
return Packet.guess_payload_class(self, payload)
class ZigBeeBeacon(Packet):
name = "ZigBee Beacon Payload"
fields_desc = [
# Protocol ID (1 octet)
ByteField("proto_id", 0),
# nwkcProtocolVersion (4 bits)
BitField("nwkc_protocol_version", 0, 4),
# Stack profile (4 bits)
BitField("stack_profile", 0, 4),
# End device capacity (1 bit)
BitField("end_device_capacity", 0, 1),
# Device depth (4 bits)
BitField("device_depth", 0, 4),
# Router capacity (1 bit)
BitField("router_capacity", 0, 1),
# Reserved (2 bits)
BitField("reserved", 0, 2),
# Extended PAN ID (8 octets)
dot15d4AddressField("extended_pan_id", 0, adjust=lambda pkt, x: 8),
# Tx offset (3 bytes)
# In ZigBee 2006 the Tx-Offset is optional, while in the 2007 and later versions, the Tx-Offset is a required value. # noqa: E501
BitField("tx_offset", 0, 24),
# Update ID (1 octet)
ByteField("update_id", 0),
]
# Inter-PAN Transmission #
class ZigbeeNWKStub(Packet):
name = "Zigbee Network Layer for Inter-PAN Transmission"
fields_desc = [
# NWK frame control
BitField("res1", 0, 2), # remaining subfields shall have a value of 0 # noqa: E501
BitField("proto_version", 2, 4),
BitField("frametype", 0b11, 2), # 0b11 (3) is a reserved frame type
BitField("res2", 0, 8), # remaining subfields shall have a value of 0 # noqa: E501
]
def guess_payload_class(self, payload):
if self.frametype == 0b11:
return ZigbeeAppDataPayloadStub
else:
return Packet.guess_payload_class(self, payload)
class ZigbeeAppDataPayloadStub(Packet):
name = "Zigbee Application Layer Data Payload for Inter-PAN Transmission"
fields_desc = [
FlagsField("frame_control", 0, 4, ['reserved1', 'security', 'ack_req', 'extended_hdr']), # noqa: E501
BitEnumField("delivery_mode", 0, 2, {0: 'unicast', 2: 'broadcast', 3: 'group'}), # noqa: E501
BitField("frametype", 3, 2), # value 0b11 (3) is a reserved frame type
# Group Address present only when delivery mode field has a value of 0b11 (group delivery mode) # noqa: E501
ConditionalField(
XLEShortField("group_addr", 0x0), # 16-bit identifier of the group
lambda pkt: pkt.getfieldval("delivery_mode") == 0b11
),
# Cluster identifier
EnumField("cluster", 0, _zcl_cluster_identifier, fmt="<H"), # unsigned short (little-endian) # noqa: E501
# Profile identifier
EnumField("profile", 0, _zcl_profile_identifier, fmt="<H"),
# ZigBee Payload
ConditionalField(
StrField("data", ""),
lambda pkt: pkt.frametype == 3
),
]
# Zigbee Device Profile #
class ZigbeeDeviceProfile(Packet):
name = "Zigbee Device Profile (ZDP) Frame"
fields_desc = [
# Transaction Sequence Number (1 octet)
ByteField("trans_seqnum", 0),
# TODO: Transaction Data (variable)
]
# ZigBee Cluster Library #
_ZCL_attr_length = {
0x00: 0, # no data
0x08: 1, # 8-bit data
0x09: 2, # 16-bit data
0x0a: 3, # 24-bit data
0x0b: 4, # 32-bit data
0x0c: 5, # 40-bit data
0x0d: 6, # 48-bit data
0x0e: 7, # 56-bit data
0x0f: 8, # 64-bit data
0x10: 1, # boolean
0x18: 1, # 8-bit bitmap
0x19: 2, # 16-bit bitmap
0x1a: 3, # 24-bit bitmap
0x1b: 4, # 32-bit bitmap
0x1c: 5, # 40-bit bitmap
0x1d: 6, # 48-bit bitmap
0x1e: 7, # 46-bit bitmap
0x1f: 8, # 64-bit bitmap
0x20: 1, # Unsigned 8-bit integer
0x21: 2, # Unsigned 16-bit integer
0x22: 3, # Unsigned 24-bit integer
0x23: 4, # Unsigned 32-bit integer
0x24: 5, # Unsigned 40-bit integer
0x25: 6, # Unsigned 48-bit integer
0x26: 7, # Unsigned 56-bit integer
0x27: 8, # Unsigned 64-bit integer
0x28: 1, # Signed 8-bit integer
0x29: 2, # Signed 16-bit integer
0x2a: 3, # Signed 24-bit integer
0x2b: 4, # Signed 32-bit integer
0x2c: 5, # Signed 40-bit integer
0x2d: 6, # Signed 48-bit integer
0x2e: 7, # Signed 56-bit integer
0x2f: 8, # Signed 64-bit integer
0x30: 1, # 8-bit enumeration
0x31: 2, # 16-bit enumeration
0x38: 2, # Semi-precision
0x39: 4, # Single precision
0x3a: 8, # Double precision
0x41: (1, "!B"), # Octet string
0x42: (1, "!B"), # Character string
0x43: (2, "!H"), # Long octet string
0x44: (2, "!H"), # Long character string
# TODO (implement Ordered sequence & collection
0xe0: 4, # Time of day
0xe1: 4, # Date
0xe2: 4, # UTCTime
0xe8: 2, # Cluster ID
0xe9: 2, # Attribute ID
0xea: 4, # BACnet OID
0xf0: 8, # IEEE address
0xf1: 16, # 128-bit security key
0xff: 0, # Unknown
}
class _DiscreteString(StrLenField):
def getfield(self, pkt, s):
dtype = pkt.attribute_data_type
length = _ZCL_attr_length.get(dtype, None)
if length is None:
return b"", self.m2i(pkt, s)
elif isinstance(length, tuple): # Variable length
size, fmt = length
# We add size as we include the length tag in the string
length = struct.unpack(fmt, s[:size])[0] + size
if isinstance(length, int):
self.length_from = lambda x: length
return StrLenField.getfield(self, pkt, s)
return s
class ZCLReadAttributeStatusRecord(Packet):
name = "ZCL Read Attribute Status Record"
fields_desc = [
# Attribute Identifier
XLEShortField("attribute_identifier", 0),
# Status
ByteEnumField("status", 0, _zcl_enumerated_status_values),
# Attribute data type (0/1 octet), and data (0/variable size)
# are only included if status == 0x00 (SUCCESS)
ConditionalField(
ByteEnumField("attribute_data_type", 0, _zcl_attribute_data_types),
lambda pkt:pkt.status == 0x00
),