Menggunakan @capgo/capacitor-native-biometric
Plugin ini memberi akses ke API biometrik native untuk Android dan iOS.
Kompatibilitas
Versi mayor plugin mengikuti Capacitor: gunakan v8 untuk Capacitor 8 (dipelihara secara aktif) dan v7 untuk Capacitor 7 (dipelihara sesuai permintaan). Lihat tabel kompatibilitas.
Instal
# Capacitor 8
bun add @capgo/capacitor-native-biometric@8
# Capacitor 7
bun add @capgo/capacitor-native-biometric@7
bunx cap sync
bunx cap sync menyalin code native plugin ke dalam proyek native Anda. Jalankan kembali setiap kali melakukan upgrade plugin.
Impor
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
Sekilas tentang API
| Metode | Deskripsi |
|---|---|
isAvailable |
Mengecek apakah hardware autentikasi biometrik tersedia. |
verifyIdentity |
Meminta user melakukan autentikasi dengan biometrik. |
getCredentials |
Mengambil kredensial yang tersimpan untuk server tertentu. |
setCredentials |
Menyimpan kredensial yang diberikan untuk server tertentu. |
deleteCredentials |
Menghapus kredensial yang tersimpan untuk server tertentu. |
getSecureCredentials |
Mengambil kredensial tersimpan untuk server tertentu, yang memerlukan autentikasi biometrik. Kredensial harus disimpan dengan accessControl diatur ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY. |
isCredentialsSaved |
Memeriksa apakah kredensial sudah tersimpan untuk server tertentu. |
setData |
Menyimpan nilai string apa pun pada key yang diberikan. Nilai dienkripsi saat disimpan (at rest) menggunakan backend secure storage platform (Android Keystore + SharedPreferences, iOS Keychain). |
getData |
Mengambil nilai yang sebelumnya disimpan untuk key yang diberikan. Hanya mengembalikan nilai yang disimpan tanpa biometrik. accessControl. |
getSecureData |
Mengambil nilai yang dilindungi biometrik untuk key yang diberikan. Nilai harus telah disimpan dengan accessControl diatur ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY. |
deleteData |
Menghapus nilai yang disimpan untuk key yang diberikan (dilindungi dan tidak dilindungi). |
isDataSaved |
Memeriksa apakah nilai sudah disimpan untuk key yang diberikan. |
Contoh
isAvailable()
Mengecek apakah hardware autentikasi biometrik tersedia.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.isAvailable();
console.log(result);
verifyIdentity()
Meminta user melakukan autentikasi dengan biometrik.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.verifyIdentity();
getCredentials()
Mengambil kredensial yang tersimpan untuk server tertentu.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.getCredentials({ server: 'example.com' });
// The result holds sensitive values: use it without logging it.
setCredentials()
Menyimpan kredensial yang diberikan untuk server tertentu.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.setCredentials({
username: 'username',
password: 'password',
server: 'example.com',
});
deleteCredentials()
Menghapus kredensial yang tersimpan untuk server tertentu.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
await NativeBiometric.deleteCredentials({ server: 'example.com' });
getSecureCredentials()
Mengambil kredensial tersimpan untuk server tertentu, yang memerlukan autentikasi biometrik. Kredensial harus disimpan dengan accessControl diatur ke BIOMETRY_CURRENT_SET atau BIOMETRY_ANY.
import { NativeBiometric } from '@capgo/capacitor-native-biometric';
const result = await NativeBiometric.getSecureCredentials({ server: 'example.com' });
// The result holds sensitive values: use it without logging it.
Tabel di atas mencantumkan 12 metode inti. Dokumentasi mengenai helper Listener, version, serta kontrak lengkap dari setiap metode tersedia di repositori GitHub.
Mendengarkan event
addListener mengembalikan sebuah handle. Panggil handle.remove() saat screen di-unmount.
Referensi lengkap
Lanjutkan dari Menggunakan @capgo/capacitor-native-biometric
Jika Anda menggunakan Menggunakan @capgo/capacitor-native-biometric untuk merencanakan alur autentikasi dan akun, hubungkan dengan @capgo/capacitor-native-biometric untuk detail implementasi di @capgo/capacitor-native-biometric, Panduan Memulai untuk detail implementasi di Getting Started, @capgo/capacitor-social-login untuk detail implementasi di @capgo/capacitor-social-login, @capgo/capacitor-passkey untuk detail implementasi di @capgo/capacitor-passkey, dan Autentikasi dua faktor untuk detail implementasi di autentikasi dua faktor.