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
|
import json
import asyncio
import dataclasses
import pytest
import zigpy.state
from jsonschema import ValidationError
from zigpy.exceptions import NetworkNotFormed
import zigpy_znp.types as t
from zigpy_znp.znp import security
from zigpy_znp.types.nvids import ExNvIds, OsalNvIds
from zigpy_znp.tools.common import validate_backup_json
from zigpy_znp.tools.network_backup import main as network_backup
from zigpy_znp.tools.network_restore import main as network_restore
from ..conftest import (
ALL_DEVICES,
EMPTY_DEVICES,
FORMED_DEVICES,
BaseZStack1CC2531,
BaseZStack3CC2531,
FormedZStack1CC2531,
BaseLaunchpadCC26X2R1,
ResetLaunchpadCC26X2R1,
)
from ..application.test_startup import DEV_NETWORK_SETTINGS
BARE_NETWORK_INFO = zigpy.state.NetworkInfo(
extended_pan_id=t.EUI64.convert("ab:de:fa:bc:de:fa:bc:de"),
channel=None,
channel_mask=None,
pan_id=None,
nwk_update_id=None,
security_level=None,
network_key=zigpy.state.Key(
key=None,
seq=None,
tx_counter=None,
rx_counter=None,
partner_ieee=None,
),
)
BARE_NODE_INFO = zigpy.state.NodeInfo(
ieee=None,
nwk=None,
logical_type=None,
)
@pytest.fixture
def backup_json():
return {
"metadata": {
"format": "zigpy/open-coordinator-backup",
"internal": {
"creation_time": "2021-02-16T22:29:28+00:00",
"zstack": {"version": 3.3},
},
"source": "zigpy-znp@0.3.0",
"version": 1,
},
"stack_specific": {"zstack": {"tclk_seed": "c04884427c8a1ed7bb8412815ccce7aa"}},
"channel": 25,
"channel_mask": [15, 20, 25],
"pan_id": "feed",
"extended_pan_id": "abdefabcdefabcde",
"coordinator_ieee": "0123456780123456",
"nwk_update_id": 2,
"security_level": 5,
"network_key": {
"frame_counter": 66781,
"key": "37668fd64e35e03342e5ef9f35ccf4ab",
"sequence_number": 1,
},
"devices": [
{
# No key
"ieee_address": "000b57fffe36b9a0",
"nwk_address": "f319",
"is_child": True,
},
{
"ieee_address": "000b57fffe38b212",
"link_key": {
"key": "d2fabcbc83dd15d7a9362a7fa39becaa", # Derived from seed
"rx_counter": 123,
"tx_counter": 456,
},
"nwk_address": "9672",
"is_child": True,
},
{
"ieee_address": "aabbccddeeff0011",
"link_key": {
"key": "4dcc18441d843fe86d8ae1396648a92b", # Derived from seed
"rx_counter": 112233,
"tx_counter": 445566,
},
"nwk_address": "abcd",
"is_child": False,
},
{
"ieee_address": "abcdabcabcabcaaa",
"link_key": {
"key": "76567876567867876718736817112312", # Not derived from seed
"rx_counter": 511223,
"tx_counter": 844556,
},
"nwk_address": None, # No known NWK address
"is_child": True, # but a child
},
],
}
def test_schema_validation(backup_json):
validate_backup_json(backup_json)
def test_schema_validation_counters(backup_json):
backup_json["devices"][1]["link_key"]["tx_counter"] = 0xFFFFFFFF
validate_backup_json(backup_json)
backup_json["devices"][1]["link_key"]["tx_counter"] = 0xFFFFFFFF + 1
with pytest.raises(ValidationError):
validate_backup_json(backup_json)
def test_schema_validation_device_key_info(backup_json):
validate_backup_json(backup_json)
backup_json["devices"][1]["link_key"]["key"] = None
with pytest.raises(ValidationError):
validate_backup_json(backup_json)
@pytest.mark.parametrize("device", EMPTY_DEVICES)
async def test_network_backup_empty(device, make_znp_server):
znp_server = make_znp_server(server_cls=device)
with pytest.raises(NetworkNotFormed):
await network_backup([znp_server._port_path, "-o", "-"])
@pytest.mark.parametrize("device", [FormedZStack1CC2531])
async def test_network_backup_pipe(device, make_znp_server, capsys):
znp_server = make_znp_server(server_cls=device)
await network_backup([znp_server._port_path, "-o", "-"])
stdout, stderr = capsys.readouterr()
validate_backup_json(json.loads(stdout))
@pytest.mark.parametrize("device", FORMED_DEVICES)
async def test_network_backup_formed(device, make_znp_server, tmp_path):
znp_server = make_znp_server(server_cls=device)
# We verified these settings with Wireshark
_, _, channel, channels, pan_id, ext_pan_id, network_key = DEV_NETWORK_SETTINGS[
device
]
backup_file = tmp_path / "backup.json"
await network_backup([znp_server._port_path, "-o", str(backup_file)])
backup = json.loads(backup_file.read_text())
# XXX: actually test that the values match up with what the device NVRAM contains
assert backup["metadata"]["version"] == 1
assert backup["metadata"]["format"] == "zigpy/open-coordinator-backup"
assert backup["metadata"]["source"].startswith("zigpy-znp@")
assert len(bytes.fromhex(backup["coordinator_ieee"])) == 8
assert t.NWK.deserialize(bytes.fromhex(backup["pan_id"])[::-1])[0] == pan_id
assert (
t.EUI64.deserialize(bytes.fromhex(backup["extended_pan_id"])[::-1])[0]
== ext_pan_id
)
assert backup["nwk_update_id"] == 0
assert backup["security_level"] == 5
assert backup["channel"] == channel
assert t.Channels.from_channel_list(backup["channel_mask"]) == channels
assert t.KeyData(bytes.fromhex(backup["network_key"]["key"])) == network_key
assert backup["network_key"]["sequence_number"] == 0
assert 0x00000000 <= backup["network_key"]["frame_counter"] <= 0xFFFFFFFF
assert isinstance(backup["devices"], list)
assert len(backup["devices"]) > 1
@pytest.mark.parametrize("device", ALL_DEVICES)
async def test_network_restore_and_backup(
device, make_znp_server, backup_json, tmp_path
):
backup_file = tmp_path / "backup.json"
backup_file.write_text(json.dumps(backup_json))
znp_server = make_znp_server(server_cls=device)
# Restore our backup on top of an existing network (or onto an empty device)
await network_restore([znp_server._port_path, "-i", str(backup_file), "-c", "2500"])
# And then back that restored device up
backup_file2 = tmp_path / "backup2.json"
await network_backup([znp_server._port_path, "-o", str(backup_file2)])
backup_json2 = json.loads(backup_file2.read_text())
# Fix up some inconsequential metadata
backup_json2["metadata"]["internal"] = backup_json["metadata"]["internal"]
backup_json2["metadata"]["source"] = backup_json["metadata"]["source"]
backup_json2["network_key"]["frame_counter"] -= 2500
# Remove things Z-Stack 1 does not preserve
if issubclass(device, BaseZStack1CC2531):
del backup_json["stack_specific"]["zstack"]["tclk_seed"]
if not backup_json["stack_specific"]["zstack"]:
del backup_json["stack_specific"]
for device in backup_json["devices"]:
if "link_key" in device:
del device["link_key"]
assert backup_json == backup_json2
@pytest.mark.parametrize("device", [ResetLaunchpadCC26X2R1])
async def test_network_restore_pick_optimal_tclk(
device, make_znp_server, backup_json, tmp_path
):
# Pick a sub-optimal TCLK
old_tclk_seed = backup_json["stack_specific"]["zstack"]["tclk_seed"]
backup_json["stack_specific"]["zstack"]["tclk_seed"] = "ab" * 16
backup_file = tmp_path / "backup.json"
backup_file.write_text(json.dumps(backup_json))
znp_server = make_znp_server(server_cls=device)
await network_restore([znp_server._port_path, "-i", str(backup_file)])
backup_file2 = tmp_path / "backup2.json"
await network_backup([znp_server._port_path, "-o", str(backup_file2)])
backup_json2 = json.loads(backup_file2.read_text())
# Optimal TCLK is re-derived
assert backup_json2["stack_specific"]["zstack"]["tclk_seed"] == old_tclk_seed
async def test_nwk_frame_counter_zstack1(make_connected_znp):
znp, znp_server = await make_connected_znp(BaseZStack1CC2531)
znp_server._nvram[ExNvIds.LEGACY] = {
OsalNvIds.NWKKEY: b"\x01" + b"\xAB" * 16 + b"\x78\x56\x34\x12"
}
assert (await security.read_nwk_frame_counter(znp)) == 0x12345678
await security.write_nwk_frame_counter(znp, 0xAABBCCDD)
assert (await security.read_nwk_frame_counter(znp)) == 0xAABBCCDD
async def test_nwk_frame_counter_zstack30(make_connected_znp):
znp, znp_server = await make_connected_znp(BaseZStack3CC2531)
znp.network_info = BARE_NETWORK_INFO
znp.node_info = BARE_NODE_INFO
znp_server._nvram[ExNvIds.LEGACY] = {
# This value is ignored
OsalNvIds.NWKKEY: b"\x01" + b"\xAB" * 16 + b"\x78\x56\x34\x12",
# Wrong EPID, ignored
OsalNvIds.LEGACY_NWK_SEC_MATERIAL_TABLE_START: bytes.fromhex(
"0f000000058eea0f004b1200"
),
# Exact EPID match, used
(OsalNvIds.LEGACY_NWK_SEC_MATERIAL_TABLE_START + 1): bytes.fromhex("01000000")
+ BARE_NETWORK_INFO.extended_pan_id.serialize(),
# Generic EPID but ignored since EPID matches
(OsalNvIds.LEGACY_NWK_SEC_MATERIAL_TABLE_START + 2): bytes.fromhex("02000000")
+ b"\xFF" * 8,
}
assert (await security.read_nwk_frame_counter(znp)) == 0x00000001
# If we change the EPID, the generic entry will be used
znp.network_info = dataclasses.replace(
znp.network_info, extended_pan_id=t.EUI64.convert("11:22:33:44:55:66:77:88")
)
assert (await security.read_nwk_frame_counter(znp)) == 0x00000002
await security.write_nwk_frame_counter(znp, 0xAABBCCDD)
assert (await security.read_nwk_frame_counter(znp)) == 0xAABBCCDD
await asyncio.sleep(0.1)
async def test_nwk_frame_counter_zstack33(make_connected_znp):
znp, znp_server = await make_connected_znp(BaseLaunchpadCC26X2R1)
znp.network_info = BARE_NETWORK_INFO
znp.node_info = BARE_NODE_INFO
znp_server._nvram = {
ExNvIds.LEGACY: {
# This value is ignored
OsalNvIds.NWKKEY: bytes.fromhex(
"00c927e9ce1544c9aa42340e4d5dc4c257e4010001000000"
)
},
ExNvIds.NWK_SEC_MATERIAL_TABLE: {
# Wrong EPID, ignored
0x0000: bytes.fromhex("0100000037a7479777d7a224"),
# Right EPID, used
0x0001: bytes.fromhex("02000000")
+ BARE_NETWORK_INFO.extended_pan_id.serialize(),
},
}
assert (await security.read_nwk_frame_counter(znp)) == 0x00000002
# If we change the EPID, the generic entry will be used. It doesn't exist.
znp.network_info = dataclasses.replace(
znp.network_info, extended_pan_id=t.EUI64.convert("11:22:33:44:55:66:77:88")
)
with pytest.raises(KeyError):
await security.read_nwk_frame_counter(znp)
# Writes similarly will fail
old_nvram_state = repr(znp_server._nvram)
# And the NVRAM will be untouched
assert repr(znp_server._nvram) == old_nvram_state
await security.write_nwk_frame_counter(znp, 0x98765432)
assert (await security.read_nwk_frame_counter(znp)) == 0x98765432
await asyncio.sleep(0.1)
def ieee_and_key(text) -> zigpy.state.Key:
ieee, key = text.replace(":", "").split("|")
return zigpy.state.Key(
partner_ieee=t.EUI64(bytes.fromhex(ieee)[::-1]),
key=t.KeyData(bytes.fromhex(key)),
)
def test_seed_candidate_finding_simple():
k1 = ieee_and_key("0011223344556677|000102030405060708090a0b0c0d0e0f")
k2 = ieee_and_key("1111223344556677|101112131415161718191a1b1c1d1e1f")
(count1, seed1), (count2, seed2) = security.iter_seed_candidates([k1, k2])
assert count1 == count2 == 1
shift1 = security.find_key_shift(k1.partner_ieee, k1.key, seed1)
shift2 = security.find_key_shift(k2.partner_ieee, k2.key, seed2)
assert shift1 is not None and shift2 is not None
assert security.compute_key(k1.partner_ieee, seed1, shift1) == k1.key
assert security.compute_key(k2.partner_ieee, seed2, shift2) == k2.key
def min_rotate(lst):
return min(security.rotate(lst, i) for i in range(len(lst)))
def test_seed_candidate_finding_complex():
ieees_and_keys = [
# Real network
ieee_and_key("000b57fffe36b9a0|0a797e7abd2b811e7702b2ec7e0bc7e7"),
ieee_and_key("000b57fffe38b212|d2fabcbc83dd15d7a9362a7fa39becaa"),
ieee_and_key("000b57fffe877774|360b0de028ec8f12f52b4b1955974384"),
ieee_and_key("000b57fffe8d4f83|9d98367aedd657cc64e54db67b15778a"),
ieee_and_key("000b57fffe8e8c44|c09e0fa233b0a1c00c08cc827549dcbb"),
ieee_and_key("000b57fffe8e92a3|ff5e69543f1f8f42df18902944d31981"),
ieee_and_key("000b57fffe8e935f|decf4219559743841def04e028ec8f12"),
ieee_and_key("000b57fffebd5ad1|8d965a543f1f8f42add0a32944d31981"),
ieee_and_key("000b57fffed53765|19bdcb2944d3198139fb32543f1f8f42"),
ieee_and_key("000b57fffedd4954|fe89957abd2b811e83f259ec7e0bc7e7"),
ieee_and_key("000b57fffedd50be|acd1813218fdcb483a12a174e180b084"),
ieee_and_key("000d6ffffe2ee3cc|b069302944eb1f81902fc9543f278942"),
ieee_and_key("000d6ffffe3066d5|19819a3eb7eb4f7c5f78e7457b7d8c5c"),
ieee_and_key("000d6ffffe7a84a9|1200687fa3a3eaaa69ccfebc83e513d7"),
ieee_and_key("000d6ffffe7bc266|ecdcac457b7d8c5caa25d13eb7eb4f7c"),
ieee_and_key("000d6ffffe7bfac1|40a6b71955af45848386f1e028d48912"),
ieee_and_key("000d6ffffea4f10b|ec5b64b67b2d718a15261f7aedee51cc"),
ieee_and_key("000d6ffffea5b793|19a972457b7d8c5c5f500f3eb7eb4f7c"),
ieee_and_key("000d6ffffea6117a|6890fa3218c5cd48fe53da74e1b8b684"),
ieee_and_key("90fd9ffffe2bbbdd|3a11ebb67bdd811ac36c907aed1ea15c"),
ieee_and_key("90fd9ffffe329a0b|8ac6fe19555fb51449e6b8e028247982"),
ieee_and_key("ccccccfffeeec02a|ea886abc8346d21b9144fc7fa3002b66"),
ieee_and_key("d0cf5efffeda9bbb|115b927abd2245ce6c205eec7e020337"),
ieee_and_key("ec1bbdfffe544f40|8007d0bc8337053bfbcb467fa371fc46"),
# Bogus entry
ieee_and_key("0011223344556677|000102030405060708090a0b0c0d0e0f"),
]
candidates = list(security.iter_seed_candidates(ieees_and_keys))
assert len(candidates) == 24 + 1
# One seed generated all but one of the keys, so there are 24 equally valid seeds.
# They are all really rotations of the same seed.
assert [c for c, s in candidates].count(24) == 24
assert len({min_rotate(bytes(s)) for c, s in candidates if c == 24}) == 1
# And one just for the bogus entry
assert [c[0] for c in candidates].count(1) == 1
|