开源项目OSS-Fuzz安装与使用指南

开源项目OSS-Fuzz安装与使用指南

oss-fuzzOSS-Fuzz - continuous fuzzing for open source software.项目地址:https://gitcode.com/gh_mirrors/os/oss-fuzz

目录结构及介绍

当你克隆或下载了 OSS-Fuzz 的仓库 (https://github.com/google/oss-fuzz.git) 后, 最主要的目录和文件包括:

目录说明

• infra: 包含了用于运行服务的基础架构代码和服务脚本. 这些脚本被用来搭建环境并执行模糊测试.

• scripts: 收集了一系列用于自动化流程的shell脚本例如构建、测试以及上传结果等。

• projects/: 每一个子目录代表了一个集成到OSS-Fuzz中的开源项目. 在这些子目录中包含了特定于该项目的模糊测试策略和必要的补丁以确保其能够顺利地进行模糊测试.

• docker: 这个目录包含了Dockerfile和其他相关文件来创建在Google Cloud上运行的容器镜像.

• images/: 存放由上述Dockerfile建立的不同类型的Docker镜像（如C/C++, Python, Go等语言的镜像）.

文件说明

• BUILD.bazel: bazel构建系统配置文件.
• run_build.sh: 构建整个工程的脚本.
• run_in_container.sh: 在指定的容器环境中运行命令的辅助脚本.
• build_and_run_fuzzers.py: 负责构建和运行模糊器的主要python脚本.

项目的启动文件介绍

run_build.sh 这个脚本负责协调项目的整个构建流程从初始化工作空间、拉取依赖库、编译代码直到将所需的二进制文件打包成Docker镜像准备部署。 通过执行以下命令可以在本地环境下测试此过程：

./infra/helper/run_build.sh <project_name>

其中 <project_name> 是希望进行模糊测试的具体开源软件名称。

配置文件介绍

在 OSS-Fuzz 中有几个关键性的配置文件, 它们控制着模糊测试的运行方式和目标.

build.yaml

位于项目目录下的 build.yaml 控制了项目的构建逻辑, 包括依赖项管理, 编译命令和测试套件选择. 此外它还指定了如何将代码包装进Docker镜像以便云平台上的运行.

docker/Dockerfiles

Dockerfile是创建容器镜像的蓝图文件它描述了所需的操作系统环境以及该环境应安装哪些工具和库以支持模糊测试框架Libfuzzer 和 Sanitizer 的运行.

在不同的语言或技术栈下OSS-Fuzz提供了对应的Dockerfile模板例如针对C/C++ Python 或者Go语言的项目都有专门优化过的基础镜像。

FROM gcr.io/oss-fuzz-base/base-builder:v2

RUN apt-get update && apt-get install -y \
    python3-dev \
    python3-setuptools \
    ...

COPY . .

CMD ["/bin/bash", "-c", "pip3 install -e ."]

通过调整 RUN 和 CMD 部分可以轻松定制化适合自己的开发环境而无需重复造轮子, 大大提高了构建效率。

以上信息涵盖了对 OSS-Fuzz 核心目录、启动脚本以及关键配置文件的基本理解. 如需更详细的实现细节建议阅读项目的README.md文件或访问社区论坛获取进一步的帮助和支持!

oss-fuzzOSS-Fuzz - continuous fuzzing for open source software.项目地址:https://gitcode.com/gh_mirrors/os/oss-fuzz