SukiSU-Ultra/docs/README-en.md

SukiSU Ultra

English | 简体中文 | 日本語

Android device root solution based on KernelSU

Experimental! Use at your own risk! This solution is based on KernelSU and is experimental!

This is an unofficial fork. All rights are reserved to @tiann

However, we will be a separately maintained branch of KSU in the future

• Fully adapted for non-GKI devices (susfs-dev and unsusfs-patched dev branches only)

How to add

Use the susfs-stable or susfs-dev branch (integrated susfs with support for non-GKI devices)

curl -LSs "https://raw.githubusercontent.com/ShirkNeko/SukiSU-Ultra/main/kernel/setup.sh" | bash -s susfs-dev

Use the main branch

curl -LSs "https://raw.githubusercontent.com/ShirkNeko/KernelSU/main/kernel/setup.sh" | bash -s main

How to use integrated susfs

1. Use the susfs-dev branch directly without any patching

KPM support

• We have removed duplicate KSU functions based on KernelPatch and retained KPM support.
• We will introduce more APatch-compatible functions to ensure the integrity of KPM functionality.

Open source address: https://github.com/ShirkNeko/SukiSU_KernelPatch_patch

KPM template address: https://github.com/udochina/KPM-Build-Anywhere

More links

Projects compiled based on Sukisu and susfs

• GKI
• OnePlus

Hook method

• This method references the hook method from (https://github.com/rsuntk/KernelSU)

1. KPROBES hook:

   • Also used for Loadable Kernel Module (LKM)
   • Default hook method on GKI kernels.
   • Need CONFIG_KPROBES=y

2. Manual hook:

   • Standard KernelSU hook: https://kernelsu.org/guide/how-to-integrate-for-non-gki.html#manually-modify-the-kernel-source
   • backslashxx's syscall manual hook: https://github.com/backslashxx/KernelSU/issues/5
   • Default hook method on Non-GKI kernels.
   • Need CONFIG_KSU_MANUAL_HOOK=y

Usage

GKI

Please follow this guide.

https://kernelsu.org/guide/installation.html

OnePlus

1. Use the link mentioned in the 'More Links' section to create a customized build with your device information, and then flash the zip file with the AnyKernel3 suffix.

Note

• You only need to fill in the first two parts of kernel versions, such as 5.10, 5.15, 6.1, or 6.6.
• Please search for the processor codename by yourself, usually it is all English without numbers.
• You can find the branch and configuration files from the OnePlus open-source kernel repository.

Features

1. Kernel-based su and root access management.
2. Not based on OverlayFS module system, but based on Magic Mount from 5ec1cff
3. App Profile: Lock root privileges in a cage.
4. Bringing back non-GKI/GKI 1.0 support
5. More customization
6. Support for KPM kernel modules

License

• The file in the “kernel” directory is under GPL-2.0-only license.
• All other parts except the “kernel” directory are under GPL-3.0 or later license.

Sponsorship list

• Ktouls Thanks so much for bringing me support
• zaoqi123 It's not a bad idea to buy me a milk tea
• wswzgdg Many thanks for supporting this project
• yspbwx2010 Many thanks
• DARKWWEE Thanks for the 100 USDT Lao

If the above list does not have your name, I will update it as soon as possible, and thanks again for your support!

Contributions

• KernelSU: original project
• MKSU: Used project
• RKSU: Reintroduced the support of non-GKI devices using the kernel of this project
• susfs：Used susfs file system
• KernelSU: KernelSU conceptualization
• Magisk: Powerful root utility
• genuine: APK v2 Signature Verification
• Diamorphine: Some rootkit utilities.
• KernelPatch: KernelPatch is a key part of the APatch implementation of the kernel module