Prise en main

Installation

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

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

Utilisez ensuite le prompt suivant :

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

Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

1. Installer le package

   bun add @capgo/capacitor-passkey

2. Synchroniser les projets natifs

   bunx cap sync

3. Ajouter la config 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. Installer le shim lors du bootstrap

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

5. Conservez votre flux WebAuthn habituel

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

Rôle de la config du plugin

La config est lue depuis plugins.CapacitorPasskey dans capacitor.config.*.

• origin: l'origine HTTPS de la relying-party primaire utilisée par le shim et API en direct
• domains: hôtes relying-party supplémentaires à patcher dans la config native lors de la synchro
• autoShim: par défaut true et contrôle le côté natif cap sync hook d'auto-configuration

Ce que la synchronisation de patchs vous apporte

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

• iOS : entitlements des domaines associés et configuration des entitlements Xcode si nécessaire
• Android : asset_statements métadonnées et la ressource générée utilisée par le manifeste

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

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

Exemple : JSON direct API (sans shim)

Lorsque votre backend renvoie déjà du JSON WebAuthn, appelez directement les méthodes du plugin.

import { CapacitorPasskey } from '@capgo/capacitor-passkey';

const registration = await CapacitorPasskey.createCredential({
  publicKey: registrationOptionsFromServer,
});

const assertion = await CapacitorPasskey.getCredential({
  publicKey: requestOptionsFromServer,
});

Utiliser isSupported() before showing passkey UI on older devices.

Guides par plateforme

Configuration iOS

Associated Domains et apple-app-site-association.

Configuration Android

Digital Asset Links et assetlinks.json.

Notes backend

Validation d'origine et points d'attention Android.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier les flux d'authentification et de compte, le connecter à Utilisation de @capgo/capacitor-passkey pour la fonctionnalité native dans Utilisation de @capgo/capacitor-passkey, @capgo/capacitor-social-login pour les détails 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 Authentification à deux facteurs pour les détails d'implémentation de l'authentification à deux facteurs.