Skip to content

Commit 8c96008

Browse files
troygiorshevjnewbery
authored andcommitted
[net] Don't return an optional from TransportDeserializer::GetMessage()
Also, access mapRecvBytesPerMsgCmd with `at()` not `find()`. This throws an error if COMMAND_OTHER doesn't exist, which should never happen. `find()` instead just accessed the last element, which could make debugging more difficult. Resolves review comments from PR19107: - bitcoin/bitcoin#19107 (comment) - bitcoin/bitcoin#19107 (comment)
1 parent e35c4a3 commit 8c96008

File tree

3 files changed

+34
-35
lines changed

3 files changed

+34
-35
lines changed

src/net.cpp

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -641,25 +641,26 @@ bool CNode::ReceiveMsgBytes(Span<const uint8_t> msg_bytes, bool& complete)
641641

642642
if (m_deserializer->Complete()) {
643643
// decompose a transport agnostic CNetMessage from the deserializer
644-
uint32_t out_err_raw_size{0};
645-
std::optional<CNetMessage> result{m_deserializer->GetMessage(time, out_err_raw_size)};
646-
if (!result) {
644+
bool reject_message{false};
645+
CNetMessage msg = m_deserializer->GetMessage(time, reject_message);
646+
if (reject_message) {
647647
// Message deserialization failed. Drop the message but don't disconnect the peer.
648648
// store the size of the corrupt message
649-
mapRecvBytesPerMsgCmd.find(NET_MESSAGE_COMMAND_OTHER)->second += out_err_raw_size;
649+
mapRecvBytesPerMsgCmd.at(NET_MESSAGE_COMMAND_OTHER) += msg.m_raw_message_size;
650650
continue;
651651
}
652652

653-
//store received bytes per message command
654-
//to prevent a memory DOS, only allow valid commands
655-
mapMsgCmdSize::iterator i = mapRecvBytesPerMsgCmd.find(result->m_command);
656-
if (i == mapRecvBytesPerMsgCmd.end())
653+
// Store received bytes per message command
654+
// to prevent a memory DOS, only allow valid commands
655+
auto i = mapRecvBytesPerMsgCmd.find(msg.m_command);
656+
if (i == mapRecvBytesPerMsgCmd.end()) {
657657
i = mapRecvBytesPerMsgCmd.find(NET_MESSAGE_COMMAND_OTHER);
658+
}
658659
assert(i != mapRecvBytesPerMsgCmd.end());
659-
i->second += result->m_raw_message_size;
660+
i->second += msg.m_raw_message_size;
660661

661662
// push the message to the process queue,
662-
vRecvMsg.push_back(std::move(*result));
663+
vRecvMsg.push_back(std::move(msg));
663664

664665
complete = true;
665666
}
@@ -733,16 +734,18 @@ const uint256& V1TransportDeserializer::GetMessageHash() const
733734
return data_hash;
734735
}
735736

