Add `Recovery` section in the new user settings `Encryption` tab by florianduros · Pull Request #28673 · element-hq/element-web

florianduros · 2024-12-06T10:51:59Z

Checklist

Tests written for new code (and old code if feasible).
New or updated public/exported symbols have accurate TSDoc documentation.
Linter and other CI checks pass.
I have licensed the changes to Element by completing the Contributor License Agreement (CLA)

First of all, I'm sorry for the size of the PR.

Task #26468
Figma design
Add a new encryption tab with a new recovery section.

Implemented

Add the crypto team as code owner of this new encryption tab

The encryption tab has the following behaviour:

If the encryption is not setup, we display a verify button to launch the Set up encryption dialog. Only this button and his description is displayed. The user must verify his device or set up the encryption before playing with the encryption settings.
Otherwise, display the Recovery section (the Key storage and Advanced section in the future)
If the user want to set up or change the recovery key when clicking on the corresponding button of the recovery section, the content of the encryption tab is replaced by a breadcrumb to do it.

The recovery section has the following behaviour:

If the recovery key is not setup, we ask to setup a recovery key
If the secrets (cross-signing keys) are not cached locally, we ask to enter the recovery key
Otherwise, display the "change recovery key" button

Not implemented

This PR DON'T (because the PR is already massive and theses tasks should be done in other PRs):

Implement the "Key storage is out of sync" toast
Implement the new "Enter your recovery key" dialog and the "Forgot your recovery key? You’ll need to reset your identity." dialog
Add dot to the User settings tab

…sKeyBackup`

…ient.getCrypto().checkKeyBackupAndEnable` to know if we need to set up a recovery key

# Conflicts: # playwright/snapshots/settings/account-user-settings-tab.spec.ts/account-linux.png # playwright/snapshots/settings/account-user-settings-tab.spec.ts/account-smallscreen-linux.png

richvdh · 2025-01-13T13:03:18Z

 * - `save_key_setup_flow`: The user is asked to save the new recovery key during the setup flow.
 * - `save_key_change_flow`: The user is asked to save the new recovery key during the change key flow.
- * - `confirm`: The user is asked to confirm the new recovery key.
+ * - `confirm_key_setup_flow`: The user is asked to confirm the new recovery key during the set up flow.
+ * - `confirm_key_change_flow`: The user is asked to confirm the new recovery key during the change key flow.


I have to say, I wonder if it wouldn't be simpler to just have three states (inform_user, save_key, confirm_key) and distinguish between the two flows by looking at the userHasRecoveryKey prop.

On the other hand, we should probably just get on and land this rather than messing with it forever. A thought for the future though.

richvdh · 2025-01-15T11:46:22Z

 * - `secrets_not_cached`: The user has a backup but the secrets are not cached.
- *                         This shouldn't happen but we have seen cases where the secrets gossiping failed or shared partial secrets when verified with another device.
- * - `good`: The user has a backup and the secrets are cached.
+ *                         This can happen if we verified another device and secret-gossiping failed, or the other device itself lacked the secrets.


It's worth noting that this indentation is lost if/when the tsdoc is rendered to HTML, and is inconsistent with our style elsewhere.

But, not a big problem. Something to consider for the future.

richvdh

🚢

florianduros added the T-Enhancement label Dec 6, 2024

florianduros force-pushed the florianduros/encryption-tab branch 3 times, most recently from 7ee9a42 to a90f51f Compare December 6, 2024 11:06

github-actions Bot deployed to EndToEndTests December 6, 2024 11:21 View deployment

github-actions Bot deployed to Netlify December 6, 2024 11:21 View deployment

florianduros force-pushed the florianduros/encryption-tab branch from a90f51f to b3dc812 Compare December 6, 2024 14:19

github-actions Bot deployed to Netlify December 6, 2024 14:32 View deployment

github-actions Bot deployed to EndToEndTests December 6, 2024 14:32 View deployment

florianduros force-pushed the florianduros/encryption-tab branch from b3dc812 to 98d86e0 Compare December 6, 2024 16:21

github-actions Bot deployed to Netlify December 6, 2024 16:34 View deployment

github-actions Bot deployed to EndToEndTests December 6, 2024 16:34 View deployment

florianduros force-pushed the florianduros/encryption-tab branch from 98d86e0 to 2710462 Compare December 10, 2024 15:02

