Frelatage 项目启动与配置教程

Frelatage 项目启动与配置教程

frelatage 项目地址: https://gitcode.com/gh_mirrors/fr/frelatage

1. 项目的目录结构及介绍

Frelatage 的目录结构如下：

frelatage/
├── dictionaries/           # 存放用于模糊测试的字典文件
├── doc/                   # 项目文档
├── examples/              # 示例代码和模糊测试用例
├── frelatage/             # Frelatage 的核心代码
├── scripts/               # 脚本文件，包括安装脚本等
├── tests/                 # 测试代码
├── .gitignore             # Git 忽略文件
├── LICENSE                # 项目许可证文件
├── README.md              # 项目说明文件
├── hall_of_fame.md        # 名人堂文件，记录项目的突出贡献者
├── mypy.ini               # mypy 配置文件
├── poetry.lock            # Poetry 锁文件，用于依赖管理
├── pyproject.toml         # Python 项目配置文件

每个目录和文件的具体功能已在上述结构中简要介绍。

2. 项目的启动文件介绍

Frelatage 的启动主要是通过 Python 的命令行执行相应的脚本或直接运行示例代码。以下是一个简单的启动示例：

首先，安装 Frelatage：

pip3 install frelatage

然后，创建一个模糊测试的 Python 脚本，例如：

import frelatage
import my_vulnerable_library

def MyFunctionFuzz(data):
    my_vulnerable_library.parse(data)

input = frelatage.Input(value="initial_value")
f = frelatage.Fuzzer(MyFunctionFuzz, [[input]])
f.fuzz()

在上述脚本中，MyFunctionFuzz 是你想要模糊测试的函数。通过 Fuzzer 类来执行模糊测试过程。

3. 项目的配置文件介绍

Frelatage 使用环境变量来配置项目。以下是一些主要的环境变量及其说明：

• FRELATAGE_DICTIONARY_ENABLE: 是否启用基于字典元素的变异。值为 1 启用，值为 0 禁用。默认值为 1。
• FRELATAGE_SAVE_NEW_COVERAGE: 是否保存新的覆盖率输入以便后续重用。值为 1 启用，值为 0 禁用。默认值为 1。
• FRELATAGE_TIMEOUT_DELAY: 函数执行超时时间（秒）。默认值为 2。
• FRELATAGE_INPUT_FILE_TMP_DIR: 输入文件存储的临时文件夹路径。默认值为 /tmp/frelatage。
• FRELATAGE_INPUT_MAX_LEN: 输入变量的最大大小（字节）。默认值为 4094。
• FRELATAGE_MAX_THREADS: 最大线程数。默认值为 8。
• FRELATAGE_MAX_STAGES: 模糊测试函数的最大阶段数。默认值为 1000000。
• FRELATAGE_MAX_CYC: （未完整显示，可能为模糊测试的最大循环数）

根据需要设置这些环境变量，可以通过以下方式：

export FRELATAGE_TIMEOUT_DELAY=5

确保在开始模糊测试之前设置好所有需要的配置。

frelatage 项目地址: https://gitcode.com/gh_mirrors/fr/frelatage