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() 5ad41bc1c8
Update changelog for next release
11 months ago
config Auto detect debug symbols for host kernels 11 months ago
docs Documentation: fix lists 11 months ago
examples Print kernel config skeleton to stdout 1 year ago
qemu Allow to enable/disable kaslr/smep/smap for debugging 11 months ago
tools Typo 1 year ago
.gitignore Remove snap support 1 year ago
.travis.yml Revert "Travis-CI: Test also without go modules" 11 months ago
CHANGELOG.md Update changelog for next release 11 months ago
LICENSE Change license to GNU AGPLv3 1 year ago
README.md Change bitcoin link 11 months ago
bootstrap.config.go Implements bootstrap, fixes #3 1 year ago
bootstrap.go Improve logging 1 year ago
db.go Implements tagging 11 months ago
debug.go Add TODO regarding kernel source 11 months ago
gen.go Move upstream to code.dumpstack.io 1 year ago
go.mod Generate markdown table statistics for tag 11 months ago
go.sum Generate markdown table statistics for tag 11 months ago
kernel.go Auto detect debug symbols for host kernels 11 months ago
log.go Generate markdown table statistics for tag 11 months ago
main.go Generate markdown table statistics for tag 11 months ago
pew.go Flag for number of runs per each kernel 11 months ago
pew_test.go Use go timers for kill docker by timeout, fixes #12 1 year ago

README.md

Codacy Badge Build Status Go Report Card Documentation Status Donate Donate

out-of-tree

out-of-tree kernel {module, exploit} development tool

Screenshot

Requirements

Qemu, docker and golang is required.

Also do not forget to set GOPATH and PATH e.g.:

$ echo 'export GOPATH=$HOME' >> ~/.bashrc
$ echo 'export PATH=$PATH:$HOME/bin' >> ~/.bashrc
$ source ~/.bashrc

Gentoo

# emerge app-emulation/qemu app-emulation/docker dev-lang/go

macOS

$ brew install go qemu
$ brew cask install docker

Fedora

$ sudo dnf install go qemu moby-engine

Also check out docker post-installation steps.

Build from source

$ go get -u code.dumpstack.io/tools/out-of-tree
$ out-of-tree bootstrap

Then you can check it on kernel module example:

$ cd $GOPATH/src/code.dumpstack.io/tools/out-of-tree/examples/kernel-module
$ out-of-tree kernel autogen # generate kernels based on .out-of-tree.toml
$ out-of-tree pew

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

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