1
0
out-of-tree kernel {module, exploit} development tool
Go to file
2023-05-24 22:48:58 +00:00
.github/workflows ci: modprobe uio 2023-05-24 18:03:04 +00:00
cache feat!: introduce new distribution structure 2023-05-18 16:07:24 +00:00
config fix: check only distro id 2023-05-24 21:58:25 +00:00
container fix: support updating containers 2023-05-24 16:43:25 +00:00
distro fix: support force kernel reinstallation 2023-05-24 16:29:52 +00:00
docs Build with cgo 2023-03-16 18:46:46 +00:00
examples feat!: new kernel config structure 2023-05-18 18:48:09 +00:00
fs feat: use distro info to create the container 2023-05-23 16:54:45 +00:00
kernel fix: change return values of macos placeholder 2023-05-23 22:44:38 +00:00
qemu fix: set error when qemu is dead 2023-05-24 19:46:11 +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
CHANGELOG.md Update changelog 2023-04-07 21:38:30 +00:00
container.go refactor: move container functions to submodule 2023-05-13 10:14:45 +00:00
db.go fix: use nullstring in lastlog 2023-05-24 22:48:58 +00:00
debug.go refactor: move kernelinfo to distro module 2023-05-23 21:33:50 +00:00
default.nix build: add version for flake 2023-05-18 12:53:46 +00:00
distro.go fix: no need to have separate case for debian anymore 2023-05-24 09:09:16 +00:00
flake.lock build: nix flakes 2023-05-16 11:47:17 +00:00
flake.nix build: add version for flake 2023-05-18 12:53:46 +00:00
gen.go feat!: new kernel config structure 2023-05-18 18:48:09 +00:00
go.mod refactor: move container generation to distro modules 2023-05-23 13:20:48 +00:00
go.sum feat: bump go version 2023-05-15 15:09:09 +00:00
gomod2nix.toml build: nix flakes 2023-05-16 11:47:17 +00:00
images.go refactor: move kernelinfo to distro module 2023-05-23 21:33:50 +00:00
kernel.go fix: support updating containers 2023-05-24 16:43:25 +00:00
LICENSE Change license to GNU AGPLv3 2018-10-08 20:54:18 +00:00
log.go feat: add internal error to log database 2023-05-24 22:46:04 +00:00
main.go fix: use the default config dirs provider 2023-05-21 20:31:47 +00:00
pack.go feat: parallel kernel installation 2023-05-21 21:43:18 +00:00
pew.go feat: add internal error to log database 2023-05-24 22:46:04 +00:00
preload.go refactor: move kernelinfo to distro module 2023-05-23 21:33:50 +00:00
README.md docs: update readme 2023-05-17 13:32:31 +00:00
shell.nix build: nix flakes 2023-05-16 11:47:17 +00:00

Codacy Badge Go Report Card 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'