RustCrypto | Implement keybackup loop

package.json

@@ -55,7 +55,7 @@
     ],
     "dependencies": {
         "@babel/runtime": "^7.12.5",
-        "@matrix-org/matrix-sdk-crypto-wasm": "^1.2.0",
+        "@matrix-org/matrix-sdk-crypto-wasm": "^1.2.1",
         "another-json": "^0.2.0",
         "bs58": "^5.0.0",
         "content-type": "^1.0.4",

spec/test-utils/test-data/generate-test-data.py

@@ -30,6 +30,7 @@
 from canonicaljson import encode_canonical_json
 from cryptography.hazmat.primitives.asymmetric import ed25519, x25519
 from cryptography.hazmat.primitives.serialization import Encoding, PublicFormat
+from random import randbytes
 
 # input data
 TEST_USER_ID = "@alice:localhost"
@@ -123,7 +124,7 @@ def main() -> None:
  * Do not edit by hand! This file is generated by `./generate-test-data.py`
  */
 
-import {{ IDeviceKeys }} from "../../../src/@types/crypto";
+import {{ IDeviceKeys, IMegolmSessionData }} from "../../../src/@types/crypto";
 import {{ IDownloadKeyResult }} from "../../../src";
 import {{ KeyBackupInfo }} from "../../../src/crypto-api";
 
@@ -167,6 +168,20 @@ def main() -> None:
 
 /** Signed backup data, suitable for return from `GET /_matrix/client/v3/room_keys/keys/{{roomId}}/{{sessionId}}` */
 export const SIGNED_BACKUP_DATA: KeyBackupInfo = { json.dumps(backup_data, indent=4) };
+
+export const MEGOLM_SESSION_DATA_ARRAY: IMegolmSessionData[] = [
+    { 
+        json.dumps(build_exported_megolm_key(), indent=8)
+    },
+    { 
+        json.dumps(build_exported_megolm_key(), indent=8)
+    },
+];
+
+/** An exported megolm session */
+export const MEGOLM_SESSION_DATA: IMegolmSessionData = { 
+        json.dumps(build_exported_megolm_key(), indent=4)
+};
 """,
         end="",
     )
@@ -265,6 +280,35 @@ def sign_json(json_object: dict, private_key: ed25519.Ed25519PrivateKey) -> str:
 
     return signature_base64
 
+def build_exported_megolm_key() -> dict:
+    index = int(0)
+    private_key = ed25519.Ed25519PrivateKey.generate()
+    # Just use radom bytes for the ratchet parts
+    ratchet = randbytes(32 * 4)
+    # exported key, start with version byte
+    exported_key = bytearray(b'\x01')
+    exported_key += index.to_bytes(4, 'big')
+    exported_key += ratchet
+    # KPub
+    exported_key += private_key.public_key().public_bytes(Encoding.Raw, PublicFormat.Raw)
+
+
+    megolm_export = {
+        "algorithm": "m.megolm.v1.aes-sha2",
+        "room_id": "!roomA:example.org",
+        "sender_key": "/Bu9e34hUClhddpf4E5gu5qEAdMY31+1A9HbiAeeQgo",
+        "session_id": encode_base64(
+            private_key.public_key().public_bytes(Encoding.Raw, PublicFormat.Raw)
+        ),
+        "session_key": encode_base64(exported_key),
+        "sender_claimed_keys": {
+            "ed25519": encode_base64(ed25519.Ed25519PrivateKey.generate().public_key().public_bytes(Encoding.Raw, PublicFormat.Raw)),
+        },
+        "forwarding_curve25519_key_chain": [],
+    }
+
+    return megolm_export
+
 
 if __name__ == "__main__":
     main()

spec/test-utils/test-data/index.ts

@@ -3,7 +3,7 @@
  * Do not edit by hand! This file is generated by `./generate-test-data.py`
  */
 
-import { IDeviceKeys } from "../../../src/@types/crypto";
+import { IDeviceKeys, IMegolmSessionData } from "../../../src/@types/crypto";
 import { IDownloadKeyResult } from "../../../src";
 import { KeyBackupInfo } from "../../../src/crypto-api";
 
@@ -115,4 +115,42 @@ export const SIGNED_BACKUP_DATA: KeyBackupInfo = {
             }
         }
     }
-};
+};
+
+export const MEGOLM_SESSION_DATA_ARRAY: IMegolmSessionData[] = [
+    {
+        "algorithm": "m.megolm.v1.aes-sha2",
+        "room_id": "!roomA:example.org",
+        "sender_key": "/Bu9e34hUClhddpf4E5gu5qEAdMY31+1A9HbiAeeQgo",
+        "session_id": "B/1owFh7K0r8cAVzQJnYxVpSmR+Cutiy7DTLRPsIsOI",
+        "session_key": "AQAAAADdFxBB2aZSfIHX9uOy1k9RHAtOYavhB2xBG1BiN5fXLTnFj9WMNGw1puBHbc9Xz1OiO79AUHOj/Yz1aiqn/PQBoBY7n7onN3vRrEUOk8PXpUfKGMwDN6IX1eyXD9jg36CQCTp2rtGZIitT4uO1rEC1vyI1F/9FQ+zFS1FKBTnAoQf9aMBYeytK/HAFc0CZ2MVaUpkfgrrYsuw0y0T7CLDi",
+        "sender_claimed_keys": {
+                "ed25519": "0Z+1+PWGErCmWx9fszojigz8Axh51Hgu9l8apPKU80k"
+        },
+        "forwarding_curve25519_key_chain": []
+},
+    {
+        "algorithm": "m.megolm.v1.aes-sha2",
+        "room_id": "!roomA:example.org",
+        "sender_key": "/Bu9e34hUClhddpf4E5gu5qEAdMY31+1A9HbiAeeQgo",
+        "session_id": "mG/goAa0BeALT2sjRL8bVTvYow1RfTFmcVRU22S1W4k",
+        "session_key": "AQAAAADlTISccgGBYg/MSQnMlBve5GWzxckGQ0tpiDSKARDF8JhOC7GJxhanJtBT/qbiiEdo/b+cfNjLM2p5fld1R+6v1vzPCrOD2wDH99n46FJAncHXZWjiaNKy35EdZK+v75BkTqfoNluawv4n3qgHa8Z8DK0jLFOfwXG3okTZX28fDJhv4KAGtAXgC09rI0S/G1U72KMNUX0xZnFUVNtktVuJ",
+        "sender_claimed_keys": {
+                "ed25519": "XXGabP9k45NJ1cWRcZ3NyLAkQ7BKNmSoW5MjhfsnqYY"
+        },
+        "forwarding_curve25519_key_chain": []
+},
+];
+
+/** An exported megolm session */
+export const MEGOLM_SESSION_DATA: IMegolmSessionData = {
+    "algorithm": "m.megolm.v1.aes-sha2",
+    "room_id": "!roomA:example.org",
+    "sender_key": "/Bu9e34hUClhddpf4E5gu5qEAdMY31+1A9HbiAeeQgo",
+    "session_id": "0GDRENodidyou+W+od+Y8AyHLJe+7Jo+rzDwjSPDFH8",
+    "session_key": "AQAAAAB+5PGbWI5AOqKXrwGYd8pDOFVbiL4vzLSzVqMm2IrlR6SUxC6zYS2FUxKTaJLnnZKblsSOwMj5Uz7L7ld9FhZ4JTKpb+KtekVmohGjmzEvWKNBnPoqZRRg6gD25FnnxYImXwAhuBl04TG76P4FRzMCb4AlHIOYiQf5b8EIGU6h3tBg0RDaHYncqLvlvqHfmPAMhyyXvuyaPq8w8I0jwxR/",
+    "sender_claimed_keys": {
+        "ed25519": "zFsHIa5597r9zods42B3KD1laMBdlaTBgwp+rgkh14o"
+    },
+    "forwarding_curve25519_key_chain": []
+};

spec/unit/rust-crypto/rust-crypto.spec.ts

@@ -61,32 +61,7 @@ describe("RustCrypto", () => {
         );
 
         it("should import and export keys", async () => {
-            const someRoomKeys = [
-                {
-                    algorithm: "m.megolm.v1.aes-sha2",
-                    room_id: "!cLDYAnjpiQXIrSwngM:localhost:8480",
-                    sender_key: "C9FMqTD20C0VaGWE/aSImkimuE6HDa/RyYj5gRUg3gY",
-                    session_id: "iGQG5GaP1/B3dSH6zCQDQqrNuotrtQjVC7w1OsUDwbg",
-                    session_key:
-                        "AQAAAADaCbP2gdOy8jrhikjploKgSBaFSJ5rvHcziaADbwNEzeCSrfuAUlXvCvxik8kU+MfCHIi5arN2M7UM5rGKdzkHnkReoIByFkeMdbjKWk5SFpVQexcM74eDhBGj+ICkQqOgApfnEbSswrmreB0+MhHHyLStwW5fy5f8A9QW1sbPuohkBuRmj9fwd3Uh+swkA0KqzbqLa7UI1Qu8NTrFA8G4",
-                    sender_claimed_keys: {
-                        ed25519: "RSq0Xw0RR0DeqlJ/j3qrF5qbN0D96fKk8lz9kZJlG9k",
-                    },
-                    forwarding_curve25519_key_chain: [],
-                },
-                {
-                    algorithm: "m.megolm.v1.aes-sha2",
-                    room_id: "!cLDYAnjpiQXIrSwngM:localhost:8480",
-                    sender_key: "C9FMqTD20C0VaGWE/aSImkimuE6HDa/RyYj5gRUg3gY",
-                    session_id: "P/Jy9Tog4CMtLseeS4Fe2AEXZov3k6cibcop/uyhr78",
-                    session_key:
-                        "AQAAAAATyAVm0c9c9DW9Od72MxvfSDYoysBw3C6yMJ3bYuTmssHN7yNGm59KCtKeFp2Y5qO7lvUmwOfSTvTASUb7HViE7Lt+Bvp5WiMTJ2Pv6m+N12ihyowV5lgtKFWI18Wxd0AugMTVQRwjBK6aMobf86NXWD2hiKm3N6kWbC0PXmqV7T/ycvU6IOAjLS7HnkuBXtgBF2aL95OnIm3KKf7soa+/",
-                    sender_claimed_keys: {
-                        ed25519: "RSq0Xw0RR0DeqlJ/j3qrF5qbN0D96fKk8lz9kZJlG9k",
-                    },
-                    forwarding_curve25519_key_chain: [],
-                },
-            ];
+            const someRoomKeys = testData.MEGOLM_SESSION_DATA_ARRAY;
             let importTotal = 0;
             const opt: ImportRoomKeysOpts = {
                 progressCallback: (stage) => {
@@ -95,11 +70,11 @@ describe("RustCrypto", () => {
             };
             await rustCrypto.importRoomKeys(someRoomKeys, opt);
 
-            expect(importTotal).toBe(2);
+            expect(importTotal).toBe(someRoomKeys.length);
 
             const keys = await rustCrypto.exportRoomKeys();
             expect(Array.isArray(keys)).toBeTruthy();
-            expect(keys.length).toBe(2);
+            expect(keys.length).toBe(someRoomKeys.length);
 
             const aSession = someRoomKeys[0];
 

src/client.ts

@@ -2253,6 +2253,8 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
             CryptoEvent.VerificationRequestReceived,
             CryptoEvent.UserTrustStatusChanged,
             CryptoEvent.KeyBackupStatus,
+            CryptoEvent.KeyBackupSessionsRemaining,
+            CryptoEvent.KeyBackupFailed,
         ]);
     }
 

src/crypto/backup.ts

@@ -440,6 +440,7 @@ export class BackupManager {
      * @param maxDelay - Maximum delay to wait in ms. 0 means no delay.
      */
     public async scheduleKeyBackupSend(maxDelay = 10000): Promise<void> {
+        logger.debug(`Key backup: scheduleKeyBackupSend currentSending:${this.sendingBackups} delay:${maxDelay}`);
         if (this.sendingBackups) return;
 
         this.sendingBackups = true;
@@ -474,6 +475,9 @@ export class BackupManager {
                             (<MatrixError>err).data.errcode == "M_NOT_FOUND" ||
                             (<MatrixError>err).data.errcode == "M_WRONG_ROOM_KEYS_VERSION"
                         ) {
+                            // fix do it now as the await check might trigger a new call to the loop before
+                            // the finally is called
+                            this.sendingBackups = false;
                             // Re-check key backup status on error, so we can be
                             // sure to present the current situation when asked.
                             await this.checkKeyBackup();
@@ -494,6 +498,10 @@ export class BackupManager {
                     return;
                 }
             }
+        } catch (err) {
+            // No one actually check errors on this promise, it's spawned internally.
+            // Just log, apps/client should use events to check status
+            logger.log(`Backup loop failed ${err}`);
         } finally {
             this.sendingBackups = false;
         }

src/rust-crypto/OutgoingRequestProcessor.ts

@@ -75,7 +75,12 @@ export class OutgoingRequestProcessor {
         } else if (msg instanceof SignatureUploadRequest) {
             resp = await this.rawJsonRequest(Method.Post, "/_matrix/client/v3/keys/signatures/upload", {}, msg.body);
         } else if (msg instanceof KeysBackupRequest) {
-            resp = await this.rawJsonRequest(Method.Put, "/_matrix/client/v3/room_keys/keys", {}, msg.body);
+            resp = await this.rawJsonRequest(
+                Method.Put,
+                "/_matrix/client/v3/room_keys/keys",
+                { version: msg.version },
+                msg.body,
+            );
         } else if (msg instanceof ToDeviceRequest) {
             const path =
                 `/_matrix/client/v3/sendToDevice/${encodeURIComponent(msg.event_type)}/` +