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() 1c2ea77920
GitHub Actions: Use latest stable nixpkgs channel
пре 1 месец
.github/workflows GitHub Actions: Use latest stable nixpkgs channel пре 1 месец
config Support custom docker commands пре 7 месеци
docs Move build from source to documentation пре 3 месеци
examples Fix spelling пре 7 месеци
qemu Add timeout after start qemu for tests пре 3 месеци
tools Add policykit-1 to rootfs пре 7 месеци
.gitignore Remove snap support пре 1 година
CHANGELOG.md Bump version пре 3 месеци
LICENSE Change license to GNU AGPLv3 пре 1 година
README.md Add note about docker group пре 3 месеци
db.go Refactor [2] пре 7 месеци
debug.go Fix spelling пре 7 месеци
gen.go Move upstream to code.dumpstack.io пре 1 година
go.mod Generate markdown table statistics for tag пре 7 месеци
go.sum Generate markdown table statistics for tag пре 7 месеци
images.config.go Remove bootstrap, download images on-demand пре 7 месеци
images.go Remove bootstrap, download images on-demand пре 7 месеци
kernel.go Should return if error occured пре 3 месеци
kernel_linux.go Exclude host kernel generation for macOS пре 7 месеци
kernel_macos.go Exclude host kernel generation for macOS пре 7 месеци
log.go Refactor пре 7 месеци
main.go Bump version пре 3 месеци
pack.go Add flag for verbose output пре 4 месеци
pew.go Add flag for verbose output пре 4 месеци
pew_test.go Use go timers for kill docker by timeout, fixes #12 пре 1 година

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:4.10.0-30-generic'

Run debug environment:

$ out-of-tree debug --kernel='Ubuntu:4.10.0-30-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 16.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.

Generate images

$ cd $GOPATH/src/code.dumpstack.io/tools/out-of-tree/tools/qemu-debian-img/
$ docker run --privileged -v $(pwd):/shared -e IMAGE=/shared/ubuntu1404.img -e RELEASE=trusty -t gen-ubuntu1804-image
$ docker run --privileged -v $(pwd):/shared -e IMAGE=/shared/ubuntu1604.img -e RELEASE=xenial -t gen-ubuntu1804-image