1
0
out-of-tree kernel {module, exploit} development tool
Go to file
2023-04-07 20:52:45 +00:00
.github/workflows Use different names for logs upload 2023-04-06 20:40:18 +00:00
config Add script artifact type 2023-03-22 20:56:44 +00:00
docs Build with cgo 2023-03-16 18:46:46 +00:00
examples Add script artifact type 2023-03-22 20:56:44 +00:00
qemu Trim last added newline 2023-04-06 20:45:20 +00:00
tools Switch to Ubuntu 22.04 for testing 2023-01-19 17:22:25 +00:00
.gitignore Ignore binary 2023-01-24 15:12:26 +00:00
CHANGELOG.md Bump version 2023-04-06 22:48:54 +00:00
container.go Add a flag to set the container runtime binary 2023-04-07 18:57:18 +00:00
db.go Show last log if no ID specified 2020-06-14 20:46:56 +00:00
debug.go Use single temp directory base 2023-04-07 16:44:21 +00:00
gen.go Add support for applying patches 2023-02-16 10:22:08 +00:00
go.mod go mod tidy 2023-04-07 00:04:10 +00:00
go.sum go mod tidy 2023-04-07 00:04:10 +00:00
images.config.go Remove bootstrap, download images on-demand 2019-08-20 09:09:38 +00:00
images.go Use single temp directory base 2023-04-07 16:44:21 +00:00
kernel_linux.go Handling discrepancies between /lib/modules and /boot 2023-04-07 10:27:59 +00:00
kernel_macos.go Exclude host kernel generation for macOS 2019-08-31 08:05:43 +00:00
kernel.go Graceful shutdown on ^C 2023-04-07 20:52:45 +00:00
LICENSE Change license to GNU AGPLv3 2018-10-08 20:54:18 +00:00
log.go Switch to zerolog 2023-03-18 21:30:07 +00:00
main.go Add a flag to set the container runtime binary 2023-04-07 18:57:18 +00:00
pack.go Do not randomize kernels installation/test order by default 2023-04-05 11:29:31 +00:00
pew.go Use single temp directory base 2023-04-07 16:44:21 +00:00
preload.go Use single temp directory base 2023-04-07 16:44:21 +00:00
README.md Typo 2023-04-07 19:11:42 +00:00
shell.nix Add shell.nix 2023-01-19 16:59:25 +00:00

Codacy Badge Go Report Card Documentation Status

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 -L https://nixos.org/nix/install | sh
$ nix-env -iA nixpkgs.out-of-tree # Note: may not be up to date immediately, in this case consider installing from source

Note that adding a user to group docker has serious security implications. Check Docker documentation for more information.

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'