Implement Password Health Report

Introduce a password health check to the application that evaluates every entry in a database. Entries that fail various tests are listed for user review and action. Also moves the statistics panel to the new Database -> Reports widget. Recycled entries are excluded from the results. We now have two classes, PasswordHealth to deal with a single password and HealthChecker to deal with all passwords of a database. Tests include passwords that are expired, re-used, and weak. * Closes #551 * Move zxcvbn usage to a centralized class (PasswordHealth) and replace its usages across the application to ensure standardized interpretation of entropy calculations. * Add new icons for the database reports view * Updated the demo database to show off the reports
2020-02-01 08:42:34 -05:00
parent 71a39c37ec
commit a81c6469a8
38 changed files with 1364 additions and 75 deletions
--- a/src/gui/reports/ReportsDialog.cpp
+++ b/src/gui/reports/ReportsDialog.cpp
@@ -0,0 +1,128 @@
+/*
+ *  Copyright (C) 2019 KeePassXC Team <team@keepassxc.org>
+ *
+ *  This program is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 2 or (at your option)
+ *  version 3 of the License.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "ReportsDialog.h"
+#include "ui_ReportsDialog.h"
+
+#include "ReportsPageHealthcheck.h"
+#include "ReportsPageStatistics.h"
+#include "ReportsWidgetHealthcheck.h"
+
+#include "core/Global.h"
+#include "touchid/TouchID.h"
+#include <core/Entry.h>
+#include <core/Group.h>
+
+class ReportsDialog::ExtraPage
+{
+public:
+    ExtraPage(QSharedPointer<IReportsPage> p, QWidget* w)
+        : page(p)
+        , widget(w)
+    {
+    }
+    void loadSettings(QSharedPointer<Database> db) const
+    {
+        page->loadSettings(widget, db);
+    }
+    void saveSettings() const
+    {
+        page->saveSettings(widget);
+    }
+
+private:
+    QSharedPointer<IReportsPage> page;
+    QWidget* widget;
+};
+
+ReportsDialog::ReportsDialog(QWidget* parent)
+    : DialogyWidget(parent)
+    , m_ui(new Ui::ReportsDialog())
+    , m_healthPage(new ReportsPageHealthcheck())
+    , m_statPage(new ReportsPageStatistics())
+    , m_editEntryWidget(new EditEntryWidget(this))
+{
+    m_ui->setupUi(this);
+
+    connect(m_ui->buttonBox, SIGNAL(rejected()), SLOT(reject()));
+    addPage(m_healthPage);
+    addPage(m_statPage);
+
+    m_ui->stackedWidget->setCurrentIndex(0);
+
+    m_editEntryWidget->setObjectName("editEntryWidget");
+    m_editEntryWidget->setSizePolicy(QSizePolicy::Ignored, QSizePolicy::Ignored);
+    m_ui->stackedWidget->addWidget(m_editEntryWidget);
+    adjustSize();
+
+    connect(m_ui->categoryList, SIGNAL(categoryChanged(int)), m_ui->stackedWidget, SLOT(setCurrentIndex(int)));
+    connect(m_healthPage->m_healthWidget,
+            SIGNAL(entryActivated(const Group*, Entry*)),
+            SLOT(entryActivationSignalReceived(const Group*, Entry*)));
+    connect(m_editEntryWidget, SIGNAL(editFinished(bool)), SLOT(switchToMainView(bool)));
+}
+
+ReportsDialog::~ReportsDialog()
+{
+}
+
+void ReportsDialog::load(const QSharedPointer<Database>& db)
+{
+    m_ui->categoryList->setCurrentCategory(0);
+    for (const ExtraPage& page : asConst(m_extraPages)) {
+        page.loadSettings(db);
+    }
+    m_db = db;
+}
+
+void ReportsDialog::addPage(QSharedPointer<IReportsPage> page)
+{
+    const auto category = m_ui->categoryList->currentCategory();
+    const auto widget = page->createWidget();
+    widget->setParent(this);
+    m_extraPages.append(ExtraPage(page, widget));
+    m_ui->stackedWidget->addWidget(widget);
+    m_ui->categoryList->addCategory(page->name(), page->icon());
+    m_ui->categoryList->setCurrentCategory(category);
+}
+
+void ReportsDialog::reject()
+{
+    for (const ExtraPage& extraPage : asConst(m_extraPages)) {
+        extraPage.saveSettings();
+    }
+
+#ifdef WITH_XC_TOUCHID
+    TouchID::getInstance().reset(m_db ? m_db->filePath() : "");
+#endif
+
+    emit editFinished(true);
+}
+
+void ReportsDialog::entryActivationSignalReceived(const Group* group, Entry* entry)
+{
+    m_editEntryWidget->loadEntry(entry, false, false, group->hierarchy().join(" > "), m_db);
+    m_ui->stackedWidget->setCurrentWidget(m_editEntryWidget);
+}
+
+void ReportsDialog::switchToMainView(bool previousDialogAccepted)
+{
+    m_ui->stackedWidget->setCurrentWidget(m_healthPage->m_healthWidget);
+    if (previousDialogAccepted) {
+        m_healthPage->m_healthWidget->calculateHealth();
+    }
+}