1
0
out-of-tree kernel {module, exploit} development tool
Go to file
2024-03-04 18:32:30 +00:00
.github/workflows ci: rename logs 2024-02-22 13:46:03 +00:00
api feat(api): job description 2024-03-04 18:32:30 +00:00
artifact fix: script path 2024-02-21 13:49:38 +00:00
cache refactor: remove ioutil 2024-02-20 12:44:35 +00:00
client feat(daemon): task groups 2024-02-26 09:48:00 +00:00
cmd feat(daemon): query jobs by update time 2024-02-28 01:51:45 +00:00
config feat: initial daemon implementation 2024-02-20 13:25:31 +00:00
container fix: load local archive 2024-02-21 22:52:38 +00:00
daemon feat(api): job description 2024-03-04 18:32:30 +00:00
distro Revert "fix: load, not import" 2024-02-21 18:55:48 +00:00
docs docs: add .readthedocs.yaml 2024-02-22 13:06:05 +00:00
examples fix: remove spaces from examples names 2024-02-20 14:30:17 +00:00
fs feat: initial daemon implementation 2024-02-20 13:25:31 +00:00
kernel feat: initial daemon implementation 2024-02-20 13:25:31 +00:00
qemu refactor: set qemu default values as constants 2024-02-25 18:02:39 +00:00
tools fix: do not use custom sources.list on debian 12 bookworm 2023-05-24 12:39:13 +00:00
.gitignore build: nix flakes 2023-05-16 11:47:17 +00:00
.readthedocs.yaml docs: add .readthedocs.yaml 2024-02-22 13:06:05 +00:00
CHANGELOG.md Update changelog 2023-04-07 21:38:30 +00:00
default.nix feat: initial daemon implementation 2024-02-20 13:25:31 +00:00
flake.lock nix flake update 2024-02-20 14:35:19 +00:00
flake.nix build: add version for flake 2023-05-18 12:53:46 +00:00
go.mod fix: remove toolchain directive 2024-02-20 13:28:43 +00:00
go.sum feat: initial daemon implementation 2024-02-20 13:25:31 +00:00
gomod2nix.toml build: nix flakes 2023-05-16 11:47:17 +00:00
LICENSE Change license to GNU AGPLv3 2018-10-08 20:54:18 +00:00
main.go feat: initial daemon implementation 2024-02-20 13:25:31 +00:00
README.md docs: add .readthedocs.yaml 2024-02-22 13:06:05 +00:00
shell.nix build: nix flakes 2023-05-16 11:47:17 +00:00

Ubuntu E2E Documentation Status

out-of-tree

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

out-of-tree was created to reduce the complexity of the environment for developing, testing and debugging Linux kernel exploits and out-of-tree kernel modules (hence the name "out-of-tree").

Screenshot

Installation

GNU/Linux (with Nix)

sudo apt install podman || sudo dnf install podman

curl -L https://nixos.org/nix/install | sh
mkdir -p ~/.config/nix
echo "experimental-features = nix-command flakes" >> ~/.config/nix/nix.conf

# stable
nix profile install nixpkgs#out-of-tree

# latest
nix profile install git+https://code.dumpstack.io/tools/out-of-tree

macOS

Note: case-sensitive FS is required for the ~/.out-of-tree directory.

$ brew install podman
$ podman machine stop || true
$ podman machine rm || true
$ podman machine init --cpus=4 --memory=4096 -v $HOME:$HOME
$ podman machine start
$ brew tap out-of-tree/repo
$ brew install out-of-tree

Read documentation for further info.

Examples

Generate all Ubuntu 22.04 kernels:

$ out-of-tree kernel genall --distro=Ubuntu --ver=22.04

Run tests based on .out-of-tree.toml definitions:

$ out-of-tree pew

Test with a specific kernel:

$ out-of-tree pew --kernel='Ubuntu:5.4.0-29-generic'

Run debug environment:

$ out-of-tree debug --kernel='Ubuntu:5.4.0-29-generic'