Change encryption option name to "encrypt_tabs"

Also adds a note about encryption to the documentation.

Author: hluk

docs/backup.rst

@@ -66,19 +66,19 @@ configuration and commands within the application.
 
 .. warning::
 
-    Tabs are always exported **unencrypted** and if a tab is
-    synchronized with directory on disk the files themselves won't be
-    exported.
+    Tabs are exported **without any encryption** by default (you would need
+    CopyQ 14.0.0 and above) and if a tab is synchronized with directory on disk
+    the files themselves will not be exported.
 
-To export the data click "Export..." in "File" menu and select what to
-export, confirm with OK button and select file to save the stuff to.
+To export the data click "Export..." in "File" menu, select what to
+export, confirm with OK button and select target file to save.
 
 To restore the data click "Import..." in "File" menu, select file to
 import and select what to import.
 
 .. note::
 
-    Import won't overwrite existing tabs and commands but create new ones.
+    Import will not overwrite existing tabs and commands but create new ones.
 
 Alternatively you can use command line for export and import everything
 (selection dialogs won't be opened).

docs/faq.rst

@@ -448,8 +448,14 @@ Alternatively, run the following command::
 Why does encryption ask for password so often?
 ----------------------------------------------
 
-Encryption plugin uses ``gpg2`` to decrypt tabs and items. The password usually
-needs to be entered only once every few minutes.
+CopyQ 14.0.0 and above has a built-in encryption support, which requires
+password only at start (and when changing encryption password). Even that can
+be avoided if "Use external key store" option is enabled and the system
+supports it (Windows Credential Store, macOS Keychain, GNOME Keyring, KWallet).
+
+In older versions, there is an Encryption plugin which uses ``gpg2`` utility to
+decrypt tabs and items. The password usually needs to be entered once every few
+minutes.
 
 If the password prompt is showing up too often, either increase tab unloading
 interval ("Unload tab after an interval" option in "History" tab in

docs/password-protection.rst

@@ -6,6 +6,14 @@ Password Protection
 This page describes how to encrypt and protect selected tabs and single
 items with a password.
 
+.. note::
+
+   CopyQ 14.0.0 and above will support encrypting all data using a custom
+   Password. This can be enabled with "Encrypt Tabs" option in Preferences. As
+   An alternative, available in older versions, the below describes using
+   Encryption plugin to encrypt specific tabs or single items (this requires a
+   GnuPG utility to be installed).
+
 Installation
 ------------
 

docs/security.rst

@@ -18,7 +18,7 @@ copied from windows with matching window titles.
     - :ref:`faq-ignore-password-manager`
 
 The data from all tabs are stored in the configuration directory unencrypted
-(unless the Encryption plugin is enabled for a tab).
+(unless the Encryption is enabled).
 
 .. seealso::
 

src/common/appconfig.h

@@ -48,8 +48,8 @@ struct item_data_threshold : Config<int> {
     }
 };
 
-struct tab_encryption_enabled : Config<bool> {
-    static QString name() { return QStringLiteral("tab_encryption_enabled"); }
+struct encrypt_tabs : Config<bool> {
+    static QString name() { return QStringLiteral("encrypt_tabs"); }
     static Value defaultValue() { return false; }
 };
 

src/gui/configurationmanager.cpp

@@ -228,11 +228,11 @@ void ConfigurationManager::updateOptionsVisibility()
         platform->canPreventScreenCapture() );
 
 #ifdef WITH_QCA_ENCRYPTION
-    m_tabGeneral->checkBoxTabEncryption->setVisible(true);
+    m_tabGeneral->checkBoxEncryptTabs->setVisible(true);
     const bool passwordWasSet = m_sharedData && !Encryption::loadPasswordHash().isEmpty();
     m_tabGeneral->pushButtonChangeEncryptionPassword->setVisible(passwordWasSet);
 #else
-    m_tabGeneral->checkBoxTabEncryption->setVisible(false);
+    m_tabGeneral->checkBoxEncryptTabs->setVisible(false);
     m_tabGeneral->pushButtonChangeEncryptionPassword->setVisible(false);
 #endif
 
@@ -254,7 +254,7 @@ void ConfigurationManager::initOptions()
     /* general options */
     bind<Config::autostart>(m_tabGeneral->checkBoxAutostart);
     bind<Config::prevent_screen_capture>(m_tabGeneral->checkBoxPreventScreenCapture);
-    bind<Config::tab_encryption_enabled>(m_tabGeneral->checkBoxTabEncryption);
+    bind<Config::encrypt_tabs>(m_tabGeneral->checkBoxEncryptTabs);
     bind<Config::use_key_store>(m_tabGeneral->checkBoxUseKeychain);
     bind<Config::clipboard_tab>(m_tabHistory->comboBoxClipboardTab->lineEdit());
     bind<Config::maxitems>(m_tabHistory->spinBoxItems);

src/gui/mainwindow.cpp

@@ -757,7 +757,7 @@ MainWindow::MainWindow(const ClipboardBrowserSharedPtr &sharedData, QWidget *par
     , m_tray(nullptr)
     , m_toolBar(new ToolBar(this))
     , m_sharedData(sharedData)
-    , m_wasEncrypted(AppConfig().option<Config::tab_encryption_enabled>())
+    , m_wasEncrypted(AppConfig().option<Config::encrypt_tabs>())
     , m_menu( new TrayMenu(this) )
     , m_menuMaxItemCount(-1)
     , m_commandDialog(nullptr)
@@ -3705,7 +3705,7 @@ void MainWindow::promptForEncryptionPasswordIfNeeded(AppConfig *appConfig)
     if (!useKeyStore)
         removePasswordFromKeychain();
 
-    if ( !appConfig->option<Config::tab_encryption_enabled>() ) {
+    if ( !appConfig->option<Config::encrypt_tabs>() ) {
         m_sharedData->encryptionKey.clear();
     } else if ( !m_sharedData->encryptionKey.isValid() ) {
         const auto prompt = useKeyStore
@@ -3727,7 +3727,7 @@ void MainWindow::reencryptTabsIfNeeded(const QStringList &tabNames, AppConfig *a
 
 void MainWindow::reencryptTabsIfNeededHelper(const QStringList &tabNames, AppConfig *appConfig)
 {
-    const bool isEncrypted = appConfig->option<Config::tab_encryption_enabled>();
+    const bool isEncrypted = appConfig->option<Config::encrypt_tabs>();
     if (m_wasEncrypted == isEncrypted)
         return;
 
@@ -3742,7 +3742,7 @@ void MainWindow::reencryptTabsIfNeededHelper(const QStringList &tabNames, AppCon
 
     // Revert encryption option if password was not provided.
     if (!oldEncryptionKey.isValid() && !newEncryptionKey.isValid()) {
-        appConfig->setOption(Config::tab_encryption_enabled::name(), m_wasEncrypted);
+        appConfig->setOption(Config::encrypt_tabs::name(), m_wasEncrypted);
         return;
     }
 
@@ -3766,7 +3766,7 @@ void MainWindow::reencryptTabsIfNeededHelper(const QStringList &tabNames, AppCon
             if (appConfig->option<Config::use_key_store>())
                 removePasswordFromKeychain();
         } else {
-            appConfig->setOption(Config::tab_encryption_enabled::name(), true);
+            appConfig->setOption(Config::encrypt_tabs::name(), true);
             m_wasEncrypted = true;
             m_sharedData->encryptionKey = oldEncryptionKey;
         }

src/tests/itemsynctests.cpp

@@ -1077,7 +1077,7 @@ void ItemSyncTests::encryptionShouldNotAffectFiles()
 
     QCOMPARE(dir1.files().join(sep), files.join(sep));
 
-    RUN("config" << "tab_encryption_enabled" << "true", "true\n");
+    RUN("config" << "encrypt_tabs" << "true", "true\n");
 
     RUN(args << inspect,
         "0: itemsync-basename:test1 text/plain:TEXT1 ;; "

src/tests/tests_encryption.cpp

@@ -13,7 +13,7 @@ void Tests::tabEncryption()
 
     // Enable tab encryption - this should work even if the encryption support
     // is not build into the app.
-    RUN("config" << "tab_encryption_enabled" << "true", "true\n");
+    RUN("config" << "encrypt_tabs" << "true", "true\n");
 
     // Verify tab doesn't exist yet
     QVERIFY( !hasTab(tab) );
@@ -50,7 +50,7 @@ void Tests::tabEncryption()
     // Password is needed when disabling encryption
     runMultiple(
         [&]() { KEYS(passwordEntryCurrentId << ":TEST123" << "ENTER"); },
-        [&]() { RUN("config" << "tab_encryption_enabled" << "false", "false\n"); }
+        [&]() { RUN("config" << "encrypt_tabs" << "false", "false\n"); }
     );
     KEYS(clipboardBrowserId);
 #endif
@@ -81,7 +81,7 @@ void Tests::tabEncryptionPasswordNew()
                 << passwordEntryRetypeId << ":TEST123" << "ENTER"
             );
         },
-        [&]() { RUN("config" << "tab_encryption_enabled" << "true", "true\n"); }
+        [&]() { RUN("config" << "encrypt_tabs" << "true", "true\n"); }
     );
     KEYS(clipboardBrowserId);
 
@@ -113,7 +113,7 @@ void Tests::tabEncryptionPasswordCurrent()
     const Args args = Args("tab") << tab << "separator" << " ";
     RUN(args << "add" << "test data 3" << "test data 2" << "test data 1", "");
 
-    RUN("config" << "tab_encryption_enabled" << "true", "true\n");
+    RUN("config" << "encrypt_tabs" << "true", "true\n");
 
     m_test->setEnv("COPYQ_PASSWORD", ":TEST");
     m_test->ignoreErrors(QRegularExpression("Loaded password does not match the stored hash"));
@@ -151,7 +151,7 @@ void Tests::tabEncryptionPasswordRetry()
                 << passwordEntryRetypeId << ":TEST123" << "ENTER"
             );
         },
-        [&]() { RUN("config" << "tab_encryption_enabled" << "true", "true\n"); }
+        [&]() { RUN("config" << "encrypt_tabs" << "true", "true\n"); }
     );
     KEYS(clipboardBrowserId);
 #else
@@ -189,11 +189,11 @@ void Tests::tabEncryptionPasswordRetryFail()
                 << passwordMessageFailedId << "ENTER"
             );
         },
