@capgo/capacitor-native-biometric

@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-biometrik native

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

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 Ionic Identity Vault aliran vault-kunci; aplikasi Anda tetap mengontrol timeout, siklus hidup, privasi layar, dan kebijakan sandi kustom.

Kemampuan Utama

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

Publik API

Methode	Deskripsi
`isAvailable`	Periksa apakah perangkat keras autentikasi biometrik tersedia.
`addListener`	Menambahkan 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/ tidak mendaftar 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 telah disimpan dengan accessControl diatur ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY.
`isCredentialsSaved`	Memeriksa jika kredit sudah disimpan untuk server tertentu.
`getPluginVersion`	Mendapatkan versi plugin native Capacitor.

Nilai Referensi

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

Auth Biometrikal Kesalahan

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 terlalu banyak upaya gagal.
`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	Gagal mengatur kode sandi perangkat, PIN, atau kredential cadangan.
`SYSTEM_CANCEL`	`15`	Android, iOS	Authentikasi dibatalkan oleh sistem, misalnya setelah kunci layar.
`USER_CANCEL`	`16`	Android, iOS	Pengguna membatalkan authentikasi.
`USER_FALLBACK`	`17`	Android, iOS	Pengguna memilih authentikasi cadangan.

Source Of Truth

Ini referensi yang disinkronkan dari src/definitions.ts di capacitor-biometrik native.

Terus lanjutkan 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).