@capgo/capacitor-biometrik native

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

Pendahuluan

Native Biometric adalah vault kunci yang aman untuk iOS dan Android. Ini menyimpan kunci di Keychain atau Keystore asli dan dapat meminta verifikasi biometrik sebelum nilai sensitif dikembalikan. Ini adalah pengganti langsung untuk Ionic Identity Vault aliran credential-vault; aplikasi Anda tetap mengontrol waktu tunggu, siklus kehidupan, layar privasi, dan kebijakan passcode 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 onboarding, keadaan terkunci, dan keluar. deleteCredentials - Periksa ketersediaan autentikasi dan ajak pengguna ketika diperlukan.
isAvailable Publik __CAPGO_KEEP_0__ verifyIdentity Bab berjudul “Publik __CAPGO_KEEP_0__”

Public API

Memeriksa apakah perangkat autentikasi biometrik tersedia.	Menambahkan listener 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/unenroll biometrik).
`isAvailable`	Mengajak pengguna untuk melakukan autentikasi dengan biometrik.
`addListener`	and
`verifyIdentity`	and
`getCredentials`	Mendapatkan kreditorisasi yang disimpan untuk server tertentu.
`setCredentials`	Menyimpan kreditorisasi yang diberikan untuk server tertentu.
`deleteCredentials`	Menghapus kreditorisasi yang disimpan untuk server tertentu.
`getSecureCredentials`	Mendapatkan kreditorisasi yang disimpan untuk server tertentu, memerlukan verifikasi biometrik. Kreditorisasi harus telah disimpan dengan accessControl yang ditetapkan ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY.
`isCredentialsSaved`	Memeriksa apakah kreditorisasi sudah disimpan untuk server tertentu.
`getPluginVersion`	Dapatkan 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 tidak tersedia atau tidak dapat diakses.
`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 tidak interaktif.
`PASSCODE_NOT_SET`	`14`	Android, iOS	Kode sandi, PIN, atau kredential cadangan perangkat tidak terkonfigurasi.
`SYSTEM_CANCEL`	`15`	Android, iOS	Sistem menghentikan autentikasi, misalnya setelah kunci layar.
`USER_CANCEL`	`16`	Android, iOS	Pengguna menghentikan autentikasi.
`USER_FALLBACK`	`17`	Android, iOS	Pengguna memilih autentikasi fallback.

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)].