@capgo/capacitor-native-biometric

Pengamanan penyimpanan kredit dan akses berbasis biometrik untuk Android dan iOS.

Ringkasan

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

Kemampuan Utama

setCredentials dan getCredentials - Simpan dan ambil kredit dengan aman untuk server tertentu.
getSecureCredentials - Baca kredit hanya setelah melakukan verifikasi biometrik native.
isCredentialsSaved - dan deleteCredentials - Bangun alur onboarding, locked-state, dan logout.
isAvailable - dan verifyIdentity - Periksa ketersediaan autentikasi dan tampilkan pesan kepada pengguna ketika diperlukan.

- Publik API

- Metode	- Deskripsi
`isAvailable`	- Memeriksa apakah perangkat keras autentikasi biometrik tersedia.
`addListener`	- Menambahkan listener yang dipanggil ketika aplikasi kembali dari latar belakang. Ini berguna untuk mendeteksi apakah ketersediaan biometrik telah berubah saat aplikasi berada di latar belakang (misalnya, pengguna mendaftar/unenroll biometrik).
`verifyIdentity`	Mengajak pengguna untuk melakukan autentikasi dengan biometrik.
`getCredentials`	Mengambil kredit yang disimpan untuk server tertentu.
`setCredentials`	Menyimpan kredit yang diberikan untuk server tertentu.
`deleteCredentials`	Menghapus kredit yang disimpan untuk server tertentu.
`getSecureCredentials`	Mengambil kredit yang disimpan untuk server tertentu, memerlukan autentikasi biometrik. Kredit harus disimpan dengan accessControl yang ditetapkan ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY.
`isCredentialsSaved`	Memeriksa apakah kredit sudah disimpan untuk server tertentu.
`getPluginVersion`	Mendapatkan versi plugin native Capacitor.

Nilai Referensi

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

Kesalahan Autentikasi Biometrik

Nilai	Code	Platform	Arti
`UNKNOWN_ERROR`	`0`	Android, iOS	Terjadi kesalahan yang tidak diketahui.
`BIOMETRICS_UNAVAILABLE`	`1`	Android, iOS	Biometrik tidak tersedia karena perangkat keras hilang atau tidak tersedia.
`USER_LOCKOUT`	`2`	Android, iOS	Pengguna terkunci setelah beberapa kali gagal mencoba.
`BIOMETRICS_NOT_ENROLLED`	`3`	Android, iOS	Tidak ada biometrik yang terdaftar pada perangkat.
`USER_TEMPORARY_LOCKOUT`	`4`	Android	Pengguna sementara diblokir, biasanya selama 30 detik.
`AUTHENTICATION_FAILED`	`10`	Android, iOS	Gagal autentikasi.
`APP_CANCEL`	`11`	iOS	Aplikasi membatalkan alur autentikasi.
`INVALID_CONTEXT`	`12`	iOS	Konteks autentikasi tidak valid.
`NOT_INTERACTIVE`	`13`	iOS	Autentikasi bukan interaktif.
`PASSCODE_NOT_SET`	`14`	Android, iOS	Kode sandi, PIN, atau kredential cadangan tidak diatur.
`SYSTEM_CANCEL`	`15`	Android, iOS	Authentikasi dibatalkan oleh sistem, misalnya setelah kunci layar.
`USER_CANCEL`	`16`	Android, iOS	Authentikasi dibatalkan oleh pengguna.
`USER_FALLBACK`	`17`	Android, iOS	Pengguna memilih authentikasi cadangan.

Sumber Kebenaran

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

Teruskan dari @capgo/capacitor-native-biometric

Jika Anda menggunakan @capgo/capacitor-native-biometric untuk merencanakan alur autentikasi dan akun, hubungkannya dengan Menggunakan @capgo/capacitor-native-biometric untuk kemampuan asli dalam Menggunakan @capgo/capacitor-native-biometric, @capgo/capacitor-login Sosial untuk detail implementasi dalam @capgo/capacitor-social-login, @capgo/capacitor-passkey untuk detail implementasi dalam @capgo/capacitor-passkey, Autentikasi Dua Faktor untuk detail implementasi di Autentikasi Dua Faktor, dan SSO (Perusahaan) untuk detail implementasi di SSO (Perusahaan).