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
|
"""Test the Thread TLV parser."""
import pytest
from python_otbr_api.tlv_parser import (
Timestamp,
Channel,
MeshcopTLVItem,
MeshcopTLVType,
NetworkName,
TLVError,
encode_tlv,
parse_tlv,
)
# Shared dataset covering the newly added Meshcop TLV types.
NEW_MESHCOP_DATASET: dict[MeshcopTLVType | int, MeshcopTLVItem] = {
MeshcopTLVType.DURATION: MeshcopTLVItem(
MeshcopTLVType.DURATION, bytes.fromhex("05")
),
MeshcopTLVType.PROVISIONING_URL: MeshcopTLVItem(
MeshcopTLVType.PROVISIONING_URL, "test".encode()
),
MeshcopTLVType.VENDOR_NAME_TLV: MeshcopTLVItem(
MeshcopTLVType.VENDOR_NAME_TLV, "ACME".encode()
),
MeshcopTLVType.UDP_ENCAPSULATION_TLV: MeshcopTLVItem(
MeshcopTLVType.UDP_ENCAPSULATION_TLV, bytes.fromhex("beef")
),
MeshcopTLVType.IPV6_ADDRESS_TLV: MeshcopTLVItem(
MeshcopTLVType.IPV6_ADDRESS_TLV,
bytes.fromhex("20010db8000000000000000000000001"),
),
MeshcopTLVType.PENDINGTIMESTAMP: MeshcopTLVItem(
MeshcopTLVType.PENDINGTIMESTAMP, bytes.fromhex("0000000000010000")
),
MeshcopTLVType.DELAYTIMER: MeshcopTLVItem(
MeshcopTLVType.DELAYTIMER, bytes.fromhex("00001388")
),
MeshcopTLVType.COUNT: MeshcopTLVItem(MeshcopTLVType.COUNT, bytes.fromhex("03")),
MeshcopTLVType.PERIOD: MeshcopTLVItem(MeshcopTLVType.PERIOD, bytes.fromhex("0032")),
MeshcopTLVType.SCAN_DURATION: MeshcopTLVItem(
MeshcopTLVType.SCAN_DURATION, bytes.fromhex("04")
),
MeshcopTLVType.ENERGY_LIST: MeshcopTLVItem(
MeshcopTLVType.ENERGY_LIST, bytes.fromhex("010203")
),
MeshcopTLVType.THREAD_DOMAIN_NAME: MeshcopTLVItem(
MeshcopTLVType.THREAD_DOMAIN_NAME, "home".encode()
),
MeshcopTLVType.DISCOVERYREQUEST: MeshcopTLVItem(
MeshcopTLVType.DISCOVERYREQUEST, bytes.fromhex("00")
),
MeshcopTLVType.DISCOVERYRESPONSE: MeshcopTLVItem(
MeshcopTLVType.DISCOVERYRESPONSE, bytes.fromhex("01")
),
MeshcopTLVType.JOINERADVERTISEMENT: MeshcopTLVItem(
MeshcopTLVType.JOINERADVERTISEMENT, bytes.fromhex("02")
),
}
# Expected TLV hex for NEW_MESHCOP_DATASET; order follows the dict insertion order.
NEW_MESHCOP_DATASET_HEX = (
"170105200474657374210441434d453002beef311020010db8000000000000000000000001"
"330800000000000100003404000013883601033702003238010439030102033b04686f6d65"
"800100810101f10102"
)
def test_encode_tlv() -> None:
"""Test the TLV parser."""
dataset = {
MeshcopTLVType.ACTIVETIMESTAMP: MeshcopTLVItem(
MeshcopTLVType.ACTIVETIMESTAMP, bytes.fromhex("0000000000010000")
),
MeshcopTLVType.CHANNEL: MeshcopTLVItem(
MeshcopTLVType.CHANNEL, bytes.fromhex("00000f")
),
MeshcopTLVType.CHANNELMASK: MeshcopTLVItem(
MeshcopTLVType.CHANNELMASK, bytes.fromhex("0004001fffe0")
),
MeshcopTLVType.EXTPANID: MeshcopTLVItem(
MeshcopTLVType.EXTPANID, bytes.fromhex("1111111122222222")
),
MeshcopTLVType.MESHLOCALPREFIX: MeshcopTLVItem(
MeshcopTLVType.MESHLOCALPREFIX, bytes.fromhex("fdad70bfe5aa15dd")
),
MeshcopTLVType.NETWORKKEY: MeshcopTLVItem(
MeshcopTLVType.NETWORKKEY, bytes.fromhex("00112233445566778899aabbccddeeff")
),
MeshcopTLVType.NETWORKNAME: NetworkName(
MeshcopTLVType.NETWORKNAME, "OpenThreadDemo".encode()
),
MeshcopTLVType.PANID: MeshcopTLVItem(
MeshcopTLVType.PANID, bytes.fromhex("1234")
),
MeshcopTLVType.PSKC: MeshcopTLVItem(
MeshcopTLVType.PSKC, bytes.fromhex("445f2b5ca6f2a93a55ce570a70efeecb")
),
MeshcopTLVType.SECURITYPOLICY: MeshcopTLVItem(
MeshcopTLVType.SECURITYPOLICY, bytes.fromhex("02a0f7f8")
),
189: MeshcopTLVItem(189, bytes.fromhex("abcdef")),
}
dataset_tlv = encode_tlv(dataset)
assert (
dataset_tlv
== (
"0E080000000000010000000300000F35060004001FFFE0020811111111222222220708FDAD"
"70BFE5AA15DD051000112233445566778899AABBCCDDEEFF030E4F70656E54687265616444"
"656D6F010212340410445F2B5CA6F2A93A55CE570A70EFEECB0C0402A0F7F8BD03ABCDEF"
).lower()
)
encoded_new_types = encode_tlv(NEW_MESHCOP_DATASET)
assert encoded_new_types == NEW_MESHCOP_DATASET_HEX
def test_parse_tlv() -> None:
"""Test the TLV parser."""
dataset_tlv = (
"0E080000000000010000000300000F35060004001FFFE0020811111111222222220708FDAD70BF"
"E5AA15DD051000112233445566778899AABBCCDDEEFF030E4F70656E54687265616444656D6F01"
"0212340410445F2B5CA6F2A93A55CE570A70EFEECB0C0402A0F7F8BD03ABCDEF"
)
dataset = parse_tlv(dataset_tlv)
assert dataset == {
MeshcopTLVType.CHANNEL: Channel(
MeshcopTLVType.CHANNEL, bytes.fromhex("00000f")
),
MeshcopTLVType.PANID: MeshcopTLVItem(
MeshcopTLVType.PANID, bytes.fromhex("1234")
),
MeshcopTLVType.EXTPANID: MeshcopTLVItem(
MeshcopTLVType.EXTPANID, bytes.fromhex("1111111122222222")
),
MeshcopTLVType.NETWORKNAME: NetworkName(
MeshcopTLVType.NETWORKNAME, "OpenThreadDemo".encode()
),
MeshcopTLVType.PSKC: MeshcopTLVItem(
MeshcopTLVType.PSKC, bytes.fromhex("445f2b5ca6f2a93a55ce570a70efeecb")
),
MeshcopTLVType.NETWORKKEY: MeshcopTLVItem(
MeshcopTLVType.NETWORKKEY, bytes.fromhex("00112233445566778899aabbccddeeff")
),
MeshcopTLVType.MESHLOCALPREFIX: MeshcopTLVItem(
MeshcopTLVType.MESHLOCALPREFIX, bytes.fromhex("fdad70bfe5aa15dd")
),
MeshcopTLVType.SECURITYPOLICY: MeshcopTLVItem(
MeshcopTLVType.SECURITYPOLICY, bytes.fromhex("02a0f7f8")
),
MeshcopTLVType.ACTIVETIMESTAMP: Timestamp(
MeshcopTLVType.ACTIVETIMESTAMP, bytes.fromhex("0000000000010000")
),
MeshcopTLVType.CHANNELMASK: MeshcopTLVItem(
MeshcopTLVType.CHANNELMASK, bytes.fromhex("0004001fffe0")
),
189: MeshcopTLVItem(189, bytes.fromhex("abcdef")),
}
parsed_new_types = parse_tlv(NEW_MESHCOP_DATASET_HEX)
assert parsed_new_types == NEW_MESHCOP_DATASET
def test_parse_tlv_with_wakeup_channel() -> None:
"""Test the TLV parser from a (truncated) dataset from an Apple BR."""
dataset_tlv = (
"0e08000065901a07000000030000194a0300000f35060004001fffc003104d79486f6d65313233"
"31323331323334"
)
dataset = parse_tlv(dataset_tlv)
assert dataset == {
MeshcopTLVType.ACTIVETIMESTAMP: Timestamp(
MeshcopTLVType.ACTIVETIMESTAMP, bytes.fromhex("000065901a070000")
),
MeshcopTLVType.CHANNEL: Channel(
MeshcopTLVType.CHANNEL, bytes.fromhex("000019")
),
MeshcopTLVType.WAKEUP_CHANNEL: MeshcopTLVItem(
MeshcopTLVType.WAKEUP_CHANNEL, bytes.fromhex("00000f")
),
MeshcopTLVType.CHANNELMASK: MeshcopTLVItem(
MeshcopTLVType.CHANNELMASK, bytes.fromhex("0004001fffc0")
),
MeshcopTLVType.NETWORKNAME: NetworkName(
MeshcopTLVType.NETWORKNAME, "MyHome1231231234".encode()
),
}
@pytest.mark.parametrize(
"tlv, error, msg",
(
(
"killevippen",
TLVError,
"invalid tlvs",
),
(
"FF",
TLVError,
"truncated tlv header",
),
(
"FF01",
TLVError,
"expected 1 bytes for tag 255, got 0",
),
(
"030E4F70656E54687265616444656D",
TLVError,
"expected 14 bytes for tag <MeshcopTLVType.NETWORKNAME: 3>, got 13",
),
(
"030E4F70656E54687265616444656DFF",
TLVError,
"invalid network name '4f70656e54687265616444656dff'",
),
),
)
def test_parse_tlv_error(tlv, error, msg) -> None:
"""Test the TLV parser error handling."""
with pytest.raises(error, match=msg):
parse_tlv(tlv)
def test_timestamp_parsing_full_integrity() -> None:
"""
Test parsing of a timestamp with mixed values for seconds, ticks, and authoritative.
We construct a value to ensure no bit overlap:
- Seconds: 400 (0x190)
- Ticks: 32767 (0x7FFF, Max value to catch the masking bug)
- Authoritative: True (1)
Hex Construction:
- Seconds (48 bits): 00 00 00 00 01 90
- Ticks/Auth (16 bits):
(Ticks << 1) | Auth
(0x7FFF << 1) | 1 => 0xFFFE | 1 => 0xFFFF
Combined Hex: 000000000190FFFF
"""
timestamp_data = bytes.fromhex("000000000190FFFF")
timestamp = Timestamp(MeshcopTLVType.ACTIVETIMESTAMP, timestamp_data)
# 1. Check Seconds: Ensures the upper 48 bits are shifted correctly
assert timestamp.seconds == 400
# 2. Check Ticks: Ensures the mask is 0x7FFF (32767)
assert timestamp.ticks == 32767
# 3. Check Authoritative: Ensures the lowest bit is read correctly
assert timestamp.authoritative is True
|
