ByteHook 开源项目使用教程

ByteHook 开源项目使用教程

bhook :fire: ByteHook is an Android PLT hook library which supports armeabi-v7a, arm64-v8a, x86 and x86_64. 项目地址: https://gitcode.com/gh_mirrors/bh/bhook

1. 项目介绍

ByteHook 是由字节跳动开发的一个 Android 平台上的 PLT（Procedural Linkage Table）钩子库。它支持 armeabi-v7a、arm64-v8a、x86 和 x86_64 架构，能够在 Android 4.1（API 级别 16）至 Android 15（API 级别 35）之间运行。ByteHook 目前被应用于 TikTok、Douyin、Toutiao、Xigua Video 和 Lark 等应用中。它允许开发者在进程中对动态库进行钩子操作，而不会互相冲突，并且支持自动钩住新加载的动态库。

2. 项目快速启动

添加依赖

首先，在你的 build.gradle 文件中添加以下依赖项：

android {
    buildFeatures {
        prefab true
    }
}

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

如果你的 Android Gradle 插件版本早于 7.1.0，你需要在 gradle.properties 文件中添加以下配置：

android.prefabVersion=2.0.0

配置 ABI

在 defaultConfig 中指定你需要的 ABI 类型：

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

打包选项

如果你在 SDK 项目中使用 ByteHook，你需要在打包选项中排除 libbytehook.so 文件：

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

如果你在 APP 项目中使用 ByteHook，你可能需要处理重复的 libbytehook.so 文件冲突：

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

初始化

在你的 Java 代码中，添加以下初始化代码：

import com.bytedance.android.bytehook.ByteHook;

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

钩子和解钩

在你的 C 或 C++ 代码中，使用以下钩子函数：

#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);

// ... 其他钩子函数 ...

int bytehook_unhook(bytehook_stub_t stub);

确保在代理函数中使用 BYTEHOOK_CALL_PREV() 宏调用原始函数，并在返回前使用 BYTEHOOK_POP_STACK() 宏。

3. 应用案例和最佳实践

（本部分将介绍一些具体的应用场景和如何使用 ByteHook 解决实际问题的最佳实践，由于具体案例需要根据实际项目情况编写，这里仅作示例说明。）

4. 典型生态项目

（本部分将列举一些与 ByteHook 相关的生态项目，这些项目可能使用了 ByteHook 或为其提供了扩展功能，具体项目需要根据实际情况列出。）

bhook :fire: ByteHook is an Android PLT hook library which supports armeabi-v7a, arm64-v8a, x86 and x86_64. 项目地址: https://gitcode.com/gh_mirrors/bh/bhook