736-
std::optional<CNetMessage> V1TransportDeserializer::GetMessage(const std::chrono::microseconds time, uint32_t& out_err_raw_size)
737+
CNetMessage V1TransportDeserializer::GetMessage(const std::chrono::microseconds time, bool& reject_message)
737738
{
739+
// Initialize out parameter
740+
reject_message = false;
738741
// decompose a single CNetMessage from the TransportDeserializer
739-
std::optional<CNetMessage> msg(std::move(vRecv));
742+
CNetMessage msg(std::move(vRecv));
740743

741744
// store command string, time, and sizes
742-
msg->m_command = hdr.GetCommand();
743-
msg->m_time = time;
744-
msg->m_message_size = hdr.nMessageSize;
745-
msg->m_raw_message_size = hdr.nMessageSize + CMessageHeader::HEADER_SIZE;
745+
msg.m_command = hdr.GetCommand();
746+
msg.m_time = time;
747+
msg.m_message_size = hdr.nMessageSize;
748+
msg.m_raw_message_size = hdr.nMessageSize + CMessageHeader::HEADER_SIZE;
746749

747750
uint256 hash = GetMessageHash();
748751

@@ -752,17 +755,15 @@ std::optional<CNetMessage> V1TransportDeserializer::GetMessage(const std::chrono
752755
// Check checksum and header command string
753756
if (memcmp(hash.begin(), hdr.pchChecksum, CMessageHeader::CHECKSUM_SIZE) != 0) {
754757
LogPrint(BCLog::NET, "Header error: Wrong checksum (%s, %u bytes), expected %s was %s, peer=%d\n",
755-
SanitizeString(msg->m_command), msg->m_message_size,
758+
SanitizeString(msg.m_command), msg.m_message_size,
756759
HexStr(Span<uint8_t>(hash.begin(), hash.begin() + CMessageHeader::CHECKSUM_SIZE)),
757760
HexStr(hdr.pchChecksum),
758761
m_node_id);
759-
out_err_raw_size = msg->m_raw_message_size;
760-
msg = std::nullopt;
762+
reject_message = true;
761763
} else if (!hdr.IsCommandValid()) {
762764
LogPrint(BCLog::NET, "Header error: Invalid message type (%s, %u bytes), peer=%d\n",
763-
SanitizeString(hdr.GetCommand()), msg->m_message_size, m_node_id);
764-
out_err_raw_size = msg->m_raw_message_size;
765-
msg.reset();
765+
SanitizeString(hdr.GetCommand()), msg.m_message_size, m_node_id);
766+
reject_message = true;
766767
}
767768

768769
// Always reset the network deserializer (prepare for the next message)

src/net.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ class TransportDeserializer {
309309
/** read and deserialize data, advances msg_bytes data pointer */
310310
virtual int Read(Span<const uint8_t>& msg_bytes) = 0;
311311
// decomposes a message from the context
312-
virtual std::optional<CNetMessage> GetMessage(std::chrono::microseconds time, uint32_t& out_err) = 0;
312+
virtual CNetMessage GetMessage(std::chrono::microseconds time, bool& reject_message) = 0;
313313
virtual ~TransportDeserializer() {}
314314
};
315315

@@ -373,7 +373,7 @@ class V1TransportDeserializer final : public TransportDeserializer
373373
}
374374
return ret;
375375
}
376-
std::optional<CNetMessage> GetMessage(std::chrono::microseconds time, uint32_t& out_err_raw_size) override;
376+
CNetMessage GetMessage(std::chrono::microseconds time, bool& reject_message) override;
377377
};
378378

379379
/** The TransportSerializer prepares messages for the network transport

src/test/fuzz/p2p_transport_serialization.cpp

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -68,18 +68,16 @@ FUZZ_TARGET_INIT(p2p_transport_serialization, initialize_p2p_transport_serializa
6868
}
6969
if (deserializer.Complete()) {
7070
const std::chrono::microseconds m_time{std::numeric_limits<int64_t>::max()};
71-
uint32_t out_err_raw_size{0};
72-
std::optional<CNetMessage> result{deserializer.GetMessage(m_time, out_err_raw_size)};
73-
if (result) {
74-
assert(result->m_command.size() <= CMessageHeader::COMMAND_SIZE);
75-
assert(result->m_raw_message_size <= mutable_msg_bytes.size());
76-
assert(result->m_raw_message_size == CMessageHeader::HEADER_SIZE + result->m_message_size);
77-
assert(result->m_time == m_time);
71+
bool reject_message{false};
72+
CNetMessage msg = deserializer.GetMessage(m_time, reject_message);
73+
assert(msg.m_command.size() <= CMessageHeader::COMMAND_SIZE);
74+
assert(msg.m_raw_message_size <= mutable_msg_bytes.size());
75+
assert(msg.m_raw_message_size == CMessageHeader::HEADER_SIZE + msg.m_message_size);
76+
assert(msg.m_time == m_time);
7877

79-
std::vector<unsigned char> header;
80-
auto msg = CNetMsgMaker{result->m_recv.GetVersion()}.Make(result->m_command, MakeUCharSpan(result->m_recv));
81-
serializer.prepareForTransport(msg, header);
82-
}
78+
std::vector<unsigned char> header;
79+
auto msg2 = CNetMsgMaker{msg.m_recv.GetVersion()}.Make(msg.m_command, MakeUCharSpan(msg.m_recv));
80+
serializer.prepareForTransport(msg2, header);
8381
}
8482
}
8583
}

0 commit comments

Comments
 (0)