diff --git a/README.md b/README.md index a61f2d8..f215ef9 100644 --- a/README.md +++ b/README.md @@ -6,39 +6,20 @@ out-of-tree kernel {module, exploit} development tool ## Installation -Read [Qemu API](qemu/README.md). - -### Generate images - - $ cd $GOPATH/src/github.com/jollheef/out-of-tree/tools/qemu-debian-img/ - $ docker run --privileged -v $(pwd):/shared -e IMAGE=/shared/ubuntu1404.img -e RELEASE=trusty -t gen-ubuntu1804-image - $ docker run --privileged -v $(pwd):/shared -e IMAGE=/shared/ubuntu1604.img -e RELEASE=xenial -t gen-ubuntu1804-image - -### Generate kernels - - cd $GOPATH/src/github.com/jollheef/out-of-tree/tools/kernel-factory - ./bootstrap.sh # more than 6-8 hours for all kernels - -### "I just want to see how it works" - -If you already have Go, Qemu and Docker installed, there's cross-platform installation checklist: - $ go get github.com/jollheef/out-of-tree - $ cd $GOPATH/src/github.com/jollheef/out-of-tree/tools/qemu-debian-img/ - $ ./bootstrap.sh - $ docker run --privileged -v $(pwd):/shared -e IMAGE=/shared/ubuntu1604.img -e RELEASE=xenial -t gen-ubuntu1804-image - $ cd ../kernel-factory - $ rm -rf {Debian,CentOS,Ubuntu/{14.04,18.04}} # speed up :) - $ ./bootstrap.sh - $ # wait several hours... - $ export OUT_OF_TREE_KCFG=$GOPATH/src/github.com/jollheef/out-of-tree/tools/kernel-factory/output/kernels.toml - $ cd ../../examples/kernel-exploit - $ # test kernel exploit - $ out-of-tree pew - $ cd ../kernel-module - $ # test kernel module + $ out-of-tree bootstrap + +Then you can check it on kernel module example: + + $ cd $GOPATH/github.com/jollheef/out-of-tree/examples/kernel-module + $ out-of-tree kernel autogen # generate kernels based on .out-of-tree.toml $ out-of-tree pew +## Generate all kernels (does not required if you dont need to use `--guess`) + + $ cd $GOPATH/src/github.com/jollheef/out-of-tree/tools/kernel-factory + $ ./bootstrap.sh # more than 6-8 hours for all kernels + ## Examples Run by absolute path @@ -68,3 +49,13 @@ Guess work kernels: Use custom kernels config $ out-of-tree --kernels /path/to/kernels.toml pew + +## Development + +Read [Qemu API](qemu/README.md). + +### Generate images + + $ cd $GOPATH/src/github.com/jollheef/out-of-tree/tools/qemu-debian-img/ + $ docker run --privileged -v $(pwd):/shared -e IMAGE=/shared/ubuntu1404.img -e RELEASE=trusty -t gen-ubuntu1804-image + $ docker run --privileged -v $(pwd):/shared -e IMAGE=/shared/ubuntu1604.img -e RELEASE=xenial -t gen-ubuntu1804-image