1
0
out-of-tree kernel {module, exploit} development tool
Go to file
2021-01-05 20:52:27 +00:00
.github/workflows Remove donate 2020-12-16 16:46:25 +00:00
config adding TestFiles to artifact config, transfers extra test files to VM 2020-09-15 12:57:11 +02:00
docs Move build from source to documentation 2019-12-27 08:38:47 +00:00
examples Use upstream lkrg 2021-01-05 20:52:27 +00:00
qemu Update bootstrap scripts to Ubuntu 20.04 2020-05-30 11:37:00 +00:00
tools CentOS 8 image generator 2020-05-30 13:42:47 +00:00
.gitignore Remove snap support 2018-12-02 15:33:13 +00:00
CHANGELOG.md Bump version 2020-06-14 21:03:12 +00:00
db.go Show last log if no ID specified 2020-06-14 20:46:56 +00:00
debug.go adding TestFiles to artifact config, transfers extra test files to VM 2020-09-15 12:57:11 +02:00
gen.go Implements modules preload list 2020-06-14 20:14:59 +00:00
go.mod Implements modules preload list 2020-06-14 20:14:59 +00:00
go.sum Implements modules preload list 2020-06-14 20:14:59 +00:00
images.config.go Remove bootstrap, download images on-demand 2019-08-20 09:09:38 +00:00
images.go Remove bootstrap, download images on-demand 2019-08-20 09:09:38 +00:00
kernel_linux.go Exclude host kernel generation for macOS 2019-08-31 08:05:43 +00:00
kernel_macos.go Exclude host kernel generation for macOS 2019-08-31 08:05:43 +00:00
kernel.go Workaround for CentOS 8 Vault repos 2020-05-30 14:13:03 +00:00
LICENSE Change license to GNU AGPLv3 2018-10-08 20:54:18 +00:00
log.go Show last log if no ID specified 2020-06-14 20:46:56 +00:00
main.go Bump version 2020-06-14 21:03:12 +00:00
pack.go Add flag for verbose output 2019-11-14 15:38:16 +00:00
pew_test.go Use go timers for kill docker by timeout, fixes #12 2018-12-08 02:53:29 +00:00
pew.go adding TestFiles to artifact config, transfers extra test files to VM 2020-09-15 12:57:11 +02:00
preload.go Implements modules preload list 2020-06-14 20:14:59 +00:00
README.md Follow redirect 2020-06-18 15:22:35 +00:00

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.