@textrp/briij-js-sdk 41.0.0

package/lib/rust-crypto/CrossSigningIdentity.js

@@ -0,0 +1,163 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+/*
+Copyright 2023 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+/** Manages the cross-signing keys for our own user.
+ *
+ * @internal
+ */
+export class CrossSigningIdentity {
+  constructor(logger, olmMachine, outgoingRequestProcessor, secretStorage) {
+    this.logger = logger;
+    this.olmMachine = olmMachine;
+    this.outgoingRequestProcessor = outgoingRequestProcessor;
+    this.secretStorage = secretStorage;
+  }
+
+  /**
+   * Initialise our cross-signing keys by creating new keys if they do not exist, and uploading to the server
+   */
+  bootstrapCrossSigning(opts) {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      if (opts.setupNewCrossSigning) {
+        yield _this.resetCrossSigning(opts.authUploadDeviceSigningKeys);
+        return;
+      }
+      var olmDeviceStatus = yield _this.olmMachine.crossSigningStatus();
+
+      // Try to fetch cross signing keys from the secret storage
+      var masterKeyFromSecretStorage = yield _this.secretStorage.get("m.cross_signing.master");
+      var selfSigningKeyFromSecretStorage = yield _this.secretStorage.get("m.cross_signing.self_signing");
+      var userSigningKeyFromSecretStorage = yield _this.secretStorage.get("m.cross_signing.user_signing");
+      var privateKeysInSecretStorage = Boolean(masterKeyFromSecretStorage && selfSigningKeyFromSecretStorage && userSigningKeyFromSecretStorage);
+      var olmDeviceHasKeys = olmDeviceStatus.hasMaster && olmDeviceStatus.hasUserSigning && olmDeviceStatus.hasSelfSigning;
+
+      // Log all relevant state for easier parsing of debug logs.
+      _this.logger.debug("bootstrapCrossSigning: starting", {
+        setupNewCrossSigning: opts.setupNewCrossSigning,
+        olmDeviceHasMaster: olmDeviceStatus.hasMaster,
+        olmDeviceHasUserSigning: olmDeviceStatus.hasUserSigning,
+        olmDeviceHasSelfSigning: olmDeviceStatus.hasSelfSigning,
+        privateKeysInSecretStorage
+      });
+      if (olmDeviceHasKeys) {
+        if (!(yield _this.secretStorage.hasKey())) {
+          _this.logger.warn("bootstrapCrossSigning: Olm device has private keys, but secret storage is not yet set up; doing nothing for now.");
+          // the keys should get uploaded to 4S once that is set up.
+        } else if (!privateKeysInSecretStorage) {
+          // the device has the keys but they are not in 4S, so update it
+          _this.logger.debug("bootstrapCrossSigning: Olm device has private keys: exporting to secret storage");
+          yield _this.exportCrossSigningKeysToStorage();
+        } else {
+          _this.logger.debug("bootstrapCrossSigning: Olm device has private keys and they are saved in secret storage; doing nothing");
+        }
+      } /* (!olmDeviceHasKeys) */else {
+        if (privateKeysInSecretStorage) {
+          // they are in 4S, so import from there
+          _this.logger.debug("bootstrapCrossSigning: Cross-signing private keys not found locally, but they are available " + "in secret storage, reading storage and caching locally");
+          var status = yield _this.olmMachine.importCrossSigningKeys(masterKeyFromSecretStorage, selfSigningKeyFromSecretStorage, userSigningKeyFromSecretStorage);
+
+          // Check that `importCrossSigningKeys` worked correctly (for example, it will fail silently if the
+          // public keys are not available).
+          if (!status.hasMaster || !status.hasSelfSigning || !status.hasUserSigning) {
+            throw new Error("importCrossSigningKeys failed to import the keys");
+          }
+
+          // Get the current device
+          var device = yield _this.olmMachine.getDevice(_this.olmMachine.userId, _this.olmMachine.deviceId);
+          try {
+            // Sign the device with our cross-signing key and upload the signature
+            var request = yield device.verify();
+            yield _this.outgoingRequestProcessor.makeOutgoingRequest(request);
+          } finally {
+            device.free();
+          }
+        } else {
+          _this.logger.debug("bootstrapCrossSigning: Cross-signing private keys not found locally or in secret storage, creating new keys");
+          yield _this.resetCrossSigning(opts.authUploadDeviceSigningKeys);
+        }
+      }
+
+      // TODO: we might previously have bootstrapped cross-signing but not completed uploading the keys to the
+      //   server -- in which case we should call OlmDevice.bootstrap_cross_signing. How do we know?
+      _this.logger.debug("bootstrapCrossSigning: complete");
+    })();
+  }
+
+  /** Reset our cross-signing keys
+   *
+   * This method will:
+   *   * Tell the OlmMachine to create new keys
+   *   * Upload the new public keys and the device signature to the server
+   *   * Upload the private keys to SSSS, if it is set up
+   */
+  resetCrossSigning(authUploadDeviceSigningKeys) {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      // XXX: We must find a way to make this atomic, currently if the user does not remember his account password
+      // or 4S passphrase/key the process will fail in a bad state, with keys rotated but not uploaded or saved in 4S.
+      var outgoingRequests = yield _this2.olmMachine.bootstrapCrossSigning(true);
+
+      // If 4S is configured we need to update it.
+      if (!(yield _this2.secretStorage.hasKey())) {
+        _this2.logger.warn("resetCrossSigning: Secret storage is not yet set up; not exporting keys to secret storage yet.");
+        // the keys should get uploaded to 4S once that is set up.
+      } else {
+        // Update 4S before uploading cross-signing keys, to stay consistent with legacy that asks
+        // 4S passphrase before asking for account password.
+        // Ultimately should be made atomic and resistant to forgotten password/passphrase.
+        _this2.logger.debug("resetCrossSigning: exporting private keys to secret storage");
+        yield _this2.exportCrossSigningKeysToStorage();
+      }
+      _this2.logger.debug("resetCrossSigning: publishing public keys to server");
+      for (var req of [outgoingRequests.uploadKeysRequest, outgoingRequests.uploadSigningKeysRequest, outgoingRequests.uploadSignaturesRequest]) {
+        if (req) {
+          yield _this2.outgoingRequestProcessor.makeOutgoingRequest(req, authUploadDeviceSigningKeys);
+        }
+      }
+    })();
+  }
+
+  /**
+   * Extract the cross-signing keys from the olm machine and save them to secret storage, if it is configured
+   *
+   * (If secret storage is *not* configured, we assume that the export will happen when it is set up)
+   */
+  exportCrossSigningKeysToStorage() {
+    var _this3 = this;
+    return _asyncToGenerator(function* () {
+      var exported = yield _this3.olmMachine.exportCrossSigningKeys();
+      /* istanbul ignore else (this function is only called when we know the olm machine has keys) */
+      if (exported !== null && exported !== void 0 && exported.masterKey) {
+        yield _this3.secretStorage.store("m.cross_signing.master", exported.masterKey);
+      } else {
+        _this3.logger.error("Cannot export MSK to secret storage, private key unknown");
+      }
+      if (exported !== null && exported !== void 0 && exported.self_signing_key) {
+        yield _this3.secretStorage.store("m.cross_signing.self_signing", exported.self_signing_key);
+      } else {
+        _this3.logger.error("Cannot export SSK to secret storage, private key unknown");
+      }
+      if (exported !== null && exported !== void 0 && exported.userSigningKey) {
+        yield _this3.secretStorage.store("m.cross_signing.user_signing", exported.userSigningKey);
+      } else {
+        _this3.logger.error("Cannot export USK to secret storage, private key unknown");
+      }
+    })();
+  }
+}
+//# sourceMappingURL=CrossSigningIdentity.js.map

