diff --git a/playwright/e2e/crypto/backups.spec.ts b/playwright/e2e/crypto/backups.spec.ts deleted file mode 100644 index 847784bff22..00000000000 --- a/playwright/e2e/crypto/backups.spec.ts +++ /dev/null @@ -1,57 +0,0 @@ -/* -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. -*/ - -import { test, expect } from "../../element-web-test"; - -test.describe("Backups", () => { - test.use({ - displayName: "Hanako", - }); - - test("Create, delete and recreate a keys backup", async ({ page, user, app }, workerInfo) => { - // skipIfLegacyCrypto - test.skip( - workerInfo.project.name === "Legacy Crypto", - "This test only works with Rust crypto. Deleting the backup seems to fail with legacy crypto.", - ); - - // Create a backup - const tab = await app.settings.openUserSettings("Security & Privacy"); - await expect(tab.getByRole("heading", { name: "Secure Backup" })).toBeVisible(); - await tab.getByRole("button", { name: "Set up", exact: true }).click(); - const dialog = await app.getDialogByTitle("Set up Secure Backup", 60000); - await dialog.getByRole("button", { name: "Continue", exact: true }).click(); - await expect(dialog.getByRole("heading", { name: "Save your Security Key" })).toBeVisible(); - await dialog.getByRole("button", { name: "Copy", exact: true }).click(); - const securityKey = await app.getClipboard(); - await dialog.getByRole("button", { name: "Continue", exact: true }).click(); - await expect(dialog.getByRole("heading", { name: "Secure Backup successful" })).toBeVisible(); - await dialog.getByRole("button", { name: "Done", exact: true }).click(); - - // Delete it - await app.settings.openUserSettings("Security & Privacy"); - await expect(tab.getByRole("heading", { name: "Secure Backup" })).toBeVisible(); - await tab.getByRole("button", { name: "Delete Backup", exact: true }).click(); - await dialog.getByTestId("dialog-primary-button").click(); // Click "Delete Backup" - - // Create another - await tab.getByRole("button", { name: "Set up", exact: true }).click(); - dialog.getByLabel("Security Key").fill(securityKey); - await dialog.getByRole("button", { name: "Continue", exact: true }).click(); - await expect(dialog.getByRole("heading", { name: "Success!" })).toBeVisible(); - await dialog.getByRole("button", { name: "OK", exact: true }).click(); - }); -}); diff --git a/playwright/e2e/crypto/utils.ts b/playwright/e2e/crypto/utils.ts index 070e615e874..f1e1f811903 100644 --- a/playwright/e2e/crypto/utils.ts +++ b/playwright/e2e/crypto/utils.ts @@ -103,12 +103,35 @@ export async function checkDeviceIsCrossSigned(app: ElementAppPage): Promise { await page.getByRole("button", { name: "User menu" }).click(); await page.locator(".mx_UserMenu_contextMenu").getByRole("menuitem", { name: "Security & Privacy" }).click(); await expect(page.locator(".mx_Dialog").getByRole("button", { name: "Restore from Backup" })).toBeVisible(); + + // expand the advanced section to see the active version in the reports + await page.locator(".mx_SecureBackupPanel_advanced").locator("..").click(); + + if (checkBackupKeyInCache) { + const cacheDecryptionKeyStatusElement = page.locator(".mx_SecureBackupPanel_statusList tr:nth-child(2) td"); + await expect(cacheDecryptionKeyStatusElement).toHaveText("cached locally, well formed"); + } + + await expect(page.locator(".mx_SecureBackupPanel_statusList tr:nth-child(5) td")).toHaveText( + expectedBackupVersion + " (Algorithm: m.megolm_backup.v1.curve25519-aes-sha2)", + ); + + await expect(page.locator(".mx_SecureBackupPanel_statusList tr:nth-child(6) td")).toHaveText(expectedBackupVersion); } /** diff --git a/playwright/e2e/crypto/verification.spec.ts b/playwright/e2e/crypto/verification.spec.ts index fc499f3f726..55d65a9b087 100644 --- a/playwright/e2e/crypto/verification.spec.ts +++ b/playwright/e2e/crypto/verification.spec.ts @@ -33,6 +33,9 @@ import { Bot } from "../../pages/bot"; test.describe("Device verification", () => { let aliceBotClient: Bot; + /** The backup version that was set up by the bot client. */ + let expectedBackupVersion: string; + test.beforeEach(async ({ page, homeserver, credentials }) => { // Visit the login page of the app, to load the matrix sdk await page.goto("/#/login"); @@ -49,9 +52,13 @@ test.describe("Device verification", () => { bootstrapSecretStorage: true, }); aliceBotClient.setCredentials(credentials); - await aliceBotClient.prepareClient(); + const mxClientHandle = await aliceBotClient.prepareClient(); await page.waitForTimeout(20000); + + expectedBackupVersion = await mxClientHandle.evaluate(async (mxClient) => { + return await mxClient.getCrypto()!.getActiveSessionBackupVersion(); + }); }); // Click the "Verify with another device" button, and have the bot client auto-accept it. @@ -87,7 +94,9 @@ test.describe("Device verification", () => { await checkDeviceIsCrossSigned(app); // Check that the current device is connected to key backup - await checkDeviceIsConnectedKeyBackup(page); + // For now we don't check that the backup key is in cache because it's a bit flaky, + // as we need to wait for the secret gossiping to happen and the settings dialog doesn't refresh automatically. + await checkDeviceIsConnectedKeyBackup(page, expectedBackupVersion, false); }); test("Verify device with QR code during login", async ({ page, app, credentials, homeserver }) => { @@ -130,7 +139,9 @@ test.describe("Device verification", () => { await checkDeviceIsCrossSigned(app); // Check that the current device is connected to key backup - await checkDeviceIsConnectedKeyBackup(page); + // For now we don't check that the backup key is in cache because it's a bit flaky, + // as we need to wait for the secret gossiping to happen and the settings dialog doesn't refresh automatically. + await checkDeviceIsConnectedKeyBackup(page, expectedBackupVersion, false); }); test("Verify device with Security Phrase during login", async ({ page, app, credentials, homeserver }) => { @@ -150,7 +161,8 @@ test.describe("Device verification", () => { await checkDeviceIsCrossSigned(app); // Check that the current device is connected to key backup - await checkDeviceIsConnectedKeyBackup(page); + // The backup decryption key should be in cache also, as we got it directly from the 4S + await checkDeviceIsConnectedKeyBackup(page, expectedBackupVersion, true); }); test("Verify device with Security Key during login", async ({ page, app, credentials, homeserver }) => { @@ -172,7 +184,8 @@ test.describe("Device verification", () => { await checkDeviceIsCrossSigned(app); // Check that the current device is connected to key backup - await checkDeviceIsConnectedKeyBackup(page); + // The backup decryption key should be in cache also, as we got it directly from the 4S + await checkDeviceIsConnectedKeyBackup(page, expectedBackupVersion, true); }); test("Handle incoming verification request with SAS", async ({ page, credentials, homeserver, toasts }) => { diff --git a/playwright/element-web-test.ts b/playwright/element-web-test.ts index 5a28518878e..9a3c7a36da7 100644 --- a/playwright/element-web-test.ts +++ b/playwright/element-web-test.ts @@ -293,7 +293,3 @@ export const expect = baseExpect.extend({ return { pass: true, message: () => "", name: "toMatchScreenshot" }; }, }); - -test.use({ - permissions: ["clipboard-read"], -}); diff --git a/playwright/pages/ElementAppPage.ts b/playwright/pages/ElementAppPage.ts index 31170f81f4f..9a5de3b1480 100644 --- a/playwright/pages/ElementAppPage.ts +++ b/playwright/pages/ElementAppPage.ts @@ -51,19 +51,6 @@ export class ElementAppPage { return this.settings.closeDialog(); } - public async getClipboard(): Promise { - return await this.page.evaluate(() => navigator.clipboard.readText()); - } - - /** - * Find an open dialog by its title - */ - public async getDialogByTitle(title: string, timeout = 5000): Promise { - const dialog = this.page.locator(".mx_Dialog"); - await dialog.getByRole("heading", { name: title }).waitFor({ timeout }); - return dialog; - } - /** * Opens the given room by name. The room must be visible in the * room list, but the room list may be folded horizontally, and the diff --git a/src/SecurityManager.ts b/src/SecurityManager.ts index f6fff3628e0..42b6c740998 100644 --- a/src/SecurityManager.ts +++ b/src/SecurityManager.ts @@ -341,22 +341,13 @@ export async function withSecretStorageKeyCache(func: () => Promise): Prom * @param {Function} [func] An operation to perform once secret storage has been * bootstrapped. Optional. * @param {bool} [forceReset] Reset secret storage even if it's already set up - * @param {bool} [setupNewKeyBackup] Reset secret storage even if it's already set up */ -export async function accessSecretStorage( - func = async (): Promise => {}, - forceReset = false, - setupNewKeyBackup = true, -): Promise { - await withSecretStorageKeyCache(() => doAccessSecretStorage(func, forceReset, setupNewKeyBackup)); +export async function accessSecretStorage(func = async (): Promise => {}, forceReset = false): Promise { + await withSecretStorageKeyCache(() => doAccessSecretStorage(func, forceReset)); } /** Helper for {@link #accessSecretStorage} */ -async function doAccessSecretStorage( - func: () => Promise, - forceReset: boolean, - setupNewKeyBackup: boolean, -): Promise { +export async function doAccessSecretStorage(func = async (): Promise => {}, forceReset = false): Promise { try { const cli = MatrixClientPeg.safeGet(); if (!(await cli.hasSecretStorageKey()) || forceReset) { @@ -387,12 +378,7 @@ async function doAccessSecretStorage( throw new Error("Secret storage creation canceled"); } } else { - const crypto = cli.getCrypto(); - if (!crypto) { - throw new Error("End-to-end encryption is disabled - unable to access secret storage."); - } - - await crypto.bootstrapCrossSigning({ + await cli.bootstrapCrossSigning({ authUploadDeviceSigningKeys: async (makeRequest): Promise => { const { finished } = Modal.createDialog(InteractiveAuthDialog, { title: _t("encryption|bootstrap_title"), @@ -405,9 +391,8 @@ async function doAccessSecretStorage( } }, }); - await crypto.bootstrapSecretStorage({ + await cli.bootstrapSecretStorage({ getKeyBackupPassphrase: promptForBackupPassphrase, - setupNewKeyBackup, }); const keyId = Object.keys(secretStorageKeys)[0]; diff --git a/src/async-components/views/dialogs/security/CreateKeyBackupDialog.tsx b/src/async-components/views/dialogs/security/CreateKeyBackupDialog.tsx index 5a7e317dd28..453a9dc84c4 100644 --- a/src/async-components/views/dialogs/security/CreateKeyBackupDialog.tsx +++ b/src/async-components/views/dialogs/security/CreateKeyBackupDialog.tsx @@ -17,6 +17,7 @@ limitations under the License. import React from "react"; import { logger } from "matrix-js-sdk/src/logger"; +import { IKeyBackupInfo } from "matrix-js-sdk/src/crypto/keybackup"; import { MatrixClientPeg } from "../../../../MatrixClientPeg"; import { _t } from "../../../../languageHandler"; @@ -74,25 +75,24 @@ export default class CreateKeyBackupDialog extends React.PureComponent => { - const crypto = cli.getCrypto(); - if (!crypto) { - throw new Error("End-to-end encryption is disabled - unable to create backup."); - } - await crypto.resetKeyBackup(); - }, - forceReset, - setupNewKeyBackup, - ); + await accessSecretStorage(async (): Promise => { + // `accessSecretStorage` will have bootstrapped secret storage if necessary, so we can now + // set up key backup. + // + // XXX: `bootstrapSecretStorage` also sets up key backup as a side effect, so there is a 90% chance + // this is actually redundant. + // + // The only time it would *not* be redundant would be if, for some reason, we had working 4S but no + // working key backup. (For example, if the user clicked "Delete Backup".) + info = await cli.prepareKeyBackupVersion(null /* random key */, { + secureSecretStorage: true, + }); + info = await cli.createKeyBackupVersion(info); + }); + await cli.scheduleAllGroupSessionsForBackup(); this.setState({ phase: Phase.Done, }); @@ -102,6 +102,9 @@ export default class CreateKeyBackupDialog extends React.PureComponent { - describe("accessSecretStorage", () => { - filterConsole("Not setting dehydration key: no SSSS key found"); - - it("runs the function passed in", async () => { - // Given a client - const crypto = { - bootstrapCrossSigning: () => {}, - bootstrapSecretStorage: () => {}, - } as unknown as CryptoApi; - const client = stubClient(); - mocked(client.hasSecretStorageKey).mockResolvedValue(true); - mocked(client.getCrypto).mockReturnValue(crypto); - - // When I run accessSecretStorage - const func = jest.fn(); - await accessSecretStorage(func); - - // Then we call the passed-in function - expect(func).toHaveBeenCalledTimes(1); - }); - - describe("expecting errors", () => { - filterConsole("End-to-end encryption is disabled - unable to access secret storage"); - - it("throws if crypto is unavailable", async () => { - // Given a client with no crypto - const client = stubClient(); - mocked(client.hasSecretStorageKey).mockResolvedValue(true); - mocked(client.getCrypto).mockReturnValue(undefined); - - // When I run accessSecretStorage - // Then we throw an error - await expect(async () => { - await accessSecretStorage(jest.fn()); - }).rejects.toThrow("End-to-end encryption is disabled - unable to access secret storage"); - }); - }); - }); -}); diff --git a/test/components/views/dialogs/security/CreateKeyBackupDialog-test.tsx b/test/components/views/dialogs/security/CreateKeyBackupDialog-test.tsx index faa466e3f5b..b0d461b8f8d 100644 --- a/test/components/views/dialogs/security/CreateKeyBackupDialog-test.tsx +++ b/test/components/views/dialogs/security/CreateKeyBackupDialog-test.tsx @@ -19,13 +19,11 @@ import React from "react"; import { mocked } from "jest-mock"; import CreateKeyBackupDialog from "../../../../../src/async-components/views/dialogs/security/CreateKeyBackupDialog"; -import { createTestClient, filterConsole } from "../../../../test-utils"; +import { createTestClient } from "../../../../test-utils"; import { MatrixClientPeg } from "../../../../../src/MatrixClientPeg"; jest.mock("../../../../../src/SecurityManager", () => ({ - accessSecretStorage: async (func = async () => Promise) => { - await func(); - }, + accessSecretStorage: jest.fn().mockResolvedValue(undefined), })); describe("CreateKeyBackupDialog", () => { @@ -41,33 +39,16 @@ describe("CreateKeyBackupDialog", () => { expect(asFragment()).toMatchSnapshot(); }); - describe("expecting failure", () => { - filterConsole("Error creating key backup"); + it("should display the error message when backup creation failed", async () => { + const matrixClient = createTestClient(); + mocked(matrixClient.scheduleAllGroupSessionsForBackup).mockRejectedValue("my error"); + MatrixClientPeg.safeGet = MatrixClientPeg.get = () => matrixClient; - it("should display an error message when backup creation failed", async () => { - const matrixClient = createTestClient(); - mocked(matrixClient.getCrypto()!.resetKeyBackup).mockImplementation(() => { - throw new Error("failed"); - }); - MatrixClientPeg.safeGet = MatrixClientPeg.get = () => matrixClient; - - const { asFragment } = render(); - - // Check if the error message is displayed - await waitFor(() => expect(screen.getByText("Unable to create key backup")).toBeDefined()); - expect(asFragment()).toMatchSnapshot(); - }); - - it("should display an error message when there is no Crypto available", async () => { - const matrixClient = createTestClient(); - mocked(matrixClient.getCrypto).mockReturnValue(undefined); - MatrixClientPeg.safeGet = MatrixClientPeg.get = () => matrixClient; - - render(); + const { asFragment } = render(); - // Check if the error message is displayed - await waitFor(() => expect(screen.getByText("Unable to create key backup")).toBeDefined()); - }); + // Check if the error message is displayed + await waitFor(() => expect(screen.getByText("Unable to create key backup")).toBeDefined()); + expect(asFragment()).toMatchSnapshot(); }); it("should display the success dialog when the key backup is finished", async () => { diff --git a/test/components/views/dialogs/security/__snapshots__/CreateKeyBackupDialog-test.tsx.snap b/test/components/views/dialogs/security/__snapshots__/CreateKeyBackupDialog-test.tsx.snap index dd82b840f1c..9d62384e3c1 100644 --- a/test/components/views/dialogs/security/__snapshots__/CreateKeyBackupDialog-test.tsx.snap +++ b/test/components/views/dialogs/security/__snapshots__/CreateKeyBackupDialog-test.tsx.snap @@ -1,6 +1,6 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`CreateKeyBackupDialog expecting failure should display an error message when backup creation failed 1`] = ` +exports[`CreateKeyBackupDialog should display the error message when backup creation failed 1`] = `