@capgo/capacitor-is-root
Capacitor Is Root Plugin for detecting rooted (Android) or jailbroken (iOS) devices.
Overview
Section titled “Overview”Capacitor Is Root Plugin for detecting rooted (Android) or jailbroken (iOS) devices.
Core Capabilities
Section titled “Core Capabilities”isRooted- Performs the default root/jailbreak detection checks.isRootedWithBusyBox- Extends the default detection with BusyBox specific checks (Android only).detectRootManagementApps- Detects if known root management applications are present (Android only).detectPotentiallyDangerousApps- Detects potentially dangerous applications commonly found on rooted devices (Android only).
Public API
Section titled “Public API”| Method | Description |
|---|---|
isRooted | Performs the default root/jailbreak detection checks. |
isRootedWithBusyBox | Extends the default detection with BusyBox specific checks (Android only). |
detectRootManagementApps | Detects if known root management applications are present (Android only). |
detectPotentiallyDangerousApps | Detects potentially dangerous applications commonly found on rooted devices (Android only). |
detectTestKeys | Detects debug/test build tags (Android only). |
checkForBusyBoxBinary | Checks whether a BusyBox binary exists on the device (Android only). |
checkForSuBinary | Checks whether a su binary is present (Android only). |
checkSuExists | Detects if the su binary can be executed (Android only). |
checkForRWPaths | Detects world writable system paths (Android only). |
checkForDangerousProps | Detects dangerous system properties (Android only). |
checkForRootNative | Executes RootBeer native checks (Android only). |
detectRootCloakingApps | Detects applications that can hide root (Android only). |
isSelinuxFlagInEnabled | Checks the SELinux enforcement state (Android only). |
isExistBuildTags | Detects test build tags on the OS image (Android only). |
doesSuperuserApkExist | Detects if superuser APKs are installed (Android only). |
isExistSUPath | Checks for known su binary locations (Android only). |
checkDirPermissions | Detects writable directories that should be protected (Android only). |
checkExecutingCommands | Executes which su style commands to detect root (Android only). |
checkInstalledPackages | Detects suspicious installed packages (Android only). |
checkforOverTheAirCertificates | Detects tampered OTA certificates (Android only). |
isRunningOnEmulator | Detects common emulator fingerprints (Android only). |
simpleCheckEmulator | Performs a lightweight emulator check (Android only). |
simpleCheckSDKBF86 | Detects x86 emulator fingerprints (Android only). |
simpleCheckQRREFPH | Detects QC reference phone builds (Android only). |
simpleCheckBuild | Detects build host anomalies (Android only). |
checkGenymotion | Detects Genymotion emulator fingerprints (Android only). |
checkGeneric | Detects generic emulator fingerprints (Android only). |
checkGoogleSDK | Detects Google SDK emulator fingerprints (Android only). |
togetDeviceInfo | Returns device information collected during detection. |
isRootedWithEmulator | Extends the default detection with emulator heuristics (Android only). |
isRootedWithBusyBoxWithEmulator | Extends the BusyBox detection with emulator heuristics (Android only). |
getPluginVersion | Get the native Capacitor plugin version. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-is-root.