out-of-tree kernel {module, exploit} development tool
Du kannst nicht mehr als 25 Themen auswählen Themen müssen mit entweder einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
dump_stack() 1c2ea77920
GitHub Actions: Use latest stable nixpkgs channel
vor 1 Monat
.github/workflows GitHub Actions: Use latest stable nixpkgs channel vor 1 Monat
config Support custom docker commands vor 7 Monaten
docs Move build from source to documentation vor 3 Monaten
examples Fix spelling vor 7 Monaten
qemu Add timeout after start qemu for tests vor 3 Monaten
tools Add policykit-1 to rootfs vor 7 Monaten
.gitignore Remove snap support vor 1 Jahr
CHANGELOG.md Bump version vor 3 Monaten
LICENSE Change license to GNU AGPLv3 vor 1 Jahr
README.md Add note about docker group vor 3 Monaten
db.go Refactor [2] vor 7 Monaten
debug.go Fix spelling vor 7 Monaten
gen.go Move upstream to code.dumpstack.io vor 1 Jahr
go.mod Generate markdown table statistics for tag vor 7 Monaten
go.sum Generate markdown table statistics for tag vor 7 Monaten
images.config.go Remove bootstrap, download images on-demand vor 7 Monaten
images.go Remove bootstrap, download images on-demand vor 7 Monaten
kernel.go Should return if error occured vor 3 Monaten
kernel_linux.go Exclude host kernel generation for macOS vor 7 Monaten
kernel_macos.go Exclude host kernel generation for macOS vor 7 Monaten
log.go Refactor vor 7 Monaten
main.go Bump version vor 3 Monaten
pack.go Add flag for verbose output vor 4 Monaten
pew.go Add flag for verbose output vor 4 Monaten
pew_test.go Use go timers for kill docker by timeout, fixes #12 vor 1 Jahr

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