github-actions Bot deployed to EndToEndTests December 10, 2024 15:18 View deployment

github-actions Bot deployed to Netlify December 10, 2024 15:19 View deployment

florianduros force-pushed the florianduros/encryption-tab branch from 2710462 to 5e31204 Compare December 11, 2024 14:30

github-actions Bot deployed to Netlify December 11, 2024 14:43 View deployment

github-actions Bot deployed to EndToEndTests December 11, 2024 14:43 View deployment

florianduros force-pushed the florianduros/encryption-tab branch from 5e31204 to 54ede8b Compare December 11, 2024 14:49

github-actions Bot deployed to Netlify December 11, 2024 15:02 View deployment

github-actions Bot deployed to EndToEndTests December 11, 2024 15:02 View deployment

florianduros force-pushed the florianduros/encryption-tab branch from 54ede8b to 1811aa6 Compare December 11, 2024 17:22

github-actions Bot deployed to Netlify December 11, 2024 17:36 View deployment

github-actions Bot deployed to EndToEndTests December 11, 2024 17:36 View deployment

florianduros force-pushed the florianduros/encryption-tab branch 5 times, most recently from 97b9f95 to 9aecfcc Compare December 12, 2024 09:16

github-actions Bot deployed to Netlify December 12, 2024 09:30 View deployment

florianduros added 3 commits January 6, 2025 15:31

Rename ChangeRecoveryKey.isSetupFlow into `ChangeRecoveryKey.userHa…

a0d904e

…sKeyBackup`

Move deleteCachedSecrets fixture in recovery.spec.ts

1a0e6dc

Use one callback instead of two in RecoveryPanel

0b254e5

dbkr reviewed Jan 7, 2025

View reviewed changes

Comment thread src/components/views/settings/encryption/RecoveryPanel.tsx Outdated

florianduros added 3 commits January 8, 2025 10:53

Fix docs and naming of utils.createBot

6f236bd

Fix typo in RecoveryPanel

82bf2cc

Add more doc to the state of the EncryptionUserSettingsTab

84d11f8

florianduros mentioned this pull request Jan 8, 2025

Replace the "Encryption" settings with a new settings tab #26468

Closed

9 tasks

florianduros and others added 4 commits January 8, 2025 11:43

Rename verification_required into set_up_encryption

2fe5555

Merge branch 'develop' into florianduros/encryption-tab

4b365ba

Update test

8a9291a

ADd new license

1c00502

richvdh requested changes Jan 8, 2025

View reviewed changes

florianduros added 8 commits January 9, 2025 11:58

Update comments and doc

dc940f5

Assert that recoveryKey.encodedPrivateKey is always defined

521cebf

Add comments to explain how the secrets could be uncached

7af44cc

Use matrixClient.secretStorage.getDefaultKeyId instead of `matrixCl…

8bd5d6a

…ient.getCrypto().checkKeyBackupAndEnable` to know if we need to set up a recovery key

Merge branch 'develop' into florianduros/encryption-tab

086f28e

# Conflicts: # playwright/snapshots/settings/account-user-settings-tab.spec.ts/account-linux.png # playwright/snapshots/settings/account-user-settings-tab.spec.ts/account-smallscreen-linux.png

Update existing screenshot to add encryption tab.

0c18708

Update tests

0a52b7c

Use new labels when changing the recovery key

e5dea48

richvdh reviewed Jan 13, 2025

View reviewed changes

florianduros added 2 commits January 13, 2025 14:52

Fix docs

f78c27a

Don't reset key backup when creating a recovery key

bef3165

richvdh reviewed Jan 15, 2025

View reviewed changes

Fix doc

ae163d1

richvdh approved these changes Jan 15, 2025

View reviewed changes

Merge branch 'develop' into florianduros/encryption-tab

ee4f3a8

This was referenced Oct 6, 2025

New Element Web release v1.12.0 grueneschweiz/element-web-apache#1

Closed

New Element Web release v1.12.0 grueneschweiz/element-web-apache#2

Closed

Uh oh!

Conversation

florianduros commented Dec 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Implemented

Not implemented

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

richvdh Jan 13, 2025

Choose a reason for hiding this comment

Uh oh!

richvdh Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

richvdh left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

florianduros commented Dec 6, 2024 •

edited

Loading

richvdh Jan 15, 2025 •

edited

Loading