From f54bac0e951584feeba4fefda9f3c02d1191bf90 Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 29 May 2020 15:42:07 +0100 Subject: [PATCH 01/12] Use recovery keys over passphrases Step 1 - change CreateSecretStorageDialog to just give a recovery key rather than a passphrase. --- .../_CreateSecretStorageDialog.scss | 35 +- .../CreateSecretStorageDialog.js | 438 +++++------------- src/i18n/strings/en_EN.json | 34 +- 3 files changed, 151 insertions(+), 356 deletions(-) diff --git a/res/css/views/dialogs/secretstorage/_CreateSecretStorageDialog.scss b/res/css/views/dialogs/secretstorage/_CreateSecretStorageDialog.scss index 63e5a3de09..9f1d0f4998 100644 --- a/res/css/views/dialogs/secretstorage/_CreateSecretStorageDialog.scss +++ b/res/css/views/dialogs/secretstorage/_CreateSecretStorageDialog.scss @@ -73,33 +73,42 @@ limitations under the License. margin-left: 20px; } -.mx_CreateSecretStorageDialog_recoveryKeyHeader { - margin-bottom: 1em; -} - .mx_CreateSecretStorageDialog_recoveryKeyContainer { - display: flex; + width: 380px; + margin-left: auto; + margin-right: auto; } .mx_CreateSecretStorageDialog_recoveryKey { - width: 262px; + font-weight: bold; + text-align: center; padding: 20px; color: $info-plinth-fg-color; background-color: $info-plinth-bg-color; - margin-right: 12px; + border-radius: 6px; + word-spacing: 1em; + margin-bottom: 20px; } .mx_CreateSecretStorageDialog_recoveryKeyButtons { - flex: 1; display: flex; + justify-content: space-between; align-items: center; } .mx_CreateSecretStorageDialog_recoveryKeyButtons .mx_AccessibleButton { - margin-right: 10px; -} - -.mx_CreateSecretStorageDialog_recoveryKeyButtons button { - flex: 1; + width: 160px; + padding-left: 0px; + padding-right: 0px; white-space: nowrap; } + +.mx_CreateSecretStorageDialog_continueSpinner { + margin-top: 33px; + text-align: right; +} + +.mx_CreateSecretStorageDialog_continueSpinner img { + width: 20px; + height: 20px; +} diff --git a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js index e6ab07c449..44e00d79cd 100644 --- a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js +++ b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js @@ -20,25 +20,19 @@ import PropTypes from 'prop-types'; import * as sdk from '../../../../index'; import {MatrixClientPeg} from '../../../../MatrixClientPeg'; import FileSaver from 'file-saver'; -import {_t, _td} from '../../../../languageHandler'; +import {_t} from '../../../../languageHandler'; import Modal from '../../../../Modal'; import { promptForBackupPassphrase } from '../../../../CrossSigningManager'; import {copyNode} from "../../../../utils/strings"; import {SSOAuthEntry} from "../../../../components/views/auth/InteractiveAuthEntryComponents"; -import PassphraseField from "../../../../components/views/auth/PassphraseField"; const PHASE_LOADING = 0; const PHASE_LOADERROR = 1; const PHASE_MIGRATE = 2; -const PHASE_PASSPHRASE = 3; -const PHASE_PASSPHRASE_CONFIRM = 4; -const PHASE_SHOWKEY = 5; -const PHASE_KEEPITSAFE = 6; -const PHASE_STORING = 7; -const PHASE_DONE = 8; -const PHASE_CONFIRM_SKIP = 9; - -const PASSWORD_MIN_SCORE = 4; // So secure, many characters, much complex, wow, etc, etc. +const PHASE_INTRO = 3; +const PHASE_SHOWKEY = 4; +const PHASE_STORING = 5; +const PHASE_CONFIRM_SKIP = 6; /* * Walks the user through the process of creating a passphrase to guard Secure @@ -65,34 +59,26 @@ export default class CreateSecretStorageDialog extends React.PureComponent { this.state = { phase: PHASE_LOADING, - passPhrase: '', - passPhraseValid: false, - passPhraseConfirm: '', - copied: false, downloaded: false, + copied: false, backupInfo: null, + backupInfoFetched: false, + backupInfoFetchError: null, backupSigStatus: null, // does the server offer a UI auth flow with just m.login.password - // for /keys/device_signing/upload? - canUploadKeysWithPasswordOnly: null, + // for /keys/device_signing/upload? (If we have an account password, we + // assume that it can) + canUploadKeysWithPasswordOnly: Boolean(this.state.accountPassword), + canUploadKeyCheckInProgress: false, accountPassword: props.accountPassword || "", accountPasswordCorrect: null, - // status of the key backup toggle switch + // No toggle for this: if we really don't want one, remove it & just hard code true useKeyBackup: true, }; this._passphraseField = createRef(); - this._fetchBackupInfo(); - if (this.state.accountPassword) { - // If we have an account password in memory, let's simplify and - // assume it means password auth is also supported for device - // signing key upload as well. This avoids hitting the server to - // test auth flows, which may be slow under high load. - this.state.canUploadKeysWithPasswordOnly = true; - } else { - this._queryKeyUploadAuth(); - } + this.loadData(); MatrixClientPeg.get().on('crypto.keyBackupStatus', this._onKeyBackupStatusChange); } @@ -109,13 +95,11 @@ export default class CreateSecretStorageDialog extends React.PureComponent { MatrixClientPeg.get().isCryptoEnabled() && await MatrixClientPeg.get().isKeyBackupTrusted(backupInfo) ); - const { force } = this.props; - const phase = (backupInfo && !force) ? PHASE_MIGRATE : PHASE_PASSPHRASE; - this.setState({ - phase, + backupInfoFetched: true, backupInfo, backupSigStatus, + backupInfoFetchError: null, }); return { @@ -123,20 +107,25 @@ export default class CreateSecretStorageDialog extends React.PureComponent { backupSigStatus, }; } catch (e) { - this.setState({phase: PHASE_LOADERROR}); + this.setState({backupInfoFetchError: e}); } } async _queryKeyUploadAuth() { try { + this.setState({canUploadKeyCheckInProgress: true}); await MatrixClientPeg.get().uploadDeviceSigningKeys(null, {}); // We should never get here: the server should always require // UI auth to upload device signing keys. If we do, we upload // no keys which would be a no-op. console.log("uploadDeviceSigningKeys unexpectedly succeeded without UI auth!"); + this.setState({canUploadKeyCheckInProgress: false}); } catch (error) { if (!error.data || !error.data.flows) { console.log("uploadDeviceSigningKeys advertised no flows!"); + this.setState({ + canUploadKeyCheckInProgress: false, + }); return; } const canUploadKeysWithPasswordOnly = error.data.flows.some(f => { @@ -144,10 +133,18 @@ export default class CreateSecretStorageDialog extends React.PureComponent { }); this.setState({ canUploadKeysWithPasswordOnly, + canUploadKeyCheckInProgress: false, }); } } + async _createRecoveryKey() { + this._recoveryKey = await MatrixClientPeg.get().createRecoveryKeyFromPassphrase(); + this.setState({ + phase: PHASE_SHOWKEY, + }); + } + _onKeyBackupStatusChange = () => { if (this.state.phase === PHASE_MIGRATE) this._fetchBackupInfo(); } @@ -156,12 +153,6 @@ export default class CreateSecretStorageDialog extends React.PureComponent { this._recoveryKeyNode = n; } - _onUseKeyBackupChange = (enabled) => { - this.setState({ - useKeyBackup: enabled, - }); - } - _onMigrateFormSubmit = (e) => { e.preventDefault(); if (this.state.backupSigStatus.usable) { @@ -171,12 +162,15 @@ export default class CreateSecretStorageDialog extends React.PureComponent { } } + _onIntroContinueClick = () => { + this._createRecoveryKey(); + } + _onCopyClick = () => { const successful = copyNode(this._recoveryKeyNode); if (successful) { this.setState({ copied: true, - phase: PHASE_KEEPITSAFE, }); } } @@ -186,10 +180,8 @@ export default class CreateSecretStorageDialog extends React.PureComponent { type: 'text/plain;charset=us-ascii', }); FileSaver.saveAs(blob, 'recovery-key.txt'); - this.setState({ downloaded: true, - phase: PHASE_KEEPITSAFE, }); } @@ -244,7 +236,9 @@ export default class CreateSecretStorageDialog extends React.PureComponent { _bootstrapSecretStorage = async () => { this.setState({ - phase: PHASE_STORING, + // we use LOADING here rather than STORING as STORING still shows the 'show key' + // screen which is not relevant: LOADING is just a generic spinner. + phase: PHASE_LOADING, error: null, }); @@ -285,9 +279,7 @@ export default class CreateSecretStorageDialog extends React.PureComponent { }, }); } - this.setState({ - phase: PHASE_DONE, - }); + this.props.onFinished(true); } catch (e) { if (this.state.canUploadKeysWithPasswordOnly && e.httpStatus === 401 && e.data.flows) { this.setState({ @@ -306,10 +298,6 @@ export default class CreateSecretStorageDialog extends React.PureComponent { this.props.onFinished(false); } - _onDone = () => { - this.props.onFinished(true); - } - _restoreBackup = async () => { // It's possible we'll need the backup key later on for bootstrapping, // so let's stash it here, rather than prompting for it twice. @@ -336,90 +324,35 @@ export default class CreateSecretStorageDialog extends React.PureComponent { } } + _onShowKeyContinueClick = () => { + this._bootstrapSecretStorage(); + } + _onLoadRetryClick = () => { + this.loadData(); + } + + async loadData() { this.setState({phase: PHASE_LOADING}); - this._fetchBackupInfo(); + const proms = []; + + if (!this.state.backupInfoFetched) proms.push(this._fetchBackupInfo()); + if (this.state.canUploadKeysWithPasswordOnly === null) proms.push(this._queryKeyUploadAuth()); + + await Promise.all(proms); + if (this.state.canUploadKeysWithPasswordOnly === null || this.state.backupInfoFetchError) { + this.setState({phase: PHASE_LOADERROR}); + } else if (this.state.backupInfo && !this.props.force) { + this.setState({phase: PHASE_MIGRATE}); + } else { + this.setState({phase: PHASE_INTRO}); + } } _onSkipSetupClick = () => { this.setState({phase: PHASE_CONFIRM_SKIP}); } - _onSetUpClick = () => { - this.setState({phase: PHASE_PASSPHRASE}); - } - - _onSkipPassPhraseClick = async () => { - this._recoveryKey = - await MatrixClientPeg.get().createRecoveryKeyFromPassphrase(); - this.setState({ - copied: false, - downloaded: false, - phase: PHASE_SHOWKEY, - }); - } - - _onPassPhraseNextClick = async (e) => { - e.preventDefault(); - if (!this._passphraseField.current) return; // unmounting - - await this._passphraseField.current.validate({ allowEmpty: false }); - if (!this._passphraseField.current.state.valid) { - this._passphraseField.current.focus(); - this._passphraseField.current.validate({ allowEmpty: false, focused: true }); - return; - } - - this.setState({phase: PHASE_PASSPHRASE_CONFIRM}); - }; - - _onPassPhraseConfirmNextClick = async (e) => { - e.preventDefault(); - - if (this.state.passPhrase !== this.state.passPhraseConfirm) return; - - this._recoveryKey = - await MatrixClientPeg.get().createRecoveryKeyFromPassphrase(this.state.passPhrase); - this.setState({ - copied: false, - downloaded: false, - phase: PHASE_SHOWKEY, - }); - } - - _onSetAgainClick = () => { - this.setState({ - passPhrase: '', - passPhraseValid: false, - passPhraseConfirm: '', - phase: PHASE_PASSPHRASE, - }); - } - - _onKeepItSafeBackClick = () => { - this.setState({ - phase: PHASE_SHOWKEY, - }); - } - - _onPassPhraseValidate = (result) => { - this.setState({ - passPhraseValid: result.valid, - }); - }; - - _onPassPhraseChange = (e) => { - this.setState({ - passPhrase: e.target.value, - }); - } - - _onPassPhraseConfirmChange = (e) => { - this.setState({ - passPhraseConfirm: e.target.value, - }); - } - _onAccountPasswordChange = (e) => { this.setState({ accountPassword: e.target.value, @@ -437,7 +370,12 @@ export default class CreateSecretStorageDialog extends React.PureComponent { let authPrompt; let nextCaption = _t("Next"); - if (this.state.canUploadKeysWithPasswordOnly) { + if (!this.state.backupSigStatus.usable) { + authPrompt =
+
{_t("Restore your key backup to upgrade your encryption")}
+
; + nextCaption = _t("Restore"); + } else if (this.state.canUploadKeysWithPasswordOnly && !this.state.accountPassword) { authPrompt =
{_t("Enter your account password to confirm the upgrade:")}
; - } else if (!this.state.backupSigStatus.usable) { - authPrompt =
-
{_t("Restore your key backup to upgrade your encryption")}
-
; - nextCaption = _t("Restore"); } else { authPrompt =

{_t("You'll need to authenticate with the server to confirm the upgrade.")} @@ -480,185 +413,53 @@ export default class CreateSecretStorageDialog extends React.PureComponent { ; } - _renderPhasePassPhrase() { - const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); - const AccessibleButton = sdk.getComponent('elements.AccessibleButton'); - const LabelledToggleSwitch = sdk.getComponent('views.elements.LabelledToggleSwitch'); - - return

-

{_t( - "Set a recovery passphrase to secure encrypted information and recover it if you log out. " + - "This should be different to your account password:", - )}

- -
- -
- - - - - - - -
- {_t("Advanced")} - - {_t("Set up with a recovery key")} - -
- ; - } - - _renderPhasePassPhraseConfirm() { - const AccessibleButton = sdk.getComponent('elements.AccessibleButton'); - const Field = sdk.getComponent('views.elements.Field'); - - let matchText; - let changeText; - if (this.state.passPhraseConfirm === this.state.passPhrase) { - matchText = _t("That matches!"); - changeText = _t("Use a different passphrase?"); - } else if (!this.state.passPhrase.startsWith(this.state.passPhraseConfirm)) { - // only tell them they're wrong if they've actually gone wrong. - // Security concious readers will note that if you left riot-web unattended - // on this screen, this would make it easy for a malicious person to guess - // your passphrase one letter at a time, but they could get this faster by - // just opening the browser's developer tools and reading it. - // Note that not having typed anything at all will not hit this clause and - // fall through so empty box === no hint. - matchText = _t("That doesn't match."); - changeText = _t("Go back to set it again."); - } - - let passPhraseMatch = null; - if (matchText) { - passPhraseMatch =
-
{matchText}
-
- - {changeText} - -
-
; - } - const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); - return
-

