Getting Started

Copier un prompt de configuration avec les étapes d'installation et la guide markdown complète 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.

Installer le package
Fenêtre de terminal
```
bun add @capgo/capacitor-app-attest
```
Synchroniser les projets natifs
Onglet de terminal
```
bunx cap sync
```
Configurer les exigences de la plateforme
- Terminé Configuration iOS pour la capacité App Attest et le flux de vérification backend.
- Terminé Configuration Android pour le Standard de vérification de l'intégrité Play et le flux de vérification backend.

Pourquoi utiliser ce plugin

Ce plugin fournit une API plateforme croisée tout en maintenant la sécurité de la plateforme native :

iOS: Apple App Attest (DeviceCheck)
Android: Norme de intégrité Google Play API
Pas de schéma de cryptage client personnalisé
Sorties normalisées pour les vérifications côté serveur

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`	Identifiant clé/ gestionnaire de la clé utilisé pour l'attestation
`token`	`string`	Jeton à vérifier sur votre serveur backend

Exigence du serveur backend

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

N'ayez jamais confiance dans le succès uniquement côté client.
Exigez des valeurs de challenge/payload uniques de votre serveur backend.
Vérifiez token, identité de l'application et protections de replay dans la logique de backend.

Utilisez les guides de backend spécifiques à la plateforme :

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier la sécurité et la conformité, connectez-le avec En utilisant @capgo/capacitor-app-attest pour la capacité native en utilisant En @capgo/capacitor-app-attest, Chiffrement pour les détails d'implémentation dans l'Encryption, Conformité pour les détails d'implémentation dans la Conformité, Capgo Scanner de sécurité pour le flux de travail du produit dans Capgo Scanner de sécurité, et Capgo Sécurité pour le flux de travail du produit dans Capgo Sécurité.