Add OTP management

Author: Mahdi-zarei

3rdparty/QrDecoder.cpp

@@ -1,6 +1,7 @@
 #include "QrDecoder.h"
 
 #include "quirc/quirc.h"
+#include <cstring>
 #include <qdebug.h>
 
 #include "quirc/quirc_internal.h"
@@ -23,7 +24,17 @@ QVector<QString> QrDecoder::decode(const QImage &image)
         return result;
     }
 
-    if (quirc_resize(m_qr, image.width(), image.height()) < 0)
+    const QImage grey = image.format() == QImage::Format_Grayscale8
+                            ? image
+                            : image.convertToFormat(QImage::Format_Grayscale8);
+    const int width = grey.width();
+    const int height = grey.height();
+    if (width <= 0 || height <= 0)
+    {
+        return result;
+    }
+
+    if (quirc_resize(m_qr, width, height) < 0)
     {
         return result;
     }
@@ -33,7 +44,11 @@ QVector<QString> QrDecoder::decode(const QImage &image)
     {
         return result;
     }
-    std::copy(image.constBits(), image.constBits() + image.width()*image.height(), rawImage);
+    // QImage pads scanlines to 4 bytes, quirc wants them packed: copying straight through shears it.
+    for (int y = 0; y < height; ++y)
+    {
+        std::memcpy(rawImage + static_cast<size_t>(y) * width, grey.constScanLine(y), width);
+    }
     quirc_end(m_qr);
 
     const int count = quirc_count(m_qr);
@@ -51,7 +66,7 @@ QVector<QString> QrDecoder::decode(const QImage &image)
         const quirc_decode_error_t err = quirc_decode(&code, &data);
         if (err == QUIRC_SUCCESS)
         {
-            result.append(QLatin1String((const char *)data.payload));
+            result.append(QString::fromUtf8((const char *)data.payload, data.payload_len));
         }
     }
 

CMakeLists.txt

