Compare commits

...

14 Commits

Author SHA1 Message Date
977d772687 fix 2026-03-13 22:20:57 +03:00
746f1b84a8 hot fix 2026-03-13 22:16:42 +03:00
af399a14ed Merge pull request #165 from orange-cpp/feature/hud
Feature/hud
2026-03-13 22:11:26 +03:00
6fb420642b updated props 2026-03-13 21:58:14 +03:00
6a2b4b90b4 fix 2026-03-13 21:49:56 +03:00
371d8154ee fix 2026-03-13 21:40:30 +03:00
d6a2165f83 fix 2026-03-13 21:37:03 +03:00
bb1b5ad14a removed shit 2026-03-13 21:32:44 +03:00
f188257e0f added stuff 2026-03-13 21:28:16 +03:00
87966c82b9 added realization 2026-03-13 21:09:12 +03:00
9da19582b5 added files 2026-03-13 20:51:59 +03:00
29f3e2565d Merge pull request #164 from orange-cpp/feaute/disk_optimization
avoid saving files on disk
2026-03-13 03:55:56 +03:00
e083b15e0b update 2026-03-13 03:42:12 +03:00
ed9da79d08 avoid saving files on disk 2026-03-13 03:33:57 +03:00
19 changed files with 938 additions and 529 deletions

View File

@@ -2,6 +2,7 @@ add_subdirectory(example_barycentric)
add_subdirectory(example_glfw3) add_subdirectory(example_glfw3)
add_subdirectory(example_proj_mat_builder) add_subdirectory(example_proj_mat_builder)
add_subdirectory(example_signature_scan) add_subdirectory(example_signature_scan)
add_subdirectory(example_hud)
if(OMATH_ENABLE_VALGRIND) if(OMATH_ENABLE_VALGRIND)
omath_setup_valgrind(example_projection_matrix_builder) omath_setup_valgrind(example_projection_matrix_builder)

View File

