MAVLinkSigningKeys.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QByteArray>
#include <QtCore/QByteArrayView>
#include <QtCore/QHash>
#include <QtCore/QLatin1StringView>
#include <QtCore/QObject>
#include <QtCore/QTimer>
#include <QtQmlIntegration/QtQmlIntegration>
#include <optional>
 
#include "MAVLinkSigning.h"
 
class QmlObjectListModel;
class SigningController;
class Vehicle;
 
class MAVLinkSigningKey : public QObject
{
    Q_OBJECT
    QML_ELEMENT
    QML_UNCREATABLE("")
 
    Q_PROPERTY(QString name READ name CONSTANT)
 
public:
    explicit MAVLinkSigningKey(const QString& name, const MAVLinkSigning::SigningKey& keyBytes,
                               QObject* parent = nullptr);
    ~MAVLinkSigningKey() override;
 
    const QString& name() const { return _name; }
 
    const MAVLinkSigning::SigningKey& keyBytes() const { return _keyBytes; }
 
    uint64_t lastTimestamp() const { return _lastTimestamp; }
    void setLastTimestamp(uint64_t ts) { _lastTimestamp = ts; }
 
private:
    const QString _name;
    MAVLinkSigning::SigningKey _keyBytes;  // 32-byte derived key — secureZero on destruction
    uint64_t _lastTimestamp = 0;
};
 
class MAVLinkSigningKeys : public QObject
{
    Q_OBJECT
    QML_ANONYMOUS
 
    Q_PROPERTY(QmlObjectListModel* keys READ keys CONSTANT)
    Q_PROPERTY(int keyUsageRevision READ keyUsageRevision NOTIFY keyUsageChanged)
 
    friend class SigningTest;
 
public:
    static MAVLinkSigningKeys* instance();
 
    explicit MAVLinkSigningKeys(QObject* parent = nullptr);
    ~MAVLinkSigningKeys() override;
 
    Q_INVOKABLE bool addKey(const QString& name, const QString& passphrase);
 
    Q_INVOKABLE bool addRawKey(const QString& name, const QString& hexKey);
 
    Q_INVOKABLE static QString generateRandomHexKey();
 
    Q_INVOKABLE void removeKey(const QString& name);
 
    Q_INVOKABLE void removeAllKeys();
 
    Q_INVOKABLE bool isKeyInUse(const QString& name) const;
 
    Q_INVOKABLE QString keyHexByName(const QString& name) const;
 
    MAVLinkSigningKey* keyAt(int index) const;
 
    std::optional<MAVLinkSigning::SigningKey> keyBytesByName(const QString& name) const;
 
    uint64_t lastTimestamp(const QString& name) const;
 
    void recordTimestamp(const QString& name, uint64_t ts);
 
    void recordTimestamps(const QHash<QString, uint64_t>& batch);
 
    void flushAllTimestamps();
 
    QString tryDetectKey(SigningController* controller, const mavlink_message_t& message);
 
    QmlObjectListModel* keys() const { return _keys; }
 
    int keyUsageRevision() const { return _keyUsageRevision; }
 
signals:
    void keysChanged();
    void keyUsageChanged();
 
private:
    void _save();
    void _load();
    bool _validateNewKey(const QString& name) const;
    MAVLinkSigningKey* _insertKey(const QString& name, const MAVLinkSigning::SigningKey& keyBytes);
    void _connectVehicle(Vehicle* vehicle);
    void _disconnectVehicle(Vehicle* vehicle);
    QHash<QString, uint64_t> _snapshotAllTimestamps() const;
 
    QmlObjectListModel* _keys = nullptr;
    QHash<QString, MAVLinkSigningKey*> _keyIndex;  // O(1) name lookups alongside QML model
    int _keyUsageRevision = 0;
    QTimer* _timestampFlushTimer = nullptr;
 
    static constexpr QLatin1StringView kSettingsGroup = QLatin1StringView("MAVLinkSigningKeys");
    static constexpr QLatin1StringView kManifestKey = QLatin1StringView("manifest");  // key names list (no secrets)
    static constexpr QLatin1StringView kKeySubgroup = QLatin1StringView("keys");  // <kSettingsGroup>/keys/<name> = key bytes
    static constexpr QLatin1StringView kTimestampSubgroup = QLatin1StringView("timestamps");  // <kSettingsGroup>/timestamps/<name> = quint64
    static constexpr int kTimestampFlushIntervalMs = 5000;
 
    static constexpr QByteArrayView kPbkdf2Salt = QByteArrayView("QGroundControl-MAVLink-Signing-v1");
    static constexpr int kPbkdf2Iterations = 600'000;
 
    static constexpr int kSigningKeySize = MAVLinkSigning::kSigningKeySize;
    static constexpr int kMaxKeys = 64;
    static constexpr int kMinPassphraseLength = 8;
 
public:
    static void setPbkdf2IterationsForTesting(int iterations) { _pbkdf2IterationsOverride = iterations; }
 
private:
    static int _effectivePbkdf2Iterations() {
        return _pbkdf2IterationsOverride > 0 ? _pbkdf2IterationsOverride : kPbkdf2Iterations;
    }
    static inline int _pbkdf2IterationsOverride = 0;
};