{_t( - "Enter your recovery passphrase a second time to confirm it.", - )}

-
- -
- {passPhraseMatch} -
-
- - - -
; - } - _renderPhaseShowKey() { const AccessibleButton = sdk.getComponent('elements.AccessibleButton'); + const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); + const InlineSpinner = sdk.getComponent("elements.InlineSpinner"); + + let continueButton; + if (this.state.phase === PHASE_SHOWKEY) { + continueButton = ; + } else { + continueButton =
+ +
; + } + return

{_t( - "Your recovery key is a safety net - you can use it to restore " + - "access to your encrypted messages if you forget your recovery passphrase.", - )}

-

{_t( - "Keep a copy of it somewhere secure, like a password manager or even a safe.", + "Store your Recovery Key somewhere safe, it can be used to unlock your encrypted messages & data.", )}

-
- {_t("Your recovery key")} -
{this._recoveryKey.encodedPrivateKey}
+ + {_t("Download")} + + {_t("or")} - {_t("Copy")} - - - {_t("Download")} + {this.state.copied ? _t("Copied!") : _t("Copy")}
-
; - } - - _renderPhaseKeepItSafe() { - let introText; - if (this.state.copied) { - introText = _t( - "Your recovery key has been copied to your clipboard, paste it to:", - {}, {b: s => {s}}, - ); - } else if (this.state.downloaded) { - introText = _t( - "Your recovery key is in your Downloads folder.", - {}, {b: s => {s}}, - ); - } - const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); - return
- {introText} -
    -
  • {_t("Print it and store it somewhere safe", {}, {b: s => {s}})}
    • -
  • {_t("Save it on a USB key or backup drive", {}, {b: s => {s}})}
    • -
  • {_t("Copy it to your personal cloud storage", {}, {b: s => {s}})}
    • -