@@ -0,0 +1,16 @@
project(example_hud)
add_executable(${PROJECT_NAME} main.cpp gui/main_window.cpp gui/main_window.hpp)
set_target_properties(
${PROJECT_NAME}
PROPERTIES CXX_STANDARD 23
ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/out/${CMAKE_BUILD_TYPE}"
LIBRARY_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/out/${CMAKE_BUILD_TYPE}"
RUNTIME_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/out/${CMAKE_BUILD_TYPE}")
find_package(OpenGL)
find_package(GLEW REQUIRED)
find_package(glfw3 CONFIG REQUIRED)
target_link_libraries(${PROJECT_NAME} PRIVATE glfw imgui::imgui omath::omath OpenGL::GL)

View File

@@ -0,0 +1,110 @@
//
// Created by Orange on 11/11/2024.
//
#include "main_window.hpp"
#include "omath/hud/renderer_realizations/imgui_renderer.hpp"
#include <GLFW/glfw3.h>
#include <algorithm>
#include <imgui.h>
#include <imgui_impl_glfw.h>
#include <imgui_impl_opengl3.h>
#include <omath/hud/entity_overlay.hpp>
namespace imgui_desktop::gui
{
bool MainWindow::m_canMoveWindow = false;
MainWindow::MainWindow(const std::string_view& caption, int width, int height)
{
if (!glfwInit())
std::exit(EXIT_FAILURE);
glfwWindowHint(GLFW_TRANSPARENT_FRAMEBUFFER, true);
m_window = glfwCreateWindow(width, height, caption.data(), nullptr, nullptr);
glfwMakeContextCurrent(m_window);
ImGui::CreateContext();
ImGui::StyleColorsDark();
ImGui::GetStyle().Colors[ImGuiCol_WindowBg] = {0.f, 0.f, 0.f, 0.f};
ImGui::GetStyle().AntiAliasedLines = false;
ImGui::GetStyle().AntiAliasedFill = false;
ImGui_ImplGlfw_InitForOpenGL(m_window, true);
ImGui_ImplOpenGL3_Init("#version 130");
}
void MainWindow::Run()
{
omath::Color box_color = {0.f, 0.f, 0.f, 1.f};
omath::Color box_fill = {0.f, 0.f, 0.f, 0.f};
omath::Color bar_color = {0.f, 1.f, 0.f, 1.f};
omath::Color bar_bg_color = {0.f, 0.f, 0.f, 0.0f};
omath::Color bar_outline_color = {0.f, 0.f, 0.f, 1.f};
float bar_width = 3.f;
float bar_value = 1.f;
while (!glfwWindowShouldClose(m_window) && m_opened)
{
glfwPollEvents();
ImGui_ImplOpenGL3_NewFrame();
ImGui_ImplGlfw_NewFrame();
ImGui::NewFrame();
ImGui::GetBackgroundDrawList()->AddRectFilled({}, ImGui::GetMainViewport()->Size, ImColor(40, 40, 40, 200));
ImGui::Begin("OHUD Showcase", &m_opened,
ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoCollapse | ImGuiWindowFlags_NoDecoration);
{
ImGui::SetWindowPos({});
ImGui::SetWindowSize(ImGui::GetMainViewport()->Size);
ImGui::ColorEdit4("Box", reinterpret_cast<float*>(&box_color), ImGuiColorEditFlags_NoInputs);
ImGui::ColorEdit4("Box fill", reinterpret_cast<float*>(&box_fill), ImGuiColorEditFlags_NoInputs);
ImGui::ColorEdit4("Bar", reinterpret_cast<float*>(&bar_color), ImGuiColorEditFlags_NoInputs);
ImGui::ColorEdit4("Bar Background", reinterpret_cast<float*>(&bar_bg_color),
ImGuiColorEditFlags_NoInputs);
ImGui::ColorEdit4("Bar Outline", reinterpret_cast<float*>(&bar_outline_color),
ImGuiColorEditFlags_NoInputs);
ImGui::PushItemWidth(100.f);
ImGui::SliderFloat("Bar Width", &bar_width, 1.f, 20.f);
ImGui::SliderFloat("Bar Value", &bar_value, 0.f, 1.f);
ImGui::PopItemWidth();
ImGui::End();
}
omath::hud::EntityOverlay ent({400.f, 100.f}, {400.f, 400.f}, std::make_shared<omath::hud::ImguiHudRenderer>());
ent.add_2d_box(box_color, box_fill, 1.f);
ent.add_cornered_2d_box(omath::Color::from_rgba(255, 0, 255, 255), box_fill);
ent.add_right_bar(bar_color, bar_outline_color, bar_bg_color, bar_width, bar_value);
ent.add_left_bar(bar_color, bar_outline_color, bar_bg_color, bar_width, bar_value);
ent.add_top_bar(bar_color, bar_outline_color, bar_bg_color, bar_width, bar_value);
ent.add_right_label({0.f, 1.f, 0.f, 1.f}, 3, true, "Health: {}/100", 100);
ent.add_right_label({1.f, 0.f, 0.f, 1.f}, 3, true, "Shield: {}/125", 125);
ent.add_right_label({1.f, 0.f, 1.f, 1.f}, 3, true, "*LOCKED*");
ent.add_top_label(omath::Color::from_rgba(255, 255, 0, 255), 3, true, "*SCOPED*");
ent.add_top_label(omath::Color::from_rgba(255, 0, 0, 255), 3, true, "*BLEEDING*");
ent.add_snap_line(omath::Vector2<float>{400, 600}, omath::Color::from_rgba(255, 0, 0, 255), 2.f);
ImGui::Render();
int display_w, display_h;
glfwGetFramebufferSize(m_window, &display_w, &display_h);
glViewport(0, 0, display_w, display_h);
glClearColor(0.f, 0.f, 0.f, 0.f);
glClear(GL_COLOR_BUFFER_BIT);
ImGui_ImplOpenGL3_RenderDrawData(ImGui::GetDrawData());
glfwSwapBuffers(m_window);
}
glfwDestroyWindow(m_window);
}
} // namespace imgui_desktop::gui
// imgui_desktop

View File

@@ -0,0 +1,28 @@
//
// Created by Vlad on 6/17/2025.
//
//
// Created by Orange on 11/11/2024.
//
#pragma once
#include <string_view>
struct GLFWwindow;
namespace imgui_desktop::gui
{
class MainWindow
{
public:
MainWindow(const std::string_view &caption, int width, int height);
void Run();
private:
GLFWwindow* m_window;
static bool m_canMoveWindow;
bool m_opened = true;
};
} // gui
// imgui_desktop

View File

@@ -0,0 +1,8 @@
//
// Created by orange on 13.03.2026.
//
#include "gui/main_window.hpp"
int main()
{
imgui_desktop::gui::MainWindow("omath::hud", 800, 600).Run();
}

View File

@@ -0,0 +1,23 @@
//
// Created by orange on 13.03.2026.
//
#pragma once
#include "omath/linear_algebra/vector2.hpp"
#include <array>
namespace omath::hud
{
class CanvasBox final
{
public:
CanvasBox(Vector2<float> top, Vector2<float> bottom, float ratio = 4.f);
[[nodiscard]]
std::array<Vector2<float>, 4> as_array() const;
Vector2<float> top_left_corner;
Vector2<float> top_right_corner;
Vector2<float> bottom_left_corner;
Vector2<float> bottom_right_corner;
};
} // namespace omath::hud

View File

@@ -0,0 +1,66 @@
//
// Created by orange on 13.03.2026.
//
#pragma once
#include "canvas_box.hpp"
#include "hud_renderer_interface.hpp"
#include "omath/linear_algebra/vector2.hpp"
#include "omath/utility/color.hpp"
#include <memory>
#include <string_view>
namespace omath::hud
{
class EntityOverlay final
{
public:
EntityOverlay(const Vector2<float>& top, const Vector2<float>& bottom,
const std::shared_ptr<HudRendererInterface>& renderer);
void add_2d_box(const Color& box_color, const Color& fill_color = Color{0.f, 0.f, 0.f, 0.f},
float thickness = 1.f) const;
void add_cornered_2d_box(const Color& box_color, const Color& fill_color = Color{0.f, 0.f, 0.f, 0.f},
float corner_ratio_len = 0.2f, float thickness = 1.f) const;
void add_right_bar(const Color& color, const Color& outline_color, const Color& bg_color, float width,
float ratio, float offset = 5.f);
void add_left_bar(const Color& color, const Color& outline_color, const Color& bg_color, float width,
float ratio, float offset = 5.f) const;
template<typename... Args>
void add_right_label(const Color& color, const float offset, const bool outlined,
std::format_string<Args...> fmt, Args&&... args)
{
const std::string label = std::vformat(fmt.get(), std::make_format_args(args...));
add_right_label(color, offset, outlined, std::string_view{label});
}
void add_right_label(const Color& color, float offset, bool outlined, const std::string_view& text);
template<typename... Args>
void add_top_label(const Color& color, const float offset, const bool outlined, std::format_string<Args...> fmt,
Args&&... args)
{
const std::string label = std::vformat(fmt.get(), std::make_format_args(args...));
add_top_label(color, offset, outlined, std::string_view{label});
}
void add_top_label(const Color& color, float offset, bool outlined, std::string_view text);
void add_top_bar(const Color& color, const Color& outline_color, const Color& bg_color, float height,
float ratio, float offset = 5.f);
void add_snap_line(const Vector2<float>& start_pos, const Color& color, float width);
private:
void draw_outlined_text(const Vector2<float>& position, const Color& color,
const std::string_view& text);
CanvasBox m_canvas;
Vector2<float> m_text_cursor_right;
Vector2<float> m_text_cursor_top;
std::shared_ptr<HudRendererInterface> m_renderer;
};
} // namespace omath::hud

View File

@@ -0,0 +1,33 @@
//
// Created by orange on 13.03.2026.
//
#pragma once
#include "omath/linear_algebra/vector2.hpp"
#include "omath/utility/color.hpp"
#include <span>
namespace omath::hud
{
class HudRendererInterface
{
public:
virtual ~HudRendererInterface() = default;
virtual void add_line(const Vector2<float>& line_start, const Vector2<float>& line_end, const Color& color,
float thickness) = 0;
virtual void add_polyline(const std::span<const Vector2<float>>& vertexes, const Color& color,
float thickness) = 0;
virtual void add_filled_polyline(const std::span<const Vector2<float>>& vertexes, const Color& color,
float thickness) = 0;
virtual void add_rectangle(const Vector2<float>& min, const Vector2<float>& max, const Color& color) = 0;
virtual void add_filled_rectangle(const Vector2<float>& min, const Vector2<float>& max, const Color& color) = 0;
virtual void add_text(const Vector2<float>& position, const Color& color, const std::string_view& text) = 0;
[[nodiscard]]
virtual Vector2<float> calc_text_size(const std::string_view& text) = 0;
};
} // namespace omath::hud

View File

@@ -0,0 +1,25 @@
//
// Created by orange on 13.03.2026.
//
#pragma once
#include <omath/hud/hud_renderer_interface.hpp>
#ifdef OMATH_IMGUI_INTEGRATION
namespace omath::hud
{
class ImguiHudRenderer final : public HudRendererInterface
{
public:
~ImguiHudRenderer() override;
void add_line(const Vector2<float>& line_start, const Vector2<float>& line_end, const Color& color,
float thickness) override;
void add_polyline(const std::span<const Vector2<float>>& vertexes, const Color& color, float thickness) override;
void add_filled_polyline(const std::span<const Vector2<float>>& vertexes, const Color& color, float thickness) override;
void add_rectangle(const Vector2<float>& min, const Vector2<float>& max, const Color& color) override;
void add_filled_rectangle(const Vector2<float>& min, const Vector2<float>& max, const Color& color) override;
void add_text(const Vector2<float>& position, const Color& color, const std::string_view& text) override;
[[nodiscard]]
virtual Vector2<float> calc_text_size(const std::string_view& text) override;
};
} // namespace omath::hud
#endif // OMATH_IMGUI_INTEGRATION

27
source/hud/canvas_box.cpp Normal file
View File

@@ -0,0 +1,27 @@
//
// Created by orange on 13.03.2026.
//
//
// Created by Vlad on 6/17/2025.
//
#include "omath/hud/canvas_box.hpp"
namespace omath::hud
{
CanvasBox::CanvasBox(const Vector2<float> top, Vector2<float> bottom, const float ratio)
{
bottom.x = top.x;
const auto height = std::abs(top.y - bottom.y);
top_left_corner = top - Vector2<float>{height / ratio, 0};
top_right_corner = top + Vector2<float>{height / ratio, 0};
bottom_left_corner = bottom - Vector2<float>{height / ratio, 0};
bottom_right_corner = bottom + Vector2<float>{height / ratio, 0};
}
std::array<Vector2<float>, 4> CanvasBox::as_array() const
{
return {top_left_corner, top_right_corner, bottom_right_corner, bottom_left_corner};
}
} // namespace ohud

View File

@@ -0,0 +1,138 @@
//
// Created by orange on 13.03.2026.
//
#include "omath/hud/entity_overlay.hpp"
namespace omath::hud
{
void EntityOverlay::add_2d_box(const Color& box_color, const Color& fill_color, const float thickness) const
{
const auto points = m_canvas.as_array();
m_renderer->add_polyline({points.data(), points.size()}, box_color, thickness);
m_renderer->add_filled_polyline({points.data(), points.size()}, fill_color, thickness);
}
void EntityOverlay::add_cornered_2d_box(const Color& box_color, const Color& fill_color,
const float corner_ratio_len, const float thickness) const
{
const auto corner_line_length =
std::abs((m_canvas.top_left_corner - m_canvas.top_right_corner).x * corner_ratio_len);
if (fill_color.value().w > 0.f)
add_2d_box(fill_color, fill_color);
// Left Side
m_renderer->add_line(m_canvas.top_left_corner,
m_canvas.top_left_corner + Vector2<float>{corner_line_length, 0.f}, box_color, thickness);
m_renderer->add_line(m_canvas.top_left_corner,
m_canvas.top_left_corner + Vector2<float>{0.f, corner_line_length}, box_color, thickness);
m_renderer->add_line(m_canvas.bottom_left_corner,
m_canvas.bottom_left_corner - Vector2<float>{0.f, corner_line_length}, box_color,
thickness);
m_renderer->add_line(m_canvas.bottom_left_corner,
m_canvas.bottom_left_corner + Vector2<float>{corner_line_length, 0.f}, box_color,
thickness);
// Right Side
m_renderer->add_line(m_canvas.top_right_corner,
m_canvas.top_right_corner - Vector2<float>{corner_line_length, 0.f}, box_color, thickness);
m_renderer->add_line(m_canvas.top_right_corner,
m_canvas.top_right_corner + Vector2<float>{0.f, corner_line_length}, box_color, thickness);
m_renderer->add_line(m_canvas.bottom_right_corner,
m_canvas.bottom_right_corner - Vector2<float>{0.f, corner_line_length}, box_color,
thickness);
m_renderer->add_line(m_canvas.bottom_right_corner,
m_canvas.bottom_right_corner - Vector2<float>{corner_line_length, 0.f}, box_color,
thickness);
}
void EntityOverlay::add_right_bar(const Color& color, const Color& outline_color, const Color& bg_color,
const float width, float ratio, const float offset)
{
ratio = std::clamp(ratio, 0.f, 1.f);
const auto max_bar_height = std::abs(m_canvas.top_right_corner.y - m_canvas.bottom_right_corner.y);
const auto bar_start = m_canvas.bottom_right_corner + Vector2<float>{offset, 0.f};
m_renderer->add_filled_rectangle(bar_start, bar_start + Vector2<float>(width, -max_bar_height), bg_color);
m_renderer->add_filled_rectangle(bar_start, bar_start + Vector2<float>(width, -max_bar_height * ratio), color);
m_renderer->add_rectangle(bar_start - Vector2<float>(1.f, 0.f),
bar_start + Vector2<float>(width, -max_bar_height), outline_color);
m_text_cursor_right.x += offset + width;
}
void EntityOverlay::add_left_bar(const Color& color, const Color& outline_color, const Color& bg_color,
const float width, float ratio, const float offset) const
{
ratio = std::clamp(ratio, 0.f, 1.f);
const auto max_bar_height = std::abs(m_canvas.top_left_corner.y - m_canvas.bottom_right_corner.y);
const auto bar_start = m_canvas.bottom_left_corner + Vector2<float>{-(offset + width), 0.f};
m_renderer->add_filled_rectangle(bar_start, bar_start + Vector2<float>(width, -max_bar_height), bg_color);
m_renderer->add_filled_rectangle(bar_start, bar_start + Vector2<float>(width, -max_bar_height * ratio), color);
m_renderer->add_rectangle(bar_start - Vector2<float>(1.f, 0.f),
bar_start + Vector2<float>(width, -max_bar_height), outline_color);
}
void EntityOverlay::add_right_label(const Color& color, const float offset, const bool outlined,
const std::string_view& text)
{
if (outlined)
draw_outlined_text(m_text_cursor_right + Vector2<float>{offset, 0.f}, color, text);
else
m_renderer->add_text(m_text_cursor_right + Vector2<float>{offset, 0.f}, color, text.data());
m_text_cursor_right.y += m_renderer->calc_text_size(text.data()).y;
}
void EntityOverlay::add_top_label(const Color& color, const float offset, const bool outlined,
const std::string_view text)
{
m_text_cursor_top.y -= m_renderer->calc_text_size(text.data()).y;
if (outlined)
draw_outlined_text(m_text_cursor_top + Vector2<float>{0.f, -offset}, color, text);
else
m_renderer->add_text(m_text_cursor_top + Vector2<float>{0.f, -offset}, color, text.data());
}
void EntityOverlay::add_top_bar(const Color& color, const Color& outline_color, const Color& bg_color,
const float height, float ratio, const float offset)
{
ratio = std::clamp(ratio, 0.f, 1.f);
const auto max_bar_width = std::abs(m_canvas.top_left_corner.x - m_canvas.bottom_right_corner.x);
const auto bar_start = m_canvas.top_left_corner - Vector2<float>{0.f, offset};
m_renderer->add_filled_rectangle(bar_start, bar_start + Vector2<float>(max_bar_width, -height), bg_color);
m_renderer->add_filled_rectangle(bar_start, bar_start + Vector2<float>(max_bar_width * ratio, -height), color);
m_renderer->add_rectangle(bar_start, bar_start + Vector2<float>(max_bar_width, -height), outline_color);
m_text_cursor_top.y -= offset + height;
}
void EntityOverlay::add_snap_line(const Vector2<float>& start_pos, const Color& color, const float width)
{
const Vector2<float> line_end =
m_canvas.bottom_left_corner
+ Vector2<float>{m_canvas.bottom_right_corner.x - m_canvas.bottom_left_corner.x, 0.f} / 2;
m_renderer->add_line(start_pos, line_end, color, width);
}
void EntityOverlay::draw_outlined_text(const Vector2<float>& position, const Color& color,
const std::string_view& text)
{
static constexpr std::array outline_offsets = {
Vector2<float>{-1, -1}, Vector2<float>{-1, 0}, Vector2<float>{-1, 1}, Vector2<float>{0, -1},
Vector2<float>{0, 1}, Vector2<float>{1, -1}, Vector2<float>{1, 0}, Vector2<float>{1, 1}};
for (const auto& outline_offset : outline_offsets)
m_renderer->add_text(position + outline_offset, Color{0.f, 0.f, 0.f, 1.f}, text.data());
m_renderer->add_text(position, color, text.data());
}
EntityOverlay::EntityOverlay(const Vector2<float>& top, const Vector2<float>& bottom,
const std::shared_ptr<HudRendererInterface>& renderer)
: m_canvas(top, bottom), m_text_cursor_right(m_canvas.top_right_corner),
m_text_cursor_top(m_canvas.top_left_corner), m_renderer(renderer)
{
}
} // namespace omath::hud

View File

@@ -0,0 +1,58 @@
//
// Created by orange on 13.03.2026.
//
#include "omath/hud/renderer_realizations/imgui_renderer.hpp"
#ifdef OMATH_IMGUI_INTEGRATION
#include <imgui.h>
namespace omath::hud
{
ImguiHudRenderer::~ImguiHudRenderer() = default;
void ImguiHudRenderer::add_line(const Vector2<float>& line_start, const Vector2<float>& line_end,
const Color& color, const float thickness)
{
ImGui::GetBackgroundDrawList()->AddLine(line_start.to_im_vec2(), line_end.to_im_vec2(), color.to_im_color(),
thickness);
}
void ImguiHudRenderer::add_polyline(const std::span<const Vector2<float>>& vertexes, const Color& color,
const float thickness)
{
ImGui::GetBackgroundDrawList()->AddPolyline(reinterpret_cast<const ImVec2*>(vertexes.data()),
static_cast<int>(vertexes.size()), color.to_im_color(),
ImDrawFlags_None, thickness);
}
void ImguiHudRenderer::add_filled_polyline(const std::span<const Vector2<float>>& vertexes, const Color& color,
const float thickness)
{
ImGui::GetBackgroundDrawList()->AddPolyline(reinterpret_cast<const ImVec2*>(vertexes.data()),
static_cast<int>(vertexes.size()), color.to_im_color(),
ImDrawFlags_Closed, thickness);
}
void ImguiHudRenderer::add_rectangle(const Vector2<float>& min, const Vector2<float>& max, const Color& color)
{
ImGui::GetBackgroundDrawList()->AddRect(min.to_im_vec2(), max.to_im_vec2(), color.to_im_color());
}
void ImguiHudRenderer::add_filled_rectangle(const Vector2<float>& min, const Vector2<float>& max,
const Color& color)
{
ImGui::GetBackgroundDrawList()->AddRectFilled(min.to_im_vec2(), max.to_im_vec2(), color.to_im_color());
}
void ImguiHudRenderer::add_text(const Vector2<float>& position, const Color& color, const std::string_view& text)
{
ImGui::GetBackgroundDrawList()->AddText(position.to_im_vec2(), color.to_im_color(), text.data(),
text.data() + text.size());
}
[[nodiscard]]
Vector2<float> calc_text_size(const std::string_view& text)
{
return Vector2<float>::from_im_vec2(ImGui::CalcTextSize(text.data()));
}
} // namespace omath::hud
#endif // OMATH_IMGUI_INTEGRATION

View File

@@ -4,7 +4,7 @@ project(unit_tests)
include(GoogleTest) include(GoogleTest)
file(GLOB_RECURSE UNIT_TESTS_SOURCES CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/general/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/engines/*.cpp") file(GLOB_RECURSE UNIT_TESTS_SOURCES CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/general/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/engines/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/*.hpp")
add_executable(${PROJECT_NAME} ${UNIT_TESTS_SOURCES} main.cpp) add_executable(${PROJECT_NAME} ${UNIT_TESTS_SOURCES} main.cpp)
set_target_properties( set_target_properties(

View File

@@ -0,0 +1,192 @@
#pragma once
// Cross-platform helper for creating binary test "files" without writing to disk where possible.
//
// Strategy:
// - Linux (non-Android, or Android API >= 30): memfd_create → /proc/self/fd/<N> (no disk I/O)
// - All other platforms: anonymous temp file via std::tmpfile(), accessed via /proc/self/fd/<N>
// on Linux, or a named temp file (cleaned up on destruction) elsewhere.
//
// Usage:
// auto f = MemFdFile::create(myVector);
// ASSERT_TRUE(f.valid());
// scanner.scan_for_pattern_in_file(f.path(), ...);
#include <cstdint>
#include <cstring>
#include <filesystem>
#include <fstream>
#include <random>
#include <string>
#include <vector>
#if defined(__linux__)
# include <unistd.h>
# include <fcntl.h>
# if defined(__ANDROID__)
# if __ANDROID_API__ >= 30
# include <sys/mman.h>
# define OMATH_TEST_USE_MEMFD 1
# endif
// Android < 30: fall through to tmpfile() path below
# else
// Desktop Linux: memfd_create available since glibc 2.27 / kernel 3.17
# include <sys/mman.h>
# define OMATH_TEST_USE_MEMFD 1
# endif
#endif
class MemFdFile
{
public:
MemFdFile() = default;
~MemFdFile()
{
#if defined(OMATH_TEST_USE_MEMFD)
if (m_fd >= 0)
::close(m_fd);
#else
if (!m_temp_path.empty())
std::filesystem::remove(m_temp_path);
#endif
}
MemFdFile(const MemFdFile&) = delete;
MemFdFile& operator=(const MemFdFile&) = delete;
MemFdFile(MemFdFile&& o) noexcept
: m_path(std::move(o.m_path))
#if defined(OMATH_TEST_USE_MEMFD)
, m_fd(o.m_fd)
#else
, m_temp_path(std::move(o.m_temp_path))
#endif
{
#if defined(OMATH_TEST_USE_MEMFD)
o.m_fd = -1;
#else
o.m_temp_path.clear();
#endif
}
[[nodiscard]] bool valid() const { return !m_path.empty(); }
[[nodiscard]] const std::filesystem::path& path() const { return m_path; }
static MemFdFile create(const std::vector<std::uint8_t>& data)
{
return create(data.data(), data.size());
}
static MemFdFile create(const std::uint8_t* data, std::size_t size)
{
MemFdFile f;
#if defined(OMATH_TEST_USE_MEMFD)
f.m_fd = static_cast<int>(::memfd_create("test_bin", 0));
if (f.m_fd < 0)
return f;
if (!write_all(f.m_fd, data, size))
{
::close(f.m_fd);
f.m_fd = -1;
return f;
}
f.m_path = "/proc/self/fd/" + std::to_string(f.m_fd);
#else
// Portable fallback: write to a uniquely-named temp file and delete on destruction
const auto tmp_dir = std::filesystem::temp_directory_path();
std::mt19937_64 rng(std::random_device{}());
const auto unique_name = "omath_test_" + std::to_string(rng()) + ".bin";
f.m_temp_path = (tmp_dir / unique_name).string();
f.m_path = f.m_temp_path;
std::ofstream out(f.m_temp_path, std::ios::binary | std::ios::trunc);
if (!out.is_open())
{
f.m_temp_path.clear();
f.m_path.clear();
return f;
}
out.write(reinterpret_cast<const char*>(data), static_cast<std::streamsize>(size));
if (!out)
{
out.close();
std::filesystem::remove(f.m_temp_path);
f.m_temp_path.clear();
f.m_path.clear();
}
#endif
return f;
}
private:
std::filesystem::path m_path;
#if defined(OMATH_TEST_USE_MEMFD)
int m_fd = -1;
static bool write_all(int fd, const std::uint8_t* data, std::size_t size)
{
std::size_t written = 0;
while (written < size)
{
const auto n = ::write(fd, data + written, size - written);
if (n <= 0)
return false;
written += static_cast<std::size_t>(n);
}
return true;
}
#else
std::string m_temp_path;
#endif
};
// ---------------------------------------------------------------------------
// Build a minimal PE binary in-memory with a single .text section.
// Layout (all offsets compile-time):
// 0x00: DOS header (64 B) 0x40: pad 0x80: NT sig 0x84: FileHeader (20 B)
// 0x98: OptionalHeader (0xF0 B) 0x188: SectionHeader (44 B) 0x1B4: section data
// ---------------------------------------------------------------------------
inline std::vector<std::uint8_t> build_minimal_pe(const std::vector<std::uint8_t>& section_bytes)
{
constexpr std::uint32_t e_lfanew = 0x80u;
constexpr std::uint16_t size_opt = 0xF0u;
constexpr std::size_t nt_off = e_lfanew;
constexpr std::size_t fh_off = nt_off + 4;
constexpr std::size_t oh_off = fh_off + 20;
constexpr std::size_t sh_off = oh_off + size_opt;
constexpr std::size_t data_off = sh_off + 44;
std::vector<std::uint8_t> buf(data_off + section_bytes.size(), 0u);
buf[0] = 'M'; buf[1] = 'Z';
std::memcpy(buf.data() + 0x3Cu, &e_lfanew, 4);
buf[nt_off] = 'P'; buf[nt_off + 1] = 'E';
const std::uint16_t machine = 0x8664u, num_sections = 1u;
std::memcpy(buf.data() + fh_off, &machine, 2);
std::memcpy(buf.data() + fh_off + 2, &num_sections, 2);
std::memcpy(buf.data() + fh_off + 16, &size_opt, 2);
const std::uint16_t magic = 0x20Bu;
std::memcpy(buf.data() + oh_off, &magic, 2);
const char name[8] = {'.','t','e','x','t',0,0,0};
std::memcpy(buf.data() + sh_off, name, 8);
const auto vsize = static_cast<std::uint32_t>(section_bytes.size());
const std::uint32_t vaddr = 0x1000u;
const auto ptr_raw = static_cast<std::uint32_t>(data_off);
std::memcpy(buf.data() + sh_off + 8, &vsize, 4);
std::memcpy(buf.data() + sh_off + 12, &vaddr, 4);
std::memcpy(buf.data() + sh_off + 16, &vsize, 4);
std::memcpy(buf.data() + sh_off + 20, &ptr_raw, 4);
std::memcpy(buf.data() + data_off, section_bytes.data(), section_bytes.size());
return buf;
}

View File

@@ -6,8 +6,8 @@
#include <omath/utility/macho_pattern_scan.hpp> #include <omath/utility/macho_pattern_scan.hpp>
#include <cstdint> #include <cstdint>
#include <cstring> #include <cstring>
#include <fstream>
#include <vector> #include <vector>
#include "mem_fd_helper.hpp"
using namespace omath; using namespace omath;
@@ -16,11 +16,12 @@ namespace
// Mach-O magic numbers // Mach-O magic numbers
constexpr std::uint32_t mh_magic_64 = 0xFEEDFACF; constexpr std::uint32_t mh_magic_64 = 0xFEEDFACF;
constexpr std::uint32_t mh_magic_32 = 0xFEEDFACE; constexpr std::uint32_t mh_magic_32 = 0xFEEDFACE;
constexpr std::uint32_t lc_segment = 0x1; constexpr std::uint32_t lc_segment = 0x1;
constexpr std::uint32_t lc_segment_64 = 0x19; constexpr std::uint32_t lc_segment_64 = 0x19;
constexpr std::string_view segment_name = "__TEXT"; constexpr std::string_view segment_name = "__TEXT";
constexpr std::string_view section_name = "__text"; constexpr std::string_view section_name = "__text";
#pragma pack(push, 1) #pragma pack(push, 1)
struct MachHeader64 struct MachHeader64
{ {
@@ -107,249 +108,174 @@ namespace
}; };
#pragma pack(pop) #pragma pack(pop)
// Helper function to create a minimal 64-bit Mach-O file with a __text section // Build a minimal 64-bit Mach-O binary in-memory with a __text section
bool write_minimal_macho64_file(const std::string& path, const std::vector<std::uint8_t>& section_bytes) std::vector<std::uint8_t> build_minimal_macho64(const std::vector<std::uint8_t>& section_bytes)
{ {
std::ofstream f(path, std::ios::binary); constexpr std::size_t load_cmd_size = sizeof(SegmentCommand64) + sizeof(Section64);
if (!f.is_open()) const std::size_t section_offset = sizeof(MachHeader64) + load_cmd_size;
return false;
// Calculate sizes std::vector<std::uint8_t> buf(section_offset + section_bytes.size(), 0u);
constexpr std::size_t header_size = sizeof(MachHeader64);
constexpr std::size_t segment_size = sizeof(SegmentCommand64);
constexpr std::size_t section_size = sizeof(Section64);
constexpr std::size_t load_cmd_size = segment_size + section_size;
// Section data will start after headers
const std::size_t section_offset = header_size + load_cmd_size;
// Create Mach-O header auto* header = reinterpret_cast<MachHeader64*>(buf.data());
MachHeader64 header{}; header->magic = mh_magic_64;
header.magic = mh_magic_64; header->cputype = 0x01000007; // CPU_TYPE_X86_64
header.cputype = 0x01000007; // CPU_TYPE_X86_64 header->cpusubtype = 0x3;
header.cpusubtype = 0x3; // CPU_SUBTYPE_X86_64_ALL header->filetype = 0x2; // MH_EXECUTE
header.filetype = 0x2; // MH_EXECUTE header->ncmds = 1;
header.ncmds = 1; header->sizeofcmds = static_cast<std::uint32_t>(load_cmd_size);
header.sizeofcmds = static_cast<std::uint32_t>(load_cmd_size);
header.flags = 0;
header.reserved = 0;
f.write(reinterpret_cast<const char*>(&header), sizeof(header)); auto* segment = reinterpret_cast<SegmentCommand64*>(buf.data() + sizeof(MachHeader64));
segment->cmd = lc_segment_64;
segment->cmdsize = static_cast<std::uint32_t>(load_cmd_size);
std::ranges::copy(segment_name, segment->segname);
segment->vmaddr = 0x100000000;
segment->vmsize = section_bytes.size();
segment->fileoff = section_offset;
segment->filesize = section_bytes.size();
segment->maxprot = 7;
segment->initprot = 5;
segment->nsects = 1;
// Create segment command auto* section = reinterpret_cast<Section64*>(buf.data() + sizeof(MachHeader64) + sizeof(SegmentCommand64));
SegmentCommand64 segment{}; std::ranges::copy(section_name, section->sectname);
segment.cmd = lc_segment_64; std::ranges::copy(segment_name, section->segname);
segment.cmdsize = static_cast<std::uint32_t>(load_cmd_size); section->addr = 0x100000000;
std::ranges::copy(segment_name, segment.segname); section->size = section_bytes.size();
segment.vmaddr = 0x100000000; section->offset = static_cast<std::uint32_t>(section_offset);
segment.vmsize = section_bytes.size();
segment.fileoff = section_offset;
segment.filesize = section_bytes.size();
segment.maxprot = 7; // VM_PROT_ALL
segment.initprot = 5; // VM_PROT_READ | VM_PROT_EXECUTE
segment.nsects = 1;
segment.flags = 0;
f.write(reinterpret_cast<const char*>(&segment), sizeof(segment)); std::memcpy(buf.data() + section_offset, section_bytes.data(), section_bytes.size());
return buf;
// Create section
Section64 section{};
std::ranges::copy(section_name, section.sectname);
std::ranges::copy(segment_name, segment.segname);
section.addr = 0x100000000;
section.size = section_bytes.size();
section.offset = static_cast<std::uint32_t>(section_offset);
section.align = 0;
section.reloff = 0;
section.nreloc = 0;
section.flags = 0;
section.reserved1 = 0;
section.reserved2 = 0;
section.reserved3 = 0;
f.write(reinterpret_cast<const char*>(&section), sizeof(section));
// Write section data
f.write(reinterpret_cast<const char*>(section_bytes.data()), static_cast<std::streamsize>(section_bytes.size()));
f.close();
return true;
} }
// Helper function to create a minimal 32-bit Mach-O file with a __text section // Build a minimal 32-bit Mach-O binary in-memory with a __text section
bool write_minimal_macho32_file(const std::string& path, const std::vector<std::uint8_t>& section_bytes) std::vector<std::uint8_t> build_minimal_macho32(const std::vector<std::uint8_t>& section_bytes)
{ {
std::ofstream f(path, std::ios::binary); constexpr std::size_t load_cmd_size = sizeof(SegmentCommand32) + sizeof(Section32);
if (!f.is_open()) constexpr std::size_t section_offset = sizeof(MachHeader32) + load_cmd_size;
return false;
// Calculate sizes std::vector<std::uint8_t> buf(section_offset + section_bytes.size(), 0u);
constexpr std::size_t header_size = sizeof(MachHeader32);
constexpr std::size_t segment_size = sizeof(SegmentCommand32);
constexpr std::size_t section_size = sizeof(Section32);
constexpr std::size_t load_cmd_size = segment_size + section_size;
// Section data will start after headers auto* header = reinterpret_cast<MachHeader32*>(buf.data());
constexpr std::size_t section_offset = header_size + load_cmd_size; header->magic = mh_magic_32;
header->cputype = 0x7;
header->cpusubtype = 0x3;
header->filetype = 0x2;
header->ncmds = 1;
header->sizeofcmds = static_cast<std::uint32_t>(load_cmd_size);
// Create Mach-O header auto* segment = reinterpret_cast<SegmentCommand32*>(buf.data() + sizeof(MachHeader32));
MachHeader32 header{}; segment->cmd = lc_segment;
header.magic = mh_magic_32; segment->cmdsize = static_cast<std::uint32_t>(load_cmd_size);
header.cputype = 0x7; // CPU_TYPE_X86 std::ranges::copy(segment_name, segment->segname);
header.cpusubtype = 0x3; // CPU_SUBTYPE_X86_ALL segment->vmaddr = 0x1000;
header.filetype = 0x2; // MH_EXECUTE segment->vmsize = static_cast<std::uint32_t>(section_bytes.size());
header.ncmds = 1; segment->fileoff = static_cast<std::uint32_t>(section_offset);
header.sizeofcmds = static_cast<std::uint32_t>(load_cmd_size); segment->filesize = static_cast<std::uint32_t>(section_bytes.size());
header.flags = 0; segment->maxprot = 7;
segment->initprot = 5;
segment->nsects = 1;
f.write(reinterpret_cast<const char*>(&header), sizeof(header)); auto* section = reinterpret_cast<Section32*>(buf.data() + sizeof(MachHeader32) + sizeof(SegmentCommand32));
std::ranges::copy(section_name, section->sectname);
std::ranges::copy(segment_name, section->segname);
section->addr = 0x1000;
section->size = static_cast<std::uint32_t>(section_bytes.size());
section->offset = static_cast<std::uint32_t>(section_offset);
// Create segment command std::memcpy(buf.data() + section_offset, section_bytes.data(), section_bytes.size());
SegmentCommand32 segment{}; return buf;
segment.cmd = lc_segment;
segment.cmdsize = static_cast<std::uint32_t>(load_cmd_size);
std::ranges::copy(segment_name, segment.segname);
segment.vmaddr = 0x1000;
segment.vmsize = static_cast<std::uint32_t>(section_bytes.size());
segment.fileoff = static_cast<std::uint32_t>(section_offset);
segment.filesize = static_cast<std::uint32_t>(section_bytes.size());
segment.maxprot = 7; // VM_PROT_ALL
segment.initprot = 5; // VM_PROT_READ | VM_PROT_EXECUTE
segment.nsects = 1;
segment.flags = 0;
f.write(reinterpret_cast<const char*>(&segment), sizeof(segment));
// Create section
Section32 section{};
std::ranges::copy(section_name, section.sectname);
std::ranges::copy(segment_name, segment.segname);
section.addr = 0x1000;
section.size = static_cast<std::uint32_t>(section_bytes.size());
section.offset = static_cast<std::uint32_t>(section_offset);
section.align = 0;
section.reloff = 0;
section.nreloc = 0;
section.flags = 0;
section.reserved1 = 0;
section.reserved2 = 0;
f.write(reinterpret_cast<const char*>(&section), sizeof(section));
// Write section data
f.write(reinterpret_cast<const char*>(section_bytes.data()), static_cast<std::streamsize>(section_bytes.size()));
f.close();
return true;
} }
} // namespace } // namespace
// Test scanning for a pattern that exists in a 64-bit Mach-O file
TEST(unit_test_macho_pattern_scan_file, ScanFindsPattern64) TEST(unit_test_macho_pattern_scan_file, ScanFindsPattern64)
{ {
constexpr std::string_view path = "./test_minimal_macho64.bin"; const std::vector<std::uint8_t> bytes = {0x55, 0x48, 0x89, 0xE5, 0x90, 0x90};
const std::vector<std::uint8_t> bytes = {0x55, 0x48, 0x89, 0xE5, 0x90, 0x90}; // push rbp; mov rbp, rsp; nop; nop const auto f = MemFdFile::create(build_minimal_macho64(bytes));
ASSERT_TRUE(write_minimal_macho64_file(path.data(), bytes)); ASSERT_TRUE(f.valid());
const auto res = MachOPatternScanner::scan_for_pattern_in_file(path, "55 48 89 E5", "__text"); const auto res = MachOPatternScanner::scan_for_pattern_in_file(f.path(), "55 48 89 E5", "__text");
EXPECT_TRUE(res.has_value()); EXPECT_TRUE(res.has_value());
if (res.has_value()) if (res.has_value())
{
EXPECT_EQ(res->target_offset, 0); EXPECT_EQ(res->target_offset, 0);
}
} }
// Test scanning for a pattern that exists in a 32-bit Mach-O file
TEST(unit_test_macho_pattern_scan_file, ScanFindsPattern32) TEST(unit_test_macho_pattern_scan_file, ScanFindsPattern32)
{ {
constexpr std::string_view path = "./test_minimal_macho32.bin"; const std::vector<std::uint8_t> bytes = {0x55, 0x89, 0xE5, 0x90, 0x90};
const std::vector<std::uint8_t> bytes = {0x55, 0x89, 0xE5, 0x90, 0x90}; // push ebp; mov ebp, esp; nop; nop const auto f = MemFdFile::create(build_minimal_macho32(bytes));
ASSERT_TRUE(write_minimal_macho32_file(path.data(), bytes)); ASSERT_TRUE(f.valid());
const auto res = MachOPatternScanner::scan_for_pattern_in_file(path, "55 89 E5", "__text"); const auto res = MachOPatternScanner::scan_for_pattern_in_file(f.path(), "55 89 E5", "__text");
EXPECT_TRUE(res.has_value()); EXPECT_TRUE(res.has_value());
if (res.has_value()) if (res.has_value())
{
EXPECT_EQ(res->target_offset, 0); EXPECT_EQ(res->target_offset, 0);
}
} }
// Test scanning for a pattern that does not exist
TEST(unit_test_macho_pattern_scan_file, ScanMissingPattern) TEST(unit_test_macho_pattern_scan_file, ScanMissingPattern)
{ {
constexpr std::string_view path = "./test_minimal_macho_missing.bin";
const std::vector<std::uint8_t> bytes = {0x00, 0x01, 0x02, 0x03}; const std::vector<std::uint8_t> bytes = {0x00, 0x01, 0x02, 0x03};
ASSERT_TRUE(write_minimal_macho64_file(path.data(), bytes)); const auto f = MemFdFile::create(build_minimal_macho64(bytes));
ASSERT_TRUE(f.valid());
const auto res = MachOPatternScanner::scan_for_pattern_in_file(path, "FF EE DD", "__text"); const auto res = MachOPatternScanner::scan_for_pattern_in_file(f.path(), "FF EE DD", "__text");
EXPECT_FALSE(res.has_value()); EXPECT_FALSE(res.has_value());
} }
// Test scanning for a pattern at a non-zero offset
TEST(unit_test_macho_pattern_scan_file, ScanPatternAtOffset) TEST(unit_test_macho_pattern_scan_file, ScanPatternAtOffset)
{ {
constexpr std::string_view path = "./test_minimal_macho_offset.bin"; const std::vector<std::uint8_t> bytes = {0x90, 0x90, 0x90, 0x55, 0x48, 0x89, 0xE5};
const std::vector<std::uint8_t> bytes = {0x90, 0x90, 0x90, 0x55, 0x48, 0x89, 0xE5}; // nops then pattern const auto f = MemFdFile::create(build_minimal_macho64(bytes));
ASSERT_TRUE(write_minimal_macho64_file(path.data(), bytes)); ASSERT_TRUE(f.valid());
const auto res = MachOPatternScanner::scan_for_pattern_in_file(path, "55 48 89 E5", "__text"); const auto res = MachOPatternScanner::scan_for_pattern_in_file(f.path(), "55 48 89 E5", "__text");
EXPECT_TRUE(res.has_value()); EXPECT_TRUE(res.has_value());
if (res.has_value()) if (res.has_value())
{
EXPECT_EQ(res->target_offset, 3); EXPECT_EQ(res->target_offset, 3);
}
} }
// Test scanning with wildcards
TEST(unit_test_macho_pattern_scan_file, ScanWithWildcard) TEST(unit_test_macho_pattern_scan_file, ScanWithWildcard)
{ {
constexpr std::string_view path = "./test_minimal_macho_wildcard.bin";
const std::vector<std::uint8_t> bytes = {0x55, 0x48, 0x89, 0xE5, 0x90}; const std::vector<std::uint8_t> bytes = {0x55, 0x48, 0x89, 0xE5, 0x90};
ASSERT_TRUE(write_minimal_macho64_file(path.data(), bytes)); const auto f = MemFdFile::create(build_minimal_macho64(bytes));
ASSERT_TRUE(f.valid());
const auto res = MachOPatternScanner::scan_for_pattern_in_file(path, "55 ? 89 E5", "__text"); const auto res = MachOPatternScanner::scan_for_pattern_in_file(f.path(), "55 ? 89 E5", "__text");
EXPECT_TRUE(res.has_value()); EXPECT_TRUE(res.has_value());
} }
// Test scanning a non-existent file
TEST(unit_test_macho_pattern_scan_file, ScanNonExistentFile) TEST(unit_test_macho_pattern_scan_file, ScanNonExistentFile)
{ {
const auto res = MachOPatternScanner::scan_for_pattern_in_file("/non/existent/file.bin", "55 48", "__text"); const auto res = MachOPatternScanner::scan_for_pattern_in_file("/non/existent/file.bin", "55 48", "__text");
EXPECT_FALSE(res.has_value()); EXPECT_FALSE(res.has_value());
} }
// Test scanning an invalid (non-Mach-O) file
TEST(unit_test_macho_pattern_scan_file, ScanInvalidFile) TEST(unit_test_macho_pattern_scan_file, ScanInvalidFile)
{ {
constexpr std::string_view path = "./test_invalid_macho.bin";
std::ofstream f(path.data(), std::ios::binary);
const std::vector<std::uint8_t> garbage = {0x00, 0x01, 0x02, 0x03, 0x04, 0x05}; const std::vector<std::uint8_t> garbage = {0x00, 0x01, 0x02, 0x03, 0x04, 0x05};
f.write(reinterpret_cast<const char*>(garbage.data()), static_cast<std::streamsize>(garbage.size())); const auto f = MemFdFile::create(garbage);
f.close(); ASSERT_TRUE(f.valid());
const auto res = MachOPatternScanner::scan_for_pattern_in_file(path, "55 48", "__text"); const auto res = MachOPatternScanner::scan_for_pattern_in_file(f.path(), "55 48", "__text");
EXPECT_FALSE(res.has_value()); EXPECT_FALSE(res.has_value());
} }
// Test scanning for a non-existent section
TEST(unit_test_macho_pattern_scan_file, ScanNonExistentSection) TEST(unit_test_macho_pattern_scan_file, ScanNonExistentSection)
{ {
constexpr std::string_view path = "./test_minimal_macho_nosect.bin";
const std::vector<std::uint8_t> bytes = {0x55, 0x48, 0x89, 0xE5}; const std::vector<std::uint8_t> bytes = {0x55, 0x48, 0x89, 0xE5};
ASSERT_TRUE(write_minimal_macho64_file(path.data(), bytes)); const auto f = MemFdFile::create(build_minimal_macho64(bytes));
ASSERT_TRUE(f.valid());
const auto res = MachOPatternScanner::scan_for_pattern_in_file(path, "55 48", "__nonexistent"); const auto res = MachOPatternScanner::scan_for_pattern_in_file(f.path(), "55 48", "__nonexistent");
EXPECT_FALSE(res.has_value()); EXPECT_FALSE(res.has_value());
} }
// Test scanning with null module base address
TEST(unit_test_macho_pattern_scan_loaded, ScanNullModule) TEST(unit_test_macho_pattern_scan_loaded, ScanNullModule)
{ {
const auto res = MachOPatternScanner::scan_for_pattern_in_loaded_module(nullptr, "55 48", "__text"); const auto res = MachOPatternScanner::scan_for_pattern_in_loaded_module(nullptr, "55 48", "__text");
EXPECT_FALSE(res.has_value()); EXPECT_FALSE(res.has_value());
} }
// Test scanning in loaded module with invalid magic
TEST(unit_test_macho_pattern_scan_loaded, ScanInvalidMagic) TEST(unit_test_macho_pattern_scan_loaded, ScanInvalidMagic)
{ {
std::vector<std::uint8_t> invalid_data(256, 0x00); std::vector<std::uint8_t> invalid_data(256, 0x00);

View File

@@ -1,114 +1,28 @@
// Unit test for PePatternScanner::scan_for_pattern_in_file using a synthetic PE-like file // Unit test for PePatternScanner::scan_for_pattern_in_file using a synthetic PE-like file
#include <gtest/gtest.h> #include <gtest/gtest.h>
#include <omath/utility/pe_pattern_scan.hpp> #include <omath/utility/pe_pattern_scan.hpp>
#include <fstream>
#include <vector>
#include <cstdint> #include <cstdint>
#include <cstring> #include <vector>
#include "mem_fd_helper.hpp"
using namespace omath; using namespace omath;
// Helper: write a trivial PE-like file with DOS header and a single section named .text
static bool write_minimal_pe_file(const std::string& path, const std::vector<std::uint8_t>& section_bytes)
{
std::ofstream f(path, std::ios::binary);
if (!f.is_open()) return false;
// Write DOS header (e_magic = 0x5A4D, e_lfanew at offset 0x3C)
std::vector<std::uint8_t> dos(64, 0);
dos[0] = 'M'; dos[1] = 'Z';
// e_lfanew -> place NT headers right after DOS (offset 0x80)
std::uint32_t e_lfanew = 0x80;
std::memcpy(dos.data() + 0x3C, &e_lfanew, sizeof(e_lfanew));
f.write(reinterpret_cast<const char*>(dos.data()), dos.size());
// Pad up to e_lfanew
if (f.tellp() < static_cast<std::streampos>(e_lfanew))
{
std::vector<char> pad(e_lfanew - static_cast<std::uint32_t>(f.tellp()), 0);
f.write(pad.data(), pad.size());
}
// NT headers signature 'PE\0\0'
f.put('P'); f.put('E'); f.put('\0'); f.put('\0');
// FileHeader: machine, num_sections
std::uint16_t machine = 0x8664; // x64
std::uint16_t num_sections = 1;
std::uint32_t dummy32 = 0;
std::uint32_t dummy32b = 0;
std::uint16_t size_optional = 0xF0; // reasonable
std::uint16_t characteristics = 0;
f.write(reinterpret_cast<const char*>(&machine), sizeof(machine));
f.write(reinterpret_cast<const char*>(&num_sections), sizeof(num_sections));
f.write(reinterpret_cast<const char*>(&dummy32), sizeof(dummy32));
f.write(reinterpret_cast<const char*>(&dummy32b), sizeof(dummy32b));
std::uint32_t num_symbols = 0;
f.write(reinterpret_cast<const char*>(&num_symbols), sizeof(num_symbols));
f.write(reinterpret_cast<const char*>(&size_optional), sizeof(size_optional));
f.write(reinterpret_cast<const char*>(&characteristics), sizeof(characteristics));
// OptionalHeader (x64) minimal: magic 0x20b, image_base, size_of_code, size_of_headers
std::uint16_t magic = 0x20b;
f.write(reinterpret_cast<const char*>(&magic), sizeof(magic));
// filler for rest of optional header up to size_optional
std::vector<std::uint8_t> opt(size_optional - sizeof(magic), 0);
// set size_code near end
// we'll set image_base and size_code fields in reasonable positions for extractor
// For simplicity, leave zeros; extractor primarily uses optional_header.image_base and size_code later,
// but we will craft a SectionHeader that points to raw data we append below.
f.write(reinterpret_cast<const char*>(opt.data()), opt.size());
// Section header (name 8 bytes, then remaining 36 bytes)
char name[8] = {'.','t','e','x','t',0,0,0};
f.write(name, 8);
// Write placeholder bytes for the rest of the section header and remember its start
constexpr std::uint32_t section_header_rest = 36u;
const std::streampos header_rest_pos = f.tellp();
std::vector<char> placeholder(section_header_rest, 0);
f.write(placeholder.data(), placeholder.size());
// Now write section raw data and remember its file offset
const std::streampos data_pos = f.tellp();
f.write(reinterpret_cast<const char*>(section_bytes.data()), static_cast<std::streamsize>(section_bytes.size()));
// Patch section header fields: virtual_size, virtual_address, size_raw_data, ptr_raw_data
const std::uint32_t virtual_size = static_cast<std::uint32_t>(section_bytes.size());
constexpr std::uint32_t virtual_address = 0x1000u;
const std::uint32_t size_raw_data = static_cast<std::uint32_t>(section_bytes.size());
const std::uint32_t ptr_raw_data = static_cast<std::uint32_t>(data_pos);
// Seek back to the header_rest_pos and write fields in order
f.seekp(header_rest_pos, std::ios::beg);
f.write(reinterpret_cast<const char*>(&virtual_size), sizeof(virtual_size));
f.write(reinterpret_cast<const char*>(&virtual_address), sizeof(virtual_address));
f.write(reinterpret_cast<const char*>(&size_raw_data), sizeof(size_raw_data));
f.write(reinterpret_cast<const char*>(&ptr_raw_data), sizeof(ptr_raw_data));
// Seek back to end for consistency
f.seekp(0, std::ios::end);
f.close();
return true;
}
TEST(unit_test_pe_pattern_scan_file, ScanFindsPattern) TEST(unit_test_pe_pattern_scan_file, ScanFindsPattern)
{ {
constexpr std::string_view path = "./test_minimal_pe.bin"; const std::vector<std::uint8_t> bytes = {0x55, 0x8B, 0xEC, 0x90, 0x90};
const std::vector<std::uint8_t> bytes = {0x55, 0x8B, 0xEC, 0x90, 0x90}; // pattern at offset 0 const auto f = MemFdFile::create(build_minimal_pe(bytes));
ASSERT_TRUE(write_minimal_pe_file(path.data(), bytes)); ASSERT_TRUE(f.valid());
const auto res = PePatternScanner::scan_for_pattern_in_file(path, "55 8B EC", ".text"); const auto res = PePatternScanner::scan_for_pattern_in_file(f.path(), "55 8B EC", ".text");
EXPECT_TRUE(res.has_value()); EXPECT_TRUE(res.has_value());
} }
TEST(unit_test_pe_pattern_scan_file, ScanMissingPattern) TEST(unit_test_pe_pattern_scan_file, ScanMissingPattern)
{ {
constexpr std::string_view path = "./test_minimal_pe_2.bin";
const std::vector<std::uint8_t> bytes = {0x00, 0x01, 0x02, 0x03}; const std::vector<std::uint8_t> bytes = {0x00, 0x01, 0x02, 0x03};
ASSERT_TRUE(write_minimal_pe_file(path.data(), bytes)); const auto f = MemFdFile::create(build_minimal_pe(bytes));
ASSERT_TRUE(f.valid());
const auto res = PePatternScanner::scan_for_pattern_in_file(path, "FF EE DD", ".text"); const auto res = PePatternScanner::scan_for_pattern_in_file(f.path(), "FF EE DD", ".text");
EXPECT_FALSE(res.has_value()); EXPECT_FALSE(res.has_value());
} }

View File

@@ -1,120 +1,89 @@
// Additional tests for PePatternScanner to exercise edge cases and loaded-module scanning // Additional tests for PePatternScanner to exercise edge cases and loaded-module scanning
#include <cstdint> #include <cstdint>
#include <cstring> #include <cstring>
#include <fstream>
#include <gtest/gtest.h> #include <gtest/gtest.h>
#include <omath/utility/pe_pattern_scan.hpp> #include <omath/utility/pe_pattern_scan.hpp>
#include <vector> #include <vector>
#include "mem_fd_helper.hpp"
using namespace omath; using namespace omath;
static bool write_bytes(const std::string& path, const std::vector<std::uint8_t>& data)
{
std::ofstream f(path, std::ios::binary);
if (!f.is_open())
return false;
f.write(reinterpret_cast<const char*>(data.data()), data.size());
return true;
}
TEST(unit_test_pe_pattern_scan_more, InvalidDosHeader) TEST(unit_test_pe_pattern_scan_more, InvalidDosHeader)
{ {
constexpr std::string_view path = "./test_bad_dos.bin";
std::vector<std::uint8_t> data(128, 0); std::vector<std::uint8_t> data(128, 0);
// write wrong magic
data[0] = 'N'; data[0] = 'N';
data[1] = 'Z'; data[1] = 'Z';
ASSERT_TRUE(write_bytes(path.data(), data)); const auto f = MemFdFile::create(data);
ASSERT_TRUE(f.valid());
const auto res = PePatternScanner::scan_for_pattern_in_file(path, "55 8B EC", ".text"); const auto res = PePatternScanner::scan_for_pattern_in_file(f.path(), "55 8B EC", ".text");
EXPECT_FALSE(res.has_value()); EXPECT_FALSE(res.has_value());
} }
TEST(unit_test_pe_pattern_scan_more, InvalidNtSignature) TEST(unit_test_pe_pattern_scan_more, InvalidNtSignature)
{ {
constexpr std::string_view path = "./test_bad_nt.bin";
std::vector<std::uint8_t> data(256, 0); std::vector<std::uint8_t> data(256, 0);
// valid DOS header
data[0] = 'M'; data[0] = 'M';
data[1] = 'Z'; data[1] = 'Z';
// point e_lfanew to 0x80
constexpr std::uint32_t e_lfanew = 0x80; constexpr std::uint32_t e_lfanew = 0x80;
std::memcpy(data.data() + 0x3C, &e_lfanew, sizeof(e_lfanew)); std::memcpy(data.data() + 0x3C, &e_lfanew, sizeof(e_lfanew));
// write garbage at e_lfanew (not 'PE\0\0')
data[e_lfanew + 0] = 'X'; data[e_lfanew + 0] = 'X';
data[e_lfanew + 1] = 'Y'; data[e_lfanew + 1] = 'Y';
data[e_lfanew + 2] = 'Z'; data[e_lfanew + 2] = 'Z';
data[e_lfanew + 3] = 'W'; data[e_lfanew + 3] = 'W';
ASSERT_TRUE(write_bytes(path.data(), data)); const auto f = MemFdFile::create(data);
ASSERT_TRUE(f.valid());
const auto res = PePatternScanner::scan_for_pattern_in_file(path, "55 8B EC", ".text"); const auto res = PePatternScanner::scan_for_pattern_in_file(f.path(), "55 8B EC", ".text");
EXPECT_FALSE(res.has_value()); EXPECT_FALSE(res.has_value());
} }
TEST(unit_test_pe_pattern_scan_more, SectionNotFound) TEST(unit_test_pe_pattern_scan_more, SectionNotFound)
{ {
// reuse minimal writer but with section named .data and search .text // Minimal PE with a .data section; scanning for .text should fail
constexpr std::string_view path = "./test_section_not_found.bin"; constexpr std::uint32_t e_lfanew = 0x80u;
std::ofstream f(path.data(), std::ios::binary); constexpr std::uint16_t size_opt = 0xF0u;
ASSERT_TRUE(f.is_open()); constexpr std::size_t nt_off = e_lfanew;
// DOS constexpr std::size_t fh_off = nt_off + 4;
std::vector<std::uint8_t> dos(64, 0); constexpr std::size_t oh_off = fh_off + 20;
dos[0] = 'M'; constexpr std::size_t sh_off = oh_off + size_opt;
dos[1] = 'Z'; constexpr std::size_t data_off = sh_off + 44;
std::uint32_t e_lfanew = 0x80;
std::memcpy(dos.data() + 0x3C, &e_lfanew, sizeof(e_lfanew));
f.write(reinterpret_cast<char*>(dos.data()), dos.size());
// pad
std::vector<char> pad(e_lfanew - static_cast<std::uint32_t>(f.tellp()), 0);
f.write(pad.data(), pad.size());
// NT sig
f.put('P');
f.put('E');
f.put('\0');
f.put('\0');
// FileHeader minimal
std::uint16_t machine = 0x8664;
std::uint16_t num_sections = 1;
std::uint32_t z = 0;
std::uint32_t z2 = 0;
std::uint32_t numsym = 0;
std::uint16_t size_opt = 0xF0;
std::uint16_t ch = 0;
f.write(reinterpret_cast<char*>(&machine), sizeof(machine));
f.write(reinterpret_cast<char*>(&num_sections), sizeof(num_sections));
f.write(reinterpret_cast<char*>(&z), sizeof(z));
f.write(reinterpret_cast<char*>(&z2), sizeof(z2));
f.write(reinterpret_cast<char*>(&numsym), sizeof(numsym));
f.write(reinterpret_cast<char*>(&size_opt), sizeof(size_opt));
f.write(reinterpret_cast<char*>(&ch), sizeof(ch));
// Optional header magic
std::uint16_t magic = 0x20b;
f.write(reinterpret_cast<char*>(&magic), sizeof(magic));
std::vector<std::uint8_t> opt(size_opt - sizeof(magic), 0);
f.write(reinterpret_cast<char*>(opt.data()), opt.size());
// Section header named .data
char name[8] = {'.', 'd', 'a', 't', 'a', 0, 0, 0};
f.write(name, 8);
std::uint32_t vs = 4, va = 0x1000, srd = 4, prd = 0x200;
f.write(reinterpret_cast<char*>(&vs), 4);
f.write(reinterpret_cast<char*>(&va), 4);
f.write(reinterpret_cast<char*>(&srd), 4);
f.write(reinterpret_cast<char*>(&prd), 4);
std::vector<char> rest(16, 0);
f.write(rest.data(), rest.size());
// section bytes
std::vector<std::uint8_t> sec = {0x00, 0x01, 0x02, 0x03};
f.write(reinterpret_cast<char*>(sec.data()), sec.size());
f.close();
auto res = PePatternScanner::scan_for_pattern_in_file(path, "00 01", ".text"); const std::vector<std::uint8_t> sec_data = {0x00, 0x01, 0x02, 0x03};
std::vector<std::uint8_t> buf(data_off + sec_data.size(), 0u);
buf[0] = 'M'; buf[1] = 'Z';
std::memcpy(buf.data() + 0x3C, &e_lfanew, 4);
buf[nt_off] = 'P'; buf[nt_off + 1] = 'E';
const std::uint16_t machine = 0x8664u, num_sections = 1u;
std::memcpy(buf.data() + fh_off, &machine, 2);
std::memcpy(buf.data() + fh_off + 2, &num_sections, 2);
std::memcpy(buf.data() + fh_off + 16, &size_opt, 2);
const std::uint16_t magic = 0x20Bu;
std::memcpy(buf.data() + oh_off, &magic, 2);
const char name[8] = {'.','d','a','t','a',0,0,0};
std::memcpy(buf.data() + sh_off, name, 8);
const std::uint32_t vs = 4u, va = 0x1000u, srd = 4u, prd = static_cast<std::uint32_t>(data_off);
std::memcpy(buf.data() + sh_off + 8, &vs, 4);
std::memcpy(buf.data() + sh_off + 12, &va, 4);
std::memcpy(buf.data() + sh_off + 16, &srd, 4);
std::memcpy(buf.data() + sh_off + 20, &prd, 4);
std::memcpy(buf.data() + data_off, sec_data.data(), sec_data.size());
const auto f = MemFdFile::create(buf);
ASSERT_TRUE(f.valid());
const auto res = PePatternScanner::scan_for_pattern_in_file(f.path(), "00 01", ".text");
EXPECT_FALSE(res.has_value()); EXPECT_FALSE(res.has_value());
} }
TEST(unit_test_pe_pattern_scan_more, LoadedModuleScanFinds) TEST(unit_test_pe_pattern_scan_more, LoadedModuleScanFinds)
{ {
// Create an in-memory buffer that mimics loaded module layout // Create an in-memory buffer that mimics loaded module layout
// Define local header structs matching those in source
struct DosHeader struct DosHeader
{ {
std::uint16_t e_magic; std::uint16_t e_magic;
@@ -158,9 +127,9 @@ TEST(unit_test_pe_pattern_scan_more, LoadedModuleScanFinds)
std::uint32_t base_of_code; std::uint32_t base_of_code;
std::uint64_t image_base; std::uint64_t image_base;
std::uint32_t section_alignment; std::uint32_t section_alignment;
std::uint32_t file_alignment; /* rest omitted */ std::uint32_t file_alignment;
std::uint32_t size_image; std::uint32_t size_image;
std::uint32_t size_headers; /* keep space */ std::uint32_t size_headers;
std::uint8_t pad[200]; std::uint8_t pad[200];
}; };
struct SectionHeader struct SectionHeader
@@ -188,44 +157,38 @@ TEST(unit_test_pe_pattern_scan_more, LoadedModuleScanFinds)
}; };
const std::vector<std::uint8_t> pattern_bytes = {0xDE, 0xAD, 0xBE, 0xEF, 0x90}; const std::vector<std::uint8_t> pattern_bytes = {0xDE, 0xAD, 0xBE, 0xEF, 0x90};
constexpr std::uint32_t base_of_code = 0x200; // will place bytes at offset 0x200 constexpr std::uint32_t base_of_code = 0x200;
const std::uint32_t size_code = static_cast<std::uint32_t>(pattern_bytes.size()); const std::uint32_t size_code = static_cast<std::uint32_t>(pattern_bytes.size());
const std::uint32_t bufsize = 0x400 + size_code; const std::uint32_t bufsize = 0x400 + size_code;
std::vector<std::uint8_t> buf(bufsize, 0); std::vector<std::uint8_t> buf(bufsize, 0);
// DOS header
const auto dos = reinterpret_cast<DosHeader*>(buf.data()); const auto dos = reinterpret_cast<DosHeader*>(buf.data());
dos->e_magic = 0x5A4D; dos->e_magic = 0x5A4D;
dos->e_lfanew = 0x80; dos->e_lfanew = 0x80;
// NT headers
const auto nt = reinterpret_cast<ImageNtHeadersX64*>(buf.data() + dos->e_lfanew); const auto nt = reinterpret_cast<ImageNtHeadersX64*>(buf.data() + dos->e_lfanew);
nt->signature = 0x4550; // 'PE\0\0' nt->signature = 0x4550;
nt->file_header.machine = 0x8664; nt->file_header.machine = 0x8664;
nt->file_header.num_sections = 1; nt->file_header.num_sections = 1;
nt->file_header.size_optional_header = static_cast<std::uint16_t>(sizeof(OptionalHeaderX64)); nt->file_header.size_optional_header = static_cast<std::uint16_t>(sizeof(OptionalHeaderX64));
nt->optional_header.magic = 0x020B;
nt->optional_header.base_of_code = base_of_code;
nt->optional_header.size_code = size_code;
nt->optional_header.magic = 0x020B; // x64
nt->optional_header.base_of_code = base_of_code;
nt->optional_header.size_code = size_code;
// Compute section table offset: e_lfanew + 4 (sig) + FileHeader + OptionalHeader
const std::size_t section_table_off = const std::size_t section_table_off =
static_cast<std::size_t>(dos->e_lfanew) + 4 + sizeof(FileHeader) + sizeof(OptionalHeaderX64); static_cast<std::size_t>(dos->e_lfanew) + 4 + sizeof(FileHeader) + sizeof(OptionalHeaderX64);
nt->optional_header.size_headers = static_cast<std::uint32_t>(section_table_off + sizeof(SectionHeader)); nt->optional_header.size_headers = static_cast<std::uint32_t>(section_table_off + sizeof(SectionHeader));
// Section header (.text)
const auto sect = reinterpret_cast<SectionHeader*>(buf.data() + section_table_off); const auto sect = reinterpret_cast<SectionHeader*>(buf.data() + section_table_off);
std::memset(sect, 0, sizeof(SectionHeader)); std::memset(sect, 0, sizeof(SectionHeader));
std::memcpy(sect->name, ".text", 5); std::memcpy(sect->name, ".text", 5);
sect->virtual_size = size_code; sect->virtual_size = size_code;
sect->virtual_address = base_of_code; sect->virtual_address = base_of_code;
sect->size_raw_data = size_code; sect->size_raw_data = size_code;
sect->ptr_raw_data = base_of_code; sect->ptr_raw_data = base_of_code;
sect->characteristics = 0x60000020; // code | execute | read sect->characteristics = 0x60000020;
// place code at base_of_code
std::memcpy(buf.data() + base_of_code, pattern_bytes.data(), pattern_bytes.size()); std::memcpy(buf.data() + base_of_code, pattern_bytes.data(), pattern_bytes.size());
const auto res = PePatternScanner::scan_for_pattern_in_loaded_module(buf.data(), "DE AD BE EF", ".text"); const auto res = PePatternScanner::scan_for_pattern_in_loaded_module(buf.data(), "DE AD BE EF", ".text");

