Passkey Plugin Capacitor

Menggunakan @capgo/capacitor-passkey

Tetapkan browser-style WebAuthn code di aplikasi Capacitor sambil plugin mengelola panggilan passkey native dan patching host native.

Browser-style API

@capgo/capacitor-passkey Menggunakan aliran WebAuthn yang sama seperti yang Anda gunakan di web.

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

Pada bangun native, plugin menginstal shim untuk navigator.credentials.create() dan navigator.credentials.get(), mengirimkan permintaan ke API passkey iOS dan Android, dan mengembalikan objek kreditur seperti browser ke aplikasi Anda.

Pasang dan sinkronkan proyek native

bun add @capgo/capacitor-passkey
bunx cap sync

Konfigurasi aplikasi host sekali saja

Tambahkan konfigurasi plugin di capacitor.config.ts atau 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;

Apa yang dilakukan konfigurasi plugin

Konfigurasi dibaca dari plugins.CapacitorPasskey di capacitor.config.*.

• origin: asal HTTPS utama yang dipakai oleh shim dan API
• domains: nama host tambahan yang dipakai untuk memperbaiki konfigurasi native selama sinkronisasi
• autoShim: default ke true dan mengontrol native cap sync hook konfigurasi otomatis

Jalankan sinkronisasi lagi setelah mengubah konfigurasi:

bunx cap sync

Instal shim selama proses bootstrapping

Import plugin dari entri pintu standar, kemudian instal shim selama proses bootstrapping aplikasi:

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

await CapacitorPasskey.autoShimWebAuthn();

After that, your existing browser-style passkey code can stay the same.

Jika Anda perlu memaksa shim atau mengganti asal yang dikonfigurasi pada waktu runtime, panggil:

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

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

Tetapkan aliran WebAuthn normal Anda

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

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

Apa saja patch sinkronisasi yang Anda butuhkan

Pada saat bunx cap sync, plugin ini memperbarui proyek host native yang dihasilkan:

• iOS: hak akses domain terkait dan pengaturan Xcode ketika diperlukan
• Android: asset_statements metadata dan sumber daya yang dihasilkan oleh manifest

Konfigurasi native masih memerlukan file kepercayaan situs

Plugin ini mengurangi pekerjaan di sisi aplikasi, tetapi passkeys masih bergantung pada file kepercayaan situs untuk domain pihak yang dipercaya Anda. Anda masih perlu menyimpan:

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

Plugin ini dapat memperbaiki proyek native yang dihasilkan selama sinkronisasi, tetapi tidak dapat membuat atau menyimpan file-file kepercayaan situs tersebut untuk Anda.

Metode publik lainnya

Plugin publik API juga mengungkapkan bantuan langsung yang ditentukan dalam src/definitions.ts:

• await CapacitorPasskey.getConfiguration() kembali ke nilai yang telah terpecahkan origin, domains, autoShim, dan saat ini platform.
• await CapacitorPasskey.createCredential(...) mendaftarkan passkey dari payload WebAuthn yang aman JSON.
• await CapacitorPasskey.getCredential(...) otentikasi dengan passkey yang sudah ada dari payload WebAuthn yang aman JSON.
• await CapacitorPasskey.isSupported() melaporkan apakah runtime saat ini mendukung passkeys.
• await CapacitorPasskey.getPluginVersion() kembali ke versi marker implementasi native saat ini.

Petunjuk platform

• Mulai memulai
• Pengaturan iOS
• Pengaturan Android
• Catatan backend

Peringatan penting iOS

Pada iOS 17.4 dan yang lebih baru, plugin menggunakan klien data browser-style API sehingga asal HTTPS yang dikonfigurasi tercermin dalam clientDataJSON.

Peringatan penting Android

Pengelola Kredensial Android dapat berbagi pihak yang dipercaya dan passkeys situs web Anda ketika Digital Asset Links dikonfigurasi, tetapi asal asertasi native tidak identik dengan asal browser. Jika backend Anda secara ketat memvalidasi clientDataJSON.origin, pastikan Anda menerima asal aplikasi Android di samping asal situs web Anda.

Referensi Lengkap

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

Teruskan dari Penggunaan @capgo/capacitor-passkey

Jika Anda menggunakan Penggunaan @capgo/capacitor-passkey untuk merencanakan autentikasi dan alur akun, hubungkannya dengan @capgo/capacitor-passkey untuk detail implementasi di @capgo/capacitor-passkey, Mulai Menggunakan untuk detail implementasi di Berikut, @capgo/capacitor-login Sosial untuk detail implementasi di @capgo/capacitor-social-login, @capgo/capacitor-native-biometric untuk detail implementasi di @capgo/capacitor-native-biometric, dan Dua faktor autentikasi untuk detail implementasi di Dua Faktor Autentikasi.