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
|
import pytest
import zigpy_znp.types as t
import zigpy_znp.commands as c
from zigpy_znp.types import nvids
from zigpy_znp.exceptions import SecurityError
async def test_osal_writes_invalid(connected_znp):
znp, _ = connected_znp
# Passing in untyped integers is not allowed
with pytest.raises(TypeError):
await znp.nvram.osal_write(nvids.OsalNvIds.HAS_CONFIGURED_ZSTACK1, 0xAB)
# Neither is passing in an empty value
with pytest.raises(ValueError):
await znp.nvram.osal_write(nvids.OsalNvIds.HAS_CONFIGURED_ZSTACK1, b"")
# Or a type that serializes to an empty value
class Empty:
def serialize(self):
return b""
assert Empty().serialize() == b""
with pytest.raises(ValueError):
await znp.nvram.osal_write(nvids.OsalNvIds.HAS_CONFIGURED_ZSTACK1, Empty())
@pytest.mark.parametrize(
"value",
[
(t.StartupOptions.ClearConfig | t.StartupOptions.ClearState),
(t.StartupOptions.ClearConfig | t.StartupOptions.ClearState).serialize(),
bytearray(b"\x03"),
],
)
async def test_osal_write_existing(connected_znp, value):
znp, znp_server = connected_znp
nvid = nvids.OsalNvIds.HAS_CONFIGURED_ZSTACK1
# The item is one byte long
length_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVLength.Req(Id=nvid),
responses=[c.SYS.OSALNVLength.Rsp(ItemLen=1)],
)
write_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVWriteExt.Req(
Id=nvid, Offset=0, Value=t.ShortBytes(b"\x03")
),
responses=[c.SYS.OSALNVWriteExt.Rsp(Status=t.Status.SUCCESS)],
)
await znp.nvram.osal_write(nvid, value)
await length_rsp
await write_rsp
async def test_osal_write_same_length(connected_znp):
znp, znp_server = connected_znp
nvid = nvids.OsalNvIds.HAS_CONFIGURED_ZSTACK1
value = b"\x01"
# The existing item is also one byte long so we will not recreate it
length_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVLength.Req(Id=nvid),
responses=[c.SYS.OSALNVLength.Rsp(ItemLen=1)],
)
write_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVWriteExt.Req(
Id=nvid, Offset=0, Value=t.ShortBytes(b"\x01")
),
responses=[c.SYS.OSALNVWriteExt.Rsp(Status=t.Status.SUCCESS)],
)
await znp.nvram.osal_write(nvid, value)
await length_rsp
await write_rsp
@pytest.mark.parametrize("nvid", [nvids.OsalNvIds.HAS_CONFIGURED_ZSTACK1])
@pytest.mark.parametrize("value", [b"\x01\x02"])
@pytest.mark.parametrize("create", [True, False])
async def test_osal_write_wrong_length(connected_znp, nvid, value, create):
znp, znp_server = connected_znp
# Pretend the item is one byte long so we will have to recreate it
length_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVLength.Req(Id=nvid),
responses=[c.SYS.OSALNVLength.Rsp(ItemLen=1)],
)
delete_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVDelete.Req(Id=nvid, ItemLen=1),
responses=[c.SYS.OSALNVDelete.Rsp(Status=t.Status.SUCCESS)],
)
init_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVItemInit.Req(Id=nvid, ItemLen=len(value), Value=value),
responses=[c.SYS.OSALNVItemInit.Rsp(Status=t.Status.NV_ITEM_UNINIT)],
)
write_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVWriteExt.Req(Id=nvid, Offset=0, Value=value),
responses=[c.SYS.OSALNVWriteExt.Rsp(Status=t.Status.SUCCESS)],
)
if create:
await znp.nvram.osal_write(nvid, value, create=True)
await length_rsp
await delete_rsp
await init_rsp
await write_rsp
else:
with pytest.raises(ValueError):
await znp.nvram.osal_write(nvid, value, create=False)
await length_rsp
assert not delete_rsp.done()
assert not init_rsp.done()
assert not write_rsp.done()
@pytest.mark.parametrize("nvid", [nvids.OsalNvIds.HAS_CONFIGURED_ZSTACK1])
@pytest.mark.parametrize("value", [b"test"])
async def test_osal_write_bad_length(connected_znp, nvid, value):
znp, znp_server = connected_znp
# The item is one byte long so we will have to recreate it
length_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVLength.Req(Id=nvid),
responses=[c.SYS.OSALNVLength.Rsp(ItemLen=1)],
)
with pytest.raises(ValueError):
await znp.nvram.osal_write(nvid, value)
await length_rsp
@pytest.mark.parametrize("nvid", [nvids.OsalNvIds.HAS_CONFIGURED_ZSTACK1])
@pytest.mark.parametrize("value", [b"test"])
async def test_osal_read_success(connected_znp, nvid, value):
znp, znp_server = connected_znp
length_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVLength.Req(Id=nvid),
responses=[c.SYS.OSALNVLength.Rsp(ItemLen=len(value))],
)
read_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVReadExt.Req(Id=nvid, Offset=0),
responses=[c.SYS.OSALNVReadExt.Rsp(Status=t.Status.SUCCESS, Value=value)],
)
result = await znp.nvram.osal_read(nvid, item_type=t.Bytes)
await length_rsp
await read_rsp
assert result == value
@pytest.mark.parametrize("nvid", [nvids.OsalNvIds.HAS_CONFIGURED_ZSTACK1])
@pytest.mark.parametrize("value", [b"test" * 62 + b"x"]) # 248 + 1 bytes, needs two
async def test_osal_read_long_success(connected_znp, nvid, value):
znp, znp_server = connected_znp
length_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVLength.Req(Id=nvid),
responses=[c.SYS.OSALNVLength.Rsp(ItemLen=len(value))],
)
read_rsp1 = znp_server.reply_once_to(
request=c.SYS.OSALNVReadExt.Req(Id=nvid, Offset=0),
responses=[c.SYS.OSALNVReadExt.Rsp(Status=t.Status.SUCCESS, Value=value[:-1])],
)
read_rsp2 = znp_server.reply_once_to(
request=c.SYS.OSALNVReadExt.Req(Id=nvid, Offset=248),
responses=[c.SYS.OSALNVReadExt.Rsp(Status=t.Status.SUCCESS, Value=b"x")],
)
result = await znp.nvram.osal_read(nvid, item_type=t.Bytes)
await length_rsp
await read_rsp1
await read_rsp2
assert result == value
@pytest.mark.parametrize("nvid", [nvids.OsalNvIds.HAS_CONFIGURED_ZSTACK1])
async def test_osal_read_failure(connected_znp, nvid):
znp, znp_server = connected_znp
length_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVLength.Req(Id=nvid),
responses=[c.SYS.OSALNVLength.Rsp(ItemLen=0)],
)
with pytest.raises(KeyError):
await znp.nvram.osal_read(nvid, item_type=t.Bytes)
await length_rsp
@pytest.mark.parametrize("nvid", [nvids.OsalNvIds.HAS_CONFIGURED_ZSTACK1])
async def test_osal_write_nonexistent(connected_znp, nvid):
znp, znp_server = connected_znp
length_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVLength.Req(Id=nvid),
responses=[c.SYS.OSALNVLength.Rsp(ItemLen=0)],
)
with pytest.raises(KeyError):
await znp.nvram.osal_write(nvid, value=b"test", create=False)
await length_rsp
@pytest.mark.parametrize("nvid", [nvids.OsalNvIds.PRECFGKEY, nvids.OsalNvIds.TCLK_SEED])
@pytest.mark.parametrize("value", [b"keydata"])
async def test_osal_read_security_bypass(connected_znp, nvid, value):
znp, znp_server = connected_znp
znp.capabilities |= t.MTCapabilities.SAPI
# Length is reported correctly
length_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVLength.Req(Id=nvid),
responses=[c.SYS.OSALNVLength.Rsp(ItemLen=len(value))],
)
# But the read will fail
read_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVReadExt.Req(Id=nvid, Offset=0),
responses=[
c.SYS.OSALNVReadExt.Rsp(Status=t.Status.INVALID_PARAMETER, Value=b"")
],
)
# Only 8-bit IDs can be extracted
if nvid <= 0xFF:
sapi_read_rsp = znp_server.reply_once_to(
request=c.SAPI.ZBReadConfiguration.Req(ConfigId=nvid),
responses=[
c.SAPI.ZBReadConfiguration.Rsp(
Status=t.Status.SUCCESS, ConfigId=nvid, Value=value
)
],
)
result = await znp.nvram.osal_read(nvid, item_type=t.Bytes)
assert result == value
await length_rsp
await read_rsp
await sapi_read_rsp
else:
with pytest.raises(SecurityError):
await znp.nvram.osal_read(nvid, item_type=t.Bytes)
await length_rsp
await read_rsp
@pytest.mark.parametrize("nvid", [nvids.OsalNvIds.POLL_RATE_OLD16])
@pytest.mark.parametrize("value", [b"\xAB\xCD"])
async def test_osal_read_proxied(connected_znp, nvid, value):
znp, znp_server = connected_znp
# Proxied reads do not do anything and will always succeed
read_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVRead.Req(Id=nvid, Offset=0),
responses=[c.SYS.OSALNVRead.Rsp(Status=t.Status.SUCCESS, Value=value)],
)
result = await znp.nvram.osal_read(nvid, item_type=t.Bytes)
await read_rsp
assert result == value
@pytest.mark.parametrize("nvid", [nvids.OsalNvIds.PRECFGKEY])
@pytest.mark.parametrize("length", [0, 16])
async def test_osal_delete(connected_znp, nvid, length):
znp, znp_server = connected_znp
length_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVLength.Req(Id=nvid),
responses=[c.SYS.OSALNVLength.Rsp(ItemLen=length)],
)
delete_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVDelete.Req(Id=nvid, ItemLen=length),
responses=[c.SYS.OSALNVDelete.Rsp(Status=t.Status.SUCCESS)],
)
await znp.nvram.osal_delete(nvid)
await length_rsp
if length == 0:
assert not delete_rsp.done()
else:
await delete_rsp
@pytest.mark.parametrize("nvid", [nvids.OsalNvIds.NWKKEY])
@pytest.mark.parametrize("value", [b"too short", b"too long " * 3, b"\x00" * 24])
async def test_osal_read_unexpected_value(connected_znp, nvid, value):
znp, znp_server = connected_znp
length_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVLength.Req(Id=nvid),
responses=[c.SYS.OSALNVLength.Rsp(ItemLen=len(value))],
)
read_rsp = znp_server.reply_once_to(
request=c.SYS.OSALNVReadExt.Req(Id=nvid, Offset=0),
responses=[c.SYS.OSALNVReadExt.Rsp(Status=t.Status.SUCCESS, Value=value)],
)
if len(value) == b"\x00" * 24:
await znp.nvram.osal_read(nvid, item_type=t.NwkActiveKeyItems)
else:
with pytest.raises(ValueError):
await znp.nvram.osal_read(nvid, item_type=t.NwkActiveKeyItems)
await length_rsp
await read_rsp
|
