Skip to content

Latest commit

 

History

History
226 lines (165 loc) · 7.18 KB

README.md

File metadata and controls

226 lines (165 loc) · 7.18 KB

Linux Kernel Security Lab (KSL)

当前稳定版本:1.0.0

KSL 是面向 Linux kernel 漏洞复现、根因分析、补丁验证和漏洞挖掘的长期实验平台。整体命令与 Android Security Research Lab 保持一致;Android Repo/AOSP 部分替换为普通 Git 与 Linux Kbuild,并额外提供 QEMU 模拟命令。

支持基线

  • 已完成端到端验证:Linux 6.6.45、x86_64、BusyBox initramfs、QEMU TCG、KASAN/KCOV 和 9p 共享;
  • 已提供构建与 QEMU 参数支持但尚未列入 1.0 完整验证基线:arm64;
  • 自动依赖安装主要面向 Debian/Ubuntu,其他发行版可按 lab doctor 结果手工安装。

完整的安装、命令参考、QEMU/9p/GDB、CTF 研究流程和故障排查见 KSL 详细使用手册。

版本变更记录见 CHANGELOG.md。

未来候选增强、版本方向和需求评估标准见 ROADMAP.md。

命令

lab help
lab version
lab doctor
lab bootstrap [plan|--apply]
lab workspace <list|add|use|current|status|init>
lab source <status|clone|update|branch|patch>
lab build [status]
lab emulate
lab research <list|create|status>

所有可能安装软件、访问网络、修改 Git 状态、编译或启动 VM 的主要操作默认只显示计划,需要显式 --apply。status、列表、patch 导出和 research case 创建等目标本身明确的本地操作直接执行。

完整流程

./scripts/build-go.sh
./bin/lab doctor
./bin/lab bootstrap plan
# 如需由 Lab 安装缺失的 Debian/Ubuntu 依赖:
# ./bin/lab bootstrap --apply

./bin/lab workspace add linux-6.6 \
  --path /data/kernel/linux-6.6 \
  --url https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git \
  --ref v6.6.45 \
  --arch x86_64 \
  --defconfig defconfig \
  --config config/kernel/security-research.config \
  --rootfs "$PWD/images/rootfs.cpio.gz"

./bin/lab source clone --workspace linux-6.6 --depth 1
./bin/lab source clone --workspace linux-6.6 --depth 1 --apply
./bin/lab source status --workspace linux-6.6

./bin/lab build config --workspace linux-6.6
./bin/lab build config --workspace linux-6.6 --apply

./bin/lab build --workspace linux-6.6
./bin/lab build --workspace linux-6.6 --jobs 16 --apply

./scripts/build-rootfs.sh
./scripts/smoke-test.sh linux-6.6

./bin/lab emulate --workspace linux-6.6 --no-network
./bin/lab emulate --workspace linux-6.6 --no-network --apply

./bin/lab research create ctf-example \
  --workspace linux-6.6 \
  --title "Example kernel CTF challenge"

配置生成与编译是两个独立阶段。先运行 lab build config --apply 生成并审计 .config,人工核查后再运行 lab build --apply;编译阶段不会隐式修改配置。

需要 GDB 调试时,使用以下命令启动。--gdb 会让 CPU 在第一条指令前暂停,需在 另一个终端连接 tcp::1234 后执行 continue:

./bin/lab emulate --workspace linux-6.6 --no-network --gdb
./bin/lab emulate --workspace linux-6.6 --no-network --gdb --apply

Workspace

每个 profile 表示一份 kernel checkout:

字段 含义
--path Linux 源码绝对路径
--url / --ref Git remote 与 branch/tag/commit-ish
--arch x86_64 或 arm64
--defconfig 初始 Kbuild 配置目标
--config 可选的标准 Kconfig fragment;同时支持 CONFIG_X=y 和 # CONFIG_X is not set
--cross-compile 交叉编译器前缀
--out 独立的 O= 输出目录
--rootfs QEMU 默认 rootfs/initramfs

profile 保存在被 Git 忽略的 config/workspaces/*.conf,活动选择保存在 .local/active-workspace。

最小 rootfs

宿主安装静态链接的 BusyBox 后,可重复生成用于 QEMU 的最小 initramfs:

./scripts/build-rootfs.sh

默认输出为被 Git 忽略的 images/rootfs.cpio.gz。可将输出路径作为第一个参数传入, 也可通过 BUSYBOX=/path/to/busybox 指定静态 BusyBox。自动启动冒烟测试使用:

./scripts/smoke-test.sh linux-6.6

脚本默认限制为 120 秒,可通过 KSL_SMOKE_TIMEOUT 调整,并将完整日志保存到 output/emulate/<workspace>/。看到 KSL_BOOT_OK 后,虚拟机会自动关机;不添加 ksl.smoke=1 时进入交互 shell。

传入第二个参数可同时验证 9p 共享目录;initramfs 会自动将其挂载到 /mnt/host:

mkdir -p poc-share
./scripts/smoke-test.sh linux-6.6 "$PWD/poc-share"

每次使用 --apply 启动后,Lab 会在 output/emulate/<workspace>/ 保存完整串口日志、 带时间戳的 JSON 元数据和 latest.json。元数据包含镜像 SHA-256、QEMU 版本、内核 命令行、网络与共享设置以及退出状态。

lab emulate status --workspace linux-6.6

已有 workspace 可以绑定或清除 fragment:

lab workspace config linux-6.6 --set config/kernel/security-research.config
lab workspace config linux-6.6
lab workspace config linux-6.6 --clear

可复现 Kernel 配置

默认的配置生成流水线是 defconfig → fragment → olddefconfig → 逐项审计:

lab build config --workspace linux-6.6
lab build config --workspace linux-6.6 --apply

fragment 使用 Linux .config 格式:

CONFIG_KASAN=y
CONFIG_KCOV=y
# CONFIG_RANDOMIZE_BASE is not set

olddefconfig 解析依赖后,Lab 会对照最终 .config;任何请求未生效都会列出并 返回失败,生成的文件仍会保留以便核查。也可以临时覆盖 workspace fragment:

lab build config --fragment /path/to/case.config --apply

传统 Kbuild 配置方式继续保留:

lab build config defconfig --apply
lab build config olddefconfig --apply
lab build config menuconfig --apply

核查 /home/.../out/<workspace>/.config 符合预期后才编译:

lab build --workspace linux-6.6 --jobs "$(nproc)" --apply

Kernel source(Git)

Linux kernel 使用普通 Git,不需要 Android repo。正式入口是 lab source;旧的 lab repo 暂时作为兼容别名保留:

lab source update                         # fetch/checkout plan
lab source update --apply
lab source branch list
lab source branch create slab-uaf --apply
lab source patch export --commits 2
lab source patch import --file fix.patch          # check only
lab source patch import --file fix.patch --apply

QEMU 模拟参数

emulate --workspace 会自动使用 profile 架构、rootfs 和 build 输出的 bzImage/Image。也可手工指定 --kernel、--rootfs、--arch、--memory、--smp、--cpu、--append、--kvm、--gdb、--no-network、--forward、--share、--extra、--qemu 和 --config。

研究流程与建议的调试配置见 docs/workflow.md。

目录

cmd/ internal/        Go CLI 与领域模块
config/workspaces/    本机 kernel profiles(忽略)
images/               rootfs/initramfs(大文件忽略)
research/             长期保留的研究 case
output/               build、Git 和运行日志
docs/                 流程文档
tests/                自动化测试

开发验证

go test ./...
go vet ./...
sh -n scripts/*.sh

License

本项目使用 MIT License。