@capgo/capacitor-native-biometric

Ikhtisar

Native Biometric adalah vault kredensial aman untuk iOS dan Android. Plugin ini menyimpan kredensial di Keychain atau Keystore native dan dapat mewajibkan autentikasi biometrik sebelum nilai sensitif dikembalikan. Ini pengganti langsung untuk alur credential vault Ionic Identity Vault; aplikasi Anda tetap mengontrol kebijakan timeout, lifecycle, privacy screen, dan custom passcode.

Kompatibilitas

Versi mayor plugin mengikuti Capacitor: v8 untuk Capacitor 8 (pemeliharaan aktif), v7 untuk Capacitor 7 (pemeliharaan sesuai permintaan).

Kemampuan Utama

• setCredentials dan getCredentials - Simpan dan ambil kredensial server secara aman.
• getSecureCredentials - Baca kredensial hanya setelah verifikasi biometrik native.
• isCredentialsSaved dan deleteCredentials - Bangun alur onboarding, locked-state, dan logout.
• isAvailable dan verifyIdentity - Cek ketersediaan autentikasi dan tampilkan prompt ke user jika diperlukan.

API Publik

Metode	Deskripsi
isAvailable	Mengecek apakah hardware autentikasi biometrik tersedia.
addListener	Menambahkan listener yang dipanggil saat aplikasi kembali aktif dari background. Berguna untuk mendeteksi apakah ketersediaan biometrik berubah selama aplikasi di background (misalnya, user mendaftarkan/menghapus biometrik).
verifyIdentity	Meminta user melakukan autentikasi dengan biometrik.
getCredentials	Mengambil kredensial yang tersimpan untuk server tertentu.
setCredentials	Menyimpan kredensial yang diberikan untuk server tertentu.
deleteCredentials	Menghapus kredensial yang tersimpan untuk server tertentu.
getSecureCredentials	Mengambil kredensial tersimpan untuk server tertentu, yang memerlukan autentikasi biometrik. Kredensial harus disimpan dengan accessControl diatur ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY.
isCredentialsSaved	Memeriksa apakah kredensial sudah tersimpan untuk server tertentu.
getPluginVersion	Dapatkan versi plugin native Capacitor.

Nilai Referensi

Gunakan nilai-nilai ini saat menangani biometricError hasil dari authenticate.

Error Autentikasi Biometrik

Nilai	Code	Platform	Arti
UNKNOWN_ERROR	0	Android, iOS	Terjadi error yang tidak diketahui.
BIOMETRICS_UNAVAILABLE	1	Android, iOS	Biometrik tidak tersedia karena hardware tidak ada atau tidak tersedia.
USER_LOCKOUT	2	Android, iOS	User terkunci setelah terlalu banyak percobaan gagal.
BIOMETRICS_NOT_ENROLLED	3	Android, iOS	Tidak ada biometrik yang terdaftar di perangkat.
USER_TEMPORARY_LOCKOUT	4	Android	User terkunci sementara, biasanya selama 30 detik.
AUTHENTICATION_FAILED	10	Android, iOS	Autentikasi gagal.
APP_CANCEL	11	iOS	Aplikasi membatalkan alur autentikasi.
INVALID_CONTEXT	12	iOS	Konteks autentikasi tidak valid.
NOT_INTERACTIVE	13	iOS	Autentikasi tidak interaktif.
PASSCODE_NOT_SET	14	Android, iOS	Passcode perangkat, PIN, atau kredensial fallback belum diatur.
SYSTEM_CANCEL	15	Android, iOS	Sistem membatalkan autentikasi, misalnya setelah layar terkunci.
USER_CANCEL	16	Android, iOS	Pengguna membatalkan autentikasi.
USER_FALLBACK	17	Android, iOS	User memilih autentikasi cadangan.

Sumber Kebenaran

Referensi ini disinkronkan dari src/definitions.ts di capacitor-native-biometric.

Lanjutkan dari @capgo/capacitor-native-biometric

Jika Anda menggunakan @capgo/capacitor-native-biometric untuk merencanakan alur autentikasi dan akun, hubungkan dengan Menggunakan @capgo/capacitor-native-biometric untuk kapabilitas native saat menggunakan @capgo/capacitor-native-biometric, @capgo/capacitor-social-login untuk detail implementasi di @capgo/capacitor-social-login, @capgo/capacitor-passkey untuk detail implementasi di @capgo/capacitor-passkey, Autentikasi dua faktor untuk detail implementasi pada Two-factor authentication, dan SSO (Enterprise) untuk detail implementasi pada SSO (Enterprise).