Erste Schritte

Installation

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

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

Nutze dann diesen Prompt:

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

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

1. Paket installieren

   bun add @capgo/capacitor-passkey

2. Native Projekte synchronisieren

   bunx cap sync

3. Plugin-Konfiguration hinzufügen

   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. Shim während des Bootstraps installieren

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

5. Behalte deinen normalen WebAuthn-Flow bei

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

Was die Plugin-Konfiguration bewirkt

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

• origin: primärer HTTPS-Relying-Party-Origin, der vom Shim und von direktem API genutzt wird
• domains: zusätzliche Relying-Party-Hostnames, die während des Syncs in die native Config gepatcht werden
• autoShim: Standardwert ist true und steuert den nativen cap sync Auto-Konfigurations-Hook

Was der Sync für dich patcht

Wenn du ausführst bunx cap syncausführst, aktualisiert das Plugin das generierte native Host-Projekt:

• iOS: Associated Domains Entitlements und Xcode-Entitlements-Verknüpfung bei Bedarf
• Android: asset_statements Metadaten und die vom Manifest verwendete generierte Ressource

Der Hook veröffentlicht deine Website-Trust-Dateien nicht für dich. Du musst sie weiterhin selbst hosten:

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

Beispiel: direktes JSON API (ohne Shim)

Wenn dein Backend bereits WebAuthn-JSON zurückgibt, rufe die Plugin-Methoden direkt auf.

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

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

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

Nutzt isSupported() bevor die Passkey-UI auf älteren Geräten angezeigt wird.

Plattform-Guides

iOS-Setup

Associated Domains und apple-app-site-association.

Android-Setup

Digital Asset Links und assetlinks.json.

Backend-Hinweise

Origin-Validierung und Android-Besonderheiten.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte Um Authentifizierungs- und Account-Flows zu planen, verbinde es mit @capgo/capacitor-passkey verwenden für die native Funktion in „@capgo/capacitor-passkey verwenden“, @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 zur Zwei-Faktor-Authentifizierung.