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-passkey` plugin in my project.

If 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 :

1. Installez le package

   bun add @capgo/capacitor-passkey

2. Synchroniser les projets natifs

   bunx cap sync

3. Ajoutez la configuration du plugin

   import type { CapacitorConfig } from '@capacitor/cli';
   
   const config: CapacitorConfig = {
     appId: 'app.capgo.passkey.example',
     appName: 'My App',
     webDir: 'dist',
     plugins: {
       CapacitorPasskey: {
         origin: 'https://signin.example.com',
         autoShim: true,
         domains: ['signin.example.com'],
       },
     },
   };
   
   export default config;

4. Installez le shim lors du démarrage

   import { CapacitorPasskey } from '@capgo/capacitor-passkey';
   
   await CapacitorPasskey.autoShimWebAuthn();

5. Conservez votre flux WebAuthn normal

   const registration = await navigator.credentials.create({
     publicKey: registrationOptions,
   });
   
   const authentication = await navigator.credentials.get({
     publicKey: requestOptions,
   });

Ce que fait la configuration du plugin

La configuration est lue à partir de plugins.CapacitorPasskey en capacitor.config.*.

• origin: origine HTTPS primaire utilisée par le shim et direct API
• domains: hôtes de dépendance supplémentaires à intégrer dans la configuration native lors de la synchronisation
• autoShim: par défaut true et contrôle la mise en œuvre auto de la configuration native cap sync Hook de configuration auto pour la mise en œuvre native

Ce que les synchronisations patchent pour vous

Lorsque vous exécutez bunx cap sync; le plugin met à jour le projet de hôte natif généré :

• iOS : les autorisations de domaine associées et la mise en relation des autorisations Xcode lorsque nécessaire
• Android : asset_statements les métadonnées et les ressources générées utilisées par le manifeste

Le hook ne publie pas vos fichiers de confiance pour le site web. Vous devez toujours les héberger :

• https://your-domain/.well-known/apple-app-site-association
• https://your-domain/.well-known/assetlinks.json

Guides de plateforme

Configuration iOS

Domaines associés et apple-app-site-association.

Configuration Android

Liens d'actif numérique et assetlinks.json.

Notes de backend

Validation de l'origine et les avertissements Android.

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier l'authentification et les flux de compte, connectez-le avec Utilisation de @capgo/capacitor-passkey pour la capacité native dans Utilisation de @capgo/capacitor-passkey, @capgo/capacitor-social-login pour le détail d'implémentation dans @capgo/capacitor-social-login, @capgo/capacitor-passkey pour les détails d'implémentation dans @capgo/capacitor-passkey, @capgo/capacitor-native-biometric pour les détails d'implémentation dans @capgo/capacitor-native-biometric, et L'authentification à deux facteurs pour les détails d'implémentation dans L'authentification à deux facteurs.