Skip to content

Make tree deserialisation exception-safe #80

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

Merged
Amaury Chamayou (achamayou) merged 1 commit into from
Aug 25, 2026
Merged

Make tree deserialisation exception-safe #80

Show file tree
Hide file tree
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
32 changes: 20 additions & 12 deletions merklecpp.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1589,17 +1589,19 @@ namespace merkle
throw std::runtime_error("not enough bytes");
}

num_flushed = deserialised_num_flushed;
leaf_nodes.reserve(num_leaf_nodes);
std::vector<Node*> deserialised_leaf_nodes;
Comment thread
eddyashton marked this conversation as resolved.
deserialised_leaf_nodes.reserve(num_leaf_nodes);
std::vector<std::unique_ptr<Node>> level;
level.reserve(num_leaf_nodes);
for (size_t i = 0; i < num_leaf_nodes; i++)
{
Node* n = Node::make(Hash(bytes, position));
leaf_nodes.push_back(n);
auto n = std::unique_ptr<Node>(Node::make(Hash(bytes, position)));
deserialised_leaf_nodes.push_back(n.get());
level.push_back(std::move(n));
}

std::vector<Node*> level = leaf_nodes;
std::vector<Node*> next_level;
size_t it = num_flushed;
std::vector<std::unique_ptr<Node>> next_level;
size_t it = deserialised_num_flushed;
uint8_t level_no = 0;
while (it != 0 || level.size() > 1)
{
Expand All @@ -1608,11 +1610,11 @@ namespace merkle
{
Hash h(bytes, position);
MERKLECPP_TRACE(MERKLECPP_TOUT << "+";);
auto n = Node::make(h);
auto n = std::unique_ptr<Node>(Node::make(std::move(h)));
n->height = level_no + 1;
n->size = Node::full_size(n->height);
assert(n->invariant());
level.insert(level.begin(), n);
level.insert(level.begin(), std::move(n));
}

MERKLECPP_TRACE(
Expand All @@ -1625,11 +1627,15 @@ namespace merkle
{
if (i + 1 >= level.size())
{
next_level.push_back(level.at(i));
next_level.push_back(std::move(level.at(i)));
}
else
{
next_level.push_back(Node::make(level.at(i), level.at(i + 1)));
auto parent = std::unique_ptr<Node>(
Node::make(level.at(i).get(), level.at(i + 1).get()));
level.at(i).release();
level.at(i + 1).release();
next_level.push_back(std::move(parent));
}
}

Expand All @@ -1644,9 +1650,11 @@ namespace merkle

if (level.size() == 1)
{
_root = level.at(0);
_root = level.at(0).release();
assert(_root->invariant());
}
leaf_nodes = std::move(deserialised_leaf_nodes);
num_flushed = deserialised_num_flushed;
}

/// @brief Operator to serialise the tree
Expand Down
10 changes: 10 additions & 0 deletions test/unit_tests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,16 @@ TEST_CASE("TreeT rejects invalid serialised leaf data")
(void)merkle::Tree(truncated_extra_hash),
"not enough bytes",
std::runtime_error);

std::vector<uint8_t> truncated_flushed_hashes;
merkle::serialise_uint64_t(1, truncated_flushed_hashes);
merkle::serialise_uint64_t(3, truncated_flushed_hashes);
truncated_flushed_hashes.resize(
truncated_flushed_hashes.size() + 2 * merkle::Hash::size_bytes);
REQUIRE_THROWS_WITH_AS(
(void)merkle::Tree(truncated_flushed_hashes),
"not enough bytes",
std::runtime_error);
}

TEST_CASE("TreeT deserialises flushed counts beyond signed shift width")
Expand Down
Loading