Vai al contenuto

Per iniziare

GitHub

Puoi usare il nostro setup assistito dall'IA per installare il plugin. Aggiungi le skill Capgo al tuo strumento di IA usando il seguente comando:

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

Poi usa il seguente prompt:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo questi comandi e segui le istruzioni specifiche per piattaforma qui sotto:

  1. Installa il pacchetto

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

    Finestra del terminale
    bunx cap sync
  3. Aggiungi config 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 lo shim durante il bootstrap

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

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

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

  • origin: l'origine HTTPS primary relying-party usata dallo shim e API diretto
  • domains: hostname extra della relying-party da applicare alla config nativa durante la sync
  • autoShim: il valore predefinito è true e controlla la parte nativa cap sync hook di auto-configurazione

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

  • iOS: configurazione degli associated domains e degli entitlements in Xcode, se necessario
  • Android: asset_statements metadati e la risorsa generata usata dal manifest

L'hook non pubblica i file di trust del tuo sito. Devi comunque ospitare:

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

Se il tuo backend restituisce già JSON WebAuthn, chiama direttamente i metodi del plugin.

import { CapacitorPasskey } from '@capgo/capacitor-passkey';
const registration = await CapacitorPasskey.createCredential({
publicKey: registrationOptionsFromServer,
});
const assertion = await CapacitorPasskey.getCredential({
publicKey: requestOptionsFromServer,
});

Usa isSupported() before showing passkey UI on older devices.

Se stai usando Per iniziare per pianificare i flussi di autenticazione e account, collegandolo a Utilizzo di @capgo/capacitor-passkey per la funzionalità nativa in Utilizzo di @capgo/capacitor-passkey, @capgo/capacitor-social-login per i dettagli di implementazione in @capgo/capacitor-social-login, @capgo/capacitor-passkey per i dettagli di implementazione in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric per i dettagli di implementazione in @capgo/capacitor-native-biometric, e Autenticazione a due fattori per i dettagli sull'implementazione dell'autenticazione a due fattori.