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() 5b0bf7de01
Bump version
пре 2 година
.github/workflows GitHub Actions: Use latest stable nixpkgs channel пре 2 година
config Implements modules preload list пре 2 година
docs Move build from source to documentation пре 2 година
examples Implements modules preload list пре 2 година
qemu Update bootstrap scripts to Ubuntu 20.04 пре 2 година
tools CentOS 8 image generator пре 2 година
.gitignore Remove snap support пре 3 година
CHANGELOG.md Bump version пре 2 година
LICENSE Change license to GNU AGPLv3 пре 3 година
README.md Update readme пре 2 година
db.go Show last log if no ID specified пре 2 година
debug.go Implements modules preload list пре 2 година
gen.go Implements modules preload list пре 2 година
go.mod Implements modules preload list пре 2 година
go.sum Implements modules preload list пре 2 година
images.config.go Remove bootstrap, download images on-demand пре 2 година
images.go Remove bootstrap, download images on-demand пре 2 година
kernel.go Workaround for CentOS 8 Vault repos пре 2 година
kernel_linux.go Exclude host kernel generation for macOS пре 2 година
kernel_macos.go Exclude host kernel generation for macOS пре 2 година
log.go Show last log if no ID specified пре 2 година
main.go Bump version пре 2 година
pack.go Add flag for verbose output пре 2 година
pew.go Implements modules preload list пре 2 година
pew_test.go Use go timers for kill docker by timeout, fixes #12 пре 3 година
preload.go Implements modules preload list пре 2 година

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 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.