diff --git a/.changeset/fix-recovery-key-cross-signing.md b/.changeset/fix-recovery-key-cross-signing.md new file mode 100644 index 000000000..33b04faa7 --- /dev/null +++ b/.changeset/fix-recovery-key-cross-signing.md @@ -0,0 +1,5 @@ +--- +default: patch +--- + +Restore cross-signing device trust when unlocking encryption backup with a recovery key. diff --git a/src/app/components/BackupRestore.test.tsx b/src/app/components/BackupRestore.test.tsx index de7257b9e..412ef8116 100644 --- a/src/app/components/BackupRestore.test.tsx +++ b/src/app/components/BackupRestore.test.tsx @@ -1,19 +1,28 @@ -import { render, screen, waitFor } from '@testing-library/react'; +import { fireEvent, render, screen, waitFor } from '@testing-library/react'; import { beforeEach, describe, expect, it, vi } from 'vitest'; import { TypedEventEmitter } from 'matrix-js-sdk/lib/models/typed-event-emitter'; -import type { CryptoApi, KeyBackupInfo } from '$types/matrix-sdk'; +import type * as MatrixSdk from '$types/matrix-sdk'; +import type { CryptoApi, CryptoBackend, KeyBackupInfo } from '$types/matrix-sdk'; import type { SecretStorageKeyContent } from '$types/matrix/accountData'; import { BackupRestoreTile } from './BackupRestore'; +const decodeRecoveryKey = vi.hoisted(() => vi.fn<(key: string) => Uint8Array>()); const emitter = new TypedEventEmitter void>>(); const mockClient = Object.assign(emitter, { secretStorage: { checkKey: vi.fn<() => Promise>().mockResolvedValue(true) }, + getSafeUserId: () => '@me:example.org', + getDeviceId: () => 'DEVICE', }); vi.mock('$hooks/useMatrixClient', () => ({ useMatrixClient: () => mockClient, })); +vi.mock('$types/matrix-sdk', async (importOriginal) => ({ + ...(await importOriginal()), + decodeRecoveryKey, +})); + vi.mock('$client/secretStorageKeys', () => ({ storePrivateKey: vi.fn<() => void>(), })); @@ -40,16 +49,31 @@ const createCrypto = ({ backupInfo = BACKUP_INFO, backupKey = null }: CryptoOver .fn() .mockResolvedValue({ trusted: true, matchesDecryptionKey: true }), restoreKeyBackup: vi.fn<() => Promise>().mockResolvedValue(undefined), + processDeviceLists: vi.fn().mockResolvedValue(undefined), + bootstrapCrossSigning: vi.fn().mockResolvedValue(undefined), + bootstrapSecretStorage: vi + .fn() + .mockResolvedValue(undefined), + setDeviceVerified: vi.fn().mockResolvedValue(undefined), loadSessionBackupPrivateKeyFromSecretStorage: vi .fn() .mockResolvedValue(undefined), - }) as unknown as CryptoApi; + }) as unknown as CryptoBackend; const recoveryPrompt = () => screen.queryByText(/does not hold the backup decryption key/i); +const submitRecoveryKey = (value: string) => { + const input = document.querySelector('form input') as HTMLInputElement; + fireEvent.change(input, { target: { value } }); + const form = input.closest('form') as HTMLFormElement; + Object.defineProperty(form, input.name, { value: input, configurable: true }); + fireEvent.submit(form); +}; + describe('BackupRestoreTile', () => { beforeEach(() => { vi.clearAllMocks(); + decodeRecoveryKey.mockReturnValue(new Uint8Array([1, 2, 3])); }); it('offers recovery when a backup exists but its key is not in the crypto store', async () => { @@ -65,6 +89,28 @@ describe('BackupRestoreTile', () => { expect(screen.getByText('Recovery Key')).toBeTruthy(); }); + it('restores cross-signing before unlocking the backup', async () => { + const crypto = createCrypto({ backupKey: null }); + render( + + ); + + await waitFor(() => expect(recoveryPrompt()).not.toBeNull()); + submitRecoveryKey('valid-key'); + + await waitFor(() => + expect(crypto.loadSessionBackupPrivateKeyFromSecretStorage).toHaveBeenCalled() + ); + expect(crypto.processDeviceLists).toHaveBeenCalledWith({ changed: ['@me:example.org'] }); + expect(crypto.bootstrapCrossSigning).toHaveBeenCalled(); + expect(crypto.setDeviceVerified).toHaveBeenCalledWith('@me:example.org', 'DEVICE'); + expect(crypto.loadSessionBackupPrivateKeyFromSecretStorage).toHaveBeenCalled(); + }); + it('stays out of the way once the key is cached', async () => { render( { storePrivateKey(secretStorageKeyId, recoveryKey); + + await cryptoBackend.processDeviceLists({ changed: [mx.getSafeUserId()] }); + await cryptoBackend.bootstrapCrossSigning({}); + await cryptoBackend.bootstrapSecretStorage({}); + + const deviceId = mx.getDeviceId(); + if (!deviceId) { + throw new Error('Unexpected Error! Current device ID not found.'); + } + await cryptoBackend.setDeviceVerified(mx.getSafeUserId(), deviceId); + // Emits KeyBackupDecryptionKeyCached, which drives the restore. await crypto.loadSessionBackupPrivateKeyFromSecretStorage(); }, - [crypto, secretStorageKeyId] + [crypto, cryptoBackend, mx, secretStorageKeyId] ) ); @@ -80,8 +94,8 @@ function BackupKeyRecovery({ return ( - This device does not hold the backup decryption key. Provide your recovery details to unlock - the backup and restore your message history. + This device does not hold the backup decryption key. Provide your recovery details to + restore device verification and unlock the backup.