Passer à la navigation

Getting Started

  1. Installez le package

    Fenêtre de terminal
    bun add @capgo/capacitor-passkey
  2. Synchronisez les projets natifs

    Fenêtre de terminal
    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,
    });

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

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

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

  • iOS : autorisations de domaine associées et mise en œuvre d'autorisations Xcode lorsqu'il le faut
  • Android : autorisations asset_statements les métadonnées et le ressource généré utilisé par le manifeste

L'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

Si vous utilisez Démarrage pour planifier l'authentification et les flux de compte, connectez-le avec Utiliser @capgo/capacitor-passkey pour la capacité native dans Utiliser @capgo/capacitor-passkey, @capgo/capacitor-social-login pour le détail d'implémentation dans @capgo/capacitor-social-login, @capgo/capacitor-passkey pour le détail d'implémentation dans @capgo/capacitor-passkey, @capgo/capacitor-native-biometric pour le détail 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.