@capgo/capacitor-native-biometric

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

Ringkasan

Native Biometric adalah vault kunci 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 Ionic Identity Vault aliran vault kunci; aplikasi Anda tetap mengontrol waktu tunggu, siklus kehidupan, layar privasi, dan kebijakan sandi kustom.

Kemampuan Utama

setCredentials dan getCredentials - Simpan dan ambil kunci dengan aman untuk server tertentu.
getSecureCredentials - Baca kredit hanya setelah verifikasi biometrik asli.
isCredentialsSaved - Bangun alur masuk, alur terkunci, dan alur keluar. deleteCredentials - Periksa ketersediaan autentikasi dan tanyakan pengguna ketika diperlukan.
isAvailable Publik __CAPGO_KEEP_0__ verifyIdentity Bab berjudul “Publik __CAPGO_KEEP_0__”

Public API

Memeriksa apakah perangkat autentikasi biometrik tersedia.	Menambahkan pendengar yang dipanggil ketika aplikasi kembali dari latar belakang. Ini berguna untuk mendeteksi jika ketersediaan biometrik telah berubah ketika aplikasi berada di latar belakang (misalnya, pengguna mendaftar/unmenggunakan biometrik).
`isAvailable`	Mengajak pengguna untuk melakukan autentikasi dengan biometrik.
`addListener`	Mengajak pengguna untuk melakukan autentikasi dengan 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 verifikasi biometrik. Kredit harus telah disimpan dengan accessControl diatur ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY.
`isCredentialsSaved`	Memeriksa apakah kredit sudah disimpan untuk server tertentu.
`getPluginVersion`	Mendapatkan versi plugin native Capacitor.

Nilai Referensi

Gunakan 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 diblokir 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 tidak interaktif.
`PASSCODE_NOT_SET`	`14`	Android, iOS	Kunci perangkat, PIN, atau kredential cadangan tidak diset.
`SYSTEM_CANCEL`	`15`	Android, iOS	Sistem menghapus autentikasi, misalnya setelah kunci layar.
`USER_CANCEL`	`16`	Android, iOS	Pengguna menghapus autentikasi.
`USER_FALLBACK`	`17`	Android, iOS	Pengguna memilih autentikasi 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 autentikasi dan alur akun, hubungkannya dengan Menggunakan @capgo/capacitor-native-biometric untuk kemampuan native di 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 di Autentikasi dua faktor, dan SSO (Enterprise) untuk detail implementasi di SSO (Enterprise).