mirror of
https://github.com/topjohnwu/Magisk.git
synced 2024-12-28 21:37:39 +00:00
dbf8c41209
Patching DTBs is proven to be difficult and problematic as there are tons of different formats out there. Adding support for all the formats in magiskboot has been quite an headache in the past year, and it still definitely does not cover all possible cases of them out there. There is another issue: fake dt fstabs. Some super old devices do not have device trees in their boot images, so some custom ROM developers had came up with a "genius" solution: hardcode fstab entries directly in the kernel source code and create fake device tree nodes even if Android 10+ init can graciously take fstab files instead (-_-) 。。。 And there is YET another issue: DTBs are not always in boot images! Google is crazy enough to litter DTBs all over the place, it is like they cannot make up their minds (duh). This means the dt fstabs can be either concatnated after the kernel (1), in the DTB partition (2), in the DTBO partition (3), in the recovery_dtbo section in boot images (4), or in the dtb section in boot images (5). FIVE f**king places, how can anyone keep up with that! With Android 10+ that uses 2 stage inits, it is crutual for Magisk to be able to modify fstab mount points in order to let the original init mount partitions for us, but NOT switch root and continue booting. For devices using dt for early mount fstab, we used to patch the DTB at install time with magiskboot. However these changes are permanent and cannot be restored back at reinstallation. With this commit, Magisk will read dt fstabs and write them to ramdisk at boot time. And in that case, the init binary will also be patched to force it to NEVER use fstabs in device-tree. By doing so, we can unify ramdisk based 2SI fstab patching as basically we are just patching fstab files. This also means we can manipulate fstab whatever Magisk needs in the future without the need to going through the headache that is patching DTBs at installation.
Introduction
Magisk is a suite of open source tools for customizing Android, supporting devices higher than Android 4.2. It covers fundamental parts of Android customization: root, boot scripts, SELinux patches, AVB2.0 / dm-verity / forceencrypt removals etc.
Here are some feature highlights:
- MagiskSU: Provide root access to your device
- Magisk Modules: Modify read-only partitions by installing modules
- MagiskHide: Hide Magisk from root detections / system integrity checks
Download
Useful Links
- Installation Instruction
- OTA Upgrade Guide
- Full Official Docs
- Magisk Troubleshoot Wiki (by @Didgeridoohan)
Android Version Support
- Android 4.2+: MagiskSU and Magisk Modules Only
- Android 4.4+: All core features available
- Android 6.0+: Guaranteed MagiskHide support
- Android 7.0+: Full MagiskHide protection
- Android 9.0+: Magisk Manager stealth mode
Bug Reports
Canary Channels are cutting edge builds for those adventurous. To access canary builds, install either Canary Magisk Manager, switch to a Canary Channel in settings and upgrade.
Only bug reports from Canary DEBUG builds will be accepted.
For installation issues, upload both boot image and install logs.
For Magisk issues, upload boot logcat or dmesg.
For Magisk Manager crashes, record and upload the logcat when the crash occurs.
Building and Development
- Magisk builds on any OS Android Studio supports. Install Android Studio and do the initial setups.
- Clone sources:
git clone --recurse-submodules https://github.com/topjohnwu/Magisk.git - Install Python 3.6+. For Windows, select 'Add Python to PATH' in installer, and run
pip install coloramaafter install. - Configure to use the JDK bundled in Android Studio:
- macOS:
export JAVA_HOME="/Applications/Android Studio.app/Contents/jre/jdk/Contents/Home" - Linux:
export PATH="/path/to/androidstudio/jre/bin:$PATH" - Windows: Add
C:\Path\To\Android Studio\jre\binto environment variablePATH
- macOS:
- Set environment variable
ANDROID_HOMEto the Android SDK folder (can be found in Android Studio settings) - Run
./build.py ndkto let the script download and install NDK for you - Set configurations in
config.prop. A sampleconfig.prop.sampleis provided. - To start building, run
build.pyto see your options. For each action, use-hto access help (e.g../build.py all -h) - To start development, open the project in Android Studio. Both app (Kotlin/Java) and native (C++/C) source code can be properly developed using the IDE, but always use
build.pyfor building. build.pybuilds in debug mode by default. If you want release builds (with-r, --release), you need a Java Keystore to sign APKs and zips. For more information, check Google's Documentation.
Translation Contributions
Default string resources for Magisk Manager and its stub APK are located here:
app/src/main/res/values/strings.xmlstub/src/main/res/values/strings.xml
Translate each and place them in the respective locations ([module]/src/main/res/values-[lang]/strings.xml).
License
Magisk, including all git submodules are free software:
you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.