ByteHook

English

ByteHook 是一个支持 armeabi-v7a、arm64-v8a、x86 和 x86_64 架构的 Android PLT hook 库。

ByteHook 目前在 TikTok、抖音、今日头条、西瓜视频和飞书中使用。

如果您需要一个 Android 内联 hook 库，请移步 ShadowHook。

特性

支持 Android 4.1 - 14（API 级别 16 - 34）。
支持 armeabi-v7a、arm64-v8a、x86 和 x86_64 架构。
对同一函数的多次 hook 和 unhook 不会相互冲突。
可以 hook 进程中的单个、部分或所有动态库。
自动 hook 新加载的动态库。
自动避免代理函数之间的递归调用和循环调用。
支持在代理函数中进行栈回溯。
使用 MIT 许可证。

文档

ByteHook 文档

快速开始

您可以参考 bytehook-sample 中的示例应用。

1. 在 build.gradle 中添加依赖

ByteHook 已发布在 Maven Central，并使用 Prefab 包格式作为原生依赖，该格式受 Android Gradle Plugin 4.0+ 支持。

android {
    buildFeatures {
        prefab true
    }
}

dependencies {
    implementation 'com.bytedance:bytehook:1.0.10'
}

注意：ByteHook 使用 prefab 包架构 v2，该架构在 Android Gradle Plugin 7.1.0 及以后版本中默认配置。如果您使用的是早于 7.1.0 的 Android Gradle Plugin 版本，请在 gradle.properties 中添加以下配置：

android.prefabVersion=2.0.0

2. 在 CMakeLists.txt 或 Android.mk 中添加依赖

CMakeLists.txt

find_package(bytehook REQUIRED CONFIG)

add_library(mylib SHARED mylib.c)
target_link_libraries(mylib bytehook::bytehook)

Android.mk

include $(CLEAR_VARS)
LOCAL_MODULE           := mylib
LOCAL_SRC_FILES        := mylib.c
LOCAL_SHARED_LIBRARIES += bytehook
include $(BUILD_SHARED_LIBRARY)

$(call import-module,prefab/bytehook)

3. 指定一个或多个您需要的 ABI

android {
    defaultConfig {
        ndk {
            abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64'
        }
    }
}

4. 添加打包选项

如果您在 SDK 项目中使用 ByteHook，您可能需要避免将 libbytehook.so 打包到您的 AAR 中，以防止在打包应用项目时遇到重复的 libbytehook.so 文件。

android {
    packagingOptions {
        exclude '**/libbytehook.so'
    }
}

另一方面，如果您在应用项目中使用 ByteHook，您可能需要添加一些选项来处理由重复的 libbytehook.so 文件引起的冲突。

android {
    packagingOptions {
        pickFirst '**/libbytehook.so'
    }
}

5. 初始化

import com.bytedance.android.bytehook.ByteHook;

public class MySdk {
    public static synchronized void init() {
        ByteHook.init();
    }
}

6. Hook 和 Unhook

#include "bytehook.h"

bytehook_stub_t bytehook_hook_single(
    const char *caller_path_name,
    const char *callee_path_name,
    const char *sym_name,
    void *new_func,
    bytehook_hooked_t hooked,
    void *hooked_arg);

bytehook_stub_t bytehook_hook_partial(
    bytehook_caller_allow_filter_t caller_allow_filter,
    void *caller_allow_filter_arg,
    const char *callee_path_name,
    const char *sym_name,
    void *new_func,
    bytehook_hooked_t hooked,
    void *hooked_arg);

bytehook_stub_t bytehook_hook_all(
    const char *callee_path_name,
    const char *sym_name,
    void *new_func,
    bytehook_hooked_t hooked,
    void *hooked_arg);

int bytehook_unhook(bytehook_stub_t stub);