# OSS-模糊 [OSS-Fuzz]() 是 Google 开发的一个开源项目，为持续模糊测试提供免费的分布式基础设施。它简化了模糊测试过程并促进了更简单的修改。虽然只有选定的项目被 OSS-Fuzz 接受，但该项目的核心是开源的，允许任何人为私人项目托管自己的实例。 ## 概述 OSS-Fuzz 提供了一个简单的 CLI 框架，用于构建和启动线束或计算其覆盖范围。此外，OSS-Fuzz 可以用作托管从模糊测试输出（例如覆盖信息）生成的静态网页的服务。 ### 关键概念概念 |描述 ---|--- **helper.py** |用于构建图像、构建模糊器和在本地运行线束的 CLI 脚本 **基础图像** |提供构建依赖项和编译器的分层 Docker 镜像 **项目.yaml** |定义 OSS-Fuzz 注册的项目元数据的配置文件 **Dockerfile** |具有构建依赖项的项目特定映像 **build.sh** |为您的项目构建模糊测试工具的脚本 **关键分数** | OSS-Fuzz 团队用于评估项目验收的指标 ## 何时申请 **在以下情况下应用此技术：** * 为开源项目设置持续模糊测试 * 需要分布式模糊测试基础设施而无需管理服务器 * 想要与模糊测试集成的覆盖率报告和错误跟踪 * 在本地测试现有的 OSS-Fuzz 工具 * 从 OSS-Fuzz 错误报告中重现崩溃 **在以下情况下跳过此技术：** * 项目是闭源的（除非托管您自己的 OSS-Fuzz 实例） * 项目不符合 OSS-Fuzz 的关键性分数阈值 * 需要专有或专门的模糊测试基础设施 * 模糊测试不需要基础设施的简单脚本 ## 快速参考任务|命令 ---|--- 克隆 OSS-Fuzz | `git 克隆 https://github.com/google/oss-fuzz` 打造项目形象| `python3 infra/helper.py build_image --pull <项目>` 使用 ASan 构建模糊器 | `python3 infra/helper.py build_fuzzers --sanitizer=地址 <项目>` 运行特定线束 | `python3 infra/helper.py run_fuzzer <项目> <线束>` 生成覆盖率报告 | `python3 infra/helper.py 覆盖 <项目>` 检查 helper.py 选项 | `python3 infra/helper.py --help` ## OSS-Fuzz 项目组件 OSS-Fuzz 提供了几种公开可用的工具和 Web 界面： ### 错误跟踪器 [错误跟踪器]() 允许您： * 检查特定项目的错误（最初仅对维护人员可见，后来[公开]()) * 创建新问题并对现有问题发表评论 * 在**所有项目**中搜索类似的错误以了解问题 ### 构建状态系统 [构建状态系统]() 帮助跟踪： * 所有包含项目的构建状态 * 上次成功构建的日期 * 构建失败及其持续时间 ### 模糊内省器 [Fuzz Introspector]() 显示： * OSS-Fuzz 中注册项目的覆盖数据 * 覆盖代码的点击频率 * 性能分析和拦截器识别阅读[此案例研究]() 以获取示例和说明。 ## 分步：运行单个线束您无需托管整个 OSS-Fuzz 平台即可使用它。帮助程序脚本可以轻松地在本地运行各个线束。 ### 第 1 步：克隆 OSS-Fuzz git 克隆 https://github.com/google/oss-fuzz cd oss-模糊 python3 infra/helper.py --help ### 第 2 步：构建项目映像 python3 infra/helper.py build_image --pull <项目名称> 这将下载并构建项目的基础 Docker 映像。 ### 步骤 3：使用 Sanitizer 构建模糊器 python3 infra/helper.py build_fuzzers --sanitizer=address <项目名称> **消毒剂选项：** * `--sanitizer=address` 用于 [AddressSanitizer]() 和 [LeakSanitizer]() * 提供其他消毒剂（语言支持有所不同） **注意：** 模糊器构建为包含线束可执行文件、字典、语料库和崩溃文件的“/build/out//”。 ### 步骤 4：运行模糊测试器 python3 infra/helper.py run_fuzzer <项目名称> <线束名称> [<模糊器参数>] 如果您跳过任何错过的步骤，帮助程序脚本会自动运行这些步骤。 ### 步骤 5：覆盖率分析（可选）首先，[安装 gsutil]()（跳过 gcloud 初始化）。 python3 infra/helper.py build_fuzzers --sanitizer=coverage <项目名称> python3 infra/helper.py 覆盖 <项目名称> 使用“--no-corpus-download”仅使用本地语料库。该命令在本地生成并托管覆盖率报告。有关详细信息，请参阅[官方 OSS-Fuzz 文档]()。 ## 常见模式 ### 模式：运行 irssi 示例 **用例：** 使用简单的注册项目测试 OSS-Fuzz 设置 # 克隆并导航到 OSS-Fuzz git 克隆 https://github.com/google/oss-fuzz cd oss-模糊 # 构建并运行 irssi 模糊器 python3 infra/helper.py build_image --pull irssi python3 infra/helper.py build_fuzzers --sanitizer=地址 irssi python3 infra/helper.py run_fuzzer irssi irssi-fuzz **预期输出：** 信息：__main__：运行： docker run --rm --privileged --shm-size=2g --platform linux/amd64 -i -e FUZZING_ENGINE=libfuzzer -e SANITIZER=address -e RUN_FUZZER_MODE=interactive -e HELPER=True -v /private/tmp/oss-fuzz/build/out/irssi:/out -t gcr.io/oss-fuzz-base/base-runner run_fuzzer irssi-fuzz。使用种子语料库：irssi-fuzz_seed_corpus.zip /out/irssi-fuzz -rss_limit_mb=2560 -timeout=25 /tmp/irssi-fuzz_corpus -max_len=2048 < /dev/null 信息：以熵功率计划运行（0xFF，100）。信息：种子：1531341664 信息：已加载 1 个模块（95687 内联 8 位计数器）：95687 [0x1096c80，0x10ae247），信息：已加载 1 个 PC 表（95687 个 PC）：95687 [0x10ae248,0x1223eb8), 信息：在 /tmp/irssi-fuzz_corpus 中找到 719 个文件信息：种子语料库：文件：719 分钟：1b 最大：170106b 总计：367969b rss：48Mb #720 INITED cov：409英尺：1738公司：640/163Kb exec/s：0 rss：62Mb #762 减少 cov: 409 ft: 1738 corp: 640/163Kb lim: 2048 exec/s: 0 rss: 63Mb L: 236/2048 MS: 2 ShuffleBytes-EraseBytes- ### 模式：注册新项目 **用例：** 将您的项目添加到 OSS-Fuzz（或私有实例）在 `projects//` 中创建三个文件： **1\. project.yaml** \- 项目元数据：主页：“https://github.com/yourorg/yourproject” 语言：c++ Primary_contact：“您的电子邮件@example.com” main_repo：“https://github.com/yourorg/yourproject” 模糊测试引擎： - libfuzzer 消毒剂： - 地址 - 未定义 **2\. Dockerfile** \- 构建依赖项：来自 gcr.io/oss-fuzz-base/base-builder 运行 apt-get update && apt-get install -y \ 自动配置\ 汽车制造商\ 库工具\ pkg 配置运行 git clone --深度 1 https://github.com/yourorg/yourproject WORKDIR 你的项目复制 build.sh $SRC/ **3\. build.sh** \- 构建线束： #!/bin/bash -eu ./autogen.sh ./configure --禁用共享使-j$(nproc) # 构建线束 $CXX $CXXFLAGS -std=c++11 -I。 \ $SRC/yourproject/fuzz/harness.cc -o $OUT/harness \ $LIB_FUZZING_ENGINE ./libyourproject.a # 复制语料库和词典（如果有） cp $SRC/yourproject/fuzz/corpus.zip $OUT/harness_seed_corpus.zip cp $SRC/yourproject/fuzz/dictionary.dict $OUT/harness.dict ## OSS-Fuzz 中的 Docker 镜像线束是在 Docker 容器中构建和执行的。所有项目共享一个运行程序映像，但每个项目都有自己的构建映像。 ### 图像层次结构图像按以下顺序相互构建： 1. **[base_image]()** \- 特定 Ubuntu 版本 2. **[base_clang]()** \- Clang 编译器；基于“base_image” 3. **[base_builder]()** \- 构建依赖项；基于“base_clang” * 特定于语言的变体：[`base_builder_go`]()等。 * 请参阅 [/oss-fuzz/infra/base-images/]() 了解完整列表 4. **您的项目 Docker 镜像** \- 项目特定的依赖项；基于“base_builder”或语言变体 ### 跑步者图像（单独使用） * **[base_runner]()** \- 执行工具；基于“base_clang” * **[base_runner_debug]()** \- 带调试工具；基于“base_runner” ## 高级用法 ### 提示和技巧提示 |为什么它有帮助 ---|--- **不要手动复制源代码** | Dockerfile 项目可能已经提取了最新版本 **检查现有项目** |浏览 [oss-fuzz/projects]() 以获取示例 **将线束保存在单独的存储库中** |像 [curl-fuzzer]() \- 更干净的组织 **使用特定的编译器版本** |基础镜像提供一致的构建环境 **在 Dockerfile 中安装依赖项** |可能需要批准 OSS-Fuzz 注册 ### 关键分数 OSS-Fuzz 使用[关键性分数]() 来评估项目验收。请参阅[此示例]()了解评分的工作原理。分数较低的项目仍可能被添加到私有 OSS-Fuzz 实例中。 ### 托管您自己的实例由于 OSS-Fuzz 是开源的，您可以托管自己的实例： * 私人项目不符合公共 OSS-Fuzz 的资格 * 关键度分数较低的项目 * 自定义模糊测试基础设施需求 ## 反模式反模式 |问题 |正确的做法 ---|---|--- **在 build.sh 中手动拉取源代码** |不使用最新版本 |让 Dockerfile 处理 git clone **将代码复制到 OSS-Fuzz 存储库** |难以维护，违反分离 |参考外部线束存储库 **忽略基础镜像版本** |构建不一致|使用提供的基础镜像和编译器 **跳过本地测试** |浪费CI资源| PR前在本地使用helper.py **不检查构建状态** |未被注意到的构建失败定期监控构建状态页面 ## 工具特定指南 ### libFuzzer OSS-Fuzz 主要使用 libFuzzer 作为 C/C++ 项目的模糊测试引擎。 **安全带签名：** extern "C" int LLVMFuzzerTestOneInput(const uint8_t *data, size_t 大小) { // 你的模糊测试逻辑返回0； } **在build.sh中构建：** $CXX $CXXFLAGS -std=c++11 -I。 \ harness.cc -o $OUT/harness \ $LIB_FUZZING_ENGINE ./libproject.a **整合技巧：** * 使用OSS-Fuzz提供的`$LIB_FUZZING_ENGINE`变量 * 包含 `-fsanitize=fuzzer` 会自动处理 * 尽可能链接到静态库 ### AFL++ OSS-Fuzz 支持 AFL++ 作为替代模糊测试引擎。 **在project.yaml中启用：** 模糊测试引擎： - afl - libfuzzer **整合技巧：** * AFL++ 线束与 libFuzzer 线束一起工作 * 使用持久模式以获得更好的性能 * OSS-Fuzz 处理特定于引擎的编译标志 ### Atheris (Python) 适用于带有 C 扩展的 Python 项目。 **来自[cbor2集成]()的示例：** **线束：** 进口动脉粥样硬化导入系统导入cbor2 @atheris.instrument_func def TestOneInput(数据): fdp = atheris.FuzzedDataProvider(数据) 尝试： cbor2.loads(数据) 除了（cbor2.CBORDecodeError，ValueError）：通过 def main(): atheris.Setup(sys.argv, TestOneInput) atheris.Fuzz() 如果 __name__ == "__main__": 主要() **在build.sh中构建：** pip3 安装 . 对于 $(find $SRC -name 'fuzz_*.py') 中的模糊器；做 compile_python_fuzzer $模糊器完成 **整合技巧：** * 使用OSS-Fuzz提供的`compile_python_fuzzer`帮助器 * 请参阅[持续模糊化 Python C 扩展]() 博客文章 ### Rust 项目 **在project.yaml中启用：** 语言：铁锈模糊测试引擎： - libfuzzer 消毒剂： - 地址 # Rust 仅支持 AddressSanitizer **在build.sh中构建：** 货物模糊构建-O --debug-assertions cp fuzz/target/x86_64-unknown-linux-gnu/release/fuzz_target_1 $OUT/ **整合技巧：** * [Rust 仅支持带有 libfuzzer 的 AddressSanitizer]() * 使用cargo-fuzz进行本地开发 * OSS-Fuzz 处理 Rust 特定的编译 ## 故障排除问题 |原因 |解决方案 ---|---|--- **构建因缺少依赖项而失败** |依赖项不在 Dockerfile 中 |在 Dockerfile 中添加 `apt-get install` 或等效项 **安全带立即崩溃** |缺少输入验证 |在线束中添加尺寸检查 **覆盖率为 0%** |线束未达到目标代码 |验证线束实际调用目标函数 **构建超时** |复杂的构建过程|优化build.sh，考虑并行构建 **构建中的消毒剂错误** |不兼容的标志 |使用OSS-Fuzz环境变量提供的标志 **找不到源代码** | Dockerfile 中的工作目录错误 |设置WORKDIR或使用绝对路径 ## 相关技能 ### 使用此技术的工具技能|如何应用 ---|--- **libfuzzer** | OSS-Fuzz 使用的主要模糊测试引擎 **aflpp** | OSS-Fuzz 支持的替代模糊测试引擎 **动脉粥样硬化** |用于在 OSS-Fuzz 中对 Python 项目进行模糊测试 **货物模糊** |用于 OSS-Fuzz 中的 Rust 项目 ### 相关技术技能|关系 ---|--- **覆盖率分析** | OSS-Fuzz 通过 helper.py 生成覆盖率报告 **地址消毒剂** | OSS-Fuzz 项目的默认清理程序 **模糊线束写作** |在 OSS-Fuzz 中注册项目的必备条件 **语料库管理** | OSS-Fuzz 维护已注册项目的语料库 ## 资源 ### 关键外部资源 **[OSS-Fuzz 官方文档]()** 全面的文档，涵盖 OSS-Fuzz 平台的注册、工具编写和故障排除。 **[入门指南]()** 将新项目注册到 OSS-Fuzz 的分步流程，包括要求和审批流程。 **[cbor2 OSS-Fuzz 集成 PR]()** 将具有 C 扩展的 Python 项目注册到 OSS-Fuzz 的真实示例。显示： * 初步提案及项目介绍 * 关键度评分评估 * 完整的实现（project.yaml、Dockerfile、build.sh、harnesses） **[Fuzz Introspector 案例研究]()** 使用 Fuzz Introspector 分析覆盖率和识别模糊测试拦截器的示例和说明。 ### 视频资源查看 OSS-Fuzz 文档，了解有关注册和利用开发的研讨会录音和教程。

奥斯弗兹

包含技能