https://github.com/out-of-tree/out-of-tree

out-of-tree kernel {module, exploit} development tool
https://github.com/out-of-tree/out-of-tree

exploit-development linux-kernel out-of-tree

Last synced: 2 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/out-of-tree/out-of-tree
• Owner: out-of-tree
• License: agpl-3.0
• Created: 2018-09-17T16:15:16.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-17T22:46:23.000Z (3 months ago)
• Last Synced: 2024-10-30T05:57:48.383Z (2 months ago)
• Topics: exploit-development, linux-kernel, out-of-tree
• Language: Go
• Homepage: https://out-of-tree.io
• Size: 1.53 MB
• Stars: 220
• Watchers: 13
• Forks: 28
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Ubuntu](https://github.com/out-of-tree/out-of-tree/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/out-of-tree/out-of-tree/actions/workflows/ubuntu.yml)

[![E2E](https://github.com/out-of-tree/out-of-tree/actions/workflows/e2e.yml/badge.svg)](https://github.com/out-of-tree/out-of-tree/actions/workflows/e2e.yml)

[![Documentation Status](https://readthedocs.org/projects/out-of-tree/badge/?version=latest)](https://out-of-tree.readthedocs.io/en/latest/?badge=latest)

# [out-of-tree](https://out-of-tree.io)

*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").

## Installation

### GNU/Linux (with [Nix](https://nixos.org/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](https://out-of-tree.readthedocs.io) for further info.

## Examples

Download all Ubuntu 24.04 kernels:

    $ out-of-tree kernel genall --distro-id=Ubuntu --distro-release=24.04

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

    $ out-of-tree pew

Test with a specific kernel:

    $ out-of-tree pew --realtime-output  --distro-id=ubuntu --kernel-regex=6.8.0-41-generic

Run debug environment:

    $ out-of-tree debug --distro-id=ubuntu --distro-release=24.04 --kernel-regex=6.8.0-41-generic