s0nh_kernel — LineageOS + NetHunter Kernel

Disclaimer

This kernel is made for educational purposes only.

I am not responsible for anything that may happen to your device by installing any custom ROMs and/or kernels.

Anything you do with this kernel you do at your own risk. By using it, you take the responsibility upon yourself and in case of any issue you are not to blame me or other related contributors.

s0nh_kernel — LineageOS + NetHunter Kernel

Kernel Features

The kernel has the following features:

Kali NetHunter support;
RTL8812AU Wi-Fi drivers;
packet injection support for internal Wi-Fi chipset.

Usage

The custom build wrapper consists of 3 main parts:

kernel builder;
assets collector;
kernel + assets bundler.

$ python3 wrapper --help
usage: wrapper [-h] [--clean] {kernel,assets,bundle} ...

A custom wrapper for the s0nh kernel.

positional arguments:
  {kernel,assets,bundle}
    kernel              build the kernel
    assets              collect assets
    bundle              build the kernel + collect assets

optional arguments:
  -h, --help            show this help message and exit
  --clean               clean the root directory

Prerequisites

It is highly recommended to use docker option to run this tool. For that you need Docker Engine or Docker Desktop, depending on your OS.

To run this tool in a local environment, you will need:

a Debian-based Linux distribution (other types of distros are untested);
packages installed via apt: libssl-dev, wget, git, make, gcc, zip.

You will also need a few Python packages. To install them, use:

python3 -m poetry install

To install poetry, use python3 -m pip install poetry.

NOTE: Whether you selected the docker or local build option, you must create an environment variable PYTHONPATH directing to the folder with this repo.

E.g., on Linux it would be export PYTHONPATH=$(pwd) in the root of the repository.

Kernel

Kernel build process can be launched by using the python3 wrapper kernel <arguments> command.

For more options you can refer to the help message below.

$ python3 wrapper kernel --help
usage: wrapper kernel [-h] [-c] [--clean-image] [--log-level {normal,verbose,quiet}] [-o OUTLOG] {local,docker,podman} losversion codename

positional arguments:
  {local,docker,podman}
                        select build environment
  losversion            select LineageOS version
  codename              select device codename

optional arguments:
  -h, --help            show this help message and exit
  -c, --clean           don't build anything, just clean the environment
  --clean-image         remove Docker/Podman image from the host machine after build
  --log-level {normal,verbose,quiet}
                        select log level
  -o OUTLOG, --output OUTLOG
                        save logs to a file

Assets

As mentioned, there is also an asset downloader, which can collect latest versions of LineageOS ROM, TWRP, Magisk and it's modules, Kali Chroot etc.

$ python3 wrapper assets --help
usage: wrapper assets [-h] [--extra-assets EXTRA_ASSETS] [--rom-only] [--clean-image] [--clean] [--log-level {normal,verbose,quiet}] [-o OUTLOG] {local,docker,podman} losversion codename {full,minimal}

positional arguments:
  {local,docker,podman}
                        select build environment
  losversion            select LineageOS version
  codename              select device codename
  {full,minimal}        select Kali chroot type

optional arguments:
  -h, --help            show this help message and exit
  --extra-assets EXTRA_ASSETS
                        select a JSON file with extra assets
  --rom-only            download only the ROM as an asset
  --clean-image         remove Docker/Podman image from the host machine after build
  --clean               autoclean 'assets' folder if it exists
  --log-level {normal,verbose,quiet}
                        select log level
  -o OUTLOG, --output OUTLOG
                        save logs to a file

Bundle

There is an option named bundle which combines build artifacts of both kernel and assets modules into a single package.

This is especially useful for linking the kernel version with the appropriate LineageOS ROM version.

There are cases when an old kernel version is used with the newer ROM version (adapted for the newer version of kernel). Such cases can ultimately lead to your system working improperly or breaking down completely, which is why it is important to use a specific kernel build with a corresponding ROM build.

Currently, there are three types of packaging available:

conan;
slim;
full.

Options full and conan collect all of the assets required to successfuly flash the kernel onto your device. The difference between the two is that full option places everything into a local release-full directory, while conan organizes everything as a Conan package.

An option named slim is a much lighter version of full packaging, as only the ROM is collected from the asset list. This is done to reduce package sizes while ensuring the kernel+ROM compatibility.

$ python3 wrapper bundle --help
usage: wrapper bundle [-h] [--conan-upload] [--clean-image] [--log-level {normal,verbose,quiet}] [-o OUTLOG] {local,docker,podman} losversion codename {conan,slim,full}

positional arguments:
  {local,docker,podman}
                        select build environment
  losversion            select LineageOS version
  codename              select device codename
  {conan,slim,full}     select package type of the bundle

optional arguments:
  -h, --help            show this help message and exit
  --conan-upload        upload Conan packages to remote
  --clean-image         remove Docker/Podman image from the host machine after build
  --log-level {normal,verbose,quiet}
                        select log level
  -o OUTLOG, --output OUTLOG
                        save logs to a file

Examples

Here are some examples of commands:

(Recommended) Build kernel and collect ROM via Docker:
- python3 wrapper bundle docker 20.0 dumpling slim
Build kernel locally:
- python3 wrapper kernel local 20.0 dumpling;
Collect all the assets locally:
- python3 wrapper assets local 20.0 dumpling full

JGodin-C2C/s0nh_kernel