【开源软件供应链点亮计划】Qemu Fuzzer学习
Qemu Fuzzer 学习
本文章来自于开源软件供应链点亮计划的 openEuler 社区项目 项目名称：No.112 qemu 设备 fuzz 测试完善
前言
一提到 Qemu + Fuzz 的组合，我首先想起的是 AFL 的 Qemu 模式，或者是各种使用虚拟化技术对 IoT 设备进行 Fuzzing 的工具。
而本文学习的是 Qemu 自身的 Fuzzing 框架，即对 Hypervisor 的 Fuzzing。它借助 Qtest 框架模拟 Guest OS 对设备的读写，并使用 LibFuzzer 的启发式算法提供数据驱动。该框架最早源于Google Summer of Code 2019项目，在 Qemu5.0.0 版本后被加入到 master 分支中。
Qemu 设备模拟原理
Qemu是一款开源的虚拟化和仿真工具，由Fabrice Bellard实现。Qemu 支持两种模式的仿真：
system mode：对于 CPU，内存以及外设的全系统仿真，提供 KVM，Hyper-V 等加速方式user mode：通过指令翻译在一种架构的 CPU 上运行另一种 CPU 架构的二进制程序
首先需要理解虚拟化的本质在于：使用一个用户态的程序，在只使用用户态内存的情况下，来处理模拟设备对内存以及其他特殊硬件的访问。由于 Qemu 需要仿真不同架构，不同指令集的设备，所以其采用了 OOP 的编程思想，实现了Qemu Object Model来描述设备模型。
- 设备模型：每个模拟出来的设备都对应一个 TypeInfo 对象，由设备名唯一标识，并存储在 hash table 中
- 设备启动：启动设备需要经过设备注册，设备类型初始化，设备实例化等步骤，
- 指令翻译：真正运行时，Qemu 通过 TCG（软件）或者 KVM（硬件）等方式，接受模拟设备的指令，并翻译到物理设备上执行。这样会带来性能开销，相比起来硬件虚拟化带来的开销更低
- 内存模拟：Qemu 负责提供内存映射给客户机。当客户机访问这部分内存以便写磁盘时，Qemu 会捕获访问，并且将请求传送给 qemu 的 IDE 控制器设备模型，模型会解析 I/O 请求并且通过宿主机的系统调用来模拟指令。最终将客户机的内存拷贝至宿主机的磁盘中。
总之，在 Guest OS 中，它认为自己可以直接和 Host OS 上的硬件设备打交道，Qemu 充当了中间人的角色，可以用下图来概括：
+----------+ +----------+ +----------+ +----------+ +----------+
| UserSpace| | UserSpace| | UserSpace| | UserSpace| | UserSpace|
+----------+ +----------+ +----------+ +----------+ +----------+
| Linux | | Mac OS | | Windows | | Linux | | Solaris |
+----------+ +----------+ +----------+ +----------+ +----------+
| Drivers | | Drivers | | Drivers | | Drivers | | Drivers |
+----------+ +----------+ +----------+ +----------+ +----------+
+----------+ +----------+ +----------+ +----------+ +----------+
| QEMU x86 | | QEMU x86 | | QEMU ARM | | QEMU PPC | | QEMU MIPS|
+----------+ +----------+ +----------+ +----------+ +----------+
+----------+-+----------+-+----------+-+----------+-+----------+
| Host System:Linux,Mac OS,Windows |
+--------------------------------------------------------------+
+--------------------------------------------------------------+
| Hardware:CPU,memory,disk,networking,USB,etc |
+--------------------------------------------------------------+关于 Qemu 设备模拟的方法，可以参考~~
User Documentation LLVMFuzzerTestOneInput~~ 关于 Qemu 设备模拟的理解，可以参考understanding Qemu devicesQemu 作者的论文：QEMU, a Fast and Portable Dynamic Translator
Qemu Fuzzer 的使用方法
实验环境
采用了本机的 WSL 上的 Docker 环境
root@31b23c4c00b7:~/qemu# lscpu
Architecture: x86_64
CPU op-mode(s): 32-bit, 64-bit
Byte Order: Little Endian
CPU(s): 16
root@31b23c4c00b7:~/qemu# cat /etc/os-release
NAME="Ubuntu"
VERSION="20.04.2 LTS (Focal Fossa)"环境问题
- 描述：Qemu 的 Fuzzing 还没有适配 AArch64 架构，虽然编译成功，但运行报错。
- 解决方案：适配 AArch64 下的 Qemu Fuzzing 正是本项目要做的内容，但在学习阶段，还是采用 x86 环境来运行。
版本问题
描述：官网给出的示例使用的是 clang-8，而最新的 clang 版本已经来到了 clang-14，如果采用较新的版本，则会在编译阶段报错（原因为开启了 Werror）。
解决方案：
- （推荐）直接采用包管理器（apt/dnf）安装 clang
- git checkout 到 LLVM8-10 之间的版本
- 到官方 Release 页面下载 LLVM8-10 之间版本的源代码
# sudo apt/dnf search xxx 可以查看包管理器中包含的软件以及对应版本，默认为clang-10
sudo apt/dnf install clang llvm compiler-rtDocker 打包
为了方便部署，采用了 docker 的形式来配置实验环境：镜像地址。
简单使用
配置好环境后，通过如下命令编译运行 Fuzzing 程序，即显示 LibFuzzer 的输出。
CC=clang-10 CXX=clang++-10 ./configure --enable-sanitizers --enable-fuzzing
# qemu-fuzz-isa isa为模拟设备的架构
make qemu-fuzz-i386 qemu-fuzz-aarch64
# 查看可用的Fuzzing对象
build/qemu-fuzz-i386 --fuzz-target=FUZZ_NAME除了上述命令外，Qemu Fuzzer 还支持 LibFuzzer 的编译指令，可以通过-help=1来查看
对于 Fuzzing 的结果，可以考虑采用Clang Sanitizer查看。该工具需要使用 CORPUS 参数，并对编译指令进行一定的修改。在 Fuzzing 结束后，通过llvm-cov命令将生成的default.profraw文件转化为.html的可视化文件。
添加自定义 Fuzzer
添加一个新的 Fuzzer 需要以下三个步骤：
- 编写 Fuzzer 源文件
foo-device-fuzz.c，放在tests/qtest/fuzz目录下 - 参考已有的 Fuzzer，使用 libqos 和 libqtest 中的 API 与模拟设备通信
- 在
tests/qtest/fuzz/meson.build文件中注册该 Fuzzer
通用 Fuzzer
为某些特定的设备类型写 Fuzzer 是非常费时费力的事情，尤其是那些 libqos 并没有包含的设备驱动。Qemu 提供了generic-fuzz的选项，用于对所有设备进行初步的 Fuzzing，包括设备的 PIO，MMIO 和 DMA。如果要启用 generic-fuzz，至少需要设置以下两个环境变量：
QEMU_FUZZ_ARGS=：配置设备所需要的参数，比如网卡，用户名QEMU_FUZZ_OBJECTS=：采用字符串匹配的方式来指定 Fuzzing 的内存区域。可以用./qemu-fuzz-i386 --fuzz-target=generic-fuzz -runs=0来检查匹配到的内存区域。如果匹配到的内存区域越多，Fuzzing 的input-space就越大，越难发现导致该设备 crash 的输入，所以MemoryRegion的选取要适度。
集成 OSS-Fuzz
OSS-Fuzz 是集成式的 Fuzzing 工具，它默认对所有的对象进行 Fuzz。由于通用 Fuzzer 的启动需要额外对环境变量进行设置，所以 Qemu 在tests/qtest/fuzz/generic_fuzz_configs.h文件中自定义了一些设备类型，用于 OSS-Fuzz。开发者可以在该文件中添加新的设备类型，官方也提供了用于搭建环境的Dockerfile。
crash 复现工具
当复现 crash 的时候，需要不包含 Fuzzer 的 Qemu，这样可以过滤调误报，并增强调试功能。可以使用 OSS-Fuzz 的脚本来创建一个one-line reproducer。
Fuzzer 生命周期
Qemu Fuzzer 为 LibFuzzer 提供了两处入口点，在 LibFuzzer 自己的 main 函数之后调用：
LLVMFuzzerInitialize：Fuzzing 开始前调用，初始化环境LLVMFuzzerTestOneInput：每个 Fuzzing 任务运行时调用，提供输入并在 Fuzzing 结束后重置状态
因为 Fuzzer 的进程会在每次 Fuzzing 运行后被重置（reset），所以 Qemu 的状态也需要重置，有两种方法来实现重置，各有优劣。
Reboot：在每次运行之间重启 Guest OSFork：在子进程中运行 test case，和 AFL 的fork-server模式很相似
Qemu Fuzzer 的依赖库
Qemu Fuzzer 实现主要依赖的是 libqtest 和 libqos 两个库，它们的关系可以参考Testing QEMU emulated devices using qtest，这篇文章介绍了 qtest 的基本原理，提供的 API 函数，并给出了添加 testcase 的方法。
libqtest
Qtest 是一个用于对 Qemu 模拟出的硬件设备做单元测试的框架，它由Qtest Client，Qtest Server两部分组成。两者之间通过 UNIX Socket 通信，支持 PIO，MMIO，中断，QMP 等指令。
Qtest Client：它是为某个设备编写的驱动程序，按照自底向上的封装顺序，它依赖于 glib 单元测试框架，libqtest，libqos 和 qgraph。如果需要添加新的测试程序，需要如下四个步骤：- 在 Qtest 目录下编写新的测试代码
tests/qtest/foo-test.c - 在 Makefile.include 中添加编译指令
- 编译：
make tests/qtest/foo-test.c - 运行：
bashQTEST_LOG=1 QTEST_QEMU_BINARY=i386-softmmu/qemu-system-i386 tests/qtest/foo-test`- 在 Qtest 目录下编写新的测试代码
Qtest Server：它和 TCG，KVM 的功能类似，是一种加速器（accelerator），通过编译指令-machine accel=qtest注册。在普通的使用场景中，VCPU 直接和虚拟硬件交互；而测试场景中，Qtest 直接和虚拟硬件交互，充当了 Qtest Client 和虚拟硬件的中间角色。Qtest 用于验证设备的行为是否正确，实际上并没有启动 Guest OS。
运行时，libqtest.c将启动 Qemu 为子进程。Qemu 的启动主函数在vl.c中，在测试场景中，调用qtest.c的qtest_init()函数，初始化 Qtest Server。
两者的关系可以用下图表示：
+----------------+ socket +----------------+----------------------+
| Qtest Client +----------> Qtest Server | |
+----------------+ +-------+--------+ |
+----------------+ | | Qemu |
| Qgraph | PIO|MMIO | |
+----------------+ | | |
+----------------+ +-------v--------+----------------------+
| libqos | | Hardware Emulation |
+----------------+ +---------------------------------------+
+----------------+
| libqtest |
+----------------+
+----------------+
| glib test |
+----------------+libqos
libqos 是用于编写 qtest case 的设备驱动框架，提供了关于memory，PCI，virtio的 API 函数。它的功能主要有以下两个：
- 相当于总线的 wrapper，为每类总线都实现了特定的函数
- 统一了设备访问的模型，简化了开发者的工作
Qemu Fuzzer 的整体流程
以上的两个依赖库都是为 Qemu 的功能性测试设计，依赖于测试输入的选取。而 Fuzzing 正是通过对输入增加随机性和变异算法来提高测试输入的质量。从而可以使用 LibFuzzer 对 Qtest 的输入进行 HOOK，提高 Qtest 的测试效率。综上所述，Qemu Fuzzer 的整体结构如图所示。
从源代码的角度来看：
fuzz.h：定义了实现一个 Fuzz Target 用到的接口和数据结构，以及与 LibFuzzer 之间的交互fork_fuzz.h：定义了并发 Fuzzer 之间的共享内存qos_fuzz.h：定义了 libqos 在 qtest 上的进一步封装的接口generic_fuzz_configs.h：定义了通用的 Fuzzer 设置virtio_xxx_fuzz.h：实现了 virtio 设备（net，blk，scsi）的 Fuzz Target
Qemu Fuzzer 的用例分析
Qemu 的Developer documentation中写道：
QEMU does not have a high level design description document - only the source code tells the full story.
所以作为 Qemu 的开发者，阅读源码非常关键。本节以 virtio-net 设备为例，分析 Qemu Fuzzing 的流程，代码路径为tests/qtest/fuzz/virto_net_fuzz.c。virtio 是一种半虚拟化的技术，需要 Host OS 提供对设备的 emulation，Guest OS 负责对设备的驱动。工作模式如下图所示：
实现方面，以自顶向下的逻辑进行说明：
- 首先，实现注册函数
register_virtio_net_fuzz_targets()。使用 libqos 提供的fuzz_add_qos_target()函数添加了三个 Fuzzing 对象。该函数是 libqos 对于fuzz_add_target()函数的 wrapper，其原型如下：
void fuzz_add_qos_target(
FuzzTarget *fuzz_opts,
const char *interface,
QOSGraphTestOptions *opts
);- 最后，修改
meson.build文件，添加条件编译选项。
接下来，以virtio-net-socket为主，对 Fuzzing 对象的参数以及参数中涉及到的函数进行分析
virtio-net-socket：
fuzz_add_qos_target(&(FuzzTarget){
.name = "virtio-net-socket",
.description = "Fuzz the virtio-net virtual queues. Fuzz incoming "
"traffic using the socket backend",
.pre_fuzz = &virtio_net_pre_fuzz,
.fuzz = virtio_net_fork_fuzz,},
"virtio-net",
&(QOSGraphTestOptions){.before = virtio_net_test_setup_socket}
);第一个参数为指向 FuzzTarget 的临时对象的指针。该对象由fuzz.h定义，含标识信息和许多与 Fuzzing 特性相关的回调函数。介绍如下：
+-------------+-----------------------------------------------------------+-------------------------------------------------------------------------+
| Field | Declaration | Description |
+-------------+-----------------------------------------------------------+-------------------------------------------------------------------------+
| name | const char *name | target identifier (passed to --fuzz-target=) |
+-------------+-----------------------------------------------------------+-------------------------------------------------------------------------+
| description | const char *description | help text |
+-------------+-----------------------------------------------------------+-------------------------------------------------------------------------+
| pre_fuzz | void(*pre_fuzz)(QTestState *) | will run once, after QEMU has been initialized, prior to the fuzz-loop. |
| | | eg: detect the memory map |
| | | Can be NULL |
+-------------+-----------------------------------------------------------+-------------------------------------------------------------------------+
| fuzz | void(*fuzz)(QTestState *, const unsigned char *, size_t); | accepts and executes an input from LibFuzzer. |
| | | this is repeatedly executed during the fuzzing loop. |
| | | Its should handle setup, input execution and cleanup. |
| | | Cannot be NULL |
+-------------+-----------------------------------------------------------+-------------------------------------------------------------------------+其中，virtio_net_pre_fuzz初始化了 qos path 和 fork fuzz 用到的共享内存。virtio_net_fork_fuzz首先 fork 出子进程，并调用virtio_net_fuzz_multi函数。该函数用自定义的vq_action来管理随机数据，根据数据包到来情况，将其加入virtioqueue中，并 kick out 出去。随后运行主循环。
第二个参数表示使用的设备接口名称，这里统一为 virtio-net。
第三个参数为qgraph.h提供的关于测试选项的结构体。其中before参数接受原型为QOSBeforeTest的函数。virtio_net_test_setup_socket函数指定了 Qemu 网络设备的后端为 socket。它负责和虚拟设备通信，并将虚拟设备的数据包发送到宿主机的网络设备中。
virtio-net-socket-check-use
fuzz_add_qos_target(&(FuzzTarget){
.name = "virtio-net-socket-check-used",
.description = "Fuzz the virtio-net virtual queues. Wait for the "
"descriptors to be used. Timeout may indicate improperly handled "
"input",
.pre_fuzz = &virtio_net_pre_fuzz,
.fuzz = virtio_net_fork_fuzz_check_used,},
"virtio-net",
&(QOSGraphTestOptions){.before = virtio_net_test_setup_socket}
);virtio_net_fork_fuzz_check_used和virtio_net_fork_fuzz非常相似，不同之处在于调用virtio_net_fuzz_multi函数的时候使用了true。
cirtio-net-slirp
fuzz_add_qos_target(&(FuzzTarget){
.name = "virtio-net-slirp",
.description = "Fuzz the virtio-net virtual queues with the slirp "
" backend. Warning: May result in network traffic emitted from the "
" process. Run in an isolated network environment.",
.pre_fuzz = &virtio_net_pre_fuzz,
.fuzz = virtio_net_fork_fuzz,},
"virtio-net",
&(QOSGraphTestOptions){.before = virtio_net_test_setup_user}
);virtio_net_test_setup_user指定了网络后端的类型为 user
Qemu Fuzzer 案例 CVE-2017-12809
最后，简要分析一个由 LibFuzzer 发现的 Qemu 上的 CVE 漏洞。
- 漏洞描述：该漏洞属于拒绝服务类。当通过 IDE 硬盘和 CD/DVD-ROM 模拟器来构建 Guest OS 时，Guest OS 中的特权用户可以通过清除一个空的 CDROM 设备驱动，造成空指针解引用，进而导致 Qemu 进程崩溃。
- 漏洞代码： 在
hw/ide/core.c文件中调用blk_aio_flush()函数前没有检查s->blk是否为空
---
hw/ide/core.c | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/hw/ide/core.c b/hw/ide/core.c
index 0b48b64d3a..bea39536b0 100644
--- a/hw/ide/core.c
+++ b/hw/ide/core.c
@@ -1063,7 +1063,15 @@ static void ide_flush_cache(IDEState *s)
s->status |= BUSY_STAT;
ide_set_retry(s);
block_acct_start(blk_get_stats(s->blk), &s->acct, 0, BLOCK_ACCT_FLUSH);
- s->pio_aiocb = blk_aio_flush(s->blk, ide_flush_cb, s);
+
+ if (blk_bs(s->blk)) {
+ s->pio_aiocb = blk_aio_flush(s->blk, ide_flush_cb, s);
+ } else {
+ /* XXX blk_aio_flush() crashes when blk_bs(blk) is NULL, remove this
+ * temporary workaround when blk_aio_*() functions handle NULL blk_bs.
+ */
+ ide_flush_cb(s, 0);
+ }
}
static void ide_cfata_metadata_inquiry(IDEState *s)
--- 漏洞修复：除了在漏洞发生部分增加条件判断以外，还在
tests/ide-test.c中增加了测试代码
---
tests/ide-test.c | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)
diff --git a/tests/ide-test.c b/tests/ide-test.c
index bfd79ddbdc..aa9de065fc 100644
--- a/tests/ide-test.c
+++ b/tests/ide-test.c
@@ -689,6 +689,24 @@ static void test_flush_nodev(void)
ide_test_quit();
}
+static void test_flush_empty_drive(void)
+{
+ QPCIDevice *dev;
+ QPCIBar bmdma_bar, ide_bar;
+
+ ide_test_start("-device ide-cd,bus=ide.0");
+ dev = get_pci_device(&bmdma_bar, &ide_bar);
+
+ /* FLUSH CACHE command on device 0 */
+ qpci_io_writeb(dev, ide_bar, reg_device, 0);
+ qpci_io_writeb(dev, ide_bar, reg_command, CMD_FLUSH_CACHE);
+
+ /* Just testing that qemu doesn't crash... */
+
+ free_pci_device(dev);
+ ide_test_quit();
+}
+
static void test_pci_retry_flush(void)
{
test_retry_flush("pc");
@@ -954,6 +972,7 @@ int main(int argc, char **argv)
qtest_add_func("/ide/flush", test_flush);
qtest_a
cd qemu
git checkout stable-2.10dd_func("/ide/flush/nodev", test_flush_nodev);
+ qtest_add_func("/ide/flush/empty_drive", test_flush_empty_drive);
qtest_add_func("/ide/flush/retry_pci", test_pci_retry_flush);
qtest_add_func("/ide/flush/retry_isa", test_isa_retry_flush);
--- 漏洞复现：找到 patch 前的 commit 版本，加上新增 test 中的测试用例，运行 qtest 程序：
# 不能直接wget对应的release版本，因为受影响的版本都被修复了
git clone https://gitlab.com/qemu-project/qemu.git;cd qemu
git checkout stable-2.10
# 从mailing list中获取patch的作者，找对应的commit
git log --author=Hajnoczi
git reset --hard=4da97120d51a4383aa96d741a2b837f8c4bbcd0b
# 构建
mkdir build;cd build;../configure ----disable-werror
make qtest其实 Qemu 虚拟机逃逸漏洞已经常见于 CTF 比赛和 CVE 中了，比如知名的CVE-2020-14364
有错误之处请批评指正，作者联系方式：cascades-sjtu
