1
0
out-of-tree kernel {module, exploit} development tool
Go to file
2023-04-05 16:24:45 +00:00
.github/workflows Set debug log level for CI 2023-03-23 15:51:43 +00:00
config Add script artifact type 2023-03-22 20:56:44 +00:00
docs Build with cgo 2023-03-16 18:46:46 +00:00
examples Add script artifact type 2023-03-22 20:56:44 +00:00
qemu Do not use the default known hosts file 2023-03-19 18:00:10 +00:00
tools Switch to Ubuntu 22.04 for testing 2023-01-19 17:22:25 +00:00
.gitignore Ignore binary 2023-01-24 15:12:26 +00:00
CHANGELOG.md Add artifact config flag 2023-02-01 08:04:27 +00:00
container.go Install kernels in mounted volume instead of dockerfile layers 2023-03-22 17:45:56 +00:00
db.go Show last log if no ID specified 2020-06-14 20:46:56 +00:00
debug.go Add script artifact type 2023-03-22 20:56:44 +00:00
gen.go Add support for applying patches 2023-02-16 10:22:08 +00:00
go.mod go mod tidy 2023-04-05 11:51:42 +00:00
go.sum go mod tidy 2023-04-05 11:51:42 +00:00
images.config.go Remove bootstrap, download images on-demand 2019-08-20 09:09:38 +00:00
images.go Add debug logs for exec.Command 2023-03-19 13:14:14 +00:00
kernel_linux.go Add debug logs for exec.Command 2023-03-19 13:14:14 +00:00
kernel_macos.go Exclude host kernel generation for macOS 2019-08-31 08:05:43 +00:00
kernel.go Implements retry for failed kernel installations 2023-04-05 16:24:45 +00:00
LICENSE Change license to GNU AGPLv3 2018-10-08 20:54:18 +00:00
log.go Switch to zerolog 2023-03-18 21:30:07 +00:00
main.go Show file:line only for debug log level 2023-03-22 17:36:04 +00:00
pack.go Do not randomize kernels installation/test order by default 2023-04-05 11:29:31 +00:00
pew.go Do not randomize kernels installation/test order by default 2023-04-05 11:29:31 +00:00
preload.go Switch to zerolog 2023-03-18 21:30:07 +00:00
README.md Switch to Ubuntu 22.04 for testing 2023-01-19 17:22:25 +00:00
shell.nix Add shell.nix 2023-01-19 16:59:25 +00:00

Codacy Badge Go Report Card Documentation Status

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 22.04

Development

Read Qemu API.