Add new database wizard and redesign master key widget #1952

phoerious · 2018-05-13T21:32:13Z

Description

This is a WIP PR for adding a user-friendly "New Database" wizard, redesigning the master key change widget, and performing other heavy refactoring in order to make things more streamlined, consistent and reusable.

The PR also fixes several old UX issues, e.g. that canceling database creation still saves a new database without contents and key. It als makes KDBX 4.0 + Argon2-KDF the default setting.

TODO:

Motivation and context

The database setup procedure is very basic and not very friendly towards new and non-technical users. KDF settings etc. are not discoverable, so users will only use the defaults. Also many widgets and APIs are not reusable, which makes it hard to use them in other contexts, such as a wizard.

Resolves #1669, resolves #124

How has this been tested?

n/a

Screenshots (if appropriate):

Types of changes

✅ New feature (breaking (!!!) change which adds functionality)

Checklist:

✅ I have read the CONTRIBUTING document. [REQUIRED]
✅ My code follows the code style of this project. [REQUIRED]
✅ All new and existing tests passed. [REQUIRED]
✅ I have compiled and verified my code with -DWITH_ASAN=ON. [REQUIRED]

hifi · 2018-05-14T17:45:59Z

The master key part may need more explanation what to select and why. A new user might think one needs to use all of them. Maybe have the key and challenge response behind an Advanced button?

phoerious · 2018-05-14T17:49:46Z

I'm planning on redesigning it completely.

Generator · 2018-05-19T16:25:43Z

This fixes #1669

TheZ3ro · 2018-05-22T08:18:45Z

Just 2 notes:

the icon in the dialog isn't horizontally aligned
set a proper window title instead of "keepassxc"

Anyway, great work

phoerious · 2018-05-23T07:52:39Z

I know. The icon is just a placeholder until I have something else. ;-)

droidmonkey · 2018-05-25T02:49:41Z

Need to add the password generator widget to the master key dialog. Maybe even a "Generate..." button which opens the password generator as a modal dialog.

phoerious · 2018-05-25T04:33:01Z

I've done all that (and much more) already. I will update the screenshots once I've put everything together for you guys to review.

droidmonkey · 2018-07-14T12:38:16Z

@phoerious is this ready?

TheZ3ro · 2018-07-16T17:15:12Z

I don't think so, tests are failing and 4 files are conflicting now

phoerious · 2018-07-29T13:57:09Z

No, I still need to adjust the tests. I also got feedback on it at the UX Forum, so I want to implement that as well.

droidmonkey

Fantastic work!

src/core/Config.cpp

droidmonkey · 2018-09-24T12:07:51Z

src/gui/DatabaseWidget.cpp

    m_csvImportWizard = new CsvImportWizard();
    m_csvImportWizard->setObjectName("csvImportWizard");
-    m_databaseSettingsWidget = new DatabaseSettingsWidget();
+    m_databaseSettingsWidget = new DatabaseSettingsDialog();


There is a name mismatch

droidmonkey · 2018-09-24T12:34:31Z

src/gui/dbsettings/DatabaseSettingsDialog.cpp

