快速入门

复制包含安装步骤和该插件完整 Markdown 指南的配置 prompt。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-is-root`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/is-root/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

安装

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-is-root` plugin in my project.

如果你更想手动设置，请运行以下命令安装插件，并按照下方各平台的说明操作：

bun add @capgo/capacitor-is-root
bunx cap sync

导入

import { IsRoot } from '@capgo/capacitor-is-root';

快速入门

import { IsRoot } from '@capgo/capacitor-is-root';

const { result } = await IsRoot.isRooted();
if (result) {
  blockSensitiveFlow();
}

示例：Android 模拟器信号

默认情况下不包含模拟器检测 isRooted()。如果策略需要，请显式调用。

const { result } = await IsRoot.isRunningOnEmulator();

示例：更深入的 Android 审计

const checks = await Promise.all([
  IsRoot.detectRootManagementApps(),
  IsRoot.checkForSuBinary(),
]);

常见坑点

iOS 模拟器：始终报告未越狱，请在真机上测试。
误报: 将 root 检测与服务端风险评分相结合，而不仅仅是直接导致程序崩溃。
应用商店政策: 屏蔽所有已 root 的用户可能会与您的应用商店分类冲突，请务必记录相关的 UX 设计。

API 概览

`isRooted`

执行默认的 root/jailbreak 检测。

这是进行基础 root/jailbreak 检测的推荐方法。它结合了该平台最可靠的检测启发式算法。同时支持 Android 和 iOS。

import { IsRoot } from '@capgo/capacitor-is-root';

const { result } = await IsRoot.isRooted();
if (result) {
  console.log('Device is rooted/jailbroken');
} else {
  console.log('Device is not rooted/jailbroken');
}

`isRootedWithBusyBox`

在默认检测的基础上增加了针对 BusyBox 的特定检测（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.isRootedWithBusyBox();
console.log(result);

`detectRootManagementApps`

检测是否存在已知的 Root 管理应用（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.detectRootManagementApps();
console.log(result);

`detectPotentiallyDangerousApps`

检测 Root 设备上常见的潜在危险应用（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.detectPotentiallyDangerousApps();
console.log(result);

`detectTestKeys`

检测 debug/test 构建标签（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.detectTestKeys();
console.log(result);

`checkForBusyBoxBinary`

检查设备上是否存在 BusyBox 二进制文件（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkForBusyBoxBinary();
console.log(result);

`checkForSuBinary`

检查是否存在 su 二进制文件（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkForSuBinary();
console.log(result);

`checkSuExists`

检测该 su 二进制文件是否可执行（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkSuExists();
console.log(result);

`checkForRWPaths`

检测全局可写的系统路径（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkForRWPaths();
console.log(result);

`checkForDangerousProps`

检测危险的系统属性（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkForDangerousProps();
console.log(result);

`checkForRootNative`

执行 RootBeer 原生检查（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkForRootNative();
console.log(result);

`detectRootCloakingApps`

检测可以隐藏 Root 权限的应用（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.detectRootCloakingApps();
console.log(result);

`isSelinuxFlagInEnabled`

检查 SELinux 强制执行状态（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.isSelinuxFlagInEnabled();
console.log(result);

`isExistBuildTags`

检测 OS 镜像上的测试 build 标签（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.isExistBuildTags();
console.log(result);

`doesSuperuserApkExist`

检测是否安装了 superuser APK（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.doesSuperuserApkExist();
console.log(result);

`isExistSUPath`

检查已知的 su binary 位置（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.isExistSUPath();
console.log(result);

`checkDirPermissions`

检测需要保护的可写目录（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkDirPermissions();
console.log(result);

`checkExecutingCommands`

执行 which su 用于检测 Root 权限的 style 命令（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkExecutingCommands();
console.log(result);

`checkInstalledPackages`

检测可疑的已安装包（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkInstalledPackages();
console.log(result);

`checkforOverTheAirCertificates`

检测被篡改的 OTA 证书（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkforOverTheAirCertificates();
console.log(result);

`isRunningOnEmulator`

检测常见的模拟器特征（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.isRunningOnEmulator();
console.log(result);

`simpleCheckEmulator`

执行轻量级模拟器检查（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.simpleCheckEmulator();
console.log(result);

`simpleCheckSDKBF86`

检测 x86 模拟器特征（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.simpleCheckSDKBF86();
console.log(result);

`simpleCheckQRREFPH`

检测 QC 参考机型构建（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.simpleCheckQRREFPH();
console.log(result);

`simpleCheckBuild`

检测构建主机异常（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.simpleCheckBuild();
console.log(result);

`checkGenymotion`

检测 Genymotion 模拟器特征码（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkGenymotion();
console.log(result);

`checkGeneric`

检测通用模拟器特征码（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkGeneric();
console.log(result);

`checkGoogleSDK`

检测 Google SDK 模拟器特征码（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.checkGoogleSDK();
console.log(result);

`togetDeviceInfo`

返回检测过程中收集到的设备信息。

提供在 Root 检测过程中收集的设备额外上下文和元数据。适用于调试和日志记录。

import { IsRoot } from '@capgo/capacitor-is-root';

const deviceInfo = await IsRoot.togetDeviceInfo();
console.log('Device info:', deviceInfo);

`isRootedWithEmulator`

通过模拟器启发式算法扩展默认检测功能（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.isRootedWithEmulator();
console.log(result);

`isRootedWithBusyBoxWithEmulator`

通过模拟器启发式算法扩展 BusyBox 检测功能（仅限 Android）。

import { IsRoot } from '@capgo/capacitor-is-root';

const result = await IsRoot.isRootedWithBusyBoxWithEmulator();
console.log(result);

类型参考

`DetectionResult`

Root/越狱检测方法返回的结果。

export interface DetectionResult {
  /**
   * `true` when the associated heuristic detects root/jailbreak artifacts.
   * `false` when no root/jailbreak indicators are found.
   *
   * @since 1.0.0
   */
  result: boolean;
}

`DeviceInfo`

检测过程中收集的设备信息。

export interface DeviceInfo {
  /**
   * Arbitrary key/value device metadata populated by the native implementation.
   * Contents vary by platform and detection methods used.
   *
   * @since 1.0.0
   */
  [key: string]: any;
}

单一事实来源

本页面由插件的 src/definitions.ts生成。当上游的公共 API 发生变化时，请重新运行 sync。

从入门指南继续

如果你正在使用 快速入门 要规划 dashboard 和 API 操作，请将其连接到使用 @capgo/capacitor-is-root 在使用 @capgo/capacitor-is-root 时，获取原生能力的方法： API 概览关于 API Overview 中的实现细节，简介关于 Introduction 中的实现细节， API 密钥有关 API Keys 的实现细节，以及设备有关 Devices 的实现细节。