Saltar al contenido

Getting Started

GitHub
  1. Instale el paquete

    Ventana de terminal
    bun add @capgo/capacitor-passkey
  2. Sincronice proyectos nativos

    Ventana de terminal
    bunx cap sync
  3. Agregar la configuración 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. Instalar el shim durante el arranque

    import { CapacitorPasskey } from '@capgo/capacitor-passkey';
    await CapacitorPasskey.autoShimWebAuthn();
  5. Mantenga su flujo WebAuthn normal

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

¿Qué hace la configuración del plugin?

¿Qué hace la configuración del plugin?

La configuración se lee de plugins.CapacitorPasskey en capacitor.config.*.

  • origin: origen de HTTPS primario de la parte de confianza utilizada por el shim y directo API
  • domains: nombres de host de la parte de confianza adicionales para parchear en la configuración nativa durante la sincronización
  • autoShim: predetermina true y controla la configuración nativa cap sync hook de autoconfiguración

¿Qué parches de sincronización te sincronizan?

Sección titulada “¿Qué parches de sincronización te sincronizan?”

Cuando ejecutas bunx cap sync, el plugin actualiza el proyecto de host nativo generado:

  • iOS: permisos de dominios asociados y configuración de Xcode cuando sea necesario
  • Android: asset_statements metadatos y el recurso generado utilizado por el manifiesto

El hook no publica los archivos de confianza de tu sitio web por ti. Todavía necesitas alojar:

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

Guías de plataforma

Guías de plataforma

Si estás utilizando Inicio rápido para planificar la autenticación y los flujos de cuenta, conecta con Usando @capgo/capacitor-passkey para la capacidad nativa en Usando @capgo/capacitor-passkey, @capgo/capacitor-social-login para el detalle de implementación en @capgo/capacitor-social-login, @capgo/capacitor-passkey para el detalle de implementación en @capgo/capacitor-passkey, @capgo/capacitor-native-biometric para el detalle de implementación en @capgo/capacitor-native-biometric, y Autenticación de dos factores para el detalle de implementación en Autenticación de dos factores.