Saltare al contenuto

Getting Started

GitHub
  1. Installa il pacchetto

    Finestra del terminale
    bun add @capgo/capacitor-passkey
  2. Sincronizza progetti nativi

    Finestra del terminale
    bunx cap sync
  3. Aggiungi la configurazione del 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. Installa il shim durante l'avvio

    import { CapacitorPasskey } from '@capgo/capacitor-passkey';
    await CapacitorPasskey.autoShimWebAuthn();
  5. Mantieni il tuo flusso WebAuthn normale

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

La configurazione viene letta da plugins.CapacitorPasskey in capacitor.config.*.

  • origin: l'origine HTTPS primaria del partito di rilievo utilizzata dal shim e diretto API
  • domains: i nomi di host del partito di rilievo aggiuntivi da patchare nella configurazione nativa durante la sincronizzazione
  • autoShim: predefinito true e controlla la nativa cap sync hook di auto-configurazione

Quando esegui bunx cap sync, il plugin aggiorna il progetto host nativo generato:

  • iOS: autorizzazioni ai domini associati e autorizzazioni Xcode quando necessario
  • Android: asset_statements metadati e il risorsa generata utilizzata dal manifesto

Lo hook non pubblica i file di trust del tuo sito per te. Hai ancora bisogno di ospitare:

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

Guida per piattaforma

Guida alla piattaforma

Se stai utilizzando Guida introduttiva per pianificare l'autenticazione e i flussi di account, connettilo con Usando @capgo/capacitor-passkey per la capacità nativa in Usando @capgo/capacitor-passkey, @capgo/capacitor-social-login per il dettaglio di implementazione in @capgo/capacitor-social-login, @capgo/capacitor-passkey per il dettaglio di implementazione in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric per il dettaglio di implementazione in @capgo/capacitor-native-biometric, e Due fattori di autenticazione per il dettaglio di implementazione in Due fattori di autenticazione.