Handle cross-signing keys missing locally and/or from secret storage

src/components/views/settings/encryption/RecoveryPanelOutOfSync.tsx

@@ -13,6 +13,9 @@ import { SettingsSection } from "../shared/SettingsSection";
 import { _t } from "../../../../languageHandler";
 import { SettingsSubheader } from "../SettingsSubheader";
 import { accessSecretStorage } from "../../../../SecurityManager";
+import DeviceListener from "../../../../DeviceListener";
+import { useMatrixClientContext } from "../../../../contexts/MatrixClientContext";
+import { resetKeyBackupAndWait } from "../../../../utils/crypto/resetKeyBackup";
 
 interface RecoveryPanelOutOfSyncProps {
     /**
@@ -33,6 +36,8 @@ interface RecoveryPanelOutOfSyncProps {
  * the client.
  */
 export function RecoveryPanelOutOfSync({ onForgotRecoveryKey, onFinish }: RecoveryPanelOutOfSyncProps): JSX.Element {
+    const matrixClient = useMatrixClientContext();
+
     return (
         <SettingsSection
             legacy={false}
@@ -55,7 +60,29 @@ export function RecoveryPanelOutOfSync({ onForgotRecoveryKey, onFinish }: Recove
                     kind="primary"
                     Icon={KeyIcon}
                     onClick={async () => {
-                        await accessSecretStorage();
+                        const crypto = matrixClient.getCrypto()!;
+
+                        const deviceListener = DeviceListener.sharedInstance();
+
+                        // we need to call keyStorageOutOfSyncNeedsBackupReset here because
+                        // deviceListener.whilePaused() sets its client to undefined, so
+                        // keyStorageOutOfSyncNeedsBackupReset won't be able to check
+                        // the backup state.
+                        const needsBackupReset = await deviceListener.keyStorageOutOfSyncNeedsBackupReset(false);
+
+                        // pause the device listener because we could be making lots
+                        // of changes, and don't want toasts to pop up and disappear
+                        // while we're doing it
+                        await deviceListener.whilePaused(async () => {
+                            await accessSecretStorage(async () => {
+                                // Reset backup if needed.
+                                if (needsBackupReset) {
+                                    await resetKeyBackupAndWait(crypto);
+                                } else if (await matrixClient.isKeyBackupKeyStored()) {
+                                    await crypto.loadSessionBackupPrivateKeyFromSecretStorage();
+                                }
+                            });
+                        });
                         onFinish();
                     }}
                 >

test/unit-tests/components/views/settings/encryption/RecoveryPanelOutOfSync-test.tsx

@@ -12,16 +12,29 @@ import { mocked } from "jest-mock";
 
 import { RecoveryPanelOutOfSync } from "../../../../../../src/components/views/settings/encryption/RecoveryPanelOutOfSync";
 import { accessSecretStorage } from "../../../../../../src/SecurityManager";
+import DeviceListener from "../../../../../../src/DeviceListener";
+import { stubClient } from "../../../../../test-utils";
+import { MatrixClientPeg } from "../../../../../../src/MatrixClientPeg";
+import MatrixClientContext from "../../../../../../src/contexts/MatrixClientContext";
 
 jest.mock("../../../../../../src/SecurityManager", () => ({
     accessSecretStorage: jest.fn(),
 }));
 
 describe("<RecoveyPanelOutOfSync />", () => {
     function renderComponent(onFinish = jest.fn(), onForgotRecoveryKey = jest.fn()) {
-        return render(<RecoveryPanelOutOfSync onFinish={onFinish} onForgotRecoveryKey={onForgotRecoveryKey} />);
+        stubClient();
+        return render(
+            <MatrixClientContext.Provider value={MatrixClientPeg.safeGet()}>
+                <RecoveryPanelOutOfSync onFinish={onFinish} onForgotRecoveryKey={onForgotRecoveryKey} />
+            </MatrixClientContext.Provider>,
+        );
     }
 
+    afterEach(() => {
+        jest.restoreAllMocks();
+    });
+
     it("should render", () => {
         const { asFragment } = renderComponent();
         expect(asFragment()).toMatchSnapshot();
@@ -38,14 +51,42 @@ describe("<RecoveyPanelOutOfSync />", () => {
     });
 
     it("should access to 4S and call onFinish when 'Enter recovery key' is clicked", async () => {
+        jest.spyOn(DeviceListener.sharedInstance(), "keyStorageOutOfSyncNeedsBackupReset").mockResolvedValue(false);
+
+        const user = userEvent.setup();
+        mocked(accessSecretStorage)
+            .mockClear()
+            .mockImplementation(async (func = async (): Promise<void> => {}) => {
+                return await func();
+            });
+
+        const onFinish = jest.fn();
+        renderComponent(onFinish);
+
+        await user.click(screen.getByRole("button", { name: "Enter recovery key" }));
+        expect(accessSecretStorage).toHaveBeenCalled();
+        expect(onFinish).toHaveBeenCalled();
+
+        expect(MatrixClientPeg.safeGet().getCrypto()!.resetKeyBackup).not.toHaveBeenCalled();
+    });
+
+    it("should reset key backup if needed", async () => {
+        jest.spyOn(DeviceListener.sharedInstance(), "keyStorageOutOfSyncNeedsBackupReset").mockResolvedValue(true);
+
         const user = userEvent.setup();
-        mocked(accessSecretStorage).mockClear().mockResolvedValue();
+        mocked(accessSecretStorage)
+            .mockClear()
+            .mockImplementation(async (func = async (): Promise<void> => {}) => {
+                return await func();
+            });
 
         const onFinish = jest.fn();
         renderComponent(onFinish);
 
         await user.click(screen.getByRole("button", { name: "Enter recovery key" }));
         expect(accessSecretStorage).toHaveBeenCalled();
         expect(onFinish).toHaveBeenCalled();
+
+        expect(MatrixClientPeg.safeGet().getCrypto()!.resetKeyBackup).toHaveBeenCalled();
     });
 });