forked from keepassxreboot/keepassxc
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Check passwords against the HIBP online service (keepassxreboot#4438)
* Fixes keepassxreboot#1083 * Add online HIBP checker dialog to the database reports widget. Permission is requested from the user prior to performing any network operations. * The number of times a password has been found in a breach is shown to the user. * If no passwords are breached then a positive message is presented. * Source of HIBP icon: https://github.com/simple-icons/simple-icons/blob/develop/icons/haveibeenpwned.svg Authored-by: Wolfram Rösler <[email protected]> Co-authored-by: Jonathan White <[email protected]>
- Loading branch information
1 parent
464e49d
commit 83ed9a8
Showing
18 changed files
with
948 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| /* | ||
| * Copyright (C) 2020 KeePassXC Team <[email protected]> | ||
| * | ||
| * 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 "HibpDownloader.h" | ||
| #include "core/Config.h" | ||
| #include "core/Global.h" | ||
| #include "core/NetworkManager.h" | ||
|
|
||
| #include <QCryptographicHash> | ||
| #include <QUrl> | ||
| #include <QtNetwork> | ||
|
|
||
| namespace | ||
| { | ||
| /* | ||
| * Return the SHA1 hash of the specified password in upper-case hex. | ||
| * | ||
| * The result is always exactly 40 characters long. | ||
| */ | ||
| QString sha1Hex(const QString& password) | ||
| { | ||
| // Get the binary SHA1 | ||
| const auto sha1 = QCryptographicHash::hash(password.toUtf8(), QCryptographicHash::Sha1); | ||
| return sha1.toHex().toUpper(); | ||
| } | ||
|
|
||
| /* | ||
| * Search a password's hash in the output of the HIBP web service. | ||
| * | ||
| * Returns the number of times the password is found in breaches, or | ||
| * 0 if the password is not in the HIBP result. | ||
| */ | ||
| int pwnCount(const QString& password, const QString& hibpResult) | ||
| { | ||
| // The first 5 characters of the hash are in the URL already, | ||
| // the HIBP result contains the remainder | ||
| auto pos = hibpResult.indexOf(sha1Hex(password).mid(5)); | ||
| if (pos < 0) { | ||
| return 0; | ||
| } | ||
|
|
||
| // Skip past the sha1 and ':' | ||
| pos += 36; | ||
|
|
||
| // Find where the count ends | ||
| auto end = hibpResult.indexOf('\n', pos); | ||
| if (end < 0) { | ||
| end = hibpResult.size(); | ||
| } | ||
|
|
||
| // Extract the count, remove remaining whitespace, and convert to int | ||
| return hibpResult.midRef(pos, end - pos).trimmed().toInt(); | ||
| } | ||
| } // namespace | ||
|
|
||
| HibpDownloader::HibpDownloader(QObject* parent) | ||
| : QObject(parent) | ||
| { | ||
| } | ||
|
|
||
| HibpDownloader::~HibpDownloader() | ||
| { | ||
| abort(); | ||
| } | ||
|
|
||
| /* | ||
| * Add one password to the list list of passwords to check. | ||
| * | ||
| * Invoke this function once for every password to check, | ||
| * then call validate(). | ||
| */ | ||
| void HibpDownloader::add(const QString& password) | ||
| { | ||
| if (!m_pwdsToTry.contains(password)) { | ||
| m_pwdsToTry << password; | ||
| } | ||
| } | ||
|
|
||
| /* | ||
| * Start validating the passwords against HIBP. | ||
| */ | ||
| void HibpDownloader::validate() | ||
| { | ||
| for (auto password : m_pwdsToTry) { | ||
| // The URL we query is https://api.pwnedpasswords.com/range/XXXXX, | ||
| // where XXXXX is the first five bytes of the hex representation of | ||
| // the password's SHA1. | ||
| const auto url = QString("https://api.pwnedpasswords.com/range/") + sha1Hex(password).left(5); | ||
|
|
||
| // HIBP requires clients to specify a user agent in the request | ||
| // (https://haveibeenpwned.com/API/v3#UserAgent); however, in order | ||
| // to minimize the amount of information we expose about ourselves, | ||
| // we don't add the KeePassXC version number or platform. | ||
| auto request = QNetworkRequest(url); | ||
| request.setRawHeader("User-Agent", "KeePassXC"); | ||
|
|
||
| // Finally, submit the request to HIBP. | ||
| auto reply = getNetMgr()->get(request); | ||
| connect(reply, &QNetworkReply::finished, this, &HibpDownloader::fetchFinished); | ||
| connect(reply, &QIODevice::readyRead, this, &HibpDownloader::fetchReadyRead); | ||
| m_replies.insert(reply, {password, {}}); | ||
| } | ||
|
|
||
| m_pwdsToTry.clear(); | ||
| } | ||
|
|
||
| int HibpDownloader::passwordsToValidate() const | ||
| { | ||
| return m_pwdsToTry.size(); | ||
| } | ||
|
|
||
| int HibpDownloader::passwordsRemaining() const | ||
| { | ||
| return m_replies.size(); | ||
| } | ||
|
|
||
| /* | ||
| * Abort the current online activity (if any). | ||
| */ | ||
| void HibpDownloader::abort() | ||
| { | ||
| for (auto reply : m_replies.keys()) { | ||
| reply->abort(); | ||
| reply->deleteLater(); | ||
| } | ||
| m_replies.clear(); | ||
| } | ||
|
|
||
| /* | ||
| * Called when new data has been loaded from the HIBP server. | ||
| */ | ||
| void HibpDownloader::fetchReadyRead() | ||
| { | ||
| const auto reply = qobject_cast<QNetworkReply*>(sender()); | ||
| auto entry = m_replies.find(reply); | ||
| if (entry != m_replies.end()) { | ||
| entry->second += reply->readAll(); | ||
| } | ||
| } | ||
|
|
||
| /* | ||
| * Called after all data has been loaded from the HIBP server. | ||
| */ | ||
| void HibpDownloader::fetchFinished() | ||
| { | ||
| const auto reply = qobject_cast<QNetworkReply*>(sender()); | ||
| const auto entry = m_replies.find(reply); | ||
| if (entry == m_replies.end()) { | ||
| return; | ||
| } | ||
|
|
||
| // Get result status | ||
| const auto ok = reply->error() == QNetworkReply::NoError; | ||
| const auto err = reply->errorString(); | ||
|
|
||
| const auto password = entry->first; | ||
| const auto hibpReply = entry->second; | ||
|
|
||
| reply->deleteLater(); | ||
| m_replies.remove(reply); | ||
|
|
||
| // If there was an error, assume it's permanent and abort | ||
| // (don't process the rest of the password list). | ||
| if (!ok) { | ||
| auto msg = tr("Online password validation failed") + ":\n" + err; | ||
| if (!hibpReply.isEmpty()) { | ||
| msg += "\n" + hibpReply; | ||
| } | ||
| abort(); | ||
| emit fetchFailed(msg); | ||
| return; | ||
| } | ||
|
|
||
| // Current password validated, send the result to the caller | ||
| emit hibpResult(password, pwnCount(password, hibpReply)); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /* | ||
| * Copyright (C) 2020 KeePassXC Team <[email protected]> | ||
| * | ||
| * 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/>. | ||
| */ | ||
|
|
||
| #ifndef KEEPASSXC_HIBPDOWNLOADER_H | ||
| #define KEEPASSXC_HIBPDOWNLOADER_H | ||
|
|
||
| #include "config-keepassx.h" | ||
| #include <QHash> | ||
| #include <QObject> | ||
| #include <QTimer> | ||
|
|
||
| #ifndef WITH_XC_NETWORKING | ||
| #error This file requires KeePassXC to be built with network support. | ||
| #endif | ||
|
|
||
| class QNetworkReply; | ||
|
|
||
| /* | ||
| * Check if a password has been hacked by looking it up on the | ||
| * "Have I Been Pwned" website (https://haveibeenpwned.com/) | ||
| * in the background. | ||
| * | ||
| * Usage: Pass the password to check to the ctor and process | ||
| * the `finished` signal to get the result. Process the | ||
| * `failed` signal to handle errors. | ||
| */ | ||
| class HibpDownloader : public QObject | ||
| { | ||
| Q_OBJECT | ||
|
|
||
| public: | ||
| explicit HibpDownloader(QObject* parent = nullptr); | ||
| ~HibpDownloader() override; | ||
|
|
||
| void add(const QString& password); | ||
| void validate(); | ||
| int passwordsToValidate() const; | ||
| int passwordsRemaining() const; | ||
|
|
||
| signals: | ||
| void hibpResult(const QString& password, int count); | ||
| void fetchFailed(const QString& error); | ||
|
|
||
| public slots: | ||
| void abort(); | ||
|
|
||
| private slots: | ||
| void fetchFinished(); | ||
| void fetchReadyRead(); | ||
|
|
||
| private: | ||
| void fetchPassword(const QString& password); | ||
|
|
||
| QStringList m_pwdsToTry; // The list of remaining passwords to validate | ||
| QHash<QNetworkReply*, QPair<QString, QByteArray>> m_replies; | ||
| }; | ||
|
|
||
| #endif // KEEPASSXC_HIBPDOWNLOADER_H |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.