MAVLinkSigning.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QByteArray>
#include <QtCore/QByteArrayView>
#include <QtCore/QDateTime>
#include <QtCore/QHash>
#include <QtCore/QString>
#include <QtCore/QTimeZone>
#include <array>
#include <cstdint>
#include <optional>
 
#include "MAVLinkMessageType.h"
 
// createSetupSigning takes mavlink_setup_signing_t&; full def lives in MAVLinkLib.h. Callers must include it.
struct __mavlink_setup_signing_t;
typedef struct __mavlink_setup_signing_t mavlink_setup_signing_t;
 
namespace MAVLinkSigning {
static constexpr int kSigningKeySize = 32;       // SHA-256 output / MAVLink secret_key size
static constexpr int kSignatureHashBytes = 6;    // truncated SHA-256 in wire signature
static constexpr int kSignaturePrefixBytes = 7;  // link_id(1) + timestamp(6) before hash
 
using SigningKey = std::array<uint8_t, kSigningKeySize>;
 
inline const QDateTime& signingEpoch()
{
    static const QDateTime epoch = QDate(2015, 1, 1).startOfDay(QTimeZone::UTC);
    return epoch;
}
 
inline uint64_t currentSigningTimestampTicks()
{
    return static_cast<uint64_t>(signingEpoch().msecsTo(QDateTime::currentDateTimeUtc())) * 100;
}
 
std::optional<SigningKey> makeSigningKey(QByteArrayView bytes);
 
enum class UnsignedAcceptancePolicy : uint8_t {
    Strict,   // RADIO_STATUS only (hop-by-hop). Default for confirmed-signing.
    Pending,  // RADIO_STATUS + HEARTBEAT + STATUSTEXT while awaiting enable/disable confirmation.
};
 
bool secureConnectionAcceptUnsignedCallback(const mavlink_status_t* status, uint32_t message_id);
bool insecureConnectionAcceptUnsignedCallback(const mavlink_status_t* status, uint32_t message_id);
 
mavlink_accept_unsigned_t callbackForPolicy(UnsignedAcceptancePolicy policy);
 
void createSetupSigning(mavlink_channel_t channel, mavlink_system_t target_system, QByteArrayView keyBytes,
                        mavlink_setup_signing_t& setup_signing);
 
bool encodeSetupSigning(mavlink_channel_t channel, uint8_t srcSysId, uint8_t srcCompId, mavlink_system_t target_system,
                        QByteArrayView keyBytes, mavlink_message_t& message);
 
bool isMessageSigned(const mavlink_message_t& message);
 
void setMessageSigned(mavlink_message_t& message, bool isSigned);
 
QByteArray serializeUnsignedCopy(const mavlink_message_t& message);
 
bool verifySignature(QByteArrayView key, const mavlink_message_t& message);
bool verifySignature(const SigningKey& key, const mavlink_message_t& message);
 
struct DetectSnapshot
{
    QString keyHint;
    bool inCooldown = false;
    bool autoDetectSuspended = false;
};
 
// Pure reads from mavlink_get_channel_status(); no SigningChannel state dependency.
void logSigningFailure(mavlink_channel_t channel);
bool checkSigningLinkId(mavlink_channel_t channel, const mavlink_message_t& message);
QString signingStatusString(mavlink_channel_t channel);
int signingStreamCount(mavlink_channel_t channel);
 
}  // namespace MAVLinkSigning