Log a warning on startup if the network uses the fixed Z2M key

Author: puddly

tests/application/test_startup.py

@@ -38,11 +38,11 @@
     ),
     FormedZStack1CC2531: (
         "CC2531, Z-Stack Home 1.2",
-        15,
-        t.Channels.from_channel_list([15]),
-        0x1F1C,
-        t.EUI64.convert("bf:00:dc:3b:60:4b:21:74"),
-        t.KeyData(bytes.fromhex("b133fd66f718179ffd767b3cc5765a60")),
+        11,
+        t.Channels.from_channel_list([11]),
+        0x1A62,
+        t.EUI64.convert("dd:dd:dd:dd:dd:dd:dd:dd"),
+        t.KeyData([1, 3, 5, 7, 9, 11, 13, 15, 0, 2, 4, 6, 8, 10, 12, 13]),
     ),
 }
 
@@ -53,7 +53,15 @@
     [(device_cls,) + settings for device_cls, settings in DEV_NETWORK_SETTINGS.items()],
 )
 async def test_info(
-    device, model, channel, channels, pan_id, ext_pan_id, network_key, make_application
+    device,
+    model,
+    channel,
+    channels,
+    pan_id,
+    ext_pan_id,
+    network_key,
+    make_application,
+    caplog,
 ):
     app, znp_server = make_application(server_cls=device)
 
@@ -66,6 +74,11 @@ async def test_info(
 
     await app.startup(auto_form=False)
 
+    if network_key == t.KeyData([1, 3, 5, 7, 9, 11, 13, 15, 0, 2, 4, 6, 8, 10, 12, 13]):
+        assert "Your network is using the insecure" in caplog.text
+    else:
+        assert "Your network is using the insecure" not in caplog.text
+
     assert app.pan_id == pan_id
     assert app.extended_pan_id == ext_pan_id
     assert app.channel == channel

tests/nvram/CC2531-ZStack1.formed.json

@@ -4,9 +4,9 @@
         "EXTADDR": "8533ce1c004b1200",
         "STARTUP_OPTION": "00",
         "START_DELAY": "0a",
-        "NIB": "1d0502151415001e0000000105018f070002051e00000f000000000000000000001c1f08008000000f0f050001000000010000000074214b603bdc00bf010000000000000000000000000000000000000000000000000000000000000000000000000f030001780a010000410000",
-        "DEVICE_LIST": "030044480000010800008de90100010800006203020004080000ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
-        "ADDRMGR": "03444859214b1c004b1200038de98e6e4b1c004b1200036203f23acefeff5ecfd000ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff",
+        "NIB": "49050215141500140000000105018f070002051e00000b00000000000000000000621a08000800000f0f0500010000000100000000dddddddddddddddd010000000000000000000000000000000000000000000000000000000000000000000000000f0300013c0a010000640000",
+        "DEVICE_LIST": "020051b7000001080000b1fd010004080000ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
+        "ADDRMGR": "0351b759214b1c004b120003b1fdf23acefeff5ecfd002a9c2a4412ffeffbd1bec00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff00ffffffffffffffffffff",
         "POLL_RATE_OLD16": "e803",
         "QUEUED_POLL_RATE": "6400",
         "RESPONSE_POLL_RATE": "6400",
@@ -16,32 +16,32 @@
         "STACK_PROFILE": "02",
         "INDIRECT_MSG_TIMEOUT": "07",
         "ROUTE_EXPIRY_TIME": "1e",
-        "EXTENDED_PAN_ID": "8533ce1c004b1200",
+        "EXTENDED_PAN_ID": "dddddddddddddddd",
         "BCAST_RETRIES": "02",
         "PASSIVE_ACK_TIMEOUT": "05",
-        "BCAST_DELIVERY_TIME": "1e",
+        "BCAST_DELIVERY_TIME": "14",
         "NWK_MODE": "02",
         "CONCENTRATOR_ENABLE": "01",
-        "CONCENTRATOR_DISCOVERY": "78",
+        "CONCENTRATOR_DISCOVERY": "3c",
         "CONCENTRATOR_RADIUS": "0a",
         "POLL_RATE": "e8030000",
-        "CONCENTRATOR_RC": "01",
+        "CONCENTRATOR_RC": "00",
         "NWK_MGR_MODE": "01",
-        "SRC_RTG_EXPIRY_TIME": "ff",
+        "SRC_RTG_EXPIRY_TIME": "0a",
         "ROUTE_DISCOVERY_TIME": "05",
-        "NWK_ACTIVE_KEY_INFO": "00b133fd66f718179ffd767b3cc5765a60",
+        "NWK_ACTIVE_KEY_INFO": "0001030507090b0d0f00020406080a0c0d",
         "NWK_ALTERN_KEY_INFO": "0000000000000000000000000000000000",
         "ROUTER_OFF_ASSOC_CLEANUP": "00",
         "NWK_LEAVE_REQ_ALLOWED": "01",
         "NWK_CHILD_AGE_ENABLE": "00",
-        "DEVICE_LIST_KA_TIMEOUT": "ff003c0000ff003c0000fffeffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
+        "DEVICE_LIST_KA_TIMEOUT": "ff003c0000fffeffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
         "BINDING_TABLE": "0000ffffffffffffffffffffffffffff",
-        "GROUP_TABLE": "0000ffffffffffffffffffffffffffffffffffffff",
+        "GROUP_TABLE": "0100f2840b00000000000000000000000000000000",
         "APS_FRAME_RETRIES": "03",
         "APS_ACK_WAIT_DURATION": "b80b",
         "APS_ACK_WAIT_MULTIPLIER": "02",
         "BINDING_TIME": "803e",
-        "APS_USE_EXT_PANID": "74214b603bdc00bf",
+        "APS_USE_EXT_PANID": "0000000000000000",
         "APS_USE_INSECURE_JOIN": "01",
         "COMMISSIONED_NWK_ADDR": "feff",
         "APS_NONMEMBER_RADIUS": "02",
@@ -53,18 +53,18 @@
         "NWK_ENDDEV_TIMEOUT_DEF": "08",
         "END_DEV_TIMEOUT_VALUE": "08",
         "END_DEV_CONFIGURATION": "00",
-        "PRECFGKEY": "b133fd66f718179ffd767b3cc5765a60",
-        "PRECFGKEYS_ENABLE": "01",
+        "PRECFGKEY": "01030507090b0d0f00020406080a0c0d",
+        "PRECFGKEYS_ENABLE": "00",
         "SECURITY_MODE": "04",
         "SECURE_PERMIT_JOIN": "01",
         "APS_LINK_KEY_TYPE": "01",
         "APS_ALLOW_R19_SECURITY": "00",
         "USE_DEFAULT_TCLK": "01",
         "TRUSTCENTER_ADDR": "0000000000000000",
         "USERDESC": "0000000000000000000000000000000000",
-        "NWKKEY": "00b133fd66f718179ffd767b3cc5765a60a60e0000",
-        "PANID": "ffff",
-        "CHANLIST": "00800000",
+        "NWKKEY": "0001030507090b0d0f00020406080a0c0de2040000",
+        "PANID": "621a",
+        "CHANLIST": "00080000",
         "LEAVE_CTRL": "00",
         "SCAN_DURATION": "05",
         "LOGICAL_TYPE": "00",
@@ -79,4 +79,4 @@
         "APP_ITEM_6": "ffffffffffffffffffffffffffffffff",
         "RF_TEST_PARMS": "00000000"
     }