- - - + {continueButton}
; } @@ -666,8 +467,8 @@ export default class CreateSecretStorageDialog extends React.PureComponent { const Spinner = sdk.getComponent('views.elements.Spinner'); return
-
; - } + ; + } _renderPhaseLoadError() { const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); @@ -683,17 +484,21 @@ export default class CreateSecretStorageDialog extends React.PureComponent { ; } - _renderPhaseDone() { + _renderPhaseIntro() { const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); return

{_t( - "You can now verify your other devices, " + - "and other users to keep your chats safe.", + "Create a Recovery Key to store encryption keys & secrets with your account data. " + + "If you lose access to this login you’ll need it to unlock your data.", )}

- +
+ + + +
; } @@ -715,21 +520,15 @@ export default class CreateSecretStorageDialog extends React.PureComponent { _titleForPhase(phase) { switch (phase) { + case PHASE_INTRO: + return _t('Create a Recovery Key'); case PHASE_MIGRATE: return _t('Upgrade your encryption'); - case PHASE_PASSPHRASE: - return _t('Set up encryption'); - case PHASE_PASSPHRASE_CONFIRM: - return _t('Confirm recovery passphrase'); case PHASE_CONFIRM_SKIP: return _t('Are you sure?'); case PHASE_SHOWKEY: - case PHASE_KEEPITSAFE: - return _t('Make a copy of your recovery key'); case PHASE_STORING: - return _t('Setting up keys'); - case PHASE_DONE: - return _t("You're done!"); + return _t('Store your Recovery Key'); default: return ''; } @@ -759,26 +558,15 @@ export default class CreateSecretStorageDialog extends React.PureComponent { case PHASE_LOADERROR: content = this._renderPhaseLoadError(); break; + case PHASE_INTRO: + content = this._renderPhaseIntro(); + break; case PHASE_MIGRATE: content = this._renderPhaseMigrate(); break; - case PHASE_PASSPHRASE: - content = this._renderPhasePassPhrase(); - break; - case PHASE_PASSPHRASE_CONFIRM: - content = this._renderPhasePassPhraseConfirm(); - break; case PHASE_SHOWKEY: - content = this._renderPhaseShowKey(); - break; - case PHASE_KEEPITSAFE: - content = this._renderPhaseKeepItSafe(); - break; case PHASE_STORING: - content = this._renderBusyPhase(); - break; - case PHASE_DONE: - content = this._renderPhaseDone(); + content = this._renderPhaseShowKey(); break; case PHASE_CONFIRM_SKIP: content = this._renderPhaseSkipConfirm(); @@ -796,7 +584,7 @@ export default class CreateSecretStorageDialog extends React.PureComponent { onFinished={this.props.onFinished} title={this._titleForPhase(this.state.phase)} headerImage={headerImage} - hasCancel={this.props.hasCancel && [PHASE_PASSPHRASE].includes(this.state.phase)} + hasCancel={this.props.hasCancel} fixedWidth={false} >
diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json index dc583d8d9a..3b86c21015 100644 --- a/src/i18n/strings/en_EN.json +++ b/src/i18n/strings/en_EN.json @@ -2187,43 +2187,41 @@ "Restore": "Restore", "You'll need to authenticate with the server to confirm the upgrade.": "You'll need to authenticate with the server to confirm the upgrade.", "Upgrade this session to allow it to verify other sessions, granting them access to encrypted messages and marking them as trusted for other users.": "Upgrade this session to allow it to verify other sessions, granting them access to encrypted messages and marking them as trusted for other users.", - "Set a recovery passphrase to secure encrypted information and recover it if you log out. This should be different to your account password:": "Set a recovery passphrase to secure encrypted information and recover it if you log out. This should be different to your account password:", + "Store your Recovery Key somewhere safe, it can be used to unlock your encrypted messages & data.": "Store your Recovery Key somewhere safe, it can be used to unlock your encrypted messages & data.", + "Download": "Download", + "Copy": "Copy", + "Unable to query secret storage status": "Unable to query secret storage status", + "Retry": "Retry", + "Create a Recovery Key to store encryption keys & secrets with your account data. If you lose access to this login you’ll need it to unlock your data.": "Create a Recovery Key to store encryption keys & secrets with your account data. If you lose access to this login you’ll need it to unlock your data.", + "Create a Recovery Key": "Create a Recovery Key", + "Upgrade your encryption": "Upgrade your encryption", + "Store your Recovery Key": "Store your Recovery Key", + "Unable to set up secret storage": "Unable to set up secret storage", + "We'll store an encrypted copy of your keys on our server. Secure your backup with a recovery passphrase.": "We'll store an encrypted copy of your keys on our server. Secure your backup with a recovery passphrase.", + "For maximum security, this should be different from your account password.": "For maximum security, this should be different from your account password.", "Enter a recovery passphrase": "Enter a recovery passphrase", "Great! This recovery passphrase looks strong enough.": "Great! This recovery passphrase looks strong enough.", - "Back up encrypted message keys": "Back up encrypted message keys", "Set up with a recovery key": "Set up with a recovery key", "That matches!": "That matches!", "Use a different passphrase?": "Use a different passphrase?", "That doesn't match.": "That doesn't match.", "Go back to set it again.": "Go back to set it again.", - "Enter your recovery passphrase a second time to confirm it.": "Enter your recovery passphrase a second time to confirm it.", - "Confirm your recovery passphrase": "Confirm your recovery passphrase", + "Please enter your recovery passphrase a second time to confirm.": "Please enter your recovery passphrase a second time to confirm.", + "Repeat your recovery passphrase...": "Repeat your recovery passphrase...", "Your recovery key is a safety net - you can use it to restore access to your encrypted messages if you forget your recovery passphrase.": "Your recovery key is a safety net - you can use it to restore access to your encrypted messages if you forget your recovery passphrase.", "Keep a copy of it somewhere secure, like a password manager or even a safe.": "Keep a copy of it somewhere secure, like a password manager or even a safe.", "Your recovery key": "Your recovery key", - "Copy": "Copy", - "Download": "Download", "Your recovery key has been copied to your clipboard, paste it to:": "Your recovery key has been copied to your clipboard, paste it to:", "Your recovery key is in your Downloads folder.": "Your recovery key is in your Downloads folder.", "Print it and store it somewhere safe": "Print it and store it somewhere safe", "Save it on a USB key or backup drive": "Save it on a USB key or backup drive", "Copy it to your personal cloud storage": "Copy it to your personal cloud storage", - "Unable to query secret storage status": "Unable to query secret storage status", - "Retry": "Retry", - "You can now verify your other devices, and other users to keep your chats safe.": "You can now verify your other devices, and other users to keep your chats safe.", - "Upgrade your encryption": "Upgrade your encryption", - "Confirm recovery passphrase": "Confirm recovery passphrase", - "Make a copy of your recovery key": "Make a copy of your recovery key", - "You're done!": "You're done!", - "Unable to set up secret storage": "Unable to set up secret storage", - "We'll store an encrypted copy of your keys on our server. Secure your backup with a recovery passphrase.": "We'll store an encrypted copy of your keys on our server. Secure your backup with a recovery passphrase.", - "For maximum security, this should be different from your account password.": "For maximum security, this should be different from your account password.", - "Please enter your recovery passphrase a second time to confirm.": "Please enter your recovery passphrase a second time to confirm.", - "Repeat your recovery passphrase...": "Repeat your recovery passphrase...", "Your keys are being backed up (the first backup could take a few minutes).": "Your keys are being backed up (the first backup could take a few minutes).", "Without setting up Secure Message Recovery, you won't be able to restore your encrypted message history if you log out or use another session.": "Without setting up Secure Message Recovery, you won't be able to restore your encrypted message history if you log out or use another session.", "Set up Secure Message Recovery": "Set up Secure Message Recovery", "Secure your backup with a recovery passphrase": "Secure your backup with a recovery passphrase", + "Confirm your recovery passphrase": "Confirm your recovery passphrase", + "Make a copy of your recovery key": "Make a copy of your recovery key", "Starting backup...": "Starting backup...", "Success!": "Success!", "Create key backup": "Create key backup", From 631184c661aa74150d5ff1e1eff1959103a1e8cf Mon Sep 17 00:00:00 2001 From: David Baker Date: Fri, 29 May 2020 15:55:16 +0100 Subject: [PATCH 02/12] Fix upgrading with already trusted backup --- .../dialogs/secretstorage/CreateSecretStorageDialog.js | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js index 44e00d79cd..2147f2c8a8 100644 --- a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js +++ b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js @@ -68,7 +68,7 @@ export default class CreateSecretStorageDialog extends React.PureComponent { // does the server offer a UI auth flow with just m.login.password // for /keys/device_signing/upload? (If we have an account password, we // assume that it can) - canUploadKeysWithPasswordOnly: Boolean(this.state.accountPassword), + canUploadKeysWithPasswordOnly: null, canUploadKeyCheckInProgress: false, accountPassword: props.accountPassword || "", accountPasswordCorrect: null, @@ -76,6 +76,12 @@ export default class CreateSecretStorageDialog extends React.PureComponent { useKeyBackup: true, }; + if (props.accountPassword) { + // If we have an account password, we assume we can upload keys with + // just a password (otherwise leave it as null so we poll to check) + this.state.canUploadKeysWithPasswordOnly = true; + } + this._passphraseField = createRef(); this.loadData(); @@ -375,7 +381,7 @@ export default class CreateSecretStorageDialog extends React.PureComponent {
{_t("Restore your key backup to upgrade your encryption")}
; nextCaption = _t("Restore"); - } else if (this.state.canUploadKeysWithPasswordOnly && !this.state.accountPassword) { + } else if (this.state.canUploadKeysWithPasswordOnly && !this.props.accountPassword) { authPrompt =
{_t("Enter your account password to confirm the upgrade:")}
Date: Tue, 2 Jun 2020 16:32:15 +0100 Subject: [PATCH 03/12] Prompt for recovery key on login rather than passphrase Only show passphrase options at all if the user has a passphrase on their SSSS key. --- .../structures/auth/_CompleteSecurity.scss | 4 + src/CrossSigningManager.js | 20 ++- .../structures/auth/CompleteSecurity.js | 4 + .../structures/auth/SetupEncryptionBody.js | 137 +++++++++++++++++- .../keybackup/RestoreKeyBackupDialog.js | 2 +- .../AccessSecretStorageDialog.js | 9 +- .../views/settings/CrossSigningPanel.js | 2 +- src/i18n/strings/en_EN.json | 11 +- src/stores/SetupEncryptionStore.js | 55 ++++++- 9 files changed, 224 insertions(+), 20 deletions(-) diff --git a/res/css/structures/auth/_CompleteSecurity.scss b/res/css/structures/auth/_CompleteSecurity.scss index f742be70e4..7dba57305f 100644 --- a/res/css/structures/auth/_CompleteSecurity.scss +++ b/res/css/structures/auth/_CompleteSecurity.scss @@ -70,6 +70,10 @@ limitations under the License. } } +.mx_CompleteSecurity_recoveryKeyInput { + width: 368px; +} + .mx_CompleteSecurity_heroIcon { width: 128px; height: 128px; diff --git a/src/CrossSigningManager.js b/src/CrossSigningManager.js index c37d0f8bf5..d40f820ac0 100644 --- a/src/CrossSigningManager.js +++ b/src/CrossSigningManager.js @@ -30,6 +30,8 @@ import {encodeBase64} from "matrix-js-sdk/src/crypto/olmlib"; // operation ends. let secretStorageKeys = {}; let secretStorageBeingAccessed = false; +// Stores the 'passphraseOnly' option for the active storage access operation +let passphraseOnlyOption = null; function isCachingAllowed() { return ( @@ -99,6 +101,7 @@ async function getSecretStorageKey({ keys: keyInfos }, ssssItemName) { const key = await inputToKey(input); return await MatrixClientPeg.get().checkSecretStorageKey(key, info); }, + passphraseOnly: passphraseOnlyOption, }, /* className= */ null, /* isPriorityModal= */ false, @@ -213,19 +216,27 @@ export async function promptForBackupPassphrase() { * * @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 {object} [opts] Named options + * @param {bool} [opts.forceReset] Reset secret storage even if it's already set up + * @param {object} [opts.withKeys] Map of key ID to key for SSSS keys that the client + * already has available. If a key is not supplied here, the user will be prompted. + * @param {bool} [opts.passphraseOnly] If true, do not prompt for recovery key or to reset keys */ -export async function accessSecretStorage(func = async () => { }, forceReset = false) { +export async function accessSecretStorage( + func = async () => { }, opts = {}, +) { const cli = MatrixClientPeg.get(); secretStorageBeingAccessed = true; + passphraseOnlyOption = opts.passphraseOnly; + secretStorageKeys = Object.assign({}, opts.withKeys || {}); try { - if (!await cli.hasSecretStorageKey() || forceReset) { + if (!await cli.hasSecretStorageKey() || opts.forceReset) { // This dialog calls bootstrap itself after guiding the user through // passphrase creation. const { finished } = Modal.createTrackedDialogAsync('Create Secret Storage dialog', '', import("./async-components/views/dialogs/secretstorage/CreateSecretStorageDialog"), { - force: forceReset, + force: opts.forceReset, }, null, /* priority = */ false, /* static = */ true, ); @@ -263,5 +274,6 @@ export async function accessSecretStorage(func = async () => { }, forceReset = f if (!isCachingAllowed()) { secretStorageKeys = {}; } + passphraseOnlyOption = null; } } diff --git a/src/components/structures/auth/CompleteSecurity.js b/src/components/structures/auth/CompleteSecurity.js index c73691611d..e38ecd3eac 100644 --- a/src/components/structures/auth/CompleteSecurity.js +++ b/src/components/structures/auth/CompleteSecurity.js @@ -21,6 +21,7 @@ import * as sdk from '../../../index'; import { SetupEncryptionStore, PHASE_INTRO, + PHASE_RECOVERY_KEY, PHASE_BUSY, PHASE_DONE, PHASE_CONFIRM_SKIP, @@ -61,6 +62,9 @@ export default class CompleteSecurity extends React.Component { if (phase === PHASE_INTRO) { icon = ; title = _t("Verify this login"); + } else if (phase === PHASE_RECOVERY_KEY) { + icon = ; + title = _t("Recovery Key"); } else if (phase === PHASE_DONE) { icon = ; title = _t("Session verified"); diff --git a/src/components/structures/auth/SetupEncryptionBody.js b/src/components/structures/auth/SetupEncryptionBody.js index 26534c6e02..cc454b865f 100644 --- a/src/components/structures/auth/SetupEncryptionBody.js +++ b/src/components/structures/auth/SetupEncryptionBody.js @@ -19,15 +19,26 @@ import PropTypes from 'prop-types'; import { _t } from '../../../languageHandler'; import { MatrixClientPeg } from '../../../MatrixClientPeg'; import * as sdk from '../../../index'; +import withValidation from '../../views/elements/Validation'; +import { decodeRecoveryKey } from 'matrix-js-sdk/src/crypto/recoverykey'; import { SetupEncryptionStore, PHASE_INTRO, + PHASE_RECOVERY_KEY, PHASE_BUSY, PHASE_DONE, PHASE_CONFIRM_SKIP, PHASE_FINISHED, } from '../../../stores/SetupEncryptionStore'; +function keyHasPassphrase(keyInfo) { + return ( + keyInfo.passphrase && + keyInfo.passphrase.salt && + keyInfo.passphrase.iterations + ); +} + export default class SetupEncryptionBody extends React.Component { static propTypes = { onFinished: PropTypes.func.isRequired, @@ -45,6 +56,11 @@ export default class SetupEncryptionBody extends React.Component { // Because of the latter, it lives in the state. verificationRequest: store.verificationRequest, backupInfo: store.backupInfo, + recoveryKey: '', + // whether the recovery key is a valid recovery key + recoveryKeyValid: null, + // whether the recovery key is the correct key or not + recoveryKeyCorrect: null, }; } @@ -67,9 +83,14 @@ export default class SetupEncryptionBody extends React.Component { store.stop(); } - _onUsePassphraseClick = async () => { + _onUseRecoveryKeyClick = async () => { const store = SetupEncryptionStore.sharedInstance(); - store.usePassPhrase(); + store.useRecoveryKey(); + } + + _onRecoveryKeyCancelClick() { + const store = SetupEncryptionStore.sharedInstance(); + store.cancelUseRecoveryKey(); } onSkipClick = () => { @@ -92,6 +113,66 @@ export default class SetupEncryptionBody extends React.Component { store.done(); } + _onUsePassphraseClick = () => { + const store = SetupEncryptionStore.sharedInstance(); + store.usePassPhrase(); + } + + _onRecoveryKeyChange = (e) => { + this.setState({recoveryKey: e.target.value}); + } + + _onRecoveryKeyValidate = async (fieldState) => { + const result = await this._validateRecoveryKey(fieldState); + this.setState({recoveryKeyValid: result.valid}); + return result; + } + + _validateRecoveryKey = withValidation({ + rules: [ + { + key: "required", + test: async (state) => { + try { + const decodedKey = decodeRecoveryKey(state.value); + const correct = await MatrixClientPeg.get().checkSecretStorageKey( + decodedKey, SetupEncryptionStore.sharedInstance().keyInfo, + ); + this.setState({ + recoveryKeyValid: true, + recoveryKeyCorrect: correct, + }); + return correct; + } catch (e) { + this.setState({ + recoveryKeyValid: false, + recoveryKeyCorrect: false, + }); + return false; + } + }, + invalid: function() { + if (this.state.recoveryKeyValid) { + return _t("This isn't the recovery key for your account"); + } else { + return _t("This isn't a valid recovery key"); + } + }, + valid: function() { + return _t("Looks good!"); + }, + }, + ], + }) + + _onRecoveryKeyFormSubmit = (e) => { + e.preventDefault(); + if (!this.state.recoveryKeyCorrect) return; + + const store = SetupEncryptionStore.sharedInstance(); + store.setupWithRecoveryKey(decodeRecoveryKey(this.state.recoveryKey)); + } + render() { const AccessibleButton = sdk.getComponent("elements.AccessibleButton"); @@ -108,6 +189,13 @@ export default class SetupEncryptionBody extends React.Component { member={MatrixClientPeg.get().getUser(this.state.verificationRequest.otherUserId)} />; } else if (phase === PHASE_INTRO) { + const store = SetupEncryptionStore.sharedInstance(); + let recoveryKeyPrompt; + if (keyHasPassphrase(store.keyInfo)) { + recoveryKeyPrompt = _t("Use Recovery Key or Passphrase"); + } else { + recoveryKeyPrompt = _t("Use Recovery Key"); + } return (

{_t( @@ -131,8 +219,8 @@ export default class SetupEncryptionBody extends React.Component {

- - {_t("Use Recovery Passphrase or Key")} + + {recoveryKeyPrompt} {_t("Skip")} @@ -140,6 +228,47 @@ export default class SetupEncryptionBody extends React.Component {
); + } else if (phase === PHASE_RECOVERY_KEY) { + const store = SetupEncryptionStore.sharedInstance(); + let keyPrompt; + if (keyHasPassphrase(store.keyInfo)) { + keyPrompt = _t( + "Enter your Recovery Key or enter a Recovery Passphrase to continue.", {}, + { + a: sub => {sub}, + }, + ); + } else { + keyPrompt = _t("Enter your Recovery Key to continue."); + } + + const Field = sdk.getComponent('elements.Field'); + return
+

{keyPrompt}

+
+ +
+
+ + {_t("Cancel")} + + + {_t("Continue")} + +
+
; } else if (phase === PHASE_DONE) { let message; if (this.state.backupInfo) { diff --git a/src/components/views/dialogs/keybackup/RestoreKeyBackupDialog.js b/src/components/views/dialogs/keybackup/RestoreKeyBackupDialog.js index a16202ed93..2f4c524ed7 100644 --- a/src/components/views/dialogs/keybackup/RestoreKeyBackupDialog.js +++ b/src/components/views/dialogs/keybackup/RestoreKeyBackupDialog.js @@ -94,7 +94,7 @@ export default class RestoreKeyBackupDialog extends React.PureComponent { if (SettingsStore.getValue("feature_cross_signing")) { // If cross-signing is enabled, we reset the SSSS recovery passphrase (and cross-signing keys) this.props.onFinished(false); - accessSecretStorage(() => {}, /* forceReset = */ true); + accessSecretStorage(() => {}, {forceReset: true}); } else { Modal.createTrackedDialogAsync('Key Backup', 'Key Backup', import('../../../../async-components/views/dialogs/keybackup/CreateKeyBackupDialog'), diff --git a/src/components/views/dialogs/secretstorage/AccessSecretStorageDialog.js b/src/components/views/dialogs/secretstorage/AccessSecretStorageDialog.js index e2ceadfbb9..43697f8ee7 100644 --- a/src/components/views/dialogs/secretstorage/AccessSecretStorageDialog.js +++ b/src/components/views/dialogs/secretstorage/AccessSecretStorageDialog.js @@ -32,6 +32,9 @@ export default class AccessSecretStorageDialog extends React.PureComponent { keyInfo: PropTypes.object.isRequired, // Function from one of { passphrase, recoveryKey } -> boolean checkPrivateKey: PropTypes.func.isRequired, + // If true, only prompt for a passphrase and do not offer to restore with + // a recovery key or reset keys. + passphraseOnly: PropTypes.bool, } constructor(props) { @@ -58,7 +61,7 @@ export default class AccessSecretStorageDialog extends React.PureComponent { _onResetRecoveryClick = () => { // Re-enter the access flow, but resetting storage this time around. this.props.onFinished(false); - accessSecretStorage(() => {}, /* forceReset = */ true); + accessSecretStorage(() => {}, {forceReset: true}); } _onRecoveryKeyChange = (e) => { @@ -164,7 +167,7 @@ export default class AccessSecretStorageDialog extends React.PureComponent { primaryDisabled={this.state.passPhrase.length === 0} /> - {_t( + {this.props.passphraseOnly ? null : _t( "If you've forgotten your recovery passphrase you can "+ "use your recovery key or " + "set up new recovery options." @@ -234,7 +237,7 @@ export default class AccessSecretStorageDialog extends React.PureComponent { primaryDisabled={!this.state.recoveryKeyValid} /> - {_t( + {this.props.passphraseOnly ? null : _t( "If you've forgotten your recovery key you can "+ "." , {}, { diff --git a/src/components/views/settings/CrossSigningPanel.js b/src/components/views/settings/CrossSigningPanel.js index b1642e260d..19148c2b6c 100644 --- a/src/components/views/settings/CrossSigningPanel.js +++ b/src/components/views/settings/CrossSigningPanel.js @@ -113,7 +113,7 @@ export default class CrossSigningPanel extends React.PureComponent { _bootstrapSecureSecretStorage = async (forceReset=false) => { this.setState({ error: null }); try { - await accessSecretStorage(() => undefined, forceReset); + await accessSecretStorage(() => undefined, {forceReset}); } catch (e) { this.setState({ error: e }); console.error("Error bootstrapping secret storage", e); diff --git a/src/i18n/strings/en_EN.json b/src/i18n/strings/en_EN.json index 3b86c21015..18cfada862 100644 --- a/src/i18n/strings/en_EN.json +++ b/src/i18n/strings/en_EN.json @@ -2083,6 +2083,7 @@ "Uploading %(filename)s and %(count)s others|one": "Uploading %(filename)s and %(count)s other", "Could not load user profile": "Could not load user profile", "Verify this login": "Verify this login", + "Recovery Key": "Recovery Key", "Session verified": "Session verified", "Failed to send email": "Failed to send email", "The email address linked to your account must be entered.": "The email address linked to your account must be entered.", @@ -2136,10 +2137,16 @@ "You can now close this window or log in to your new account.": "You can now close this window or log in to your new account.", "Registration Successful": "Registration Successful", "Create your account": "Create your account", + "This isn't the recovery key for your account": "This isn't the recovery key for your account", + "This isn't a valid recovery key": "This isn't a valid recovery key", + "Looks good!": "Looks good!", + "Use Recovery Key or Passphrase": "Use Recovery Key or Passphrase", + "Use Recovery Key": "Use Recovery Key", "Confirm your identity by verifying this login from one of your other sessions, granting it access to encrypted messages.": "Confirm your identity by verifying this login from one of your other sessions, granting it access to encrypted messages.", "This requires the latest Riot on your other devices:": "This requires the latest Riot on your other devices:", "or another cross-signing capable Matrix client": "or another cross-signing capable Matrix client", - "Use Recovery Passphrase or Key": "Use Recovery Passphrase or Key", + "Enter your Recovery Key or enter a Recovery Passphrase to continue.": "Enter your Recovery Key or enter a Recovery Passphrase to continue.", + "Enter your Recovery Key to continue.": "Enter your Recovery Key to continue.", "Your new session is now verified. It has access to your encrypted messages, and other users will see it as trusted.": "Your new session is now verified. It has access to your encrypted messages, and other users will see it as trusted.", "Your new session is now verified. Other users will see it as trusted.": "Your new session is now verified. Other users will see it as trusted.", "Without completing security on this session, it won’t have access to encrypted messages.": "Without completing security on this session, it won’t have access to encrypted messages.", @@ -2182,9 +2189,9 @@ "Import": "Import", "Confirm encryption setup": "Confirm encryption setup", "Click the button below to confirm setting up encryption.": "Click the button below to confirm setting up encryption.", - "Enter your account password to confirm the upgrade:": "Enter your account password to confirm the upgrade:", "Restore your key backup to upgrade your encryption": "Restore your key backup to upgrade your encryption", "Restore": "Restore", + "Enter your account password to confirm the upgrade:": "Enter your account password to confirm the upgrade:", "You'll need to authenticate with the server to confirm the upgrade.": "You'll need to authenticate with the server to confirm the upgrade.", "Upgrade this session to allow it to verify other sessions, granting them access to encrypted messages and marking them as trusted for other users.": "Upgrade this session to allow it to verify other sessions, granting them access to encrypted messages and marking them as trusted for other users.", "Store your Recovery Key somewhere safe, it can be used to unlock your encrypted messages & data.": "Store your Recovery Key somewhere safe, it can be used to unlock your encrypted messages & data.", diff --git a/src/stores/SetupEncryptionStore.js b/src/stores/SetupEncryptionStore.js index ae1f998b02..8c081e1da9 100644 --- a/src/stores/SetupEncryptionStore.js +++ b/src/stores/SetupEncryptionStore.js @@ -20,10 +20,11 @@ import { accessSecretStorage, AccessCancelledError } from '../CrossSigningManage import { PHASE_DONE as VERIF_PHASE_DONE } from "matrix-js-sdk/src/crypto/verification/request/VerificationRequest"; export const PHASE_INTRO = 0; -export const PHASE_BUSY = 1; -export const PHASE_DONE = 2; //final done stage, but still showing UX -export const PHASE_CONFIRM_SKIP = 3; -export const PHASE_FINISHED = 4; //UX can be closed +export const PHASE_RECOVERY_KEY = 1; +export const PHASE_BUSY = 2; +export const PHASE_DONE = 3; //final done stage, but still showing UX +export const PHASE_CONFIRM_SKIP = 4; +export const PHASE_FINISHED = 5; //UX can be closed export class SetupEncryptionStore extends EventEmitter { static sharedInstance() { @@ -36,11 +37,19 @@ export class SetupEncryptionStore extends EventEmitter { return; } this._started = true; - this.phase = PHASE_INTRO; + this.phase = PHASE_BUSY; this.verificationRequest = null; this.backupInfo = null; + + // ID of the key that the secrets we want are encrypted with + this.keyId = null; + // Descriptor of the key that the secrets we want are encrypted with + this.keyInfo = null; + MatrixClientPeg.get().on("crypto.verification.request", this.onVerificationRequest); MatrixClientPeg.get().on('userTrustStatusChanged', this._onUserTrustStatusChanged); + + this.fetchKeyInfo(); } stop() { @@ -57,7 +66,40 @@ export class SetupEncryptionStore extends EventEmitter { } } + async fetchKeyInfo() { + const keys = await MatrixClientPeg.get().isSecretStored('m.cross_signing.master', false); + if (Object.keys(keys).length === 0) { + this.keyId = null; + this.keyInfo = null; + } else { + // If the secret is stored under more than one key, we just pick an arbitrary one + this.keyId = Object.keys(keys)[0]; + this.keyInfo = keys[this.keyId]; + } + + this.phase = PHASE_INTRO; + this.emit("update"); + } + + async useRecoveryKey() { + this.phase = PHASE_RECOVERY_KEY; + this.emit("update"); + } + + cancelUseRecoveryKey() { + this.phase = PHASE_INTRO; + this.emit("update"); + } + + async setupWithRecoveryKey(recoveryKey) { + this.startTrustCheck({[this.keyId]: recoveryKey}); + } + async usePassPhrase() { + this.startTrustCheck(); + } + + async startTrustCheck(withKeys) { this.phase = PHASE_BUSY; this.emit("update"); const cli = MatrixClientPeg.get(); @@ -84,6 +126,9 @@ export class SetupEncryptionStore extends EventEmitter { // to advance before this. await cli.restoreKeyBackupWithSecretStorage(backupInfo); } + }, { + withKeys, + passphraseOnly: true, }).catch(reject); } catch (e) { console.error(e); From 5624cf5ceb45c553a5bd21499fcd3cdf51b0734a Mon Sep 17 00:00:00 2001 From: David Baker Date: Tue, 2 Jun 2020 17:55:27 +0100 Subject: [PATCH 04/12] Add option to reset keys to the encryption setup screen --- .../structures/auth/_CompleteSecurity.scss | 4 ++++ .../CreateSecretStorageDialog.js | 24 +++++++++++++++++-- .../structures/auth/SetupEncryptionBody.js | 15 ++++++++++++ src/stores/SetupEncryptionStore.js | 9 +++++++ 4 files changed, 50 insertions(+), 2 deletions(-) diff --git a/res/css/structures/auth/_CompleteSecurity.scss b/res/css/structures/auth/_CompleteSecurity.scss index 7dba57305f..7ea78befb4 100644 --- a/res/css/structures/auth/_CompleteSecurity.scss +++ b/res/css/structures/auth/_CompleteSecurity.scss @@ -102,3 +102,7 @@ limitations under the License. } } } + +.mx_CompleteSecurity_resetText { + padding-top: 20px; +} diff --git a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js index 2147f2c8a8..a7114d9a73 100644 --- a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js +++ b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js @@ -359,6 +359,14 @@ export default class CreateSecretStorageDialog extends React.PureComponent { this.setState({phase: PHASE_CONFIRM_SKIP}); } + _onGoBackClick = () => { + if (this.state.backupInfo && !this.props.force) { + this.setState({phase: PHASE_MIGRATE}); + } else { + this.setState({phase: PHASE_INTRO}); + } + } + _onAccountPasswordChange = (e) => { this.setState({ accountPassword: e.target.value, @@ -492,6 +500,18 @@ export default class CreateSecretStorageDialog extends React.PureComponent { _renderPhaseIntro() { const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); + + let cancelButton; + if (this.props.force) { + // if this is a forced key reset then aborting will just leave the old keys + // in place, and is thereforece just 'cancel' + cancelButton = ; + } else { + // if it's setting up from scratch then aborting leaves the user without + // crypto set up, so they skipping the setup. + cancelButton = ; + } + return

{_t( "Create a Recovery Key to store encryption keys & secrets with your account data. " + @@ -502,7 +522,7 @@ export default class CreateSecretStorageDialog extends React.PureComponent { onPrimaryButtonClick={this._onIntroContinueClick} hasCancel={false} > - + {cancelButton}

; @@ -516,7 +536,7 @@ export default class CreateSecretStorageDialog extends React.PureComponent { "access to encrypted messages.", )} diff --git a/src/components/structures/auth/SetupEncryptionBody.js b/src/components/structures/auth/SetupEncryptionBody.js index cc454b865f..bc83e6e939 100644 --- a/src/components/structures/auth/SetupEncryptionBody.js +++ b/src/components/structures/auth/SetupEncryptionBody.js @@ -83,6 +83,11 @@ export default class SetupEncryptionBody extends React.Component { store.stop(); } + _onResetClick = () => { + const store = SetupEncryptionStore.sharedInstance(); + store.startKeyReset(); + } + _onUseRecoveryKeyClick = async () => { const store = SetupEncryptionStore.sharedInstance(); store.useRecoveryKey(); @@ -226,6 +231,16 @@ export default class SetupEncryptionBody extends React.Component { {_t("Skip")} +
{_t( + "If you've forgotten your recovery key you can " + + "", {}, { + button: sub => + {sub} + , + }, + )}
); } else if (phase === PHASE_RECOVERY_KEY) { diff --git a/src/stores/SetupEncryptionStore.js b/src/stores/SetupEncryptionStore.js index 8c081e1da9..cc64e24a03 100644 --- a/src/stores/SetupEncryptionStore.js +++ b/src/stores/SetupEncryptionStore.js @@ -81,6 +81,15 @@ export class SetupEncryptionStore extends EventEmitter { this.emit("update"); } + async startKeyReset() { + try { + await accessSecretStorage(() => {}, {forceReset: true}); + // If the keys are reset, the trust status event will fire and we'll change state + } catch (e) { + // dialog was cancelled - stay on the current screen + } + } + async useRecoveryKey() { this.phase = PHASE_RECOVERY_KEY; this.emit("update"); From 397b95c5fa12fda74e8594d61a31e8b02c5629e2 Mon Sep 17 00:00:00 2001 From: David Baker Date: Tue, 2 Jun 2020 18:03:32 +0100 Subject: [PATCH 05/12] lint --- .../views/dialogs/secretstorage/CreateSecretStorageDialog.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js index a7114d9a73..f5a8db4e04 100644 --- a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js +++ b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js @@ -509,7 +509,9 @@ export default class CreateSecretStorageDialog extends React.PureComponent { } else { // if it's setting up from scratch then aborting leaves the user without // crypto set up, so they skipping the setup. - cancelButton = ; + cancelButton = ; } return
From 0046e204a071c27cd473a06111937c15085e9edf Mon Sep 17 00:00:00 2001 From: David Baker Date: Tue, 2 Jun 2020 18:30:37 +0100 Subject: [PATCH 06/12] Make the continue button actually work --- src/components/structures/auth/SetupEncryptionBody.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/components/structures/auth/SetupEncryptionBody.js b/src/components/structures/auth/SetupEncryptionBody.js index bc83e6e939..7886ed26dd 100644 --- a/src/components/structures/auth/SetupEncryptionBody.js +++ b/src/components/structures/auth/SetupEncryptionBody.js @@ -279,6 +279,7 @@ export default class SetupEncryptionBody extends React.Component { {_t("Continue")} From 338b88fe4371d6d1991dfe7ecfbdee3bcd14b35d Mon Sep 17 00:00:00 2001 From: David Baker Date: Wed, 3 Jun 2020 09:34:45 +0100 Subject: [PATCH 07/12] Remove unused CSS rule --- res/css/structures/auth/_CompleteSecurity.scss | 4 ---- 1 file changed, 4 deletions(-) diff --git a/res/css/structures/auth/_CompleteSecurity.scss b/res/css/structures/auth/_CompleteSecurity.scss index 7ea78befb4..b0462db477 100644 --- a/res/css/structures/auth/_CompleteSecurity.scss +++ b/res/css/structures/auth/_CompleteSecurity.scss @@ -70,10 +70,6 @@ limitations under the License. } } -.mx_CompleteSecurity_recoveryKeyInput { - width: 368px; -} - .mx_CompleteSecurity_heroIcon { width: 128px; height: 128px; From b60a1d3b66b01845cef4d40cee5247b5990576ac Mon Sep 17 00:00:00 2001 From: David Baker Date: Wed, 3 Jun 2020 09:55:48 +0100 Subject: [PATCH 08/12] Import components --- .../secretstorage/CreateSecretStorageDialog.js | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js index 5bb25b8f19..72759575b4 100644 --- a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js +++ b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js @@ -25,6 +25,10 @@ import Modal from '../../../../Modal'; import { promptForBackupPassphrase } from '../../../../CrossSigningManager'; import {copyNode} from "../../../../utils/strings"; import {SSOAuthEntry} from "../../../../components/views/auth/InteractiveAuthEntryComponents"; +import AccessibleButton from "../../../../components/views/elements/AccessibleButton"; +import DialogButtons from "../../../../components/views/elements/DialogButtons"; +import InlineSpinner from "../../../../components/views/elements/InlineSpinner"; + const PHASE_LOADING = 0; const PHASE_LOADERROR = 1; @@ -380,7 +384,6 @@ export default class CreateSecretStorageDialog extends React.PureComponent { // Once we're confident enough in this (and it's supported enough) we can do // it automatically. // https://github.com/vector-im/riot-web/issues/11696 - const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); const Field = sdk.getComponent('views.elements.Field'); let authPrompt; @@ -429,10 +432,6 @@ export default class CreateSecretStorageDialog extends React.PureComponent { } _renderPhaseShowKey() { - const AccessibleButton = sdk.getComponent('elements.AccessibleButton'); - const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); - const InlineSpinner = sdk.getComponent("elements.InlineSpinner"); - let continueButton; if (this.state.phase === PHASE_SHOWKEY) { continueButton =

{_t("Unable to query secret storage status")}

@@ -500,8 +498,6 @@ export default class CreateSecretStorageDialog extends React.PureComponent { } _renderPhaseIntro() { - const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); - let cancelButton; if (this.props.force) { // if this is a forced key reset then aborting will just leave the old keys @@ -532,7 +528,6 @@ export default class CreateSecretStorageDialog extends React.PureComponent { } _renderPhaseSkipConfirm() { - const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); return
{_t( "Without completing security on this session, it won’t have " + @@ -568,7 +563,6 @@ export default class CreateSecretStorageDialog extends React.PureComponent { let content; if (this.state.error) { - const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); content =

{_t("Unable to set up secret storage")}

From 5844a2dd9bd9edeacc74303f05fad4975098d671 Mon Sep 17 00:00:00 2001 From: David Baker Date: Wed, 3 Jun 2020 10:09:38 +0100 Subject: [PATCH 09/12] indenting (that somehow the linter doesn't care about?) --- .../views/dialogs/secretstorage/CreateSecretStorageDialog.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js index 72759575b4..dd71b13fb6 100644 --- a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js +++ b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js @@ -481,8 +481,8 @@ export default class CreateSecretStorageDialog extends React.PureComponent { const Spinner = sdk.getComponent('views.elements.Spinner'); return
-
; - } +
; + } _renderPhaseLoadError() { return
From 226abb457e2ca5b3302609b6a69033e1480e24f6 Mon Sep 17 00:00:00 2001 From: David Baker Date: Wed, 3 Jun 2020 12:24:22 +0100 Subject: [PATCH 10/12] Update copy in encryption upgrade swcreen --- .../secretstorage/CreateSecretStorageDialog.js | 14 ++++++-------- src/i18n/strings/en_EN.json | 6 ++---- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js index dd71b13fb6..192427d384 100644 --- a/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js +++ b/src/async-components/views/dialogs/secretstorage/CreateSecretStorageDialog.js @@ -389,10 +389,8 @@ export default class CreateSecretStorageDialog extends React.PureComponent { let authPrompt; let nextCaption = _t("Next"); if (!this.state.backupSigStatus.usable) { - authPrompt =
-
{_t("Restore your key backup to upgrade your encryption")}
-
; - nextCaption = _t("Restore"); + authPrompt = null; + nextCaption = _t("Upload"); } else if (this.state.canUploadKeysWithPasswordOnly && !this.props.accountPassword) { authPrompt =
{_t("Enter your account password to confirm the upgrade:")}
@@ -413,9 +411,9 @@ export default class CreateSecretStorageDialog extends React.PureComponent { return

{_t( - "Upgrade this session to allow it to verify other sessions, " + - "granting them access to encrypted messages and marking them " + - "as trusted for other users.", + "Upgrade your Recovery Key to store encryption keys & secrets " + + "with your account data. If you lose access to this login you'll " + + "need it to unlock your data.", )}

{authPrompt}
Date: Wed, 3 Jun 2020 13:04:29 +0100 Subject: [PATCH 11/12] Fix end to end tests for new UI --- test/end-to-end-tests/src/usecases/signup.js | 19 +------------------ 1 file changed, 1 insertion(+), 18 deletions(-) diff --git a/test/end-to-end-tests/src/usecases/signup.js b/test/end-to-end-tests/src/usecases/signup.js index aa9f6b7efa..c56d4a8dc8 100644 --- a/test/end-to-end-tests/src/usecases/signup.js +++ b/test/end-to-end-tests/src/usecases/signup.js @@ -79,35 +79,18 @@ module.exports = async function signup(session, username, password, homeserver) const acceptButton = await session.query('.mx_InteractiveAuthEntryComponents_termsSubmit'); await acceptButton.click(); - //plow through cross-signing setup by entering arbitrary details - //TODO: It's probably important for the tests to know the passphrase - const xsigningPassphrase = 'a7eaXcjpa9!Yl7#V^h$B^%dovHUVX'; // https://xkcd.com/221/ - let passphraseField = await session.query('.mx_CreateSecretStorageDialog_passPhraseField input'); - await session.replaceInputText(passphraseField, xsigningPassphrase); - await session.delay(1000); // give it a second to analyze our passphrase for security let xsignContButton = await session.query('.mx_CreateSecretStorageDialog .mx_Dialog_buttons .mx_Dialog_primary'); await xsignContButton.click(); - //repeat passphrase entry - passphraseField = await session.query('.mx_CreateSecretStorageDialog_passPhraseField input'); - await session.replaceInputText(passphraseField, xsigningPassphrase); - await session.delay(1000); // give it a second to analyze our passphrase for security - xsignContButton = await session.query('.mx_CreateSecretStorageDialog .mx_Dialog_buttons .mx_Dialog_primary'); - await xsignContButton.click(); - //ignore the recovery key //TODO: It's probably important for the tests to know the recovery key const copyButton = await session.query('.mx_CreateSecretStorageDialog_recoveryKeyButtons_copyBtn'); await copyButton.click(); //acknowledge that we copied the recovery key to a safe place - const copyContinueButton = await session.query('.mx_CreateSecretStorageDialog .mx_Dialog_primary'); + const copyContinueButton = await session.query('.mx_CreateSecretStorageDialog .mx_Dialog_buttons .mx_Dialog_primary'); await copyContinueButton.click(); - //acknowledge that we're done cross-signing setup and our keys are safe - const doneOkButton = await session.query('.mx_CreateSecretStorageDialog .mx_Dialog_primary'); - await doneOkButton.click(); - //wait for registration to finish so the hash gets set //onhashchange better? From 0c1809bb380ee35a4d01cbd22893e766184f72fb Mon Sep 17 00:00:00 2001 From: David Baker Date: Wed, 3 Jun 2020 13:24:56 +0100 Subject: [PATCH 12/12] lint --- test/end-to-end-tests/src/usecases/signup.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/test/end-to-end-tests/src/usecases/signup.js b/test/end-to-end-tests/src/usecases/signup.js index c56d4a8dc8..2859aadbda 100644 --- a/test/end-to-end-tests/src/usecases/signup.js +++ b/test/end-to-end-tests/src/usecases/signup.js @@ -79,7 +79,7 @@ module.exports = async function signup(session, username, password, homeserver) const acceptButton = await session.query('.mx_InteractiveAuthEntryComponents_termsSubmit'); await acceptButton.click(); - let xsignContButton = await session.query('.mx_CreateSecretStorageDialog .mx_Dialog_buttons .mx_Dialog_primary'); + const xsignContButton = await session.query('.mx_CreateSecretStorageDialog .mx_Dialog_buttons .mx_Dialog_primary'); await xsignContButton.click(); //ignore the recovery key @@ -88,7 +88,9 @@ module.exports = async function signup(session, username, password, homeserver) await copyButton.click(); //acknowledge that we copied the recovery key to a safe place - const copyContinueButton = await session.query('.mx_CreateSecretStorageDialog .mx_Dialog_buttons .mx_Dialog_primary'); + const copyContinueButton = await session.query( + '.mx_CreateSecretStorageDialog .mx_Dialog_buttons .mx_Dialog_primary', + ); await copyContinueButton.click(); //wait for registration to finish so the hash gets set