Démarrage

Installer

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 Vue d'ensemble

isRooted

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

Cette méthode est recommandée pour la détection de base de root/jailbreak. Elle exécute une combinaison des heuristiques de détection les plus fiables pour la plateforme. Fonctionne sur Android et 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';

await IsRoot.isRootedWithBusyBox();

detectRootManagementApps

Détermine si des applications de gestion de root connues sont présentes (seulement Android).

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

await IsRoot.detectRootManagementApps();

detectPotentiallyDangerousApps

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

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

await IsRoot.detectPotentiallyDangerousApps();

detectTestKeys

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

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

await IsRoot.detectTestKeys();

checkForBusyBoxBinary

Vérifie si un fichier exécutable BusyBox existe sur l'appareil (seulement Android).

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

await IsRoot.checkForBusyBoxBinary();

checkForSuBinary

Vérifie si un fichier exécutable est présent (seulement Android). su Copier dans le presse-papier

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

await IsRoot.checkForSuBinary();

checkSuExists

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

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

await IsRoot.checkSuExists();

checkForRWPaths

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

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

await IsRoot.checkForRWPaths();

checkForDangerousProps

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

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

await IsRoot.checkForDangerousProps();

checkForRootNative

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

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

await IsRoot.checkForRootNative();

detectRootCloakingApps

Détection d'applications pouvant cacher la racine (seulement Android).

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

await IsRoot.detectRootCloakingApps();

isSelinuxFlagInEnabled

Vérifie l'état d'application de SELinux (seulement Android).

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

await IsRoot.isSelinuxFlagInEnabled();

isExistBuildTags

Détection de balises de build de test sur l'image du système (seulement Android).

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

await IsRoot.isExistBuildTags();

doesSuperuserApkExist

Détection d'APKs superutilisateur installés (seulement Android).

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

await IsRoot.doesSuperuserApkExist();

isExistSUPath

Vérifie les emplacements de fichiers binaires connus (seulement Android). su Copier dans le presse-papier

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

await IsRoot.isExistSUPath();

checkDirPermissions

Copier dans le presse-papier

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

await IsRoot.checkDirPermissions();

checkExecutingCommands

Copier dans le presse-papier which su Section intitulée « checkExecutingCommands »

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

await IsRoot.checkExecutingCommands();

checkInstalledPackages

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

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

await IsRoot.checkInstalledPackages();

checkforOverTheAirCertificates

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

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

await IsRoot.checkforOverTheAirCertificates();

isRunningOnEmulator

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

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

await IsRoot.isRunningOnEmulator();

simpleCheckEmulator

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

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

await IsRoot.simpleCheckEmulator();

simpleCheckSDKBF86

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

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

await IsRoot.simpleCheckSDKBF86();

simpleCheckQRREFPH

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

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

await IsRoot.simpleCheckQRREFPH();

simpleCheckBuild

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

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

await IsRoot.simpleCheckBuild();

checkGenymotion

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

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

await IsRoot.checkGenymotion();

checkGeneric

Détection de traces d'émulateurs génériques (seulement Android).

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

await IsRoot.checkGeneric();

checkGoogleSDK

Détection de traces d'émulateurs Google SDK (seulement Android).

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

await IsRoot.checkGoogleSDK();

togetDeviceInfo

Renvoi des informations sur le dispositif collectées pendant 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'émulateurs (seulement Android).

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

await IsRoot.isRootedWithEmulator();

isRootedWithBusyBoxWithEmulator

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

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

await IsRoot.isRootedWithBusyBoxWithEmulator();

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 sur le dispositif 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 Of Truth

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

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier le tableau de bord et les opérations API, connectez-le avec Utilisation de @capgo/capacitor-is-root pour la capacité native dans Utilisation de @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.