Menggunakan @capgo/capacitor-passkey

Pertahankan gaya browser WebAuthn code di aplikasi Capacitor sambil plugin mengelola panggilan passkey native dan patching host native.

Gaya browser API

@capgo/capacitor-passkey Gaya browser __CAPGO_KEEP_0__ menjaga alur 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.

Instal dan sinkronkan proyek native

bun add @capgo/capacitor-passkey
bunx cap sync

Konfigurasi aplikasi host sekali

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 secara langsung
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

Pasang shim selama bootstrap

Import plugin dari entri paket standar, kemudian pasang shim selama aplikasi bootstrap:

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 sudah diatur pada waktu runtime, silakan panggil:

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

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

Tetapkan alur WebAuthn normal Anda

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

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

Apa saja yang diperbarui secara sinkron

Selama bunx cap syncPada saat itu, 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 yang digunakan oleh manifest

Pengaturan native masih memerlukan file kepercayaan website

Plugin ini mengurangi pekerjaan di sisi aplikasi, tetapi passkeys masih bergantung pada file kepercayaan website 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 memperbarui proyek host native yang dihasilkan selama sinkron, tetapi tidak dapat membuat atau menyimpan file kepercayaan website untuk Anda.

Metode publik lainnya

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

await CapacitorPasskey.getConfiguration() mengembalikan nilai yang telah terpecahkan origin, domains, autoShim, dan saat ini platform.
await CapacitorPasskey.createCredential(...) mendaftarkan sebuah 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() mengembalikan versi marker implementasi native saat ini.

Petunjuk platform

Peringatan iOS Penting

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

Peringatan Android Penting

Manajer Kredensial Android dapat berbagi pihak yang dipercaya dan kunci pasword dengan situs web Anda ketika Digital Asset Links dikonfigurasi, tetapi asal asertasi native tidak identik dengan asal origin browser. Jika backend Anda secara ketat memvalidasi clientDataJSON.originPastikan 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/

Lanjutkan dari Menggunakan @capgo/capacitor-passkey

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

Passkey

Tutorial tentang Passkey