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.

README.md 2.8KB

1 year ago
1 year ago
1 year ago
8 months ago
3 months ago
8 months ago
1 year ago
3 months ago
3 months ago
1 year ago
1 year ago
3 months ago
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. [![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)
  2. [![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)
  3. [![Documentation Status](https://readthedocs.org/projects/out-of-tree/badge/?version=latest)](https://out-of-tree.readthedocs.io/en/latest/?badge=latest)
  4. [![Donate](https://img.shields.io/badge/donate-paypal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=R8W2UQPZ5X5JE&source=url)
  5. [![Donate](https://img.shields.io/badge/donate-bitcoin-green.svg)](https://blockchair.com/bitcoin/address/bc1q23fyuq7kmngrgqgp6yq9hk8a5q460f39m8nv87)
  6. # [out-of-tree](https://out-of-tree.io)
  7. out-of-tree kernel {module, exploit} development tool
  8. 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).
  9. ![Screenshot](https://cloudflare-ipfs.com/ipfs/Qmb88fgdDjbWkxz91sWsgmoZZNfVThnCtj37u3mF2s3T3T)
  10. ## Installation
  11. ### GNU/Linux (with [Nix](https://nixos.org/nix/))
  12. $ curl -fsSL https://get.docker.com | sh
  13. $ sudo usermod -aG docker user && newgrp docker
  14. $ curl -L https://nixos.org/nix/install | sh
  15. $ nix-env -iA nixpkgs.out-of-tree
  16. Note that adding a user to group *docker* has serious security implications. Check Docker documentation for more information.
  17. ### macOS
  18. $ brew cask install docker
  19. $ open --background -a Docker && sleep 1m
  20. $ brew tap jollheef/repo
  21. $ brew install out-of-tree
  22. Read [documentation](https://out-of-tree.readthedocs.io) for further info.
  23. ## Examples
  24. Run by absolute path
  25. $ out-of-tree --path /path/to/exploit/directory pew
  26. Test only with one kernel:
  27. $ out-of-tree pew --kernel='Ubuntu:5.4.0-29-generic
  28. Run debug environment:
  29. $ out-of-tree debug --kernel='Ubuntu:5.4.0-29-generic
  30. Test binary module/exploit with implicit defined test ($BINARY_test)
  31. $ out-of-tree pew --binary /path/to/exploit
  32. Test binary module/exploit with explicit defined test
  33. $ out-of-tree pew --binary /path/to/exploit --test /path/to/exploit_test
  34. Guess work kernels:
  35. $ out-of-tree pew --guess
  36. Use custom kernels config
  37. $ out-of-tree --kernels /path/to/kernels.toml pew
  38. Generate all kernels
  39. $ out-of-tree kernel genall --distro Ubuntu --ver 20.04
  40. ## Troubleshooting
  41. If anything happens that you cannot solve -- just remove `$HOME/.out-of-tree`.
  42. But it'll be better if you'll write the bug report.
  43. ## Development
  44. Read [Qemu API](qemu/README.md).