Lebih cepat ke konten

@capgo/capacitor-biometrik native

Penyimpanan kunci yang aman dan akses yang dikunci biometrik untuk Android dan iOS.

Native Biometric adalah sebuah vault kunci yang aman untuk iOS dan Android. Ini menyimpan kunci di Keychain atau Keystore native dan dapat meminta autentikasi biometrik sebelum nilai sensitif dikembalikan. Ini adalah pengganti langsung untuk Ionic Identity Vault aliran credential-vault; aplikasi Anda tetap mengontrol waktu tunggu, siklus kehidupan, privasi layar, dan kebijakan sandi kustom.

  • setCredentials dan getCredentials - Simpan dan akses kembali kreditensial untuk server tertentu.
  • getSecureCredentials - Baca kreditensial hanya setelah melakukan verifikasi biometrik native.
  • isCredentialsSaved dan deleteCredentials - Bangun alur penggunaan, alur terkunci, dan alur keluar.
  • isAvailable dan verifyIdentity - Periksa ketersediaan autentikasi dan tampilkan notifikasi kepada pengguna ketika diperlukan.
MethodeDeskripsi
isAvailablePeriksa apakah perangkat verifikasi biometrik tersedia.
addListenerMenambahkan pemangku jawab yang dipanggil ketika aplikasi kembali dari latar belakang. Ini berguna untuk mendeteksi jika ketersediaan biometrik telah berubah saat aplikasi berada di latar belakang (misalnya, pengguna mendaftar/mengundurkan biometrik).
verifyIdentityMengajak pengguna untuk melakukan autentikasi dengan biometrik.
getCredentialsMengambil kredit yang disimpan untuk server tertentu.
setCredentialsMenyimpan kredit yang diberikan untuk server tertentu.
deleteCredentialsMenghapus kredit yang disimpan untuk server tertentu.
getSecureCredentialsMengambil kredit yang disimpan untuk server tertentu, memerlukan autentikasi biometrik. Kredit harus telah disimpan dengan accessControl diatur ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY.
isCredentialsSavedMemeriksa jika kredit sudah disimpan untuk server tertentu.
getPluginVersionMendapatkan versi plugin native Capacitor.

Pakai nilai-nilai ini ketika mengolah biometricError hasil dari authenticate.

NilaiCodePlatformArti
UNKNOWN_ERROR0Android, iOSTerjadi kesalahan yang tidak diketahui.
BIOMETRICS_UNAVAILABLE1Android, iOSBiometrik tidak tersedia karena perangkat keras hilang atau tidak tersedia.
USER_LOCKOUT2Android, iOSPengguna terkunci setelah beberapa kali gagal mencoba.
BIOMETRICS_NOT_ENROLLED3Android, iOSTidak ada biometrik yang terdaftar pada perangkat.
USER_TEMPORARY_LOCKOUT4AndroidPengguna sementara diblokir, biasanya selama 30 detik.
AUTHENTICATION_FAILED10Android, iOSGagal autentikasi.
APP_CANCEL11iOSAplikasi membatalkan alur autentikasi.
INVALID_CONTEXT12iOSKonteks autentikasi tidak valid.
NOT_INTERACTIVE13iOSAutentikasi tidak interaktif.
PASSCODE_NOT_SET14Android, iOSKode sandi perangkat, PIN, atau kredential cadangan tidak diset.
SYSTEM_CANCEL15Android, iOSSistem membatalkan autentikasi, misalnya setelah kunci layar.
USER_CANCEL16Android, iOSPengguna membatalkan autentikasi.
USER_FALLBACK17Android, iOSPengguna memilih autentikasi cadangan.

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

Terus lanjut dari @capgo/capacitor-biometrik native

Judul Bagian: Terus lanjut dari @capgo/capacitor-biometrik native

Jika Anda menggunakan @capgo/capacitor-biometrik native untuk merencanakan autentikasi dan alur akun, hubungkannya dengan Menggunakan @capgo/capacitor-biometrik native untuk kemampuan native di Menggunakan @capgo/capacitor-biometrik native, @capgo/capacitor-login sosial untuk detail implementasi di @capgo/capacitor-login sosial, @capgo/capacitor-passkey untuk detail implementasi di @capgo/capacitor-passkey, Autentikasi Dua Faktor untuk detail implementasi di Autentikasi Dua Faktor, dan SSO (Enterprise) untuk detail implementasi di SSO (Enterprise).