SukiSU-Ultra/docs/README-en.md

SukiSU

Enlish | 简体中文

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 reserved @tiann

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

How to add

Using the 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 main branching

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

More links

Projects compiled based on Sukisu and susfs

• GKI
• OnePlus

Hook method

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

1. KPROBES hook:
   • This fork only supports GKI (5.10 - 6.x) kernels, all non-GKI kernels must use manual hooks.
   • For Loadable Kernel Modules (LKM)
   • Default hooking method for GKI kernels
   • Requires CONFIG_KPROBES=y. 2.
2. Hooks manual:
   • For GKI (5.10 - 6.x) kernels, add CONFIG_KSU_MANUAL_HOOK=y to the kernel defconfig and make sure to protect KernelSU hooks by using #ifdef CONFIG_KSU_MANUAL_HOOK instead of #ifdef CONFIG_KSU.
   • Standard KernelSU hooks: https://kernelsu.org/guide/how-to-integrate-for-non-gki.html#manually-modify-the-kernel-source
   • backslashxx syscall hooks: https://github.com/backslashxx/KernelSU/issues/5
   • Some non-GKI devices that manually integrate KPROBES do not require the manual VFS hook new_hook.patch patch

Usage

[GKI]

1. such as millet redmi samsung and other devices (does not include the magic kernel manufacturers such as: meizu, a plus real me oppo)
2. find more links in the GKI build project to find the device kernel version directly download with TWRP or kernel flashing tool to brush into the zip with AnyKernel3 suffix can be
3. General without the suffix of the .zip compressed package is universal, gz suffix for the special TianGui models, lz4 suffix for Google models, general brush without the suffix can be!

[OnePlus]

1. Find the Yiga project in the More link and fill in your own, then build it with cloud compilation, and finally brush in the zip with AnyKernel3 suffix. Note: You only need to fill in the first two kernel versions, such as 5.10, 5.15, 6.1, 6.6.

• Please search for the processor codename by yourself, usually it is all English without numbers.
• Branching and configuration files, please fill in the kernel open source address.

Features

1. Kernel-based su and root access management.
2. Not based on OverlayFS module system. 3.
3. Application Profiles: Lock root privileges in a cage. 4.
4. Bringing back non-GKI/GKI 1.0 support
5. More customization

License

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

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

How the above list does not have your name, I will keep you updated, thanks again for your support!

Contributions

• KernelSU: original project
• MKSU: Used project
• RKSU：Re-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 skills.