Utiliser @capgo/capacitor-passkey

Conservez votre style de navigateur WebAuthn code dans une application Capacitor tout en laissant le plugin gérer les appels de clés de passe natives et la mise à jour de l'hôte natif.

Style de navigateur API

@capgo/capacitor-passkey perpétue le même flux WebAuthn que vous utilisez déjà sur le web :

await navigator.credentials.create({ publicKey: registrationOptions });
await navigator.credentials.get({ publicKey: requestOptions });

Dans les builds natives, le plugin installe un shim pour navigator.credentials.create() et navigator.credentials.get(), transmet la demande à l'API de clés de passe iOS et Android, et retourne des objets de credenciaux similaires à ceux du navigateur à votre application.

Installer et synchroniser les projets natives

bun add @capgo/capacitor-passkey
bunx cap sync

Configurez l'application hôte une fois

Ajoutez la configuration du plugin dans capacitor.config.ts ou capacitor.config.json:

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;

Ce que fait la configuration du plugin

La configuration est lue à partir de plugins.CapacitorPasskey en capacitor.config.*.

origin: origine HTTPS primaire de l'entité de confiance utilisée par le shim et direct API
domains: hôtes supplémentaires d'entités de confiance à intégrer dans la configuration native lors de la synchronisation
autoShim: par défaut true et contrôle la configuration native cap sync l'invite de configuration automatique

Exécutez à nouveau la synchronisation après avoir modifié la configuration :

bunx cap sync

Installez le shim lors du démarrage

Importez le plugin à partir de l'entrée de package standard, puis installez le shim lors du démarrage de l'application :

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

await CapacitorPasskey.autoShimWebAuthn();

Après cela, votre clé de passe existante de style navigateur code peut rester la même.

Si vous devez forcer le shim ou définir l'origine configurée en temps de exécution, appelez :

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

CapacitorPasskey.shimWebAuthn({
  origin: 'https://signin.example.com',
});

Conservez votre flux WebAuthn normal

const credential = await navigator.credentials.create({
  publicKey: registrationOptions,
});

const assertion = await navigator.credentials.get({
  publicKey: requestOptions,
});

Quels patchs synchrones pour vous

Lors de bunx cap sync, le plugin met à jour les projets de hôte natif générés :

iOS : autorisations de domaine associées et mise en relation des autorisations Xcode lorsqu'il le faut
Android : asset_statements méta-données et les ressources générées utilisées par le manifeste

La mise en place native nécessite toujours des fichiers de confiance du site web

The plugin réduit le travail côté application, mais les clés de passe dépendent toujours des fichiers de confiance du site pour votre domaine de partie de confiance. Vous avez toujours besoin d'héberger :

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

Le plugin peut corriger les projets natifs générés lors de la synchronisation, mais il ne peut pas créer ou héberger ces fichiers de confiance du site pour vous.

Autres méthodes publiques

La version publique du plugin API expose également les assistants directs définis dans src/definitions.ts:

await CapacitorPasskey.getConfiguration() renvoie la résolution origin, domains, autoShimet actuel platform.
await CapacitorPasskey.createCredential(...) enregistre une clé de passe à partir d'un payload WebAuthn sécurisé JSON.
await CapacitorPasskey.getCredential(...) s'est authentifié avec une clé de passe existante à partir d'un payload WebAuthn sécurisé JSON.
await CapacitorPasskey.isSupported() indique si le runtime actuel prend en charge les clés de passe.
await CapacitorPasskey.getPluginVersion() renvoie la version de marque de l'implémentation native actuelle.

Guides de plateforme

Note importante iOS

Sur iOS 17.4 et versions ultérieures, le plugin utilise le client-data de style navigateur API donc l'origine HTTPS configurée est reflétée dans clientDataJSON.

Alerte importante Android

Le gestionnaire de clés Android peut partager la même partie de confiance et les clés de passe comme votre site web lorsque les liens de biens numériques sont configurés, mais l'origine d'affirmation native n'est pas identique à une origine de navigateur. Si votre serveur valide strictement clientDataJSON.originAssurez-vous que votre serveur accepte l'origine de l'application Android aux côtés de l'origine de votre site web.

Référence complète

GitHub: https://github.com/Cap-go/capacitor-passkey/
Documentation : /docs/plugins/passkey/

Continuez à partir de l'utilisation de @capgo/capacitor-passkey

Si vous utilisez Utilisez @capgo/capacitor-passkey pour planifier l'authentification et les flux de compte, connectez-le avec @capgo/capacitor-passkey pour les détails d'implémentation dans @capgo/capacitor-passkey, Prise en main pour les détails d'implémentation dans Prise en main, @capgo/capacitor-social-login pour les détails d'implémentation dans @capgo/capacitor-social-login, @capgo/capacitor-native-biometric pour les détails d'implémentation dans @capgo/capacitor-native-biometric et Authentification à deux facteurs pour le détail d'implémentation dans Authentification à deux facteurs.

Passkey

Tutoriel sur la clé de passe