跳过内容

开始使用

  1. 安装包

    终端窗口
    bun add @capgo/capacitor-passkey
  2. 同步本机项目

    终端窗口
    bunx cap sync
  3. 添加插件配置

    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

    import { CapacitorPasskey } from '@capgo/capacitor-passkey';
    await CapacitorPasskey.autoShimWebAuthn();
  5. 保持正常的 WebAuthn 流程

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

该插件配置的作用

“插件配置的作用”

从配置文件中读取 plugins.CapacitorPasskeycapacitor.config.*.

  • originhttps://API
  • domains在同步过程中,将额外的依赖方主机名注入到本地配置中。
  • autoShim: 默认值 true 控制原生 cap sync 自动配置钩子

为你提供的同步补丁

关于“同步补丁”

当您运行时, bunx cap sync,插件会更新生成的本机主机项目:

  • iOS:当需要时,关联域名特权和 Xcode 特权编程
  • Android: asset_statements 元数据和由清单使用的生成资源

钩子不会为您发布网站信任文件。您仍然需要托管:

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