Shizuku README

The project's README from github.com/RikkaApps/Shizuku. As one markdown file: README.md.

Shizuku

Background

When developing apps that requires root, the most common method is to run some commands in the su shell. For example, there is an app that uses the pm enable/disable command to enable/disable components.

This method has very big disadvantages:

  1. Extremely slow (Multiple process creation)
  2. Needs to process texts (Super unreliable)
  3. The possibility is limited to available commands
  4. Even if ADB has sufficient permissions, the app requires root privileges to run

Shizuku uses a completely different way. See detailed description below.

User guide & Download

https://shizuku.rikka.app/

How does Shizuku work?

First, we need to talk about how app use system APIs. For example, if the app wants to get installed apps, we all know we should use PackageManager#getInstalledPackages(). This is actually an interprocess communication (IPC) process of the app process and system server process, just the Android framework did the inner works for us.

Android uses binder to do this type of IPC. Binder allows the server-side to learn the uid and pid of the client-side, so that the system server can check if the app has the permission to do the operation.

Usually, if there is a "manager" (e.g., PackageManager) for apps to use, there should be a "service" (e.g., PackageManagerService) in the system server process. We can simply think if the app holds the binder of the "service", it can communicate with the "service". The app process will receive binders of system services on start.

Shizuku guides users to run a process, Shizuku server, with root or ADB first. When the app starts, the binder to Shizuku server will also be sent to the app.

The most important feature Shizuku provides is something like be a middle man to receive requests from the app, sent them to the system server, and send back the results. You can see the transactRemote method in rikka.shizuku.server.ShizukuService class, and moe.shizuku.api.ShizukuBinderWrapper class for the detail.

So, we reached our goal, to use system APIs with higher permission. And to the app, it is almost identical to the use of system APIs directly.

Developer guide

API & sample

https://github.com/RikkaApps/Shizuku-API

Migrating from pre-v11

Existing applications still works, of course.

https://github.com/RikkaApps/Shizuku-API#migration-guide-for-existing-applications-use-shizuku-pre-v11

Attention

  1. ADB permissions are limited

    ADB has limited permissions and different on various system versions. You can see permissions granted to ADB here.

    Before calling the API, you can use ShizukuService#getUid to check if Shizuku is running user ADB, or use ShizukuService#checkPermission to check if the server has sufficient permissions.

  2. Hidden API limitation from Android 9

    As of Android 9, the usage of the hidden APIs is limited for normal apps. Please use other methods (such as https://github.com/LSPosed/AndroidHiddenApiBypass).

  3. Android 8.0 & ADB

    At present, the way Shizuku service gets the app process is to combine IActivityManager#registerProcessObserver and IActivityManager#registerUidObserver (26+) to ensure that the app process will be sent when the app starts. However, on API 26, ADB lacks permissions to use registerUidObserver, so if you need to use Shizuku in a process that might not be started by an Activity, it is recommended to trigger the send binder by starting a transparent activity.

  4. Direct use of transactRemote requires attention

    • The API may be different under different Android versions, please be sure to check it carefully. Also, the android.app.IActivityManager has the aidl form in API 26 and later, and android.app.IActivityManager$Stub exists only on API 26.

    • SystemServiceHelper.getTransactionCode may not get the correct transaction code, such as android.content.pm.IPackageManager$Stub.TRANSACTION_getInstalledPackages does not exist on API 25 and there is android.content.pm.IPackageManager$Stub.TRANSACTION_getInstalledPackages_47 (this situation has been dealt with, but it is not excluded that there may be other circumstances). This problem is not encountered with the ShizukuBinderWrapper method.

Developing Shizuku itself

Build

The :manager:assembleDebug task generates a debuggable server. You can attach a debugger to shizuku_server to debug the server. Be aware that, in Android Studio, "Run/Debug configurations" - "Always install with package manager" should be checked, so that the server will use the latest code.

License

All code files in this project are licensed under Apache 2.0

Under Apache 2.0 section 6, specifically:

Shizuku (RikkaApps/Shizuku)

Searching Database…

31.6K ·GitHub
Shizuku
Что это такое?Shizuku позволяет обычным Android-приложениям вызывать привилегированные системные API с правами ADB или root. Для этого запускается небольшой Java-сервер через app_process, вместо вызова команд su через оболочку.
Это приложение или библиотека, которую я добавляю в свой проект?И то, и другое: Shizuku — это приложение-менеджер, которое пользователи устанавливают на устройство через ADB, а также библиотека (ShizukuBinderWrapper, API ShizukuService), которую разработчики сторонних приложений подключают, чтобы обращаться к этому серверу.
Как это запустить?Обычные пользователи устанавливают приложение-менеджер Shizuku и запускают службу через ADB или root; разработчики клонируют репозиторий вместе с сабмодулями и собирают модуль менеджера с помощью Gradle (assembleDebug или assembleRelease).
Мне нужен root или подойдет и ADB?Подходит любой вариант: Shizuku может работать с правами ADB или root, но доступ через ADB ограничен сильнее и зависит от версии Android.
При прямом использовании API есть подводные камни?Скрытые API ограничены на Android 9 и новее, наборы прав ADB различаются в зависимости от версии ОС, для API 26 при определении процесса нужны обходные решения, а коды транзакций, используемые в прямых вызовах transactRemote, могут отличаться в разных версиях Android.
Лицензия полностью свободная?Apache 2.0 с дополнительным пунктом, который запрещает другим приложениям использовать значок приложения, название «Shizuku» или его application id/строку разрешения.
Зачем нужен Shizuku, если можно просто запускать команды su?Вызов команд через su медленный (запускает несколько процессов), требует хрупкого разбора текстового вывода команд и ограничен тем, какие команды вообще существуют. Shizuku же запускает постоянно работающий Java-сервер, поэтому приложения вызывают настоящие системные API напрямую.
Для чего нужен ShizukuBinderWrapper?Это рекомендуемый способ вызывать методы системных служб binder через Shizuku. Он также избавляет от несовпадения кодов транзакций между версиями Android, которое может возникать при прямых вызовах transactRemote.
Может ли Shizuku работать, если приложение запускается без Activity?На Android 8.0 с ADB определение процесса опирается на registerUidObserver, который ADB на API 26 использовать не может, поэтому приложениям, которые могут запускаться без Activity, рекомендуется запускать прозрачную Activity для регистрации binder.
What are similar projects?timber, GSYVideoPlayer, MaterialDrawer, MVPArms, Vector, hilight-studio, butterknife, EventBus
Which topics is it in?adb, root, android-development, android-library, mobile-development, kotlin, mobile, android, security, apache-2.0, library, developer-tools
Creator
RikkaApps
Size
38.1 MB
Stars
31.6K
Updated
CommitJun 18Releasev13.6.0May 25
Age
9y
Commits · 90 Days