package/lib/rust-crypto/CrossSigningIdentity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CrossSigningIdentity.js","names":["CrossSigningIdentity","constructor","logger","olmMachine","outgoingRequestProcessor","secretStorage","bootstrapCrossSigning","opts","_this","_asyncToGenerator","setupNewCrossSigning","resetCrossSigning","authUploadDeviceSigningKeys","olmDeviceStatus","crossSigningStatus","masterKeyFromSecretStorage","get","selfSigningKeyFromSecretStorage","userSigningKeyFromSecretStorage","privateKeysInSecretStorage","Boolean","olmDeviceHasKeys","hasMaster","hasUserSigning","hasSelfSigning","debug","olmDeviceHasMaster","olmDeviceHasUserSigning","olmDeviceHasSelfSigning","hasKey","warn","exportCrossSigningKeysToStorage","status","importCrossSigningKeys","Error","device","getDevice","userId","deviceId","request","verify","makeOutgoingRequest","free","_this2","outgoingRequests","req","uploadKeysRequest","uploadSigningKeysRequest","uploadSignaturesRequest","_this3","exported","exportCrossSigningKeys","masterKey","store","error","self_signing_key","userSigningKey"],"sources":["../../src/rust-crypto/CrossSigningIdentity.ts"],"sourcesContent":["/*\r\nCopyright 2023 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nimport {\r\n    type OlmMachine,\r\n    type CrossSigningStatus,\r\n    type CrossSigningBootstrapRequests,\r\n} from \"@matrix-org/matrix-sdk-crypto-wasm\";\r\n\r\nimport type * as RustSdkCryptoJs from \"@matrix-org/matrix-sdk-crypto-wasm\";\r\nimport { type BootstrapCrossSigningOpts } from \"../crypto-api/index.ts\";\r\nimport { type Logger } from \"../logger.ts\";\r\nimport { type OutgoingRequestProcessor } from \"./OutgoingRequestProcessor.ts\";\r\nimport { type UIAuthCallback } from \"../interactive-auth.ts\";\r\nimport { type ServerSideSecretStorage } from \"../secret-storage.ts\";\r\n\r\n/** Manages the cross-signing keys for our own user.\r\n *\r\n * @internal\r\n */\r\nexport class CrossSigningIdentity {\r\n    public constructor(\r\n        private readonly logger: Logger,\r\n        private readonly olmMachine: OlmMachine,\r\n        private readonly outgoingRequestProcessor: OutgoingRequestProcessor,\r\n        private readonly secretStorage: ServerSideSecretStorage,\r\n    ) {}\r\n\r\n    /**\r\n     * Initialise our cross-signing keys by creating new keys if they do not exist, and uploading to the server\r\n     */\r\n    public async bootstrapCrossSigning(opts: BootstrapCrossSigningOpts): Promise<void> {\r\n        if (opts.setupNewCrossSigning) {\r\n            await this.resetCrossSigning(opts.authUploadDeviceSigningKeys);\r\n            return;\r\n        }\r\n\r\n        const olmDeviceStatus: CrossSigningStatus = await this.olmMachine.crossSigningStatus();\r\n\r\n        // Try to fetch cross signing keys from the secret storage\r\n        const masterKeyFromSecretStorage = await this.secretStorage.get(\"m.cross_signing.master\");\r\n        const selfSigningKeyFromSecretStorage = await this.secretStorage.get(\"m.cross_signing.self_signing\");\r\n        const userSigningKeyFromSecretStorage = await this.secretStorage.get(\"m.cross_signing.user_signing\");\r\n        const privateKeysInSecretStorage = Boolean(\r\n            masterKeyFromSecretStorage && selfSigningKeyFromSecretStorage && userSigningKeyFromSecretStorage,\r\n        );\r\n\r\n        const olmDeviceHasKeys =\r\n            olmDeviceStatus.hasMaster && olmDeviceStatus.hasUserSigning && olmDeviceStatus.hasSelfSigning;\r\n\r\n        // Log all relevant state for easier parsing of debug logs.\r\n        this.logger.debug(\"bootstrapCrossSigning: starting\", {\r\n            setupNewCrossSigning: opts.setupNewCrossSigning,\r\n            olmDeviceHasMaster: olmDeviceStatus.hasMaster,\r\n            olmDeviceHasUserSigning: olmDeviceStatus.hasUserSigning,\r\n            olmDeviceHasSelfSigning: olmDeviceStatus.hasSelfSigning,\r\n            privateKeysInSecretStorage,\r\n        });\r\n\r\n        if (olmDeviceHasKeys) {\r\n            if (!(await this.secretStorage.hasKey())) {\r\n                this.logger.warn(\r\n                    \"bootstrapCrossSigning: Olm device has private keys, but secret storage is not yet set up; doing nothing for now.\",\r\n                );\r\n                // the keys should get uploaded to 4S once that is set up.\r\n            } else if (!privateKeysInSecretStorage) {\r\n                // the device has the keys but they are not in 4S, so update it\r\n                this.logger.debug(\"bootstrapCrossSigning: Olm device has private keys: exporting to secret storage\");\r\n                await this.exportCrossSigningKeysToStorage();\r\n            } else {\r\n                this.logger.debug(\r\n                    \"bootstrapCrossSigning: Olm device has private keys and they are saved in secret storage; doing nothing\",\r\n                );\r\n            }\r\n        } /* (!olmDeviceHasKeys) */ else {\r\n            if (privateKeysInSecretStorage) {\r\n                // they are in 4S, so import from there\r\n                this.logger.debug(\r\n                    \"bootstrapCrossSigning: Cross-signing private keys not found locally, but they are available \" +\r\n                        \"in secret storage, reading storage and caching locally\",\r\n                );\r\n                const status = await this.olmMachine.importCrossSigningKeys(\r\n                    masterKeyFromSecretStorage,\r\n                    selfSigningKeyFromSecretStorage,\r\n                    userSigningKeyFromSecretStorage,\r\n                );\r\n\r\n                // Check that `importCrossSigningKeys` worked correctly (for example, it will fail silently if the\r\n                // public keys are not available).\r\n                if (!status.hasMaster || !status.hasSelfSigning || !status.hasUserSigning) {\r\n                    throw new Error(\"importCrossSigningKeys failed to import the keys\");\r\n                }\r\n\r\n                // Get the current device\r\n                const device: RustSdkCryptoJs.Device = (await this.olmMachine.getDevice(\r\n                    this.olmMachine.userId,\r\n                    this.olmMachine.deviceId,\r\n                ))!;\r\n                try {\r\n                    // Sign the device with our cross-signing key and upload the signature\r\n                    const request: RustSdkCryptoJs.SignatureUploadRequest = await device.verify();\r\n                    await this.outgoingRequestProcessor.makeOutgoingRequest(request);\r\n                } finally {\r\n                    device.free();\r\n                }\r\n            } else {\r\n                this.logger.debug(\r\n                    \"bootstrapCrossSigning: Cross-signing private keys not found locally or in secret storage, creating new keys\",\r\n                );\r\n                await this.resetCrossSigning(opts.authUploadDeviceSigningKeys);\r\n            }\r\n        }\r\n\r\n        // TODO: we might previously have bootstrapped cross-signing but not completed uploading the keys to the\r\n        //   server -- in which case we should call OlmDevice.bootstrap_cross_signing. How do we know?\r\n        this.logger.debug(\"bootstrapCrossSigning: complete\");\r\n    }\r\n\r\n    /** Reset our cross-signing keys\r\n     *\r\n     * This method will:\r\n     *   * Tell the OlmMachine to create new keys\r\n     *   * Upload the new public keys and the device signature to the server\r\n     *   * Upload the private keys to SSSS, if it is set up\r\n     */\r\n    private async resetCrossSigning(authUploadDeviceSigningKeys?: UIAuthCallback<void>): Promise<void> {\r\n        // XXX: We must find a way to make this atomic, currently if the user does not remember his account password\r\n        // or 4S passphrase/key the process will fail in a bad state, with keys rotated but not uploaded or saved in 4S.\r\n        const outgoingRequests: CrossSigningBootstrapRequests = await this.olmMachine.bootstrapCrossSigning(true);\r\n\r\n        // If 4S is configured we need to update it.\r\n        if (!(await this.secretStorage.hasKey())) {\r\n            this.logger.warn(\r\n                \"resetCrossSigning: Secret storage is not yet set up; not exporting keys to secret storage yet.\",\r\n            );\r\n            // the keys should get uploaded to 4S once that is set up.\r\n        } else {\r\n            // Update 4S before uploading cross-signing keys, to stay consistent with legacy that asks\r\n            // 4S passphrase before asking for account password.\r\n            // Ultimately should be made atomic and resistant to forgotten password/passphrase.\r\n            this.logger.debug(\"resetCrossSigning: exporting private keys to secret storage\");\r\n            await this.exportCrossSigningKeysToStorage();\r\n        }\r\n\r\n        this.logger.debug(\"resetCrossSigning: publishing public keys to server\");\r\n        for (const req of [\r\n            outgoingRequests.uploadKeysRequest,\r\n            outgoingRequests.uploadSigningKeysRequest,\r\n            outgoingRequests.uploadSignaturesRequest,\r\n        ]) {\r\n            if (req) {\r\n                await this.outgoingRequestProcessor.makeOutgoingRequest(req, authUploadDeviceSigningKeys);\r\n            }\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Extract the cross-signing keys from the olm machine and save them to secret storage, if it is configured\r\n     *\r\n     * (If secret storage is *not* configured, we assume that the export will happen when it is set up)\r\n     */\r\n    private async exportCrossSigningKeysToStorage(): Promise<void> {\r\n        const exported: RustSdkCryptoJs.CrossSigningKeyExport | undefined =\r\n            await this.olmMachine.exportCrossSigningKeys();\r\n        /* istanbul ignore else (this function is only called when we know the olm machine has keys) */\r\n        if (exported?.masterKey) {\r\n            await this.secretStorage.store(\"m.cross_signing.master\", exported.masterKey);\r\n        } else {\r\n            this.logger.error(`Cannot export MSK to secret storage, private key unknown`);\r\n        }\r\n        if (exported?.self_signing_key) {\r\n            await this.secretStorage.store(\"m.cross_signing.self_signing\", exported.self_signing_key);\r\n        } else {\r\n            this.logger.error(`Cannot export SSK to secret storage, private key unknown`);\r\n        }\r\n        if (exported?.userSigningKey) {\r\n            await this.secretStorage.store(\"m.cross_signing.user_signing\", exported.userSigningKey);\r\n        } else {\r\n            this.logger.error(`Cannot export USK to secret storage, private key unknown`);\r\n        }\r\n    }\r\n}\r\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;AACA;AACA,OAAO,MAAMA,oBAAoB,CAAC;EACvBC,WAAWA,CACGC,MAAc,EACdC,UAAsB,EACtBC,wBAAkD,EAClDC,aAAsC,EACzD;IAAA,KAJmBH,MAAc,GAAdA,MAAc;IAAA,KACdC,UAAsB,GAAtBA,UAAsB;IAAA,KACtBC,wBAAkD,GAAlDA,wBAAkD;IAAA,KAClDC,aAAsC,GAAtCA,aAAsC;EACxD;;EAEH;AACJ;AACA;EACiBC,qBAAqBA,CAACC,IAA+B,EAAiB;IAAA,IAAAC,KAAA;IAAA,OAAAC,iBAAA;MAC/E,IAAIF,IAAI,CAACG,oBAAoB,EAAE;QAC3B,MAAMF,KAAI,CAACG,iBAAiB,CAACJ,IAAI,CAACK,2BAA2B,CAAC;QAC9D;MACJ;MAEA,IAAMC,eAAmC,SAASL,KAAI,CAACL,UAAU,CAACW,kBAAkB,CAAC,CAAC;;MAEtF;MACA,IAAMC,0BAA0B,SAASP,KAAI,CAACH,aAAa,CAACW,GAAG,CAAC,wBAAwB,CAAC;MACzF,IAAMC,+BAA+B,SAAST,KAAI,CAACH,aAAa,CAACW,GAAG,CAAC,8BAA8B,CAAC;MACpG,IAAME,+BAA+B,SAASV,KAAI,CAACH,aAAa,CAACW,GAAG,CAAC,8BAA8B,CAAC;MACpG,IAAMG,0BAA0B,GAAGC,OAAO,CACtCL,0BAA0B,IAAIE,+BAA+B,IAAIC,+BACrE,CAAC;MAED,IAAMG,gBAAgB,GAClBR,eAAe,CAACS,SAAS,IAAIT,eAAe,CAACU,cAAc,IAAIV,eAAe,CAACW,cAAc;;MAEjG;MACAhB,KAAI,CAACN,MAAM,CAACuB,KAAK,CAAC,iCAAiC,EAAE;QACjDf,oBAAoB,EAAEH,IAAI,CAACG,oBAAoB;QAC/CgB,kBAAkB,EAAEb,eAAe,CAACS,SAAS;QAC7CK,uBAAuB,EAAEd,eAAe,CAACU,cAAc;QACvDK,uBAAuB,EAAEf,eAAe,CAACW,cAAc;QACvDL;MACJ,CAAC,CAAC;MAEF,IAAIE,gBAAgB,EAAE;QAClB,IAAI,QAAQb,KAAI,CAACH,aAAa,CAACwB,MAAM,CAAC,CAAC,CAAC,EAAE;UACtCrB,KAAI,CAACN,MAAM,CAAC4B,IAAI,CACZ,kHACJ,CAAC;UACD;QACJ,CAAC,MAAM,IAAI,CAACX,0BAA0B,EAAE;UACpC;UACAX,KAAI,CAACN,MAAM,CAACuB,KAAK,CAAC,iFAAiF,CAAC;UACpG,MAAMjB,KAAI,CAACuB,+BAA+B,CAAC,CAAC;QAChD,CAAC,MAAM;UACHvB,KAAI,CAACN,MAAM,CAACuB,KAAK,CACb,wGACJ,CAAC;QACL;MACJ,CAAC,CAAC,8BAA+B;QAC7B,IAAIN,0BAA0B,EAAE;UAC5B;UACAX,KAAI,CAACN,MAAM,CAACuB,KAAK,CACb,8FAA8F,GAC1F,wDACR,CAAC;UACD,IAAMO,MAAM,SAASxB,KAAI,CAACL,UAAU,CAAC8B,sBAAsB,CACvDlB,0BAA0B,EAC1BE,+BAA+B,EAC/BC,+BACJ,CAAC;;UAED;UACA;UACA,IAAI,CAACc,MAAM,CAACV,SAAS,IAAI,CAACU,MAAM,CAACR,cAAc,IAAI,CAACQ,MAAM,CAACT,cAAc,EAAE;YACvE,MAAM,IAAIW,KAAK,CAAC,kDAAkD,CAAC;UACvE;;UAEA;UACA,IAAMC,MAA8B,SAAU3B,KAAI,CAACL,UAAU,CAACiC,SAAS,CACnE5B,KAAI,CAACL,UAAU,CAACkC,MAAM,EACtB7B,KAAI,CAACL,UAAU,CAACmC,QACpB,CAAG;UACH,IAAI;YACA;YACA,IAAMC,OAA+C,SAASJ,MAAM,CAACK,MAAM,CAAC,CAAC;YAC7E,MAAMhC,KAAI,CAACJ,wBAAwB,CAACqC,mBAAmB,CAACF,OAAO,CAAC;UACpE,CAAC,SAAS;YACNJ,MAAM,CAACO,IAAI,CAAC,CAAC;UACjB;QACJ,CAAC,MAAM;UACHlC,KAAI,CAACN,MAAM,CAACuB,KAAK,CACb,6GACJ,CAAC;UACD,MAAMjB,KAAI,CAACG,iBAAiB,CAACJ,IAAI,CAACK,2BAA2B,CAAC;QAClE;MACJ;;MAEA;MACA;MACAJ,KAAI,CAACN,MAAM,CAACuB,KAAK,CAAC,iCAAiC,CAAC;IAAC;EACzD;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACkBd,iBAAiBA,CAACC,2BAAkD,EAAiB;IAAA,IAAA+B,MAAA;IAAA,OAAAlC,iBAAA;MAC/F;MACA;MACA,IAAMmC,gBAA+C,SAASD,MAAI,CAACxC,UAAU,CAACG,qBAAqB,CAAC,IAAI,CAAC;;MAEzG;MACA,IAAI,QAAQqC,MAAI,CAACtC,aAAa,CAACwB,MAAM,CAAC,CAAC,CAAC,EAAE;QACtCc,MAAI,CAACzC,MAAM,CAAC4B,IAAI,CACZ,gGACJ,CAAC;QACD;MACJ,CAAC,MAAM;QACH;QACA;QACA;QACAa,MAAI,CAACzC,MAAM,CAACuB,KAAK,CAAC,6DAA6D,CAAC;QAChF,MAAMkB,MAAI,CAACZ,+BAA+B,CAAC,CAAC;MAChD;MAEAY,MAAI,CAACzC,MAAM,CAACuB,KAAK,CAAC,qDAAqD,CAAC;MACxE,KAAK,IAAMoB,GAAG,IAAI,CACdD,gBAAgB,CAACE,iBAAiB,EAClCF,gBAAgB,CAACG,wBAAwB,EACzCH,gBAAgB,CAACI,uBAAuB,CAC3C,EAAE;QACC,IAAIH,GAAG,EAAE;UACL,MAAMF,MAAI,CAACvC,wBAAwB,CAACqC,mBAAmB,CAACI,GAAG,EAAEjC,2BAA2B,CAAC;QAC7F;MACJ;IAAC;EACL;;EAEA;AACJ;AACA;AACA;AACA;EACkBmB,+BAA+BA,CAAA,EAAkB;IAAA,IAAAkB,MAAA;IAAA,OAAAxC,iBAAA;MAC3D,IAAMyC,QAA2D,SACvDD,MAAI,CAAC9C,UAAU,CAACgD,sBAAsB,CAAC,CAAC;MAClD;MACA,IAAID,QAAQ,aAARA,QAAQ,eAARA,QAAQ,CAAEE,SAAS,EAAE;QACrB,MAAMH,MAAI,CAAC5C,aAAa,CAACgD,KAAK,CAAC,wBAAwB,EAAEH,QAAQ,CAACE,SAAS,CAAC;MAChF,CAAC,MAAM;QACHH,MAAI,CAAC/C,MAAM,CAACoD,KAAK,2DAA2D,CAAC;MACjF;MACA,IAAIJ,QAAQ,aAARA,QAAQ,eAARA,QAAQ,CAAEK,gBAAgB,EAAE;QAC5B,MAAMN,MAAI,CAAC5C,aAAa,CAACgD,KAAK,CAAC,8BAA8B,EAAEH,QAAQ,CAACK,gBAAgB,CAAC;MAC7F,CAAC,MAAM;QACHN,MAAI,CAAC/C,MAAM,CAACoD,KAAK,2DAA2D,CAAC;MACjF;MACA,IAAIJ,QAAQ,aAARA,QAAQ,eAARA,QAAQ,CAAEM,cAAc,EAAE;QAC1B,MAAMP,MAAI,CAAC5C,aAAa,CAACgD,KAAK,CAAC,8BAA8B,EAAEH,QAAQ,CAACM,cAAc,CAAC;MAC3F,CAAC,MAAM;QACHP,MAAI,CAAC/C,MAAM,CAACoD,KAAK,2DAA2D,CAAC;MACjF;IAAC;EACL;AACJ","ignoreList":[]}

package/lib/rust-crypto/DehydratedDeviceManager.d.ts

@@ -0,0 +1,118 @@
+import * as RustSdkCryptoJs from "@matrix-org/matrix-sdk-crypto-wasm";
+import { type OutgoingRequestProcessor } from "./OutgoingRequestProcessor.ts";
+import { type IHttpOpts, type BriijHttpApi } from "../http-api/index.ts";
+import { type ServerSideSecretStorage } from "../secret-storage.ts";
+import { type Logger } from "../logger.ts";
+import { CryptoEvent, type CryptoEventHandlerMap, type StartDehydrationOpts } from "../crypto-api/index.ts";
+import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
+/**
+ * The unstable URL prefix for dehydrated device endpoints
+ */
+export declare const UnstablePrefix = "/_matrix/client/unstable/org.matrix.msc3814.v1";
+/**
+ * Manages dehydrated devices
+ *
+ * We have one of these per `RustCrypto`.  It's responsible for
+ *
+ * * determining server support for dehydrated devices
+ * * creating new dehydrated devices when requested, including periodically
+ *   replacing the dehydrated device with a new one
+ * * rehydrating a device when requested, and when present
+ *
+ * @internal
+ */
+export declare class DehydratedDeviceManager extends TypedEventEmitter<DehydratedDevicesEvents, DehydratedDevicesEventMap> {
+    private readonly logger;
+    private readonly olmMachine;
+    private readonly http;
+    private readonly outgoingRequestProcessor;
+    private readonly secretStorage;
+    /** the ID of the interval for periodically replacing the dehydrated device */
+    private intervalId?;
+    constructor(logger: Logger, olmMachine: RustSdkCryptoJs.OlmMachine, http: BriijHttpApi<IHttpOpts & {
+        onlyData: true;
+    }>, outgoingRequestProcessor: OutgoingRequestProcessor, secretStorage: ServerSideSecretStorage);
+    private cacheKey;
+    /**
+     * Return whether the server supports dehydrated devices.
+     */
+    isSupported(): Promise<boolean>;
+    /**
+     * Start using device dehydration.
+     *
+     * - Rehydrates a dehydrated device, if one is available and `opts.rehydrate`
+     *   is `true`.
+     * - Creates a new dehydration key, if necessary, and stores it in Secret
+     *   Storage.
+     *   - If `opts.createNewKey` is set to true, always creates a new key.
+     *   - If a dehydration key is not available, creates a new one.
+     * - Creates a new dehydrated device, and schedules periodically creating
+     *   new dehydrated devices.
+     *
+     * @param opts - options for device dehydration. For backwards compatibility
+     *     with old code, a boolean can be given here, which will be treated as
+     *     the `createNewKey` option. However, this is deprecated.
+     */
+    start(opts?: StartDehydrationOpts | boolean): Promise<void>;
+    /**
+     * Return whether the dehydration key is stored in Secret Storage.
+     */
+    isKeyStored(): Promise<boolean>;
+    /**
+     * Reset the dehydration key.
+     *
+     * Creates a new key and stores it in secret storage.
+     *
+     * @returns The newly-generated key.
+     */
+    resetKey(): Promise<RustSdkCryptoJs.DehydratedDeviceKey>;
+    /**
+     * Get and cache the encryption key from secret storage.
+     *
+     * If `create` is `true`, creates a new key if no existing key is present.
+     *
+     * @returns the key, if available, or `null` if no key is available
+     */
+    private getKey;
+    /**
+     * Rehydrate the dehydrated device stored on the server.
+     *
+     * Checks if there is a dehydrated device on the server.  If so, rehydrates
+     * the device and processes the to-device events.
+     *
+     * Returns whether or not a dehydrated device was found.
+     */
+    rehydrateDeviceIfAvailable(): Promise<boolean>;
+    /**
+     * Creates and uploads a new dehydrated device.
+     *
+     * Creates and stores a new key in secret storage if none is available.
+     */
+    createAndUploadDehydratedDevice(): Promise<void>;
+    /**
+     * Schedule periodic creation of dehydrated devices.
+     */
+    scheduleDeviceDehydration(): Promise<void>;
+    /**
+     * Stop the dehydrated device manager.
+     *
+     * Cancels any scheduled dehydration tasks.
+     */
+    stop(): void;
+    /**
+     * Delete the current dehydrated device and stop the dehydrated device manager.
+     */
+    delete(): Promise<void>;
+}
+/**
+ * The events fired by the DehydratedDeviceManager
+ * @internal
+ */
+type DehydratedDevicesEvents = CryptoEvent.DehydratedDeviceCreated | CryptoEvent.DehydratedDeviceUploaded | CryptoEvent.RehydrationStarted | CryptoEvent.RehydrationProgress | CryptoEvent.RehydrationCompleted | CryptoEvent.RehydrationError | CryptoEvent.DehydrationKeyCached | CryptoEvent.DehydratedDeviceRotationError;
+/**
+ * A map of the {@link DehydratedDeviceEvents} fired by the {@link DehydratedDeviceManager} and their payloads.
+ * @internal
+ */
+type DehydratedDevicesEventMap = Pick<CryptoEventHandlerMap, DehydratedDevicesEvents>;
+export {};
+//# sourceMappingURL=DehydratedDeviceManager.d.ts.map

package/lib/rust-crypto/DehydratedDeviceManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DehydratedDeviceManager.d.ts","sourceRoot":"","sources":["../../src/rust-crypto/DehydratedDeviceManager.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,eAAe,MAAM,oCAAoC,CAAC;AAEtE,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAE9E,OAAO,EAAE,KAAK,SAAS,EAAmB,KAAK,YAAY,EAAU,MAAM,sBAAsB,CAAC;AAElG,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAEpE,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,KAAK,qBAAqB,EAAE,KAAK,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC5G,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAmBrE;;GAEG;AACH,eAAO,MAAM,cAAc,mDAAmD,CAAC;AAW/E;;;;;;;;;;;GAWG;AACH,qBAAa,uBAAwB,SAAQ,iBAAiB,CAAC,uBAAuB,EAAE,yBAAyB,CAAC;IAK1G,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,wBAAwB;IACzC,OAAO,CAAC,QAAQ,CAAC,aAAa;IARlC,8EAA8E;IAC9E,OAAO,CAAC,UAAU,CAAC,CAAiC;gBAG/B,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,eAAe,CAAC,UAAU,EACtC,IAAI,EAAE,YAAY,CAAC,SAAS,GAAG;QAAE,QAAQ,EAAE,IAAI,CAAA;KAAE,CAAC,EAClD,wBAAwB,EAAE,wBAAwB,EAClD,aAAa,EAAE,uBAAuB;YAK7C,QAAQ;IAKtB;;OAEG;IACU,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IA2B5C;;;;;;;;;;;;;;;OAeG;IACU,KAAK,CAAC,IAAI,GAAE,oBAAoB,GAAG,OAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAyB5E;;OAEG;IACU,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAI5C;;;;;;OAMG;IACU,QAAQ,IAAI,OAAO,CAAC,eAAe,CAAC,mBAAmB,CAAC;IAQrE;;;;;;OAMG;YACW,MAAM;IAuBpB;;;;;;;OAOG;IACU,0BAA0B,IAAI,OAAO,CAAC,OAAO,CAAC;IA4E3D;;;;OAIG;IACU,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC;IAa7D;;OAEG;IACU,yBAAyB,IAAI,OAAO,CAAC,IAAI,CAAC;IAavD;;;;OAIG;IACI,IAAI,IAAI,IAAI;IAOnB;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAyBvC;AAED;;;GAGG;AACH,KAAK,uBAAuB,GACtB,WAAW,CAAC,uBAAuB,GACnC,WAAW,CAAC,wBAAwB,GACpC,WAAW,CAAC,kBAAkB,GAC9B,WAAW,CAAC,mBAAmB,GAC/B,WAAW,CAAC,oBAAoB,GAChC,WAAW,CAAC,gBAAgB,GAC5B,WAAW,CAAC,oBAAoB,GAChC,WAAW,CAAC,6BAA6B,CAAC;AAEhD;;;GAGG;AACH,KAAK,yBAAyB,GAAG,IAAI,CAAC,qBAAqB,EAAE,uBAAuB,CAAC,CAAC"}