通过源码学习peach的使用-先知社区

前言

本文通过分析和调试源码来学习 peach 的使用。peach 网上能找到的版本为peach2，peach3，peach4。

peach2

peach2 使用 python2 编写，下载地址为：

https://github.com/MozillaSecurity/peach

python 虽然容易上手和理解，但是 python2 的环境比较难搭建。即使搭建成功之后，由于 peach2和 peach3 之后版本使用的命令参数差异较大，网上和官方文档中也找不到使用说明，很难运行起来。

peach3 和 peach4

peach3 和 peach4 使用 c# 编写

peach3 下载地址为：

https://gitlab.com/peachtech/peach-fuzzer-community

peach4 下载地址为：

https://gitlab.com/gitlab-org/security-products/protocol-fuzzer-ce

peach3 编译环境搭建过程中会提示 CL.exe 版本不支持，暂不知道如何解决

peach4 编译环境搭建网上有相关的资料可以参考，虽然也有一些坑，但最终还是能解决并成功搭建起来编译环境。本文主要分析 peach4 的源码。

环境搭建

环境搭建参考：

https://github.com/sfncat/peach/blob/main/doc/编译PeachPro 4.0(protocol-fuzzer-ce) for windows.md

按照教程安装遇到了一些问题，解决方法如下：

typescript 安装： typescript 需要安装 1.8 以下的版本，安装命令为

npm install -g typescript@1.8

Ruby2.7 安装：安装文章中提供的 Ruby2.7 时，msys2 and mingw development toolchain 对应版本的文件无法下载。可以通过安装 Ruby3.4 来解决此问题，但环境变量中指向 Ruby3.4/bin 目录应修改为 Ruby2.7/bin 目录

choco安装Java,xsltprocs,git：需要使用管理员权限打开命令行

doxygen 安装：文章提供的链接无法访问，去官网安装最新的版本就行

visual C++ Redistributable for Visual Studio 2012 Update 4 下载链接：

https://www.microsoft.com/en-us/download/details.aspx?id=30679

.paket.exe restore --verbose

执行不成功可以考虑用手机热点

IDE 使用

参考文章

https://cartermgj.github.io/2018/02/02/peach-source/

，使用命令

waf.bat msvs2017

生成 sln 文件。

按照文章中所描述的，将启动项目设为 peach

图片加载失败

为 peach 项目的命令行参数指定 pit 文件，即可调试运行

图片加载失败

基本元素

peach 运行需要指定一个 xml 格式的 pit 文件，此文件主要描述了 fuzz 过程中使用的协议格式、状态模型、测试目标。下面是一个最简单的 pit 文件，只包含必须要有的元素：

DataModel: 用于定义协议的格式

StateModel：用于定义协议的状态机，一般情况下只定义一个 State 和一个 Action 就行

Test: 指定 peach 运行时使用的配置，如状态机、变异策略、日志文件路径、目标地址

DataModel

协议格式定义在 DataModel 元素下，通用参数有：

name: 标识一个元素，便于被其它元素引用

mutable: 此元素是否变异，默认为 true。除了类型相关的元素之外，

DataModel、Block 这种元素也会变异，如增加、删除、交换这些元素

occur 相关：用于指导变异，这些参数不为默认时，元素在变异时会增加一些复制自身的操作

minOccurs: 最少出现次数，默认 1

maxOccurs: 最多出现次数，默认 1

occurs: 实际出现次数，默认 1

DataModel 本身也有一些参数：

ref: 可以引用其它 DataModel，引用的数据会在当前 DataModel 的前面

Block

用于对一些元素统一进行操作，如计算数据包的总长度，关键参数如下：

ref: 引用其它 Block 或 DataModel

Number

定义一个整数（字节码数据，而不是字符串，1 是字节码，”1” 是字符串），关键参数如下：

size: bit 为单位，最大为 64

signed: 是否有符号，默认 false

endian: 大小端，默认小端（big 和 network 都表示大端）

value: 默认值

valueType: value 的数据格式，string 或 hex，默认 string，一般用 hex

Double

定义一个浮点数，关键参数如下：

