Go to file
topjohnwu a1b5185ecb Make sure rootfs file selabels are correct
Android Q init assumes rootfs to always be on EXT4 images, thus
never runs restorecon on the whole root directory. This is an issue
because some folders in rootfs were set with special selabels in
the system partition, but when copying over to initramfs by magiskinit,
these labels will not be preserved.

So the solution is to relabel the files in rootfs with the original
context right? Yes, but rootfs does not allow security xattr to be set
on files before the kernel SELinux initializes with genfs_contexts.
We have to load our sepolicy to the kernel before we clone the root
directory from system partition, which we will also restore the selabel
in the meantime.

Unfortunately this means that for each reboot, the exact same policy
will be loaded to the kernel twice: once in magiskinit so we can label
rootfs properly, and once by the original init, which is part of the
boot procedure. There is no easy way to prevent init from loading
sepolicy, as init will refuse to continue if policy loading has failed.
2019-03-14 22:27:29 -04:00
app Don't remove SafetyNet from hide list 2019-03-14 07:00:36 -04:00
chromeos Massive build script refactor 2017-06-03 20:31:02 +08:00
docs Update newline in docs 2019-02-03 23:48:20 -05:00
gradle/wrapper Upgrade Android Studio 2019-03-07 03:41:24 -05:00
native Make sure rootfs file selabels are correct 2019-03-14 22:27:29 -04:00
net Upgrade Android Studio 2019-03-07 03:41:24 -05:00
scripts Support boot_img_hdr_v2 2019-03-13 16:51:22 -04:00
shared Separate stub Magisk Manager to a module 2019-03-08 10:16:02 -05:00
signing Full project restructuring 2019-01-30 03:10:12 -05:00
snet Full project restructuring 2019-01-30 03:10:12 -05:00
stub Update it-it stub 2019-03-12 17:04:23 -04:00
.gitattributes Build everything ourselves 2017-08-24 12:14:17 +08:00
.gitignore Support Android Q new init setup 2019-03-03 06:35:25 -05:00
.gitmodules Remove magiskpolicy as submodule 2018-07-18 18:43:36 +08:00
build.gradle Update AGP and R8 2019-03-12 16:53:07 -04:00
build.py Update build script 2019-03-12 17:01:37 -04:00
config.prop.sample Read props directly in Gradle 2018-08-20 12:02:38 +08:00
gradle.properties Use ToT r8 for releases 2019-03-07 17:33:06 -05:00
gradlew Update Gradle wrapper to 4.6 2018-04-22 03:09:02 +08:00
gradlew.bat Update Gradle wrapper to 4.6 2018-04-22 03:09:02 +08:00
LICENSE Use GPL v3 license and update copyright messages 2017-04-22 17:12:54 +08:00
README.MD Update README.md 2019-03-08 10:23:42 -05:00
settings.gradle Remove app-core module 2019-03-08 10:19:22 -05:00

Magisk

Downloads | Documentation | XDA Thread

Introduction

Magisk is a suite of open source tools for customizing Android, supporting devices higher than Android 4.2 (API 17). It covers the fundamental parts for Android customization: root, boot scripts, SELinux patches, AVB2.0 / dm-verity / forceencrypt removals etc.

Furthermore, Magisk provides a Systemless Interface to alter the system (or vendor) arbitrarily while the actual partitions stay completely intact. With its systemless nature along with several other hacks, Magisk can hide modifications from nearly any system integrity verifications used in banking apps, corporation monitoring apps, game cheat detections, and most importantly Google's SafetyNet API.

Bug Reports

Make sure to install the latest Canary Build before reporting any bugs! DO NOT report bugs that is already fixed upstream. Follow the instructions in the Canary Channel XDA Thread, and report a bug either by opening an issue on GitHub or directly in the thread.

Building Environment Requirements

  • Python 3: run build.py script
  • Java Development Kit (JDK) 8: Compile Magisk Manager and sign zips
  • Latest Android SDK: set ANDROID_HOME environment variable to the path to Android SDK
  • Android NDK: Install NDK along with SDK ($ANDROID_HOME/ndk-bundle), or optionally specify a custom path ANDROID_NDK_HOME
  • (Windows Only) Python package Colorama: Install with pip install colorama, used for ANSI color codes

Building Notes and Instructions

  • Clone sources with submodules: git clone --recurse-submodules https://github.com/topjohnwu/Magisk.git
  • Building is supported on macOS, Linux, and Windows. Official releases are built and tested with FrankeNDK; point ANDROID_NDK_HOME to FrankeNDK if you want to use it for compiling.
  • Set configurations in config.prop. A sample file config.prop.sample is provided as an example.
  • Run build.py with argument -h to see the built-in help message. The -h option also works for each supported actions, e.g. ./build.py binary -h
  • By default, build.py build binaries and Magisk Manager in debug mode. If you want to build Magisk Manager in release mode (via the -r, --release flag), you need a Java Keystore file release-key.jks (only JKS format is supported) to sign APKs and zips. For more information, check out Google's Official Documentation.

Translations

Default string resources for Magisk Manager are scattered throughout

  • app/src/main/res/values/strings.xml
  • stub/src/main/res/values/strings.xml
  • shared/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/>.