SafetyHook 项目下载及安装教程

2024-12-05 11:05:28作者：舒璇辛Bertina

1. 项目介绍

SafetyHook 是一个用于 Windows x86 和 x86_64 系统的 C++23 过程钩子库。它旨在使运行时过程钩子尽可能安全，同时保持其实现的简单性。SafetyHook 目前支持以下功能：

在创建或删除钩子时停止所有其他线程。
修复可能受创建或删除钩子影响的线程的 IP。
修复重定位指令的 IP 相对偏移（例如 lea rax, [rip + 0x1234]）。
修复重定位指令的相对偏移（例如 jmp 0x1234）。
将短分支扩展为近分支。
处理落在蹦床内的短分支。
使用支持最新指令的现代反汇编引擎。
具有精心设计的 API，难以误用。

2. 项目下载位置

要下载 SafetyHook 项目，请访问项目的 GitHub 仓库。您可以通过以下步骤下载项目：

打开终端或命令提示符。
使用 git clone 命令下载项目：

git clone https://github.com/cursey/safetyhook.git

3. 项目安装环境配置

在安装 SafetyHook 之前，您需要确保您的开发环境满足以下要求：

操作系统：Windows x86 或 x86_64
编译器：支持 C++23 的编译器（如 GCC、Clang 或 MSVC）
CMake：版本 3.14 或更高
Zydis：用于反汇编的库（如果使用合并构建，则不需要单独安装）

环境配置示例

以下是配置环境的示例步骤：

安装 CMake：
- 下载并安装 CMake 3.14 或更高版本。
- 配置系统环境变量，确保 CMake 可执行文件在 PATH 中。
安装编译器：
- 安装支持 C++23 的编译器，如 MSVC、GCC 或 Clang。
- 配置系统环境变量，确保编译器可执行文件在 PATH 中。
安装 Zydis（可选）：
- 如果使用合并构建，则不需要单独安装 Zydis。
- 如果需要单独安装，请参考 Zydis 的官方文档进行安装。

4. 项目安装方式

SafetyHook 可以通过以下几种方式安装：

使用 CMake 的 FetchContent

在您的 CMake 项目中，添加以下代码以使用 FetchContent 下载并安装 SafetyHook：

include(FetchContent)

# SafetyHook
FetchContent_Declare(
    safetyhook
    GIT_REPOSITORY "https://github.com/cursey/safetyhook.git"
    GIT_TAG "origin/main"
)
FetchContent_MakeAvailable(safetyhook)

如果您希望 SafetyHook 自动下载并安装 Zydis，请启用 CMake 选项 -DSAFETYHOOK_FETCH_ZYDIS=ON。

使用 Git 子模块

在您的项目根目录中，使用以下命令将 SafetyHook 添加为 Git 子模块：

git submodule add https://github.com/cursey/safetyhook.git

在 CMakeLists.txt 中，添加以下代码以包含 SafetyHook：

add_subdirectory(safetyhook)

使用合并构建

访问 SafetyHook 的发布页面，下载包含 Zydis 的合并构建 ZIP 文件。
将 ZIP 文件解压到您的项目目录中。
在 CMakeLists.txt 中，添加以下代码以包含 SafetyHook：

add_subdirectory(safetyhook)

5. 项目处理脚本

以下是一个简单的示例脚本，展示如何在项目中使用 SafetyHook：

#include <iostream>
#include <safetyhook.hpp>

__declspec(noinline) int add(int x, int y) {
    return x + y;
}

SafetyHookInline g_add_hook;

int hook_add(int x, int y) {
    return g_add_hook.call<int>(x * 2, y * 2);
}

int main() {
    std::cout << "unhooked add(2, 3) = " << add(2, 3) << "\n";

    // 创建一个钩子 on add (使用 SafetyHook 的简单 API)
    g_add_hook = safetyhook::create_inline(reinterpret_cast<void*>(add), reinterpret_cast<void*>(hook_add));

    std::cout << "hooked add(3, 4) = " << add(3, 4) << "\n";

    g_add_hook = nullptr;

    std::cout << "unhooked add(5, 6) = " << add(5, 6) << "\n";

    return 0;
}