diff --git a/.eslintignore b/.eslintignore index b05d64e42..ae5fa5857 100644 --- a/.eslintignore +++ b/.eslintignore @@ -208,9 +208,9 @@ packages/app-desktop/gui/DialogTitle.js.map packages/app-desktop/gui/DropboxLoginScreen.d.ts packages/app-desktop/gui/DropboxLoginScreen.js packages/app-desktop/gui/DropboxLoginScreen.js.map -packages/app-desktop/gui/EncryptionConfigScreen.d.ts -packages/app-desktop/gui/EncryptionConfigScreen.js -packages/app-desktop/gui/EncryptionConfigScreen.js.map +packages/app-desktop/gui/EncryptionConfigScreen/EncryptionConfigScreen.d.ts +packages/app-desktop/gui/EncryptionConfigScreen/EncryptionConfigScreen.js +packages/app-desktop/gui/EncryptionConfigScreen/EncryptionConfigScreen.js.map packages/app-desktop/gui/ErrorBoundary.d.ts packages/app-desktop/gui/ErrorBoundary.js packages/app-desktop/gui/ErrorBoundary.js.map @@ -931,9 +931,9 @@ packages/lib/commands/index.js.map packages/lib/commands/synchronize.d.ts packages/lib/commands/synchronize.js packages/lib/commands/synchronize.js.map -packages/lib/components/shared/encryption-config-shared.d.ts -packages/lib/components/shared/encryption-config-shared.js -packages/lib/components/shared/encryption-config-shared.js.map +packages/lib/components/EncryptionConfigScreen/utils.d.ts +packages/lib/components/EncryptionConfigScreen/utils.js +packages/lib/components/EncryptionConfigScreen/utils.js.map packages/lib/database.d.ts packages/lib/database.js packages/lib/database.js.map diff --git a/.gitignore b/.gitignore index 793f113f3..ce68bab61 100644 --- a/.gitignore +++ b/.gitignore @@ -193,9 +193,9 @@ packages/app-desktop/gui/DialogTitle.js.map packages/app-desktop/gui/DropboxLoginScreen.d.ts packages/app-desktop/gui/DropboxLoginScreen.js packages/app-desktop/gui/DropboxLoginScreen.js.map -packages/app-desktop/gui/EncryptionConfigScreen.d.ts -packages/app-desktop/gui/EncryptionConfigScreen.js -packages/app-desktop/gui/EncryptionConfigScreen.js.map +packages/app-desktop/gui/EncryptionConfigScreen/EncryptionConfigScreen.d.ts +packages/app-desktop/gui/EncryptionConfigScreen/EncryptionConfigScreen.js +packages/app-desktop/gui/EncryptionConfigScreen/EncryptionConfigScreen.js.map packages/app-desktop/gui/ErrorBoundary.d.ts packages/app-desktop/gui/ErrorBoundary.js packages/app-desktop/gui/ErrorBoundary.js.map @@ -916,9 +916,9 @@ packages/lib/commands/index.js.map packages/lib/commands/synchronize.d.ts packages/lib/commands/synchronize.js packages/lib/commands/synchronize.js.map -packages/lib/components/shared/encryption-config-shared.d.ts -packages/lib/components/shared/encryption-config-shared.js -packages/lib/components/shared/encryption-config-shared.js.map +packages/lib/components/EncryptionConfigScreen/utils.d.ts +packages/lib/components/EncryptionConfigScreen/utils.js +packages/lib/components/EncryptionConfigScreen/utils.js.map packages/lib/database.d.ts packages/lib/database.js packages/lib/database.js.map diff --git a/packages/app-desktop/gui/ConfigScreen/ConfigScreen.tsx b/packages/app-desktop/gui/ConfigScreen/ConfigScreen.tsx index 4a9689de8..d4e4da8d5 100644 --- a/packages/app-desktop/gui/ConfigScreen/ConfigScreen.tsx +++ b/packages/app-desktop/gui/ConfigScreen/ConfigScreen.tsx @@ -6,7 +6,7 @@ import { _ } from '@joplin/lib/locale'; import bridge from '../../services/bridge'; import Setting, { AppType, SyncStartupOperation } from '@joplin/lib/models/Setting'; import control_PluginsStates from './controls/plugins/PluginsStates'; -import EncryptionConfigScreen from '../EncryptionConfigScreen'; +import EncryptionConfigScreen from '../EncryptionConfigScreen/EncryptionConfigScreen'; const { connect } = require('react-redux'); const { themeStyle } = require('@joplin/lib/theme'); diff --git a/packages/app-desktop/gui/EncryptionConfigScreen.tsx b/packages/app-desktop/gui/EncryptionConfigScreen.tsx deleted file mode 100644 index 1e54ef559..000000000 --- a/packages/app-desktop/gui/EncryptionConfigScreen.tsx +++ /dev/null @@ -1,394 +0,0 @@ -const React = require('react'); -const { connect } = require('react-redux'); -import Setting from '@joplin/lib/models/Setting'; -import EncryptionService from '@joplin/lib/services/e2ee/EncryptionService'; -import { themeStyle } from '@joplin/lib/theme'; -import { _ } from '@joplin/lib/locale'; -import time from '@joplin/lib/time'; -import { State } from '@joplin/lib/reducer'; -import shim from '@joplin/lib/shim'; -import dialogs from './dialogs'; -import bridge from '../services/bridge'; -import shared from '@joplin/lib/components/shared/encryption-config-shared'; -import { MasterKeyEntity } from '@joplin/lib/services/e2ee/types'; -import { getEncryptionEnabled, masterKeyEnabled, SyncInfo } from '@joplin/lib/services/synchronizer/syncInfoUtils'; -import { getDefaultMasterKey, toggleAndSetupEncryption } from '@joplin/lib/services/e2ee/utils'; -import MasterKey from '@joplin/lib/models/MasterKey'; -import StyledInput from './style/StyledInput'; -import Button, { ButtonLevel } from './Button/Button'; -import styled from 'styled-components'; - -const MasterPasswordInput = styled(StyledInput)` - min-width: 300px; - align-items: center; -`; - -interface Props {} - -class EncryptionConfigScreenComponent extends React.Component { - constructor(props: Props) { - super(props); - - shared.initialize(this, props); - } - - componentWillUnmount() { - this.isMounted_ = false; - shared.componentWillUnmount(); - } - - componentDidMount() { - this.isMounted_ = true; - shared.componentDidMount(this); - } - - componentDidUpdate(prevProps: Props) { - shared.componentDidUpdate(this, prevProps); - } - - async checkPasswords() { - return shared.checkPasswords(this); - } - - private renderMasterKey(mk: MasterKeyEntity, _isDefault: boolean) { - const theme = themeStyle(this.props.themeId); - - const onToggleEnabledClick = () => { - return shared.onToggleEnabledClick(this, mk); - }; - - const passwordStyle = { - color: theme.color, - backgroundColor: theme.backgroundColor, - border: '1px solid', - borderColor: theme.dividerColor, - }; - - const onSaveClick = () => { - return shared.onSavePasswordClick(this, mk); - }; - - const onPasswordChange = (event: any) => { - return shared.onPasswordChange(this, mk, event.target.value); - }; - - const renderPasswordInput = (masterKeyId: string) => { - if (this.state.masterPasswordKeys[masterKeyId] || !this.state.passwordChecks['master']) { - return ( - - ({_('Master password')}) - - ); - } else { - return ( - - onPasswordChange(event)} />{' '} - - - ); - } - }; - - const password = this.state.passwords[mk.id] ? this.state.passwords[mk.id] : ''; - const isActive = this.props.activeMasterKeyId === mk.id; - const activeIcon = isActive ? '✔' : ''; - const passwordOk = this.state.passwordChecks[mk.id] === true ? '✔' : '❌'; - - return ( - - {activeIcon} - {mk.id}
{_('Source: ')}{mk.source_application} - {_('Created: ')}{time.formatMsToLocal(mk.created_time)}
{_('Updated: ')}{time.formatMsToLocal(mk.updated_time)} - {renderPasswordInput(mk.id)} - {passwordOk} - - - - - ); - } - - renderNeedUpgradeSection() { - if (!shim.isElectron()) return null; - - const needUpgradeMasterKeys = EncryptionService.instance().masterKeysThatNeedUpgrading(this.props.masterKeys); - if (!needUpgradeMasterKeys.length) return null; - - const theme = themeStyle(this.props.themeId); - - const rows = []; - const comp = this; - - for (const mk of needUpgradeMasterKeys) { - rows.push( - - {mk.id} - - - ); - } - - return ( -
-

{_('Master keys that need upgrading')}

-

{_('The following master keys use an out-dated encryption algorithm and it is recommended to upgrade them. The upgraded master key will still be able to decrypt and encrypt your data as usual.')}

- - - - - - - {rows} - -
{_('ID')}{_('Upgrade')}
-
- ); - } - - renderReencryptData() { - if (!shim.isElectron()) return null; - if (!this.props.shouldReencrypt) return null; - - const theme = themeStyle(this.props.themeId); - const buttonLabel = _('Re-encrypt data'); - - const intro = this.props.shouldReencrypt ? _('The default encryption method has been changed to a more secure one and it is recommended that you apply it to your data.') : _('You may use the tool below to re-encrypt your data, for example if you know that some of your notes are encrypted with an obsolete encryption method.'); - - let t = `${intro}\n\n${_('In order to do so, your entire data set will have to be encrypted and synchronised, so it is best to run it overnight.\n\nTo start, please follow these instructions:\n\n1. Synchronise all your devices.\n2. Click "%s".\n3. Let it run to completion. While it runs, avoid changing any note on your other devices, to avoid conflicts.\n4. Once sync is done on this device, sync all your other devices and let it run to completion.\n\nImportant: you only need to run this ONCE on one device.', buttonLabel)}`; - - t = t.replace(/\n\n/g, '

'); - t = t.replace(/\n/g, '
'); - t = `

${t}

`; - - return ( -
-

{_('Re-encryption')}

-

- - - - - { !this.props.shouldReencrypt ? null : } -
- ); - } - - private renderMasterKeySection(masterKeys: MasterKeyEntity[], isEnabledMasterKeys: boolean) { - const theme = themeStyle(this.props.themeId); - const mkComps = []; - const showTable = isEnabledMasterKeys || this.state.showDisabledMasterKeys; - const latestMasterKey = MasterKey.latest(); - - for (let i = 0; i < masterKeys.length; i++) { - const mk = masterKeys[i]; - mkComps.push(this.renderMasterKey(mk, isEnabledMasterKeys && latestMasterKey && mk.id === latestMasterKey.id)); - } - - const headerComp = isEnabledMasterKeys ?

{_('Master Keys')}

: shared.toggleShowDisabledMasterKeys(this) } style={{ ...theme.urlStyle, display: 'inline-block', marginBottom: 10 }} href="#">{showTable ? _('Hide disabled master keys') : _('Show disabled master keys')}; - const infoComp = isEnabledMasterKeys ?

{'Note: Only one master key is going to be used for encryption (the one marked as "active"). Any of the keys might be used for decryption, depending on how the notes or notebooks were originally encrypted.'}

: null; - const tableComp = !showTable ? null : ( - - - - - - - - - - - {mkComps} - -
{_('Active')}{_('ID')}{_('Date')}{_('Password')}{_('Valid')}{_('Actions')}
- ); - - if (mkComps.length) { - return ( -
- {headerComp} - {tableComp} - {infoComp} -
- ); - } - - return null; - } - - private renderMasterPassword() { - if (!this.props.encryptionEnabled && !this.props.masterKeys.length) return null; - - const theme = themeStyle(this.props.themeId); - - const onMasterPasswordSave = async () => { - shared.onMasterPasswordSave(this); - - if (!(await shared.masterPasswordIsValid(this, this.state.masterPasswordInput))) { - alert('Password is invalid. Please try again.'); - } - }; - - if (this.state.passwordChecks['master']) { - return ( -
- {_('Master password:')}   - ✔ {_('Loaded')} -
- ); - } else { - return ( -
- ❌ {'The master password is not set or is invalid. Please type it below:'} -
- shared.onMasterPasswordChange(this, event.target.value)} />{' '} -
-
- ); - } - } - - render() { - const theme = themeStyle(this.props.themeId); - const masterKeys: MasterKeyEntity[] = this.props.masterKeys; - - const containerStyle = Object.assign({}, theme.containerStyle, { - padding: theme.configScreenPadding, - overflow: 'auto', - backgroundColor: theme.backgroundColor3, - }); - - const nonExistingMasterKeyIds = this.props.notLoadedMasterKeys.slice(); - - for (let i = 0; i < masterKeys.length; i++) { - const mk = masterKeys[i]; - const idx = nonExistingMasterKeyIds.indexOf(mk.id); - if (idx >= 0) nonExistingMasterKeyIds.splice(idx, 1); - } - - const onToggleButtonClick = async () => { - const isEnabled = getEncryptionEnabled(); - const masterKey = getDefaultMasterKey(); - - let answer = null; - if (isEnabled) { - answer = await dialogs.confirm(_('Disabling encryption means *all* your notes and attachments are going to be re-synchronised and sent unencrypted to the sync target. Do you wish to continue?')); - } else { - const msg = shared.enableEncryptionConfirmationMessages(masterKey); - answer = await dialogs.prompt(msg.join('\n\n'), '', '', { type: 'password' }); - } - - if (!answer) return; - - try { - await toggleAndSetupEncryption(EncryptionService.instance(), !isEnabled, masterKey, answer); - } catch (error) { - await dialogs.alert(error.message); - } - }; - - const decryptedItemsInfo =

{shared.decryptedStatText(this)}

; - const toggleButton = ( - - ); - - const needUpgradeSection = this.renderNeedUpgradeSection(); - const reencryptDataSection = this.renderReencryptData(); - - const enabledMasterKeySection = this.renderMasterKeySection(masterKeys.filter(mk => masterKeyEnabled(mk)), true); - const disabledMasterKeySection = this.renderMasterKeySection(masterKeys.filter(mk => !masterKeyEnabled(mk)), false); - - let nonExistingMasterKeySection = null; - - if (nonExistingMasterKeyIds.length) { - const rows = []; - for (let i = 0; i < nonExistingMasterKeyIds.length; i++) { - const id = nonExistingMasterKeyIds[i]; - rows.push( - - {id} - - ); - } - - nonExistingMasterKeySection = ( -
-

{_('Missing Master Keys')}

-

{_('The master keys with these IDs are used to encrypt some of your items, however the application does not currently have access to them. It is likely they will eventually be downloaded via synchronisation.')}

- - - - - - {rows} - -
{_('ID')}
-
- ); - } - - return ( -
-
- { -
-

- {_('For more information about End-To-End Encryption (E2EE) and advice on how to enable it please check the documentation:')}{' '} - { - bridge().openExternal('https://joplinapp.org/e2ee/'); - }} - href="#" - style={theme.urlStyle} - > - https://joplinapp.org/e2ee/ - -

-
- } -

{_('Status')}

-

- {_('Encryption is:')} {this.props.encryptionEnabled ? _('Enabled') : _('Disabled')} -

- {this.renderMasterPassword()} - {decryptedItemsInfo} - {toggleButton} - {needUpgradeSection} - {this.props.shouldReencrypt ? reencryptDataSection : null} - {enabledMasterKeySection} - {disabledMasterKeySection} - {nonExistingMasterKeySection} - {!this.props.shouldReencrypt ? reencryptDataSection : null} -
-
- ); - } -} - -const mapStateToProps = (state: State) => { - const syncInfo = new SyncInfo(state.settings['syncInfoCache']); - - return { - themeId: state.settings.theme, - masterKeys: syncInfo.masterKeys, - passwords: state.settings['encryption.passwordCache'], - encryptionEnabled: syncInfo.e2ee, - activeMasterKeyId: syncInfo.activeMasterKeyId, - shouldReencrypt: state.settings['encryption.shouldReencrypt'] >= Setting.SHOULD_REENCRYPT_YES, - notLoadedMasterKeys: state.notLoadedMasterKeys, - masterPassword: state.settings['encryption.masterPassword'], - }; -}; - -const EncryptionConfigScreen = connect(mapStateToProps)(EncryptionConfigScreenComponent); - -export default EncryptionConfigScreen; diff --git a/packages/app-desktop/gui/EncryptionConfigScreen/EncryptionConfigScreen.tsx b/packages/app-desktop/gui/EncryptionConfigScreen/EncryptionConfigScreen.tsx new file mode 100644 index 000000000..523a6f6a7 --- /dev/null +++ b/packages/app-desktop/gui/EncryptionConfigScreen/EncryptionConfigScreen.tsx @@ -0,0 +1,366 @@ +const React = require('react'); +import EncryptionService from '@joplin/lib/services/e2ee/EncryptionService'; +import { themeStyle } from '@joplin/lib/theme'; +import { _ } from '@joplin/lib/locale'; +import time from '@joplin/lib/time'; +import shim from '@joplin/lib/shim'; +import dialogs from '../dialogs'; +import bridge from '../../services/bridge'; +import { decryptedStatText, dontReencryptData, enableEncryptionConfirmationMessages, onSavePasswordClick, onToggleEnabledClick, reencryptData, upgradeMasterKey, useInputMasterPassword, useInputPasswords, usePasswordChecker, useStats, useToggleShowDisabledMasterKeys } from '@joplin/lib/components/EncryptionConfigScreen/utils'; +import { MasterKeyEntity } from '@joplin/lib/services/e2ee/types'; +import { getEncryptionEnabled, masterKeyEnabled, SyncInfo } from '@joplin/lib/services/synchronizer/syncInfoUtils'; +import { getDefaultMasterKey, toggleAndSetupEncryption } from '@joplin/lib/services/e2ee/utils'; +import StyledInput from '../style/StyledInput'; +import Button, { ButtonLevel } from '../Button/Button'; +import styled from 'styled-components'; +import { useCallback, useMemo } from 'react'; +import { connect } from 'react-redux'; +import { AppState } from '../../app.reducer'; +import Setting from '@joplin/lib/models/Setting'; + +const MasterPasswordInput = styled(StyledInput)` + min-width: 300px; + align-items: center; +`; + +interface Props { + themeId: any; + masterKeys: MasterKeyEntity[]; + passwords: Record; + notLoadedMasterKeys: string[]; + encryptionEnabled: boolean; + shouldReencrypt: boolean; + activeMasterKeyId: string; + masterPassword: string; +} + +const EncryptionConfigScreen = (props: Props) => { + const { inputPasswords, onInputPasswordChange } = useInputPasswords(props.passwords); + + const theme: any = useMemo(() => { + return themeStyle(props.themeId); + }, [props.themeId]); + + const stats = useStats(); + const { passwordChecks, masterPasswordKeys } = usePasswordChecker(props.masterKeys, props.activeMasterKeyId, props.masterPassword, props.passwords); + const { showDisabledMasterKeys, toggleShowDisabledMasterKeys } = useToggleShowDisabledMasterKeys(); + + const onUpgradeMasterKey = useCallback((mk: MasterKeyEntity) => { + void upgradeMasterKey(mk, passwordChecks, props.passwords); + }, [passwordChecks, props.passwords]); + + const renderNeedUpgradeSection = () => { + if (!shim.isElectron()) return null; + + const needUpgradeMasterKeys = EncryptionService.instance().masterKeysThatNeedUpgrading(props.masterKeys); + if (!needUpgradeMasterKeys.length) return null; + + const theme = themeStyle(props.themeId); + + const rows = []; + + for (const mk of needUpgradeMasterKeys) { + rows.push( + + {mk.id} + + + ); + } + + return ( +
+

{_('Master keys that need upgrading')}

+

{_('The following master keys use an out-dated encryption algorithm and it is recommended to upgrade them. The upgraded master key will still be able to decrypt and encrypt your data as usual.')}

+ + + + + + + {rows} + +
{_('ID')}{_('Upgrade')}
+
+ ); + }; + + const renderReencryptData = () => { + if (!shim.isElectron()) return null; + if (!props.shouldReencrypt) return null; + + const theme = themeStyle(props.themeId); + const buttonLabel = _('Re-encrypt data'); + + const intro = props.shouldReencrypt ? _('The default encryption method has been changed to a more secure one and it is recommended that you apply it to your data.') : _('You may use the tool below to re-encrypt your data, for example if you know that some of your notes are encrypted with an obsolete encryption method.'); + + let t = `${intro}\n\n${_('In order to do so, your entire data set will have to be encrypted and synchronised, so it is best to run it overnight.\n\nTo start, please follow these instructions:\n\n1. Synchronise all your devices.\n2. Click "%s".\n3. Let it run to completion. While it runs, avoid changing any note on your other devices, to avoid conflicts.\n4. Once sync is done on this device, sync all your other devices and let it run to completion.\n\nImportant: you only need to run this ONCE on one device.', buttonLabel)}`; + + t = t.replace(/\n\n/g, '

'); + t = t.replace(/\n/g, '
'); + t = `

${t}

`; + + return ( +
+

{_('Re-encryption')}

+

+ + + + + { !props.shouldReencrypt ? null : } +
+ ); + }; + + const renderMasterKey = (mk: MasterKeyEntity) => { + const theme = themeStyle(props.themeId); + + const passwordStyle = { + color: theme.color, + backgroundColor: theme.backgroundColor, + border: '1px solid', + borderColor: theme.dividerColor, + }; + + const password = inputPasswords[mk.id] ? inputPasswords[mk.id] : ''; + const isActive = props.activeMasterKeyId === mk.id; + const activeIcon = isActive ? '✔' : ''; + const passwordOk = passwordChecks[mk.id] === true ? '✔' : '❌'; + + const renderPasswordInput = (masterKeyId: string) => { + if (masterPasswordKeys[masterKeyId] || !passwordChecks['master']) { + return ( + + ({_('Master password')}) + + ); + } else { + return ( + + onInputPasswordChange(mk, event.target.value)} />{' '} + + + ); + } + }; + + return ( + + {activeIcon} + {mk.id}
{_('Source: ')}{mk.source_application} + {_('Created: ')}{time.formatMsToLocal(mk.created_time)}
{_('Updated: ')}{time.formatMsToLocal(mk.updated_time)} + {renderPasswordInput(mk.id)} + {passwordOk} + + + + + ); + }; + + const renderMasterKeySection = (masterKeys: MasterKeyEntity[], isEnabledMasterKeys: boolean) => { + const theme = themeStyle(props.themeId); + const mkComps = []; + const showTable = isEnabledMasterKeys || showDisabledMasterKeys; + + for (let i = 0; i < masterKeys.length; i++) { + const mk = masterKeys[i]; + mkComps.push(renderMasterKey(mk)); + } + + const headerComp = isEnabledMasterKeys ?

{_('Master Keys')}

: toggleShowDisabledMasterKeys() } style={{ ...theme.urlStyle, display: 'inline-block', marginBottom: 10 }} href="#">{showTable ? _('Hide disabled master keys') : _('Show disabled master keys')}; + const infoComp = isEnabledMasterKeys ?

{'Note: Only one master key is going to be used for encryption (the one marked as "active"). Any of the keys might be used for decryption, depending on how the notes or notebooks were originally encrypted.'}

: null; + const tableComp = !showTable ? null : ( + + + + + + + + + + + {mkComps} + +
{_('Active')}{_('ID')}{_('Date')}{_('Password')}{_('Valid')}{_('Actions')}
+ ); + + if (mkComps.length) { + return ( +
+ {headerComp} + {tableComp} + {infoComp} +
+ ); + } + + return null; + }; + + const { inputMasterPassword, onMasterPasswordSave, onMasterPasswordChange } = useInputMasterPassword(props.masterKeys, props.activeMasterKeyId); + + const renderMasterPassword = () => { + if (!props.encryptionEnabled && !props.masterKeys.length) return null; + + const theme = themeStyle(props.themeId); + + if (passwordChecks['master']) { + return ( +
+ {_('Master password:')}   + ✔ {_('Loaded')} +
+ ); + } else { + return ( +
+ ❌ {'The master password is not set or is invalid. Please type it below:'} +
+ onMasterPasswordChange(event.target.value)} />{' '} +
+
+ ); + } + }; + + const containerStyle = Object.assign({}, theme.containerStyle, { + padding: theme.configScreenPadding, + overflow: 'auto', + backgroundColor: theme.backgroundColor3, + }); + + const nonExistingMasterKeyIds = props.notLoadedMasterKeys.slice(); + + for (let i = 0; i < props.masterKeys.length; i++) { + const mk = props.masterKeys[i]; + const idx = nonExistingMasterKeyIds.indexOf(mk.id); + if (idx >= 0) nonExistingMasterKeyIds.splice(idx, 1); + } + + const onToggleButtonClick = async () => { + const isEnabled = getEncryptionEnabled(); + const masterKey = getDefaultMasterKey(); + + let answer = null; + if (isEnabled) { + answer = await dialogs.confirm(_('Disabling encryption means *all* your notes and attachments are going to be re-synchronised and sent unencrypted to the sync target. Do you wish to continue?')); + } else { + const msg = enableEncryptionConfirmationMessages(masterKey); + answer = await dialogs.prompt(msg.join('\n\n'), '', '', { type: 'password' }); + } + + if (!answer) return; + + try { + await toggleAndSetupEncryption(EncryptionService.instance(), !isEnabled, masterKey, answer); + } catch (error) { + await dialogs.alert(error.message); + } + }; + + const decryptedItemsInfo =

{decryptedStatText(stats)}

; + const toggleButton = ( + + ); + + const needUpgradeSection = renderNeedUpgradeSection(); + const reencryptDataSection = renderReencryptData(); + + const enabledMasterKeySection = renderMasterKeySection(props.masterKeys.filter(mk => masterKeyEnabled(mk)), true); + const disabledMasterKeySection = renderMasterKeySection(props.masterKeys.filter(mk => !masterKeyEnabled(mk)), false); + + let nonExistingMasterKeySection = null; + + if (nonExistingMasterKeyIds.length) { + const rows = []; + for (let i = 0; i < nonExistingMasterKeyIds.length; i++) { + const id = nonExistingMasterKeyIds[i]; + rows.push( + + {id} + + ); + } + + nonExistingMasterKeySection = ( +
+

{_('Missing Master Keys')}

+

{_('The master keys with these IDs are used to encrypt some of your items, however the application does not currently have access to them. It is likely they will eventually be downloaded via synchronisation.')}

+ + + + + + {rows} + +
{_('ID')}
+
+ ); + } + + return ( +
+
+ { +
+

+ {_('For more information about End-To-End Encryption (E2EE) and advice on how to enable it please check the documentation:')}{' '} + { + bridge().openExternal('https://joplinapp.org/e2ee/'); + }} + href="#" + style={theme.urlStyle} + > + https://joplinapp.org/e2ee/ + +

+
+ } +

{_('Status')}

+

+ {_('Encryption is:')} {props.encryptionEnabled ? _('Enabled') : _('Disabled')} +

+ {renderMasterPassword()} + {decryptedItemsInfo} + {toggleButton} + {needUpgradeSection} + {props.shouldReencrypt ? reencryptDataSection : null} + {enabledMasterKeySection} + {disabledMasterKeySection} + {nonExistingMasterKeySection} + {!props.shouldReencrypt ? reencryptDataSection : null} +
+
+ ); +}; + +const mapStateToProps = (state: AppState) => { + const syncInfo = new SyncInfo(state.settings['syncInfoCache']); + + return { + themeId: state.settings.theme, + masterKeys: syncInfo.masterKeys, + passwords: state.settings['encryption.passwordCache'], + encryptionEnabled: syncInfo.e2ee, + activeMasterKeyId: syncInfo.activeMasterKeyId, + shouldReencrypt: state.settings['encryption.shouldReencrypt'] >= Setting.SHOULD_REENCRYPT_YES, + notLoadedMasterKeys: state.notLoadedMasterKeys, + masterPassword: state.settings['encryption.masterPassword'], + }; +}; + +export default connect(mapStateToProps)(EncryptionConfigScreen); diff --git a/packages/app-mobile/components/screens/encryption-config.tsx b/packages/app-mobile/components/screens/encryption-config.tsx index f0f926c55..9cdeabf1f 100644 --- a/packages/app-mobile/components/screens/encryption-config.tsx +++ b/packages/app-mobile/components/screens/encryption-config.tsx @@ -2,68 +2,56 @@ const React = require('react'); const { TextInput, TouchableOpacity, Linking, View, StyleSheet, Text, Button, ScrollView } = require('react-native'); const { connect } = require('react-redux'); const { ScreenHeader } = require('../screen-header.js'); -const { BaseScreenComponent } = require('../base-screen.js'); const { themeStyle } = require('../global-style.js'); const DialogBox = require('react-native-dialogbox').default; const { dialogs } = require('../../utils/dialogs.js'); import EncryptionService from '@joplin/lib/services/e2ee/EncryptionService'; import { _ } from '@joplin/lib/locale'; import time from '@joplin/lib/time'; -import shared from '@joplin/lib/components/shared/encryption-config-shared'; +import { decryptedStatText, enableEncryptionConfirmationMessages, onSavePasswordClick, useInputMasterPassword, useInputPasswords, usePasswordChecker, useStats } from '@joplin/lib/components/EncryptionConfigScreen/utils'; import { MasterKeyEntity } from '@joplin/lib/services/e2ee/types'; import { State } from '@joplin/lib/reducer'; import { SyncInfo } from '@joplin/lib/services/synchronizer/syncInfoUtils'; import { getDefaultMasterKey, setupAndDisableEncryption, toggleAndSetupEncryption } from '@joplin/lib/services/e2ee/utils'; +import { useMemo, useRef, useState } from 'react'; -interface Props {} +interface Props { + themeId: any; + masterKeys: MasterKeyEntity[]; + passwords: Record; + notLoadedMasterKeys: string[]; + encryptionEnabled: boolean; + shouldReencrypt: boolean; + activeMasterKeyId: string; + masterPassword: string; +} -class EncryptionConfigScreenComponent extends BaseScreenComponent { - static navigationOptions(): any { - return { header: null }; - } +const EncryptionConfigScreen = (props: Props) => { + const [passwordPromptShow, setPasswordPromptShow] = useState(false); + const [passwordPromptAnswer, setPasswordPromptAnswer] = useState(''); + const [passwordPromptConfirmAnswer, setPasswordPromptConfirmAnswer] = useState(''); + const stats = useStats(); + const { passwordChecks, masterPasswordKeys } = usePasswordChecker(props.masterKeys, props.activeMasterKeyId, props.masterPassword, props.passwords); + const { inputPasswords, onInputPasswordChange } = useInputPasswords(props.passwords); + const { inputMasterPassword, onMasterPasswordSave, onMasterPasswordChange } = useInputMasterPassword(props.masterKeys, props.activeMasterKeyId); + const dialogBoxRef = useRef(null); - constructor(props: Props) { - super(props); + const mkComps = []; - this.state = { - passwordPromptShow: false, - passwordPromptAnswer: '', - passwordPromptConfirmAnswer: '', + const nonExistingMasterKeyIds = props.notLoadedMasterKeys.slice(); + + const theme: any = useMemo(() => { + return themeStyle(props.themeId); + }, [props.themeId]); + + const rootStyle = useMemo(() => { + return { + flex: 1, + backgroundColor: theme.backgroundColor, }; + }, [theme]); - shared.initialize(this, props); - - this.styles_ = {}; - } - - componentWillUnmount() { - this.isMounted_ = false; - } - - async refreshStats() { - return shared.refreshStats(this); - } - - componentDidMount() { - this.isMounted_ = true; - shared.componentDidMount(this); - } - - componentDidUpdate(prevProps: Props) { - shared.componentDidUpdate(this, prevProps); - } - - async checkPasswords() { - return shared.checkPasswords(this); - } - - styles() { - const themeId = this.props.themeId; - const theme = themeStyle(themeId); - - if (this.styles_[themeId]) return this.styles_[themeId]; - this.styles_ = {}; - + const styles = useMemo(() => { const styles = { titleText: { flex: 1, @@ -93,39 +81,32 @@ class EncryptionConfigScreenComponent extends BaseScreenComponent { }, }; - this.styles_[themeId] = StyleSheet.create(styles); - return this.styles_[themeId]; - } + return StyleSheet.create(styles); + }, [theme]); - renderMasterKey(_num: number, mk: MasterKeyEntity) { - const theme = themeStyle(this.props.themeId); + const decryptedItemsInfo = props.encryptionEnabled ? {decryptedStatText(stats)} : null; - const onSaveClick = () => { - return shared.onSavePasswordClick(this, mk); - }; + const renderMasterKey = (_num: number, mk: MasterKeyEntity) => { + const theme = themeStyle(props.themeId); - const onPasswordChange = (text: string) => { - return shared.onPasswordChange(this, mk, text); - }; - - const password = this.state.passwords[mk.id] ? this.state.passwords[mk.id] : ''; - const passwordOk = this.state.passwordChecks[mk.id] === true ? '✔' : '❌'; + const password = inputPasswords[mk.id] ? inputPasswords[mk.id] : ''; + const passwordOk = passwordChecks[mk.id] === true ? '✔' : '❌'; const inputStyle: any = { flex: 1, marginRight: 10, color: theme.color }; inputStyle.borderBottomWidth = 1; inputStyle.borderBottomColor = theme.dividerColor; const renderPasswordInput = (masterKeyId: string) => { - if (this.state.masterPasswordKeys[masterKeyId] || !this.state.passwordChecks['master']) { + if (masterPasswordKeys[masterKeyId] || !passwordChecks['master']) { return ( - ({_('Master password')}) + ({_('Master password')}) ); } else { return ( - onPasswordChange(text)} style={inputStyle}> + onInputPasswordChange(mk, text)} style={inputStyle}> {passwordOk} - + ); } @@ -133,65 +114,65 @@ class EncryptionConfigScreenComponent extends BaseScreenComponent { return ( - {_('Master Key %s', mk.id.substr(0, 6))} - {_('Created: %s', time.formatMsToLocal(mk.created_time))} + {_('Master Key %s', mk.id.substr(0, 6))} + {_('Created: %s', time.formatMsToLocal(mk.created_time))} {_('Password:')} {renderPasswordInput(mk.id)} ); - } + }; - passwordPromptComponent() { - const theme = themeStyle(this.props.themeId); + const renderPasswordPrompt = () => { + const theme = themeStyle(props.themeId); const masterKey = getDefaultMasterKey(); const onEnableClick = async () => { try { - const password = this.state.passwordPromptAnswer; + const password = passwordPromptAnswer; if (!password) throw new Error(_('Password cannot be empty')); - const password2 = this.state.passwordPromptConfirmAnswer; + const password2 = passwordPromptConfirmAnswer; if (!password2) throw new Error(_('Confirm password cannot be empty')); if (password !== password2) throw new Error(_('Passwords do not match!')); await toggleAndSetupEncryption(EncryptionService.instance(), true, masterKey, password); // await generateMasterKeyAndEnableEncryption(EncryptionService.instance(), password); - this.setState({ passwordPromptShow: false }); + setPasswordPromptShow(false); } catch (error) { - await dialogs.error(this, error.message); + alert(error.message); } }; - const messages = shared.enableEncryptionConfirmationMessages(masterKey); + const messages = enableEncryptionConfirmationMessages(masterKey); - const messageComps = messages.map(msg => { + const messageComps = messages.map((msg: string) => { return {msg}; }); return ( {messageComps} - {_('Password:')} + {_('Password:')} { - this.setState({ passwordPromptAnswer: text }); + setPasswordPromptAnswer(text); }} > - {_('Confirm password:')} + {_('Confirm password:')} { - this.setState({ passwordPromptConfirmAnswer: text }); + setPasswordPromptConfirmAnswer(text); }} > @@ -207,156 +188,132 @@ class EncryptionConfigScreenComponent extends BaseScreenComponent { ); - } + }; - private renderMasterPassword() { - if (!this.props.encryptionEnabled && !this.props.masterKeys.length) return null; - - const theme = themeStyle(this.props.themeId); - - const onMasterPasswordSave = async () => { - shared.onMasterPasswordSave(this); - - if (!(await shared.masterPasswordIsValid(this, this.state.masterPasswordInput))) { - alert('Password is invalid. Please try again.'); - } - }; + const renderMasterPassword = () => { + if (!props.encryptionEnabled && !props.masterKeys.length) return null; const inputStyle: any = { flex: 1, marginRight: 10, color: theme.color }; inputStyle.borderBottomWidth = 1; inputStyle.borderBottomColor = theme.dividerColor; - if (this.state.passwordChecks['master']) { + if (passwordChecks['master']) { return ( - {_('Master password:')} - {_('Loaded')} + {_('Master password:')} + {_('Loaded')} ); } else { return ( - {'The master password is not set or is invalid. Please type it below:'} + {'The master password is not set or is invalid. Please type it below:'} - shared.onMasterPasswordChange(this, text)} style={inputStyle}> + onMasterPasswordChange(text)} style={inputStyle}> - - ) : null; - - return ( - - - - { - - {_('For more information about End-To-End Encryption (E2EE) and advice on how to enable it please check the documentation:')} - { - Linking.openURL('https://joplinapp.org/e2ee/'); - }} - > - https://joplinapp.org/e2ee/ - - - } - - {_('Status')} - {_('Encryption is: %s', this.props.encryptionEnabled ? _('Enabled') : _('Disabled'))} - {decryptedItemsInfo} - {this.renderMasterPassword()} - {toggleButton} - {passwordPromptComp} - {mkComps} - {nonExistingMasterKeySection} - - - { - this.dialogbox = dialogbox; - }} - /> + nonExistingMasterKeySection = ( + + {_('Missing Master Keys')} + {_('The master keys with these IDs are used to encrypt some of your items, however the application does not currently have access to them. It is likely they will eventually be downloaded via synchronisation.')} + {rows} ); } -} -const EncryptionConfigScreen = connect((state: State) => { + const passwordPromptComp = passwordPromptShow ? renderPasswordPrompt() : null; + const toggleButton = !passwordPromptShow ? ( + + + + ) : null; + + return ( + + + + { + + {_('For more information about End-To-End Encryption (E2EE) and advice on how to enable it please check the documentation:')} + { + Linking.openURL('https://joplinapp.org/e2ee/'); + }} + > + https://joplinapp.org/e2ee/ + + + } + + {_('Status')} + {_('Encryption is: %s', props.encryptionEnabled ? _('Enabled') : _('Disabled'))} + {decryptedItemsInfo} + {renderMasterPassword()} + {toggleButton} + {passwordPromptComp} + {mkComps} + {nonExistingMasterKeySection} + + + + + ); +}; + +export default connect((state: State) => { const syncInfo = new SyncInfo(state.settings['syncInfoCache']); return { @@ -368,6 +325,4 @@ const EncryptionConfigScreen = connect((state: State) => { notLoadedMasterKeys: state.notLoadedMasterKeys, masterPassword: state.settings['encryption.masterPassword'], }; -})(EncryptionConfigScreenComponent); - -export default EncryptionConfigScreen; +})(EncryptionConfigScreen); diff --git a/packages/app-mobile/package.json b/packages/app-mobile/package.json index 6766ccb00..f47e7eadf 100644 --- a/packages/app-mobile/package.json +++ b/packages/app-mobile/package.json @@ -15,8 +15,8 @@ "postinstall": "jetify && npm run build" }, "dependencies": { - "@joplin/lib": "^2.2.0", - "@joplin/renderer": "^2.2.0", + "@joplin/lib": "~2.4", + "@joplin/renderer": "~2.4", "@react-native-community/clipboard": "^1.5.0", "@react-native-community/datetimepicker": "^3.0.3", "@react-native-community/geolocation": "^2.0.2", @@ -69,7 +69,7 @@ "@codemirror/lang-markdown": "^0.18.4", "@codemirror/state": "^0.18.7", "@codemirror/view": "^0.18.19", - "@joplin/tools": "^1.0.9", + "@joplin/tools": "~2.4", "@rollup/plugin-node-resolve": "^13.0.0", "@rollup/plugin-typescript": "^8.2.1", "@types/node": "^14.14.6", diff --git a/packages/app-mobile/utils/dialogs.js b/packages/app-mobile/utils/dialogs.js index 48bfe0f77..466bbf4e9 100644 --- a/packages/app-mobile/utils/dialogs.js +++ b/packages/app-mobile/utils/dialogs.js @@ -7,14 +7,13 @@ const { Keyboard } = require('react-native'); const dialogs = {}; -dialogs.confirm = (parentComponent, message) => { - if (!parentComponent) throw new Error('parentComponent is required'); - if (!('dialogbox' in parentComponent)) throw new Error('A "dialogbox" component must be defined on the parent component!'); +dialogs.confirmRef = (ref, message) => { + if (!ref) throw new Error('ref is required'); return new Promise((resolve) => { Keyboard.dismiss(); - parentComponent.dialogbox.confirm({ + ref.confirm({ content: message, ok: { @@ -32,6 +31,13 @@ dialogs.confirm = (parentComponent, message) => { }); }; +dialogs.confirm = (parentComponent, message) => { + if (!parentComponent) throw new Error('parentComponent is required'); + if (!('dialogbox' in parentComponent)) throw new Error('A "dialogbox" component must be defined on the parent component!'); + + return dialogs.confirmRef(parentComponent.dialogBox, message); +}; + dialogs.pop = (parentComponent, message, buttons, options = null) => { if (!parentComponent) throw new Error('parentComponent is required'); if (!('dialogbox' in parentComponent)) throw new Error('A "dialogbox" component must be defined on the parent component!'); diff --git a/packages/lib/components/EncryptionConfigScreen/utils.ts b/packages/lib/components/EncryptionConfigScreen/utils.ts new file mode 100644 index 000000000..bb4bf72d5 --- /dev/null +++ b/packages/lib/components/EncryptionConfigScreen/utils.ts @@ -0,0 +1,183 @@ +import shim from '../../shim'; +import { _ } from '../../locale'; +import BaseItem, { EncryptedItemsStats } from '../../models/BaseItem'; +import useAsyncEffect, { AsyncEffectEvent } from '../../hooks/useAsyncEffect'; +import { MasterKeyEntity } from '../../services/e2ee/types'; +import time from '../../time'; +import { findMasterKeyPassword } from '../../services/e2ee/utils'; +import EncryptionService from '../../services/e2ee/EncryptionService'; +import { masterKeyEnabled, setMasterKeyEnabled } from '../../services/synchronizer/syncInfoUtils'; +import MasterKey from '../../models/MasterKey'; +import { reg } from '../../registry'; +import Setting from '../../models/Setting'; +const { useCallback, useEffect, useState } = shim.react(); + +type PasswordChecks = Record; + +export const useStats = () => { + const [stats, setStats] = useState({ encrypted: null, total: null }); + const [statsUpdateTime, setStatsUpdateTime] = useState(0); + + useAsyncEffect(async (event: AsyncEffectEvent) => { + const r = await BaseItem.encryptedItemsStats(); + if (event.cancelled) return; + setStats(r); + }, [statsUpdateTime]); + + useEffect(() => { + const iid = shim.setInterval(() => { + setStatsUpdateTime(Date.now()); + }, 3000); + + return () => { + clearInterval(iid); + }; + }, []); + + return stats; +}; + +export const decryptedStatText = (stats: EncryptedItemsStats) => { + const doneCount = stats.encrypted !== null ? stats.total - stats.encrypted : '-'; + const totalCount = stats.total !== null ? stats.total : '-'; + const result = _('Decrypted items: %s / %s', doneCount, totalCount); + return result; +}; + +export const enableEncryptionConfirmationMessages = (masterKey: MasterKeyEntity) => { + const msg = [_('Enabling encryption means *all* your notes and attachments are going to be re-synchronised and sent encrypted to the sync target. Do not lose the password as, for security purposes, this will be the *only* way to decrypt the data! To enable encryption, please enter your password below.')]; + if (masterKey) msg.push(_('Encryption will be enabled using the master key created on %s', time.unixMsToLocalDateTime(masterKey.created_time))); + return msg; +}; + +const masterPasswordIsValid = async (masterKeys: MasterKeyEntity[], activeMasterKeyId: string, masterPassword: string = null) => { + const activeMasterKey = masterKeys.find((mk: MasterKeyEntity) => mk.id === activeMasterKeyId); + masterPassword = masterPassword === null ? masterPassword : masterPassword; + if (activeMasterKey && masterPassword) { + return EncryptionService.instance().checkMasterKeyPassword(activeMasterKey, masterPassword); + } + + return false; +}; + +export const reencryptData = async () => { + const ok = confirm(_('Please confirm that you would like to re-encrypt your complete database.')); + if (!ok) return; + + await BaseItem.forceSyncAll(); + void reg.waitForSyncFinishedThenSync(); + Setting.setValue('encryption.shouldReencrypt', Setting.SHOULD_REENCRYPT_NO); + alert(_('Your data is going to be re-encrypted and synced again.')); +}; + +export const dontReencryptData = () => { + Setting.setValue('encryption.shouldReencrypt', Setting.SHOULD_REENCRYPT_NO); +}; + +export const useToggleShowDisabledMasterKeys = () => { + const [showDisabledMasterKeys, setShowDisabledMasterKeys] = useState(false); + + const toggleShowDisabledMasterKeys = () => { + setShowDisabledMasterKeys((current) => !current); + }; + + return { showDisabledMasterKeys, toggleShowDisabledMasterKeys }; +}; + +export const onToggleEnabledClick = (mk: MasterKeyEntity) => { + setMasterKeyEnabled(mk.id, !masterKeyEnabled(mk)); +}; + +export const onSavePasswordClick = (mk: MasterKeyEntity, passwords: Record) => { + const password = passwords[mk.id]; + if (!password) { + Setting.deleteObjectValue('encryption.passwordCache', mk.id); + } else { + Setting.setObjectValue('encryption.passwordCache', mk.id, password); + } +}; + +export const onMasterPasswordSave = (masterPasswordInput: string) => { + Setting.setValue('encryption.masterPassword', masterPasswordInput); +}; + +export const useInputMasterPassword = (masterKeys: MasterKeyEntity[], activeMasterKeyId: string) => { + const [inputMasterPassword, setInputMasterPassword] = useState(''); + + const onMasterPasswordSave = useCallback(async () => { + Setting.setValue('encryption.masterPassword', inputMasterPassword); + + if (!(await masterPasswordIsValid(masterKeys, activeMasterKeyId, inputMasterPassword))) { + alert('Password is invalid. Please try again.'); + } + }, [inputMasterPassword]); + + const onMasterPasswordChange = useCallback((password: string) => { + setInputMasterPassword(password); + }, []); + + return { inputMasterPassword, onMasterPasswordSave, onMasterPasswordChange }; +}; + +export const useInputPasswords = (propsPasswords: Record) => { + const [inputPasswords, setInputPasswords] = useState>(propsPasswords); + + useEffect(() => { + setInputPasswords(propsPasswords); + }, [propsPasswords]); + + const onInputPasswordChange = useCallback((mk: MasterKeyEntity, password: string) => { + setInputPasswords(current => { + return { + ...current, + [mk.id]: password, + }; + }); + }, []); + + return { inputPasswords, onInputPasswordChange }; +}; + +export const usePasswordChecker = (masterKeys: MasterKeyEntity[], activeMasterKeyId: string, masterPassword: string, passwords: Record) => { + const [passwordChecks, setPasswordChecks] = useState({}); + const [masterPasswordKeys, setMasterPasswordKeys] = useState({}); + + useAsyncEffect(async (event: AsyncEffectEvent) => { + const newPasswordChecks: PasswordChecks = {}; + const newMasterPasswordKeys: PasswordChecks = {}; + + for (let i = 0; i < masterKeys.length; i++) { + const mk = masterKeys[i]; + const password = await findMasterKeyPassword(EncryptionService.instance(), mk, passwords); + const ok = password ? await EncryptionService.instance().checkMasterKeyPassword(mk, password) : false; + newPasswordChecks[mk.id] = ok; + newMasterPasswordKeys[mk.id] = password === masterPassword; + } + + newPasswordChecks['master'] = await masterPasswordIsValid(masterKeys, activeMasterKeyId, masterPassword); + + if (event.cancelled) return; + + setPasswordChecks(newPasswordChecks); + setMasterPasswordKeys(newMasterPasswordKeys); + }, [masterKeys, masterPassword]); + + return { passwordChecks, masterPasswordKeys }; +}; + +export const upgradeMasterKey = async (masterKey: MasterKeyEntity, passwordChecks: PasswordChecks, passwords: Record): Promise => { + const passwordCheck = passwordChecks[masterKey.id]; + if (!passwordCheck) { + return _('Please enter your password in the master key list below before upgrading the key.'); + } + + try { + const password = passwords[masterKey.id]; + const newMasterKey = await EncryptionService.instance().upgradeMasterKey(masterKey, password); + await MasterKey.save(newMasterKey); + void reg.waitForSyncFinishedThenSync(); + return _('The master key has been upgraded successfully!'); + } catch (error) { + return _('Could not upgrade master key: %s', error.message); + } +}; diff --git a/packages/lib/components/shared/encryption-config-shared.ts b/packages/lib/components/shared/encryption-config-shared.ts deleted file mode 100644 index ef60a736d..000000000 --- a/packages/lib/components/shared/encryption-config-shared.ts +++ /dev/null @@ -1,196 +0,0 @@ -import EncryptionService from '../../services/e2ee/EncryptionService'; -import { _ } from '../../locale'; -import BaseItem from '../../models/BaseItem'; -import Setting from '../../models/Setting'; -import MasterKey from '../../models/MasterKey'; -import { reg } from '../../registry.js'; -import shim from '../../shim'; -import { MasterKeyEntity } from '../../services/e2ee/types'; -import time from '../../time'; -import { masterKeyEnabled, setMasterKeyEnabled } from '../../services/synchronizer/syncInfoUtils'; -import { findMasterKeyPassword } from '../../services/e2ee/utils'; - -class Shared { - - private refreshStatsIID_: any; - - public initialize(comp: any, props: any) { - comp.state = { - passwordChecks: {}, - // Master keys that can be decrypted with the master password - // (normally all of them, but for legacy support we need this). - masterPasswordKeys: {}, - stats: { - encrypted: null, - total: null, - }, - passwords: Object.assign({}, props.passwords), - showDisabledMasterKeys: false, - masterPasswordInput: '', - }; - comp.isMounted_ = false; - - this.refreshStatsIID_ = null; - } - - public async refreshStats(comp: any) { - const stats = await BaseItem.encryptedItemsStats(); - comp.setState({ - stats: stats, - }); - } - - public async toggleShowDisabledMasterKeys(comp: any) { - comp.setState({ showDisabledMasterKeys: !comp.state.showDisabledMasterKeys }); - } - - public async reencryptData() { - const ok = confirm(_('Please confirm that you would like to re-encrypt your complete database.')); - if (!ok) return; - - await BaseItem.forceSyncAll(); - void reg.waitForSyncFinishedThenSync(); - Setting.setValue('encryption.shouldReencrypt', Setting.SHOULD_REENCRYPT_NO); - alert(_('Your data is going to be re-encrypted and synced again.')); - } - - public dontReencryptData() { - Setting.setValue('encryption.shouldReencrypt', Setting.SHOULD_REENCRYPT_NO); - } - - public async upgradeMasterKey(comp: any, masterKey: MasterKeyEntity) { - const passwordCheck = comp.state.passwordChecks[masterKey.id]; - if (!passwordCheck) { - alert(_('Please enter your password in the master key list below before upgrading the key.')); - return; - } - - try { - const password = comp.state.passwords[masterKey.id]; - const newMasterKey = await EncryptionService.instance().upgradeMasterKey(masterKey, password); - await MasterKey.save(newMasterKey); - void reg.waitForSyncFinishedThenSync(); - alert(_('The master key has been upgraded successfully!')); - } catch (error) { - alert(_('Could not upgrade master key: %s', error.message)); - } - } - - public componentDidMount(comp: any) { - this.componentDidUpdate(comp); - - void this.refreshStats(comp); - - if (this.refreshStatsIID_) { - shim.clearInterval(this.refreshStatsIID_); - this.refreshStatsIID_ = null; - } - - this.refreshStatsIID_ = shim.setInterval(() => { - if (!comp.isMounted_) { - shim.clearInterval(this.refreshStatsIID_); - this.refreshStatsIID_ = null; - return; - } - void this.refreshStats(comp); - }, 3000); - } - - public componentDidUpdate(comp: any, prevProps: any = null) { - if (prevProps && comp.props.passwords !== prevProps.passwords) { - comp.setState({ passwords: Object.assign({}, comp.props.passwords) }); - } - - if (!prevProps || comp.props.masterKeys !== prevProps.masterKeys || comp.props.passwords !== prevProps.passwords) { - comp.checkPasswords(); - } - } - - public componentWillUnmount() { - if (this.refreshStatsIID_) { - shim.clearInterval(this.refreshStatsIID_); - this.refreshStatsIID_ = null; - } - } - - public async masterPasswordIsValid(comp: any, masterPassword: string = null) { - const activeMasterKey = comp.props.masterKeys.find((mk: MasterKeyEntity) => mk.id === comp.props.activeMasterKeyId); - masterPassword = masterPassword === null ? comp.props.masterPassword : masterPassword; - if (activeMasterKey && masterPassword) { - return EncryptionService.instance().checkMasterKeyPassword(activeMasterKey, masterPassword); - } - - return false; - } - - public async checkPasswords(comp: any) { - const passwordChecks = Object.assign({}, comp.state.passwordChecks); - const masterPasswordKeys = Object.assign({}, comp.state.masterPasswordKeys); - for (let i = 0; i < comp.props.masterKeys.length; i++) { - const mk = comp.props.masterKeys[i]; - const password = await findMasterKeyPassword(EncryptionService.instance(), mk); - const ok = password ? await EncryptionService.instance().checkMasterKeyPassword(mk, password) : false; - passwordChecks[mk.id] = ok; - masterPasswordKeys[mk.id] = password === comp.props.masterPassword; - } - - passwordChecks['master'] = await this.masterPasswordIsValid(comp); - - comp.setState({ passwordChecks, masterPasswordKeys }); - } - - public masterPasswordStatus(comp: any) { - // Don't translate for now because that's temporary - later it should - // always be set and the label should be replaced by a "Change master - // password" button. - return comp.props.masterPassword ? 'Master password is set' : 'Master password is not set'; - } - - public decryptedStatText(comp: any) { - const stats = comp.state.stats; - const doneCount = stats.encrypted !== null ? stats.total - stats.encrypted : '-'; - const totalCount = stats.total !== null ? stats.total : '-'; - const result = _('Decrypted items: %s / %s', doneCount, totalCount); - return result; - } - - public onSavePasswordClick(comp: any, mk: MasterKeyEntity) { - const password = comp.state.passwords[mk.id]; - if (!password) { - Setting.deleteObjectValue('encryption.passwordCache', mk.id); - } else { - Setting.setObjectValue('encryption.passwordCache', mk.id, password); - } - - comp.checkPasswords(); - } - - public onMasterPasswordChange(comp: any, value: string) { - comp.setState({ masterPasswordInput: value }); - } - - public onMasterPasswordSave(comp: any) { - Setting.setValue('encryption.masterPassword', comp.state.masterPasswordInput); - } - - public onPasswordChange(comp: any, mk: MasterKeyEntity, password: string) { - const passwords = Object.assign({}, comp.state.passwords); - passwords[mk.id] = password; - comp.setState({ passwords: passwords }); - } - - public onToggleEnabledClick(_comp: any, mk: MasterKeyEntity) { - setMasterKeyEnabled(mk.id, !masterKeyEnabled(mk)); - } - - public enableEncryptionConfirmationMessages(masterKey: MasterKeyEntity) { - const msg = [_('Enabling encryption means *all* your notes and attachments are going to be re-synchronised and sent encrypted to the sync target. Do not lose the password as, for security purposes, this will be the *only* way to decrypt the data! To enable encryption, please enter your password below.')]; - if (masterKey) msg.push(_('Encryption will be enabled using the master key created on %s', time.unixMsToLocalDateTime(masterKey.created_time))); - return msg; - } - -} - -const shared = new Shared(); - -export default shared; diff --git a/packages/lib/hooks/useEventListener.ts b/packages/lib/hooks/useEventListener.ts index d137e66cc..f8f0420d7 100644 --- a/packages/lib/hooks/useEventListener.ts +++ b/packages/lib/hooks/useEventListener.ts @@ -25,6 +25,7 @@ function useEventListener( const eventListener = (event: Event) => { // eslint-disable-next-line no-extra-boolean-cast if (!!savedHandler?.current) { + // @ts-ignore savedHandler.current(event); } }; diff --git a/packages/lib/models/BaseItem.ts b/packages/lib/models/BaseItem.ts index bb3178d8f..0e01e8fc5 100644 --- a/packages/lib/models/BaseItem.ts +++ b/packages/lib/models/BaseItem.ts @@ -33,6 +33,11 @@ export interface ItemsThatNeedSyncResult { neverSyncedItemIds: string[]; } +export interface EncryptedItemsStats { + encrypted: number; + total: number; +} + export default class BaseItem extends BaseModel { public static encryptionService_: any = null; @@ -513,7 +518,7 @@ export default class BaseItem extends BaseModel { return output; } - static async encryptedItemsStats() { + public static async encryptedItemsStats(): Promise { const classNames = this.encryptableItemClassNames(); let encryptedCount = 0; let totalCount = 0; diff --git a/packages/lib/package-lock.json b/packages/lib/package-lock.json index 028f86c89..5e93ebb3b 100644 --- a/packages/lib/package-lock.json +++ b/packages/lib/package-lock.json @@ -67,6 +67,7 @@ "@types/fs-extra": "^9.0.6", "@types/jest": "^26.0.15", "@types/node": "^14.14.6", + "@types/react": "^17.0.20", "clean-html": "^1.5.0", "jest": "^26.6.3", "sharp": "^0.26.2", @@ -1073,6 +1074,29 @@ "integrity": "sha512-UEyp8LwZ4Dg30kVU2Q3amHHyTn1jEdhCIE59ANed76GaT1Vp76DD3ZWSAxgCrw6wJ0TqeoBpqmfUHiUDPs//HQ==", "dev": true }, + "node_modules/@types/prop-types": { + "version": "15.7.4", + "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.4.tgz", + "integrity": "sha512-rZ5drC/jWjrArrS8BR6SIr4cWpW09RNTYt9AMZo3Jwwif+iacXAqgVjm0B0Bv/S1jhDXKHqRVNCbACkJ89RAnQ==", + "dev": true + }, + "node_modules/@types/react": { + "version": "17.0.20", + "resolved": "https://registry.npmjs.org/@types/react/-/react-17.0.20.tgz", + "integrity": "sha512-wWZrPlihslrPpcKyCSlmIlruakxr57/buQN1RjlIeaaTWDLtJkTtRW429MoQJergvVKc4IWBpRhWw7YNh/7GVA==", + "dev": true, + "dependencies": { + "@types/prop-types": "*", + "@types/scheduler": "*", + "csstype": "^3.0.2" + } + }, + "node_modules/@types/scheduler": { + "version": "0.16.2", + "resolved": "https://registry.npmjs.org/@types/scheduler/-/scheduler-0.16.2.tgz", + "integrity": "sha512-hppQEBDmlwhFAXKJX2KnWLYu5yMfi91yazPb2l+lbJiwW+wdo1gNeRA+3RgNSO39WYX2euey41KEwnqesU2Jew==", + "dev": true + }, "node_modules/@types/stack-utils": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.0.tgz", @@ -2253,6 +2277,12 @@ "integrity": "sha512-b0tGHbfegbhPJpxpiBPU2sCkigAqtM9O121le6bbOlgyV+NyGyCmVfJ6QW9eRjz8CpNfWEOYBIMIGRYkLwsIYg==", "dev": true }, + "node_modules/csstype": { + "version": "3.0.8", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.0.8.tgz", + "integrity": "sha512-jXKhWqXPmlUeoQnF/EhTtTl4C9SnrxSH/jZUih3jmO6lBKr99rP3/+FmrMj4EFpOXzMtXHAZkd3x0E6h6Fgflw==", + "dev": true + }, "node_modules/dashdash": { "version": "1.14.1", "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", @@ -9758,6 +9788,29 @@ "integrity": "sha512-UEyp8LwZ4Dg30kVU2Q3amHHyTn1jEdhCIE59ANed76GaT1Vp76DD3ZWSAxgCrw6wJ0TqeoBpqmfUHiUDPs//HQ==", "dev": true }, + "@types/prop-types": { + "version": "15.7.4", + "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.4.tgz", + "integrity": "sha512-rZ5drC/jWjrArrS8BR6SIr4cWpW09RNTYt9AMZo3Jwwif+iacXAqgVjm0B0Bv/S1jhDXKHqRVNCbACkJ89RAnQ==", + "dev": true + }, + "@types/react": { + "version": "17.0.20", + "resolved": "https://registry.npmjs.org/@types/react/-/react-17.0.20.tgz", + "integrity": "sha512-wWZrPlihslrPpcKyCSlmIlruakxr57/buQN1RjlIeaaTWDLtJkTtRW429MoQJergvVKc4IWBpRhWw7YNh/7GVA==", + "dev": true, + "requires": { + "@types/prop-types": "*", + "@types/scheduler": "*", + "csstype": "^3.0.2" + } + }, + "@types/scheduler": { + "version": "0.16.2", + "resolved": "https://registry.npmjs.org/@types/scheduler/-/scheduler-0.16.2.tgz", + "integrity": "sha512-hppQEBDmlwhFAXKJX2KnWLYu5yMfi91yazPb2l+lbJiwW+wdo1gNeRA+3RgNSO39WYX2euey41KEwnqesU2Jew==", + "dev": true + }, "@types/stack-utils": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.0.tgz", @@ -10725,6 +10778,12 @@ } } }, + "csstype": { + "version": "3.0.8", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.0.8.tgz", + "integrity": "sha512-jXKhWqXPmlUeoQnF/EhTtTl4C9SnrxSH/jZUih3jmO6lBKr99rP3/+FmrMj4EFpOXzMtXHAZkd3x0E6h6Fgflw==", + "dev": true + }, "dashdash": { "version": "1.14.1", "resolved": "https://registry.npmjs.org/dashdash/-/dashdash-1.14.1.tgz", diff --git a/packages/lib/package.json b/packages/lib/package.json index e4ef27294..72daa4b07 100644 --- a/packages/lib/package.json +++ b/packages/lib/package.json @@ -19,6 +19,7 @@ "@types/fs-extra": "^9.0.6", "@types/jest": "^26.0.15", "@types/node": "^14.14.6", + "@types/react": "^17.0.20", "clean-html": "^1.5.0", "jest": "^26.6.3", "sharp": "^0.26.2", diff --git a/packages/lib/services/e2ee/utils.ts b/packages/lib/services/e2ee/utils.ts index 53d849ca5..d9c53249c 100644 --- a/packages/lib/services/e2ee/utils.ts +++ b/packages/lib/services/e2ee/utils.ts @@ -103,7 +103,7 @@ export async function migrateMasterPassword() { // previously any master key could be encrypted with any password, so to support // this legacy case, we first check if the MK decrypts with the master password. // If not, try with the master key specific password, if any is defined. -export async function findMasterKeyPassword(service: EncryptionService, masterKey: MasterKeyEntity): Promise { +export async function findMasterKeyPassword(service: EncryptionService, masterKey: MasterKeyEntity, passwordCache: Record = null): Promise { const masterPassword = Setting.value('encryption.masterPassword'); if (masterPassword && await service.checkMasterKeyPassword(masterKey, masterPassword)) { logger.info('findMasterKeyPassword: Using master password'); @@ -112,7 +112,7 @@ export async function findMasterKeyPassword(service: EncryptionService, masterKe logger.info('findMasterKeyPassword: No master password is defined - trying to get master key specific password'); - const passwords = Setting.value('encryption.passwordCache'); + const passwords = passwordCache ? passwordCache : Setting.value('encryption.passwordCache'); return passwords[masterKey.id]; } diff --git a/packages/lib/shim.ts b/packages/lib/shim.ts index 4fe6bd005..631fa96c5 100644 --- a/packages/lib/shim.ts +++ b/packages/lib/shim.ts @@ -1,22 +1,26 @@ +import * as React from 'react'; import { NoteEntity, ResourceEntity } from './services/database/types'; let isTestingEnv_ = false; -// We need to ensure that there's only one instance of React being used by -// all the packages. In particular, the lib might need React to define -// generic hooks, but it shouldn't have React in its dependencies as that -// would cause the following error: +// We need to ensure that there's only one instance of React being used by all +// the packages. In particular, the lib might need React to define generic +// hooks, but it shouldn't have React in its dependencies as that would cause +// the following error: // // https://reactjs.org/warnings/invalid-hook-call-warning.html#duplicate-react // -// So instead, the **applications** include React as a dependency, then -// pass it to any other packages using the shim. Essentially, only one -// package should require React, and in our case that should be one of the -// applications (app-desktop, app-mobile, etc.) since we are sure they -// won't be dependency to other packages (unlike the lib which can be -// included anywhere). - -let react_: any = null; +// So instead, the **applications** include React as a dependency, then pass it +// to any other packages using the shim. Essentially, only one package should +// require React, and in our case that should be one of the applications +// (app-desktop, app-mobile, etc.) since we are sure they won't be dependency to +// other packages (unlike the lib which can be included anywhere). +// +// Regarding the type - althought we import React, we only use it as a type +// using `typeof React`. This is just to get types in hooks. +// +// https://stackoverflow.com/a/42816077/561309 +let react_: typeof React = null; const shim = { Geolocation: null as any,