size: bit 为单位，只能为 32 或 64

signed: 是否有符号，默认 false

endian: 大小端，默认小端（big 和 network 都表示大端）

value: 默认值，可以直接写浮点数 ”0.1” 或使用科学计数法 “1e-1”

valueType: value 的数据格式，string 或 hex，默认 string

Blob

定义一个数据块，一般用于定义协议的数据部分，关键参数如下：

length: 长度

lengthType: 长度类型，bytes 或 bits，默认 bytes

value: 默认值

valueType: value 的数据格式，string 或 hex，默认 string

token: 是否为 token，默认 false（网上说此字段为 true 表示不变异，经过测试此字段没有效果，还是建议使用 mutable）

Choice

下面包含多个子元素，当 Choice 的变异策略生效时会从子元素中选择一个，否则使用第一个子元素。子元素的 mutable 建议设置为 false，如果都设置为 true，只有第一个子元素的变异策略会生效。

Flag

一个 Flags 下面包含多个 Flag，Flag 本质上还是 Number，通过 Flags 包裹起来可以多一些数组相关的变异策略，如删除某个 Flag，交换 Flag 位置。Flags关键参数为：

size：元素占几个 bit（Flags 中没有给值的 bit 处用 0 填充）

position: 元素在 Flags 中的位置（以 bit 为单位），position=10 size=2 表示 Flags 中第 11 -12 个 bit

Padding

用于填充数据包，让数据包的长度对齐到 n bit 的倍数，关键参数如下：

alignment: 对齐到多少

bit（不是 byte）

，默认 8。想以 4 字节对齐，应设置为 32

alignedTo: 指定哪个元素需要对齐，不指定则对齐父元素

minSize: 最少填充的 bit，默认 0。满足最少填充数的前提下，再满足对齐要求

图片加载失败

String

定义一个字符串，关键参数如下：

length: 长度。nullTerminated 为 true 时可以不指定长度。只有当 length 不指定、nullTerminated 为 true，或者 lengthType 为 chars、length 指定时字符串长度才是确定的。因为有些编码中一个字符可能占多个 bytes，如果不能表示完整的字符会报错

lengthType: 长度类型，bytes、bits、chars，默认 bytes

nullTerminated: 字符串是否以 00 结尾，默认 false

padCharacter: 当字符串长度不够 length 时用于填充的字符，默认空

type: 编码类型，默认 utf8

value: 默认值，默认空

valueType: value 的数据格式，默认 string

图片加载失败

Relation

Relation 标签用于统计其它字段的内容信息，如计算其它字段的长度、变异时的重复次数、数据包中相对于某个字段的偏移。

长度

Relation的type为size时可以计算指定元素的长度（字节为单位），语法为

一些情况下，长度字段可能表示为实际长度乘2或除2，如一些协议中长度字段表示payload占多少个word（2字节），这时需要将payload的实际长度除2。peach中可以使用 expressionSet和expressionGet实现这样的功能。设置方式如下：

●

expressionSet 和 expressionGet 必须互为逆运算，若 expressionSet=”size*2”，expressionGet需要为”size/2”。这里size表示Relation type=”size” 绑定的元素实际长度。

●

expressionSet 表示对数据包中字段的操作，上述表示payload占多少个word的功能实现如下

重复次数

Relation的type为count时可以计算指定元素变异时的重复次数（元素定义时可以指定maxOccurs和minOccurs），语法为

同样可以使用expressionSet和expressionGet，里面用于计算的变量需要修改为 count。

偏移

Relation的type为offset时可以计算指定元素的偏移：

指定元素相对于数据包头部的偏移，

指定元素相对于Relation所在元素的偏移，

，包含Relation所在元素的size

指定元素相对于指定的任意元素的偏移，

同样可以使用expressionSet和expressionGet，里面用于计算的变量需要修改为 offset。

Fixup

Fixup 标签的主要功能有：校验和计算、hash计算、序列号生成、值拷贝。可以直接参考官方文档：

https://peachtech.gitlab.io/peach-fuzzer-community/v3/Fixup.html

校验和计算

自定义校验和