+void DatabaseSettingsDialog::save()
+{
+    if (!m_generalWidget->save())
+        return;


Simple if statements in this whole file need braces

droidmonkey · 2018-09-24T12:36:59Z

src/gui/dbsettings/DatabaseSettingsDialog.cpp

+{
+    int pageIndex = m_ui->stackedWidget->currentIndex();
+
+    bool enabled = (pageIndex == 0 && m_generalWidget->hasAdvancedMode());


I'd prefer not to use magic numbers for GUI page indexes. Can we shove these into const ints?

src/gui/dbsettings/DatabaseSettingsWidgetEncryption.cpp

droidmonkey · 2018-09-24T13:04:54Z

src/gui/masterkey/KeyFileEditWidget.h

+public:
+    explicit KeyFileEditWidget(QWidget* parent = nullptr);
+    Q_DISABLE_COPY(KeyFileEditWidget);
+    ~KeyFileEditWidget();


src/gui/masterkey/KeyComponentWidget.cpp

droidmonkey · 2018-09-24T13:16:46Z

src/gui/wizard/NewDatabaseWizard.cpp

+    setWindowTitle(tr("Create a new KeePassXC database..."));
+
+    // TODO: change image
+    setPixmap(QWizard::BackgroundPixmap, filePath()->applicationIcon().pixmap(512, 512));


Don't forget to do this 😉

Never!!!111eleven

src/gui/wizard/NewDatabaseWizardPage.h

droidmonkey · 2018-09-24T13:19:03Z

src/gui/wizard/NewDatabaseWizardPageMetaData.cpp

+    setPageWidget(new DatabaseSettingWidgetMetaData());
+
+    setTitle(tr("General Database Information"));
+    setSubTitle(tr("Please fill in the name, and optional description "


... display name, optional description, and ...

I think that was supposed to be an "an". But I just realised that default username is obsolete. It's not shown here anymore.

droidmonkey

One additional change

droidmonkey · 2018-09-24T13:26:36Z

src/gui/masterkey/YubiKeyEditWidget.cpp

+{
+    setComponentName(tr("YubiKey Challenge-Response"));
+    setComponentDescription(tr("<p>If you possess a <a href=\"https://www.yubico.com/\">YubiKey</a>, you can add it "
+                               "for additional security.</p><p>The YubiKey needs to be programmed with an "


Recommended wording: "If you own a YubiKey, you can use it for additional security. The YubiKey requires one of its slots to be programmed as HMAC-SHA1 Challenge-Response."

weslly

Works and looks great to me, but the master password input always show in clear text by default. Is this intended?

phoerious · 2018-09-24T19:13:33Z

Yes, it's actually intended, because at that time you need to put some thought into a strong yet memorable master password and it's very unlikely that somebody is should surfing (in which case you can hide it). The password generator inherits whatever state the PasswordEdit field is in (here it really doesn't make any sense to hide it).

This patch implements a new database wizard to guide users through the process of setting up a new database and choosing sane encryption settings. It also reimplements the master key settings to be more user-friendly. Users can now add, change, or remove individual composite key components instead of having to set all components at once. This avoids confusion about a password being reset if the user only wants to add a key file. With these changes comes a major refactor of how database composite keys and key components are handled. Copying of keys is prohibited and each key exists only once in memory and is referenced via shared pointers. GUI components for changing individual keys are encapsulated into separate classes to be more reusable. The password edit and generator widgets have also been refactored to be more reusable.

droidmonkey · 2018-09-25T19:08:35Z

I approve merging this PR (final 👍 )

Pull request #1952 introduced a compilation error on macOS due to missing header includes.

Pull request keepassxreboot#1952 introduced a compilation error on macOS due to missing header includes.

- New Database Wizard [#1952] - Advanced Search [#1797] - Automatic update checker [#2648] - KeeShare database synchronization [#2109, #1992, #2738, #2742, #2746, #2739] - Improve favicon fetching; transition to Duck-Duck-Go [#2795, #2011, #2439] - Remove KeePassHttp support [#1752] - CLI: output info to stderr for easier scripting [#2558] - CLI: Add --quiet option [#2507] - CLI: Add create command [#2540] - CLI: Add recursive listing of entries [#2345] - CLI: Fix stdin/stdout encoding on Windows [#2425] - SSH Agent: Support OpenSSH for Windows [#1994] - macOS: TouchID Quick Unlock [#1851] - macOS: Multiple improvements; include CLI in DMG [#2165, #2331, #2583] - Linux: Prevent Klipper from storing secrets in clipboard [#1969] - Linux: Use polling based file watching for NFS [#2171] - Linux: Enable use of browser plugin in Snap build [#2802] - TOTP QR Code Generator [#1167] - High-DPI Scaling for 4k screens [#2404] - Make keyboard shortcuts more consistent [#2431] - Warn user if deleting referenced entries [#1744] - Allow toolbar to be hidden and repositioned [#1819, #2357] - Increase max allowed database timeout to 12 hours [#2173] - Password generator uses existing password length by default [#2318] - Improve alert message box button labels [#2376] - Show message when a database merge makes no changes [#2551] - Browser Integration Enhancements [#1497, #2253, #1904, #2232, #1850, #2218, #2391, #2396, #2542, #2622, #2637, #2790] - Overall Code Improvements [#2316, #2284, #2351, #2402, #2410, #2419, #2422, #2443, #2491, #2506, #2610, #2667, #2709, #2731]

sts10 · 2019-03-20T02:23:43Z

This is really great! I did have one potentially annoying question... feel free to dismiss for a reason I'm missing!

I feel like it's a bit deceptive to have the number of transform rounds change from a 1 second benchmark to just 1 round when users peak into the Advanced section. Shouldn't it keep the default of a 1 second benchmark given in the simple setup? I'm thinking about users who are curious about the Advanced settings, but don't know to hit the "Benchmark" button...

That said, I'm not sure what a good fix to this is, other than running the 1 second benchmark right when the user clicks the "Advanced" button, which seems not great as the user might think something wrong?

droidmonkey · 2019-03-20T02:28:02Z

@sts10 please file a new issue for this, that is a bug

sts10 · 2019-03-20T02:47:34Z

Filed: #2806

phoerious added user interface new feature labels May 13, 2018

phoerious added this to the v2.4.0 milestone May 13, 2018

phoerious added the needs work label May 13, 2018

phoerious force-pushed the feature/new-db-wizard branch from 30bc621 to 577600c Compare May 23, 2018 23:38

phoerious changed the title ~~Add new database wizard~~ Add new database wizard and redesign master key widget May 26, 2018

phoerious force-pushed the feature/new-db-wizard branch from ed2b9f0 to 55c9e51 Compare May 26, 2018 13:06

phoerious mentioned this pull request Jun 8, 2018

Change master key UI suggests that it will be modified, not overwritten #1698

Closed

phoerious force-pushed the feature/new-db-wizard branch from 55c9e51 to a4b1d2f Compare June 8, 2018 13:48

droidmonkey requested review from droidmonkey, louib, weslly and TheZ3ro July 9, 2018 00:36

droidmonkey mentioned this pull request Jul 14, 2018

Show password entropy when setting database password #124

Closed

phoerious force-pushed the feature/new-db-wizard branch from d26f59e to 9a6c4f6 Compare July 24, 2018 22:07

droidmonkey mentioned this pull request Aug 24, 2018

UI Redesign #1705

Closed

phoerious force-pushed the feature/new-db-wizard branch 4 times, most recently from 525d297 to fa0c217 Compare September 22, 2018 16:39

phoerious force-pushed the feature/new-db-wizard branch from 4b5b518 to b60186d Compare September 23, 2018 16:55

droidmonkey requested changes Sep 24, 2018

View reviewed changes

phoerious force-pushed the feature/new-db-wizard branch 2 times, most recently from 6dd0e88 to 427884b Compare September 24, 2018 17:19

droidmonkey approved these changes Sep 24, 2018

View reviewed changes

phoerious force-pushed the feature/new-db-wizard branch 2 times, most recently from 96c084c to 5106d6e Compare September 24, 2018 18:30

weslly reviewed Sep 24, 2018

View reviewed changes

phoerious force-pushed the feature/new-db-wizard branch from 5106d6e to 414f690 Compare September 24, 2018 18:55

phoerious added EPIC and removed needs work labels Sep 24, 2018

phoerious force-pushed the feature/new-db-wizard branch from 414f690 to d53da87 Compare September 24, 2018 19:15

phoerious added 2 commits September 24, 2018 21:18

Enable color output in Docker images

79be20b

phoerious force-pushed the feature/new-db-wizard branch from d53da87 to 79be20b Compare September 24, 2018 19:18

phoerious merged commit 5295a68 into develop Sep 25, 2018

phoerious deleted the feature/new-db-wizard branch September 25, 2018 19:12

droidmonkey mentioned this pull request Sep 30, 2018

Generate warning when using short master password #2049

Closed

phoerious pushed a commit that referenced this pull request Oct 3, 2018

Fix TouchID compiling on macOS (#2332)

aa7216b

Pull request #1952 introduced a compilation error on macOS due to missing header includes.

coelebs pushed a commit to coelebs/keepassxc that referenced this pull request Oct 3, 2018

Fix TouchID compiling on macOS (keepassxreboot#2332)

ed8bdce

Pull request keepassxreboot#1952 introduced a compilation error on macOS due to missing header includes.

droidmonkey mentioned this pull request Jul 10, 2019

UX improvements to New Database flow #836

Closed

phoerious added pr: new feature Pull request that adds a new feature and removed new feature labels Nov 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new database wizard and redesign master key widget #1952

Add new database wizard and redesign master key widget #1952

phoerious commented May 13, 2018 •

edited

Loading

hifi commented May 14, 2018

phoerious commented May 14, 2018 •

edited

Loading

Generator commented May 19, 2018

TheZ3ro commented May 22, 2018

phoerious commented May 23, 2018

droidmonkey commented May 25, 2018 •

edited

Loading

phoerious commented May 25, 2018

droidmonkey commented Jul 14, 2018

TheZ3ro commented Jul 16, 2018

phoerious commented Jul 29, 2018

droidmonkey left a comment

droidmonkey Sep 24, 2018

droidmonkey Sep 24, 2018

droidmonkey Sep 24, 2018

droidmonkey Sep 24, 2018

droidmonkey Sep 24, 2018

phoerious Sep 24, 2018

droidmonkey Sep 24, 2018

phoerious Sep 24, 2018

droidmonkey left a comment

droidmonkey Sep 24, 2018 •

edited

Loading

weslly left a comment

phoerious commented Sep 24, 2018

droidmonkey commented Sep 25, 2018

sts10 commented Mar 20, 2019 •

edited

Loading

droidmonkey commented Mar 20, 2019

sts10 commented Mar 20, 2019

Add new database wizard and redesign master key widget #1952

Add new database wizard and redesign master key widget #1952

Conversation

phoerious commented May 13, 2018 • edited Loading

Description

Motivation and context

How has this been tested?

Screenshots (if appropriate):

Types of changes

Checklist:

hifi commented May 14, 2018

phoerious commented May 14, 2018 • edited Loading

Generator commented May 19, 2018

TheZ3ro commented May 22, 2018

phoerious commented May 23, 2018

droidmonkey commented May 25, 2018 • edited Loading

phoerious commented May 25, 2018

droidmonkey commented Jul 14, 2018

TheZ3ro commented Jul 16, 2018

phoerious commented Jul 29, 2018

droidmonkey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

droidmonkey left a comment

Choose a reason for hiding this comment

droidmonkey Sep 24, 2018 • edited Loading

Choose a reason for hiding this comment

weslly left a comment

Choose a reason for hiding this comment

phoerious commented Sep 24, 2018

droidmonkey commented Sep 25, 2018

sts10 commented Mar 20, 2019 • edited Loading

droidmonkey commented Mar 20, 2019

sts10 commented Mar 20, 2019

phoerious commented May 13, 2018 •

edited

Loading

phoerious commented May 14, 2018 •

edited

Loading

droidmonkey commented May 25, 2018 •

edited

Loading

droidmonkey Sep 24, 2018 •

edited

Loading

sts10 commented Mar 20, 2019 •

edited

Loading