Einstieg

Installieren

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

Importieren

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

API Übersicht

isRooted

Durchführt die Standardprüfungen für Root/Jailbreak.

Dies ist die empfohlene Methode für grundlegende Root/Jailbreak-Prüfungen. Sie führt eine Combination der zuverlässigsten Erkennungsheuristiken für die Plattform aus. Funktioniert auf beiden Android und 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

Ergänzt die Standarddetektion mit BusyBox-spezifischen Überprüfungen (nur Android).

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

await IsRoot.isRootedWithBusyBox();

detectRootManagementApps

Ermittelt, ob bekannte Anwendungen zur Verwaltung von Root-Rechten vorhanden sind (nur Android).

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

await IsRoot.detectRootManagementApps();

detectPotentiallyDangerousApps

Ermittelt potenziell gefährliche Anwendungen, die häufig auf Root-Geräten vorkommen (nur Android).

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

await IsRoot.detectPotentiallyDangerousApps();

detectTestKeys

Ermittelt Debug-/Test-Build-Tags (nur Android).

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

await IsRoot.detectTestKeys();

checkForBusyBoxBinary

Überprüft, ob ein BusyBox-Binary auf dem Gerät (nur Android) vorhanden ist.

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

await IsRoot.checkForBusyBoxBinary();

checkForSuBinary

Überprüft, ob ein su Binary vorhanden ist (nur Android).

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

await IsRoot.checkForSuBinary();

checkSuExists

Ermittelt, ob das su Binary auf dem Gerät ausgeführt werden kann (nur Android).

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

await IsRoot.checkSuExists();

checkForRWPaths

Detektet weltweit schreibbare Systempfade (nur Android).

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

await IsRoot.checkForRWPaths();

checkForDangerousProps

Detektet gefährliche Systemeigenschaften (nur Android).

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

await IsRoot.checkForDangerousProps();

checkForRootNative

Ausführt RootBeer native Prüfungen (nur Android).

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

await IsRoot.checkForRootNative();

detectRootCloakingApps

Detektet Anwendungen, die das Root-Verstecken ermöglichen (nur Android).

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

await IsRoot.detectRootCloakingApps();

isSelinuxFlagInEnabled

Überprüft den SELinux-Einsatzszustand (nur Android).

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

await IsRoot.isSelinuxFlagInEnabled();

isExistBuildTags

Erkennung von Build-Tags für Tests auf dem Betriebssystem-Image (nur Android).

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

await IsRoot.isExistBuildTags();

doesSuperuserApkExist

Erkennung von installierten Superuser-APKs (nur Android).

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

await IsRoot.doesSuperuserApkExist();

isExistSUPath

Überprüfung bekannter su binary-Ortungen (nur Android).

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

await IsRoot.isExistSUPath();

checkDirPermissions

Ermittelt schreibbare Verzeichnisse, die geschützt werden sollten (nur Android).

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

await IsRoot.checkDirPermissions();

checkExecutingCommands

Ausführt which su Stil-Befehle, um Root zu erkennen (nur Android).

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

await IsRoot.checkExecutingCommands();

checkInstalledPackages

Ermittelt verdächtige installierte Pakete (nur Android).

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

await IsRoot.checkInstalledPackages();

checkforOverTheAirCertificates

Ermittelt manipulierte OTA-Zertifikate (nur Android).

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

await IsRoot.checkforOverTheAirCertificates();

isRunningOnEmulator

Erkennung von häufigen Emulatormerkmalen (nur Android).

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

await IsRoot.isRunningOnEmulator();

simpleCheckEmulator

Durchführung eines leichten Emulatortests (nur Android).

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

await IsRoot.simpleCheckEmulator();

simpleCheckSDKBF86

Erkennung von x86-Emulatormerkmalen (nur Android).

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

await IsRoot.simpleCheckSDKBF86();

simpleCheckQRREFPH

Erkennung von QC-Referenztelefon-Software (nur Android).

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

await IsRoot.simpleCheckQRREFPH();

simpleCheckBuild

Erkennung von Anomalien des Build-Hosts (nur Android).

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

await IsRoot.simpleCheckBuild();

checkGenymotion

Erkennung von Fingerabdrücken des Genymotion-Emulators (nur Android).

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

await IsRoot.checkGenymotion();

checkGeneric

Erkennung von generischen Emulator-Fingerabdrücken (nur Android).

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

await IsRoot.checkGeneric();

checkGoogleSDK

Erkennung von Google SDK-Emulator-Fingerabdrücken (nur Android).

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

await IsRoot.checkGoogleSDK();

togetDeviceInfo

Gibt Informationen über das Gerät zurück, die während der Erkennung gesammelt wurden.

Bietet zusätzliche Kontext- und Metadaten über das Gerät, das während des Root-Erkennungsprozesses gesammelt wurde. Nützlich für Debugging- und Protokollierungszwecke.

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

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

isRootedWithEmulator

Erweitert die Standarderkennung mit Emulatoreheuristiken (nur Android).

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

await IsRoot.isRootedWithEmulator();

isRootedWithBusyBoxWithEmulator

Erweitert die Erkennung von BusyBox mit Emulatoreheuristiken (nur Android).

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

await IsRoot.isRootedWithBusyBoxWithEmulator();

Typenverweis

DetectionResult

Ergibt durch die root-/jailbreak-Detektionsmethoden.

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

Geräteinformationen, die während der Detektion gesammelt werden.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.