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.

78 lines
2.8 KiB

2 years ago
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/aba4aad2046b4d1a9a99cf98e22c018b)](https://app.codacy.com/app/jollheef/out-of-tree?utm_source=github.com&utm_medium=referral&utm_content=jollheef/out-of-tree&utm_campaign=Badge_Grade_Dashboard)
[![Go Report Card](https://goreportcard.com/badge/code.dumpstack.io/tools/out-of-tree)](https://goreportcard.com/report/code.dumpstack.io/tools/out-of-tree)
[![Documentation Status](https://readthedocs.org/projects/out-of-tree/badge/?version=latest)](https://out-of-tree.readthedocs.io/en/latest/?badge=latest)
3 years ago
3 years ago
# [out-of-tree](https://out-of-tree.io)
3 years ago
3 years ago
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).
3 years ago
## Installation
### GNU/Linux (with [Nix](https://nixos.org/nix/))
$ curl -fsSL https://get.docker.com | sh
2 years ago
$ sudo usermod -aG docker user && newgrp docker
$ curl -L 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](https://out-of-tree.readthedocs.io) for further info.
2 years ago
## Examples
3 years ago
Run by absolute path
$ out-of-tree --path /path/to/exploit/directory pew
Test only with one kernel:
1 year ago
$ out-of-tree pew --kernel='Ubuntu:5.4.0-29-generic
Run debug environment:
1 year ago
$ out-of-tree debug --kernel='Ubuntu:5.4.0-29-generic
3 years ago
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
3 years ago
Use custom kernels config
$ out-of-tree --kernels /path/to/kernels.toml pew
Generate all kernels
3 years ago
1 year ago
$ out-of-tree kernel genall --distro Ubuntu --ver 20.04
3 years ago
2 years ago
## 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](qemu/README.md).