Getting Started

Copiez une invitation de configuration avec les étapes d'installation et la guide Markdown complet pour ce plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-app-attest`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/app-attest/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

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

Utilisez ensuite la prompt suivante :

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-app-attest` 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 :

Installer le package
Fenêtre de terminal
```
bun add @capgo/capacitor-app-attest
```
Synchroniser les projets natifs
Fenêtre de terminal
```
bunx cap sync
```
Configurer les exigences de la plateforme
- Terminer Paramètres iOS pour la capacité d'attestation d'applications et le flux de vérification backend.
- Complet Paramètres Android pour le standard d'intégrité de Play et le flux de vérification backend.

Pourquoi utiliser ce plugin

This plugin provides one cross-platform API while keeping native platform security:

Android : Standard d'intégrité de Google Play __CAPGO_KEEP_0__DeviceCheck)
Android: Google Play Integrity Standard API
Sorties normalisées pour les vérifications backend
Pourquoi utiliser ce plugin

Utilisation

import { AppAttest } from '@capgo/capacitor-app-attest';

const support = await AppAttest.isSupported();
if (!support.isSupported) {
  throw new Error(`Attestation not supported on ${support.platform}`);
}

const prepared = await AppAttest.prepare();

const registration = await AppAttest.createAttestation({
  keyId: prepared.keyId,
  challenge: 'backend-one-time-registration-challenge',
});

const assertion = await AppAttest.createAssertion({
  keyId: prepared.keyId,
  payload: 'backend-one-time-request-payload',
});

console.log(registration.platform, registration.format, registration.token);
console.log(assertion.platform, assertion.format, assertion.token);

Forme de réponse unifiée

createAttestation() et createAssertion() renvoyer les mêmes champs de clé sur iOS et Android :

Champ	Type	Description
`platform`	`'ios' \| 'android' \| 'web'`	Plateforme native qui a produit le jeton
`format`	`AttestationFormat`	`apple-app-attest` ou `google-play-integrity-standard`
`keyId`	`string`	Utilisez le handle du fournisseur clé pour l'attestation
`token`	`string`	Token à vérifier sur votre serveur

Exigence du serveur

L'attestation n'est utile que lorsqu'elle est vérifiée côté serveur.

Ne faites jamais confiance à la réussite uniquement côté client.
Exigez des valeurs de défi/payload uniques une fois de votre serveur.
Vérifiez tokenUtilisez la logique de protection côté serveur pour l'identité de l'application, la protection contre la reprise et les protections.

Consultez les guides du backend spécifiques au plateforme :

Continuez de Getting Started

Si vous utilisez Getting Started pour planifier la sécurité et la conformité, connectez-le avec En utilisant @capgo/capacitor-app-attest pour la capacité native dans En utilisant @capgo/capacitor-app-attest, Chiffrement pour le détail d'implémentation dans Chiffrement, Conformité pour le détail d'implémentation dans Conformité, Capgo Scanner de sécurité pour le flux de produit dans Capgo Scanner de sécurité, et Capgo Sécurité pour le flux de produit dans Capgo Sécurité