-}
+}

zigpy_znp/zigbee/application.py

@@ -65,6 +65,10 @@
 
 REQUEST_RETRYABLE_ERRORS = REQUEST_TRANSIENT_ERRORS | REQUEST_ROUTING_ERRORS
 
+Z2M_PAN_ID = 0xA162
+Z2M_EXT_PAN_ID = t.EUI64.convert("DD:DD:DD:DD:DD:DD:DD:DD")
+Z2M_NETWORK_KEY = t.KeyData([1, 3, 5, 7, 9, 11, 13, 15, 0, 2, 4, 6, 8, 10, 12, 13])
+
 DEFAULT_TC_LINK_KEY = t.TCLinkKey(
     ExtAddr=t.EUI64.convert("FF:FF:FF:FF:FF:FF:FF:FF"),  # global
     Key=t.KeyData(b"ZigBeeAlliance09"),
@@ -364,6 +368,11 @@ async def _startup(self, auto_form=False, force_form=False, read_only=False):
             "  Network key: %s", ":".join(f"{c:02x}" for c in self.network_key)
         )
 
+        if self.network_key == Z2M_NETWORK_KEY:
+            LOGGER.warning(
+                "Your network is using the insecure Zigbee2MQTT network key!"
+            )
+
         self._watchdog_task = asyncio.create_task(self._watchdog_loop())
 
     async def update_network_channel(self, channel: t.uint8_t):