fix: Some more backup support for EZSP 13+ (#888)

Koenkk · Jan 28, 2024 · 9b6c04b · 9b6c04b
1 parent 9b3dfc2
commit 9b6c04b
Show file tree

Hide file tree

Showing 6 changed files with 641 additions and 11 deletions.
diff --git a/src/adapter/ezsp/adapter/backup.ts b/src/adapter/ezsp/adapter/backup.ts
@@ -2,7 +2,13 @@
 import Debug from "debug";
 import {Driver} from '../driver';
 import * as Models from "../../../models";
-import {EmberKeyType, EmberKeyStruct, EmberNetworkParameters} from '../driver/types';
+import {
+    EmberKeyType,
+    EmberKeyStruct,
+    EmberNetworkParameters,
+    EmberSecurityManagerNetworkKeyInfo,
+    EmberKeyData
+} from '../driver/types';
 import {channelsMask2list} from '../driver/utils';
 
 
@@ -20,30 +26,48 @@ export class EZSPAdapterBackup {
         this.debug("creating backup");
         const version: number = await this.driver.ezsp.version();
         const linkResult = await this.driver.getKey(EmberKeyType.TRUST_CENTER_LINK_KEY);
-        const trustCenterLinkKey: EmberKeyStruct = linkResult.keyStruct;
         const netParams = await this.driver.ezsp.execCommand('getNetworkParameters');
         const networkParams: EmberNetworkParameters = netParams.parameters;
         const netResult = await this.driver.getKey(EmberKeyType.CURRENT_NETWORK_KEY);
-        const networkKey: EmberKeyStruct = netResult.keyStruct;
+        let tclKey: Buffer = null;
+        let netKey: Buffer = null;
+        let netKeySequenceNumber: number = 0;
+        let netKeyFrameCounter: number = 0;
+
+        if (version < 13) {
+            tclKey = Buffer.from((linkResult.keyStruct as EmberKeyStruct).key.contents);
+            netKey = Buffer.from((netResult.keyStruct as EmberKeyStruct).key.contents);
+            netKeySequenceNumber = (netResult.keyStruct as EmberKeyStruct).sequenceNumber;
+            netKeyFrameCounter = (netResult.keyStruct as EmberKeyStruct).outgoingFrameCounter;
+        } else {
+            tclKey = Buffer.from((linkResult.keyData as EmberKeyData).contents);
+            netKey = Buffer.from((netResult.keyData as EmberKeyData).contents);
+            // get rest of info from second cmd in EZSP 13+
+            const netKeyInfoResult = await this.driver.getNetworkKeyInfo();
+            const networkKeyInfo : EmberSecurityManagerNetworkKeyInfo = netKeyInfoResult.networkKeyInfo;
+            netKeySequenceNumber = networkKeyInfo.networkKeySequenceNumber;
+            netKeyFrameCounter = networkKeyInfo.networkKeyFrameCounter;
+        }
+
         const ieee = (await this.driver.ezsp.execCommand('getEui64')).eui64;
         /* return backup structure */
         /* istanbul ignore next */
         return {
             ezsp: {
                 version: version,
-                hashed_tclk: Buffer.from(trustCenterLinkKey.key.contents),
+                hashed_tclk: tclKey,
             },
             networkOptions: {
                 panId: networkParams.panId,
                 extendedPanId: Buffer.from(networkParams.extendedPanId),
                 channelList: channelsMask2list(networkParams.channels),
-                networkKey: Buffer.from(networkKey.key.contents),
+                networkKey: netKey,
                 networkKeyDistribute: true,
             },
             logicalChannel: networkParams.radioChannel,
             networkKeyInfo: {
-                sequenceNumber: networkKey.sequenceNumber,
-                frameCounter: networkKey.outgoingFrameCounter
+                sequenceNumber: netKeySequenceNumber,
+                frameCounter: netKeyFrameCounter
             },
             securityLevel: 5,
             networkUpdateId: networkParams.nwkUpdateId,

diff --git a/src/adapter/ezsp/driver/commands.ts b/src/adapter/ezsp/driver/commands.ts
@@ -79,6 +79,8 @@ import {/* Basic Types */
     EmberNeighbors,
     EmberRoutingTable,
     EmberSecurityManagerContext,
+    EmberSecurityManagerNetworkKeyInfo,
+    SLStatus,
 } from './types';
 
 /* eslint-disable-next-line @typescript-eslint/no-explicit-any*/
@@ -1191,7 +1193,15 @@ export const FRAMES: {[key: string]: EZSPFrameDesc} = {
         },
         response: {
             keyData: EmberKeyData,
-            status: EmberStatus
+            status: SLStatus,
+        },
+    },
+    getNetworkKeyInfo: {
+        ID: 0x0116,
+        request: null,
+        response: {
+            status: SLStatus,
+            networkKeyInfo: EmberSecurityManagerNetworkKeyInfo,
         },
     },
     switchNetworkKeyHandler: {

diff --git a/src/adapter/ezsp/driver/driver.ts b/src/adapter/ezsp/driver/driver.ts
@@ -19,6 +19,7 @@ import {
     EmberKeyType,
     EmberDerivedKeyType,
     EmberStackError,
+    SLStatus,
 } from './types/named';
 import {Multicast} from './multicast';
 import {Waitress, Wait} from '../../../utils';
@@ -860,9 +861,23 @@ export class Driver extends EventEmitter {
             smc.flags = 0;
             smc.psaKeyAlgPermission = 0;
             const keyInfo = await this.ezsp.execCommand('exportKey', {context: smc});
-            console.assert(keyInfo.status === EmberStatus.SUCCESS, 
+            console.assert(keyInfo.status === SLStatus.SL_STATUS_OK, 
                 `exportKey(${EmberKeyType.valueToName(EmberKeyType, keyType)}) `
-                + `returned unexpected status: ${keyInfo.status}`);
+                + `returned unexpected SL status: ${keyInfo.status}`);
+            return keyInfo;
+        }
+    }
+
+    public async getNetworkKeyInfo(): Promise<EZSPFrameData> {
+        if (this.ezsp.ezspV < 13) {
+            throw new Error(`getNetKeyInfo(): Invalid call on EZSP < 13.`);
+        } else {
+            const keyInfo = await this.ezsp.execCommand('getNetworkKeyInfo');
+            console.assert(
+                keyInfo.status === SLStatus.SL_STATUS_OK, 
+                `getNetworkKeyInfo() returned unexpected SL status: ${keyInfo.status}`
+            );
+
             return keyInfo;
         }
     }

diff --git a/src/adapter/ezsp/driver/types/index.ts b/src/adapter/ezsp/driver/types/index.ts
@@ -43,6 +43,7 @@ import {
     EzspMfgTokenId,
     EzspStatus,
     EmberStatus,
+    SLStatus,
     EmberStackError,
     EmberEventUnits,
     EmberNodeType,
@@ -117,6 +118,7 @@ import {
     EmberRoutingTable,
     EmberRoutingTableEntry,
     EmberSecurityManagerContext,
+    EmberSecurityManagerNetworkKeyInfo,
 } from './struct';
 
 /* eslint-disable-next-line @typescript-eslint/no-explicit-any*/
@@ -178,6 +180,7 @@ export {
     EzspMfgTokenId,
     EzspStatus,
     EmberStatus,
+    SLStatus,
     EmberStackError,
     EmberEventUnits,
     EmberNodeType,
@@ -251,4 +254,5 @@ export {
     EmberRoutingTable,
     EmberRoutingTableEntry,
     EmberSecurityManagerContext,
+    EmberSecurityManagerNetworkKeyInfo,
 };