1
0
Fork 0
out-of-tree kernel {module, exploit} development tool
 
 
 
 
Go to file
dump_stack() 81db5a6d6a
Update go.mod
2020-05-30 10:43:12 +00:00
.github/workflows GitHub Actions: Use latest stable nixpkgs channel 2020-02-21 00:32:02 +00:00
config Support custom docker commands 2019-08-30 00:05:50 +00:00
docs Move build from source to documentation 2019-12-27 08:38:47 +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
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 note about docker group 2019-12-28 08:50:10 +00:00
db.go Refactor [2] 2019-08-17 09:05:06 +00:00
debug.go Sync with the latest logrusorgru/aurora 2020-05-19 14:48:53 +00:00
gen.go Move upstream to code.dumpstack.io 2019-02-02 21:25:09 +00:00
go.mod Update go.mod 2020-05-30 10:43:12 +00:00
go.sum Sync with the latest logrusorgru/aurora 2020-05-19 14:48:53 +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 Sync with the latest logrusorgru/aurora 2020-05-19 14:48:53 +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 Sync with the latest logrusorgru/aurora 2020-05-19 14:48:53 +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 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