Skip to content

fix(hidpp10): validate Receiver register and event parsers #552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jelmerdehen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(hidpp10): validate Receiver register and event parsers #552

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 55 additions & 8 deletions src/logid/backend/hidpp10/Receiver.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

#include <backend/hidpp10/Receiver.h>
#include <cassert>
#include <stdexcept>

using namespace logid::backend::hidpp10;
using namespace logid::backend;
Expand Down Expand Up @@ -45,6 +46,8 @@ void Receiver::_receiverCheck() {

Receiver::NotificationFlags Receiver::getNotificationFlags() {
auto response = getRegister(EnableHidppNotifications, {}, hidpp::ReportType::Short);
if (response.size() < 2)
throw std::runtime_error("getNotificationFlags: short response");

NotificationFlags flags{};
flags.deviceBatteryStatus = response[0] & (1 << 4);
Expand Down Expand Up @@ -74,6 +77,8 @@ void Receiver::enumerate() {
///TODO: Investigate usage
uint8_t Receiver::getConnectionState(hidpp::DeviceIndex index) {
auto response = getRegister(ConnectionState, {index}, hidpp::ReportType::Short);
if (response.empty())
throw std::runtime_error("getConnectionState: empty response");

return response[0];
}
Expand Down Expand Up @@ -159,8 +164,11 @@ std::map<hidpp::DeviceIndex, uint8_t> Receiver::getDeviceActivity() {
auto response = getRegister(DeviceActivity, {}, hidpp::ReportType::Long);

std::map<hidpp::DeviceIndex, uint8_t> device_activity;
for (uint8_t i = hidpp::WirelessDevice1; i <= hidpp::WirelessDevice6; i++)
for (uint8_t i = hidpp::WirelessDevice1; i <= hidpp::WirelessDevice6; i++) {
if (i >= response.size())
break;
device_activity[static_cast<hidpp::DeviceIndex>(i)] = response[i];
}

return device_activity;
}
Expand All @@ -178,13 +186,17 @@ Receiver::getPairingInfo(hidpp::DeviceIndex index) {

struct PairingInfo info{};
if (_is_bolt) {
if (response.size() < 4)
throw std::runtime_error("getPairingInfo: short bolt response");
info = {
.destinationId = 0, // no longer given?
.reportInterval = 0, // no longer given?
.pid = (uint16_t) ((response[3] << 8) | response[2]),
.deviceType = static_cast<hidpp::DeviceType>(response[1])
};
} else {
if (response.size() < 8)
throw std::runtime_error("getPairingInfo: short response");
info = {
.destinationId = response[1],
.reportInterval = response[2],
Expand All @@ -208,6 +220,10 @@ Receiver::getExtendedPairingInfo(hidpp::DeviceIndex index) {

auto response = getRegister(PairingInfo, request, hidpp::ReportType::Long);

const std::size_t required = static_cast<std::size_t>(psl_offset) + 1;
if (response.size() < required)
throw std::runtime_error("getExtendedPairingInfo: short response");

ExtendedPairingInfo info{};

info.serialNumber = 0;
Expand Down Expand Up @@ -274,12 +290,18 @@ std::string Receiver::getDeviceName(hidpp::DeviceIndex index) {
}

hidpp::DeviceIndex Receiver::deviceDisconnectionEvent(const hidpp::Report& report) {
assert(report.subId() == DeviceDisconnection);
if (report.subId() != DeviceDisconnection)
throw std::runtime_error("deviceDisconnectionEvent: bad subId");
return report.deviceIndex();
}

hidpp::DeviceConnectionEvent Receiver::deviceConnectionEvent(const hidpp::Report& report) {
assert(report.subId() == DeviceConnection);
if (report.subId() != DeviceConnection)
throw std::runtime_error("deviceConnectionEvent: bad subId");

const auto param_size = static_cast<std::size_t>(report.paramEnd() - report.paramBegin());
if (param_size < 3)
throw std::runtime_error("deviceConnectionEvent: short report");

auto data = report.paramBegin();

Expand All @@ -299,7 +321,14 @@ hidpp::DeviceConnectionEvent Receiver::deviceConnectionEvent(const hidpp::Report

bool Receiver::fillDeviceDiscoveryEvent(DeviceDiscoveryEvent& event,
const hidpp::Report& report) {
assert(report.subId() == DeviceDiscovered);
if (report.subId() != DeviceDiscovered)
throw std::runtime_error("fillDeviceDiscoveryEvent: bad subId");
if (report.type() != hidpp::Report::Type::Long)
throw std::runtime_error("fillDeviceDiscoveryEvent: short report");

const auto param_size = static_cast<std::size_t>(report.paramEnd() - report.paramBegin());
if (param_size < hidpp::LongParamLength)
throw std::runtime_error("fillDeviceDiscoveryEvent: truncated payload");

auto data = report.paramBegin();

Expand Down Expand Up @@ -343,7 +372,11 @@ bool Receiver::fillDeviceDiscoveryEvent(DeviceDiscoveryEvent& event,
}

PairStatusEvent Receiver::pairStatusEvent(const hidpp::Report& report) {
assert(report.subId() == PairStatus);
if (report.subId() != PairStatus)
throw std::runtime_error("pairStatusEvent: bad subId");
const auto param_size = static_cast<std::size_t>(report.paramEnd() - report.paramBegin());
if (param_size < 2)
throw std::runtime_error("pairStatusEvent: short report");

return {
.pairing = (bool)(report.paramBegin()[0] & 1),
Expand All @@ -352,7 +385,11 @@ PairStatusEvent Receiver::pairStatusEvent(const hidpp::Report& report) {
}

BoltPairStatusEvent Receiver::boltPairStatusEvent(const hidpp::Report& report) {
assert(report.subId() == BoltPairStatus);
if (report.subId() != BoltPairStatus)
throw std::runtime_error("boltPairStatusEvent: bad subId");
const auto param_size = static_cast<std::size_t>(report.paramEnd() - report.paramBegin());
if (param_size < 2)
throw std::runtime_error("boltPairStatusEvent: short report");

return {
.pairing = report.address() == 0,
Expand All @@ -361,7 +398,11 @@ BoltPairStatusEvent Receiver::boltPairStatusEvent(const hidpp::Report& report) {
}

DiscoveryStatusEvent Receiver::discoveryStatusEvent(const hidpp::Report& report) {
assert(report.subId() == DiscoveryStatus);
if (report.subId() != DiscoveryStatus)
throw std::runtime_error("discoveryStatusEvent: bad subId");
const auto param_size = static_cast<std::size_t>(report.paramEnd() - report.paramBegin());
if (param_size < 2)
throw std::runtime_error("discoveryStatusEvent: short report");

return {
.discovering = report.address() == 0,
Expand All @@ -370,7 +411,13 @@ DiscoveryStatusEvent Receiver::discoveryStatusEvent(const hidpp::Report& report)
}

std::string Receiver::passkeyEvent(const hidpp::Report& report) {
assert(report.subId() == PasskeyRequest);
if (report.subId() != PasskeyRequest)
throw std::runtime_error("passkeyEvent: bad subId");
if (report.type() != hidpp::Report::Type::Long)
throw std::runtime_error("passkeyEvent: short report");
const auto param_size = static_cast<std::size_t>(report.paramEnd() - report.paramBegin());
if (param_size < 6)
throw std::runtime_error("passkeyEvent: truncated payload");

return {report.paramBegin(), report.paramBegin() + 6};
}
Expand Down