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() dc73413114
Set version
hace 10 meses
config Support custom docker commands hace 10 meses
docs Fix spelling hace 10 meses
examples Fix spelling hace 10 meses
qemu Fix spelling hace 10 meses
tools Add rootfs generator for Ubuntu 14.04 hace 10 meses
.gitignore Remove snap support hace 1 año
.travis.yml Travis-CI: xenial -> bionic hace 10 meses
CHANGELOG.md Set version hace 10 meses
LICENSE Change license to GNU AGPLv3 hace 1 año
README.md Travis-CI: migrate to travis-ci.com hace 10 meses
db.go Refactor [2] hace 10 meses
debug.go Fix spelling hace 10 meses
gen.go Move upstream to code.dumpstack.io hace 1 año
go.mod Generate markdown table statistics for tag hace 10 meses
go.sum Generate markdown table statistics for tag hace 10 meses
images.config.go Remove bootstrap, download images on-demand hace 10 meses
images.go Remove bootstrap, download images on-demand hace 10 meses
kernel.go Support custom docker commands hace 10 meses
log.go Refactor hace 10 meses
main.go Set version hace 10 meses
pack.go Implements global timeout hace 10 meses
pew.go Implements global timeout hace 10 meses
pew_test.go Use go timers for kill docker by timeout, fixes #12 hace 1 año

README.md

Codacy Badge Build Status 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

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

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

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