Getting Started

Installation

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Zur Zwischenablage kopieren

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten angegebenen plattform-spezifischen Anweisungen befolgen:

1. Installieren Sie das Paket

   bun add @capgo/capacitor-passkey

2. Synchronisieren Sie native Projekte

   bunx cap sync

3. Fügen Sie die Plugin-Konfiguration hinzu

   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. Installieren Sie den Shim während des Bootstraps

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

5. Halten Sie Ihren normalen WebAuthn-Flow bei

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

Was die Plugin-Konfiguration tut

Die Konfiguration wird aus plugins.CapacitorPasskey in capacitor.config.*.

• origin: primäre HTTPS-Vertrauenspartei-Quelle, die vom Shim und dem direkten API verwendet wird
• domains: zusätzliche Vertrauenspartei-Hostnamen, die in die native Konfiguration während der Synchronisierung eingepflegt werden
• autoShim: standardmäßig true und steuert die native cap sync Automatisierung des Konfigurationshakens

Was die Synchronisierung für Sie patcht

When Sie das Plugin ausführen, bunx cap syncdie Plugin aktualisiert das generierte native Host-Projekt:

• iOS: Zugehörigkeitsberechtigungen für Domänen und Xcode-Zugriffsberechtigungen, wenn erforderlich
• Android: asset_statements Metadaten und die generierte Ressource, die vom Manifest verwendet wird

Der Hook veröffentlicht Ihre Website-Vertrauensdateien nicht für Sie. Sie müssen sie noch selbst hosten:

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

Plattformanleitungen

iOS-Einrichtung

Zugehörigkeitsberechtigungen für Domänen und apple-app-site-association.

Android-Einrichtung

Digitale Asset-Links und assetlinks.json.

Hintergrundinformationen

Validierung der Ursprungsadresse und Hinweise zu Android.

Weitermachen von Getting Started

Wenn Sie Getting Started zur Planung der Authentifizierung und der Kontoflows verwenden, verbinden Sie es mit Mit @capgo/capacitor-passkey für die native Fähigkeit in Mit @capgo/capacitor-passkey, @capgo/capacitor-social-login für die Implementierungsdetails in @capgo/capacitor-social-login, @capgo/capacitor-passkey für die Implementierungsdetails in @capgo/capacitor-Passkey, @capgo/capacitor-native-biometrische für die Implementierungsdetails in @capgo/capacitor-native-biometrische, und Zwei-Faktor-Authentifizierung für die Implementierungsdetails in Zwei-Faktor-Authentifizierung.