github/Magisk
1
Fork 0
mirror of https://github.com/topjohnwu/Magisk synced 2024-11-13 20:54:12 +01:00
Code Releases Activity
3,387 Commits 1 Branch 138 Tags 104 MiB
C++ 36.9%
Kotlin 30.1%
Rust 16.5%
Java 9%
Shell 4.8%
Other 2.6%
cf2d02c0dd
Go to file
topjohnwu cf2d02c0dd Don't wipe ramdisk when A-only SAR
2019-09-22 06:17:54 -04:00
app Update v7.3.4 changelogs 2019-09-19 05:29:45 -04:00
docs Fix links in docs 2019-09-19 05:48:21 -04:00
gradle/wrapper Update Gradle wrapper to 5.6.2 2019-09-09 17:38:54 -04:00
native Fix potential crash when traversing cpio entries 2019-09-22 06:15:19 -04:00
scripts Don't wipe ramdisk when A-only SAR 2019-09-22 06:17:54 -04:00
shared Translation is done 2019-09-01 01:12:15 +08:00
signing Update dependencies 2019-09-12 12:50:44 -04:00
snet Update snet extension 2019-08-08 04:18:32 -07:00
stub Fix strings 2019-09-08 01:19:33 -04:00
tools Clean elf after building shared binaries 2019-08-22 02:51:17 +08:00
.gitattributes Clean elf after building shared binaries 2019-08-22 02:51:17 +08:00
.gitignore Revert "Revert to old find boot order" 2019-04-05 15:18:39 -04:00
.gitmodules Clean elf after building shared binaries 2019-08-22 02:51:17 +08:00
build.gradle Make kotlin version a variable globally 2019-09-03 16:27:57 -04:00
build.py Clean elf after building shared binaries 2019-08-22 02:51:17 +08:00
config.prop.sample Read props directly in Gradle 2018-08-20 12:02:38 +08:00
gradle.properties Updated build tools & enabled incremental kapt 2019-05-09 15:27:37 +02:00
gradlew Update Gradle wrapper to 5.6.1 2019-09-01 01:17:22 +08:00
gradlew.bat Update Gradle wrapper to 5.6.1 2019-09-01 01:17:22 +08:00
LICENSE Use GPL v3 license and update copyright messages 2017-04-22 17:12:54 +08:00
README.MD Fix typo and add link to GH issues 2019-09-09 17:39:15 -04:00
settings.gradle Remove net module 2019-08-04 18:33:20 -07:00

README.MD

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 are 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).

Signature Verification

Official release zips and APKs are signed with my personal private key. You can verify the key certificate to make sure the binaries you downloaded are not manipulated in anyway.

# Use the keytool command from JDK to print certificates
keytool -printcert -jarfile <APK or Magisk zip>

# The output should contain the following signature
Owner: CN=John Wu, L=Taipei, C=TW
Issuer: CN=John Wu, L=Taipei, C=TW
Serial number: 50514879
Valid from: Sun Aug 14 13:23:44 EDT 2016 until: Tue Jul 21 13:23:44 EDT 2116
Certificate fingerprints:
	 MD5:  CE:DA:68:C1:E1:74:71:0A:EF:58:89:7D:AE:6E:AB:4F
	 SHA1: DC:0F:2B:61:CB:D7:E9:D3:DB:BE:06:0B:2B:87:0D:46:BB:06:02:11
	 SHA256: B4:CB:83:B4:DA:D9:9F:99:7D:BE:87:2F:01:3A:A1:6C:14:EE:C4:1D:16:70:21:F3:71:F7:E1:33:0F:27:3E:E6
	 Signature algorithm name: SHA256withRSA
	 Version: 3

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/>.