Getting Started

Installieren

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrer AI-Werkzeug mit folgendem Befehl hinzu:

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

Verwenden Sie dann folgende Anweisung:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten aufgeführten plattform-spezifischen Anweisungen befolgen:

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-Detektion.

Dies ist die empfohlene Methode für die grundlegende Root/Jailbreak-Detektion. Sie führt eine Combination der zuverlässigsten Detektionsheuristiken 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

Erweitert die Standardprüfungen um BusyBox-spezifische Prüfungen (nur Android).

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

await IsRoot.isRootedWithBusyBox();

detectRootManagementApps

Ermittelt, ob bekannte Root-Verwaltungsanwendungen vorhanden sind (nur Android).

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

await IsRoot.detectRootManagementApps();

detectPotentiallyDangerousApps

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

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

await IsRoot.detectPotentiallyDangerousApps();

detectTestKeys

Erkennung von Debug-/Test-Build-Labels (nur Android).

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

await IsRoot.detectTestKeys();

checkForBusyBoxBinary

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

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

await IsRoot.checkForBusyBoxBinary();

checkForSuBinary

Überprüft, ob eine su Binärdatei vorhanden ist (nur Android).

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

await IsRoot.checkForSuBinary();

checkSuExists

Erkennung, ob Su vorhanden ist su Kann als Binärdatei ausgeführt werden (nur Android).

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

await IsRoot.checkSuExists();

checkForRWPaths

Weltzugriffsberechtigte Systempfade erkennen (nur Android).

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

await IsRoot.checkForRWPaths();

checkForDangerousProps

Gefährliche Systemeigenschaften erkennen (nur Android).

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

await IsRoot.checkForDangerousProps();

checkForRootNative

Ausführt RootBeer-native-Überprüfungen (nur Android).

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

await IsRoot.checkForRootNative();

detectRootCloakingApps

Erkennen von Anwendungen, die die Root-Zugriff verbergen können (nur Android).

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

await IsRoot.detectRootCloakingApps();

isSelinuxFlagInEnabled

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

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

await IsRoot.isSelinuxFlagInEnabled();

isExistBuildTags

Erkennen von Test-Build-Labels auf dem OS-Bild (nur Android).

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

await IsRoot.isExistBuildTags();

doesSuperuserApkExist

Erkennen, ob Superuser-APKs installiert sind (nur Android).

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

await IsRoot.doesSuperuserApkExist();

isExistSUPath

Überprüft bekannte su binary Orte (nur Android).

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

await IsRoot.isExistSUPath();

checkDirPermissions

Währende schreibgeschützte Verzeichnisse erkennen, die geschützt werden sollten (nur Android).

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

await IsRoot.checkDirPermissions();

checkExecutingCommands

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

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

await IsRoot.checkExecutingCommands();

checkInstalledPackages

Verdächtige installierte Pakete erkennen (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

Ermittelt gängige Emulator- Fingerabdrücke (nur Android).

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

await IsRoot.isRunningOnEmulator();

simpleCheckEmulator

Durchführt eine leichte Überprüfung von Emulatoren (nur Android).

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

await IsRoot.simpleCheckEmulator();

simpleCheckSDKBF86

Ermittelt x86-Emulator-Fingerabdrücke (nur Android).

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

await IsRoot.simpleCheckSDKBF86();

simpleCheckQRREFPH

Erkennung von Referenz-Handys für QC (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 von Genymotion-Emulatoren (nur Android).

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

await IsRoot.checkGenymotion();

checkGeneric

Erkennung von generischen Emulatoren (nur Android).

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

await IsRoot.checkGeneric();

checkGoogleSDK

Erkennung von Google SDK-Emulatoren (nur Android).

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

await IsRoot.checkGoogleSDK();

togetDeviceInfo

Rückgabe von Geräteinformationen, die während der Erkennung gesammelt wurden.

Bietet zusätzliche Kontext- und Metadaten zum Gerät, das während des Root-Detektionsprozesses 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

Ergänzung der Standarderkennung mit Emulatorenheuristiken (nur Android).

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

await IsRoot.isRootedWithEmulator();

isRootedWithBusyBoxWithEmulator

Erweitert die BusyBox-Detektion mit Emulatorheuristiken (nur Android).

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

await IsRoot.isRootedWithBusyBoxWithEmulator();

Typenverweis

DetectionResult

Durch die root-/jailbreak-Detektionsmethoden zurückgegebener Wert.

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 wurde aus dem Plugin generiert. src/definitions.ts. Wenn sich die öffentliche API im Hintergrund ändert, führen Sie den Sync erneut durch.

Weiter zum Erste Schritt

Wenn Sie "Erste Schritt" verwenden, um das Dashboard und die __CAPGO_KEEP_0__-Operationen zu planen, verbinden Sie es mit Mit @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-is-root für die native Fähigkeit in Mit @API/__CAPGO_KEEP_1__-is-root Using @capgo/capacitor-is-root for the native capability in Using @capgo/capacitor-is-root, API Overview for the implementation detail in API Overview, Einführung für die Implementierungsdetails in Einführung API Schlüssel für die Implementierungsdetails in API Schlüssel und Geräte für die Implementierungsdetails in Geräte.