上面的校验和算法较少，且不灵活，下面介绍如何使用Python自定义校验和算法（网上没找到相关的资料，通过看源码和调试得到解决方案）。步骤如下：

●

编写Python模块：__init__函数必须要有，fixup函数需要我们实现，输入参数为 C# 类型的数据，返回值需要为整型（与引用脚本处使用的Number类型一致）。为方便Python处理输入，需要将C#类型的输入转换为Python字节数组。

●

导入Python模块：在DataModel的上方使用Import导入。直接写文件名的话，文件需要放在 peach.exe 所在的路径下。

●

绑定元素：Fixup class=”ScriptFixup”，里面的子元素 class 写上 Python文件中的类名（文件名.类名），ref 写上用于计算校验和的元素名。

hash计算

序列号生成

分为递增序列号和随机序列号。

值拷贝

让当前元素的值等于指定元素的值。

Transformer

Transformer标签用于对元素进行编码，作用于父元素，使用方式如下：

Hint

Hint标签用在数据标签里，用于为字段添加一些特定的变异器，常见的有 NumericalString、TypeTransform。语法如下：

变异器（Mutator）

变异器分为状态变异器 StateMutator 和数据变异器 DataMutator。peach 状态切换相关的资料较少，暂不清楚如何进行状态定义与切换，本文主要介绍数据变异器 DataMutator。

●

可以在Test标签中通过include和exclude关键词来选择和排除对应的mutator。

图片加载失败

●

第一个数据包为定义的原始数据包，不会进行变异，此阶段用来准备变异器为后续数据包变异做准备。

图片加载失败

StateMutator

ActionDuplicate

ActionRemove

ActionSwap

StateChangeRandom

DataMutator

每个变异器支持的元素类型，需要将元素 mutable 设为 true

ArrayEdgeCase：必须为 Sequence，且元素数量不为 0

ArrayRandomizeOrder：必须为 Sequence，且元素数量大于 1

ArrayReverseOrder：必须为 Sequence，且元素数量大于 1

ArrayVariance：必须为 Sequence，且元素数量不为 0

BlobChangeFromNull：元素为 Blob，且内容不为空

BlobChangeRandom：元素为 Blob，且内容不为空

BlobChangeSpecial：元素为 Blob，且内容不为空

BlobChangeToNull：元素为 Blob，且内容不为空

BlobExpandAllRandom：元素为 Blob

BlobExpandSingleIncrementing：元素为 Blob

BlobExpandSingleRandom：元素为 Blob

BlobExpandZero：元素为 Blob

BlobReduce：元素为 Blob，且内容不为空

ChoiceSwitch：元素为 Choice，选项大于 1

DataElementBitFlipper：所有元素，内容不为空

DataElementDuplicate：元素不为 Choice、Flag，内容不为空

DataElementRemove：元素不为 Choice、Flag，父元素不为空

DataElementSwapNear：元素不为 Flag，下一个元素存在，父元素不为空

DoubleEdgeCase：hint 为 NumericalString 的字符串；长度为 32 或 64 的 Double

DoubleRandom：hint 为 NumericalString 的字符串；长度为 32 或 64 的 Double

DoubleVariance：hint 为 NumericalString 的字符串；不为 nan 和 inf 的 Double

ExtraValues：hint 为 ExtraValues 的 String、Number、Blob

NumberEdgeCase：hint 为 NumericalString 的字符串；长度大于 8 bit 的 Number

NumberRandom：hint 为 NumericalString 的字符串；长度大于 8 bit 的 Number

NumberVariance：hint 为 NumericalString 的字符串；Number

SampleNinja：需要定义 ninja db

SizedDataEdgeCase：拥有 size Relation 的元素

SizedDataVariance：拥有 size Relation 的元素

SizedEdgeCase：拥有 size Relation 的元素

SizedVariance：拥有 size Relation 的元素

StringAsciiRandom：元素为字符串

StringCaseLower：元素为字符串且包含大写字符

StringCaseRandom：元素为字符串且不能全为大写或小写字符

StringCaseUpper：元素为字符串且包含小写字符

