/* Copyright 2018, 2019 New Vector Ltd Copyright 2019, 2020 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 React from 'react'; import FileSaver from 'file-saver'; import * as sdk from '../../../../index'; import {MatrixClientPeg} from '../../../../MatrixClientPeg'; import PropTypes from 'prop-types'; import { scorePassword } from '../../../../utils/PasswordScorer'; import { _t } from '../../../../languageHandler'; import { accessSecretStorage } from '../../../../CrossSigningManager'; import SettingsStore from '../../../../settings/SettingsStore'; import AccessibleButton from "../../../../components/views/elements/AccessibleButton"; const PHASE_PASSPHRASE = 0; const PHASE_PASSPHRASE_CONFIRM = 1; const PHASE_SHOWKEY = 2; const PHASE_KEEPITSAFE = 3; const PHASE_BACKINGUP = 4; const PHASE_DONE = 5; const PHASE_OPTOUT_CONFIRM = 6; const PASSWORD_MIN_SCORE = 4; // So secure, many characters, much complex, wow, etc, etc. const PASSPHRASE_FEEDBACK_DELAY = 500; // How long after keystroke to offer passphrase feedback, ms. // XXX: copied from ShareDialog: factor out into utils function selectText(target) { const range = document.createRange(); range.selectNodeContents(target); const selection = window.getSelection(); selection.removeAllRanges(); selection.addRange(range); } /* * Walks the user through the process of creating an e2e key backup * on the server. */ export default class CreateKeyBackupDialog extends React.PureComponent { static propTypes = { secureSecretStorage: PropTypes.bool, onFinished: PropTypes.func.isRequired, } constructor(props) { super(props); this._recoveryKeyNode = null; this._keyBackupInfo = null; this._setZxcvbnResultTimeout = null; this.state = { secureSecretStorage: props.secureSecretStorage, phase: PHASE_PASSPHRASE, passPhrase: '', passPhraseConfirm: '', copied: false, downloaded: false, zxcvbnResult: null, }; if (this.state.secureSecretStorage === undefined) { this.state.secureSecretStorage = SettingsStore.isFeatureEnabled("feature_cross_signing"); } // If we're using secret storage, skip ahead to the backing up step, as // `accessSecretStorage` will handle passphrases as needed. if (this.state.secureSecretStorage) { this.state.phase = PHASE_BACKINGUP; } } componentDidMount() { // If we're using secret storage, skip ahead to the backing up step, as // `accessSecretStorage` will handle passphrases as needed. if (this.state.secureSecretStorage) { this._createBackup(); } } componentWillUnmount() { if (this._setZxcvbnResultTimeout !== null) { clearTimeout(this._setZxcvbnResultTimeout); } } _collectRecoveryKeyNode = (n) => { this._recoveryKeyNode = n; } _onCopyClick = () => { selectText(this._recoveryKeyNode); const successful = document.execCommand('copy'); if (successful) { this.setState({ copied: true, phase: PHASE_KEEPITSAFE, }); } } _onDownloadClick = () => { const blob = new Blob([this._keyBackupInfo.recovery_key], { type: 'text/plain;charset=us-ascii', }); FileSaver.saveAs(blob, 'recovery-key.txt'); this.setState({ downloaded: true, phase: PHASE_KEEPITSAFE, }); } _createBackup = async () => { const { secureSecretStorage } = this.state; this.setState({ phase: PHASE_BACKINGUP, error: null, }); let info; try { if (secureSecretStorage) { await accessSecretStorage(async () => { info = await MatrixClientPeg.get().prepareKeyBackupVersion( null /* random key */, { secureSecretStorage: true }, ); info = await MatrixClientPeg.get().createKeyBackupVersion(info); }); } else { info = await MatrixClientPeg.get().createKeyBackupVersion( this._keyBackupInfo, ); } await MatrixClientPeg.get().scheduleAllGroupSessionsForBackup(); this.setState({ phase: PHASE_DONE, }); } catch (e) { console.error("Error creating key backup", e); // TODO: If creating a version succeeds, but backup fails, should we // delete the version, disable backup, or do nothing? If we just // disable without deleting, we'll enable on next app reload since // it is trusted. if (info) { MatrixClientPeg.get().deleteKeyBackupVersion(info.version); } this.setState({ error: e, }); } } _onCancel = () => { this.props.onFinished(false); } _onDone = () => { this.props.onFinished(true); } _onOptOutClick = () => { this.setState({phase: PHASE_OPTOUT_CONFIRM}); } _onSetUpClick = () => { this.setState({phase: PHASE_PASSPHRASE}); } _onSkipPassPhraseClick = async () => { this._keyBackupInfo = await MatrixClientPeg.get().prepareKeyBackupVersion(); this.setState({ copied: false, downloaded: false, phase: PHASE_SHOWKEY, }); } _onPassPhraseNextClick = async (e) => { e.preventDefault(); // If we're waiting for the timeout before updating the result at this point, // skip ahead and do it now, otherwise we'll deny the attempt to proceed // even if the user entered a valid passphrase if (this._setZxcvbnResultTimeout !== null) { clearTimeout(this._setZxcvbnResultTimeout); this._setZxcvbnResultTimeout = null; await new Promise((resolve) => { this.setState({ zxcvbnResult: scorePassword(this.state.passPhrase), }, resolve); }); } if (this._passPhraseIsValid()) { this.setState({phase: PHASE_PASSPHRASE_CONFIRM}); } }; _onPassPhraseConfirmNextClick = async (e) => { e.preventDefault(); if (this.state.passPhrase !== this.state.passPhraseConfirm) return; this._keyBackupInfo = await MatrixClientPeg.get().prepareKeyBackupVersion(this.state.passPhrase); this.setState({ copied: false, downloaded: false, phase: PHASE_SHOWKEY, }); }; _onSetAgainClick = () => { this.setState({ passPhrase: '', passPhraseConfirm: '', phase: PHASE_PASSPHRASE, zxcvbnResult: null, }); } _onKeepItSafeBackClick = () => { this.setState({ phase: PHASE_SHOWKEY, }); } _onPassPhraseChange = (e) => { this.setState({ passPhrase: e.target.value, }); if (this._setZxcvbnResultTimeout !== null) { clearTimeout(this._setZxcvbnResultTimeout); } this._setZxcvbnResultTimeout = setTimeout(() => { this._setZxcvbnResultTimeout = null; this.setState({ // precompute this and keep it in state: zxcvbn is fast but // we use it in a couple of different places so no point recomputing // it unnecessarily. zxcvbnResult: scorePassword(this.state.passPhrase), }); }, PASSPHRASE_FEEDBACK_DELAY); } _onPassPhraseConfirmChange = (e) => { this.setState({ passPhraseConfirm: e.target.value, }); } _passPhraseIsValid() { return this.state.zxcvbnResult && this.state.zxcvbnResult.score >= PASSWORD_MIN_SCORE; } _renderPhasePassPhrase() { const DialogButtons = sdk.getComponent('views.elements.DialogButtons'); let strengthMeter; let helpText; if (this.state.zxcvbnResult) { if (this.state.zxcvbnResult.score >= PASSWORD_MIN_SCORE) { helpText = _t("Great! This passphrase looks strong enough."); } else { const suggestions = []; for (let i = 0; i < this.state.zxcvbnResult.feedback.suggestions.length; ++i) { suggestions.push(
{_t( "Your recovery key is a safety net - you can use it to restore " + "access to your encrypted messages if you forget your passphrase.", )}
{_t( "Keep a copy of it somewhere secure, like a password manager or even a safe.", )}
{this._keyBackupInfo.recovery_key}
{_t( "Your keys are being backed up (the first backup could take a few minutes).", )}
{_t("Unable to create key backup")}