Skip to content

Commit

Permalink
Add some assertions for the validity of the binexport
Browse files Browse the repository at this point in the history 
PiperOrigin-RevId: 692203408
Change-Id: I3e679761c20868c3e67f203ba71075ff45f257d0
  • Loading branch information
@copybara-github
BinExport Authors authored and copybara-github committed Nov 1, 2024
1 parent 223519a commit 23619ba
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 5 deletions.
53 changes: 49 additions & 4 deletions reader/flow_graph.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,14 @@
#include "third_party/absl/log/check.h"
#include "third_party/absl/log/log.h"
#include "third_party/absl/memory/memory.h"
#include "third_party/absl/strings/ascii.h"
#include "third_party/absl/status/status.h"
#include "third_party/absl/strings/str_cat.h"
#include "third_party/absl/types/optional.h"
#include "third_party/zynamics/binexport/architectures.h"
#include "third_party/absl/strings/ascii.h"
#include "third_party/zynamics/binexport/reader/graph_utility.h"
#include "third_party/zynamics/binexport/reader/instruction.h"
#include "third_party/zynamics/binexport/util/status_macros.h"
#include "third_party/zynamics/binexport/util/types.h"

namespace security::binexport {
Expand Down Expand Up @@ -76,14 +79,26 @@ uint32_t GetEdgeTypeFromProto(BinExport2::FlowGraph::Edge::Type type) {
}
}

void EdgesFromEdgeProto(
absl::Status EdgesFromEdgeProto(
const BinExport2& proto, const BinExport2::FlowGraph& flow_graph_proto,
const std::vector<Address>& addresses,
const std::vector<uint64_t>& instruction_addresses,
std::vector<std::pair<FlowGraph::Graph::edges_size_type,
FlowGraph::Graph::edges_size_type>>* edges,
std::vector<FlowGraph::EdgeProperty>* edge_properties) {
for (const auto& edge : flow_graph_proto.edge()) {
if (edge.source_basic_block_index() < 0 ||
edge.source_basic_block_index() >= proto.basic_block_size() ||
edge.target_basic_block_index() < 0 ||
edge.target_basic_block_index() >= proto.basic_block_size()) {
return absl::InvalidArgumentError(absl::StrCat(
"Found an invalid binexport proto for binary: ",
proto.meta_information().executable_id(),
" - invalid basic block index inside the flow graph - source basic "
"block index: ",
edge.source_basic_block_index(),
" target basic block index: ", edge.target_basic_block_index()));
}
const Address source_address =
instruction_addresses[proto.basic_block(edge.source_basic_block_index())
.instruction_index(0)
Expand All @@ -107,6 +122,7 @@ void EdgesFromEdgeProto(
edge_properties->push_back(edge_property);
}
}
return absl::OkStatus();
}

void AssignVertexProperties(
Expand Down Expand Up @@ -144,9 +160,28 @@ FlowGraph::Vertex FlowGraph::GetVertex(Address address) const {
}

std::unique_ptr<FlowGraph> FlowGraph::FromBinExport2Proto(
const BinExport2& proto, const BinExport2::FlowGraph& flow_graph_proto,
const std::vector<uint64_t>& instruction_addresses) {
auto flow_graph =
FromBinExport2(proto, flow_graph_proto, instruction_addresses);
if (!flow_graph.ok()) {
LOG(FATAL) << "Failed to create flow graph: " << flow_graph.status();
return nullptr;
}
return std::move(flow_graph.value());
}

absl::StatusOr<std::unique_ptr<FlowGraph>> FlowGraph::FromBinExport2(
const BinExport2& proto, const BinExport2::FlowGraph& flow_graph_proto,
const std::vector<Address>& instruction_addresses) {
auto flow_graph = absl::make_unique<FlowGraph>();
if (flow_graph_proto.entry_basic_block_index() < 0 ||
flow_graph_proto.entry_basic_block_index() >= proto.basic_block_size()) {
return absl::InvalidArgumentError(absl::StrCat(
"Invalid entry basic block for binary: ",
proto.meta_information().executable_id(),
" - entry bb index: ", flow_graph_proto.entry_basic_block_index()));
}
int entry_instruction_index =
proto.basic_block(flow_graph_proto.entry_basic_block_index())
.instruction_index(0)
Expand All @@ -160,6 +195,15 @@ std::unique_ptr<FlowGraph> FlowGraph::FromBinExport2Proto(
addresses.reserve(flow_graph_proto.basic_block_index_size());

for (int basic_block_index : flow_graph_proto.basic_block_index()) {
if (basic_block_index < 0 ||
basic_block_index >= proto.basic_block_size()) {
return absl::InvalidArgumentError(
absl::StrCat("Found an invalid binexport proto for binary: ",
proto.meta_information().executable_id(),
" - invalid basic block index inside the flow graph - "
"basic block index: ",
basic_block_index));
}
const BinExport2::BasicBlock& basic_block_proto(
proto.basic_block(basic_block_index));
VertexProperty vertex_property;
Expand Down Expand Up @@ -202,8 +246,9 @@ std::unique_ptr<FlowGraph> FlowGraph::FromBinExport2Proto(
edges.reserve(flow_graph_proto.edge_size());
std::vector<EdgeProperty> edge_properties;
edge_properties.reserve(flow_graph_proto.edge_size());
EdgesFromEdgeProto(proto, flow_graph_proto, addresses, instruction_addresses,
&edges, &edge_properties);
NA_RETURN_IF_ERROR(EdgesFromEdgeProto(proto, flow_graph_proto, addresses,
instruction_addresses, &edges,
&edge_properties));
flow_graph->graph_ = Graph(boost::edges_are_unsorted_multi_pass,
edges.begin(), edges.end(), addresses.size());
flow_graph->architecture_ = GetSupportedArchitecture(proto);
Expand Down
10 changes: 9 additions & 1 deletion reader/flow_graph.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,15 @@

#include <boost/graph/adjacency_list.hpp> //NOLINT
#include <boost/graph/compressed_sparse_row_graph.hpp> // NOLINT
#include <cstddef>
#include <cstdint>
#include <limits>
#include <memory>
#include <tuple>
#include <utility>
#include <vector>

#include "third_party/absl/base/macros.h"
#include "third_party/absl/base/attributes.h"
#include "third_party/absl/types/optional.h"
#include "third_party/zynamics/binexport/architectures.h"
#include "third_party/zynamics/binexport/binexport2.pb.h"
Expand Down Expand Up @@ -85,6 +88,11 @@ class FlowGraph {
VertexProperty, EdgeProperty>;

// Factory method to read and initialize a flow graph (BinExport2).
static absl::StatusOr<std::unique_ptr<FlowGraph>> FromBinExport2(
const BinExport2& proto, const BinExport2::FlowGraph& flow_graph_proto,
const std::vector<uint64_t>& instruction_addresses);

ABSL_DEPRECATED("Use FromBinExport2Proto that returns a StatusOr instead.")
static std::unique_ptr<FlowGraph> FromBinExport2Proto(
const BinExport2& proto, const BinExport2::FlowGraph& flow_graph_proto,
const std::vector<uint64_t>& instruction_addresses);
Expand Down

0 comments on commit 23619ba

Please sign in to comment.