Getting Started

Install

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

Import

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

API Overview

isRooted

Performs the default root/jailbreak detection checks.

This is the recommended method for basic root/jailbreak detection. It runs a combination of the most reliable detection heuristics for the platform. Works on both Android and 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

Extends the default detection with BusyBox specific checks (Android only).

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

await IsRoot.isRootedWithBusyBox();

detectRootManagementApps

Detects if known root management applications are present (Android only).

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

await IsRoot.detectRootManagementApps();

detectPotentiallyDangerousApps

Detects potentially dangerous applications commonly found on rooted devices (Android only).

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

await IsRoot.detectPotentiallyDangerousApps();

detectTestKeys

Detects debug/test build tags (Android only).

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

await IsRoot.detectTestKeys();

checkForBusyBoxBinary

Checks whether a BusyBox binary exists on the device (Android only).

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

await IsRoot.checkForBusyBoxBinary();

checkForSuBinary

Checks whether a su binary is present (Android only).

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

await IsRoot.checkForSuBinary();

checkSuExists

Detects if the su binary can be executed (Android only).

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

await IsRoot.checkSuExists();

checkForRWPaths

Detects world writable system paths (Android only).

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

await IsRoot.checkForRWPaths();

checkForDangerousProps

Detects dangerous system properties (Android only).

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

await IsRoot.checkForDangerousProps();

checkForRootNative

Executes RootBeer native checks (Android only).

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

await IsRoot.checkForRootNative();

detectRootCloakingApps

Detects applications that can hide root (Android only).

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

await IsRoot.detectRootCloakingApps();

isSelinuxFlagInEnabled

Checks the SELinux enforcement state (Android only).

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

await IsRoot.isSelinuxFlagInEnabled();

isExistBuildTags

Detects test build tags on the OS image (Android only).

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

await IsRoot.isExistBuildTags();

doesSuperuserApkExist

Detects if superuser APKs are installed (Android only).

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

await IsRoot.doesSuperuserApkExist();

isExistSUPath

Checks for known su binary locations (Android only).

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

await IsRoot.isExistSUPath();

checkDirPermissions

Detects writable directories that should be protected (Android only).

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

await IsRoot.checkDirPermissions();

checkExecutingCommands

Executes which su style commands to detect root (Android only).

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

await IsRoot.checkExecutingCommands();

checkInstalledPackages

Detects suspicious installed packages (Android only).

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

await IsRoot.checkInstalledPackages();

checkforOverTheAirCertificates

Detects tampered OTA certificates (Android only).

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

await IsRoot.checkforOverTheAirCertificates();

isRunningOnEmulator

Detects common emulator fingerprints (Android only).

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

await IsRoot.isRunningOnEmulator();

simpleCheckEmulator

Performs a lightweight emulator check (Android only).

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

await IsRoot.simpleCheckEmulator();

simpleCheckSDKBF86

Detects x86 emulator fingerprints (Android only).

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

await IsRoot.simpleCheckSDKBF86();

simpleCheckQRREFPH

Detects QC reference phone builds (Android only).

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

await IsRoot.simpleCheckQRREFPH();

simpleCheckBuild

Detects build host anomalies (Android only).

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

await IsRoot.simpleCheckBuild();

checkGenymotion

Detects Genymotion emulator fingerprints (Android only).

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

await IsRoot.checkGenymotion();

checkGeneric

Detects generic emulator fingerprints (Android only).

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

await IsRoot.checkGeneric();

checkGoogleSDK

Detects Google SDK emulator fingerprints (Android only).

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

await IsRoot.checkGoogleSDK();

togetDeviceInfo

Returns device information collected during detection.

Provides additional context and metadata about the device that was gathered during the root detection process. Useful for debugging and logging purposes.

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

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

isRootedWithEmulator

Extends the default detection with emulator heuristics (Android only).

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

await IsRoot.isRootedWithEmulator();

isRootedWithBusyBoxWithEmulator

Extends the BusyBox detection with emulator heuristics (Android only).

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

await IsRoot.isRootedWithBusyBoxWithEmulator();

Type Reference

DetectionResult

Result returned by root/jailbreak detection methods.

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

Device information collected during detection.

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;
}

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Keep going from Getting Started

If you are using Getting Started to plan dashboard and API operations, connect it with Using @capgo/capacitor-is-root for the native capability in Using @capgo/capacitor-is-root, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, API Keys for the implementation detail in API Keys, and Devices for the implementation detail in Devices.