-        [&]() { RUN("config" << "tab_encryption_enabled" << "true", "true\n"); }
+        [&]() { RUN("config" << "encrypt_tabs" << "true", "true\n"); }
     );
 
     // If the initial password was not provided, encryption should be disabled.
-    RUN("config" << "tab_encryption_enabled", "false\n");
+    RUN("config" << "encrypt_tabs", "false\n");
 #else
     SKIP("Encryption support not built-in");
 #endif
@@ -202,7 +202,7 @@ void Tests::tabEncryptionPasswordRetryFail()
 void Tests::tabEncryptionLargeItems()
 {
 #ifdef WITH_QCA_ENCRYPTION
-    RUN("config" << "tab_encryption_enabled" << "true", "true\n");
+    RUN("config" << "encrypt_tabs" << "true", "true\n");
 
     const auto tab = testTab(1);
     const auto args = Args("tab") << tab;
@@ -234,7 +234,7 @@ void Tests::tabEncryptionLargeItems()
 void Tests::tabEncryptionChangePassword()
 {
 #ifdef WITH_QCA_ENCRYPTION
-    RUN("config" << "tab_encryption_enabled" << "true", "true\n");
+    RUN("config" << "encrypt_tabs" << "true", "true\n");
 
     const auto tab = testTab(1);
     const auto args = Args("tab") << tab;
@@ -277,7 +277,7 @@ void Tests::tabEncryptionMissingHash()
 {
     // Ensure that missing hash file does not lock users out from their data.
 #ifdef WITH_QCA_ENCRYPTION
-    RUN("config" << "tab_encryption_enabled" << "true", "true\n");
+    RUN("config" << "encrypt_tabs" << "true", "true\n");
 
     const auto tab = testTab(1);
     const auto args = Args("tab") << tab;
@@ -318,10 +318,10 @@ void Tests::tabEncryptionMissingHash()
     // Try to disable decryption with a wrong password
     runMultiple(
         [&]() { KEYS(passwordEntryCurrentId << ":TEST1234" << "ENTER"); },
-        [&]() { RUN("config" << "tab_encryption_enabled" << "false", "false\n"); }
+        [&]() { RUN("config" << "encrypt_tabs" << "false", "false\n"); }
     );
     KEYS(clipboardBrowserId);
-    RUN("config" << "tab_encryption_enabled", "true\n");
+    RUN("config" << "encrypt_tabs", "true\n");
 
     TEST( m_test->stopServer() );
 
@@ -335,10 +335,10 @@ void Tests::tabEncryptionMissingHash()
     // Disable decryption
     runMultiple(
         [&]() { KEYS(passwordEntryCurrentId << ":TEST123" << "ENTER"); },
-        [&]() { RUN("config" << "tab_encryption_enabled" << "false", "false\n"); }
+        [&]() { RUN("config" << "encrypt_tabs" << "false", "false\n"); }
     );
     KEYS(clipboardBrowserId);
-    RUN("config" << "tab_encryption_enabled", "false\n");
+    RUN("config" << "encrypt_tabs", "false\n");
 
     TEST( m_test->stopServer() );
 

src/ui/configtabgeneral.ui

@@ -161,12 +161,12 @@
        </widget>
       </item>
       <item>
-       <widget class="QCheckBox" name="checkBoxTabEncryption">
+       <widget class="QCheckBox" name="checkBoxEncryptTabs">
         <property name="toolTip">
          <string>Encrypt tab data on disk (requires password to be set)</string>
         </property>
         <property name="text">
-         <string>Enable &amp;tab encryption</string>
+         <string>Encrypt &amp;Tabs</string>
         </property>
        </widget>
       </item>
@@ -399,7 +399,7 @@
   <tabstop>checkBoxOpenWindowsOnCurrentScreen</tabstop>
   <tabstop>checkBoxConfirmExit</tabstop>
   <tabstop>checkBoxAutostart</tabstop>
-  <tabstop>checkBoxTabEncryption</tabstop>
+  <tabstop>checkBoxEncryptTabs</tabstop>
   <tabstop>checkBoxUseKeychain</tabstop>
   <tabstop>pushButtonChangeEncryptionPassword</tabstop>
   <tabstop>comboBoxNavigationStyle</tabstop>