View File

@@ -4,6 +4,7 @@
#include <gtest/gtest.h> #include <gtest/gtest.h>
#include <omath/utility/pe_pattern_scan.hpp> #include <omath/utility/pe_pattern_scan.hpp>
#include <vector> #include <vector>
#include "mem_fd_helper.hpp"
using namespace omath; using namespace omath;
@@ -19,95 +20,6 @@ struct TestFileHeader
std::uint16_t characteristics; std::uint16_t characteristics;
}; };
static bool write_bytes(const std::string& path, const std::vector<std::uint8_t>& data)
{
std::ofstream f(path, std::ios::binary);
if (!f.is_open())
return false;
f.write(reinterpret_cast<const char*>(data.data()), data.size());
return true;
}
// Helper: write a trivial PE-like file with DOS header and a single section named .text
static bool write_minimal_pe_file(const std::string& path, const std::vector<std::uint8_t>& section_bytes)
{
std::ofstream f(path, std::ios::binary);
if (!f.is_open())
return false;
// Write DOS header (e_magic = 0x5A4D, e_lfanew at offset 0x3C)
std::vector<std::uint8_t> dos(64, 0);
dos[0] = 'M';
dos[1] = 'Z';
std::uint32_t e_lfanew = 0x80;
std::memcpy(dos.data() + 0x3C, &e_lfanew, sizeof(e_lfanew));
f.write(reinterpret_cast<const char*>(dos.data()), dos.size());
// Pad up to e_lfanew
if (f.tellp() < static_cast<std::streampos>(e_lfanew))
{
std::vector<char> pad(e_lfanew - static_cast<std::uint32_t>(f.tellp()), 0);
f.write(pad.data(), pad.size());
}
// NT headers signature 'PE\0\0'
f.put('P');
f.put('E');
f.put('\0');
f.put('\0');
// FileHeader minimal
std::uint16_t machine = 0x8664; // x64
std::uint16_t num_sections = 1;
std::uint32_t dummy32 = 0;
std::uint32_t dummy32b = 0;
std::uint16_t size_optional = 0xF0;
std::uint16_t characteristics = 0;
f.write(reinterpret_cast<const char*>(&machine), sizeof(machine));
f.write(reinterpret_cast<const char*>(&num_sections), sizeof(num_sections));
f.write(reinterpret_cast<const char*>(&dummy32), sizeof(dummy32));
f.write(reinterpret_cast<const char*>(&dummy32b), sizeof(dummy32b));
std::uint32_t num_symbols = 0;
f.write(reinterpret_cast<const char*>(&num_symbols), sizeof(num_symbols));
f.write(reinterpret_cast<const char*>(&size_optional), sizeof(size_optional));
f.write(reinterpret_cast<const char*>(&characteristics), sizeof(characteristics));
// OptionalHeader minimal filler
std::uint16_t magic = 0x20b;
f.write(reinterpret_cast<const char*>(&magic), sizeof(magic));
std::vector<std::uint8_t> opt(size_optional - sizeof(magic), 0);
f.write(reinterpret_cast<const char*>(opt.data()), opt.size());
// Section header (name 8 bytes, then remaining 36 bytes)
char name[8] = {'.', 't', 'e', 'x', 't', 0, 0, 0};
f.write(name, 8);
constexpr std::uint32_t section_header_rest = 36u;
const std::streampos header_rest_pos = f.tellp();
std::vector<char> placeholder(section_header_rest, 0);
f.write(placeholder.data(), placeholder.size());
// Now write section raw data and remember its file offset
const std::streampos data_pos = f.tellp();
f.write(reinterpret_cast<const char*>(section_bytes.data()), static_cast<std::streamsize>(section_bytes.size()));
// Patch section header fields
const std::uint32_t virtual_size = static_cast<std::uint32_t>(section_bytes.size());
constexpr std::uint32_t virtual_address = 0x1000u;
const std::uint32_t size_raw_data = static_cast<std::uint32_t>(section_bytes.size());
const std::uint32_t ptr_raw_data = static_cast<std::uint32_t>(data_pos);
f.seekp(header_rest_pos, std::ios::beg);
f.write(reinterpret_cast<const char*>(&virtual_size), sizeof(virtual_size));
f.write(reinterpret_cast<const char*>(&virtual_address), sizeof(virtual_address));
f.write(reinterpret_cast<const char*>(&size_raw_data), sizeof(size_raw_data));
f.write(reinterpret_cast<const char*>(&ptr_raw_data), sizeof(ptr_raw_data));
f.seekp(0, std::ios::end);
f.close();
return true;
}
TEST(unit_test_pe_pattern_scan_more2, LoadedModuleNullBaseReturnsNull) TEST(unit_test_pe_pattern_scan_more2, LoadedModuleNullBaseReturnsNull)
{ {
const auto res = PePatternScanner::scan_for_pattern_in_loaded_module(nullptr, "DE AD"); const auto res = PePatternScanner::scan_for_pattern_in_loaded_module(nullptr, "DE AD");
@@ -116,7 +28,6 @@ TEST(unit_test_pe_pattern_scan_more2, LoadedModuleNullBaseReturnsNull)
TEST(unit_test_pe_pattern_scan_more2, LoadedModuleInvalidOptionalHeaderReturnsNull) TEST(unit_test_pe_pattern_scan_more2, LoadedModuleInvalidOptionalHeaderReturnsNull)
{ {
// Construct in-memory buffer with DOS header but invalid optional header magic
std::vector<std::uint8_t> buf(0x200, 0); std::vector<std::uint8_t> buf(0x200, 0);
struct DosHeader struct DosHeader
{ {
@@ -128,19 +39,11 @@ TEST(unit_test_pe_pattern_scan_more2, LoadedModuleInvalidOptionalHeaderReturnsNu
dos->e_magic = 0x5A4D; dos->e_magic = 0x5A4D;
dos->e_lfanew = 0x80; dos->e_lfanew = 0x80;
// Place an NT header with wrong optional magic at e_lfanew
const auto nt_ptr = buf.data() + dos->e_lfanew; const auto nt_ptr = buf.data() + dos->e_lfanew;
// write signature nt_ptr[0] = 'P'; nt_ptr[1] = 'E'; nt_ptr[2] = 0; nt_ptr[3] = 0;
nt_ptr[0] = 'P';
nt_ptr[1] = 'E';
nt_ptr[2] = 0;
nt_ptr[3] = 0;
// craft FileHeader with size_optional_header large enough
constexpr std::uint16_t size_opt = 0xE0; constexpr std::uint16_t size_opt = 0xE0;
// file header starts at offset 4 std::memcpy(nt_ptr + 4 + 12, &size_opt, sizeof(size_opt));
std::memcpy(nt_ptr + 4 + 12, &size_opt,
sizeof(size_opt)); // size_optional_header located after 12 bytes into FileHeader
// write optional header magic to be invalid value
constexpr std::uint16_t bad_magic = 0x9999; constexpr std::uint16_t bad_magic = 0x9999;
std::memcpy(nt_ptr + 4 + sizeof(std::uint32_t) + sizeof(std::uint16_t) + sizeof(std::uint16_t), &bad_magic, std::memcpy(nt_ptr + 4 + sizeof(std::uint32_t) + sizeof(std::uint16_t) + sizeof(std::uint16_t), &bad_magic,
sizeof(bad_magic)); sizeof(bad_magic));
@@ -151,13 +54,11 @@ TEST(unit_test_pe_pattern_scan_more2, LoadedModuleInvalidOptionalHeaderReturnsNu
TEST(unit_test_pe_pattern_scan_more2, FileX86OptionalHeaderScanFindsPattern) TEST(unit_test_pe_pattern_scan_more2, FileX86OptionalHeaderScanFindsPattern)
{ {
constexpr std::string_view path = "./test_pe_x86.bin";
const std::vector<std::uint8_t> pattern = {0xDE, 0xAD, 0xBE, 0xEF}; const std::vector<std::uint8_t> pattern = {0xDE, 0xAD, 0xBE, 0xEF};
const auto f = MemFdFile::create(build_minimal_pe(pattern));
ASSERT_TRUE(f.valid());
// Use helper from this file to write a consistent minimal PE file with .text section const auto res = PePatternScanner::scan_for_pattern_in_file(f.path(), "DE AD BE EF", ".text");
ASSERT_TRUE(write_minimal_pe_file(path.data(), pattern));
const auto res = PePatternScanner::scan_for_pattern_in_file(path, "DE AD BE EF", ".text");
ASSERT_TRUE(res.has_value()); ASSERT_TRUE(res.has_value());
EXPECT_GE(res->virtual_base_addr, 0u); EXPECT_GE(res->virtual_base_addr, 0u);
EXPECT_GE(res->raw_base_addr, 0u); EXPECT_GE(res->raw_base_addr, 0u);
@@ -166,97 +67,73 @@ TEST(unit_test_pe_pattern_scan_more2, FileX86OptionalHeaderScanFindsPattern)
TEST(unit_test_pe_pattern_scan_more2, FilePatternNotFoundReturnsNull) TEST(unit_test_pe_pattern_scan_more2, FilePatternNotFoundReturnsNull)
{ {
const std::string path = "./test_pe_no_pattern.bin";
std::vector<std::uint8_t> data(512, 0); std::vector<std::uint8_t> data(512, 0);
// minimal DOS/NT headers to make extract_section fail earlier or return empty data data[0] = 'M'; data[1] = 'Z';
data[0] = 'M';
data[1] = 'Z';
constexpr std::uint32_t e_lfanew = 0x80; constexpr std::uint32_t e_lfanew = 0x80;
std::memcpy(data.data() + 0x3C, &e_lfanew, sizeof(e_lfanew)); std::memcpy(data.data() + 0x3C, &e_lfanew, sizeof(e_lfanew));
// NT signature data[e_lfanew + 0] = 'P'; data[e_lfanew + 1] = 'E';
data[e_lfanew + 0] = 'P';
data[e_lfanew + 1] = 'E';
data[e_lfanew + 2] = 0;
data[e_lfanew + 3] = 0;
// FileHeader: one section, size_optional_header set low
constexpr std::uint16_t num_sections = 1; constexpr std::uint16_t num_sections = 1;
constexpr std::uint16_t size_optional_header = 0xE0; constexpr std::uint16_t size_optional_header = 0xE0;
std::memcpy(data.data() + e_lfanew + 6, &num_sections, sizeof(num_sections)); std::memcpy(data.data() + e_lfanew + 6, &num_sections, sizeof(num_sections));
std::memcpy(data.data() + e_lfanew + 4 + 12, &size_optional_header, sizeof(size_optional_header)); std::memcpy(data.data() + e_lfanew + 4 + 12, &size_optional_header, sizeof(size_optional_header));
// Optional header magic x64
constexpr std::uint16_t magic = 0x020B; constexpr std::uint16_t magic = 0x020B;
std::memcpy(data.data() + e_lfanew + 4 + sizeof(TestFileHeader), &magic, sizeof(magic)); std::memcpy(data.data() + e_lfanew + 4 + sizeof(TestFileHeader), &magic, sizeof(magic));
// Section header .text with small data that does not contain the pattern
constexpr std::size_t offset_to_segment_table = e_lfanew + 4 + sizeof(TestFileHeader) + size_optional_header; constexpr std::size_t offset_to_segment_table = e_lfanew + 4 + sizeof(TestFileHeader) + size_optional_header;
constexpr char name[8] = {'.', 't', 'e', 'x', 't', 0, 0, 0}; constexpr char name[8] = {'.', 't', 'e', 'x', 't', 0, 0, 0};
std::memcpy(data.data() + offset_to_segment_table, name, 8); std::memcpy(data.data() + offset_to_segment_table, name, 8);
std::uint32_t vs = 4, va = 0x1000, srd = 4, prd = 0x200; std::uint32_t vs = 4, va = 0x1000, srd = 4, prd = 0x200;
std::memcpy(data.data() + offset_to_segment_table + 8, &vs, 4); std::memcpy(data.data() + offset_to_segment_table + 8, &vs, 4);
std::memcpy(data.data() + offset_to_segment_table + 12, &va, 4); std::memcpy(data.data() + offset_to_segment_table + 12, &va, 4);
std::memcpy(data.data() + offset_to_segment_table + 16, &srd, 4); std::memcpy(data.data() + offset_to_segment_table + 16, &srd, 4);
std::memcpy(data.data() + offset_to_segment_table + 20, &prd, 4); std::memcpy(data.data() + offset_to_segment_table + 20, &prd, 4);
// write file
ASSERT_TRUE(write_bytes(path, data));
const auto res = PePatternScanner::scan_for_pattern_in_file(path, "AA BB CC", ".text"); const auto f = MemFdFile::create(data);
ASSERT_TRUE(f.valid());
const auto res = PePatternScanner::scan_for_pattern_in_file(f.path(), "AA BB CC", ".text");
EXPECT_FALSE(res.has_value()); EXPECT_FALSE(res.has_value());
} }
// Extra tests for pe_pattern_scan edge cases (on-disk API)
TEST(PePatternScanMore2, PatternAtStartFound) TEST(PePatternScanMore2, PatternAtStartFound)
{ {
const std::string path = "./test_pe_more_start.bin";
const std::vector<std::uint8_t> bytes = {0x90, 0x01, 0x02, 0x03, 0x04}; const std::vector<std::uint8_t> bytes = {0x90, 0x01, 0x02, 0x03, 0x04};
ASSERT_TRUE(write_minimal_pe_file(path, bytes)); const auto f = MemFdFile::create(build_minimal_pe(bytes));
ASSERT_TRUE(f.valid());
const auto res = PePatternScanner::scan_for_pattern_in_file(path, "90 01 02", ".text"); const auto res = PePatternScanner::scan_for_pattern_in_file(f.path(), "90 01 02", ".text");
EXPECT_TRUE(res.has_value()); EXPECT_TRUE(res.has_value());
} }
TEST(PePatternScanMore2, PatternAtEndFound) TEST(PePatternScanMore2, PatternAtEndFound)
{ {
const std::string path = "./test_pe_more_end.bin"; const std::vector<std::uint8_t> bytes = {0x00, 0x11, 0x22, 0x33, 0x44};
std::vector<std::uint8_t> bytes = {0x00, 0x11, 0x22, 0x33, 0x44}; const auto f = MemFdFile::create(build_minimal_pe(bytes));
ASSERT_TRUE(write_minimal_pe_file(path, bytes)); ASSERT_TRUE(f.valid());
const auto res = PePatternScanner::scan_for_pattern_in_file(path, "22 33 44", ".text"); const auto res = PePatternScanner::scan_for_pattern_in_file(f.path(), "22 33 44", ".text");
if (!res.has_value()) if (!res.has_value())
{ {
// Try to locate the section header and print the raw section bytes the scanner would read // Debug: inspect section header via the memfd path
std::ifstream in(path, std::ios::binary); std::ifstream in(f.path(), std::ios::binary);
ASSERT_TRUE(in.is_open()); if (in.is_open())
// search for ".text" name
in.seekg(0, std::ios::beg);
std::vector<char> filebuf((std::istreambuf_iterator<char>(in)), std::istreambuf_iterator<char>());
const auto it = std::search(filebuf.begin(), filebuf.end(), std::begin(".text"), std::end(".text") - 1);
if (it != filebuf.end())
{ {
const size_t pos = std::distance(filebuf.begin(), it); std::vector<char> filebuf((std::istreambuf_iterator<char>(in)), std::istreambuf_iterator<char>());
// after name, next fields: virtual_size (4), virtual_address(4), size_raw_data(4), ptr_raw_data(4) const auto it = std::search(filebuf.begin(), filebuf.end(), std::begin(".text"), std::end(".text") - 1);
const size_t meta_off = pos + 8; if (it != filebuf.end())
uint32_t virtual_size{};
uint32_t virtual_address{};
uint32_t size_raw_data{};
uint32_t ptr_raw_data{};
std::memcpy(&virtual_size, filebuf.data() + meta_off, sizeof(virtual_size));
std::memcpy(&virtual_address, filebuf.data() + meta_off + 4, sizeof(virtual_address));
std::memcpy(&size_raw_data, filebuf.data() + meta_off + 8, sizeof(size_raw_data));
std::memcpy(&ptr_raw_data, filebuf.data() + meta_off + 12, sizeof(ptr_raw_data));
std::cerr << "Parsed section header: virtual_size=" << virtual_size << " virtual_address=0x" << std::hex
<< virtual_address << std::dec << " size_raw_data=" << size_raw_data
<< " ptr_raw_data=" << ptr_raw_data << "\n";
if (ptr_raw_data + size_raw_data <= filebuf.size())
{ {
std::cerr << "Extracted section bytes:\n"; const std::size_t pos = std::distance(filebuf.begin(), it);
for (size_t i = 0; i < size_raw_data; i += 16) const std::size_t meta_off = pos + 8;
{ std::uint32_t virtual_size{}, virtual_address{}, size_raw_data{}, ptr_raw_data{};
std::fprintf(stderr, "%04zx: ", i); std::memcpy(&virtual_size, filebuf.data() + meta_off, sizeof(virtual_size));
for (size_t j = 0; j < 16 && i + j < size_raw_data; ++j) std::memcpy(&virtual_address, filebuf.data() + meta_off + 4, sizeof(virtual_address));
std::fprintf(stderr, "%02x ", static_cast<uint8_t>(filebuf[ptr_raw_data + i + j])); std::memcpy(&size_raw_data, filebuf.data() + meta_off + 8, sizeof(size_raw_data));
std::fprintf(stderr, "\n"); std::memcpy(&ptr_raw_data, filebuf.data() + meta_off + 12, sizeof(ptr_raw_data));
} std::cerr << "Parsed section header: virtual_size=" << virtual_size << " virtual_address=0x"
<< std::hex << virtual_address << std::dec << " size_raw_data=" << size_raw_data
<< " ptr_raw_data=" << ptr_raw_data << "\n";
} }
} }
} }
@@ -265,30 +142,30 @@ TEST(PePatternScanMore2, PatternAtEndFound)
TEST(PePatternScanMore2, WildcardMatches) TEST(PePatternScanMore2, WildcardMatches)
{ {
const std::string path = "./test_pe_more_wild.bin";
const std::vector<std::uint8_t> bytes = {0xDE, 0xAD, 0xBE, 0xEF}; const std::vector<std::uint8_t> bytes = {0xDE, 0xAD, 0xBE, 0xEF};
ASSERT_TRUE(write_minimal_pe_file(path, bytes)); const auto f = MemFdFile::create(build_minimal_pe(bytes));
ASSERT_TRUE(f.valid());
const auto res = PePatternScanner::scan_for_pattern_in_file(path, "DE ?? BE", ".text"); const auto res = PePatternScanner::scan_for_pattern_in_file(f.path(), "DE ?? BE", ".text");
EXPECT_TRUE(res.has_value()); EXPECT_TRUE(res.has_value());
} }
TEST(PePatternScanMore2, PatternLongerThanBuffer) TEST(PePatternScanMore2, PatternLongerThanBuffer)
{ {
const std::string path = "./test_pe_more_small.bin";
const std::vector<std::uint8_t> bytes = {0xAA, 0xBB}; const std::vector<std::uint8_t> bytes = {0xAA, 0xBB};
ASSERT_TRUE(write_minimal_pe_file(path, bytes)); const auto f = MemFdFile::create(build_minimal_pe(bytes));
ASSERT_TRUE(f.valid());
const auto res = PePatternScanner::scan_for_pattern_in_file(path, "AA BB CC", ".text"); const auto res = PePatternScanner::scan_for_pattern_in_file(f.path(), "AA BB CC", ".text");
EXPECT_FALSE(res.has_value()); EXPECT_FALSE(res.has_value());
} }
TEST(PePatternScanMore2, InvalidPatternParse) TEST(PePatternScanMore2, InvalidPatternParse)
{ {
const std::string path = "./test_pe_more_invalid.bin";
const std::vector<std::uint8_t> bytes = {0x01, 0x02, 0x03}; const std::vector<std::uint8_t> bytes = {0x01, 0x02, 0x03};
ASSERT_TRUE(write_minimal_pe_file(path, bytes)); const auto f = MemFdFile::create(build_minimal_pe(bytes));
ASSERT_TRUE(f.valid());
const auto res = PePatternScanner::scan_for_pattern_in_file(path, "01 GG 03", ".text"); const auto res = PePatternScanner::scan_for_pattern_in_file(f.path(), "01 GG 03", ".text");
EXPECT_FALSE(res.has_value()); EXPECT_FALSE(res.has_value());
} }

View File

@@ -31,7 +31,11 @@
"dependencies": [ "dependencies": [
"glfw3", "glfw3",
"glew", "glew",
"opengl" "opengl",
{
"name": "imgui",
"features": ["glfw-binding", "opengl3-binding"]
}
] ]
}, },
"imgui": { "imgui": {