Anfangen

Installation

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie folgenden Befehl ausführen:

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

Verwenden Sie dann die folgende Anfrage:

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. Behalten Sie Ihren normalen WebAuthn-Fluss 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: Haupt-HTTPS-Anbieter-URL, die vom Shim und direkt vom API verwendet wird
• domains: zusätzliche Anbieter-Hostnamen, die in die native Konfiguration während der Synchronisierung eingepflegt werden
• autoShim: standardmäßig true und steuert die native cap sync Automatisierungskonfigurations-Hook

Wie synchronisiert Patchs für Sie

Wenn Sie es ausführen bunx cap sync, das Plugin aktualisiert das generierte native Host-Projekt:

• iOS: Domänenzugehörigkeiten und Xcode-Zugriffsrechte, wenn erforderlich
• Android: asset_statements Metadaten und das generierte Ressourcen, das 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

Führer für Plattformen

iOS-Einrichtung

Zugehörige Domains und apple-app-site-association.

Android-Einrichtung

Digitale Asset Links und assetlinks.json.

Hinweise zum Backend

Origin-Validierung und Android-Hinweise.

Fahren Sie mit dem Getting Started

Wenn Sie Getting Started zur Planung der Authentifizierung und der Kontoflows verwenden, verbinden Sie es mit Verwenden Sie @capgo/capacitor-passkey für die native Fähigkeit in Verwenden Sie @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-biometric für die Implementierungsdetails in @capgo/capacitor-native-biometric und Zwei-Faktor-Authentifizierung für die Implementierungsdetails in Zwei-Faktor-Authentifizierung.