StringLengthEdgeCase：元素为字符串

StringLengthVariance：元素为字符串

StringList：元素为字符串，hint 为 StringList

StringSqlInjection：元素为字符串

StringStatic：元素为字符串

StringUnicodeAbstractCharacters：元素为字符串且不为 ascii 编码

StringUnicodeFormatCharacters：元素为字符串且不为 ascii 编码

StringUnicodeInvalid：元素为字符串且不为 ascii 编码

StringUnicodeNonCharacters：元素为字符串且不为 ascii 编码

StringUnicodePlane0：元素为字符串且不为 ascii 编码

StringUnicodePlane1：元素为字符串且不为 ascii 编码

StringUnicodePlane14：元素为字符串且不为 ascii 编码

StringUnicodePlane15And16：元素为字符串且不为 ascii 编码

StringUnicodePlane2：元素为字符串且不为 ascii 编码

StringUnicodePrivateUseArea：元素为字符串且不为 ascii 编码

StringUtf16BomLength：元素为字符串且不为 ascii 编码，hint 为 TypeTransform

StringUtf16BomStatic：元素为字符串且不为 ascii 编码，hint 为 TypeTransform

StringUtf32BomLength：元素为字符串且不为 ascii 编码，hint 为 TypeTransform

StringUtf32BomStatic：元素为字符串且不为 ascii 编码，hint 为 TypeTransform

StringUtf8BomLength：元素为字符串，hint 为 TypeTransform

StringUtf8BomStatic：元素为字符串，hint 为 TypeTransform

StringUtf8ExtraBytes：元素为字符串，hint 为 TypeTransform，元素内容不为空

StringUtf8Invalid：元素为字符串，hint 为 TypeTransform，元素内容不为空

变异策略（Strategy）

多进程与非确定性变异策略，无法计数。

Sequential

对于所有mutable为true的元素（包括DataModel和Block），依次使用所有变异器和变异器返回的结果，每次只变异一个元素。（如某个变异器返回的结果为1-255所有的整数，变异器结果会按顺序返回）

RandomStrategy

对于所有mutable为true的元素（包括DataModel和Block），随机选择最多N个元素进行变异（默认N为6，），每个需要变异的元素随机使用变异器和变异器返回的结果。最多变异元素的定义如下：

RandomDeterministicStrategy

对于所有mutable为true的元素（包括DataModel和Block），随机使用所有变异器，依次使用所有变异器返回的结果，每次只变异一个元素。

实用技巧

●

运行peach时加上—debug可以打印出发送的数据包。

●

运行peach时加上—seed 123可以指定seed，让多次运行时Random策略每次变异的元素和选择的变异器相同，便于复现问题。

与 boofuzz 对比

peach 中提供了较多的标签用于对文件格式进行模糊测试。本文仅比较网络模糊测试。

变异器

peach 的变异器更多一点。但是，个人觉得对于黑盒模糊测试，两者变异器差距不大。

变异策略

●

boofuzz 只有默认的变异策略。虽然 boofuzz 通过组合的方式，遍历所有可能的变异器组合，但是效率较低。

●

peach 支持Sequential、Random、RandomDeterministic 3种变异策略。Random 支持同时对多个元素进行变异，效率较高。

数据定义

●

boofuzz使用函数调用的方式定义数据。

●

peach使用xml定义数据比较方便和直观。

状态定义

●

boofuzz 中状态定义和状态之间的关系直接connect就行。

●

peach 提供了State和Action标签，但相关文档较少，暂不清楚如何使用。

自定义函数

●

boofuzz 基于Python开发的，自定义函数使用的是Python的数据结构，比较方便。

●

peach 基于C#开发，自定义函数需要先通过C#函数进行类型转换。

结果查看

●

boofuzz 会将每次 fuzz 的日志以 sqlite 数据库的形式存储在当前目录下，可以使用命令

boo open xxx.db

打开网页进行查看。

●

peach需要实时抓包查看。

总结

●

对于单一状态的网络模糊测试，建议使用peach。

●

对于多状态或需要自定义函数的网络模糊测试，建议使用boofuzz。