@@ -93,6 +93,8 @@ set(PROJECT_SOURCES
         src/global/HTTPRequestHelper.cpp
         src/global/DeviceDetailsHelper.cpp
         src/global/CountryHelper.cpp
+        include/global/OTP.hpp
+        src/global/OTP.cpp
 
         3rdparty/qrcodegen.cpp
         3rdparty/QtExtKeySequenceEdit.cpp
@@ -168,6 +170,8 @@ set(PROJECT_SOURCES
         src/ui/widget/StartStopButton.cpp
         include/ui/widget/TrayProfileSelector.hpp
         src/ui/widget/TrayProfileSelector.cpp
+        include/ui/widget/TrayOtpCodes.hpp
+        src/ui/widget/TrayOtpCodes.cpp
         include/ui/utils/DataViewHtmlGenerator.h
         src/ui/utils/DataViewHtmlGenerator.cpp
         include/ui/utils/ProfilesTableModel.h
@@ -179,6 +183,8 @@ set(PROJECT_SOURCES
         include/ui/utils/ProfilesTableVerticalHeader.h
         src/ui/utils/ProfilesTableVerticalHeader.cpp
         include/ui/utils/ProfilesTableFilterHeader.h
+        include/ui/utils/ScreenQrScanner.h
+        src/ui/utils/ScreenQrScanner.cpp
 
         include/ui/profile/dialog_edit_profile.h
         src/ui/profile/dialog_edit_profile.cpp
@@ -268,6 +274,24 @@ set(PROJECT_SOURCES
         include/ui/setting/dialog_vpn_settings.h
         include/ui/setting/dialog_vpn_settings.ui
 
+        src/ui/setting/dialog_preset_settings.cpp
+        include/ui/setting/dialog_preset_settings.h
+        include/ui/setting/dialog_preset_settings.ui
+
+        src/ui/setting/dialog_otp_manager.cpp
+        include/ui/setting/dialog_otp_manager.h
+        include/ui/setting/dialog_otp_manager.ui
+
+        src/ui/setting/dialog_edit_otp.cpp
+        include/ui/setting/dialog_edit_otp.h
+        include/ui/setting/dialog_edit_otp.ui
+
+        src/ui/setting/OtpItem.cpp
+        include/ui/setting/OtpItem.h
+        include/ui/setting/OtpItem.ui
+        src/ui/setting/OtpListWidget.cpp
+        include/ui/setting/OtpListWidget.h
+
         src/ui/stats/dialog_traffic_stats.cpp
         include/ui/stats/dialog_traffic_stats.h
         include/ui/stats/dialog_traffic_stats.ui
@@ -394,22 +418,26 @@ set(PROJECT_SOURCES
         include/database/ProfilesRepo.h
         include/database/GroupsRepo.h
         include/database/RoutesRepo.h
+        include/database/OtpProfilesRepo.h
         include/database/SettingsRepo.h
         include/database/TrafficStatsRepo.h
 
         include/database/entities/Profile.h
         include/database/entities/Group.h
         include/database/entities/RouteProfile.h
         include/database/entities/RouteRule.h
+        include/database/entities/OtpProfile.h
 
         src/database/entities/Profile.cpp
         src/database/entities/Group.cpp
         src/database/entities/RouteProfile.cpp
         src/database/entities/RouteRule.cpp
+        src/database/entities/OtpProfile.cpp
 
         src/database/ProfilesRepo.cpp
         src/database/GroupsRepo.cpp
         src/database/RoutesRepo.cpp
+        src/database/OtpProfilesRepo.cpp
         src/database/TrafficStatsRepo.cpp
 
         include/database/DatabaseManager.h

include/database/Database.h

@@ -30,15 +30,17 @@ namespace Configs {
     // profiles -> groups, groups_order, profiles tables
     // routes   -> route_profiles, route_rules tables
     // settings -> settings table
+    // otp      -> otp_profiles table
     // icons    -> icons/ folder (handled by the UI layer, not the database)
     struct BackupParts {
         bool profiles = false;
         bool routes = false;
         bool settings = false;
+        bool otp = false;
         bool icons = false;
 
-        [[nodiscard]] bool anyDb() const { return profiles || routes || settings; }
-        [[nodiscard]] bool any() const { return profiles || routes || settings || icons; }
+        [[nodiscard]] bool anyDb() const { return profiles || routes || settings || otp; }
+        [[nodiscard]] bool any() const { return anyDb() || icons; }
     };
 
     // Max bound parameters per statement (SQLite default SQLITE_MAX_VARIABLE_NUMBER is 999).

include/database/DatabaseManager.h

@@ -9,6 +9,7 @@ namespace Configs {
     class RoutesRepo;
     class GroupsRepo;
     class ProfilesRepo;
+    class OtpProfilesRepo;
     class TrafficStatsRepo;
 
     void initDB(const std::string& dbPath);
@@ -21,6 +22,7 @@ namespace Configs {
         Database statsDb;
 
         static void createEntityIdsTable(Database& db);
+        static bool entityIdsColumnExists(Database& db, const char* columnName);
         // Derive the stats database path (throne_stats.db) as a sibling of the
         // main database file.
         static std::string deriveStatsDbPath(const std::string& dbPath);
@@ -29,6 +31,7 @@ namespace Configs {
         std::unique_ptr<ProfilesRepo> profilesRepo;
         std::unique_ptr<GroupsRepo> groupsRepo;
         std::unique_ptr<RoutesRepo> routesRepo;
+        std::unique_ptr<OtpProfilesRepo> otpProfilesRepo;
         std::unique_ptr<SettingsRepo> settingsRepo;
         std::unique_ptr<TrafficStatsRepo> trafficStatsRepo;
 

include/database/OtpProfilesRepo.h

@@ -0,0 +1,51 @@
+#pragma once
+
+#include <QList>
+#include <QMutex>
+#include <map>
+#include <memory>
+
+#include "Database.h"
+#include "include/database/entities/OtpProfile.h"
+
+namespace Configs {
+    class OtpProfilesRepo {
+    private:
+        Database &db;
+        mutable QMutex mutex;
+        mutable std::map<int, std::weak_ptr<OtpProfile>> identityMap;
+
+        void createTables() const;
+
+        [[nodiscard]] bool otpProfilesColumnExists(const char *columnName) const;
+
+        void saveToDatabase(const OtpProfile *profile, int id) const;
+
+        [[nodiscard]] std::shared_ptr<OtpProfile> otpProfileFromRow(SQLite::Statement &stmt) const;
+
+        [[nodiscard]] int NewOtpProfileID() const;
+
+    public:
+        explicit OtpProfilesRepo(Database &database);
+
+        [[nodiscard]] static std::shared_ptr<OtpProfile> NewOtpProfile();
+
+        bool AddOtpProfile(std::shared_ptr<OtpProfile> &profile);
+
+        [[nodiscard]] std::shared_ptr<OtpProfile> GetOtpProfile(int id) const;
+
+        [[nodiscard]] std::shared_ptr<OtpProfile> GetOtpProfileByName(const QString &name) const;
+
+        void DeleteOtpProfile(int id);
+
+        void DeleteOtpProfiles(const QList<int> &ids);
+
+        [[nodiscard]] QList<std::shared_ptr<OtpProfile>> GetAllOtpProfiles() const;
+
+        [[nodiscard]] QList<int> GetAllOtpProfileIds() const;
+
+        bool Save(const std::shared_ptr<OtpProfile> &profile);
+
+        void UpdateOtpProfilesOrder(const QList<int> &idsInOrder);
+    };
+} // namespace Configs

include/database/entities/OtpProfile.h

@@ -0,0 +1,30 @@
+#pragma once
+
+#include <QJsonObject>
+#include <QString>
+
+#include "include/global/OTP.hpp"
+
+namespace Configs {
+    class OtpProfile : public OTP::Entry {
+    public:
+        int id = -1;
+
+        OtpProfile() = default;
+        explicit OtpProfile(const OTP::Entry &entry) : OTP::Entry(entry) {}
+
+        [[nodiscard]] QString DisplayName() const;
+
+        [[nodiscard]] QString CurrentCode() const { return OTP::GenerateCode(*this); }
+
+        [[nodiscard]] int SecondsRemaining() const { return OTP::SecondsRemaining(*this); }
+
+        [[nodiscard]] QString Validate() const { return OTP::Validate(*this); }
+
+        [[nodiscard]] QString ExportToLink() const { return OTP::ExportToLink(*this); }
+
+        [[nodiscard]] QJsonObject ExportToJson() const;
+
+        bool ParseFromJson(const QJsonObject &object);
+    };
+} // namespace Configs

include/global/OTP.hpp

@@ -0,0 +1,70 @@
+#pragma once
+
+#include <QByteArray>
+#include <QList>
+#include <QString>
+#include <QStringList>
+
+namespace OTP {
+    enum class Algorithm : int {
+        SHA1 = 0,
+        SHA256,
+        SHA512,
+    };
+
+    enum class Type : int {
+        TOTP = 0,
+        HOTP,
+    };
+
+    constexpr int DEFAULT_DIGITS = 6;
+    constexpr int DEFAULT_PERIOD = 30;
+    constexpr int MIN_DIGITS = 4;
+    constexpr int MAX_DIGITS = 10;
+    constexpr int MIN_PERIOD = 1;
+    constexpr int MAX_PERIOD = 3600;
+
+    struct Entry {
+        QString name;
+        QString issuer;
+        QString secret;
+        Algorithm algorithm = Algorithm::SHA1;
+        Type type = Type::TOTP;
+        int digits = DEFAULT_DIGITS;
+        int period = DEFAULT_PERIOD;
+        qint64 counter = 0;
+    };
+
+    QString AlgorithmToString(Algorithm algorithm);
+    Algorithm AlgorithmFromString(const QString &name, bool *ok = nullptr);
+    QString TypeToString(Type type);
+    Type TypeFromString(const QString &name, bool *ok = nullptr);
+
+    QByteArray Base32Decode(const QString &input, bool *ok = nullptr);
+    QString Base32Encode(const QByteArray &input);
+
+    QString NormalizeSecret(const QString &secret);
+
+    // Empty means usable; a non-empty result is the translated reason it is not.
+    QString Validate(const Entry &entry);
+
+    QString GenerateHOTP(const QByteArray &key, quint64 counter, Algorithm algorithm, int digits);
+
+    // `unixTime` < 0 means now.
+    QString GenerateCode(const Entry &entry, qint64 unixTime = -1);
+
+    int SecondsRemaining(const Entry &entry, qint64 unixTime = -1);
+
+    QString ExportToLink(const Entry &entry);
+    bool ParseFromLink(const QString &link, Entry &out);
+
+    // Google Authenticator's format: it pins the step to 30 s, so other periods do not survive.
+    QString ExportToMigrationLink(const QList<Entry> &entries);
+    bool ParseFromMigrationLink(const QString &link, QList<Entry> &out);
+
+    // Takes any of the above or a bare base32 secret, which yields an unnamed entry.
+    QList<Entry> ParseAny(const QString &text, QStringList *problems = nullptr);
+
+    QByteArray ExportToJson(const QList<Entry> &entries);
+    bool ParseFromJson(const QByteArray &json, QList<Entry> &out);
+} // namespace OTP

include/ui/mainwindow.h

@@ -49,6 +49,7 @@ namespace Configs_sys {
 }
 
 class TrayProfileSelector;
+class TrayOtpCodes;
 class TestRunner;
 
 namespace Qv2ray::ui { class SyntaxHighlighter; }
@@ -150,6 +151,10 @@ private slots:
 
     void on_menu_vpn_settings_triggered();
 
+    void on_menu_preset_settings_triggered();
+
+    void on_menu_otp_manager_triggered();
+
     void on_menu_hotkey_settings_triggered();
 
     void on_menu_add_from_input_triggered();
@@ -210,6 +215,8 @@ private slots:
     QMenu *trayMenu = nullptr;    // tray context menu
     QPointer<TrayProfileSelector> traySelector;
     void openTraySelector(bool routing);
+    QPointer<TrayOtpCodes> trayOtpCodes;
+    void openTrayOtpCodes();
     QShortcut *shortcut_esc = new QShortcut(QKeySequence::Cancel, this);
     //
     QThreadPool *parallelCoreCallPool = new QThreadPool(this);

include/ui/mainwindow.ui

@@ -771,6 +771,7 @@ QTabBar::tab:selected {
     <addaction name="menu_basic_settings"/>
     <addaction name="menu_routing_settings"/>
     <addaction name="menu_vpn_settings"/>
+    <addaction name="menu_preset_settings"/>
     <addaction name="menu_hotkey_settings"/>
     <addaction name="menu_open_config_folder"/>
    </widget>
@@ -845,6 +846,8 @@ QTabBar::tab:selected {
     <addaction name="actionAuto_Selector"/>
     <addaction name="actionSpeedtest_Current"/>
     <addaction name="separator"/>
+    <addaction name="menu_otp_manager"/>
+    <addaction name="separator"/>
     <addaction name="actionRuntime_Stats"/>
     <addaction name="actionTraffic_Stats"/>
     <addaction name="actionCheck_For_Update"/>
@@ -1174,6 +1177,16 @@ QTabBar::tab:selected {
     <string>Tun Settings</string>
    </property>
   </action>
+  <action name="menu_preset_settings">
+   <property name="text">
+    <string>Preset Settings</string>
+   </property>
+  </action>
+  <action name="menu_otp_manager">
+   <property name="text">
+    <string>OTP Manager</string>
+   </property>
+  </action>
   <action name="actionRestart_Program">
    <property name="text">
     <string>Restart Program</string>