1
0
Fork 0
out-of-tree kernel {module, exploit} development tool
 
 
 
 
Go to file
dump_stack() 434aeb768b
Add commands for install Docker
2019-12-27 08:18:45 +00:00
.github/workflows GitHub Actions: split jobs, add end-to-end testing 2019-12-26 06:47:37 +00:00
config Support custom docker commands 2019-08-30 00:05:50 +00:00
docs Fix spelling 2019-08-21 06:16:25 +00:00
examples Fix spelling 2019-08-21 06:16:25 +00:00
qemu Add timeout after start qemu for tests 2019-12-27 07:52:26 +00:00
tools Add policykit-1 to rootfs 2019-08-31 12:45:55 +00:00
.gitignore Remove snap support 2018-12-02 15:33:13 +00:00
.travis.yml Travis-CI: xenial -> bionic 2019-08-18 11:33:58 +00:00
CHANGELOG.md Bump version 2019-12-25 14:40:13 +00:00
LICENSE Change license to GNU AGPLv3 2018-10-08 20:54:18 +00:00
README.md Add commands for install Docker 2019-12-27 08:18:45 +00:00
db.go Refactor [2] 2019-08-17 09:05:06 +00:00
debug.go Fix spelling 2019-08-21 06:16:25 +00:00
gen.go Move upstream to code.dumpstack.io 2019-02-02 21:25:09 +00:00
go.mod Generate markdown table statistics for tag 2019-08-16 20:11:35 +00:00
go.sum Generate markdown table statistics for tag 2019-08-16 20:11:35 +00:00
images.config.go Remove bootstrap, download images on-demand 2019-08-20 09:09:38 +00:00
images.go Remove bootstrap, download images on-demand 2019-08-20 09:09:38 +00:00
kernel.go Should return if error occured 2019-12-26 13:16:38 +00:00
kernel_linux.go Exclude host kernel generation for macOS 2019-08-31 08:05:43 +00:00
kernel_macos.go Exclude host kernel generation for macOS 2019-08-31 08:05:43 +00:00
log.go Refactor 2019-08-17 08:51:42 +00:00
main.go Bump version 2019-12-25 14:40:13 +00:00
pack.go Add flag for verbose output 2019-11-14 15:38:16 +00:00
pew.go Add flag for verbose output 2019-11-14 15:38:16 +00:00
pew_test.go Use go timers for kill docker by timeout, fixes #12 2018-12-08 02:53:29 +00:00

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

Installation

GNU/Linux (with Nix)

$ curl -fsSL https://get.docker.com | sh
$ curl https://nixos.org/nix/install | sh
$ nix-env -iA nixpkgs.out-of-tree

macOS

$ brew cask install docker
$ open --background -a Docker && sleep 1m
$ brew tap jollheef/repo
$ brew install out-of-tree

Build from source

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

$ 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