out-of-tree kernel {module, exploit} development tool
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
dump_stack() 90829e2409
Follow redirect
2 週之前
.github/workflows Update donate.yml 2 週之前
config Implements modules preload list 3 週之前
docs Move build from source to documentation 6 月之前
examples Implements modules preload list 3 週之前
qemu Update bootstrap scripts to Ubuntu 20.04 1 月之前
tools CentOS 8 image generator 1 月之前
.gitignore Remove snap support 1 年之前
CHANGELOG.md Bump version 3 週之前
LICENSE Change license to GNU AGPLv3 1 年之前
README.md Follow redirect 2 週之前
db.go Show last log if no ID specified 3 週之前
debug.go Implements modules preload list 3 週之前
gen.go Implements modules preload list 3 週之前
go.mod Implements modules preload list 3 週之前
go.sum Implements modules preload list 3 週之前
images.config.go Remove bootstrap, download images on-demand 10 月之前
images.go Remove bootstrap, download images on-demand 10 月之前
kernel.go Workaround for CentOS 8 Vault repos 1 月之前
kernel_linux.go Exclude host kernel generation for macOS 10 月之前
kernel_macos.go Exclude host kernel generation for macOS 10 月之前
log.go Show last log if no ID specified 3 週之前
main.go Bump version 3 週之前
pack.go Add flag for verbose output 7 月之前
pew.go Implements modules preload list 3 週之前
pew_test.go Use go timers for kill docker by timeout, fixes #12 1 年之前
preload.go Implements modules preload list 3 週之前

README.md

Codacy Badge Go Report Card Documentation Status Donate Donate

out-of-tree

out-of-tree kernel {module, exploit} development tool

out-of-tree is for automating some routine actions for creating development environments for debugging kernel modules and exploits, generating reliability statistics for exploits, and also provides the ability to easily integrate into CI (Continuous Integration).

Screenshot

Installation

GNU/Linux (with Nix)

$ curl -fsSL https://get.docker.com | sh
$ sudo usermod -aG docker user && newgrp docker
$ curl -L https://nixos.org/nix/install | sh
$ nix-env -iA nixpkgs.out-of-tree

Note that adding a user to group docker has serious security implications. Check Docker documentation for more information.

macOS

$ brew cask install docker
$ open --background -a Docker && sleep 1m
$ brew tap jollheef/repo
$ brew install out-of-tree

Read documentation for further info.

Examples

Run by absolute path

$ out-of-tree --path /path/to/exploit/directory pew

Test only with one kernel:

$ out-of-tree pew --kernel='Ubuntu:5.4.0-29-generic

Run debug environment:

$ out-of-tree debug --kernel='Ubuntu:5.4.0-29-generic

Test binary module/exploit with implicit defined test ($BINARY_test)

$ out-of-tree pew --binary /path/to/exploit

Test binary module/exploit with explicit defined test

$ out-of-tree pew --binary /path/to/exploit --test /path/to/exploit_test

Guess work kernels:

$ out-of-tree pew --guess

Use custom kernels config

$ out-of-tree --kernels /path/to/kernels.toml pew

Generate all kernels

$ out-of-tree kernel genall --distro Ubuntu --ver 20.04

Troubleshooting

If anything happens that you cannot solve -- just remove $HOME/.out-of-tree.

But it’ll be better if you’ll write the bug report.

Development

Read Qemu API.