Getting Started

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous.

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

Importer

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

API Présentation

isRooted

Exécute les vérifications de détection de root/jailbreak par défaut.

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

Étend la détection par défaut avec des vérifications spécifiques à BusyBox (seulement Android).

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

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

detectRootManagementApps

Étend la détection par défaut avec des vérifications spécifiques à BusyBox (seulement Android).

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

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

detectPotentiallyDangerousApps

Détection d'applications potentiellement dangereuses courantes sur les appareils rootés (seulement Android).

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

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

detectTestKeys

Détection de balises de build de débogage/test (seulement Android).

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

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

checkForBusyBoxBinary

Vérifie l'existence d'un fichier exécutable BusyBox sur le dispositif (seulement Android).

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

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

checkForSuBinary

Vérifie si un su Le binaire est présent (seulement sur Android).

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

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

checkSuExists

Détermine si le su peut être exécuté (seulement Android).

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

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

checkForRWPaths

Détermine les chemins système mondiaux écrits (seulement Android).

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

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

checkForDangerousProps

Détermine les propriétés système dangereuses (seulement Android).

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

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

checkForRootNative

Exécute les vérifications natives de RootBeer (seulement Android).

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

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

detectRootCloakingApps

Détermine les applications qui peuvent cacher la racine (seulement Android).

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

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

isSelinuxFlagInEnabled

Vérifie l'état de mise en œuvre de SELinux (seulement Android).

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

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

isExistBuildTags

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

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

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

doesSuperuserApkExist

Détermine si des APK superutilisateurs sont installés (seulement Android).

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

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

isExistSUPath

Vérifie les emplacements connus su Section intitulée « checkDirPermissions »

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

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

checkDirPermissions

Détermine les répertoires écritures qui doivent être protégés (seulement Android).

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

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

checkExecutingCommands

Executes which su Commandes de style pour détecter la racine (seulement Android).

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

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

checkInstalledPackages

Détection de packages installés suspects (seulement Android).

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

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

checkforOverTheAirCertificates

Détection de certificats OTA altérés (seulement Android).

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

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

isRunningOnEmulator

Détection de signes d'émulateurs courants (seulement Android).

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

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

simpleCheckEmulator

Effectue une vérification d'émulateur légère (seulement Android).

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

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

simpleCheckSDKBF86

Détection des empreintes de simulateurs x86 (seulement Android).

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

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

simpleCheckQRREFPH

Détection des builds de téléphone de référence QC (seulement Android).

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

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

simpleCheckBuild

Détection d'anomalies de serveur de build (seulement Android).

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

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

checkGenymotion

Détection des empreintes de simulateurs Genymotion (seulement Android).

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

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

checkGeneric

Détection des empreintes de simulateurs génériques (seulement Android).

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

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

checkGoogleSDK

Détection des empreintes de simulateurs Google SDK (seulement Android).

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

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

togetDeviceInfo

Renvoie les informations de l'appareil collectées lors de la détection.

Fournit un contexte supplémentaire et des métadonnées sur le dispositif qui a été collecté pendant le processus de détection de la racine. Utile pour les besoins de débogage et de journalisation.

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

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

isRootedWithEmulator

Étend la détection par défaut avec des heuristiques d'émulateur (seulement Android).

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

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

isRootedWithBusyBoxWithEmulator

Étend la détection de BusyBox avec des heuristiques d'émulateur (seulement Android).

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

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

Référence de type

DetectionResult

Résultat retourné par les méthodes de détection de root/jailbreak.

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

Informations de l'appareil collectées pendant la détection.

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 De Vérité

Cette page est générée à partir du plugin’s src/definitions.ts. Re-run la synchronisation lorsque les données publiques API changent en amont.

Continuez de la page d'accueil

Si vous utilisez Getting Started pour planifier le tableau de bord et les opérations API, connectez-l’avec Utiliser @capgo/capacitor-is-root pour la capacité native dans Utiliser @capgo/capacitor-is-root, API Vue d'ensemble pour les détails d'implémentation dans API Vue d'ensemble Introduction pour les détails d'implémentation dans Introduction API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.